View source for Help:Page status indicators

<languages />
<translate>
<!--T:1-->
'''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 {{<tvar name=1>ll|Help:Protected pages</tvar>|protected}} or whether it is a [[w:WP:FA|featured article]]).

<!--T:2-->
They are also variously called top icons, page icons, heading icons or title icons.

<!--T:3-->
This functionality was added to {{<tvar name=1>ll|MediaWiki 1.25</tvar>|MediaWiki 1.25}} in <tvar name=gerrit>{{gerrit|162609}}</tvar> to solve <tvar name=bug>{{task|T25796}}</tvar> and replace the numerous ad-hoc solutions to this problem, such as the English Wikipedia's [[w:Template:Top icon|‘top icon’ template]].

== Viewing page status indicators == <!--T:4-->
</translate>
[[File:Page status indicators position (San Francisco).png|350px|thumb|<translate><!--T:5--> Vector skin screenshot with indicator area marked.</translate>]]
<translate><!--T:6--> Page status indicators are usually displayed in the top-right corner of the page, outside of the main content, or right before page title.</translate>
<translate><!--T:28--> Their exact location depends on the {{<tvar name=1>ll|Help:Skins</tvar>|skin}}.</translate>
{{clear}}

<translate>
== Adding page status indicators == <!--T:7-->

<!--T:8-->
Use the following syntax to add indicators to a page, changing the <tvar name=1><code>name</code></tvar> attribute and contents of the tag to suit your tastes.

<!--T:9-->
It is strongly recommended to create a {{<tvar name=1>ll|Help:Templates</tvar>|template}} for each indicator type you're going to need, instead of including the tag syntax directly in articles.

<!--T:29-->
Wikitext syntax:</translate>
<syntaxhighlight lang="html">
<indicator name="foo">[[File:Foo.svg|20px]]</indicator>
</syntaxhighlight>

<translate>
<!--T:30-->
Lua module syntax:</translate>

<syntaxhighlight lang=lua>
mw.getCurrentFrame():extensionTag {
	name = "indicator",
	content = '[[File:Foo.svg|20px]]',
	args = {
		name = "foo"
	}
}
</syntaxhighlight>

<translate>
<!--T:10-->
Note that:
</translate>

* <translate><!--T:33--> When using a caption on the image, the caption automatically becomes a <tvar name="1"><code>title</code></tvar> attribute with the contents of the caption.</translate>
* <translate><!--T:32--> Any wikitext can be added, not just images.</translate> <translate><!--T:31--> (<tvar name=1>{{ll|Help:TemplateStyles|nsp=0}}</tvar> is only supported starting with <tvar name=3>{{ll|MediaWiki 1.39}}</tvar>, see <tvar name=2>{{T|188443}}</tvar>.)</translate>
* <translate><!--T:11--> Every indicator must have a unique identifier (name).</translate> <translate><!--T:12--> It's not possible to have several indicators with the same name – in case of duplicates, the latest occurrence of the tag wins.</translate>
* <translate><!--T:13--> Indicators are displayed ordered by their names (case-sensitive) and not in order of their occurrence.</translate> <translate><!--T:14--> This ensures consistency across pages and provides a simple means of ordering or grouping them.</translate>
* <translate><!--T:15--> Indicators are not tracked.</translate> <translate><!--T:16--> They are intended to merely reflect the content or metadata that is already present on the page, and not be data themselves.</translate> <translate><!--T:17--> You should be able to use the appropriate {{<tvar name=1>ll|Help:Tracking categories</tvar>|tracking category}}, template {{<tvar name=2>ll|Transclusion</tvar>|transclusions}} list, {{<tvar name=3>ll|Help:Special pages</tvar>|special page}} report, or other means to list pages that include a given indicator.</translate>

<translate>
== Known problems == <!--T:34-->
</translate>
* <translate><!--T:35--> They are not displayed by <tvar name=1>{{ll|Skin:Minerva Neue}}</tvar>, see <tvar name=2>[[phab:T75299]]</tvar>.</translate>
* <translate><!--T:36--> They cannot be previewed in the <tvar name=1>{{ll|VisualEditor}}</tvar>.</translate>
* You cannot add a widget of the [[Extension:Widgets|Widgets extension]] between indicator tags. 
<translate>

== Customizing display on your wiki == <!--T:18-->
</translate>
<translate><!--T:19--> If the skin you're using supports page status indicators (all default skins do), you can adjust their display using [[<tvar name=man>Special:MyLanguage/Manual:Skin configuration#Site-wide CSS modifications</tvar>|site and user CSS]].</translate>
<translate><!--T:20--> The CSS classes to style are <tvar name=1><code>.mw-indicators</code></tvar> (for the entire containing block) and <tvar name=2><code>.mw-indicator</code></tvar> (for each separate indicator).</translate>

<translate>
<!--T:21-->
Each indicator is also given an ID of <tvar name=1><code>#mw-indicator-''name''</code></tvar>, where <tvar name=2><code>''name''</code></tvar> is the name assigned to the indicator using the <tvar name=indicator><syntaxhighlight lang=html inline><indicator name="foo"></syntaxhighlight></tvar> syntax.

== Adding support for indicators in skins == <!--T:22-->

<!--T:23-->
See <tvar name=2><code>array-indicators</code></tvar> on <tvar name=1>{{ll|Manual:SkinMustache.php#Template_data}}</tvar>.

== Using indicators from PHP code == <!--T:24-->
</translate>
<translate><!--T:25--> Access the <tvar name=OutputPage>{{ll|Manual:OutputPage.php|OutputPage}}</tvar> object and call its <tvar name=setIndicators><code>setIndicators()</code></tvar> method, passing an ID and the HTML string you want displayed.</translate>
<translate><!--T:26--> If you're adding a help link to documentation, call its <tvar name=addHelpLink><code>addHelpLink()</code></tvar> method, also implemented by <tvar name=SpecialPage>{{ll|Manual:SpecialPage.php|SpecialPage}}</tvar> and other classes.</translate>
<translate><!--T:27--> This puts a help link in the indicators area; for example, see <tvar name=1>[[Special:WhatLinksHere]]</tvar>.</translate>

[[Category:Help{{#translation:}}]]