Module:Documentation/doc

This is the documentation page for Module:Documentation

This Lua module is used in MediaWiki:Scribunto-doc-page-show and MediaWiki:Scribunto-doc-page-does-not-exist, and on approximately 175,000 pages.
Changes to it can cause immediate changes to the Wikipedia user interface.
To avoid major disruption and server load, any changes should be tested in the module's /sandbox or /testcases subpages, or in your own module sandbox. The tested changes can be added to this page in a single edit. Please discuss changes on the talk page before implementing them.

File:Lua-Logo.svg

This module depends on the following other modules:

CSS

This module uses TemplateStyles:

Module:Documentation/styles.css

This module displays a green box containing documentation for templates, Lua modules, or other pages. The {{Documentation }} template invokes it.

Normal usage

For most uses, you should use the {{Documentation }} template; please see that template's page for its usage instructions and parameters.

Use in other modules

To use this module from another Lua module, first load it with require:

local documentation = require('Module:Documentation').main

Then you can simply call it using a table of arguments.

documentation{content = 'Some documentation', ['link box'] = 'My custom link box'}

Please refer to the template documentation for usage instructions and a list of parameters.

Porting to other wikis

The module has a configuration file at Module:Documentation/config which is intended to allow easy translation and porting to other wikis. Please see the code comments in the config page for instructions. If you have any questions, or you need a feature which is not currently implemented, please leave a message at Template talk:Documentation to get the attention of a developer.

The messages that need to be customized to display a documentation template/module at the top of module pages are MediaWiki:Scribunto-doc-page-show and MediaWiki:Scribunto-doc-page-does-not-exist.