Template:Documentation subpage/doc: Difference between revisions

Latest revision as of 09:15, 12 August 2026

This subpage contains documentation, categories, or other content that is not part of the template.
To view the template page itself, see Template:Documentation subpage.

العربية ∙ asturianu ∙ Boarisch ∙ беларуская (тарашкевіца) ∙ български ∙ বাংলা ∙ català ∙ čeština ∙ dansk ∙ Deutsch ∙ Zazaki ∙ Ελληνικά ∙ English ∙ Esperanto ∙ español ∙ eesti ∙ euskara ∙ فارسی ∙ suomi ∙ français ∙ galego ∙ עברית ∙ हिन्दी ∙ hrvatski ∙ magyar ∙ Bahasa Indonesia ∙ italiano ∙ 日本語 ∙ ქართული ∙ 한국어 ∙ кыргызча ∙ Lëtzebuergesch ∙ македонски ∙ മലയാളം ∙ ဘာသာမန် ∙ Bahasa Melayu ∙ Mirandés ∙ မြန်မာဘာသာ ∙ norsk bokmål ∙ Plattdüütsch ∙ Nederlands ∙ norsk ∙ polski ∙ português ∙ português do Brasil ∙ русский ∙ sicilianu ∙ Scots ∙ slovenščina ∙ српски / srpski ∙ svenska ∙ ไทย ∙ Türkçe ∙ українська ∙ اردو ∙ oʻzbekcha / ўзбекча ∙ Tiếng Việt ∙ 中文 ∙ 中文（简体） ∙ 中文（繁體） ∙ 中文（臺灣） ∙ +/−

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

Template parameters

Parameter text is empty

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.

Template parameters
This template prefers inline formatting of parameters.
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”. Suggested values `override` Auto value `override`	Line	optional
Category	`category`	The category to add the documentation subpage to. Default Depends on the namespace: Template or other namespace [[Category:Template documentation]] Module namespace [[Category:Module documentation]] User namespace [[Category:User documentation]]	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. Default {{NAMESPACE}}:{{BASEPAGENAME}}	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

Localization

العربية ∙ asturianu ∙ Boarisch ∙ беларуская (тарашкевіца) ∙ български ∙ বাংলা ∙ català ∙ čeština ∙ dansk ∙ Deutsch ∙ Zazaki ∙ Ελληνικά ∙ English ∙ Esperanto ∙ español ∙ eesti ∙ euskara ∙ فارسی ∙ suomi ∙ français ∙ galego ∙ עברית ∙ हिन्दी ∙ hrvatski ∙ magyar ∙ Bahasa Indonesia ∙ italiano ∙ 日本語 ∙ ქართული ∙ 한국어 ∙ кыргызча ∙ Lëtzebuergesch ∙ македонски ∙ മലയാളം ∙ ဘာသာမန် ∙ Bahasa Melayu ∙ Mirandés ∙ မြန်မာဘာသာ ∙ norsk bokmål ∙ Plattdüütsch ∙ Nederlands ∙ norsk ∙ polski ∙ português ∙ português do Brasil ∙ русский ∙ sicilianu ∙ Scots ∙ slovenščina ∙ српски / srpski ∙ svenska ∙ ไทย ∙ Türkçe ∙ українська ∙ اردو ∙ oʻzbekcha / ўзбекча ∙ Tiếng Việt ∙ 中文 ∙ 中文（简体） ∙ 中文（繁體） ∙ 中文（臺灣） ∙ +/−

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.

