Module:Documentation/doc: Difference between revisions
en>Dinoguy1000 (→Porting to other wikis: because the link to {{Documentation}}'s talk page is there for the benefit of third-party wikis, it should use external link syntax (an internal link would just point to their local page, which won't help them, and an interwiki prefix can't be assumed to exist)) |
m (1 revision imported) |
(No difference)
| |
Latest revision as of 23:27, 25 December 2019
 | This Lua module is used on approximately 108,000 pages. To avoid major disruption and server load, any changes should be tested in the module's /sandbox or /testcases subpages, or in your own module sandbox. The tested changes can be added to this page in a single edit. Consider discussing changes on the talk page before implementing them. |
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. 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.