Difference between revisions of "Template:Documentation subpage"
Line 1: | Line 1: | ||
− | + | <includeonly>{{#ifeq: {{lc:{{SUBPAGENAME}}}} | {{{override|doc}}} | |
− | + | | <!-- doc page --> | |
− | + | </includeonly>{{ | |
− | + | #ifeq: {{{doc-notice|show}}} | show | |
− | + | | {{mbox | |
− | + | | type = notice | |
− | + | | image = [[File:TemplateDocumentation.png|40px]] | |
− | {{#ifeq: {{lc:{{SUBPAGENAME}}}} | {{{override|doc}}}| | + | | text = |
− | + | '''This is a [[Wikipedia:Template documentation|documentation]] [[Wikipedia:Subpages|subpage]] for {{{1|[[{{SUBJECTSPACE}}:{{BASEPAGENAME}}]]}}}''' <small>(see that page for the {{ #if: {{{text1|}}} | {{{text1}}} | {{ #ifeq: {{SUBJECTSPACE}} | {{ns:User}} | {{lc:{{SUBJECTSPACE}}}} template | {{ #if: {{SUBJECTSPACE}} | {{lc:{{SUBJECTSPACE}}}} | article }}}}}} itself)</small>.<br />It contains usage information, [[Wikipedia:Categories|categories]] and other content that is not part of the original {{ #if: {{{text2|}}} | {{{text2}}} | {{ #if: {{{text1|}}} | {{{text1}}} | {{ #ifeq: {{SUBJECTSPACE}} | {{ns:User}} | {{lc:{{SUBJECTSPACE}}}} template page | {{ #if: {{SUBJECTSPACE}} |{{lc:{{SUBJECTSPACE}}}} page|article}}}}}}}}. | |
− | + | }} | |
− | + | }}{{DEFAULTSORT:{{PAGENAME}}}}{{ | |
− | + | #if: {{{inhibit|}}} | |
− | + | | <!-- skip --> | |
− | + | | [[Category:{{ | |
− | + | #if: {{SUBJECTSPACE}} | |
− | + | | {{SUBJECTSPACE}} | |
− | + | | Article | |
− | + | }} documentation<noinclude>| </noinclude>]] | |
− | + | }}<includeonly> | |
− | + | | <!-- if not on a /doc subpage, do nothing --> | |
− | + | }}</includeonly><noinclude> | |
− | + | {{pp-template|small=yes}} | |
− | + | {{documentation}} | |
− | + | <!-- Add categories and interwikis to the /doc subpage, not here! --> | |
− | + | </noinclude> | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | | | ||
− | |||
− | }} | ||
− | </includeonly><noinclude>{{pp-template|small=yes}}{{documentation}}</noinclude> |
Revision as of 20:13, 23 June 2009
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, 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').