Difference between revisions of "Template:Documentation subpage"

From SVR Wiki
Jump to: navigation, search
m (link)
m (this line isn't really necessary)
Line 3: Line 3:
 
| This is the [[Wikipedia:Template documentation|template documentation]] page {{{1|for [[{{NAMESPACE}}:{{BASEPAGENAME}}]].}}}<br/><span style="font-size: 88%">This page is not intended to be viewed directly. Links using [[Help:Variable|variable]]s may appear broken; do not replace these with [[hardcoded]] page names or URLs.</span>
 
| This is the [[Wikipedia:Template documentation|template documentation]] page {{{1|for [[{{NAMESPACE}}:{{BASEPAGENAME}}]].}}}<br/><span style="font-size: 88%">This page is not intended to be viewed directly. Links using [[Help:Variable|variable]]s may appear broken; do not replace these with [[hardcoded]] page names or URLs.</span>
 
|}
 
|}
----
 
 
<includeonly>[[Category:Template documentation|{{PAGENAME}}]]</includeonly><noinclude>
 
<includeonly>[[Category:Template documentation|{{PAGENAME}}]]</includeonly><noinclude>
 
{{{{FULLPAGENAME}}/doc}}
 
{{{{FULLPAGENAME}}/doc}}
 
<!-- Add categories and interwikis to the /doc subpage, not here! -->
 
<!-- Add categories and interwikis to the /doc subpage, not here! -->
 
</noinclude>
 
</noinclude>

Revision as of 11:51, 8 May 2007

Edit-paste.svg This is the template documentation page for Template:Documentation subpage.
This page is not intended to be viewed directly. Links using variables may appear broken; do not replace these with hardcoded page names or URLs.


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.