Difference between revisions of "Template:Documentation subpage"
Line 1: | Line 1: | ||
− | {{#if:{{{ | + | <table class="messagebox" style="line-height:1.1em;" style=" background:#f9f9b7;"><tr><td rowspan="3" style="width:60px;text-align:center;" > [[Image:Edit-paste.svg|40px]]</td><td>This is the [[Wikipedia:Template documentation|template documentation]] page for [[{{NAMESPACE}}:{{{1|{{BASEPAGENAME}}}}}]].</td></tr><tr><td><small>This page may not be intended to be viewed directly. <br/>Links using [[Help:Variable|variable]]s may appear broken; do not replace these with [[hardcoded]] page names or URLs.</small></td></tr> |
+ | </table> | ||
+ | {{#if:{{{inhib|x}}}{{{inhibit|}}}| | ||
+ | |||
| | | | ||
− | + | <includeonly>[[Category:Template documentation|{{PAGENAME}}]]</includeonly> | |
− | |||
− | |||
− | |||
− | |||
− | |||
}} | }} | ||
− | |<includeonly>{{#ifeq: {{lc:{{SUBPAGENAME}}}} | {{{override|doc}}} | + | | |
− | + | <includeonly> | |
− | </includeonly>{{ | + | {{#ifeq: {{lc:{{SUBPAGENAME}}}} | {{{override|doc}}}| |
− | + | </includeonly> | |
− | + | {{#ifeq: {{{doc-notice|show}}} | show | | |
− | + | {{mbox|type = notice|image=[[File:Edit-copy green.svg|40px]]|text='''This is a [[Wikipedia:Template documentation|documentation]] [[Wikipedia:Subpages|subpage]] for {{{1|[[{{SUBJECTSPACE}}:{{BASEPAGENAME}}]]}}}''' <small>(see that page for the | |
− | + | {{#if: {{{text1|}}} | | |
− | + | {{{text1}}} | |
− | '''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}}}}}}}}. | + | | |
− | + | {{#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|}}}| | ||
+ | |||
+ | | | ||
+ | [[Category: | ||
+ | {{#if: {{SUBJECTSPACE}}| | ||
+ | {{SUBJECTSPACE}} | ||
+ | | | ||
+ | Article | ||
+ | }} | ||
+ | documentation<noinclude>| </noinclude>]] | ||
+ | }}<includeonly> | ||
+ | | | ||
+ | |||
}} | }} | ||
+ | </includeonly><noinclude>{{pp-template|small=yes}}{{documentation}}</noinclude> |
Revision as of 19:37, 23 June 2009
|
40px |
[[Category: Template
documentation| ]]Template:Pp-templateUsage
{{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').