Difference between revisions of "Template:Documentation subpage/doc"

From blackwiki
Jump to navigation Jump to search
test>Arctic Night
m (Reverted edits by Astrologist praveen (talk) to last revision by کاشف عقیل (HG))
test>Labant
m (more languages)
Line 1: Line 1:
 
{{documentation subpage}}
 
{{documentation subpage}}
 
__NOTOC__
 
__NOTOC__
==Usage==
+
== Usage ==
 
  {{tl|documentation subpage}}
 
  {{tl|documentation subpage}}
 
'''OR'''
 
'''OR'''
 
  {{tlx|documentation subpage|<nowiki>[[</nowiki><var>main page to link to</var><nowiki>]]</nowiki>}}
 
  {{tlx|documentation subpage|<nowiki>[[</nowiki><var>main page to link to</var><nowiki>]]</nowiki>}}
  
===Userboxes===
+
=== 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:
 
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}}
 
  {{tl|userbox documentation subpage}}
Line 12: Line 12:
 
  {{tlx|userbox documentation subpage|<nowiki>[[</nowiki><var>main userbox page to link to</var><nowiki>]]</nowiki>}}
 
  {{tlx|userbox documentation subpage|<nowiki>[[</nowiki><var>main userbox page to link to</var><nowiki>]]</nowiki>}}
  
===Customization of text===
+
=== 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.
 
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.
  
Line 22: Line 22:
 
  {{tlx|documentation subpage|text1<nowiki>=</nowiki><var>custom first line text</var>|text2<nowiki>=</nowiki><var>custom second line text</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==
+
== How it is displayed ==
 
This template should be placed at the top of "/doc" pages. It changes output depending on where it is viewed:
 
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 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.
 
* 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==
+
== Functions ==
 
In addition to the output message, the template categorizes pages to [[:Category:Template documentation]], [[:Category:User documentation]], 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').
 
In addition to the output message, the template categorizes pages to [[:Category:Template documentation]], [[:Category:User documentation]], 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==
+
== See also ==
* [[Wikipedia:Template documentation]] for how this template is used.
+
* [[Wikipedia:Template sandbox and test cases]] for how this template is used.
{{ Documentation/doc/see also }}
+
{{ Documentation/see also }}
  
 
<includeonly>
 
<includeonly>
Line 39: Line 39:
 
[[Category:Template namespace templates]]
 
[[Category:Template namespace templates]]
  
 +
[[als:Vorlage:Dokumentation/Dokuseite]]
 
[[ar:قالب:صفحة توثيق فرعية]]
 
[[ar:قالب:صفحة توثيق فرعية]]
 +
[[bar:Vorlage:Dokumentation/Dokuseitn]]
 
[[be-x-old:Шаблён:Падстаронка-дакумэнтацыя]]
 
[[be-x-old:Шаблён:Падстаронка-дакумэнтацыя]]
 
[[bg:Шаблон:Подстраница с документация]]
 
[[bg:Шаблон:Подстраница с документация]]
 
[[ca:Plantilla:Subpàgina de plantilla]]
 
[[ca:Plantilla:Subpàgina de plantilla]]
 
[[cs:Šablona:Podstránka s dokumentací]]
 
[[cs:Šablona:Podstránka s dokumentací]]
 +
[[da:Skabelon:Skabelondokumentationsside vist direkte]]
 +
[[de:Vorlage:Dokumentation/Dokuseite]]
 +
[[es:Plantilla:Subpágina de documentación]]
 
[[fa:الگو:Documentation subpage]]
 
[[fa:الگو:Documentation subpage]]
[[es:Plantilla:Subpágina de documentación]]
+
[[fr:Modèle:Documentation modèle vue directement]]
 
[[eu:Txantiloi:Txantiloi dokumentazio azpiorrialdea]]
 
[[eu:Txantiloi:Txantiloi dokumentazio azpiorrialdea]]
 
[[hy:Կաղապար:Documentation subpage]]
 
[[hy:Կաղապար:Documentation subpage]]
Line 51: Line 56:
 
[[is:Snið:Skjalsíða]]
 
[[is:Snið:Skjalsíða]]
 
[[ja:template:Documentation subpage]]
 
[[ja:template:Documentation subpage]]
[[la:formula:Documentation subpage]]
+
[[ka:template:თარგის ინფო გვერდის ხედვა პირდაპირ]]
 +
[[la:Formula:Documentation subpage]]
 
[[mk:Шаблон:Документација потстрана]]
 
[[mk:Шаблон:Документација потстрана]]
[[no:mal:Documentation subpage]]
+
[[ml:ഫലകം:Template doc page transcluded]]
 +
[[nl:Sjabloon:Sjabdoc direct]]
 +
[[nn:Mal:Dokumentasjonsunderside]]
 +
[[no:Mal:Dokumentasjonsunderside]]
 
[[pl:Szablon:Podstrona dokumentacji]]
 
[[pl:Szablon:Podstrona dokumentacji]]
 
[[pt:Predefinição:Subpágina de documentação]]
 
[[pt:Predefinição:Subpágina de documentação]]
[[ru:Шаблон:Подстраница документации]]
+
[[ro:template:Template doc page viewed directly]]
 +
[[ru:Шаблон:Docpage]]
 +
[[simple:Template:Documentation subpage]]
 +
[[sl:template:Dokumentacijska podstran]]
 
[[sl:template:Dokumentacijska podstran]]
 
[[sl:template:Dokumentacijska podstran]]
 
[[sq:Stampa:Documentation subpage]]
 
[[sq:Stampa:Documentation subpage]]
 +
[[sv:Mall:Dokumentationssida]]
 
[[tpi:Template:Documentation subpage]]
 
[[tpi:Template:Documentation subpage]]
 +
[[tr:Şablon:Belgeleme]]
 
[[uk:Шаблон:Підсторінка документації]]
 
[[uk:Шаблон:Підсторінка документації]]
 
[[ur:Template:Documentation subpage]]
 
[[ur:Template:Documentation subpage]]
 +
[[zh:模板:Template doc page viewed directly]]
 
</includeonly>
 
</includeonly>

Revision as of 11:46, 14 November 2010

Usage

{{documentation subpage}}

OR

{{documentation subpage|[[main page to link to]]}}

Userboxes

When used to document usage of a userbox, it may be preferred to have this template state "userbox"/"userbox page" instead of "template"/"template page" or "user template"/"user template page". If this is preferred, use:

{{userbox documentation subpage}}

OR

{{userbox documentation subpage|[[main userbox page to link to]]}}

Customization of text

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

Example usage:

{{documentation subpage|text1=custom first and second line text}}
{{documentation subpage|text2=custom second line text only}}
{{documentation subpage|text1=custom first line text|text2=custom second line text}}

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 {{Documentation}}) will automatically note that the documentation is transcluded from a subpage.

Functions

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

See also

General information about documentation for templates:

{{Documentation}} family:

Meta-Wiki {{Documentation}} ancestor: