|
|
| Line 1: |
Line 1: |
| | <includeonly> |
| | <!-- Simple Documentation Template (no Lua) --> |
| | |
| | <!-- Try to include the /doc subpage if it exists --> |
| | {{#ifexist:{{FULLPAGENAME}}/doc |
| | | <div style="border:1px solid #a2a9b1; background-color:#f8f9fa; padding:0.5em; margin-top:1em;"> |
| | <strong>Template documentation</strong><br /> |
| | {{{{FULLPAGENAME}}/doc}} |
| | </div> |
| | | <!-- No /doc page found --> |
| | }} |
| | </includeonly> |
| <noinclude> | | <noinclude> |
| <languages/>
| | This is a simple fallback for <code><nowiki>{{documentation}}</nowiki></code>. |
| </noinclude><includeonly>{{#invoke:documentation|main|_content={{ {{#invoke:documentation|contentTitle}}}}}}</includeonly><noinclude>
| | It automatically shows the content of a <code>/doc</code> subpage if it exists. |
| {{documentation|content=
| |
| | |
| {{Lua|Module:Documentation}}
| |
| <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>
| |
| <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> | |
| == Usage == <!--T:2-->
| |
| | |
| === Customising display === <!--T:3-->
| |
| | |
| <!--T:4-->
| |
| Overrides exist to customise the output in special cases:
| |
| </translate>
| |
| * <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>
| |
| == Rationale == <!--T:6-->
| |
| </translate>
| |
| <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>
| | Usage: |
| == See also == <!--T:9-->
| | <pre><nowiki>{{documentation}}</nowiki></pre> |
| </translate> | |
| * <translate><!--T:14--> [[w:Template:Documentation subpage]]</translate>
| |
| * {{tim|Documentation}}
| |
| * <translate><!--T:11--> [[w:Wikipedia:Template documentation]]</translate>
| |
|
| |
|
| }}
| | Create a subpage named <code>Template:YourTemplateName/doc</code> for the documentation text. |
| [[Category:Formatting templates{{#translation:}}|Template documentation]]
| | </noinclude> |
| [[Category:Template documentation{{#translation:}}| ]]
| |
| </noinclude><includeonly>{{#if:{{{content|}}}| | |
| [[Category:Template documentation pages{{#translation:}}]]
| |
| }}</includeonly>
| |
This is a simple fallback for {{documentation}}.
It automatically shows the content of a /doc subpage if it exists.
Usage:
{{documentation}}
Create a subpage named Template:YourTemplateName/doc for the documentation text.