Template:Documentation subpage/doc: Difference between revisions
More actions
Add “autovalue” for parameter `1` (the override parameter) |
Prefix language interwiki links with w: |
||
| (5 intermediate revisions by 5 users not shown) | |||
| Line 8: | Line 8: | ||
|1d-de=Ist der Parameter auf den Wert „override“ gesetzt, wird diese Vorlage angezeigt. Dieser Wert wird benutzt, wenn die Dokumentationsunterseite nicht „/doc“ ist. | |1d-de=Ist der Parameter auf den Wert „override“ gesetzt, wird diese Vorlage angezeigt. Dieser Wert wird benutzt, wenn die Dokumentationsunterseite nicht „/doc“ ist. | ||
|1d-fr=Si passé comme « override », permet de forcer l’affichage de ce modèle. N’utiliser que si la page de documentation page ne se termine pas en « /doc ». | |1d-fr=Si passé comme « override », permet de forcer l’affichage de ce modèle. N’utiliser que si la page de documentation page ne se termine pas en « /doc ». | ||
|1d-pt=Se definido para « override », permite forçar a exibição deste modelo. Utilize apenas se a página da documentação não terminar em “/doc”. | |||
|1type=line | |1type=line | ||
|1sv=override | |1sv=override | ||
| Line 24: | Line 25: | ||
|2d-de=Ganzer Seitenname der beschriebenen Vorlage. Diser Parameter wird nur verwendet, wenn die Dokumentationsseite keine Unterseite der beschriebenen Vorlage ist. | |2d-de=Ganzer Seitenname der beschriebenen Vorlage. Diser Parameter wird nur verwendet, wenn die Dokumentationsseite keine Unterseite der beschriebenen Vorlage ist. | ||
|2d-fr=Nom de page complet du modèle décrit. N’utiliser que si la page de documentation n’est pas une sous-page du modèle décrit. | |2d-fr=Nom de page complet du modèle décrit. N’utiliser que si la page de documentation n’est pas une sous-page du modèle décrit. | ||
|2d-pt=Nome da página completa do modelo descrito. Utilize apenas se a página da documentação não é uma subpágina do modelo descrito. | |||
|2type=wiki-page-name | |2type=wiki-page-name | ||
|2def=<nowiki>{{NAMESPACE}}:{{BASEPAGENAME}}</nowiki> | |2def=<nowiki>{{NAMESPACE}}:{{BASEPAGENAME}}</nowiki> | ||
| Line 32: | Line 34: | ||
|desc-bar=De Vurlog <nowiki>{{documentation subpage}}</nowiki> wead an ålle Vurlogn-Dokumentazionsseitn oben hiigschriibn. De Vurlog muas ned in <no<nowiki />include> definiirt weadn, då de Vurlog nua auf de Untaeitn „/doc“-Seiten ozoagt werdn. | |desc-bar=De Vurlog <nowiki>{{documentation subpage}}</nowiki> wead an ålle Vurlogn-Dokumentazionsseitn oben hiigschriibn. De Vurlog muas ned in <no<nowiki />include> definiirt weadn, då de Vurlog nua auf de Untaeitn „/doc“-Seiten ozoagt werdn. | ||
|desc-de=Diese Vorlage wird an allen Vorlagen-Dokumentationsseiten oben angebracht. Die Vorlage muss nicht in <no<nowiki />include> definiert werden, da die Vorlage nur auf den Unterseiten „/doc“-Seiten angezeigt werden. | |desc-de=Diese Vorlage wird an allen Vorlagen-Dokumentationsseiten oben angebracht. Die Vorlage muss nicht in <no<nowiki />include> definiert werden, da die Vorlage nur auf den Unterseiten „/doc“-Seiten angezeigt werden. | ||
|desc-fr=Placez <nowiki>{{documentation subpage}}</nowiki> en haut des sous-pages de documentation de modèle. Il n’est pas nécessaire de le placer dans des balises <no<nowiki />include> car il | |desc-fr=Placez <nowiki>{{documentation subpage}}</nowiki> en haut des sous-pages de documentation de modèle. Il n’est pas nécessaire de le placer dans des balises <no<nowiki />include> car il n’apparaîtra que sur les sous-pages nommées « /doc ». | ||
|desc-pt=Coloque este modelo no topo das subpáginas da documentação do modelo. Não precisa de estar nas etiquetas <no<nowiki />include> porque só irá aparecer nas subpáginas de “/doc”. | |||
|namespace=Template | |namespace=Template | ||
|usergroup=all | |usergroup=all | ||
| Line 42: | Line 45: | ||
|i18n-desc= | |i18n-desc= | ||
|i18n-mediawiki-msg= | |i18n-mediawiki-msg= | ||
|seealso=[[m:Template:Documentation]], [[: | |seealso=* [[m:Template:Documentation]], [[:w:Wikipedia:Template documentation]] <!-- | ||
-->{{LangSwitch| | -->{{LangSwitch| | ||
|bar=(zua Dårstellung wia de Vurlog heagnomma wird) | |bar=(zua Dårstellung wia de Vurlog heagnomma wird) | ||
| Line 49: | Line 52: | ||
|fr=(pour le guide d'utilisation de ce modèle) | |fr=(pour le guide d'utilisation de ce modèle) | ||
}} | }} | ||
* {{tl2|Doc-inline}}, {{tl2|doc-end}} | |||
| setscats = | | setscats = | ||
Latest revision as of 09:15, 12 August 2026
Place this template at the top of all template documentation subpages. It does not need to be in <noinclude> tags because it will only show up on “/doc” subpages.
The template automatically sets the following categories:
- Category:Template documentation – Documentation subpages in the Template and other namespace.
- Category:Module documentation – Documentation subpages in the Module namespace.
- Category:User documentation – Documentation subpages in the User namespace.
Usage
{{Documentation subpage}}
Template parameters
- TemplateData
TemplateData is a way to store information about template parameters (the description of those and of the whole template) for both humans and machines. It is used by VisualEditor and possibly other tools like Upload Wizard.
Existing template documentation
At Wikimedia Commons, it is recommended to use {{TemplateBox}} with either useTemplateData=1 or useTemplateData=only on the /doc subpage and transcluding it with {{Documentation}} into the template. <nowiki>-tags can be wrapped around the arguments, if required, to avoid templates being expanded.
Newly created template documentation and imports
Another option, especially for imported templates, or for users with JSON experience, is placing raw <templatedata>-tags into the Wikitext of the template, as described in various Wikipediae.
Wikipedia's help about TemplateData • Commons-specific information
Place this template at the top of all template documentation subpages. It does not need to be in <noinclude> tags because it will only show up on “/doc” subpages.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| override | 1 | If set to “override”, allows to force the display of this template. Use only if the documentation page does not end in “/doc”.
| Line | optional |
| Category | category | The category to add the documentation subpage to.
| Line | optional |
| page | page | Full page name of the described template. Use only if the documentation page is not a subpage of the described template.
| Page name | optional |
Additional information
The template is intended to be used in the following namespaces: the Template namespace
The template is intended to be used by the following user groups: all users
Placement: At the top of the page
See also
- m:Template:Documentation, w:Wikipedia:Template documentation (for how this template is used)
{{Doc-inline}},{{doc-end}}
Localization
This template is localized through {{Autotranslate}}. The layout of the template can be found under Template:Documentation subpage/layout.
To add your language to the list of languages supported by this template, please copy the code of Template:Documentation subpage/en (or any other language version you prefer to translate) and replace the text strings in there (the form below can be used to create a translation, the English version is preloaded in the edit box). Please change the parameter lang from en (or whatever language you are translating) to the language code of your language.