Quelltext der Seite Vorlage:Documentation/doc

<!-- Add categories where indicated at the bottom of this page and interwikis at Wikidata -->
{{Uses TemplateStyles|Template:Documentation/styles.css}}
{{Uses TNT|Documentation|nocat=1}}
{{TemplateBox
 |name = Documentation
 |desc-en = This template automatically displays a green documentation box like you are seeing now, and automatically loads the content from a /doc subpage. It can also load the content from other places if instructed to. It is intended for pages which are [[:en:Wikipedia:Transclusion|transcluded]] in other pages, i.e. templates, whether in the template namespace or not.
 |desc-ar = <div dir="rtl"> يعرض هذا القالب بشكل آلي صندوق توثيق أخضر مثل الذي تراه الآن، ويقوم أيضاً بتحميل محتوى الصفحة الفرعية /doc. يمكن أن يُحمَّل محتوىً من صفحات أخرى إذا جرى تضمينها. هذا القالب مُصمم ليُضمن في صفحات أخرى مثل القوالب</div>
 |desc-td-en = This template automatically displays a green documentation box like you are seeing now, and automatically loads the content from a /doc subpage. It can also load the content from other places if instructed to. It is intended for pages which are transcluded in other pages, i.e. templates, whether in the template namespace or not.

 |1        = 1
 <!-- |1aliases = List of aliases, separated by / (a slash) -->
 |1label   = pagename
 |1d-en    = Template name (if there's no explicit namespace, the page is assumed to be in the "Template:" namespace; to specify a page in the main namespace, prefix it explicitly with ":")
 |1type    = string/wiki-page-name
 |1def     = The current template page with the suffix /doc
 |1stat    = optional

 |2        = heading
 |2label   = heading text
 |2aliases = 2
 |2d-td-en= Change the text of the "documentation" heading. If this is set to blank, the entire heading line (including the first [edit] link) will also disappear. If the documentation page doesn't exist, the "edit" link includes a preload parameter so that clicking it will pre-fill the edit form with the basic documentation page format.
 |2d-en    = Change the text of the "documentation" heading. If this is set to blank, the entire heading line (including the first [edit] link) will also disappear. If the documentation page doesn't exist, the "edit" link includes a [[mw:Manual:Creating pages with preloaded text|preload]] parameter so that clicking it will pre-fill the edit form with the basic documentation page format.
 |2type    = string
 |2def     = icon and "Documentation" text
 |2stat    = optional-

 |3        = content
 |3label   = content
 |3d-en    = The content of the documentation can also be fed directly as text, instead of being specified by the name of the page containing it (parameter {{para|1}}). This option is mostly useful in a rare case where is a single documentation template is used to document many templates, with very little content change. In such a case, the {{para|content}} parameter can be used to call the documentation template with additional parameters, like <code><nowiki>content = {{Any doc page/doc |parameter1 |parameter2}}</nowiki></code>. See "Usage" section below for more examples and [[:Category:Multi-template documentation]] for examples of template documentation pages used for more than one template.
 |3d-td-en = The content of the documentation can also be fed directly as text, instead of being specified by the name of the page containing it (parameter "1="). This option is mostly useful in a rare case where is a single documentation template is used to document many templates, with very little content change. In such a case, the "content=" parameter can be used to call the documentation template with additional parameters, like "<nowiki>content = {{Any doc page/doc |parameter1 |parameter2}}</nowiki>". See "Usage" section below for more examples and "Category:Multi-template documentation" for examples of template documentation pages used for more than one template.
 |3type    = string
 |3def     = 
 |3stat    = optional-

 |namespace = template
 |usergroup = all
 |placement = bottom
 |type = 
 |setscats = 
 |lines = one
 |shorthand = 
 |relieson = 
 |mustbesubst = 
 |useTemplateData = 1
 |usage-notes = This template allows any page to use any documentation page, and makes it possible to protect templates while allowing anyone to edit the template's documentation, and categories. It also reduces server resources by circumventing a [[:en:Wikipedia:Template limits|technical limitation of templates]] (see a [{{fullurl:en:Project:Village pump (technical)|diff=prev&oldid=69888944}} developer's explanation]).

Normally this template is used without any parameters, placed at the bottom of the template or page being documented, within a {{tag|noinclude}} container:

<pre>
<!--Last line of your template code--><noinclude>
{{Documentation}}
<!-- Add categories to the /doc subpage -->
</noinclude>
</pre>

Then this template automatically loads the content from the /doc subpage of the template it is used on.

This template can also load the content from any other page. Like this:

<pre>
<!--Last line of your template code--><noinclude>
{{Documentation |Template:Other page/doc}}
</noinclude>
</pre>

Note that when loading the documentation from a page other than the local /doc page it becomes tricky to handle the categories.

The content can also be fed directly as text. Like this:

<pre>
<!--Last line of your template code--><noinclude>
{{Documentation
 | content =
(some documentation)
}}</noinclude>
</pre>

When the {{para|content}} parameter is used, the doc box normally does not show the [edit] [purge] links in the top right corner. Note that if the /doc page exists, a link to it is still shown in the link box below the doc box.

Parameter {{para|1}} and the {{para|content}} parameter can also be combined, like this:

<pre>
<!--Last line of your template code--><noinclude>
{{Documentation |1=Template:Any page/doc
| content = {{Any page/doc |parameters}}
}}</noinclude>
</pre>

Then the pagename fed as parameter 1 is used for the [edit] [purge] links and for the /doc link in the link box below the doc box. But the '''content''' parameter is used for the content shown in the doc box. The above code means that the content is transcluded as {{tnull|Template:Any page/doc{{!}}parameters}}. In this example a parameter is also fed to the /doc page being loaded.

If the documentation page contains includeonly or noinclude tags as part of the documentation, replace the "<" with "&amp;lt;". 
 |example = 
 |example-value =
 |seealso =
* {{Tl|documentation subpage}}
* [[m:Template:Documentation]]
* {{Tl|Description}}

| i18n-method = ext.translate
| i18n-desc =
Additionally, this template makes use of [[Module:TNT]] and [[Data:I18n/Documentation.tab]].
<includeonly>
[[Category:Templates using Module:TNT for internationalisation]]
</includeonly>
}}
<includeonly>{{Sandbox other||
<!-- Categories below this line; interwikis at Wikidata -->
[[Category:Documentation templates]]
[[Category:Template namespace templates]]
}}</includeonly>