Template:Dochead/doc: Difference between revisions

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


=== See also ===
=== See also ===
* [[Template:Docheadwiki]] – Similar template, used mainly for templates which are more or less copied over from Wikipedia.
* [[Template:Doc head Wikipedia]] – Similar template, used mainly for templates borrowed from Wikipedia.


<noinclude>[[Category:Template documentation]]</noinclude>
<noinclude>[[Category:Template documentation]]</noinclude>

Revision as of 13:33, 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