289
edits
Changes
Created page with "{{documentation subpage}} __NOTOC__ ==Usage== <nowiki>{{documentation subpage}}</nowiki> '''OR''' <nowiki>{{documentation subpage|main page to link to}}</nowiki> ===Customi..."
{{documentation subpage}}
__NOTOC__
==Usage==
<nowiki>{{documentation subpage}}</nowiki>
'''OR'''
<nowiki>{{documentation subpage|main page to link to}}</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:
<nowiki>{{documentation subpage|text1= custom first and second line text}}</nowiki>
<nowiki>{{documentation subpage|text2=custom second line text only}}</nowiki>
<nowiki>{{documentation subpage|text1=custom first line text|text2=custom second line text}}</nowiki>
==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').
<includeonly>
<!-- categories and interwiki links -->
[[Category:Template documentation| {{PAGENAME}}]]
[[Category:Template namespace templates]]
</includeonly>
__NOTOC__
==Usage==
<nowiki>{{documentation subpage}}</nowiki>
'''OR'''
<nowiki>{{documentation subpage|main page to link to}}</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:
<nowiki>{{documentation subpage|text1= custom first and second line text}}</nowiki>
<nowiki>{{documentation subpage|text2=custom second line text only}}</nowiki>
<nowiki>{{documentation subpage|text1=custom first line text|text2=custom second line text}}</nowiki>
==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').
<includeonly>
<!-- categories and interwiki links -->
[[Category:Template documentation| {{PAGENAME}}]]
[[Category:Template namespace templates]]
</includeonly>
