Help:Page status indicators

From MediaWiki.org
Jump to: navigation, search

Other languages:
English • ‎español • ‎日本語 • ‎português do Brasil

Page status indicators are icons (or short text snippets) displayed outside of the main content that provide quick information about the status of the article (for example whether the page is protected or whether it is a featured article).

They are also variously called top icons, page icons, heading icons or title icons.

This functionality was added to MediaWiki 1.25 in Gerrit change 162609 to solve task T25796 and replace the numerous ad-hoc solutions to this problem, such as the English Wikipedia's 'top icon' template.

Viewing page status indicators[edit]

Vector skin screenshot with indicator area marked

Page status indicators are usually displayed in the top-right corner of the page, outside of the main content, or right before page title. Their exact location depends on the skin.

Adding page status indicators in wikitext[edit]

Use the following syntax to add indicators to a page, changing the name attribute and contents of the tag to suit your tastes.

It is strongly recommended to create a template for each indicator type you're going to need, instead of including the tag syntax directly in articles.

<indicator name="foo">[[File:Foo.svg|20px]]</indicator>

Note that:

  • Every indicator must have a unique identifier (name). It's not possible to have several indicators with the same name – in case of duplicates, the latest occurrence of the tag wins.
  • Indicators are displayed ordered by their names (case-sensitive) (and not occurrence order). This ensures consistency across pages and provides a simple means of ordering or grouping them.
  • Indicators are not tracked. They are intended to merely reflect the content or metadata that is already present on the page, and not be data themselves. You should be able to use the appropriate tracking category, template transclusions list, special page report, or other means to list pages that include a given indicator.

Customizing display on your wiki[edit]

If the skin you're using supports page status indicators (all default skins do), you can adjust their display using site and user CSS. The CSS classes to style are .mw-indicators (for the entire containing block) and .mw-indicator (for each separate indicator).

Each indicator is also given an id of #mw-indicator-name, where name is the name assigned to the indicator using the <indicator name="foo"> syntax.

Adding support for indicators in skins[edit]

See Manual:Skinning Part 2#Page status indicatorsManual:Skinning Part 2#Page status indicators.

Using indicators from PHP code[edit]

Access the OutputPageManual:OutputPage.php object and call its setIndicators() method, passing an ID and the HTML string you want displayed. If you're adding a help link to documentation, call its addHelpLink() method, also implemented by SpecialPageManual:SpecialPage.php and other classes. This puts a help link in the indicators area; for example, see Special:WhatLinksHere.