« Module:Documentation/doc » : différence entre les versions
(Page créée avec « This module displays a blue box containing documentation for templates, Lua modules, or other pages. It is usually run using the {{tl|documen... ») |
Aucun résumé des modifications |
||
| Ligne 9 : | Ligne 9 : | ||
To use this module from another Lua module, first load it with <code>require</code>: | To use this module from another Lua module, first load it with <code>require</code>: | ||
< | <syntaxhighlight lang="lua"> | ||
local documentation = require('Module:Documentation').main | local documentation = require('Module:Documentation').main | ||
</ | </syntaxhighlight> | ||
Then you can simply call it using a table of arguments. | Then you can simply call it using a table of arguments. | ||
< | <syntaxhighlight lang="lua"> | ||
documentation{content = 'Some documentation', ['link box'] = 'My custom link box'} | documentation{content = 'Some documentation', ['link box'] = 'My custom link box'} | ||
</ | </syntaxhighlight> | ||
Please refer to the [[Template:Documentation/doc|template documentation]] for usage instructions and a list of parameters. | Please refer to the [[Template:Documentation/doc|template documentation]] for usage instructions and a list of parameters. | ||
Dernière version du 7 mai 2022 à 11:50
This module displays a blue box containing documentation for templates, Lua modules, or other pages. It is usually run using the {{documentation}} template.
Normal usage
For most uses, this module should be called from the {{documentation}} template. Please see the template page for usage instructions and a list of 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.