Difference between revisions of "Template:Documentation subpage/doc"
From Arkaz
m (1 revision(s)) |
|||
| Line 1: | Line 1: | ||
| − | {{documentation subpage}}< | + | {{documentation subpage}} |
| + | __NOTOC__ | ||
| + | ==Usage== | ||
| + | {{tl|documentation subpage}} | ||
| + | '''OR''' | ||
| + | {{tlx|documentation subpage|<nowiki>[[</nowiki><var>main page to link to</var><nowiki>]]</nowiki>}} | ||
| + | |||
| + | ===Userboxes=== | ||
| + | When used to document usage of a [[Wikipedia:Userboxes|userbox]], it may be preferred to have this template state "userbox"/"userbox page" instead of "{{lc:{{ns:Template}}}}"/"{{lc:{{ns:Template}}}} page" or "{{lc:{{ns:User}}}} template"/"{{lc:{{ns:User}}}} template page". If this is preferred, use: | ||
| + | {{tl|userbox documentation subpage}} | ||
| + | '''OR''' | ||
| + | {{tlx|userbox documentation subpage|<nowiki>[[</nowiki><var>main userbox page to link to</var><nowiki>]]</nowiki>}} | ||
| + | |||
| + | ===Customization of text=== | ||
| + | To manually change the text of the template, the "<code>text1=<var>your text here</var></code>" and/or "<code>text2=<var>your other text here</var></code>" parameters can be specified. "<code>text1=</code>" changes the automatic text on the first line to your own word(s). "<code>text2=</code>" changes the automatic text on the second line to your own word(s). If "<code>text1=</code>" parameter is specified without the "<code>text2=</code>" parameter, both the first and second line of text will be custom based on the text given in the "<code>text1=</code>" parameter. | ||
| − | = | + | Example usage: |
| − | < | + | {{tlx|documentation subpage|text1<nowiki>=</nowiki><var>custom first and second line text</var>}} |
| − | {{documentation subpage}} | + | |
| − | + | {{tlx|documentation subpage|text2<nowiki>=</nowiki><var>custom second line text only</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: | 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 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), | + | * 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== | ==Functions== | ||
| − | In addition to the output message, the template categorizes pages to [[:Category: | + | 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== | ||
| − | * | + | * [[Wikipedia:Template documentation]] for how this template is used. |
| − | + | {{ Documentation/doc/see also }} | |
<includeonly> | <includeonly> | ||
<!-- categories and interwiki links --> | <!-- categories and interwiki links --> | ||
[[Category:Template documentation| {{PAGENAME}}]] | [[Category:Template documentation| {{PAGENAME}}]] | ||
[[Category:Template namespace templates]] | [[Category:Template namespace templates]] | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
</includeonly> | </includeonly> | ||
Latest revision as of 12:22, 9 March 2009
| 40px | This is a documentation subpage for Template:Documentation subpage (see that page for the template itself). It contains usage information, categories and other content that is not part of the original template page. |
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}}
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
{{Documentation}}) will automatically note that the documentation is 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 sort key to the page name without namespace (ie, "Foo" on "Template:Foo", so it would be sorted in categories under 'F').
See also
- Wikipedia:Template documentation for how this template is used.
