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 1: Line 1:
{{dochead}}
{{dochead}}{{wikipedia}}
{{wikipedia}}
The <code><nowiki>{{documentation}}</nowiki></code> template is used to contain information and instructions for templates and modules. The actual information is located in the <code>/doc</code> subpage.{{clear}}
The <code><nowiki>{{documentation}}</nowiki></code> template is used to contain information and instructions for templates and modules. The actual information is located in the <code>/doc</code> subpage.{{clear}}
__NOTOC__
__NOTOC__
=== Usage ===
=== Templates ===
==== Templates ====
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:
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:


Line 16: Line 14:
</pre>
</pre>


==== Modules ====
=== Modules ===
Place this template on the <code>/doc</code> subpage and pass the notes, along with {{tlx|dochead}}, in as the first unnamed parameter:
Place this template on the <code>/doc</code> subpage and pass the notes, along with {{tlx|dochead}}, in as the first unnamed parameter:



Revision as of 16:46, 24 February 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.

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

See also

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