Template:Documentation: Difference between revisions
From Graal Military Wiki
Content added Content deleted
(at least then let's get Edit and History next to each other as custom; .plainlinks was pointlessly duplicated; newlines for clearer code; Help:Variable: Don't use PAGENAMEE in fullurl) |
m (1 revision imported) |
||
| (194 intermediate revisions by 76 users not shown) | |||
| Line 1: | Line 1: | ||
<includeonly>{| class="article-table" style="width:100%;" |
|||
<div class="template-documentation"> |
|||
|- style="font-size:18px;" |
|||
<div style="padding-bottom:3px; border-bottom:1px solid #aaa; margin-bottom:1ex;"> |
|||
! Template documentation follows |
|||
<span class="editsection plainlinks">[[[{{{1|{{SUBJECTPAGENAME}}/doc}}}|view]]] |
|||
|- |
|||
[[{{fullurl:{{{1|{{SUBJECTPAGENAME}}/doc}}}|action=edit{{#ifexist: {{{1|{{SUBJECTSPACE}}:{{SUBJECTPAGENAME}}/doc}}} ||&preload=Template:Documentation/preload}}}} edit]] |
|||
| ''Note: the template above may sometimes be partially or fully invisible.'' |
|||
[[{{fullurl:{{{1|{{SUBJECTPAGENAME}}/doc}}}|action=history}} history]]</span> |
|||
|- |
|||
<span style="font-size: 150%">Documentation</span></div> |
|||
| Visit [[Template:{{PAGENAMEE}}/doc]] to edit this documentation. ([[Template:Documentation|How does this work?]]) |
|||
|} |
|||
<div id="template_doc_page_transcluded" class="dablink">This [[Wikipedia:Template documentation|documentation]] is [[Wikipedia:Transclusion|transcluded]] from [[{{{1|{{FULLPAGENAME}}/doc}}}]]. {{#ifexist: {{#rel2abs: /sandbox }} | {{#ifexist: {{#rel2abs: /testcases}} | <br> This template has a [[/sandbox|sandbox]] ''([{{fullurl:{{FULLPAGENAME}}/sandbox|action=edit}} edit])'' and [[/testcases|testcases]] for editors to experiment.}}<!-- else don't show when just 1 of /sandbox or /testcases exists -->}} </div>{{{{{1|{{SUBJECTPAGENAME}}/doc}}}}} <br style="clear:both;" /></div> |
|||
<div style="margin:0 1em;"> |
|||
{{tocright}} |
|||
{{{{PAGENAME}}/doc}}</div></includeonly><noinclude>{{documentation}}[[Category:Template documentation| ]]</noinclude> |
|||
Latest revision as of 14:15, 29 February 2020
| Template documentation follows |
|---|
| Note: the template above may sometimes be partially or fully invisible. |
| Visit Template:Documentation/doc to edit this documentation. (How does this work?) |
Description
This template is used to insert descriptions on template pages.
Syntax
Add <noinclude>{{documentation}}</noinclude> at the end of the template page.
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>
{{documentation}}</noinclude>
If your template is not a completed div or table, you may need to close the tags just before {{documentation}} is inserted (within the noinclude tags).
A line break right before {{documentation}} 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>{{t|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.
Note that the above example also uses the Template:T and Template:T/piece templates.
