Difference between revisions of "Template:Documentation"
(New page: <div class="template-documentation"><!-- These are the literal class definitions in common.css: →For template documentation: .template-documentation { clear: both; margin: 1...) |
|||
| Line 1: | Line 1: | ||
| − | <div class="template-documentation"><!-- | + | <div class="template-documentation" style="margin-top:1em;"><!-- |
| − | + | -->{{#if:{{{heading|defaultnotblank}}}|<!-- | |
| − | + | --><div style="padding-bottom:3px; border-bottom:1px solid #aaa; margin-bottom:1ex;"><!-- | |
| − | + | --><span class="editsection plainlinks"><!-- | |
| − | + | -->[[{{fullurl:{{{1|{{SUBJECTPAGENAME}}/doc}}}|<!-- | |
| − | + | -->action=edit{{#ifexist: {{{1|{{SUBJECTSPACE}}:{{SUBJECTPAGENAME}}/doc}}} |<!-- | |
| − | + | nothing | |
| − | + | -->|<!--else--><!-- | |
| − | + | -->&preload=Template:Documentation/preload<!-- | |
| − | + | -->}}<!-- | |
| − | + | -->}} edit]]</span><!-- | |
| − | + | --><span style="font-size: 150%">{{{heading|Documentation}}}</span><!-- | |
| − | + | --></div><!-- | |
| − | + | -->}} | |
| − | + | <div id="template_doc_page_transcluded" class="dablink plainlinks">''This [[Wikipedia:Template documentation|documentation]] is [[Wikipedia:Transclusion|transcluded]] from [[{{{1|{{FULLPAGENAME}}/doc}}}]].'' <small>(<!-- | |
| − | + | -->[[{{{1|{{SUBJECTPAGENAME}}/doc}}}|view]] | <!-- | |
| − | + | -->[{{fullurl:{{{1|{{SUBJECTPAGENAME}}/doc}}}|<!-- | |
| − | + | -->action=edit<!-- | |
| − | + | -->{{#ifexist: {{{1|{{SUBJECTSPACE}}:{{SUBJECTPAGENAME}}/doc}}} |<!-- | |
| − | + | nothing | |
| − | }}</span> | + | -->|<!--else--><!-- |
| − | + | -->&preload=Template:Documentation/preload<!-- | |
| − | + | -->}}<!-- | |
| − | + | -->}} edit] | <!-- | |
| − | + | -->[{{fullurl:{{{1|{{SUBJECTPAGENAME}}/doc}}}|action=history}} history]<!-- | |
| − | + | -->)</small> {{#ifexist: {{#rel2abs: /sandbox }} | <!-- | |
| − | + | -->{{#ifexist: {{#rel2abs: /testcases}} | <!-- | |
| − | + | --><br> ''This template has a [[{{FULLPAGENAME}}/sandbox|sandbox]]'' <small>([{{fullurl:{{FULLPAGENAME}}/sandbox|action=edit}} edit])</small> ''and [[{{FULLPAGENAME}}/testcases|testcases]] for editors to experiment.''<!-- | |
| − | + | -->}}<!-- else don't show when just 1 of /sandbox or /testcases exists --><!-- | |
| − | + | -->}} </div>{{<!-- -->{{{1|{{SUBJECTPAGENAME}}/doc}}}<!-- -->}} <div style="clear:both;" /></div></div> | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | {{ | ||
| − | </div> | ||
Revision as of 11:36, 2 September 2008
- Note: Since on mw: the subpage feature is off in the template namespace there are complications.
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:Tiw (similar template with more documentation; see template comparison)
- Template:Tiw (replaces older {{Template doc page viewed directly}} and {{Template doc page transcluded}})
- Template:Tim
See also
es:Plantilla:Uso de plantilla fr:Modèle:Documentation modèle hsb:Předłoha:Doc hu:Sablon:Sablondokumentáció ko:틀:틀 설명문서 nl:Sjabloon:Sjabdoc ru:Шаблон:Doc sl:Predloga:Dokumentacija uk:Шаблон:Doc zh:Template:Template doc
<div style="clear:both;" />
