Movatterモバイル変換


[0]ホーム

URL:


Jump to content
WikipediaThe Free Encyclopedia
Search

Template:Documentation subpage

Permanently protected template
From Wikipedia, the free encyclopedia
iconThis is adocumentationsubpage forTemplate:Documentation subpage.
It may contain usage information,categories and other content that is not part of the original template page.
Template documentation[view] [edit] [history] [purge]
For use on the subpage itself
Not to be confused withTemplate:Documentation.

This template displays a message that the current page is a documentation subpage.

Usage

{{Documentation subpage}}
or
{{Documentation subpage|[[Page where the documentation istranscluded]]}}

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|text2= can be used to set the text of, respectively, the template's first and second lines. Iftext1 is set but nottext2, both lines' text will derive fromtext1:

Withtext1 andtext2

{{Documentation subpage |text1='''''text1 appears here''''' |text2='''''text2 appears here'''''}}

iconThis is adocumentationsubpage for [page] .
It may contain usage information,categories and other content that is not part of the originaltext2 appears here.
Withtext2 only

{{Documentation subpage |text2='''''text2 appears here'''''}}

iconThis is adocumentationsubpage for [page] .
It may contain usage information,categories and other content that is not part of the originaltext2 appears here.
Withtext1 only

{{Documentation subpage |text1='''''text1 appears here'''''}}

iconThis is adocumentationsubpage for [page] .
It may contain usage information,categories and other content that is not part of the originaltext1 appears here.

Other parameters

Parameter|nocat=true willprevent this template from generating any categories.

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.
    • As a workaround if the documentation page's name doesn't end with '/doc', use|override= to specify the doc subpage's name. For example, if the documentation were at "Template:Example/Documentation", use|override=documentation (must be lower-case to work)
  • 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 istranscluded from a subpage.

Module documentation

This template is automatically shown on /doc subpages in themodule namespace. This is done automatically viaMediaWiki:Scribunto-doc-page-header. Thisfails to add the doc page toCategory:Module documentation pages so some module doc pages transclude the template manually or add the category directly to fix this.

Automatic categorization

In addition to the banner, the template adds pages to categories named after the subject namespace, but only for documentation pages in namespaces with the subpage feature:

It defaults thesort key to the page name without namespace: Template:Foo, for example, would be sorted as "Foo", i.e. under "F".

See also

The abovedocumentation istranscluded fromTemplate:Documentation subpage/doc.(edit |history)
Editors can experiment in this template'ssandbox(edit |diff) andtestcases(edit) pages.
Add categories to the/doc subpage.Subpages of this template.
Retrieved from "https://en.wikipedia.org/w/index.php?title=Template:Documentation_subpage&oldid=1320329438"
Categories:
Hidden categories:

[8]ページ先頭

©2009-2025 Movatter.jp