|
|
| Line 1: |
Line 1: |
| {{Documentation subpage}} | | <includeonly><!-- |
| {{high-use}}
| | -->{{#ifeq:{{lc:{{SUBPAGENAME}}}} |{{{override|doc}}} |
| {{Distinguish|Template:Documentation}} | | | <!--(this template has been transcluded on a /doc or /{{{override}}} page)--> |
| This template displays a message that the current page is a documentation subpage.
| | </includeonly><!-- |
|
| |
|
| == Usage ==
| | -->{{#ifeq:{{{doc-notice|show}}} |show |
| : {{Template link expanded|Documentation subpage}} | | | {{Mbox |
| : or | | | type = notice |
| : {{Template link expanded|Documentation subpage |[[{{var|Page where the documentation is [[Help:Transclusion|transcluded]]}}]]}} | | | style = margin-bottom:1.0em; |
| | | image = [[File:Edit-copy green.svg|40px|alt=|link=]] |
| | | text = |
| | {{strong|This is a [[Wikipedia:Template documentation|documentation]] [[Wikipedia:Subpages|subpage]]}} for {{terminate sentence|{{{1|[[:{{SUBJECTSPACE}}:{{BASEPAGENAME}}]]}}}}}<br />It may contain 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}}}}}}}}. |
| | }} |
| | }}<!-- |
|
| |
|
| ===Userbox documentation===
| | -->{{DEFAULTSORT:{{{defaultsort|{{PAGENAME}}}}}}}<!-- |
| 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:
| |
| : {{Template link expanded|Userbox documentation subpage}}
| |
| : or
| |
| : {{Template link expanded|Userbox documentation subpage |[[{{var|userbox page}}]]}}
| |
|
| |
|
| ===Text customization===
| | -->{{#if:{{{inhibit|}}} |<!--(don't categorize)--> |
| The parameters {{para|text1}} and {{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'':
| | | <includeonly><!-- |
| {{Hidden begin |showhide=left |title=With ''text1'' and ''text2''}}
| | -->{{#ifexist:{{NAMESPACE}}:{{BASEPAGENAME}} |
| <code><nowiki>{{Documentation subpage |text1='''''text1 appears here''''' |text2='''''text2 appears here'''''}}</nowiki></code>
| | | [[Category:{{#switch:{{SUBJECTSPACE}} |Template=Template |Module=Module |User=User |#default=Wikipedia}} documentation pages]] |
| {{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]] -->}}}}
| | | [[Category:Documentation subpages without corresponding pages]] |
| {{Hidden end}} | | }}<!-- |
| {{Hidden begin |showhide=left |title=With ''text2'' only}} | | --></includeonly> |
| <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}}
| |
|
| |
|
| ===Other parameters===
| | (completing initial #ifeq: at start of template:) |
| {{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.)
| | --><includeonly> |
| | | | <!--(this template has not been transcluded on a /doc or /{{{override}}} page)--> |
| == Display ==
| | }}<!-- |
| This template should normally be placed at the top of /doc pages. It changes output depending on where it is viewed:
| | --></includeonly><noinclude>{{Documentation}}</noinclude> |
| * 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 <code>{{Template link|Documentation}}</code>) will automatically note that the documentation is [[Help:Transclusion|transcluded]] from a subpage.
| |
| | |
| == Module documentation ==
| |
| This template is automatically shown on /doc subpages in the [[Wikipedia:Namespace|module namespace]]. This is done automatically via [[MediaWiki:Scribunto-doc-page-header]].
| |
| | |
| == Automatic categorization ==
| |
| 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=
| |
| *{{Template link|Userbox/categories}}
| |
| *{{Template link|Userbox/citydoc}}}}</includeonly>
| |
| *{{Template link|Documentation/see also}}
| |
| *{{Template link|Documentation subpage}}
| |
| *{{Template link|Userspace disclaimers}}
| |
| *{{Template link|Userbox 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> | |
Template documentation