Template:Documentation: Difference between revisions

Jump to navigation Jump to search
imported>Pathoschild
m (typo)
imported>Pathoschild
(moved view/edit/history links to "transcluded from..." line, + redundant "[edit]" link beside fake header as that is the intuitive place)
Line 1: Line 1:
<div class="template-documentation">
<div class="template-documentation">
<div style="padding-bottom:3px; {{#if:{{{heading|defaultnotblank}}}|border-bottom:1px solid #aaa;}} margin-bottom:1ex;">
<div style="padding-bottom:3px; {{#if:{{{heading|defaultnotblank}}}|border-bottom:1px solid #aaa;}} margin-bottom:1ex;">
<span class="editsection plainlinks">&#091;[[{{{1|{{SUBJECTPAGENAME}}/doc}}}|view]]]
<span class="editsection plainlinks">[[{{fullurl:{{{1|{{SUBJECTPAGENAME}}/doc}}}|action=edit{{#ifexist: {{{1|{{SUBJECTSPACE}}:{{SUBJECTPAGENAME}}/doc}}} ||&preload=Template:Documentation/preload}}}} edit]]</span>
[[{{fullurl:{{{1|{{SUBJECTPAGENAME}}/doc}}}|action=edit{{#ifexist: {{{1|{{SUBJECTSPACE}}:{{SUBJECTPAGENAME}}/doc}}} ||&preload=Template:Documentation/preload}}}} edit]]
[[{{fullurl:{{{1|{{SUBJECTPAGENAME}}/doc}}}|action=history}} history]]</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">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 id="template_doc_page_transcluded" class="dablink plainlinks">This [[Wikipedia:Template documentation|documentation]] is [[Wikipedia:Transclusion|transcluded]] from [[{{{1|{{FULLPAGENAME}}/doc}}}]] ([[{{{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]). {{#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>

Revision as of 14:47, 18 October 2007

[edit]

Documentation
==Description==

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.