Difference between revisions of "Help:Categories"

From eLinux.org
Jump to: navigation, search
m (1 revision(s))
m (link to the bug, since it exists)
Line 1: Line 1:
 
{{PD Help Page}}
 
{{PD Help Page}}
MediaWiki allows you to categorize pages and files by appending one or more '''{{ns:category}}''' tags to the content text. Adding these tags creates links at the bottom of the page that take you to the list of all pages in that category, which makes it easy to browse related articles.
+
MediaWiki allows you to categorize pages and files by appending one or more '''Category''' {{#ifeq:Category|{{ns:category}}||'''({{ns:category}})'''}} tags to the content text. Adding these tags creates links at the bottom of the page that take you to the list of all pages in that category, which makes it easy to browse related articles.
 
+
== How to add a page to a Category ==
+
To add a page to a {{ns:category}}, simply put the following in the page you are editing:
+
  
 +
==Add a page to a category==
 +
To add a page or uploaded file to a category, simply edit the page and add the following text (where ''NAME'' is the name of the category you want to add it to).
 
  <nowiki>[[</nowiki>{{ns:category}}:''NAME'']]
 
  <nowiki>[[</nowiki>{{ns:category}}:''NAME'']]
  
where ''NAME'' is the name of the {{ns:category}} you want to add it to. Any number of {{ns:category}} tags may be added to the page and the page will be listed in all of them. {{ns:category}} tags can be added wherever you like in the editing text, but in general, they are added at the very bottom for the convenience of other editors.
+
Any number of {{ns:category}} tags may be added to the page and the page will be listed in all of them. {{ns:category}} tags can be added wherever you like in the editing text, but they are usually added at the very bottom for the convenience of other editors.
  
Images and other uploaded files can be categorized by adding {{ns:category}} tags to their description page. Adding {{ns:category}} tags to categories will categorize them into subcategories. It is always a good idea to organize all categories within your wiki into a hierarchy with a single top level category.
+
If categories are placed into a section of text by themselves, any nearby excess whitespace will be ignored. If placed between a list and regular text, you will need to manually add the &lt;br /&gt; linebreak.
  
=== Sort key ===
+
Adding {{ns:category}} tags to categories will make them subcategories. It is a good idea to organize all your categories into a hierarchy with a single top level category.
You can add a “sort key” to the {{ns:category}} tag that specifies where the page will appear within the Category. This is done by using the following markup:
+
  
 +
===Sort key===
 +
A ''sort key'' specifies where the page will appear in the category list, and under which letter heading. (By default, the page is sorted under the first letter of its full name ''including its namespace''.) You can add a sort key to a page by adding it inside the {{ns:category}} tag. For example, the tag below will add the page under the heading "S".
 
  <nowiki>[[</nowiki>{{ns:category}}:''NAME''|''SORT'']]
 
  <nowiki>[[</nowiki>{{ns:category}}:''NAME''|''SORT'']]
  
For example, to add this page to the “Help” category under the section “C,” you write
+
Sort keys are case-sensitive, and a space is also valid. The order of the sections within a category follows the Unicode sort order. The sort key does not change the page title displayed in the category.
 
+
<nowiki>[[</nowiki>{{ns:category}}:Help|Categories]]
+
 
+
Note that sort keys are case sensitive, and even a space is recognized as a sort key. The order of the sections within a {{ns:category}} follows the order of Unicode.
+
 
+
The sort key does not affect how the page title is displayed in the category, only how it is ordered in the list. In the above example, the link to this page will still read ”Help:Categories.“
+
 
+
By default, pages not in the “main“ [[Help:Namespaces|namespaces]] will be sorted by the page name including the namespace, which can be rather inconvenient. One basic trick to avoid this is to use a special tag as a sort key as following:
+
 
+
<nowiki>[[</nowiki>{{ns:category}}:Help|<nowiki>{{PAGENAME}}</nowiki>]]
+
 
+
This is particularly useful when using templates that include a category tag.
+
 
+
== How to create a category ==
+
A category can be created just as other wiki pages (See [[Help:Starting a new page]]). Just remember to add <code>{{ns:category}}:</code> before the name of the category.
+
 
+
In fact, the list of pages in a category exists even if the category page is not created, but such categories are isolated from other categories and will serve little to sort out the pages and files of your wiki.
+
  
Renaming (moving) a category is not possible like other wiki pages. If it is necessary, you have to create a new category and change the tag in each member of the category. This loses the page history, which is undesirable in wikis where category pages contain significant amounts of text.
+
==Create a category==
 +
A category can be created the same way as as other wiki pages (See [[Help:Starting a new page]]); just add "<code>{{ns:category}}:</code>" before the page title. (Category lists exist even if their description page is not created, but these categories are isolated from others and serve little purpose for organization or navigation.)
  
To save extra work, you may want to search well within your wiki before attempting to create a new category. The list of all categories can be found in “{{lcfirst:{{int:specialpages}}}}” in the {{lcfirst:{{int:toolbox}}}}” box of the [[Help:Navigation#Sidebar|sidebar]].
+
It is not possible to rename (move) a category, unlike other wiki pages. It is necessary to create a new category and change the {{ns:category}} tag on every page. The new category will not have the older category's page history, which is undesirable if there are many revisions.
  
== Linking to categories ==
+
To avoid extra work, try searching within your wiki before creating a new category. The list of all categories can be found in "{{lcfirst:{{int:specialpages}}}}" in the "{{lcfirst:{{int:toolbox}}}}" box of the [[Help:Navigation#Sidebar|sidebar]].
To create a link to a category, use a leading colon as in
+
  
<nowiki>[[</nowiki>:{{ns:category}}:NAME]]
+
===Hidden categories===
 +
The categories that a page is in are normally listed at the bottom of the page. A category can be hidden from these lists by adding "<code><nowiki>__HIDDENCAT__</nowiki></code>" to the category page. (Each user can choose to see them in a separate "{{int:hidden-categories}}" list, by checking "{{int:tog-showhiddencats}}" in the "Misc" section of [[Special:Preferences]].)
  
For example, to link to “{{ns:category}}:Help", write <code><nowiki>[[</nowikI>:{{ns:category}}:Help]]</code>, which will result in [[:{{ns:category}}:Help]]. Without the leading colon, it would add the page into the category.
+
Hidden categories are automatically added to [[:Category:{{mediawiki:hidden-category-category}}]] (specified by [[MediaWiki:Hidden-category-category]]).
  
If you want to display alternate text for the link, add that after a pipe as with other internal links (See [[Help:Links]]):
+
Hidden categories are not hidden on category pages ({{bugzilla|15550}})
  
  <nowiki>[[</nowiki>:{{ns:category}}:NAME|TEXT]]
+
==Linking to a category==
 +
To create a link to a category, use a leading colon before the category name. (Without this colon, it will add the current page to the category.) To change the link text, write the text inside the link tag after a pipe.
 +
  <nowiki>[[</nowiki>:{{ns:category}}:''NAME'']]
 +
<nowiki>[[</nowiki>:{{ns:category}}:''NAME''|''TEXT'']]
 +
 +
For example, to link to "{{ns:category}}:Help", write "<code><nowiki>[[</nowiki>:{{ns:category}}:Help]]</code>", which will result in [[:{{ns:category}}:Help]].
  
[[Help:Redirect|Redirects]] to a category also need a leading colon to prevent the redirect pages from being included in the category.
+
[[Help:Redirect|Redirect pages]] must also use the colon, otherwise it will be added to the category instead of redirecting.
  
 
{{Languages}}
 
{{Languages}}
 
[[Category:Help|Categories]]
 
[[Category:Help|Categories]]

Revision as of 08:32, 22 November 2009

PD Important note: When you edit this page, you agree to release your contribution into the public domain. If you don't want this or can't do this because of license restrictions, please don't edit. This page is one of the Public Domain Help Pages, which can be freely copied into fresh wiki installations and/or distributed with MediaWiki software; see Help:Contents for an overview of all pages. See Project:PD help/Copying for instructions. PD

MediaWiki allows you to categorize pages and files by appending one or more Category tags to the content text. Adding these tags creates links at the bottom of the page that take you to the list of all pages in that category, which makes it easy to browse related articles.

Add a page to a category

To add a page or uploaded file to a category, simply edit the page and add the following text (where NAME is the name of the category you want to add it to).

[[Category:NAME]]

Any number of Category tags may be added to the page and the page will be listed in all of them. Category tags can be added wherever you like in the editing text, but they are usually added at the very bottom for the convenience of other editors.

If categories are placed into a section of text by themselves, any nearby excess whitespace will be ignored. If placed between a list and regular text, you will need to manually add the <br /> linebreak.

Adding Category tags to categories will make them subcategories. It is a good idea to organize all your categories into a hierarchy with a single top level category.

Sort key

A sort key specifies where the page will appear in the category list, and under which letter heading. (By default, the page is sorted under the first letter of its full name including its namespace.) You can add a sort key to a page by adding it inside the Category tag. For example, the tag below will add the page under the heading "S".

[[Category:NAME|SORT]]

Sort keys are case-sensitive, and a space is also valid. The order of the sections within a category follows the Unicode sort order. The sort key does not change the page title displayed in the category.

Create a category

A category can be created the same way as as other wiki pages (See Help:Starting a new page); just add "Category:" before the page title. (Category lists exist even if their description page is not created, but these categories are isolated from others and serve little purpose for organization or navigation.)

It is not possible to rename (move) a category, unlike other wiki pages. It is necessary to create a new category and change the Category tag on every page. The new category will not have the older category's page history, which is undesirable if there are many revisions.

To avoid extra work, try searching within your wiki before creating a new category. The list of all categories can be found in "special pages" in the "tools" box of the sidebar.

Hidden categories

The categories that a page is in are normally listed at the bottom of the page. A category can be hidden from these lists by adding "__HIDDENCAT__" to the category page. (Each user can choose to see them in a separate "Hidden categories" list, by checking "Show hidden categories" in the "Misc" section of Special:Preferences.)

Hidden categories are automatically added to Category:Hidden categories (specified by MediaWiki:Hidden-category-category).

Hidden categories are not hidden on category pages (bug 15550)

Linking to a category

To create a link to a category, use a leading colon before the category name. (Without this colon, it will add the current page to the category.) To change the link text, write the text inside the link tag after a pipe.

[[:Category:NAME]]
[[:Category:NAME|TEXT]]

For example, to link to "Category:Help", write "[[:Category:Help]]", which will result in Category:Help.

Redirect pages must also use the colon, otherwise it will be added to the category instead of redirecting.

Language: English