Template:Documentation: Difference between revisions
Created page with "==Syntax== <pre> {{Character | title1= | image1= | caption1= | aliases= | titles= | affilation= | world= | age= | pronouns= | species= | abilities= | family= | associates= }} </pre> ==Sample Output== {{Character | title1=Dusty the Star | image1=Dustar.png | caption1=K E T | aliases=Purrbaby | titles=Grand High Empress of Meowing | affilation=All | world=Kity Mewniverse | age=Unfathomably ancient | pronouns=she/her | species=..." |
ahaha that doesn't go there |
||
| (One intermediate revision by the same user not shown) | |||
| Line 1: | Line 1: | ||
<includeonly>{| class="article-table plainlinks" style="width:100%;" role="complementary" | |||
< | |- style="" | ||
! style="padding:0px;" | <div style="width:100%; padding:3px 0px; text-align:center;" class="color1">Template documentation</div> | |||
|- | |||
| ''Note: portions of the template sample may not be visible without values provided.'' | |||
|- | |||
| View or edit [[{{{1|Template:{{PAGENAMEE}}/doc}}}|this documentation]]. ([[Template:Documentation|About template documentation]]) | |||
|- | |||
| Editors can experiment in this template's [{{fullurl:{{FULLPAGENAMEE}}/Draft|action=edit}} sandbox] and [{{fullurl:{{FULLPAGENAMEE}}/testcases}} test case] pages. | |||
|} | |||
<div style="margin:0 1em;"> | |||
{{{{{1|{{PAGENAME}}/doc}}}}}</div></includeonly><noinclude>{{Documentation}}[[Category:Documentation templates]]</noinclude> | |||
</ | |||
}} | |||
{{ | |||
}} | |||
</ | |||
Latest revision as of 22:26, 26 June 2023
Template documentation
|
|---|
| Note: portions of the template sample may not be visible without values provided. |
| View or edit this documentation. (About template documentation) |
| Editors can experiment in this template's sandbox and test case pages. |
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>{{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.