Template:Documentation: Difference between revisions

From Jenny Everywhere Wiki
m (Changed protection level for "Template:Documentation": Robot: Protecting all pages from category templates (‎[edit=sysop] (indefinite) ‎[move=sysop] (indefinite)))
(sliding away from inline styling)
Line 1: Line 1:
<includeonly><div style="border:2px #012c57 solid;"><div id=mn><div style="background:#012c57; color:white; padding:1em; margin:0em;">'''Instructions''' <span style="font-size:85%;">for {{tlx|{{PAGENAME}}}}</span></div></div><div style="padding:1em; padding-bottom:0em; margin:0em;background:#ececec">
<includeonly><div class="documentation">
{{{{PAGENAME}}/doc}}</div><div id=mn style="background:#012c57; color:#fff; padding:0.5em; margin:0em; font-size:85%; text-align:right">Visit [[Template:{{PAGENAME}}/doc|<span style="color:#A6A6B8">the documentation page</span>]] to edit this text! ([[Template:Documentation|<span style="color:#A6A6B8">How does this work</span>]]?)</div></div></includeonly><noinclude>{{documentation}}[[Category:Templates|{{PAGENAME}}]]</noinclude>
<div class="title">'''Instructions''' <span style="font-size:85%;">for {{tlx|{{PAGENAME}}}}</span></div>
<div class="description">{{{{PAGENAME}}/doc}}</div>
<div class="footer">Visit [[Template:{{PAGENAME}}/doc|the documentation page]] to edit this text! ([[Template:Documentation|How does this work]]?)</div></div>
</div></includeonly><noinclude>{{documentation}}[[Category:Templates|{{PAGENAME}}]]</noinclude>

Revision as of 15:57, 10 October 2018

Instructions for {{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]]</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 template.