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

From blackwiki
Jump to navigation Jump to search
test>Funandtrvl
(fx)
test>Sardanaphalus
(some formatting/rephrasings, sandbox non-categorisation)
Line 1: Line 1:
{{documentation subpage}}
+
{{Documentation subpage}} __NOTOC__
__NOTOC__
+
 
 
== Usage ==
 
== Usage ==
{{tl|documentation subpage}}
 
'''OR'''
 
{{tlx|documentation subpage|<nowiki>[[</nowiki><var>main page to link to</var><nowiki>]]</nowiki>}}
 
  
=== Userboxes ===
+
{{tlx|Documentation subpage}}
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:
+
or
  {{tl|userbox documentation subpage}}
+
  {{tlx|Documentation subpage|{{!((}}{{var|Page where the documentation [[Wikipedia:Transclusion|transcluded]]}}{{!))}}}}
'''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:
 +
{{tl|Userbox documentation subpage}}
 +
or
 +
{{tlx|Userbox documentation subpage|{{!((}}{{var|userbox page}}{{!))}}}}
  
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=''custom text (text1) appears here'' |text2=''custom text (text2) appears here''}}</nowiki></code>
 +
{{float|left|produces...}} {{Documentation subpage |text1=''custom text (text1) appears here''|text2=''custom text (text2) appears here''}}
 +
{{Hidden end}}
 +
{{Hidden begin |showhide=left |title=With ''text2'' only}}
 +
<code><nowiki>{{Documentation subpage |text2=''custom text (text2) appears here''}}</nowiki></code>
 +
{{float|left|produces...}} {{Documentation subpage |text2=''custom text (text2) appears here''}}
 +
{{Hidden end}}
 +
{{Hidden begin |showhide=left |title=With ''text1'' only}}
 +
<code><nowiki>{{Documentation subpage |text1=''custom text (text1) appears here''}}</nowiki></code>
 +
{{float|left|produces...}} {{Documentation subpage |text1=''custom text (text1) appears here''}}
 +
{{Hidden end}}
  
{{tlx|documentation subpage|text2<nowiki>=</nowiki><var>custom second line text only</var>}}
+
== Display ==
  
{{tlx|documentation subpage|text1<nowiki>=</nowiki><var>custom first line text</var>|text2<nowiki>=</nowiki><var>custom second line text</var>}}
+
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 [[Wikipedia:Transclusion|transcluded]] from a subpage.
  
== How it is displayed ==
+
== Functions ==
This template should 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 (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 ==
+
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".
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').
 
  
 
== See also ==
 
== See also ==
Line 34: Line 42:
  
 
<includeonly>
 
<includeonly>
<!-- categories and interwiki links -->
+
{{#ifeq:{{SUBPAGENAME}}|sandbox | |
 +
<!--Categories below here, please; interwikis to Wikidata.-->
 
[[Category:Template documentation| ]]
 
[[Category:Template documentation| ]]
 
[[Category:Template namespace templates]]
 
[[Category:Template namespace templates]]
  
 
[[tn:Template:Documentation subpage]]
 
[[tn:Template:Documentation subpage]]
 +
}}
 
</includeonly>
 
</includeonly>

Revision as of 10:37, 18 July 2014

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/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=''custom text (text1) appears here'' |text2=''custom text (text2) appears here''}}
produces...
With text2 only
{{Documentation subpage |text2=''custom text (text2) appears here''}}
produces...
With text1 only
{{Documentation subpage |text1=''custom text (text1) appears here''}}
produces...

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

General information about documentation for templates:

{{Documentation}} family:

Meta-Wiki {{Documentation}} ancestor: