Template:Documentation: Difference between revisions

From Linguifex
Jump to navigation Jump to search
m (1 revision imported)
No edit summary
Line 1: Line 1:
{{#invoke:documentation|main|_content={{ {{#invoke:documentation|contentTitle}}}}}}<noinclude>
{{#invoke:documentation|show|hr={{{hr|above}}}}}<noinclude>
<!-- Categories go on the /doc subpage, and interwikis go on Wikidata. -->
<!-- Categories go on the /doc subpage, and interwikis go on Wikidata. -->
</noinclude>
</noinclude>

Revision as of 17:27, 31 December 2021


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.