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 2: Line 2:
{{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}}
=== Usage ===
On templates, enclose it in <code><nowiki><noinclude></nowiki></code> tags:
<pre>
<noinclude>
{{documentation}}
[[Category: ...]]
...
</noinclude>
</pre>
On modules, this template goes on their documentation pages themselves:
<pre>
{{documentation|
{{dochead}}
...
}}
</pre>


=== See also ===
=== See also ===
* [[Template:Dochead]] &ndash; used to categorise and add appropriate headers onto documentation pages.
* [[Template:Dochead]] &ndash; used to categorise and add appropriate headers onto documentation pages.

Revision as of 15:23, 25 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 templates, enclose it in <noinclude> tags:

<noinclude>
{{documentation}}

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

On modules, this template goes on their documentation pages themselves:

{{documentation|
{{dochead}}
...
}}

See also

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