Modèle:Documentation subpage

De TI-Planet Wiki
Aller à : navigation, rechercher
[edit] [history] [purge] 50px Template documentation

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 "modèle"/"modèle page" or "utilisateur template"/"utilisateur 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 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 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:

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íða 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ção 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:Template:Documentation subpage zh:模板:Template doc page viewed directly