Template:Documentation subpage/doc

From PZwiki
< Template:Documentation subpage
Revision as of 11:30, 16 May 2018 by Vaileasys (talk | contribs) (Doc for Template:Documentation subpage)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

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