Difference between revisions of "Template:Documentation subpage/doc"


Warning: Parameter 1 to MapsHooks::onParserClearState() expected to be a reference, value given in /var/www/vhosts/shdenham.co.uk/httpdocs/mw/includes/Hooks.php on line 201

Warning: Parameter 1 to ExtArrays::onParserClearState() expected to be a reference, value given in /var/www/vhosts/shdenham.co.uk/httpdocs/mw/includes/Hooks.php on line 201

Warning: Parameter 1 to Cite::clearState() expected to be a reference, value given in /var/www/vhosts/shdenham.co.uk/httpdocs/mw/includes/Hooks.php on line 201
From Aktanak
Jump to: navigation, search
m (Text replace - "[[Category:Template namespace templates" to "")
Line 21: Line 21:
  
 
  {{tlx|documentation subpage|text1<nowiki>=</nowiki><var>custom first line text</var>|text2<nowiki>=</nowiki><var>custom second line text</var>}}
 
  {{tlx|documentation subpage|text1<nowiki>=</nowiki><var>custom first line text</var>|text2<nowiki>=</nowiki><var>custom second line text</var>}}
−
 
−
==How it is displayed==
 
−
This template should be placed at the top of "/doc" pages. It changes output depending on where it is viewed:
 
−
* On a "/doc" page, it displays a box explaining template documentation and links to the template page.
 
−
* On other pages (ie, pages transcluding the "/doc" page), the template will not show. The template page itself (which contains <code>{{tl|Documentation}}</code>) will automatically note that the documentation is [[Wikipedia:Transclusion|transcluded]] from a subpage.
 
−
 
−
==Functions==
 
−
In addition to the output message, the template categorizes pages to [[:Category:Template documentation]], [[:Category:User documentation]], or similar (named after the subject space), but only for documentation pages in namespaces with the subpage feature. It defaults the [[m:Help:Categories#Sort order|sort key]] to the page name without namespace (ie, "Foo" on "Template:Foo", so it would be sorted in categories under 'F').
 
  
 
==See also==
 
==See also==

Revision as of 23:07, 23 May 2011


Usage

{{documentation subpage}}

OR 

{{documentation subpage|[[main page to link to]]}}

Userboxes

When used to document usage of a userbox, it may be preferred to have this template state "userbox"/"userbox page" instead of "template"/"template page" or "user template"/"user template page". If this is preferred, use: 

{{userbox documentation subpage}}

OR 

{{userbox documentation subpage|[[main userbox page to link to]]}}

Customization of text

To manually change the text of the template, the "text1=your text here" and/or "text2=your other text here" parameters can be specified. "text1=" changes the automatic text on the first line to your own word(s). "text2=" changes the automatic text on the second line to your own word(s). If "text1=" parameter is specified without the "text2=" parameter, both the first and second line of text will be custom based on the text given in the "text1=" parameter.

Example usage: 

{{documentation subpage|text1=custom first and second line text}}

{{documentation subpage|text2=custom second line text only}}

{{documentation subpage|text1=custom first line text|text2=custom second line text}}

See also

Template:Documentation/doc/see also


Retrieved from "http://shdenham.co.uk/mw/index.php?title=Template:Documentation_subpage/doc&oldid=7698"