Template:Dochead/doc: Difference between revisions

From Xenharmonic Wiki
Jump to navigation Jump to search
ArrowHead294 (talk | contribs)
No edit summary
ArrowHead294 (talk | contribs)
No edit summary
Line 1: Line 1:
<includeonly><hr><small>Documentation transcluded from [[/doc]]</small></includeonly>
<includeonly><hr><small>Documentation transcluded from [[/doc]]</small></includeonly>
This template automatically inserts the default documentation header:
: {| style="margin: 15px 0px 15px 0px; width: 98%;"
| <hr><small>Documentation transcluded from [[Template:Docheadwiki/doc|/doc]]</small>
|}
on templates and modules, while also providing a link to the documentation subpage. It is wrapped in a <code>&lt;span&gt;</code> element with a switchable <code>display</code> so that it is visible on the base page but not on the documentation page.
It also places items inside their respective categories, which eliminates the need to do this manually. Currently, it is configured to place templates inside [[:Category:Templates]] and modules inside [[:Category:Lua modules]].
=== Usage ===
This template is invoked by placing <code>{{((}}dochead{{))}}</code> at the top of a module or template's <code>/doc</code> subpage.
=== See also ===
* [[Template:Docheadwiki]] &ndash; Similar template, used mainly for templates which are more or less copied over from Wikipedia.
<noinclude>[[Category:Template documentation]]</noinclude>
<noinclude>[[Category:Template documentation]]</noinclude>

Revision as of 08:11, 21 May 2024

This template automatically inserts the default documentation header:


Documentation transcluded from /doc

on templates and modules, while also providing a link to the documentation subpage. It is wrapped in a <span> element with a switchable display so that it is visible on the base page but not on the documentation page.

It also places items inside their respective categories, which eliminates the need to do this manually. Currently, it is configured to place templates inside Category:Templates and modules inside Category:Lua modules.

Usage

This template is invoked by placing {{dochead}} at the top of a module or template's /doc subpage.

See also

  • Template:Docheadwiki – Similar template, used mainly for templates which are more or less copied over from Wikipedia.