This page is protected against editing.

Template:Module-nav

From Wikimedia Commons, the free media repository
Jump to navigation Jump to search

CodeDiscussionEditHistoryLinksLink count Subpages:DocumentationTestsResultsSandboxLive code All modules

Protected This template has been protected from editing to prevent vandalism.
Please discuss changes on the talk page or request unprotection.
Template documentationview · edit · history · purge ]
This documentation is transcluded from Template:Module-nav/doc.

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:

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>JSON</templatedata> ./. {{TemplateBox}}
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.

Discussion
There is an ongoing discussion about that matter. Feel invited to comment if you are experienced in either way, your time permits and if you like to share your opinion or to make a suggestion.


Wikipedia's help about TemplateDataCommons-specific information

This template provides navigation for Lua-based Scribunto modules.

Template parameters[Edit template data]

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
Module Namemodule

The name of the module, without the “Module:” namespace prefix.

Default
File
Stringrequired

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)