Template:Module-nav/doc
 | This template is used in system messages. Changes to it can cause immediate changes to the Wikimedia user interface. To avoid major disruption, any changes should be tested in the template's /sandbox or /testcases subpages, or in your own user subpage. The tested changes can be added to this page in a single edit. Please discuss changes on the talk page before implementing them. |
This template provides navigation for Lua-based Scribunto modules.
Usage
{{Module-nav |module= }}
To display this template at the top of module pages and module doc pages, the following messages need to be customized:
- MediaWiki:Scribunto-doc-page-does-not-exist: displayed on existing module pages when their respective module doc page does not exist
- MediaWiki:Scribunto-doc-page-header: displayed on module doc pages regardless of their existence or the existence of their respective module page
- MediaWiki:Scribunto-doc-page-show: displayed on existing module pages when their respective doc page also exists
Module doc pages are determined by the MediaWiki:Scribunto-doc-page-name naming pattern, see translations at: MediaWiki:Scribunto-doc-page-name
Template parameters
- TemplateData
TemplateData is a way to store information about template parameters (the description of those and of the whole template) for both humans and machines. It is used by VisualEditor and possibly other tools like Upload Wizard.
Existing template documentation
At Wikimedia Commons, it is recommended to use {{TemplateBox}} with either useTemplateData=1 or useTemplateData=only on the /doc subpage and transcluding it with {{Documentation}} into the template. <nowiki>-tags can be wrapped around the arguments, if required, to avoid templates being expanded.
Newly created template documentation and imports
Another option, especially for imported templates, or for users with JSON experience, is placing raw <templatedata>-tags into the Wikitext of the template, as described in various Wikipediae.
Wikipedia's help about TemplateData • Commons-specific information
This template provides navigation for Lua-based Scribunto modules.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| Module Name | module | The name of the module, without the “Module:” namespace prefix.
| String | required |
Additional information
The template is intended to be used in the following namespaces: the MediaWiki namespace
The template is intended to be used by the following user groups: Administrators
Placement: At the top of the page
Relies on:
See also
Localization
To add your language to the list of languages supported by this template, please edit the /i18n subpage and add a row to the "{{LangSwitch|}}" constructs. It takes the form "|xx= Your translation " (xx being the code of your language)