On November 27th, 2022, the 8,000th article was added to the SuccuWiki!
Template:Documentation subpage/doc: Difference between revisions
mNo edit summary |
mNo edit summary |
||
| (One intermediate revision by the same user not shown) | |||
| Line 5: | Line 5: | ||
'''OR''' | '''OR''' | ||
{{tlx|documentation subpage|<nowiki>[[</nowiki><var>main page to link to</var><nowiki>]]</nowiki>}} | {{tlx|documentation subpage|<nowiki>[[</nowiki><var>main page to link to</var><nowiki>]]</nowiki>}} | ||
=== Customization of text === | === Customization of text === | ||
| Line 28: | Line 22: | ||
== Functions == | == Functions == | ||
In addition to the output message, the template categorizes pages to [[:Category:Template documentation pages]], [[:Category:User documentation pages]], or similar (named after the subject space), but only for documentation pages in namespaces with the subpage feature. It defaults the | In addition to the output message, the template categorizes pages to [[:Category:Template documentation pages]], [[:Category:User documentation pages]], 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 == | == See also == | ||
Latest revision as of 06:31, 10 October 2012
 |
This is a documentation subpage for Template:Documentation subpage. It contains usage information, categories, interlanguage links and other content that is not part of the original template page. |
Usage
{{documentation subpage}}
OR
{{documentation subpage|[[main 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 pages, Category:User documentation pages, 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 sandbox and test cases for how this template is used.
General information about documentation for templates:
{{Documentation}} family:
- {{Documentation}}
- {{Documentation subpage}}
Meta-Wiki {{Documentation}} ancestor: