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

From blackwiki
Jump to navigation Jump to search
imported>Ianblair23
(links)
 
(67 intermediate revisions by 39 users not shown)
Line 1: Line 1:
{{documentation subpage}}
+
{{Distinguish|Template:Documentation}}
__NOTOC__
+
This template displays a message that the current page is a documentation subpage.
 +
 
 
== Usage ==
 
== Usage ==
{{tl|documentation subpage}}
+
: {{tlx|Documentation subpage}}
'''OR'''
+
: or
{{tlx|documentation subpage|<nowiki>[[</nowiki><var>main page to link to</var><nowiki>]]</nowiki>}}
+
: {{tlx|Documentation subpage |&#91;&#91;{{var|Page where the documentation [[Help:Transclusion|transcluded]]}}&#93;&#93;}}
  
=== Userboxes ===
+
<br><br>{{example needed|s}}
When used to document usage of a [[Wikipedia:Userboxes|userbox]], it may be preferred to have this template state "userbox"/"userbox page" instead of "{{lc:{{ns:Template}}}}"/"{{lc:{{ns:Template}}}} page" or "{{lc:{{ns:User}}}} template"/"{{lc:{{ns:User}}}} template page". If this is preferred, use:
 
{{tl|userbox documentation subpage}}
 
'''OR'''
 
{{tlx|userbox documentation subpage|<nowiki>[[</nowiki><var>main userbox page to link to</var><nowiki>]]</nowiki>}}
 
  
=== Customization of text ===
+
===Userbox documentation===
To manually change the text of the template, the "<code>text1=<var>your text here</var></code>" and/or "<code>text2=<var>your other text here</var></code>" parameters can be specified. "<code>text1=</code>" changes the automatic text on the first line to your own word(s). "<code>text2=</code>" changes the automatic text on the second line to your own word(s). If "<code>text1=</code>" parameter is specified without the "<code>text2=</code>" parameter, both the first and second line of text will be custom based on the text given in the "<code>text1=</code>" parameter.
+
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:
 +
: {{tlx|Userbox documentation subpage}}
 +
: or
 +
: {{tlx|Userbox documentation subpage |&#91;&#91;{{var|userbox page}}&#93;&#93;}}
  
Example usage:
+
===Text customization===
{{tlx|documentation subpage|text1<nowiki>=</nowiki><var>custom first and second line text</var>}}
+
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'':
 +
{{Hidden begin |showhide=left |title=With ''text1'' and ''text2''}}
 +
<code><nowiki>{{Documentation subpage |text1='''''text1 appears here''''' |text2='''''text2 appears here'''''}}</nowiki></code>
 +
{{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]] -->}}}}
 +
{{Hidden end}}
 +
{{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}}
  
{{tlx|documentation subpage|text2<nowiki>=</nowiki><var>custom second line text only</var>}}
+
===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.)
  
{{tlx|documentation subpage|text1<nowiki>=</nowiki><var>custom first line text</var>|text2<nowiki>=</nowiki><var>custom second line text</var>}}
+
== Display ==
 
+
This template should normally be placed at the top of /doc pages. It changes output depending on where it is viewed:
== How it is displayed ==
+
* On a /doc page, it displays a box explaining template documentation and links to the template page.
This template should be placed at the top of "/doc" pages. It changes output depending on where it is viewed:
+
* 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.
* 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 <code>{{tl|Documentation}}</code>) will automatically note that the documentation is [[Wikipedia:Transclusion|transcluded]] from a subpage.
 
  
 
== Functions ==
 
== Functions ==
In addition to the output message, the template categorizes 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 (ie, "Foo" on "Template:Foo", so it would be sorted in categories under 'F').
+
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 ==
 
