Template:Documentation: Difference between revisions
From Graal Military Wiki
Content added Content deleted
mediawiki>Shirayuki m (dummy edit to update translation pages) |
m (1 revision imported) |
||
Line 1: | Line 1: | ||
<includeonly>{| class="article-table" style="width:100%;" |
|||
<noinclude> |
|||
|- style="font-size:18px;" |
|||
<languages/> |
|||
⚫ | |||
</noinclude><includeonly>{{#switch:<translate></translate> |
|||
| |
|- |
||
| ''Note: the template above may sometimes be partially or fully invisible.'' |
|||
{{#invoke:documentation|main|_content={{ {{#invoke:documentation|contentTitle}}}}}} |
|||
|- |
|||
| #default= |
|||
{{ |
| Visit [[Template:{{PAGENAMEE}}/doc]] to edit this documentation. ([[Template:Documentation|How does this work?]]) |
||
⚫ | |||
}}</includeonly><noinclude> |
|||
<div style="margin:0 1em;"> |
|||
{{documentation|content= |
|||
{{tocright}} |
|||
{{{{PAGENAME}}/doc}}</div></includeonly><noinclude>{{documentation}}[[Category:Template documentation| ]]</noinclude> |
|||
{{Lua|Module:Documentation}} |
|||
<translate> |
|||
==Usage== <!--T:2--> |
|||
===Customizing display=== <!--T:3--> |
|||
<!--T:4--> |
|||
Overrides exist to customize 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--> |
|||
<!--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, categories, and interwiki links.</translate> |
|||
<translate> |
|||
<!--T:8--> |
|||
It also reduces server resources by circumventing a [[w:Wikipedia:Template limits|technical limitation of templates]] (see a [<tvar|url>{{fullurl:en:Project:Village pump (technical)|diff=prev&oldid=69888944}}</> developer's explanation]). |
|||
==See also== <!--T:9--> |
|||
</translate> |
|||
* {{tiw|documentation subpage}} |
|||
* {{tim|Documentation}} |
|||
⚫ | |||
⚫ | |||
[[Category:Formatting templates{{#translation:}}|Template documentation]] |
|||
[[Category:Template documentation{{#translation:}}| ]] |
|||
</noinclude><includeonly>{{#if:{{{content|}}}| |
|||
[[Category:Template documentation pages{{#translation:}}]] |
|||
}}</includeonly> |
Revision as of 09:35, 26 January 2020
Template documentation follows |
---|
Note: the template above may sometimes be partially or fully invisible. |
Visit Template:Documentation/doc to edit this documentation. (How does this work?) |
Description
This template is used to insert descriptions on template pages.
Syntax
Add <noinclude>{{documentation}}</noinclude>
at the end of the template page.
Usage
On the Template page
This is the normal format when used:
TEMPLATE CODE<includeonly>Any categories to be inserted into articles by the template</includeonly><noinclude> {{documentation}}</noinclude>
If your template is not a completed div or table, you may need to close the tags just before {{documentation}}
is inserted (within the noinclude tags).
A line break right before {{documentation}}
can also be useful as it helps prevent the documentation template "running into" previous code.
On the Template/doc page
Normally, you will want to write something like the following on the documentation page:
==Description== This template is used to do something. ==Syntax== Type <code>{{t|templatename}}</code> somewhere. ==Samples== <code><nowiki>{{templatename|input}}</nowiki></code> results in... {{templatename|input}} <includeonly>Any categories for the template itself</includeonly><noinclude>[[Category:Template documentation|{{PAGENAME}}]]</noinclude>
Use any or all of the above description/syntax/sample output sections. You may also want to add "see also" or other sections.
Note that the above example also uses the Template:T and Template:T/piece templates.