Template:Documentation subpage: Difference between revisions
No edit summary |
m (Reverted edits by 90.219.4.40 (talk) to last revision by Shirayuki) |
||
| Line 1: | Line 1: | ||
{{#if:{{{Original-recipe|}}}{{{Orig|}}} |
|||
|<!-- reconstruction of original Template:Template doc page pattern (now the redirected to " Template:Documentation subpage") template... ca mid-November 2007 --> |
|||
<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|}}}|<!-- skip --->|<includeonly>[[Category:Template documentation|{{PAGENAME}}]]</includeonly> |
|||
}}<!-- Please retain the above original template... |
|||
There are templates formulated to [[WP:DPP]] that need this. |
|||
Of course, if you all want to start updating all the interwiki exported templates, go on making things more incompatible... queries to User:Fabartus. |
|||
---> |
|||
|<includeonly>{{#ifeq: {{lc:{{SUBPAGENAME}}}} | {{{override|doc}}} |
|||
| <!-- doc page --> |
| <!-- doc page --> |
||
</includeonly>{{ |
</includeonly>{{ |
||
| Line 7: | Line 23: | ||
| image = [[File:Edit-copy green.svg|40px]] |
| image = [[File:Edit-copy green.svg|40px]] |
||
| text = |
| text = |
||
'''This is a [[Wikipedia:Template documentation|documentation]] [[ |
'''This is a [[w:Wikipedia:Template documentation|documentation]] [[Help:Subpages|subpage]] for {{{1|[[:{{SUBJECTSPACE}}:{{BASEPAGENAME}}]]}}}''' |
||
<small>(see that page for the {{#if:{{{text1|}}} |
|||
|{{{text1}}} |
|||
| ⚫ | |||
|{{lc:{{SUBJECTSPACE}}}} template |
|||
|{{#if:{{SUBJECTSPACE}} |
|||
|{{lc:{{SUBJECTSPACE}}}} |
|||
|article}} |
|||
}} |
|||
}} itself)</small>.<br /><!-- |
|||
-->It contains usage information, [[Help:Categories|categories]], [[w:Help:Interlanguage links|interlanguage links]] 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:{{{defaultsort|{{PAGENAME}}}}}}}{{ |
}}{{DEFAULTSORT:{{{defaultsort|{{PAGENAME}}}}}}}{{ |
||
#if: {{{inhibit|}}} |
#if: {{{inhibit|}}} |
||
| <!-- skip --> |
| <!-- skip --> |
||
| |
| {{#ifeq:{{SUBJECTSPACE}}|Template|[[Category:Template documentation]]}} |
||
| ⚫ | |||
| Template = Template |
|||
| Module = Module |
|||
| User = User |
|||
| #default = Wikipedia |
|||
}} documentation pages]]|[[Category:Documentation subpages without corresponding pages]]}}</includeonly> |
|||
}}<includeonly> |
}}<includeonly> |
||
| <!-- if not on a /doc subpage, do nothing --> |
| <!-- if not on a /doc subpage, do nothing --> |
||
| Line 25: | Line 56: | ||
<!-- Add categories and interwikis to the /doc subpage, not here! --> |
<!-- Add categories and interwikis to the /doc subpage, not here! --> |
||
</noinclude> |
</noinclude> |
||
}} |
|||
Revision as of 14:14, 5 August 2013
 | This is a documentation subpage for Template:Documentation subpage
(see that page for the template itself). It contains usage information, categories, interlanguage links and other content that is not part of the original template page. |
This template displays a message that the current page is a documentation subpage.
Usage
{{Documentation subpage}}- or
{{Documentation subpage|[[Page where the documentation transcluded]]}}
Userbox documentation
To set this template to use "userbox" and "userbox page" rather than "template" and "template page" or "user template" and "user template page", use:
{{Userbox documentation subpage}}- or
{{Userbox documentation subpage|[[userbox page]]}}
Text customization
The parameters |text1= and |text2= can be used to set the text of, respectively, the template's first and second lines. If text1 is set but not text2, both lines' text will derive from text1:
{{Documentation subpage |text1='''''text1 appears here''''' |text2='''''text2 appears here'''''}}
| This is a documentation subpage for [page]
(see that page for the text1 appears here itself). It contains usage information, categories, interlanguage links and other content that is not part of the original text2 appears here. |
{{Documentation subpage |text2='''''text2 appears here'''''}}
| This is a documentation subpage for [page]
(see that page for the template itself). It contains usage information, categories, interlanguage links and other content that is not part of the original text2 appears here. |
{{Documentation subpage |text1='''''text1 appears here'''''}}
| This is a documentation subpage for [page]
(see that page for the text1 appears here itself). It contains usage information, categories, interlanguage links and other content that is not part of the original text1 appears here. |
Other parameters
|inhibit=yes will prevent this template from generating any categories. (By default, "Namespace documentation pages" (usually Category:Template documentation pages) is added, or Category:Documentation subpages without corresponding pages if the main page doesn't exist.)
Display
This template should normally 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 – i.e. 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 its message, the template adds 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: Template:Foo, for example, would be sorted as "Foo", i.e. under "F".