Difference between revisions of "Template:Documentation subpage"

From SVR Wiki
Jump to: navigation, search
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:
<center>
+
{| class="messagebox standard-talk"
{| class="messagebox" style="width:80%; border:1px solid #c0c090; background:#f8eaba; margin:2px 4px 2px 4px;"
+
| style="vertical-align: top; padding: 1em" | [[Image:Edit-paste.svg|40px]]
|- style="vertical-align:top;"
+
| This is the [[Wikipedia:Template doc page pattern|template documentation page]] {{{1|for [[{{NAMESPACE}}:{{BASEPAGENAME}}]].}}}
|align="center" style="width:60px; padding:1ex;"| [[Image:Edit-paste.svg|none|40px]]
 
| '''This is the [[Wikipedia:Template doc page pattern|template documentation page]] {{#if:{{{1|}}}|{{{1}}}|for [[{{NAMESPACE}}:{{BASEPAGENAME}}]].}}'''<br/><hr/>This page is not necessarily intended to be viewed directly. If it uses [[w:Help:Variable|variable]]s, some links may appear broken. Do not replace these variables with [[w:Hardcoded|hardcoded]] page names or URLs.
 
|}<br/><hr/>
 
</center>
 
<includeonly>[[Category:Template documentation|{{PAGENAME}}]]</includeonly><!--
 
 
 
--><noinclude>
 
<center><small>''[[Template:Template doc page viewed directly]] template ends''</small></center>
 
;Note: This template will take an alternative parameter <nowiki>{{{1}}}</nowiki> when it is applied as a X/doc style warning in a common usage page for several utility templates. (Such as are normally related by function or application and frequently list one another as ''see also'' pages.)
 
 
 
<br/><br/>Ver: fix up interwiki issues, class mesagebox 'standard-talk' not so standard, make links interwiki.// <b>[[User:Fabartus|Fra]]</b><font color="green">[[User talk:Fabartus|nkB]]</font> 21:47, 23 February 2007 (UTC)
 
 
 
Org: Commons, IWTG perams adusts, (mn) <B>[[User:Fabartus|Fra]]</B><font color="green">[[User talk:Fabartus|nkB]]</font> 18:44, 12 February 2007 (UTC) {{-}}
 
 
----
 
----
{{interwikitmp-grp|inhib=yes|SYS=yes|V=0}}
+
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.
 
+
|}
== See also ==
+
----
* [[M:Meta:Template doc page pattern]] or [[W:Wikipedia:Template doc page pattern]] for how this template is used.
+
<includeonly>[[Category:Template documentation|{{PAGENAME}}]]</includeonly><noinclude>
* Related templates:
+
{{{{FULLPAGENAME}}/doc}}
# {{tlw| Template doc page transcluded}} (as redirect: ''{{tlw|Template doc page pattern}}'')
+
<!-- Add categories and interwikis to the /doc subpage, not here! -->
# {{tlw| Interwiki doc page pattern}}
 
 
 
 
 
 
 
<!--Categories-->
 
[[Category:Template documentation |!{{PAGENAME}}]]
 
[[Category:Template namespace templates|{{PAGENAME}}]]
 
 
 
<!--Interwiki's in Other languages-->{{-}}
 
[[ja:Template:テンプレート文書直接表示]]
 
[[pl:Szablon:Dokumentacja szablonu oglądana bezpośrednio]]
 
[[sl:Predloga:Neposredno prikazana dokumentacijska stran predloge]]
 
[[uk:Шаблон:Документація шаблона (безпосередня)]]
 
[[zh:Template:Template doc page viewed directly]]
 
 
 
{{pp-semi-template|small=yes}}
 
 
</noinclude>
 
</noinclude>

Revision as of 06:44, 7 May 2007

Edit-paste.svg This is the template documentation page for Template:Documentation subpage.

This page is not necessarily intended to be viewed directly. If it uses variables, some links may appear broken. Do not replace these variables 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.