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 (Modify statement) |
m (Optimization) |
||
| Line 13: | Line 13: | ||
--><nowiki>[</nowiki>[{{fullurl:{{{1|{{SUBJECTPAGENAME}}/doc}}}|action=history}} History]<nowiki>]</nowiki><!-- | --><nowiki>[</nowiki>[{{fullurl:{{{1|{{SUBJECTPAGENAME}}/doc}}}|action=history}} History]<nowiki>]</nowiki><!-- | ||
-->|<nowiki>[</nowiki>[{{fullurl:{{{1|{{SUBJECTPAGENAME}}/doc}}}|action=edit}} Create]<nowiki>]</nowiki>}} <!-- | -->|<nowiki>[</nowiki>[{{fullurl:{{{1|{{SUBJECTPAGENAME}}/doc}}}|action=edit}} Create]<nowiki>]</nowiki>}} <!-- | ||
| − | -->{{#ifeq:{{FULLPAGENAME}}|Template:Documentation|<!-- | + | -->{{#ifeq:{{FULLPAGENAME}}|Template:Documentation|<!--don't display Help if this page is Template:Documentation |
-->|<nowiki>[</nowiki>[[Template:Documentation|Help]]<nowiki>]</nowiki>}} <!-- | -->|<nowiki>[</nowiki>[[Template:Documentation|Help]]<nowiki>]</nowiki>}} <!-- | ||
| − | --><nowiki>[</nowiki>[{{fullurl:{{ | + | --><nowiki>[</nowiki>[{{fullurl:{{FULLPAGENAMEE}}|action=purge}} Refresh]<nowiki>]</nowiki></span></div><!-- |
--><div id="template_doc_page_transcluded" class="dablink plainlinks" style="font-size:85%;"><!-- | --><div id="template_doc_page_transcluded" class="dablink plainlinks" style="font-size:85%;"><!-- | ||
| Line 21: | Line 21: | ||
-->|The documentation haven't been [{{fullurl:{{{1|{{SUBJECTPAGENAME}}/doc}}}|action=edit}} create]d.}}</div><!-- | -->|The documentation haven't been [{{fullurl:{{{1|{{SUBJECTPAGENAME}}/doc}}}|action=edit}} create]d.}}</div><!-- | ||
--><div style="margin:0 1em;"> | --><div style="margin:0 1em;"> | ||
| − | {{ | + | {{#if:{{{notoc|}}}||{{Toc|{{#if:{{{toc|right}}}|{{{toc|right}}}|right}}}}}} |
{{#ifexist:{{{1|{{SUBJECTPAGENAME}}/doc}}}|{{{{{1|{{SUBJECTPAGENAME}}/doc}}}}}}}</div></div></includeonly><noinclude> | {{#ifexist:{{{1|{{SUBJECTPAGENAME}}/doc}}}|{{{{{1|{{SUBJECTPAGENAME}}/doc}}}}}}}</div></div></includeonly><noinclude> | ||
{{documentation}}</noinclude> | {{documentation}}</noinclude> | ||
Revision as of 10:39, 23 August 2021
Template DocumentationThis 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.
