Template:Documentation subpage: Difference between revisions

Revision as of 17:03, 28 May 2013

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 ∙ 中文 ∙ 中文（简体） ∙ 中文（繁體） ∙ 中文（臺灣） ∙ +/−

Template documentation[ view · edit · history · purge ]

This documentation is transcluded from Template:Documentation subpage/doc.

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[Edit template data]
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: @@
-<includeonly>{{#ifeq: {{lc:{{SUBPAGENAME}}}} | {{{override|doc}}}
+<includeonly><!--
-  | <!-- doc page -->
+-->{{#ifeq:{{SUBPAGENAME}}|{{#ifeq:{{{1|}}}|override|{{SUBPAGENAME}}|doc}}|</includeonly><!-- show on doc pages only
-</includeonly>{{
+  -->{{Documentation subpage/{{Fallback|Documentation subpage}}}}<!--
-    #ifeq: {{{doc-notice|show}}} | show
+  -->{{{category|[[Category:Template documentation|<noinclude> </noinclude><includeonly>{{PAGENAME}}</includeonly>]]}}}<!--
-    | {{mbox
+--><includeonly>}}</includeonly><!--  show on doc pages only
-      | type = notice
+--><noinclude>{{documentation}}</noinclude>
-      | image = [[File:Edit-copy green.svg|40px|link=]]
-      | text =
-{{LangSwitch
-|de       = '''Diese Seite ist die Dokumentations-Unterseite von {{{1|[[:{{SUBJECTSPACE}}:{{BASEPAGENAME}}]]}}}'''.
-|en       = '''This is a [[meta:Help:Template documentation|documentation]] [[mw:Help:Subpages|subpage]] for {{{1|[[:{{SUBJECTSPACE}}:{{BASEPAGENAME}}]]}}}'''.<br />It contains usage information, [[Meta:Categorization|categories]], [[meta:Help:Interlanguage links|interlanguage links]] and other content that is not part of the original {{ #if: {{{text2|}}} | {{{text2}}} | {{ #if: {{{text1|}}} | {{{text1}}} | {{ #ifeq: {{SUBJECTSPACE}} | {{ns:User}} | {{lc:{{SUBJECTSPACE}}}} template page | {{ #if: {{SUBJECTSPACE}} |{{lc:{{SUBJECTSPACE}}}} page|article}}}}}}}}.
-|fr       = '''Cette page est une sous-page contenant la documentation de la page {{{1|[[:{{SUBJECTSPACE}}:{{BASEPAGENAME}}]]}}}'''.<br />Elle contient des informations, des catégories et des liens interwikis qui ne font pas partie de la page principale.
-|it       = '''Questa è una [[mw:Help:Subpages|sottopagina]] di [[meta:Help:Template documentation|documentazione]] per {{{1|[[:{{SUBJECTSPACE}}:{{BASEPAGENAME}}]]}}}'''.<br />Contiene informazioni sull'uso, [[Meta:Categorization|categorie]], [[meta:Help:Interlanguage links|collegamenti interlinguistici]] e altri contenuti che non fanno parte della pagina principale.
-}}
-      }}
-    }}{{DEFAULTSORT:{{{defaultsort|{{PAGENAME}}}}}}}{{
-    #if: {{{inhibit|}}}
-    | <!-- skip -->
-    | <includeonly>{{#ifexist:{{NAMESPACE}}:{{BASEPAGENAME}}|[[Category:{{
-      #switch: {{SUBJECTSPACE}}
-      | Template  = Template
-      | User      = User
-      | #default  = Wikipedia
-    }} documentation pages]]|[[Category:Documentation subpages without corresponding pages]]}}</includeonly>
-  }}<includeonly>
-| <!-- if not on a /doc subpage, do nothing -->
-}}</includeonly><noinclude>
-{{documentation}}
-<!-- Add categories and interwikis to the /doc subpage, not here! -->
-</noinclude>