Difference between revisions of "Template:Documentation"
m |
m |
||
| (2 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
<div class="template-documentation"> | <div class="template-documentation"> | ||
| − | + | <center><table width="96%"><tr><td width="60px" align="left">[[Image:Template-info.png|50px]]</td><td align="left"><span style="font-size:125%;">'''Template Documentation'''</span></td><td align="right">{{#ifexist: {{{1|{{Documentation/docname}}}}} | |
| − | |||
| − | |||
| − | |||
|<!--** /doc EXISTS** -->[[{{fullurl:{{{1|{{Documentation/docname}}}}}|action=edit}} edit]] | |<!--** /doc EXISTS** -->[[{{fullurl:{{{1|{{Documentation/docname}}}}}|action=edit}} edit]] | ||
| − | |<!--**/doc DOESN'T EXIST**-->[[{{fullurl:{{{1|{{Documentation/docname }}}}}|action=edit&preload=Template:Documentation/preload}} create]]}}</ | + | |<!--**/doc DOESN'T EXIST**-->[[{{fullurl:{{{1|{{Documentation/docname }}}}}|action=edit&preload=Template:Documentation/preload}} create]]}}</td></tr></table></center><hr> |
| − | + | {{#ifexist: {{{1|{{Documentation/docname}}}}}|<span style="color:white; margin-left:30px;">''This [[Project:Template documentation|documentation]] is [[Project:Transclusion|transcluded]] from [[{{{1|{{Documentation/docname}}}}}]].''</span> <small style="font-style:normal; color:white;"> ([{{fullurl:{{{1|{{Documentation/docname}}}}}|action=edit}} edit] | [{{fullurl:{{{1|{{Documentation/docname}}}}}|action=history}} history])</small><br/>||}} | |
| − | |||
{{#if:{{{content|}}}|{{{content}}}|{{#ifexist:{{{1|{{Documentation/docname}}}}} | {{ {{{1|{{Documentation/docname}}}}} }} }}}} | {{#if:{{{content|}}}|{{{content}}}|{{#ifexist:{{{1|{{Documentation/docname}}}}} | {{ {{{1|{{Documentation/docname}}}}} }} }}}} | ||
</div> | </div> | ||
| − | + | {{#ifexist: {{{1|{{Documentation/docname}}}}}|[[Category:Templates|{{{PAGENAME}}}]]|[[Category:Documentation Needed|{{{PAGENAME}}]]}} | |
| − | {{#ifexist: {{{1|{{Documentation/docname}}}}}||[[Category:Documentation Needed|{{{PAGENAME}}]]}} | ||
Latest revision as of 15:10, 21 July 2008
 | Template Documentation | [edit] |
This documentation is transcluded from Template:Documentation/doc. (edit | history)
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 /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.
