Difference between pages "Help:Bots" and "Help:Categories"

From Funtoo
(Difference between pages)
Jump to: navigation, search
 
m (1 revision: Importing the public domain help content from Mediawiki)
 
Line 1: Line 1:
 
{{PD Help Page}}
 
{{PD Help Page}}
 +
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.
  
A '''bot''' is a computer program that automatically retrieves or updates wiki pages when it is executed. In general, bots are used for repetitive maintenance tasks, whose volume and characteristics are too large to be performed manually by users.
+
==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'']]
  
Developing and executing bots is normally outside the role of normal users, requires programming experience and must be done in coordination with the wiki's [[Help:Sysops and permissions|admins]].  
+
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.
  
By default, bot edits are hidden in [[Special:RecentChanges|{{ns:special}}:{{MediaWiki:Recentchanges}}]].  
+
Spaces and line breaks before categories are ignored, thus
 +
<pre><nowiki>
 +
* A list item
 +
[[Category:Some category]] Some text
 +
</nowiki></pre>
 +
will be rendered the same as
 +
<pre><nowiki>
 +
* A list item Some text
 +
</nowiki></pre>
 +
You will need to manually add a &lt;br /&gt; tag or a line break after the category.
  
== Framework and interface for bot development ==
+
===Sort key===
Bots do not access the wiki through the normal graphical user interface. MediaWiki has an API (Application Programming Interface) available for this purpose. An API is a protocol for standardised communication between two computer programs. Check {{mediawiki|API:Client code}} for more information.
+
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'']]
  
To access a wiki through the API a bot must have a user account, which has been granted 'bot' [[Help:Assigning permissions|permissions]].
+
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.
  
=== pywikipediabot ===
+
==Create a category==
{{mediawiki|meta:pywikipediabot}} provides a framework for the development of bots, which are commonly used to perform maintenance tasks such as adding a footer to some categorized pages ({{mediawiki|meta:pywikipediabot/add_text.py|add_text.py}}), adding some [[Help:Links|wikilinks]] ({{mediawiki|meta:pywikipediabot/replace.py|replace.py}}), moving old contents of [[Help:Talk pages|talk pages]] to [[Help:Subpages|subpages]] ({{mediawiki|meta:pywikipediabot/archivebot.py|archivebot.py}}), editing [[Help:Categories|categories]] ({{mediawiki|meta:pywikipediabot/category.py|category.py}}), or managing [[Help:Templates|templates]] ({{mediawiki|meta:pywikipediabot/template.py|template.py}}).
+
A category is created when a page is created in the '''''Category:''''' namespace. A category page can be created the same way 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.)
  
== The MassEditRegex extension ==
+
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.
[[:mw:Extension:MassEditRegex|Extension:MassEditRegex]] provides an alternative way to perform mass edits using regular expressions, through a special page in the wiki. Only admins can normally use this extension.
+
  
== See also ==
+
To avoid extra work, try searching within your wiki before creating a new category. The list of all categories can be found in "{{int:specialpages}}" in the "{{lcfirst:{{int:toolbox}}}}" box of the [[Help:Navigation#Sidebar|sidebar]].
* {{mediawiki|meta:Bot}}
+
  
{{Languages}}
+
==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>" [[Help:Magic words|magic word]] 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 "{{int:prefs-rendering}}" section of [[Special:Preferences]].)
  
[[Category:Help|{{PAGENAME}}]]
+
Hidden categories are automatically added to [[:Category:{{mediawiki:hidden-category-category}}]] (specified by [[MediaWiki:Hidden-category-category]]).
 +
 
 +
Hidden categories are not hidden on category pages ({{bugzilla|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.
 +
<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:Redirects|Redirect pages]] (to categories) must also use the colon, otherwise it will be added to the category instead of redirecting.
 +
 
 +
{{Languages}}
 +
[[Category:Help|Categories]]

Revision as of 16:54, 29 October 2010

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.

Spaces and line breaks before categories are ignored, thus

* A list item
[[Category:Some category]] Some text

will be rendered the same as

* A list item Some text

You will need to manually add a <br /> tag or a line break after the 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 is created when a page is created in the Category: namespace. A category page can be created the same way 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__" magic word to the category page. (Each user can choose to see them in a separate "Hidden categories" list, by checking "Show hidden categories" in the "Appearance" 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 (to categories) must also use the colon, otherwise it will be added to the category instead of redirecting.

Language: English