Module:Documentation/doc
| icon | This is a documentation subpage for Template:Terminate sentence It may contain usage information, categories and other content that is not part of the original module page. |
Script error: No such module "High-use".
- REDIRECT Template:Template rating
Template:Redirect category shell
Page Module:Message box/ombox.css has no content.
| File:Lua-Logo.svg | This module depends on the following other modules: |
Template:Uses TemplateStyles This module displays a green box containing documentation for templates, Lua modules, or other pages. The Template:Tl template invokes it.
Normal usage
For most uses, you should use the Template:Tl 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. Also, links to Wikipedia within config strings, i.e. [[Wikipedia:Template documentation|documentation]] will point to non-existent Wikipedia pages if config is on another wiki. Either modify, remove it, or add the interwiki prefix like so: [[w:Wikipedia:Template documentation|documentation]].
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.
The messages that need to be customized to display a documentation template/module at the top of module pages are MediaWiki:Scribunto-doc-page-show and MediaWiki:Scribunto-doc-page-does-not-exist.
