ModEnc is currently in Maintenance Mode: Changes could occur at any given moment, without advance warning.
Template:Documentation: Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
Add in-line doc function |
||
| (5 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
<includeonly><div class="template-documentation" style="background: aliceblue; padding: 1em; border: 1px solid #aaa;"><!-- | <includeonly><div class="template-documentation" style="background: aliceblue; padding: 1em; border: 1px solid #aaa; clear:both;"><!-- | ||
--><div class="template-documentation-header" style="padding-bottom:3px; border-bottom: 1px solid #aaa; margin-bottom:1ex"><!-- | --><div class="template-documentation-header" style="padding-bottom:3px; border-bottom: 1px solid #aaa; margin-bottom:1ex"><!-- | ||
--><span style="font-weight: bold; font-size: 150%">{{#switch:{{NAMESPACE}}<!-- | --><span style="font-weight: bold; font-size: 150%">{{#switch:{{NAMESPACE}}<!-- | ||
| Line 8: | Line 8: | ||
--> <span class="editsection plainlinks" style="font-size:small;" id="doc_editlinks"><!-- | --> <span class="editsection plainlinks" style="font-size:small;" id="doc_editlinks"><!-- | ||
-->{{#ifexist:{{{ | ##If the independent documentation page exists (takes precedence over in-line documentation) | ||
-->|<nowiki>[</nowiki>[[{{{ | -->{{#ifexist:{{{doclink|{{SUBJECTPAGENAME}}/doc}}}<!-- | ||
--><nowiki>[</nowiki>[{{fullurl:{{{ | -->|<nowiki>[</nowiki>[[{{{doclink|{{SUBJECTPAGENAME}}/doc}}}|View]]<nowiki>] </nowiki><!-- | ||
--><nowiki>[</nowiki>[{{fullurl:{{{ | --><nowiki>[</nowiki>[{{fullurl:{{{doclink|{{SUBJECTPAGENAME}}/doc}}}|action=edit}} Edit]<nowiki>] </nowiki><!-- | ||
-->|<nowiki>[</nowiki>[{{fullurl:{{{ | --><nowiki>[</nowiki>[{{fullurl:{{{doclink|{{SUBJECTPAGENAME}}/doc}}}|action=history}} History]<nowiki>] </nowiki><!-- | ||
--><nowiki>[</nowiki>[[Template:Documentation|Help]]<nowiki>]</nowiki> <!-- | ##If this is an in-line documentation | ||
--><nowiki>[</nowiki>[{{fullurl:{{ | -->|{{#if:{{{1|}}}|<nowiki>[</nowiki>[{{fullurl:{{FULLPAGENAME}}|action=edit}} Edit]<nowiki>] </nowiki><!-- | ||
-->|<nowiki>[</nowiki>[{{fullurl:{{{doclink|{{SUBJECTPAGENAME}}/doc}}}|action=edit}} Create]<nowiki>] </nowiki>}}}} <!-- | |||
##Do not display Help if this page is Template:Documentation | |||
-->{{#ifeq:{{FULLPAGENAME}}|Template:Documentation|<!-- | |||
-->|<nowiki>[</nowiki>[[Template:Documentation|Help]]<nowiki>] </nowiki>}}<!-- | |||
##General item | |||
--><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%;"><!-- | ||
-->{{#ifexist:{{{ | -->{{#ifexist:{{{doclink|{{SUBJECTPAGENAME}}/doc}}}|This document transclude from [[{{{doclink|{{SUBJECTPAGENAME}}/doc}}}]].<!-- | ||
-->|This documentation haven't been [{{fullurl:{{{ | -->|{{#if:{{{1|}}}|This is an in-line documentation.|The documentation haven't been [{{fullurl:{{{doclink|{{SUBJECTPAGENAME}}/doc}}}|action=edit}} create]d.}}}}</div><!-- | ||
--><div style="margin:0 1em;"> | --><div style="margin:0 1em;"> | ||
{{ | {{#if:{{{notoc|}}}|__NOTOC__|{{Toc|{{#if:{{{toc|right}}}|{{{toc|right}}}|right}}}}}} | ||
{{#ifexist:{{{ | {{#ifexist:{{{doclink|{{SUBJECTPAGENAME}}/doc}}}|{{{{{doclink|{{SUBJECTPAGENAME}}/doc}}}}}<!-- | ||
##In-line documentation | |||
-->|{{#if:{{{1|}}}|{{{1|}}}}}}}</div></div></includeonly><noinclude> | |||
{{documentation}}</noinclude> | {{documentation}}</noinclude> | ||
Latest revision as of 04:06, 25 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.