Difference between revisions of "Template:Documentation subpage/doc"

From blackwiki
Jump to navigation Jump to search
test>VarunFEB2003
imported>Ianblair23
(links)
 
(45 intermediate revisions by 27 users not shown)
Line 1: Line 1:
{{Documentation subpage}} __NOTOC__
+
{{Distinguish|Template:Documentation}}
 +
This template displays a message that the current page is a documentation subpage.
 +
 
 
== Usage ==
 
== Usage ==
 
: {{tlx|Documentation subpage}}
 
: {{tlx|Documentation subpage}}
 
: or
 
: or
: {{tlx|Documentation subpage |[[{{var|Page where the documentation [[Wikipedia:Transclusion|transcluded]]}}]]}}
+
: {{tlx|Documentation subpage |[[{{var|Page where the documentation [[Help:Transclusion|transcluded]]}}]]}}
 +
 
 +
<br><br>{{example needed|s}}
  
 
===Userbox documentation===
 
===Userbox documentation===
Line 25: Line 29:
 
{{Documentation subpage |[''page''] |text1='''''text1 appears here''''' |override={{lc:{{SUBPAGENAME}}<!-- Hack to allow example to appear, even when viewed from [[Template:Documentation subpage]] -->}}}}
 
{{Documentation subpage |[''page''] |text1='''''text1 appears here''''' |override={{lc:{{SUBPAGENAME}}<!-- Hack to allow example to appear, even when viewed from [[Template:Documentation subpage]] -->}}}}
 
{{Hidden end}}
 
{{Hidden end}}
 +
 +
===Other parameters===
 +
{{para|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 ==
 
== Display ==
 
This template should normally be placed at the top of /doc pages. It changes output depending on where it is viewed:
 
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 a /doc page, it displays a box explaining template documentation and links to the template page.
* On other pages&nbsp;– i.e. pages transcluding the /doc page&nbsp;– the template will not show. The template page itself (which contains <code>{{tl|Documentation}}</code>) will automatically note that the documentation is [[Wikipedia:Transclusion|transcluded]] from a subpage.
+
* On other pages&nbsp;– i.e. pages transcluding the /doc page&nbsp;– the template will not show. The template page itself (which contains <code>{{tl|Documentation}}</code>) will automatically note that the documentation is [[Help:Transclusion|transcluded]] from a subpage.
  
 
== Functions ==
 
== Functions ==
Line 35: Line 42:
  
 
== See also ==
 
== See also ==
{{Documentation/see also}}
+
<includeonly>{{#switch:{{FULLPAGENAME}}
{{User Talk Pages}}
+
|Template:Userbox documentation subpage=
{{Userspace Disclaimers}}
+
*{{tl|Userbox/categories}}
 
+
*{{tl|Userbox/citydoc}}}}</includeonly>
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox |
+
*{{tl|Documentation/see also}}
| <!--Categories below here, please; interwikis to Wikidata.-->
+
*{{tl|Documentation subpage}}
[[Category:Template documentation| ]]
+
*{{tl|Userspace disclaimers}}
[[Category:Template namespace templates]]
+
*{{tl|Userbox documentation subpage}}
 +
*{{tl|Userspace disclaimers}}
  
[[tn:Template:Documentation subpage]]
+
<includeonly>{{Sandbox other||<!-- Make sure only the template page is categorised. No subpages, and not after transclusion. This /doc page is reused, btw.
 +
-->{{#switch:{{FULLPAGENAME}}
 +
|Template:Documentation subpage        = [[Category:Template documentation| ]]
 +
|Template:Userbox documentation subpage = [[Category:Template documentation| ]][[Category:Userboxes|Δ]]
 +
}}
 +
[[Category:Documentation header templates]]
 
}}</includeonly>
 
}}</includeonly>

Latest revision as of 21:40, 21 November 2020

This template displays a message that the current page is a documentation subpage.

Usage

{{Documentation subpage}}
or
{{Documentation subpage |[[Page where the documentation transcluded]]}}



[examples needed]

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/or |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:

With text1 and text2

{{Documentation subpage |text1='''''text1 appears here''''' |text2='''''text2 appears here'''''}}

With text2 only

{{Documentation subpage |text2='''''text2 appears here'''''}}

With text1 only

{{Documentation subpage |text1='''''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".

See also