Template:Documentation subpage: Difference between revisions
Jump to navigation
Jump to search
(New page: {{#if:{{{Original-recipe|}}}{{{Orig|}}} |<!-- reconstruction of original Template:Template doc page pattern (now the redirected to " Template:Documentation subpage") template... ca mid-No...) |
m (1 revision imported) |
||
| (One intermediate revision by one other user not shown) | |||
| Line 1: | Line 1: | ||
<includeonly><!-- | |||
-->{{#ifeq:{{lc:{{SUBPAGENAME}}}} |{{{override|doc}}} | |||
| <!--(this template has been transcluded on a /doc or /{{{override}}} page)--> | |||
</includeonly><!-- | |||
--> | |||
-->{{#ifeq:{{{doc-notice|show}}} |show | |||
| {{Mbox | |||
| type = notice | |||
| style = margin-bottom:1.0em; | |||
| image = [[File:Edit-copy green.svg|40px|alt=|link=]] | |||
| text = | |||
'''This is a [[Wikipedia:Template documentation|documentation]] [[Wikipedia:Subpages|subpage]] for {{{1|[[:{{SUBJECTSPACE}}:{{BASEPAGENAME}}]]}}}'''.<br />It contains 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}}}}}}}}. | |||
}} | |||
}}<!-- | |||
-->{{DEFAULTSORT:{{{defaultsort|{{PAGENAME}}}}}}}<!-- | |||
-- | -->{{#if:{{{inhibit|}}} |<!--(don't categorize)--> | ||
| <includeonly><!-- | |||
-->{{#ifexist:{{NAMESPACE}}:{{BASEPAGENAME}} | |||
< | | [[Category:{{#switch:{{SUBJECTSPACE}} |Template=Template |Module=Module |User=User |#default=Wikipedia}} documentation pages]] | ||
| [[Category:Documentation subpages without corresponding pages]] | |||
}}<!-- | |||
--></includeonly> | |||
}}<!-- | |||
(completing initial #ifeq: at start of template:) | |||
--><includeonly> | |||
| <!--(this template has not been transcluded on a /doc or /{{{override}}} page)--> | |||
}}<!-- | |||
--></includeonly><noinclude>{{Documentation}}</noinclude> | |||
| <!-- | |||
}}</includeonly><noinclude> | |||
{{ | |||
</noinclude> | |||
Latest revision as of 04:06, 2 November 2018
 | This is a documentation subpage for Template:Documentation subpage. It contains usage information, categories and other content that is not part of the original template page. |
Template documentationUsage[edit source]
{{documentation subpage}}
OR
{{documentation subpage|[[main page to link to]]}}
Userboxes[edit source]
When used to document usage of a userbox, it may be preferred to have this template state "userbox"/"userbox page" instead of "template"/"template page" or "user template"/"user template page". If this is preferred, use:
{{userbox documentation subpage}}
OR
{{userbox documentation subpage|[[main userbox page to link to]]}}
Customization of text[edit source]
To manually change the text of the template, the "text1=your text here" and/or "text2=your other text here" parameters can be specified. "text1=" changes the automatic text on the first line to your own word(s). "text2=" changes the automatic text on the second line to your own word(s). If "text1=" parameter is specified without the "text2=" parameter, both the first and second line of text will be custom based on the text given in the "text1=" parameter.
Example usage:
{{documentation subpage|text1=custom first and second line text}}
{{documentation subpage|text2=custom second line text only}}
{{documentation subpage|text1=custom first line text|text2=custom second line text}}
How it is displayed[edit source]
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
{{Documentation}}) will automatically note that the documentation is transcluded from a subpage.
Functions[edit source]
In addition to the output message, the template categorizes pages to Category:Template documentation, Category:User documentation, 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 (ie, "Foo" on "Template:Foo", so it would be sorted in categories under 'F').
See also[edit source]
- Wikipedia:Template documentation for how this template is used.
General information about documentation for templates[edit source]
{{ Documentation }} family[edit source]
- Template:Documentation subpage/doc (backlinks, edit)
- Template:Documentation subpage/sandbox (backlinks, edit)
- Template:Documentation subpage/testcases (backlinks, edit)
Meta Wiki {{ Documentation }} ancestor[edit source]
| The above documentation is transcluded from Template:Documentation subpage/doc. (edit | history) Editors can experiment in this template's sandbox (create | mirror) and testcases (create) pages. Please add categories to the /doc subpage. Subpages of this template. |