Template:Documentation: Difference between revisions

From Space Station 14 Wiki
(Created page with "<noinclude>Stub.</noinclude>")
 
(copied a doc template over from the cosmoteer wiki)
Line 1: Line 1:
<noinclude>Stub.</noinclude>
<includeonly>
{| class="wikitable" style="float: left;"
! <div style="width:100%; padding:3px 0px; text-align:center; font-size: large;">Template documentation</div>
|-
| View or edit [[{{{1|Template:{{PAGENAMEE}}/doc}}}|this documentation]]. ([[Template:Documentation|About template documentation]])
{{Mbox
| type      = content
| image      = none
| style      = border-left: 10px solid #2a4b8d; margin-left: 0;
| textstyle  = text-align: left;
| text      = <div style="text-align: left;">'''Note'''<br>Portions of the template sample may not be visible without values provided.</div>
}}
|}
{{Clear|left}}
{{{{{1|{{PAGENAME}}/doc}}}}}</includeonly><noinclude>{{Documentation}}[[Category:Documentation templates]]<templatedata>
{
"params": {
"1": {
"label": "Link override",
"description": "Override for the documentation link.",
"type": "wiki-page-name",
"default": "/doc (relative to the page, where this template is included)."
}
},
"description": "This template is used to insert descriptions on template pages.",
"format": "inline"
}
</templatedata></noinclude>

Revision as of 07:48, 24 June 2024

Template documentation
View or edit this documentation. (About template documentation)

Syntax

Add <noinclude>{{Documentation}}</noinclude> at the end of the template page.

Add <noinclude>{{Documentation}}</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:Template link template.

This template is used to insert descriptions on template pages.

Template parameters[Edit template data]

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
Link override1

Override for the documentation link.

Default
/doc (relative to the page, where this template is included).
Page nameoptional