Difference between revisions of "Template:Documentation"
From Arkaz
| Line 1: | Line 1: | ||
| − | <div class="template-documentation" | + | <div class="template-documentation"><!-- |
| − | <span class="editsection plainlinks" id="doc_editlinks">[[{{fullurl:{{{1|{{ | + | |
| − | <span style="font-size: 150%">{{{heading|Documentation}}}</span></div>}} | + | These are the literal class definitions in common.css: |
| − | <div id="template_doc_page_transcluded" class="dablink plainlinks">This [[Wikipedia:Template documentation|documentation]] is [[Wikipedia:Transclusion|transcluded]] from [[{{{1|{{ | + | |
| + | /* For template documentation */ | ||
| + | .template-documentation { | ||
| + | clear: both; | ||
| + | margin: 1em 0 0 0; | ||
| + | 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 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> | ||
| + | }}<!-- | ||
| + | |||
| + | --><div id="template_doc_page_transcluded" class="dablink plainlinks"><!-- | ||
| + | -->{{#ifexist: {{{1|{{Documentation/docname}}}}} | ||
| + | |<!--**/doc EXISTS**-->This [[Wikipedia:Template documentation|documentation]] is [[Wikipedia:Transclusion|transcluded]] from [[{{{1|{{Documentation/docname}}}}}]]. <small style="font-style: normal">([{{fullurl:{{{1|{{Documentation/docname}}}}}|action=edit}} edit] | [{{fullurl:{{{1|{{Documentation/docname}}}}}|action=history}} history])</small><br /> | ||
| + | }}<!-- | ||
| + | |||
| + | -->{{#switch: {{SUBPAGENAME}} | ||
| + | |sandbox|testcases=<!--**DO NOT SHOW THESE LINKS ON THE SANDBOX/TESTCASES PAGES**--> | ||
| + | |#default= | ||
| + | {{#switch: {{SUBJECTSPACE}} | ||
| + | |{{ns:template}} | ||
| + | |{{ns:user}}= | ||
| + | {{#ifexist: {{FULLPAGENAME}}/sandbox | ||
| + | |This template has a [[/sandbox|sandbox]] <small style="font-style: normal">([{{fullurl:{{ #rel2abs: /sandbox }}|action=edit}} edit])</small> <!-- | ||
| + | -->{{#ifexist: {{FULLPAGENAME}}/testcases | ||
| + | |and [[/testcases|testcases]] <small style="font-style: normal">([{{fullurl:{{ #rel2abs: /testcases }}|action=edit}} edit])</small>}} for editors to experiment. | ||
| + | |{{#ifexist: {{FULLPAGENAME}}/testcases | ||
| + | |This template has [[/testcases|testcases]] <small style="font-style: normal">([{{fullurl:{{ #rel2abs: /testcases }}|action=edit}} edit])</small> for editors to experiment.}} | ||
| + | }}}}}} | ||
| + | </div> | ||
| + | {{#if:{{{content|}}}|{{{content}}}|{{#ifexist:{{{1|{{Documentation/docname}}}}} | {{ {{{1|{{Documentation/docname}}}}} }} }}}} | ||
| + | <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 10:40, 9 March 2009
|
This template employs intricate features of template syntax. You are encouraged to familiarise yourself with its setup and parser functions before editing the template. If your edit causes unexpected problems, please undo it quickly, as this template may appear on a large number of pages. Remember that you can conduct experiments, and should test all improvements, in either the general Template sandbox or your user space before changing anything here.
|
 |
It has been suggested that this page or section be merged with Template:Template doc. (Discuss) |
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.
Usage
Normal
<noinclude>{{documentation}}</noinclude>
or <noinclude>{{documentation|template:any page/doc}}</noinclude>
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.
Add categories and interwiki links to the documentation page inside includeonly tags.
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
This template allows any page to use any documentation page, and makes it possible to protect templates while allowing anyone to edit the template's documentation, categories, and interwiki links. It also reduces server resources by circumventing a technical limitation of templates (see a developer's explanation).
See also
- Template:template doc (backlinks, edit) (similar template with more documentation; see template comparison)
- Template:documentation subpage (backlinks, edit) (replaces older {{Template doc page viewed directly}} and {{Template doc page transcluded}})
- m:Template:Documentation (backlinks, edit)