== See also ==
* [[Wikipedia:Template sandbox and test cases]] for how this template is used.
+
<includeonly>{{#switch:{{FULLPAGENAME}}
{{ Documentation/see also }}
+
|Template:Userbox documentation subpage=
 
+
*{{tl|Userbox/categories}}
<includeonly>
+
*{{tl|Userbox/citydoc}}}}</includeonly>
<!-- categories and interwiki links -->
+
*{{tl|Documentation/see also}}
[[Category:Template documentation| {{PAGENAME}}]]
+
*{{tl|Documentation subpage}}
[[Category:Template namespace templates]]
+
*{{tl|Userspace disclaimers}}
 +
*{{tl|Userbox documentation subpage}}
 +
*{{tl|Userspace disclaimers}}
  
[[als:Vorlage:Dokumentation/Dokuseite]]
+
<includeonly>{{Sandbox other||<!-- Make sure only the template page is categorised. No subpages, and not after transclusion. This /doc page is reused, btw.
[[ar:قالب:صفحة توثيق فرعية]]
+
-->{{#switch:{{FULLPAGENAME}}
[[as:Template:Documentation subpage]]
+
|Template:Documentation subpage         = [[Category:Template documentation| ]]
[[bar:Vorlage:Dokumentation/Dokuseitn]]
+
|Template:Userbox documentation subpage = [[Category:Template documentation| ]][[Category:Userboxes|Δ]]
[[be-x-old:Шаблён:Падстаронка-дакумэнтацыя]]
+
}}
[[bg:Шаблон:Подстраница с документация]]
+
[[Category:Documentation header templates]]
[[bn:টেমপ্লেট:Documentation subpage]]
+
}}</includeonly>
[[ca:Plantilla:Subpàgina de plantilla]]
 
[[cs:Šablona:Podstránka s dokumentací]]
 
[[da:Skabelon:Skabelondokumentationsside vist direkte]]
 
[[de:Vorlage:Dokumentation/Dokuseite]]
 
[[eo:Ŝablono:Ŝablona navigado]]
 
[[es:Plantilla:Subpágina de documentación]]
 
[[et:Mall:Dokumentatsiooni alamleht]]
 
[[fa:الگو:زیرصفحه توضیحات]]
 
[[fr:Modèle:Documentation modèle vue directement]]
 
[[eu:Txantiloi:Txantiloi dokumentazio azpiorrialdea]]
 
[[ko:틀:틀 설명문서 안내]]
 
[[id:Templat:Subhalaman dokumentasi]]
 
[[is:Snið:Skjalsíða]]
 
[[ja:template:Documentation subpage]]
 
[[ka:template:თარგის ინფო გვერდის ხედვა პირდაპირ]]
 
[[ky:Калып:Documentation subpage]]
 
[[la:Formula:Documentation subpage]]
 
[[mk:Шаблон:Документација потстрана]]
 
[[ml:ഫലകം:Template doc page transcluded]]
 
[[ms:Templat:Sublaman pendokumenan]]
 
[[nl:Sjabloon:Sjabdoc direct]]
 
[[nn:Mal:Dokumentasjonsunderside]]
 
[[no:Mal:Dokumentasjonsunderside]]
 
[[pl:Szablon:Podstrona dokumentacji]]
 
[[pt:Predefinição:Subpágina de documentação]]
 
[[ro:template:Template doc page viewed directly]]
 
[[ru:Шаблон:Docpage]]
 
[[simple:Template:Documentation subpage]]
 
[[sl:template:Dokumentacijska podstran]]
 
[[sl:template:Dokumentacijska podstran]]
 
[[sq:Stampa:Documentation subpage]]
 
[[sv:Mall:Dokumentationssida]]
 
[[tpi:Template:Documentation subpage]]
 
[[th:แม่แบบ:Documentation subpage]]
 
[[tn:Template:Documentation subpage]]
 
[[ta:வார்ப்புரு:Documentation subpage]]
 
[[tr:Şablon:Şablon belge sayfası]]
 
[[uk:Шаблон:Підсторінка документації]]
 
[[ur:Template:Documentation subpage]]
 
[[zh:模板:Template doc page viewed directly]]
 
</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