Template:Dochead/doc: Difference between revisions
ArrowHead294 (talk | contribs) mNo edit summary |
No edit summary |
||
| Line 7: | Line 7: | ||
On modules, unless <code>header=none</code> is passed, a header will appear to inform users that modules should be called via templates instead of being invoked directly: | On modules, unless <code>header=none</code> is passed, a header will appear to inform users that modules should be called via templates instead of being invoked directly: | ||
'''Note:''' Do not invoke this module directly; use the corresponding template instead: [[mw:Help:Magic words#Page names|Template:<nowiki>{{ROOTPAGENAME}}</nowiki>]]. | <blockquote>'''Note:''' Do not invoke this module directly; use the corresponding template instead: [[mw:Help:Magic words #Page names|Template: <nowiki>{{ROOTPAGENAME}}</nowiki>]].</blockquote> | ||
where <code>ROOTPAGENAME</code> is a [[mw:Help:Magic words|"magic word"]] that returns the name of the page without the namespace or subpages. | where <code>ROOTPAGENAME</code> is a [[mw:Help:Magic words|"magic word"]] that returns the name of the page without the namespace or subpages. This way, the link in the header will attempt to point to a template with the same name as the module, since this is mostly the case. If the template which calls the module has a different name, pass in <code>temp=</code> followed by the name of the template. | ||
You can also directly specify the header using the <code>header</code> parameter. | |||
=== See also === | === See also === | ||
* [[Template: Documentation]] – inserts a documentation section onto a template or module. | * [[Template: Documentation]] – inserts a documentation section onto a template or module. | ||
* [[Template: Doc head Wikipedia]] – similar template, used mainly for templates borrowed from Wikipedia. | * [[Template: Doc head Wikipedia]] – similar template, used mainly for templates borrowed from Wikipedia. | ||
Revision as of 15:58, 23 September 2025
- This template is implemented by the Lua module Module:Dochead.
- This template invokes the following functions: dochead from Dochead.
This template automatically categorizes documentation by namespace, 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 to inform users that modules should be called via templates instead of being invoked directly:
Note: Do not invoke this module directly; use the corresponding template instead: Template: {{ROOTPAGENAME}}.
where ROOTPAGENAME is a "magic word" that returns the name of the page without the namespace or subpages. This way, the link in the header will attempt to point to a template with the same name as the module, since this is mostly the case. If the template which calls the module has a different name, pass in temp= followed by the name of the template.
You can also directly specify the header using the header parameter.
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.