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 6: Line 6:
|}
|}


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.
onto the main pages for certain items (mostly templates and modules), while also providing a link to the documentation subpage.
 
The header is wrapped in a <code>&lt;span&gt;</code> element so it can be hidden on documentation pages but visible on main pages where they are transcluded.


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

Revision as of 12:36, 22 May 2024

This template automatically inserts the default documentation header:


Documentation transcluded from /doc

onto the main pages for certain items (mostly templates and modules), while also providing a link to the documentation subpage.

The header is wrapped in a <span> element so it can be hidden on documentation pages but visible on main pages where they are transcluded.

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