Template:Documentation: Difference between revisions

From Linguifex
Jump to navigation Jump to search
m (1 revision: Getting templates while it works)
No edit summary
 
(9 intermediate revisions by 5 users not shown)
Line 1: Line 1:
<noinclude><div style="display:none;"></noinclude><div style="border:1px solid black; margin:1em; margin-top:3em;"><div style="background:#ddd; color:#111; padding:1em; margin:0em;">'''Template Documentation''' <span style="font-size:85%;">(''for the above {{PAGENAME}} template, sometimes hidden or invisible'')</span></div><div style="padding:1em; padding-bottom:0em; margin:0em;">{{tocright}}
{{#invoke:documentation|show|hr={{{hr|above}}}}}
{{{{PAGENAME}}/doc}}
</div><br style="clear:both;"/><div style="background:#ddd; color:#111; padding:0.5em; margin:0em; font-size:85%; text-align:right;">Visit [[Template:{{PAGENAME}}/doc]] to edit this text! ([[Template:Documentation|How does this work]]?)</div></div><noinclude></div>
{{Documentation}}[[Category:Templates]][[Category:Template documentation]][[Category:Functionality]]</noinclude>

Latest revision as of 22:46, 4 February 2022


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.