Template:Dochead/doc: Difference between revisions
ArrowHead294 (talk | contribs) mNo edit summary |
ArrowHead294 (talk | contribs) mNo edit summary |
||
| Line 2: | Line 2: | ||
This template automatically inserts the default documentation header: | This template automatically inserts the default documentation header: | ||
< | <blockquote class="toccolours"> | ||
<div><hr /><span style="font-size: 0.75em;">Documentation transcluded from [[/doc]]</span></div> | <div><hr /><span style="font-size: 0.75em;">Documentation transcluded from [[/doc]]</span></div> | ||
</ | </blockquote> | ||
onto the main pages for certain items (mostly templates and modules), while also providing a link to the documentation subpage. | onto the main pages for certain items (mostly templates and modules), while also providing a link to the documentation subpage. | ||
| Line 15: | Line 15: | ||
On modules, unless <code>header=none</code> is passed, a header will appear. By default, this will attempt to point to the template with the same name: | On modules, unless <code>header=none</code> is passed, a header will appear. By default, this will attempt to point to the template with the same name: | ||
< | <blockquote class="toccolours"> | ||
'''Note:''' Do not invoke this module directly; use the corresponding template instead: [[Template:{{ROOTPAGENAME}}]]. | '''Note:''' Do not invoke this module directly; use the corresponding template instead: [[Template:{{ROOTPAGENAME}}]]. | ||
</ | </blockquote> | ||
but this can be changed by passing <code>temp=</code> followed by the name of the template (without <code>Template:</code> in front). | but this can be changed by passing <code>temp=</code> followed by the name of the template (without <code>Template:</code> in front). | ||
Revision as of 12:37, 11 September 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.
It also places items inside their respective categories, which eliminates the need to do this manually. Currently, it is configured to place modules and their documentation inside their respective categories (Category:Lua modules and Category:Module documentation).
Usage
This template is invoked by placing {{dochead}} at the top of a module or template's /doc subpage.
On modules, unless header=none is passed, a header will appear. By default, this will attempt to point to the template with the same name:
Note: Do not invoke this module directly; use the corresponding template instead: Template:Dochead.
but this can be changed by passing temp= followed by the name of the template (without Template: in front).
See also
- Template:Documentation – Inserts a documentation section onto a template or module.
- Template:Doc head Wikipedia – Similar template, used mainly for templates borrowed from Wikipedia.