imported>Oetterer |
|||
| Zeile 12: | Zeile 12: | ||
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. | ||
Aktuelle Version vom 27. Juni 2022, 10:44 Uhr
 | This is a documentation subpage for Modul:Documentation. It contains usage information, categories and other content that is not part of the original modul page. |
 | This module is subject to page protection. It is a highly visible module in use by a very large number of pages, or is substituted very frequently. Because vandalism or mistakes would affect many pages, and even trivial editing might cause substantial load on the servers, it is protected from editing. |
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[Quelltext bearbeiten]
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[Quelltext bearbeiten]
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[Quelltext bearbeiten]
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.