Module:Documentation/doc: Difference between revisions

From Zoophilia Wiki
Jump to navigationJump to search
Remove erroneous meta-status templates
Goonson (talk | contribs)
Line 1: Line 1:
This module displays a box containing documentation for templates, Lua modules and other pages. The {{Template link general|Documentation}} template invokes it.
This module displays a box containing documentation for templates, Lua modules and other pages. The {{Template link general|Documentation}} template invokes it.
== Normal usage ==
For most uses, you should use the {{Template link general|Documentation}} template; please see that template's page for its usage instructions and parameters.


== Use in other modules ==
== Use in other modules ==

Revision as of 19:26, 26 March 2026

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

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 from Wikipedia to other wikis. Please see the code comments in the config page for instructions. If you have any questions, or you need a feature which is not currently implemented, please leave a message at Template talk:Documentation to get the attention of a developer.