Module:Documentation/doc

From OS-Tan Collections Wiki
< Module:Documentation
Revision as of 20:12, 10 December 2023 by Halian (talk | contribs) (Created page with "{{Lua|Module:Documentation/config|Module:Documentation/i18n|Module:Arguments|Module:Message box|Module:Module wikitext|Module:TNT}} This module displays a blue box containing documentation for templates, Lua modules, or other pages. The {{tl|documentation}} template invokes it. == Normal usage == For most uses, you should use the {{tl|documentation}} template; please see that template's page for its usage instructions and parameters. == Use in other...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

This is the documentation page for Module:Documentation

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.

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.