Difference between revisions 84493 and 95014 on piwiki

{{documentation subpage}}
__NOTOC__
== Usage ==
 {{tl|documentation subpage}}
'''OR'''
 {{tlx|documentation subpage|<nowiki>[[</nowiki><var>main page to link to</var><nowiki>]]</nowiki>}}

=== Userboxes ===
When used to document usage of a [[Wikipedia:Userboxes|userbox]], it may be preferred to have this template state "userbox"/"userbox page" instead of "{{lc:{{ns:Template}}}}"/"{{lc:{{ns:Template}}}} page" or "{{lc:{{ns:User}}}} template"/"{{lc:{{ns:User}}}} template page". If this is preferred, use:
 {{tl|userbox documentation subpage}}
'''OR'''
 {{tlx|userbox documentation subpage|<nowiki>[[</nowiki><var>main userbox page to link to</var><nowiki>]]</nowiki>}}

=== Customization of text ===
To manually change the text of the template, the "<code>text1=<var>your text here</var></code>" and/or "<code>text2=<var>your other text here</var></code>" parameters can be specified. "<code>text1=</code>" changes the automatic text on the first line to your own word(s). "<code>text2=</code>" changes the automatic text on the second line to your own word(s). If "<code>text1=</code>" parameter is specified without the "<code>text2=</code>" parameter, both the first and second line of text will be custom based on the text given in the "<code>text1=</code>" parameter.

Example usage:
 {{tlx|documentation subpage|text1<nowiki>=</nowiki><var>custom first and second line text</var>}}

 {{tlx|documentation subpage|text2<nowiki>=</nowiki><var>custom second line text only</var>}}

 {{tlx|documentation subpage|text1<nowiki>=</nowiki><var>custom first line text</var>|text2<nowiki>=</nowiki><var>custom second line text</var>}}

== How it is displayed ==
This template should be placed at the top of "/doc" pages. It changes output depending on where it is viewed:
* On a "/doc" page, it displays a box explaining template documentation and links to the template page.
* On other pages (ie, pages transcluding the "/doc" page), the template will not show. The template page itself (which contains <code>{{tl|Documentation}}</code>) will automatically note that the documentation is [[Wikipedia:Transclusion|transcluded]] from a subpage.

== Functions ==
In addition to the output message, the template categorizes pages to [[:Category:Template documentation pages]], [[:Category:User documentation pages]], or similar (named after the subject space), but only for documentation pages in namespaces with the subpage feature. It defaults the [[m:Help:Categories#Sort order|sort key]] to the page name without namespace (ie, "Foo" on "Template:Foo", so it would be sorted in categories under 'F').

== See also ==
* [[Wikipedia:Template sandbox and test cases]] for how this template is used.
{{ Documentation/see also }}

<includeonly>
<!-- categories and interwiki links -->
[[Category:Template documentation| {{PAGENAME}}]]
[[Category:Template namespace templates]]

[[als:Vorlage:Dokumentation/Dokuseite]]
[[ar:قالب:صفحة توثيق فرعية]]
[[as:Template:Documentation subpage]]
[[bar:Vorlage:Dokumentation/Dokuseitn]]
[[be-x-old:Шаблён:Падстаронка-дакумэнтацыя]]
[[bg:Шаблон:Подстраница с документация]]
[[bn:টেমপ্লেট:Documentation subpage]] 
[[ca:Plantilla:Subpàgina de plantilla]]
[[cs:Šablona:Podstránka s dokumentací]]
[[da:Skabelon:Skabelondokumentationsside vist direkte]]
[[de:Vorlage:Dokumentation/Dokuseite]]
[[eo:Ŝablono:Ŝablona navigado]]
[[es:Plantilla:Subpágina de documentación]]
[[fa:الگو:Documentation subpage]]
[[fr:Modèle:Documentation modèle vue directement]]
[[eu:Txantiloi:Txantiloi dokumentazio azpiorrialdea]]
[[ko:틀:틀 설명문서 안내]]
[[id:Templat:Subhalaman dokumentasi]]
[[is:Snið:Skjalsíðabe-x-old:Шаблён:Падстаронка-дакумэнтацыя]]
[[ca:Plantilla:Subpàgina de plantilla]]
[[fa:الگو:Documentation subpage]]
[[fr:Modèle:Documentation modèle vue directement]]
[[ja:template:Documentation subpage]]
[[ka:template:თარგის ინფო გვერდის ხედვა პირდაპირ]]
[[la:Formula:Documentation subpage]]
[[mk:Шаблон:Документација потстрана]]
[[ml:ഫലകം:Template doc page transcluded]]
[[nl:Sjabloon:Sjabdoc direct]]
[[nn:Mal:Dokumentasjonsunderside]]
[[no:Mal:Dokumentasjonsunderside]]
[[pl:Szablon:Podstrona dokumentacji]]
[[pt:Predefinição:Subpágina de documentaçãoo:Mal:Dokumentasjonsunderside]]
[[ro:template:Template doc page viewed directly]]
[[ru:Шаблон:Docpage]]⏎
[[simple:Template:Documentation subpage]]
[[sl:template:Dokumentacijska podstran]]
[[sl:template:Dokumentacijska podstran]]
[[sq:Stampa:Documentation subpage]]
[[sv:Mall:Dokumentationssida]]
[[tpi:Template:Documentation subpage]]
[[th:แม่แบบ:Documentation subpage]]
[[tn:Template:Documentation subpage]]
[[ta:வார்ப்புரு:Documentation subpage]]
[[tr:Şablon:Şablon belge sayfası]]
[[uk:Шаблон:Підсторінка документації]]
[[ur:Templateth:แม่แบบ:Documentation subpage]]
[[zh:模板:Template doc page viewed directly]]
</includeonly>