ModEnc is currently in Maintenance Mode: Changes could occur at any given moment, without advance warning.
Difference between revisions of "Template:Documentation"
From ModEnc
m (Delete redundancy) |
m (debug) |
||
Line 9: | Line 9: | ||
--> <span class="editsection plainlinks" style="font-size:small;" id="doc_editlinks"><!-- | --> <span class="editsection plainlinks" style="font-size:small;" id="doc_editlinks"><!-- | ||
-->{{#ifexist:{{{1|{{SUBJECTPAGENAME}}/doc}}}<!-- | -->{{#ifexist:{{{1|{{SUBJECTPAGENAME}}/doc}}}<!-- | ||
− | -->|<nowiki>[</nowiki>[[ | + | -->|<nowiki>[</nowiki>[[{{{1|{{SUBJECTPAGENAME}}/doc}}}|View]]<nowiki>]</nowiki> <!-- |
--><nowiki>[</nowiki>[{{fullurl:{{FULLPAGENAMEE}}/doc|action=edit}} Edit]<nowiki>]</nowiki> <!-- | --><nowiki>[</nowiki>[{{fullurl:{{FULLPAGENAMEE}}/doc|action=edit}} Edit]<nowiki>]</nowiki> <!-- | ||
--><nowiki>[</nowiki>[{{fullurl:{{{1|{{SUBJECTPAGENAME}}/doc}}}|action=history}} History]<nowiki>]</nowiki><!-- | --><nowiki>[</nowiki>[{{fullurl:{{{1|{{SUBJECTPAGENAME}}/doc}}}|action=history}} History]<nowiki>]</nowiki><!-- |
Revision as of 07:31, 18 August 2021
This document transclude from Template:Documentation/doc.
Description
This template is used to insert descriptions on template pages.
Syntax
Add <noinclude>{{documentation}}</noinclude>
or <noinclude>{{doc}}</noinclude>
at the end of the template page.
- If
notoc=1
, the catalogue will not be displayed. - Use
toc=
will set the alignment of the catalogue.
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> {{doc}}</noinclude>
If your template is not a completed div or table, you may need to close the tags just before {{doc}}
is inserted (within the noinclude tags).
A line break right before {{doc}}
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>{{tl|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.