Module:Documentation/doc

This is a documentation subpage for Module:Documentation (see that page for the module itself).
It contains usage information, categories and other content that is not part of the original module page.

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

Normal usage[edit]

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[edit]

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[edit]

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.