Difference between revisions of "Template:Documentation/doc"
(Created page with "{{TemplateBox |1=1 |1d={{LangSwitch | de = Mit diesem Parameter wird ein alternatives Ziel für die Dokumentationsunterseite definiert. | en = This parameter defines an al...") |
(No difference)
|
Latest revision as of 11:52, 20 May 2019
| 40px | This is a documentation subpage for Template:Documentation. It contains usage information, categories, and other content that is not part of the original template page. |
This template can be used to export the documentation of a template to an external page.
Usage
{{Documentation|1=|preload=|heading=|heading-style=|content=}}
You should add this template within <noinclude> tags so that it does not appear if the template is used anywhere else.
You can find all templates who include this template but do not have a documentation subpage by this list.
Parameters
| Parameter name | Description | Default value | required or optional?
|
|---|---|---|---|
| parameter #1 (1) | This parameter defines an alternative target for the documentation subpage. Default /doc. | empty | optional |
| preload | WIth this parameter, an alternative taget for the preload page is specified. | empty | optional |
| heading | This parameter can be an alternative headline are displayed. | ¬ | optional |
| heading-style | WIth this alternative parameter settings for the documentation can be specified. | empty | optional |
| content | The standard header will not displayed when the parameter content are value.
|
empty | optional |
Additional information
The template is intended to be used in the following namespaces: all namespaces
The template is intended to be used by the following user groups: all users
Relies on:
{{Documentation/docspace}},
{{Documentation/start box}},
{{Documentation/start box2}},
{{Documentation/end box}},
{{Documentation/end box2}},
{{Documentation/template page}},
{{Purge}},
{{Protected}},
{{Fmbox}}
See also
{{TemplateBox}}(Template can be insered on the standardization of documentation subpage)
Localization
This template is not intended to be localized.
The localization of the headline is included in the subtemplate {{Documentation/start box}}, the localization for the bottom box is included in the subtemplate {{Documentation/end box}}.