Difference between revisions of "Template:Documentation subpage"
From SVR Wiki
m ({{pp-semi-template|small=yes}}) |
(simplify formatting, and this - of all templates - might as well have documentation in a subpage if only to illustrate how the template is meant to work) |
||
Line 1: | Line 1: | ||
− | + | {| class="messagebox standard-talk" | |
− | {| class="messagebox | + | | style="vertical-align: top; padding: 1em" | [[Image:Edit-paste.svg|40px]] |
− | | | + | | This is the [[Wikipedia:Template doc page pattern|template documentation page]] {{{1|for [[{{NAMESPACE}}:{{BASEPAGENAME}}]].}}} |
− | |||
− | | | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
---- | ---- | ||
− | + | This page is not necessarily intended to be viewed directly. If it uses [[Help:Variable|variable]]s, some links may appear broken. Do not replace these variables with [[hardcoded]] page names or URLs. | |
− | + | |} | |
− | + | ---- | |
− | + | <includeonly>[[Category:Template documentation|{{PAGENAME}}]]</includeonly><noinclude> | |
− | + | {{{{FULLPAGENAME}}/doc}} | |
− | + | <!-- Add categories and interwikis to the /doc subpage, not here! --> | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | [[Category:Template documentation | | ||
− | |||
− | |||
− | <!-- | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
</noinclude> | </noinclude> |
Revision as of 06:44, 7 May 2007
Usage
{{documentation subpage}}
OR
{{documentation subpage|[[main page to link to]]}}
Customization of text
To manually change the text of the template, the "text1=your text here
" and/or "text2=your other text here
" parameters can be specified. "text1=
" changes the automatic text on the first line to your own word(s). "text2=
" changes the automatic text on the second line to your own word(s). If "text1=
" parameter is specified without the "text2=
" parameter, both the first and second line of text will be custom based on the text given in the "text1=
" parameter.
Example usage:
{{documentation subpage|text1=custom first and second line text}}
{{documentation subpage|text2=custom second line text only}}
{{documentation subpage|text1=custom first line text|text2=custom second line text}}
How it is displayed
This template should 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 (ie, 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.