@@ Line 1: / Line 1: @@
-{{documentation subpage}}
+<!-- Add categories where indicated at the bottom of this page and interwikis at Wikidata -->
+{{TemplateBox
+|1=1
+|1label-en=override
+|1d-en=If set to “override”, allows to force the display of this template. Use only if the documentation page does not end in “/doc”.
+ |1d-bar=Is da Parametar aufm Weat „override“ gsetzt, wead de Vurlog ozoagt. Dea Weat wead heagnomma, wenn de Dokumentazionsuntaseitn ned „/doc“ is.
+ |1d-ca=Si es posa com a “override“, permet forçar la visualització d'aquesta plantilla. S'ha d'emprar només si la pàgina de documentació no finalitza en « /doc ».
+ |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-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
+|1sv=override
+|1av=override
+|1def=
+|1stat=optional-
-==Usage==
+|2=page
-<pre>
+|2label-en=page
-{{documentation subpage}}
+ |2label-ca=pàgina
-or: {{documentation subpage|[[main page to link to]]|[[documentation to link to]]}}
+ |2label-de=Seite
-</pre>
+ |2label-fr=page
-This template should be placed at the top of "/doc" pages. It changes output depending on where it is viewed:
+|2d-en=Full page name of the described template. Use only if the documentation page is not a subpage of the described template.
-* On a "/doc" page, it displays a box explaining template documentation and links to the template page.
+ |2d-bar=Ganza Seitnnama vo da Vurlog, zu dea de Beschraibung kheardt. Dea Parametar wead nua heagnomma, wenn de Dokumentazionsseitn koa Untaseitn vo da Vurlog is, zu dea de Beschraibung kheardt.
-* On other pages (ie, pages transcluding the "/doc" page), it notes that the documentation is transcluded from a subpage.
+ |2d-ca=Nom complet de la pàgina on es descriu la plantilla. Utilitzar només si la pàgina de documentació no és una subpágina de la plantilla descrita.
+ |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-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
+|2def=<nowiki>{{NAMESPACE}}:{{BASEPAGENAME}}</nowiki>
+|2stat=optional-
-==Functions==
+|name=Documentation subpage
-In addition to the output message, the template categorizes pages to [[:Category:Documentation subpages|Documentation subpages]] and 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').
+|desc-en=Place this template at the top of all template documentation subpages. It does not need to be in <no<nowiki />include> tags because it will only show up on “/doc” subpages.
+ |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-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
+|usergroup=all
+|placement=top
+|usage-notes=
+|type=documentation
+|example=
+|i18n-method=autotranslate
+|i18n-desc=
+|i18n-mediawiki-msg=
+|seealso=* [[m:Template:Documentation]], [[:w:Wikipedia:Template documentation]] <!--
+-->{{LangSwitch|
+|bar=(zua Dårstellung wia de Vurlog heagnomma wird)
+|de=(zur Darstellung wie die Vorlage benutzt wird)
+|en=(for how this template is used)
+|fr=(pour le guide d'utilisation de ce modèle)
+}}
+* {{tl2|Doc-inline}}, {{tl2|doc-end}}
-==See also==
+| setscats =
-* [[m:Template:Documentation]] or [[:en:Wikipedia:Template documentation]] for how this template is used.
+* {{C|Template documentation|+}} – Documentation subpages in the {{ll|Help:Namespaces#Template|Template}} and other namespace.
+* {{C|Module documentation|+}} – Documentation subpages in the {{ll|Help:Namespaces#Module|Module}} namespace.
+* {{C|User documentation|+}} – Documentation subpages in the {{ll|Help:Namespaces#User|User}} namespace.
-<includeonly>
+|shorthand=
+| print = line
+| useTemplateData = only
+| 3 = category
+| 3label-en = Category
+| 3description-en = The category to add the documentation subpage to.
+| 3default-en =
+Depends on the namespace:
+; Template or other namespace
+: <nowiki>[[Category:Template documentation]]</nowiki>
+; Module namespace
+: <nowiki>[[Category:Module documentation]]</nowiki>
+; User namespace
+: <nowiki>[[Category:User documentation]]</nowiki>
+<nowiki/>
+| 3stat = optional-
+| 3type = line
+}}
+<includeonly>{{Sandbox other||
+<!-- Categories below this line; interwikis at Wikidata -->
+[[Category:Documentation templates]]
 [[Category:Template documentation| ]]
-[[Category:Template namespace templates|{{PAGENAME}}]]
+[[Category:Template namespace templates]]
+}}</includeonly>
-[[bg:template:Директно гледана документация]]
-[[da:template:Template doc page viewed directly]]
-[[en:Template:Documentation subpage]]
-[[es:template:Template doc page viewed directly]]
-[[fr:template:Template doc page viewed directly]]
-[[id:template:Dokumentasi templat dilihat langsung]]
-[[ka:template:თარგის ინფო გვერდის ხედვა პირდაპირ]]
-[[ml:ഫലകം:Template doc page transcluded]]
-[[nl:template:Sjabdoc direct]]
-[[ja:template:テンプレート文書直接表示]]
-[[pl:template:Opis szablonu bezpośrednio]]
-[[ro:template:Template doc page viewed directly]]
-[[simple:template:Template doc page viewed directly]]
-[[sl:template:Dokumentacijska podstran]]
-[[uk:template:Документація шаблона (безпосередня)]]
-[[zh:template:Template doc page viewed directly]]
-</includeonly>

CodexBot (talk | contribs)

Latest revision as of 09:15, 12 August 2026

Usage

Template parameters

Additional information

See also

Localization