Difference between revisions of "Template:Documentation"

From DDwiki
Jump to: navigation, search
Line 1: Line 1:
<!--
+
<div style="background-color:#ECFCF4;border:1px solid #AAA;clear:both;margin:1em 0 0;padding:1em">
  Start of green doc box.
+
<div style="padding-bottom:3px;border-bottom:1px solid #aaa;margin-bottom:1ex">
-->{{documentation/start box2
+
<span class="editsection plainlinks" id="doc_editlinks" style="float:right;margin-left:5px">
| preload = {{{preload|}}}  <!--Allow custom preloads-->
+
[[{{fullurl:{{{docpage|{{FULLPAGENAME}}/doc}}}|action=edit}} edit]] [[{{fullurl:{{{docpage|{{FULLPAGENAME}}/doc}}}|action=history}} history]] [[{{fullurl:{{{docpage|{{FULLPAGENAME}}}}}|action=purge}} purge]]
| heading = {{{heading|¬}}}  <!--Empty but defined means no header-->
+
</span>
| heading-style = {{{heading-style|}}}
+
<span style="font-weight:bold;font-size:125%">
| content = {{{content|}}}
+
[[File:Template-info.png|50px|link=|alt=Documentation icon]]
 
+
Template documentation
<!--Some namespaces must have the /doc, /sandbox and /testcases
+
</span>
    in talk space-->
+
</div>
| docspace = {{documentation/docspace}}
+
{{Template:{{PAGENAME}}/doc }}
 
+
</div>
| 1 = {{{1|}}}  <!--Other docname, if fed-->
+
 
+
<!--The namespace is added in /start box2-->
+
| template page = {{documentation/template page}}
+
 
+
}}<!-- Start content --><!--
+
  Start load the /doc content:
+
  Note: The line breaks between this comment and the next line are necessary
+
  so  "=== Headings ===" at the start and end of docs are interpreted.
+
-->
+
{{ {{documentation/docspace}}:{{documentation/template page}}/doc }}
+
<!--
+
  End load the /doc content:
+
  Note: The line breaks between this comment and the previous line are necessary
+
  so  "=== Headings ===" at the start and end of docs are interpreted.
+
-->{{documentation/end box2
+
| preload = {{{preload|}}}   <!--Allow custom preloads-->
+
| content = {{{content|}}}
+
| link box = {{{link box|}}<!--So "link box=off" works-->
+
 
+
<!--Some namespaces must have the /doc, /sandbox and /testcases
+
    in talk space-->
+
| docspace = {{documentation/docspace}}
+
 
+
| 1 = {{{1|}}}  <!--Other docname, if fed-->
+
 
+
<!--The namespace is added in /end box2-->
+
| template page = {{documentation/template page}}
+
 
+
}}<!--
+
  End of green doc box
+
--><noinclude>
+
 
+
<!-- Add categories and interwikis to the /doc subpage, not here! -->
+
</noinclude>
+

Revision as of 01:21, 16 April 2012

[edit] [history] [purge] Documentation icon Template documentation

This is the {{documentation}} template.

This template displays a green doc box like you are seeing now, and automatically loads the content from a /doc subpage.

Usage

This template is used without any parameters, placed at the bottom of the template or page being documented, within <noinclude>:

<!--Last line of your template code--><noinclude>

{{documentation}}
<!-- Add categories to the /doc subpage, not here! -->
</noinclude>

Then this template automatically loads the content from the /doc subpage of the template it is used on.

Best practice

The code should be added at the bottom of the template code, with no space before <noinclude> (which would cause extra space on pages where the template is used).

Categories and interwiki links that apply to the template itself should be added to the bottom of the /doc subpage, inside <includeonly>...</includeonly> tags.

If the documentation page contains <includeonly> or <noinclude> tags as part of the visible documentation text, replace the "<" with "&lt;".

Documentation pages

Documentation pages should end with the category links for both the documentation page and the template itself, in the following way:

<includeonly>[[Category:CATEGORY TO WHICH THE TEMPLATE BELONGS]]</includeonly>
<noinclude>[[Category:Template documentation]]</noinclude>