Template:Documentation/doc

English Wikipedia has an article on:

Template:Documentation

The {{documentation}} template is used to contain information and instructions for templates and modules. The actual information is located in the /doc subpage.

Wikipedia's documentation template has modules that help render the dialog boxes, but here the box is hard-coded to simplify things.

Templates

On templates, place {{documentation}} on the page itself, place the relevant categories afterwards, and enclose them in <noinclude> tags:

<noinclude>
{{documentation}}

[[Category: ...]]
...
</noinclude>

Modules

On pages consisting of exclusively code (modules, CSS, JS, etc), place this template on the /doc subpage and pass the notes, along with {{dochead}}, in as the first unnamed parameter:

Note: Pipe characters (|) must be escaped as {{!}} or {{pipe}}, equals signs must be escaped as {{=}} (this may apply to tags as well, e.g. <div style{{=}}"…">), and other special characters and character sequences may need to be escaped accordingly, except for ones inside <nowiki>, <pre>, <math>, and <syntaxhighlight> tags.

{{documentation|
{{dochead}}
...
}}

Additionally, when {{lua}} is used on a module documentation page to indicate dependencies, the first paragraph paragraph of text after the Lua banner may need to be encased in its own paragraph (<p>) element:

{{documentation|
{{dochead}}{{lua|...|...|}}
<p>Paragraph 1</p>

Paragraph 2

Paragraph 3
...
}}

Wikipedia has Module:Documentation which takes care of things automatically, but here, this is used as a workaround to avoid the need for modules.

See also

• Template:Dochead – used to categorise and add appropriate headers onto documentation pages.