Template:Documentation subpage: Difference between revisions

From PZwiki
(deprecated)
m (Automated {{Languages}} removal.)
(2 intermediate revisions by 2 users not shown)
Line 1: Line 1:
<noinclude>{{Languages}}</noinclude><includeonly>{{#ifeq: {{lc:{{SUBPAGENAME}}}} | {{{override|doc}}}
<noinclude></noinclude><includeonly>{{#ifeq: {{lc:{{SUBPAGENAME}}}} | {{{override|doc}}}
   | <!-- doc page -->
   | <!-- doc page -->
{{#ifeq: {{{doc-notice|show}}} | show
{{#ifeq: {{{doc-notice|show}}} | show
Line 21: Line 21:
| <!-- if not on a /doc subpage, do nothing -->
| <!-- if not on a /doc subpage, do nothing -->
}}</includeonly><noinclude>
}}</includeonly><noinclude>
{{Deprecated template}}
{{Deprecated}}
{{documentation}}
{{documentation}}
[[Category:Mbox templates]]
[[Category:Mbox]]
</noinclude>
</noinclude>

Revision as of 14:15, 3 March 2024

Imbox content.png
This template is deprecated.
This template will eventually be removed.
[view] [edit] [history] [purge] Template documentation


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'''''}}

Notebook.png
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'''''}}

Notebook.png
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'''''}}

Notebook.png
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.

See also

Documentation transcluded from Template:Documentation subpage/doc.
Editors can experiment in this template's sandbox (create)