Template:Documentation: Difference between revisions
imported>Patrick (restore newline to make haeder at the top work; subst:documentation (little problem on one page (special case) should not affect general template, it was fixed by substitution)) |
imported>Patrick ({{SUBJECTPAGENAME}}/sandbox) |
||
Line 2: | Line 2: | ||
<span class="editsection plainlinks" id="doc_editlinks">[[{{fullurl:{{{1|{{SUBJECTPAGENAME}}/doc}}}|action=edit{{#ifexist: {{{1|{{SUBJECTSPACE}}:{{SUBJECTPAGENAME}}/doc}}} ||&preload=Template:Documentation/preload}}}} edit]]</span> | <span class="editsection plainlinks" id="doc_editlinks">[[{{fullurl:{{{1|{{SUBJECTPAGENAME}}/doc}}}|action=edit{{#ifexist: {{{1|{{SUBJECTSPACE}}:{{SUBJECTPAGENAME}}/doc}}} ||&preload=Template:Documentation/preload}}}} edit]]</span> | ||
<span style="font-size: 150%">{{{heading|Documentation}}}</span></div>}} | <span style="font-size: 150%">{{{heading|Documentation}}}</span></div>}} | ||
<div id="template_doc_page_transcluded" class="dablink plainlinks">This [[Wikipedia:Template documentation|documentation]] is [[Wikipedia:Transclusion|transcluded]] from [[{{{1|{{SUBJECTPAGENAME}}/doc}}}]]. <small style="font-style: normal">([[{{{1|{{SUBJECTPAGENAME}}/doc}}}|view]] | [{{fullurl:{{{1|{{SUBJECTPAGENAME}}/doc}}}|action=edit{{#ifexist: {{{1|{{SUBJECTSPACE}}:{{SUBJECTPAGENAME}}/doc}}} ||&preload=Template:Documentation/preload}}}} edit] | [{{fullurl:{{{1|{{SUBJECTPAGENAME}}/doc}}}|action=history}} history])</small> {{#ifexist: {{#rel2abs: /sandbox }} | {{#ifexist: {{#rel2abs: /testcases}} | <br> This template has a [[/sandbox|sandbox]] <small style="font-style: normal">([{{fullurl:{{ | <div id="template_doc_page_transcluded" class="dablink plainlinks">This [[Wikipedia:Template documentation|documentation]] is [[Wikipedia:Transclusion|transcluded]] from [[{{{1|{{SUBJECTPAGENAME}}/doc}}}]]. <small style="font-style: normal">([[{{{1|{{SUBJECTPAGENAME}}/doc}}}|view]] | [{{fullurl:{{{1|{{SUBJECTPAGENAME}}/doc}}}|action=edit{{#ifexist: {{{1|{{SUBJECTSPACE}}:{{SUBJECTPAGENAME}}/doc}}} ||&preload=Template:Documentation/preload}}}} edit] | [{{fullurl:{{{1|{{SUBJECTPAGENAME}}/doc}}}|action=history}} history])</small> {{#ifexist: {{#rel2abs: /sandbox }} | {{#ifexist: {{#rel2abs: /testcases}} | <br> This template has a [[/sandbox|sandbox]] <small style="font-style: normal">([{{fullurl:{{SUBJECTPAGENAME}}/sandbox|action=edit}} edit])</small> and [[/testcases|testcases]] for editors to experiment.}}<!-- else don't show when just 1 of /sandbox or /testcases exists -->}} </div> | ||
{{ {{#ifexist:{{{1|{{SUBJECTPAGENAME}}/doc}}}|{{{1|{{SUBJECTPAGENAME}}/doc}}}|ns:0}} }} | {{ {{#ifexist:{{{1|{{SUBJECTPAGENAME}}/doc}}}|{{{1|{{SUBJECTPAGENAME}}/doc}}}|ns:0}} }} | ||
<div style="clear:both;" /></div></div> | <div style="clear:both;" /></div></div> |
Revision as of 09:28, 7 November 2007
[edit]
DocumentationDescription
This template is used to insert descriptions on template pages.
Syntax
Add <noinclude>{{documentation}}</noinclude>
at the end of the template page.
Add <noinclude>{{documentation|<documentation page>}}</noinclude>
to transclude an alternative page from the /doc subpage.
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 documentation page
The documentation page is usually located on the /doc subpage for a template, but a different page can be specified with the first parameter of the template (see Syntax).
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.