Template:Documentation/doc: Difference between revisions
ArrowHead294 (talk | contribs) mNo edit summary |
ArrowHead294 (talk | contribs) mNo edit summary |
||
| Line 5: | Line 5: | ||
__NOTOC__ | __NOTOC__ | ||
=== Templates === | === Templates === | ||
On templates, place <code>{{<nowiki />documentation}}</code> on the page itself, place the relevant categories afterwards, and enclose them in <code><<nowiki />noinclude></code> tags: | |||
<pre> | <pre> | ||
| Line 17: | Line 17: | ||
=== Modules === | === Modules === | ||
On pages consisting of exclusively code (modules, CSS, JS, etc), place this template on the <code>/doc</code> subpage and pass the notes, along with {{tlx|dochead}}, in as the first unnamed parameter: | |||
{{escape notice}} | {{escape notice}} | ||
| Line 28: | Line 28: | ||
</pre> | </pre> | ||
Wikipedia has {{w|Module:Documentation}} which takes care of things automatically | Wikipedia has {{w|Module:Documentation}} which takes care of things automatically, but here, this is used as a workaround to avoid the need for modules. | ||
=== 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. | ||
Revision as of 13:20, 15 April 2025
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}}
...
}}
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.