Module:Documentation/doc: Difference between revisions

From HIBIKIFORUM
Jump to navigation Jump to search
mNo edit summary
mNo edit summary
Line 1: Line 1:
{{module rating|p}}


This module displays a blue box containing documentation for [[Special:MyLanguage/Help:templates|templates]], [[Special:MyLanguage/Lua scripting|Lua modules]], or other pages. The {{tl|documentation}} template invokes it.
This module displays a blue box containing documentation for [[Special:MyLanguage/Help:templates|templates]], [[Special:MyLanguage/Lua scripting|Lua modules]], or other pages. The {{tl|documentation}} template invokes it.

Revision as of 22:34, 5 September 2020

Template:Module rating

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:

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.