Template:Documentation: Difference between revisions

From Blackmouth Chronicles
Jump to navigation Jump to search
(not every template with documentation should go in Category:Template documentation; beautify code)
m (1 revision imported)
Line 1: Line 1:
<languages />
<includeonly><div style="border: 1px solid black; margin: 3em 1em 1em;"><div style="background: Tan; color: Black; padding: 1em; margin: 0;">'''Template documentation''' <span style="font-size: 85%;">(for the above template, sometimes hidden or invisible)</span></div><div style="padding: 1em 1em 0; margin: 0;">{{tocright}}
<onlyinclude><includeonly>{{#switch:<translate></translate>
{{#if: {{{namespace|}}}|{{:{{{namespace}}}:{{PAGENAME}}/doc}}|{{{{PAGENAME}}/doc}} }}
|          = {{#invoke:documentation|main|_content={{ {{#invoke:documentation|contentTitle}}}}}}
</div><br style="clear: both;"/><div style="background: Tan; color: Black; padding: 0.5em; margin: 0em; font-size: 85%; text-align: right;">Visit [[{{#if: {{{namespace|}}}|{{{namespace}}}|Template}}:{{PAGENAME}}/doc]] to edit this text! ([[Template:Documentation|How does this work]]?)</div></div></includeonly><noinclude>
| #default = {{#invoke:Template translation|renderTranslatedTemplate|template=Template:Documentation|noshift=1}}
{{Documentation}}
}}</includeonly></onlyinclude>
[[Category:Template documentation| ]]
{{documentation|content=
</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}}
* [[w:Wikipedia:Template documentation]]
 
}}
[[Category:Formatting templates{{#translation:}}|Template documentation]]
[[Category:Template documentation{{#translation:}}| ]]

Revision as of 09:17, 3 September 2019

Template documentation (for the above template, sometimes hidden or invisible)
Description
This template is used to insert descriptions on template pages.
Syntax
Type <noinclude>{{documentation}}</noinclude> at the end of the template page.

General usage

On the Template page

Template code<includeonly>Any categories to be inserted into articles by the template</includeonly><noinclude>
{{documentation}}</noinclude>

Note that, depending on the template, you may need to add a clear or complete a table/div just before {{documentation}} is inserted (within the noinclude tags).

The line break is also useful as it helps prevent the documentation template "running into" previous code.

On the Template/doc page

;Description
:This template is used to do something.
;Syntax
:Type <code>{{t|templatename}}</code> somewhere.
;Sample output
:<code><nowiki>{{templatename|foo}}</nowiki></code> gives...
:{{templatename|foo}}

<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 further usage information sections.

Note that the above example also uses the Template:T and Template:T/piece templates.