Difference between revisions of "Help:Categories"

From eLinux.org
Jump to: navigation, search
(reorganize)
 
(Hidden categories)
(10 intermediate revisions by 5 users not shown)
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.
+
Categories, a software feature of MediaWiki, provide automatic indexes that are useful as tables of contents.
  
== How to add a page to a Category ==
+
You can categorize pages and files by adding one or more '''Category''' {{#ifeq:Category|{{ns:category}}||'''({{ns:category}})'''}} tags to the content text. These tags create 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.
To add a page to a {{ns:category}}, simply put the following in the page you are editing:
 
  
  <nowiki>[[</nowiki>{{ns:category}}:''NAME'']]
+
  <nowiki>[[</nowiki>{{ns:category}}:'''''e-con Systems''''']]
 +
'''e-con Systems'''<br>
 +
[http://www.e-consystems.com/ www.e-consystems.com]<br><br>
 +
'''System on Module'''<br>
 +
* [http://www.e-consystems.com/iMX6-system-on-module.asp eSOMiMX6 - i.MX6 System on Module]
 +
* [http://www.e-consystems.com/iMX6-development-board.asp Ankaa - eSOMiMX6 Reference Design]
 +
* [http://www.e-consystems.com/DM3730-computer-on-module.asp eSOM3730 - AM3703/DM3730 Computer on Module]
 +
* [http://www.e-consystems.com/DM3730-development-kit.asp Almach - eSOM3730 Reference Design]
  
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.
+
<nowiki>[[</nowiki>{{ns:category}}:'''''System on Module''''']]
 +
'''e-con Systems'''<br>
 +
[http://www.e-consystems.com/ www.e-consystems.com]<br><br>
 +
'''System on Module'''<br>
 +
* [http://www.e-consystems.com/iMX6-system-on-module.asp eSOMiMX6 - i.MX6 System on Module]
 +
* [http://www.e-consystems.com/iMX6-development-board.asp Ankaa - eSOMiMX6 Reference Design]
 +
* [http://www.e-consystems.com/DM3730-computer-on-module.asp eSOM3730 - AM3703/DM3730 Computer on Module]
 +
* [http://www.e-consystems.com/DM3730-development-kit.asp Almach - eSOM3730 Reference Design]
  
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.
+
==Managing the category hierarchy== 
 +
Categories may belong to other categories in a hierarchy. Since category pages are much like any other page, a {{ns:category}} tag may be added to the bottom of a category page.  
  
=== Sort key ===
+
It is a good idea to organize all categories into a hierarchy with a single top level category. The category structure can take the form of a tree with separate branches, but more often will have a graph structure. Generally, there should be a contiguous chain of parent-child links between each category and the 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:
 
  
<nowiki>[[</nowiki>{{ns:category}}:''NAME''|''SORT'']]
+
==Linking to a category==
 +
To create a link to a category, use a leading colon before the category name (without this colon, the current page would be added to the category):
  
For example, to add this page to the “Help” category under the section “C,” you write
+
:<code><nowiki>[[</nowiki>:{{ns:category}}:Help]]</code> &rarr; '''[[:{{ns:category}}:Help]]'''
  
<nowiki>[[</nowiki>{{ns:category}}:Help|Categories]]
+
To change the link text, write the text inside the link tag after a pipe:
  
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.
+
:<code><nowiki>[[</nowiki>:{{ns:category}}:Help|Help category]]</code> &rarr; '''[[:{{ns:category}}:Help|Help category]]'''
 +
 +
[[Help:Redirects|Redirect pages]] that redirect to categories must also use the colon, otherwise they will be added to the category instead of redirecting.
  
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.“
+
==Redirecting a category==
 
+
Like normal wiki pages, category pages can be redirected to other normal or category pages.
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.
 
 
 
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]].
 
 
 
== Linking to categories ==
 
To create a link to a category, use a leading colon as in
 
 
 
<nowiki>[[</nowiki>:{{ns:category}}:NAME]]
 
 
 
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.
 
 
 
If you want to display alternate text for the link, add that after a pipe as with other internal links (See [[Help:Links]]):
 
 
 
<nowiki>[[</nowiki>:{{ns:category}}:NAME|TEXT]]
 
 
 
[[Help:Redirect|Redirects]] to a category also need a leading colon to prevent the redirect pages from being included in the category.
 
  
 
{{Languages}}
 
{{Languages}}
 
[[Category:Help|Categories]]
 
[[Category:Help|Categories]]

Revision as of 02:57, 22 July 2015

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

Categories, a software feature of MediaWiki, provide automatic indexes that are useful as tables of contents.

You can categorize pages and files by adding one or more Category tags to the content text. These tags create 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.

[[Category:e-con Systems]]

e-con Systems
www.e-consystems.com

System on Module

[[Category:System on Module]]

e-con Systems
www.e-consystems.com

System on Module

Managing the category hierarchy

Categories may belong to other categories in a hierarchy. Since category pages are much like any other page, a Category tag may be added to the bottom of a category page.

It is a good idea to organize all categories into a hierarchy with a single top level category. The category structure can take the form of a tree with separate branches, but more often will have a graph structure. Generally, there should be a contiguous chain of parent-child links between each category and the top level category.

Linking to a category

To create a link to a category, use a leading colon before the category name (without this colon, the current page would be added to the category):

[[:Category:Help]]Category:Help

To change the link text, write the text inside the link tag after a pipe:

[[:Category:Help|Help category]]Help category

Redirect pages that redirect to categories must also use the colon, otherwise they will be added to the category instead of redirecting.

Redirecting a category

Like normal wiki pages, category pages can be redirected to other normal or category pages.

Language: English