Template:Documentation subpage: Difference between revisions

From TestWiki
Content added Content deleted
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"
<center>
| style="vertical-align: top; padding: 1em" | [[Image:Edit-paste.svg|40px]]
{| class="messagebox" style="width:80%; border:1px solid #c0c090; background:#f8eaba; margin:2px 4px 2px 4px;"
| This is the [[Wikipedia:Template doc page pattern|template documentation page]] {{{1|for [[{{NAMESPACE}}:{{BASEPAGENAME}}]].}}}
|- style="vertical-align:top;"
|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) {{-}}
----
----
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.
{{interwikitmp-grp|inhib=yes|SYS=yes|V=0}}
|}

----
== See also ==
<includeonly>[[Category:Template documentation|{{PAGENAME}}]]</includeonly><noinclude>
* [[M:Meta:Template doc page pattern]] or [[W:Wikipedia:Template doc page pattern]] for how this template is used.
{{{{FULLPAGENAME}}/doc}}
* Related templates:
<!-- Add categories and interwikis to the /doc subpage, not here! -->
# {{tlw| Template doc page transcluded}} (as redirect: ''{{tlw|Template doc page pattern}}'')
# {{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

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.


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.


This template displays a message that the current page is a documentation subpage.

Usage

{{Documentation subpage}}
or
{{Documentation subpage|[[Page where the documentation transcluded]]}}



[examples needed]

Userbox documentation

To set this template to use "userbox" and "userbox page" rather than "template" and "template page" or "user template" and "user template page", use:

{{Userbox documentation subpage}}
or
{{Userbox documentation subpage|[[userbox page]]}}

Text customization

The parameters |text1= and |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:

With text1 and text2

{{Documentation subpage |text1='''''text1 appears here''''' |text2='''''text2 appears here'''''}}

This is the template documentation page [page]

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.


With text2 only

{{Documentation subpage |text2='''''text2 appears here'''''}}

This is the template documentation page [page]

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.


With text1 only

{{Documentation subpage |text1='''''text1 appears here'''''}}

This is the template documentation page [page]

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.


Other parameters

|inhibit=yes will prevent this template from generating any categories. (By default, "Namespace documentation pages" (usually Category:Template documentation pages) is added, or Category:Documentation subpages without corresponding pages if the main page doesn't exist.)

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 (which contains {{Documentation}}) will automatically note that the documentation is transcluded from a subpage.

Functions

In addition to its message, the template adds pages to Category:Template documentation pages, Category:User documentation pages, or similar (named after the subject space), but only for documentation pages in namespaces with the subpage feature. It defaults the sort key to the page name without namespace: Template:Foo, for example, would be sorted as "Foo", i.e. under "F".

See also