Place this template on the page itself, enclose <code><nowiki>{{documentation}}</nowiki></code> in <code><nowiki><noinclude></nowiki></code> tags, and put in the relevant categories afterwards:
Place this template on the page itself, enclose <code><nowiki>{{documentation}}</nowiki></code> in <code><<nowiki />noinclude></code> tags, and put in the relevant categories afterwards:
<pre>
<pre>
Line 17:
Line 17:
==== Modules ====
==== Modules ====
Place this template on the documentation page (the <code>/doc</code> subpage) and pass the notes in as the first unnamed parameter:
Place this template on the <code>/doc</code> subpage and pass the notes, along with {{tlx|dochead|plaincode}}, in as the first unnamed parameter:
{{escape notice}}
{{escape notice}}
Line 29:
Line 29:
=== See also ===
=== See also ===
* [[Template:Dochead]] – used to categorise and add appropriate headers onto documentation pages.
* [[Template:Dochead]] – used to categorise and add appropriate headers onto documentation pages.
The {{documentation}} template is used to contain information and instructions for templates and modules. The actual information is located in the /doc subpage.
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}}
...
}}
See also
Template:Dochead – used to categorise and add appropriate headers onto documentation pages.
