Template:Documentation subpage: Difference between revisions
(merging: copy from sandbox; add semi-protection) |
m (1 revision imported) Tags: Mobile edit Mobile web edit Advanced mobile edit |
||
(161 intermediate revisions by 100 users not shown) | |||
Line 1: | Line 1: | ||
<includeonly><!-- |
|||
<noinclude> |
|||
⚫ | |||
<!-- only show on documentation subpages --> |
|||
| <!--(this template has been transcluded on a /doc or /{{{override}}} page)--> |
|||
{{ #ifeq: {{SUBPAGENAME}} | sandbox |
|||
</includeonly><!-- |
|||
| {{Template sandbox notice}} |
|||
| {{pp-semi-template|small=yes}} |
|||
-->{{#ifeq:{{{doc-notice|show}}} |show |
|||
}} |
|||
| {{Mbox |
|||
⚫ | |||
| type = notice |
|||
⚫ | |||
| style = margin-bottom:1.0em; |
|||
⚫ | |||
| image = [[File:Edit-copy green.svg|40px|alt=|link=]] |
|||
#if: {{{inhibit|}}} |
|||
| text = |
|||
| <!-- skip --> |
|||
⚫ | {{strong|This is a [[Wikipedia:Template documentation|documentation]] [[Wikipedia:Subpages|subpage]]}} for {{terminate sentence|{{{1|[[:{{SUBJECTSPACE}}:{{BASEPAGENAME}}]]}}}}}<br />It may contain usage information, [[Wikipedia:Categorization|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}}}}}}}}. |
||
| [[Category:{{ #if: {{SUBJECTSPACE}} |{{SUBJECTSPACE}}|Article}} documentation<noinclude>| </noinclude>]] |
|||
}} |
|||
}}<includeonly>}}</includeonly><noinclude> |
|||
}}<!-- |
|||
{{ #ifeq: {{FULLPAGENAME}} | Template:Documentation subpage | |
|||
{{mergingfrom|Template doc page|date=November 2007}} |
|||
-->{{DEFAULTSORT:{{{defaultsort|{{PAGENAME}}}}}}}<!-- |
|||
{{mergingfrom|Template doc page transcluded|date=November 2007}} |
|||
<!-- Merge completed: [[User:ConradPino]] 13:00, 9 November 2007 (UTC) |
|||
-->{{#if:{{{inhibit|}}} |<!--(don't categorize)--> |
|||
{{mergingfrom|Template doc page viewed directly|date=November 2007}} |
|||
| <includeonly><!-- |
|||
--> |
|||
-->{{#ifexist:{{NAMESPACE}}:{{BASEPAGENAME}} |
|||
{{documentation}} |
|||
| [[Category:{{#switch:{{SUBJECTSPACE}} |Template=Template |Module=Module |User=User |#default=Wikipedia}} documentation pages]] |
|||
}} |
|||
| [[Category:Documentation subpages without corresponding pages]] |
|||
<!-- Add categories and interwikis to the /doc subpage, not here! --> |
|||
}}<!-- |
|||
</noinclude> |
|||
--></includeonly> |
|||
}}<!-- |
|||
(completing initial #ifeq: at start of template:) |
|||
⚫ | |||
| <!--(this template has not been transcluded on a /doc or /{{{override}}} page)--> |
|||
}}<!-- |
|||
--></includeonly><noinclude>{{Documentation}}</noinclude> |
Latest revision as of 15:41, 29 November 2023
Template:Strong for Template:Documentation subpage. It may contain usage information, categories 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 Edit
{{Documentation subpage}}
- or
{{Documentation subpage|[[Page where the documentation transcluded]]}}
Userbox documentation Edit
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 Edit
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'''''}}
Template:Strong for [page] . It may contain usage information, categories and other content that is not part of the original text2 appears here. |
{{Documentation subpage |text2='''''text2 appears here'''''}}
Template:Strong for [page] . It may contain usage information, categories and other content that is not part of the original text2 appears here. |
{{Documentation subpage |text1='''''text1 appears here'''''}}
Template:Strong for [page] . It may contain usage information, categories and other content that is not part of the original text1 appears here. |
Other parameters Edit
|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 Edit
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 Edit
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".