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

Place this template on the page itself, enclose {{documentation}} in <noinclude> tags, and put in the relevant categories afterwards:

<noinclude>
{{documentation}}

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

Modules

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}}
...
}}

Wikipedia has Module:Documentation which takes care of things automatically on pages consisting of exclusively code (e.g. modules), but here, this is used as a workaround.

See also

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