Welcome to Warhammer 40k - Lexicanum! Log in and join the community.

Difference between revisions of "Template:Documentation"

From Warhammer 40k - Lexicanum
Jump to: navigation, search
 
Line 9: Line 9:
 
  }}<div class="plainlinks" style="font-style:italic;margin-bottom:0.5em;padding-left:2em">{{#ifexist: {{{1|{{Documentation/docname}}}}}
 
  }}<div class="plainlinks" style="font-style:italic;margin-bottom:0.5em;padding-left:2em">{{#ifexist: {{{1|{{Documentation/docname}}}}}
 
   |This [[Lexicanum:Template documentation|documentation]] is [[Lexicanum:Transclusion|transcluded]] from [[{{{1|{{Documentation/docname}}}}}]]. <small style="font-style: normal">([{{fullurl:{{{1|{{Documentation/docname}}}}}|action=edit}} edit] &#124; [{{fullurl:{{{1|{{Documentation/docname}}}}}|action=history}} history])</small><br />
 
   |This [[Lexicanum:Template documentation|documentation]] is [[Lexicanum:Transclusion|transcluded]] from [[{{{1|{{Documentation/docname}}}}}]]. <small style="font-style: normal">([{{fullurl:{{{1|{{Documentation/docname}}}}}|action=edit}} edit] &#124; [{{fullurl:{{{1|{{Documentation/docname}}}}}|action=history}} history])</small><br />
  }}{{#switch: {{SUBPAGENAME}}
+
  }}
  |sandbox|testcases=
 
  |#default=
 
    {{#switch: {{SUBJECTSPACE}}
 
    |{{ns:template}}
 
    |{{ns:user}}=
 
      {{#ifexist: {{FULLPAGENAME}}/sandbox
 
      |This template has a [[/sandbox|sandbox]] <small style="font-style: normal">([{{fullurl:{{ #rel2abs: /sandbox }}|action=edit}} edit])</small> {{#ifexist: {{FULLPAGENAME}}/testcases
 
        |and [[/testcases|testcases]] <small style="font-style: normal">([{{fullurl:{{ #rel2abs: /testcases }}|action=edit}} edit])</small>}} for editors to experiment.
 
      |{{#ifexist: {{FULLPAGENAME}}/testcases
 
        |This template has [[/testcases|testcases]] <small style="font-style: normal">([{{fullurl:{{ #rel2abs: /testcases }}|action=edit}} edit])</small> for editors to experiment.}}
 
}}}}}}
 
 
  </div>
 
  </div>
 
{{#if:{{{content|}}}|{{{content}}}|{{#ifexist:{{{1|{{Documentation/docname}}}}} | {{ {{{1|{{Documentation/docname}}}}} }} }}}}
 
{{#if:{{{content|}}}|{{{content}}}|{{#ifexist:{{{1|{{Documentation/docname}}}}} | {{ {{{1|{{Documentation/docname}}}}} }} }}}}
 
<div style="clear: both;"></div>
 
<div style="clear: both;"></div>
 
</div>
 
</div>

Latest revision as of 12:59, 26 June 2009

[edit] [purge] Template-info.png Template documentation

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 "&lt;".

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.