Difference between revisions of "Template:Documentation"
m (1 revision) |
m (1 revision) |
||
| Line 1: | Line 1: | ||
< | <div class="template-documentation"><!-- | ||
These are the literal class definitions in common.css: | |||
-->{{#ifeq:{{{heading|μ}}}|<!--**DEFINED BUT EMPTY**-->|<!--**NOTHING**--> | |||
/* For template documentation */ | |||
|<span class="editsection plainlinks" id="doc_editlinks" | .template-documentation { | ||
clear: both; | |||
|<!--** /doc EXISTS** -->[{{fullurl:{{{1|{{Documentation/docname}}}}}|action=edit}} edit]] | margin: 1em 0 0 0; | ||
|<!--**/doc DOESN'T EXIST**-->[{{fullurl:{{{1|{{Documentation/docname }}}}}|action=edit&preload=Template:Documentation/preload}} create] | border: 1px solid #aaa; | ||
background-color: #ecfcf4; | |||
padding: 5px; | |||
} | |||
-->{{#ifeq:{{{heading|μ}}}|<!--**DEFINED BUT EMPTY**--> | |||
|<!--**NOTHING**--> | |||
|<div style="padding-bottom:3px; border-bottom: 1px solid #aaa; margin-bottom:1ex">{{#ifeq:{{{content|μ}}}|μ | |||
|<span class="editsection plainlinks" id="doc_editlinks">{{#ifexist: {{{1|{{Documentation/docname}}}}} | |||
|<!--** /doc EXISTS** -->[[{{fullurl:{{{1|{{Documentation/docname}}}}}|action=edit}} edit]] | |||
|<!--**/doc DOESN'T EXIST**-->[[{{fullurl:{{{1|{{Documentation/docname }}}}}|action=edit&preload=Template:Documentation/preload}} create]] | |||
}}</span> | }}</span> | ||
}} <span style="{{#if:{{{heading-style|}}}|{{{heading-style}}}|{{#ifeq:{{NAMESPACE}}|{{ns:template}}|font-weight: bold; font-size: 125%|font-size: 150%}}}}">{{#if:{{{heading|}}}|{{{heading}}}|{{#ifeq:{{NAMESPACE}}|{{ns:template}}|[[Image:Template-info.svg|50px]] Template documentation|Documentation}}}}</span></div> | }} <span style="{{#if:{{{heading-style|}}}|{{{heading-style}}}|{{#ifeq:{{NAMESPACE}}|{{ns:template}}|font-weight: bold; font-size: 125%|font-size: 150%}}}}">{{#if:{{{heading|}}}|{{{heading}}}|{{#ifeq:{{NAMESPACE}}|{{ns:template}}|[[Image:Template-info.svg|50px]] Template documentation|Documentation}}}}</span></div> | ||
| Line 24: | Line 32: | ||
|#default= | |#default= | ||
{{#switch: {{SUBJECTSPACE}} | {{#switch: {{SUBJECTSPACE}} | ||
| {{ns:template}} | |{{ns:template}} | ||
| {{ns:user}}= | |{{ns:user}}= | ||
{{#ifexist: {{FULLPAGENAME}}/sandbox | {{#ifexist: {{FULLPAGENAME}}/sandbox | ||
|This template has a [[/sandbox|sandbox]] <small style="font-style: normal">([{{fullurl:{{ #rel2abs: /sandbox }}|action=edit}} edit])</small> <!-- | |||
{{#ifexist: {{FULLPAGENAME}}/testcases | -->{{#ifexist: {{FULLPAGENAME}}/testcases | ||
|and [[/testcases|testcases]] <small style="font-style: normal">([{{fullurl:{{ #rel2abs: /testcases }}|action=edit}} edit])</small>}} for editors to experiment. | |and [[/testcases|testcases]] <small style="font-style: normal">([{{fullurl:{{ #rel2abs: /testcases }}|action=edit}} edit])</small>}} for editors to experiment. | ||
|{{#ifexist: {{FULLPAGENAME}}/testcases | |{{#ifexist: {{FULLPAGENAME}}/testcases | ||
| Line 35: | Line 43: | ||
</div> | </div> | ||
{{#if:{{{content|}}}|{{{content}}}|{{#ifexist:{{{1|{{Documentation/docname}}}}} | {{ {{{1|{{Documentation/docname}}}}} }} }}}} | {{#if:{{{content|}}}|{{{content}}}|{{#ifexist:{{{1|{{Documentation/docname}}}}} | {{ {{{1|{{Documentation/docname}}}}} }} }}}} | ||
</div> | <div style="clear: both;"></div> | ||
</div><noinclude> | |||
{{pp-template|small=yes}} | |||
<!-- Add categories and interwikis to the /doc subpage, not here! --> | |||
</noinclude> | |||
Latest revision as of 14:55, 3 February 2009
Template documentationThis template has a sandbox (edit) and testcases (edit) for editors to experiment.
This template automatically displays a documentation box like you are seeing now, of which the content is transcluded from another page. It is intended for pages which are transcluded in other pages, i.e. templates, whether in the template namespace or not.
| Accessibility | The accessibility of this article or template is in question. For specifics, please see the relevant discussion on the talk page. Information on making articles more accessible can be found at Wikiproject Accessibility. |
Usage
Normal /doc
<noinclude>{{Documentation}}</noinclude>
Any /doc page
<noinclude>{{Documentation|Template:any page/doc}}</noinclude>
In-line content
<noinclude>{{Documentation|content=This is documentation.}}</noinclude>
In-line content with [view][edit] links
<noinclude>{{Documentation
|1 = Template:any page/doc
|content ={{Template:any page/doc|parameters}}
}}</noinclude>
Best practice
This code should be added at the bottom of the template code, with no extra space before "<noinclude>" (which would cause extra space on pages where the template is used). The parameter can be used as shown above to transclude an arbitrary documentation page.
Categories and interwiki links that apply to the template itself should be added to the documentation page, inside <includeonly> </includeonly> tags. For more complex cases, see Wikipedia:Template documentation#Categories and interwiki links.
If the documentation page contains includeonly or noinclude tags as part of the documentation, replace the "<" with "<".
Customizing display
Overrides exist to customize the output in special cases:
{{documentation| heading = ...}}− change the text of the "documentation" heading. If this is set to blank, the entire heading line (including the first [edit] link) will also disappear.
Functions
If the documentation page doesn't exist, the "edit" link includes a preload parameter so that clicking it will pre-fill the edit form with the basic documentation page format.
Rationale
Use of this template allows templates to be protected where necessary, while allowing anyone to edit the documentation, categories, and interwiki links.
See also
General information about documentation for templates
{{ Documentation }} family
- Template:Documentation/doc (backlinks, edit)
- Template:Documentation/doc/see also (backlinks, edit)
- Template:Documentation/docname (backlinks, edit)
- Template:Documentation/preload (backlinks, edit)
- Template:Documentation/preload/testcases (backlinks, edit)
- Template:Documentation/preload/infobox testcases (backlinks, edit)
- Template:Documentation/sandbox (backlinks, edit)
- Template:Documentation/testcases (backlinks, edit)
- Template:Documentation/testcases/test1 (backlinks, edit)
- Template:Documentation/testcases/test2 (backlinks, edit)
Meta Wiki {{ Documentation }} ancestor
- m:Template:Documentation (backlinks, edit)
ar:قالب:توثيق bg:Шаблон:Документация ca:Plantilla:Ús de la plantilla cs:Šablona:Dokumentace da:Skabelon:Dokumentation de:Vorlage:Dokumentation dsb:Pśedłoga:Dokumentacija et:Mall:Usage of template es:Plantilla:Documentación de plantilla eo:Ŝablono:Dok fa:الگو:توضیحات fr:Modèle:Documentation modèle gl:Template:Uso de plantilla hsb:Předłoha:Doc hu:Sablon:Sablondokumentáció ia:Patrono:Docpatrono id:Templat:Dokumentasi it:Template:Man ja:Template:Documentation ko:틀:틀 설명문서 no:mal:Dokumentasjon nl:Sjabloon:Sjabdoc pl:Szablon:Dokumentacja pt:Predefinição:Instruções da predefinição ro:Format:Documentaţie ru:Шаблон:Doc sl:Predloga:Dokumentacija sq:Stampa:Dokumentacion sv:Mall:Dokumentation tl:Template:Documantation tpi:Template:Template doc uk:Шаблон:Документація zh:Template:Documentation
- Pages with broken file links
- Articles with accessibility problems
- Template documentation
- Wikipedia formatting and function templates
- Protected templates