Module:Documentation/doc: Difference between revisions

From HIBIKIFORUM
Jump to navigation Jump to search
(Created page with "{{Uses TemplateStyles|Module:Documentation/styles.css}} This module displays a blue box containing documentation for templates, Special...")
 
No edit summary
Line 1: Line 1:
{{Uses TemplateStyles|Module:Documentation/styles.css}}
This module displays a blue box containing documentation for [[Special:MyLanguage/Help:templates|templates]], [[Special:MyLanguage/Lua scripting|Lua modules]], or other pages. The <code><nowiki>{{documentation}}</nowiki></code> 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 <code><nowiki>{{documentation}}</nowiki></code> template invokes it.



Revision as of 16:48, 2 September 2020

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.