Template:Documentation: Difference between revisions
(Created page with '<div class="template-documentation"><!-- These are the literal class definitions in common.css: →For template documentation: .template-documentation { clear: both; …') |
No edit summary |
||
| Line 25: | Line 25: | ||
--><div id="template_doc_page_transcluded" class="dablink plainlinks"><!-- | --><div id="template_doc_page_transcluded" class="dablink plainlinks"><!-- | ||
-->{{#ifexist: {{{1|{{Documentation/docname}}}}} | -->{{#ifexist: {{{1|{{Documentation/docname}}}}} | ||
|<!--**/doc EXISTS**-->This [[ | |<!--**/doc EXISTS**-->This [[Lockwiki:Template documentation|documentation]] is 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 /> | ||
}}<!-- | }}<!-- | ||
Revision as of 17:38, 24 June 2009
Template documentationThis 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 /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.
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
