Template:Documentation/doc: Difference between revisions

From Xenharmonic Wiki
Jump to navigation Jump to search
ArrowHead294 (talk | contribs)
mNo edit summary
ArrowHead294 (talk | contribs)
mNo edit summary
Line 16: Line 16:


On modules, this template goes on their documentation pages (the <code>/doc</code> subpages):
On modules, this template goes on their documentation pages (the <code>/doc</code> subpages):
{{escape notice}}


<pre>
<pre>

Revision as of 02:20, 27 January 2025

English Wikipedia has an article on:

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

Usage

On template pages, enclose {{documentation}} in <noinclude> tags:

<noinclude>
{{documentation}}

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

On modules, this template goes on their documentation pages (the /doc subpages):

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.