Difference between revisions of "Template:Documentation subpage"

From SVR Wiki
Jump to: navigation, search
(change category, per proposal on Template talk:Documentation)
m (only rename for template space for now)
Line 16: Line 16:
 
       | {{SUBJECTSPACE}}
 
       | {{SUBJECTSPACE}}
 
       | Article
 
       | Article
     }} documentation pages]]</includeonly>
+
     }} documentation {{ifeq:{{SUBJECTSPACE}}|Template|pages}}]]</includeonly>
 
   }}<includeonly>
 
   }}<includeonly>
 
| <!-- if not on a /doc subpage, do nothing -->
 
| <!-- if not on a /doc subpage, do nothing -->

Revision as of 16:37, 25 February 2011

Documentation icon Template documentation[view] [edit] [history] [purge]

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.