Difference between revisions of "Template:Documentation"
m (Replacing SVG icon by PNG, because SVG support is broken on the SL Wiki) |
(Change background colour to #e5f8ff, which is the lightest possible tint to the main colour for the current SL logo) |
||
| (4 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
<div style="clear:both;margin:1em 0;border:1px solid #AAA;background:# | <div style="clear:both;margin:1em 0;border:1px solid #AAA;background:#e5f8ff;padding:.5em">{{#ifeq:{{{heading|1}}}|{{{heading|}}}<!--**DEFINED BUT EMPTY**--> | ||
|<!--**NOTHING**--> | |<!--**NOTHING**--> | ||
|<div style="padding-bottom:3px;border-bottom:1px solid #aaa;margin-bottom:1ex">{{#ifeq:{{{content|1}}}|{{{content|}}}<!--**DEFINED BUT EMPTY**--> | |<div style="padding-bottom:3px;border-bottom:1px solid #aaa;margin-bottom:1ex">{{#ifeq:{{{content|1}}}|{{{content|}}}<!--**DEFINED BUT EMPTY**--> | ||
| Line 7: | Line 7: | ||
|<!--**/doc DOESN'T EXIST**-->[[{{fullurl:{{{1|{{Documentation/docname}}}}}|action=edit&preload=Template:Documentation/preload}} {{int:Create}}]] | |<!--**/doc DOESN'T EXIST**-->[[{{fullurl:{{{1|{{Documentation/docname}}}}}|action=edit&preload=Template:Documentation/preload}} {{int: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}}| | }} <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.png|50px|link=]] Template documentation|Documentation}}}}</span></div> | ||
}}<!-- | }}<!-- | ||
| Line 13: | Line 13: | ||
-->{{#ifexist:{{{1|{{Documentation/docname}}}}} | -->{{#ifexist:{{{1|{{Documentation/docname}}}}} | ||
|<!--**/doc EXISTS**-->This [[Template:Documentation|documentation]] is | |<!--**/doc EXISTS**-->This [[Template:Documentation|documentation]] is {{Wikipedia|Transclusion|transcluded}} from [[{{{1|{{Documentation/docname}}}}}]]. <small style="font-style:small">([{{fullurl:{{{1|{{Documentation/docname}}}}}|action=edit}} {{int:Edit}}] | [{{fullurl:{{{1|{{Documentation/docname}}}}}|action=history}} history])<br />'''''Note to editors:''' Please don't categorize this template by editing it directly. Instead, place the category in its documentation page, in its "includeonly" section.''</small><br /><!-- | ||
-->}}<!-- | -->}}<!-- | ||
Latest revision as of 12:09, 15 September 2022
Template documentation
transcluded from Template:Documentation/doc. (Edit | history)Note to editors: Please don't categorize this template by editing it directly. Instead, place the category in its documentation page, in its "includeonly" section.
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
- In-line content without [view][edit] links
<noinclude>{{Documentation| content = This is documentation. }}</noinclude>
- Normal /doc with [view][edit] links
<noinclude>{{Documentation}}</noinclude>
- Any /doc page
<noinclude>{{Documentation|Template:any page/doc}}</noinclude>
- Any /doc page with optional parameters
<noinclude>{{Documentation|Template:any page/doc|parameter1|parameter2|parameter3}}</noinclude><noinclude>{{Documentation|Template:any page/doc
| p1 = paramname1 | v1 = paramvalue1
| p2 = paramname2 | v2 = paramvalue2
| p3 = paramname3 | v3 = paramvalue3
}}</noinclude><noinclude>{{Documentation|Template:any page/doc| content = {{Template:any page/doc|optional 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 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.