Module:Documentation/doc

From Wikivoyage
Jump to navigation Jump to search

This module displays a green 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.