Module:Documentation/doc
This is the documentation page for Module:Documentation
 | High-use template or module This message may appear because a template was copied from Wikipedia or another wiki. Please remove the link to template Template:Used in system if this is not a high usage template on MEpedia. |
</noinclude>
 | This module is subject to page protection. It is a high-risk 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. |
 | Uses Lua: |
 | header-module |
This module displays a blue box containing documentation for templates, Lua modules, or other pages. The {{documentation}}
{{documentation}} template invokes it.
Normal usage[edit source]
For most uses, you should use the {{documentation}}
{{documentation}} template; please see that template's page for its usage instructions and parameters.
Use in other modules[edit source]
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[edit source]
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.
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.
