Module:Documentation/doc

Template:Module rating Template:Lua Template:Uses TemplateStyles Template:Uses TNT This module displays a blue 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:

<syntaxhighlight lang="lua"> local documentation = require('Module:Documentation').main </syntaxhighlight>

Then you can simply call it using a table of arguments. <syntaxhighlight lang="lua"> documentation{content = 'Some documentation', ['link box'] = 'My custom link box'} </syntaxhighlight>

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.

To display Module documentation on the Module's page itself, you should create MediaWiki:Scribunto-doc-page-show accordingly. (See also Extension:Scribunto/Lua reference manual#Module documentation)

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.