Template:Documentation subpage/doc: Difference between revisions
mNo edit summary |
mNo edit summary |
||
Line 1: | Line 1: | ||
{{ | {{Documentation subpage}} | ||
{{Support|Template:Mbox}} | |||
__NOTOC__ | |||
This template displays a message that the current page is a documentation subpage. | This template displays a message that the current page is a documentation subpage. | ||
== Usage == | == Usage == | ||
: | : {{tlc|Documentation subpage}} | ||
: or | |||
: {{tlc|Documentation subpage|[[Page where the documentation is transcluded]]}} | |||
===Text customization=== | === Text customization === | ||
The parameters | 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'': | ||
===Other parameters=== | With {{para|text1}} and {{para|text2}}: | ||
{{tlc|Documentation subpage |text1{{=}}'''''text1 appears here''''' |text2{{=}}'''''text2 appears here'''''}} | |||
{{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]] -->}}}} | |||
With {{para|text2}} only: | |||
{{tlc|Documentation subpage |text2{{=}}'''''text2 appears here'''''}} | |||
{{Documentation subpage |[''page''] |text2='''''text2 appears here''''' |override={{lc:{{SUBPAGENAME}}<!-- Hack to allow example to appear, even when viewed from [[Template:Documentation subpage]] -->}}}} | |||
With {{para|text1}} only: | |||
{{tlc|Documentation subpage |text1{{=}}'''''text1 appears here'''''}} | |||
{{Documentation subpage |[''page''] |text1='''''text1 appears here''''' |override={{lc:{{SUBPAGENAME}}<!-- Hack to allow example to appear, even when viewed from [[Template:Documentation subpage]] -->}}}} | |||
=== Other parameters === | |||
{{para|inhibit|yes}} will prevent this template from generating any categories. (By default, "''Namespace'' documentation pages" (usually {{c|Template documentation pages}}) is added, or {{c|Documentation subpages without corresponding pages}} if the main page doesn't exist.) | |||
== Display == | == Display == | ||
This template should normally be placed at the top of /doc pages. It changes output depending on where it is viewed: | 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 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 | * On other pages – i.e. pages transcluding the /doc page – the template will not show. The template page itself (which contains {{tlc|Documentation}}) will automatically note that the documentation is [[Wikipedia: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 {{c|Template documentation pages}}, {{c|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". | |||
<includeonly>{{sandbox other||{{testcases other|| | |||
<!-- Categories below this line, please --> | <!-- Categories below this line, please --> | ||
[[Category:Templates]] | [[Category:Templates]] | ||
</includeonly> | [[Category:Utility Templates]] | ||
}}}}</includeonly> |
Revision as of 05:13, 14 June 2023
It contains usage information, categories and other content that is not part of the original template page.
|
Supporting Templates |
This template displays a message that the current page is a documentation subpage.
Usage
{{Documentation subpage}}
- or
{{Documentation subpage|Page where the documentation is transcluded}}
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=text1 appears here|text2=text2 appears here}}
This is a documentation subpage for [page] .
It contains usage information, categories and other content that is not part of the original text2 appears here.
|
With |text2=
only:
{{Documentation subpage|text2=text2 appears here}}
This is a documentation subpage for [page] .
It contains usage information, categories and other content that is not part of the original text2 appears here.
|
With |text1=
only:
{{Documentation subpage|text1=text1 appears here}}
This is a documentation subpage for [page] .
It contains usage information, categories and other content that is not part of the original text1 appears here.
|
Other parameters
|inhibit=yes
will prevent this template from generating any categories. (By default, "Namespace documentation pages" (usually Template documentation pages) is added, or 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
{{Documentation}}
) will automatically note that the documentation is transcluded from a subpage.
Module documentation
This template is automatically shown on /doc subpages in the module namespace. This is done automatically via MediaWiki:Scribunto-doc-page-header.
Automatic categorization
In addition to its message, the template adds pages to Template documentation pages, 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".