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

From blackwiki
Jump to navigation Jump to search
test>Sperry0912
imported>Ianblair23
(links)
 
(151 intermediate revisions by more than 100 users not shown)
Line 1: Line 1:
{{Sara Kate Perry}}
+
{{Distinguish|Template:Documentation}}
__NOTOC__
+
This template displays a message that the current page is a documentation subpage.
==Sara Kate Perry==
 
<(Born September, 12 1980 in Boca Raton Florida)Broadway Actress, Singer, Dancer )  >
 
  
Most recent preformance credits:
+
== Usage ==
* RENT (Original, Musical, Drama).
+
: {{tlx|Documentation subpage}}
* 42nd Street (Revival, Musical).
+
: or
 +
: {{tlx|Documentation subpage |&#91;&#91;{{var|Page where the documentation [[Help:Transclusion|transcluded]]}}&#93;&#93;}}
  
==Functions==
+
<br><br>{{example needed|s}}
Other credits include: Aida (Disney, Musical), Grease (Revival, Musical), Crazy for You (Original, Musical). Sara is currently the Artistic Director of SHOWTIME Dance & Performing Arts Theatre in Boca Raton Florida.
 
  
==See also==
+
===Userbox documentation===
* [[Wikipedia:Template documentation]] for how this template is used.
+
To set this template to use "userbox" and "userbox page" rather than "{{lc:{{ns:Template}}}}" and "{{lc:{{ns:Template}}}} page" or "{{lc:{{ns:User}}}} template" and "{{lc:{{ns:User}}}} template page", use:
{{ Documentation/doc/see also }}
+
: {{tlx|Userbox documentation subpage}}
<includeonly>
+
: or
<!-- categories and interwiki links -->
+
: {{tlx|Userbox documentation subpage |&#91;&#91;{{var|userbox page}}&#93;&#93;}}
[[Category:Template documentation| {{PAGENAME}}]]
 
[[Category:Template namespace templates]]
 
  
[[bg:Шаблон:Подстраница с документация]]
+
===Text customization===
[[es:Plantilla:Subpágina documentación de plantilla]]
+
The parameters {{para|text1}} and/or {{para|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'':
[[is:Snið:Skjalsíða]]
+
{{Hidden begin |showhide=left |title=With ''text1'' and ''text2''}}
[[ja:template:Documentation subpage]]
+
<code><nowiki>{{Documentation subpage |text1='''''text1 appears here''''' |text2='''''text2 appears here'''''}}</nowiki></code>
[[mk:Шаблон:Документација потстрана]]
+
{{Documentation subpage |[''page''] |text1='''''text1 appears here''''' |text2='''''text2 appears here''''' |override={{lc:{{SUBPAGENAME}}<!-- Hack to allow example to appear, even when viewed from [[Template:Documentation subpage]] -->}}}}
[[pl:Szablon:Podstrona dokumentacji]]
+
{{Hidden end}}
[[sl:template:Dokumentacijska podstran]]
+
{{Hidden begin |showhide=left |title=With ''text2'' only}}
 +
<code><nowiki>{{Documentation subpage |text2='''''text2 appears here'''''}}</nowiki></code>
 +
{{Documentation subpage |[''page''] |text2='''''text2 appears here''''' |override={{lc:{{SUBPAGENAME}}<!-- Hack to allow example to appear, even when viewed from [[Template:Documentation subpage]] -->}}}}
 +
{{Hidden end}}
 +
{{Hidden begin |showhide=left |title=With ''text1'' only}}
 +
<code><nowiki>{{Documentation subpage |text1='''''text1 appears here'''''}}</nowiki></code>
 +
{{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}}
  
</includeonly>
+
===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 ==
 +
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&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 ==
 +
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 [[m:Help:Categories#Sort order|sort key]] to the page name without namespace: Template:Foo, for example, would be sorted as "Foo", i.e. under "F".
 +
 
 +
== See also ==
 +
<includeonly>{{#switch:{{FULLPAGENAME}}
 +
|Template:Userbox documentation subpage=
 +
*{{tl|Userbox/categories}}
 +
*{{tl|Userbox/citydoc}}}}</includeonly>
 +
*{{tl|Documentation/see also}}
 +
*{{tl|Documentation subpage}}
 +
*{{tl|Userspace disclaimers}}
 +
*{{tl|Userbox documentation subpage}}
 +
*{{tl|Userspace disclaimers}}
 +
 
 +
<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>

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