en>Taravyvan Adijene |
|
| (3 intermediate revisions by 2 users not shown) |
| Line 1: |
Line 1: |
| <noinclude>
| | Used to create documentation for templates |
| <languages/>
| |
| </noinclude><includeonly>{{#invoke:documentation|main|_content={{ {{#invoke:documentation|contentTitle}}}}}}</includeonly><noinclude>
| |
| {{documentation|content=
| |
|
| |
|
| {{Lua|Module:Documentation}}
| | ==Usage== |
| <translate><!--T:12--> This template automatically displays a documentation box like the one you are seeing now, of which the content is sometimes transcluded from another page.</translate>
| | There are two ways to use this template. |
| <translate><!--T:13--> It is intended for pages which are [[<tvar name=1>Special:MyLanguage/Help:Transclusion</tvar>|transcluded]] in other pages, i.e. templates, whether in the template namespace or not.</translate>
| |
|
| |
|
| <translate> | | 1. Add to the bottom of your template: |
| ==Usage== <!--T:2-->
| | <pre><nowiki><noinclude>{{doc}}<noinclude></nowiki></pre> |
|
| |
|
| ===Customizing display=== <!--T:3-->
| | Then click on the "Create" link to get started with your documentation. |
|
| |
|
| <!--T:4-->
| | 2. Include the documentation directly in the template (not preferred method): |
| Overrides exist to customize the output in special cases:
| | <pre><nowiki><noinclude>{{doc|text= |
| </translate> | | Documentation text |
| * <nowiki>{{</nowiki>documentation{{!}}'''heading'''=<nowiki>}}</nowiki> - <translate><!--T:5--> change the text of the "documentation" heading.</translate> <translate><!--T:10--> If this is set to blank, the entire heading line (including the first [edit] link) will also disappear.</translate>
| |
|
| |
|
| <translate>
| | ==Usage== |
| ==Rationale== <!--T:6--> | | How to use the template, etc. |
| </translate>
| | }}<noinclude></nowiki></pre> |
| <translate><!--T:7--> 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.</translate>
| |
| <translate><!--T:8--> It also reduces server resources by circumventing a [[w:Wikipedia:Template limits|technical limitation of templates]] (see a [[<tvar name=1>:en:Special:Diff/69888944</tvar>|developer's explanation]]).</translate> | |
|
| |
|
| <translate> | | <noinclude>[[Category:Documentation templates]]</noinclude> |
| ==See also== <!--T:9-->
| |
| </translate>
| |
| * <translate><!--T:14--> [[w:Template:Documentation subpage]]</translate>
| |
| * {{tim|Documentation}}
| |
| * <translate><!--T:11--> [[w:Wikipedia:Template documentation]]</translate>
| |
| | |
| }}
| |
| [[Category:Formatting templates{{#translation:}}|Template documentation]]
| |
| [[Category:Template documentation{{#translation:}}| ]]
| |
| </noinclude><includeonly>{{#if:{{{content|}}}| | |
| [[Category:Template documentation pages{{#translation:}}]]
| |
| }}</includeonly>
| |
Used to create documentation for templates
Usage
There are two ways to use this template.
1. Add to the bottom of your template:
<noinclude>{{doc}}<noinclude>
Then click on the "Create" link to get started with your documentation.
2. Include the documentation directly in the template (not preferred method):
<noinclude>{{doc|text=
Documentation text
==Usage==
How to use the template, etc.
}}<noinclude>