More actions
Created page with "<noinclude>{{Documentation subpage}}</noinclude> {{Source}} This is a documentation subpage template, used on top of every documentation page. It should be transcluded on all template subpages. == Usage == <code><nowiki>{{Documentation subpage}}</nowiki></code> == See also == Category:Documentation templates <includeonly> <!-- Template categories/interwiki --> Category:Documentation templates </includeonly>" Â |
mNo edit summary  |
||
| (One intermediate revision by the same user not shown) | |||
| Line 1: | Line 1: | ||
{{Documentation subpage}} | |||
== Usage == | |||
: {{Template link expanded|Documentation subpage}} | |||
: or | |||
: {{Template link expanded|Documentation subpage |[[Page where the documentation [[mw:Help:Transclusion|transcluded]]]]}} | |||
== | ===Text customization=== | ||
<code><nowiki>{{Documentation subpage}}</nowiki></code> | The parameters |text1= and |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'': | |||
<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]] -->}}}} | |||
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]] -->}}}} | |||
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]] -->}}}} | |||
== | ===Other parameters=== | ||
[[:Category:Documentation | |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 [[mw:Help:Transclusion|transcluded]] from a subpage. | |||
</includeonly> | == Functions == | ||
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". | |||
<includeonly>[[Category:Notice templates]]</includeonly> | |||
Latest revision as of 15:46, 21 July 2025
 | This is a documentation subpage for Template:Documentation subpage. It contains usage information, categories and other content that is not part of the original page. |
Usage
{{Documentation subpage}}- or
{{Documentation subpage |[[Page where the documentation transcluded]]}}
Text customization
The parameters |text1= and |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 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
{{Documentation}}
Functions
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 sort key to the page name without namespace: Template:Foo, for example, would be sorted as "Foo", i.e. under "F".