Template:Documentation subpage/doc: Difference between revisions
m (+doc subpage template) |
m (inhibit category to stop it from adding Template to category) |
||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
{{Documentation subpage}} | <noinclude>{{Documentation subpage}}</noinclude> | ||
== Usage == | == Usage == | ||
: {{tlx|Documentation subpage}} | : {{tlx|Documentation subpage}} | ||
| Line 10: | Line 10: | ||
<code><nowiki>{{Documentation subpage |text1='''''text1 appears here''''' |text2='''''text2 appears here'''''}}</nowiki></code> | <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]] -->}}}} | {{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]] -->}}|inhibit=yes}} | ||
<code><nowiki>{{Documentation subpage |text2='''''text2 appears here'''''}}</nowiki></code> | <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]] -->}}}} | {{Documentation subpage |[''page''] |text2='''''text2 appears here''''' |override={{lc:{{SUBPAGENAME}}<!-- Hack to allow example to appear, even when viewed from [[Template:Documentation subpage]] -->}}|inhibit=yes}} | ||
<code><nowiki>{{Documentation subpage |text1='''''text1 appears here'''''}}</nowiki></code> | <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]] -->}}}} | {{Documentation subpage |[''page''] |text1='''''text1 appears here''''' |override={{lc:{{SUBPAGENAME}}<!-- Hack to allow example to appear, even when viewed from [[Template:Documentation subpage]] -->}}|inhibit=yes}} | ||
Revision as of 16:03, 11 June 2023
|
This is a documentation subpage for Template:Documentation subpage.
It contains usage information and other content that is not part of the original template page. |
Usage
{{Documentation subpage}}- or
{{Documentation subpage |[[Page where the documentation 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:
{{Documentation subpage |text1='''''text1 appears here''''' |text2='''''text2 appears here'''''}}
|
|
This is a documentation subpage for [page] .
It contains usage information and other content that is not part of the original text2 appears here. |
{{Documentation subpage |text2='''''text2 appears here'''''}}
|
|
This is a documentation subpage for [page] .
It contains usage information and other content that is not part of the original text2 appears here. |
{{Documentation subpage |text1='''''text1 appears here'''''}}
|
|
This is a documentation subpage for [page] .
It contains usage information and other content that is not part of the original text1 appears here. |
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 will automatically note that the documentation is transcluded from a subpage.