Template:Documentation/doc: Difference between revisions
Jump to navigation
Jump to search
ArrowHead294 (talk | contribs) mNo edit summary |
ArrowHead294 (talk | contribs) mNo edit summary |
||
| Line 4: | Line 4: | ||
=== Usage === | === Usage === | ||
=== Templates === | |||
Enclose <code><nowiki>{{documentation}}</nowiki></code> in <code><nowiki><noinclude></nowiki></code> tags: | |||
<pre> | <pre> | ||
| Line 15: | Line 16: | ||
</pre> | </pre> | ||
=== Modules === | |||
Place this template on the documentation page (the <code>/doc</code> subpage) and pass the notes in as the first unnamed parameter: | |||
{{escape notice}} | {{escape notice}} | ||
Revision as of 02:21, 27 January 2025
The {{documentation}} template is used to contain information and instructions for templates and modules. The actual information is located in the /doc subpage.
Usage
Templates
Enclose {{documentation}} in <noinclude> tags:
<noinclude>
{{documentation}}
[[Category: ...]]
...
</noinclude>
Modules
Place this template on the documentation page (the /doc subpage) and pass the notes 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.