Template:Documentation: Difference between revisions

From Space Station 14 Wiki
(replaced note with a callout template)
(refactor, support for "below banner")
Line 1: Line 1:
<includeonly>
<includeonly><!--
{| class="wikitable" style="float: left;"
-->{{#vardefine: docpage_link|{{{1|{{FULLPAGENAMEE}}/doc}}}}}<!--
! <div style="width:100%; padding:3px 0px; text-align:center; font-size: large;">Template documentation</div>
 
|-
--><div style="
| View or edit [[{{{1|Template:{{PAGENAMEE}}/doc}}}|this documentation]]. ([[Template:Documentation|About template documentation]])
    border: 2px solid var(--border-color);
{{Callout|Info|h=Note|Portions of the template sample may not be visible without values provided.}}
    padding: 0.4rem;
|}
    background-color: color-mix(in srgb, var(--action-color-dark-x2) 5%, transparent);
{{Clear|left}}
    border-radius: .2rem;
{{{{{1|{{PAGENAME}}/doc}}}}}</includeonly><noinclude>{{Documentation}}[[Category:Documentation templates]]<templatedata>
"><!--
    --><div style="text-align:center; margin-bottom: 1rem;"><!--
    --><div style="font-weight: bold; font-size: large;">Template documentation</div><!--
    --><span style="font-size: 1.05em;">[[{{#var:docpage_link}}|view]]</span> or <span style="font-size: 1.05em;">[https://wiki.spacestation14.com/wiki/{{#var:docpage_link}}?action=edit edit]</span> this documentation {{colored text|gray|•}} [[Template:Documentation|about template documentation]]<!--
    --><hr>
</div><!--
 
-->{{#vardefine: below_banner|{{{below banner|{{{bb|}}}}}}}}<!--
 
-->{{#if: {{#var:below_banner}}<!--
    -->|{{{below banner|{{{bb|}}}}}}<!--
    -->|<!--
-->}}<!--
 
-->__TOC__<!--
-->{{clear}}<!--
--><br>
{{{{{1|{{PAGENAME}}/doc}}}}}</div></includeonly><noinclude>
 
{{Documentation|bb=
{{has alias templates|docs}}
}}
 
[[Category:Templates for documenting other templates]]
<templatedata>
{
{
"params": {
"params": {
Line 15: Line 39:
"type": "wiki-page-name",
"type": "wiki-page-name",
"default": "/doc (relative to the page, where this template is included)."
"default": "/doc (relative to the page, where this template is included)."
},
"below banner": {
"label": "Content below banner",
"description": "Content to insert below banner and above documentation.",
"type": "content",
"aliases": [
"bb"
]
}
}
},
},

Revision as of 10:47, 15 August 2024


Template documentation
view or edit this documentation about template documentation
Has an alias
This template has an alternative name:

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
Content below bannerbelow banner bb

Content to insert below banner and above documentation.

Contentoptional