Toggle search
Search
Toggle menu
notifications
Toggle personal menu
Editing
Template:Documentation subpage/doc
Template page
Views
Read
Edit source
View history
associated-pages
Template
Discussion
More actions
Warning:
You are not logged in. Your IP address will be publicly visible if you make any edits. If you
log in
or
create an account
, your edits will be attributed to your username, along with other benefits.
Anti-spam check. Do
not
fill this in!
{{Documentation subpage}} {{high-use}} {{Distinguish|Template:Documentation}} This template displays a message that the current page is a documentation subpage. == Usage == : {{Template link expanded|Documentation subpage}} : or : {{Template link expanded|Documentation subpage |[[{{var|Page where the documentation is transcluded}}]]}} ===Userbox documentation=== 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=== 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'': {{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}} ===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 β 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 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>
Summary:
Please note that all contributions to W.K.pedia are considered to be released under the Creative Commons Attribution-ShareAlike (see
awk:Copyrights
for details). If you do not want your writing to be edited mercilessly and redistributed at will, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource.
Do not submit copyrighted work without permission!
Cancel
Editing help
(opens in new window)
Templates used on this page:
Template:Distinguish
(
edit
)
Template:Documentation subpage
(
edit
)
Template:Hidden begin
(
edit
)
Template:Hidden begin/styles.css
(
edit
)
Template:Hidden end
(
edit
)
Template:High-use
(
edit
)
Template:Mbox
(
edit
)
Template:Para
(
edit
)
Template:Strong
(
edit
)
Template:Template link
(
edit
)
Template:Template link expanded
(
edit
)
Template:Terminate sentence
(
edit
)
Template:Var
(
edit
)
Module:Arguments
(
edit
)
Module:Distinguish
(
edit
)
Module:Format link
(
edit
)
Module:Hatnote
(
edit
)
Module:Hatnote/styles.css
(
edit
)
Module:Hatnote list
(
edit
)
Module:High-use
(
edit
)
Module:Message box
(
edit
)
Module:Message box/configuration
(
edit
)
Module:Message box/ombox.css
(
edit
)
Module:TableTools
(
edit
)
Module:Template link general
(
edit
)
Module:Text
(
edit
)
Module:Transclusion count
(
edit
)
Module:Transclusion count/data/D
(
edit
)
Module:Yesno
(
edit
)