Template:Documentation

From UniWiki
Jump to: navigation, search
Template documentation (for the above template, sometimes hidden or invisible)
Description
This template is used to insert documentation on template pages.
Syntax and Parameters
Type <noinclude>{{t|documentation|<var>{{FULLPAGENAME}}/doc</var>}}</noinclude> at the end of the template page. Include the full (exact, including namespace) name of the documentation page as a parameter where posible.

General usage

On the Template page

You should attach <noinclude>{{t|documentation|{{subst:FULLPAGENAME}}/doc}}</noinclude> to the end of the template page, so it looks like the below:

<includeonly> TEMPLATE CODE HERE
Any categories to be inserted into articles by the template</includeonly><noinclude>
{{documentation|{{subst:FULLPAGENAME}}/doc}}</noinclude>

This will fill in add the documentation template to the template-page, but not pages where the template is used due to the inclusion tags. The subst:FULLPAGENAME serves as a wikimedia "Magic Word" and will be replaced by the wikispace and page name once the edit is completed, and serves to direct the template towards the appropriate page for substitution in case the automatic code fails to work.

On the Template/doc page

You should fill this out with information on how to use the template. For example,

See also Template:Documentation/preload
;Description
:This template is used to do something.
;Syntax
:Type <code>{{t|templatename}}</code> somewhere.
;Sample output
:<code><nowiki>{{templatename|foo}}</nowiki></code> gives...
:{{templatename|foo}}

<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 further usage information sections.

Note that the above example also uses {{T}} to display the formatting of the template code, without actually calling the template for transclusion (as normally happens with the squiggly brackets).

Rationale

This template allows any page to use any documentation page, and makes it possible to protect templates while allowing anyone to edit the template's documentation, categories, and interwiki links. According to MediaWiki it also helps reduce server resource demand by circumventing certain technical limitations of templates. Unfortunately they don't say what those limitations are, exactly. - 2012, User:Quinn fellthorn

User:Telinchei would suggest to the those relate to server resources, when deciding what to transclude (finding noinclude tags) from the template page.
Visit Template:documentation/doc to edit this text! (How does this work?) (Refresh this text - why?)
Personal tools
Namespaces
Variants
Actions
Navigation
EVE University
Toolbox