This is the documentation page forModule:Documentation
![]() | This Lua module is used on100,000+ pages. To avoid large-scale disruption and unnecessary server load, any changes to this module should first be tested in its/sandbox or/testcases subpages. The tested changes can then be added to this page in a single edit. Please consider discussing any changes on thetalk page before implementing them. |
![]() | This module issubject to page protection. It is ahighly visible module in use by a very large number of pages, or issubstituted very frequently. Because vandalism or mistakes would affect many pages, and even trivial editing might cause substantial load on the servers, it isprotected from editing. |
This module displays a blue box containing documentation fortemplates,Lua modules, or other pages. The {{documentation}} template invokes it.
For most uses, you should use the {{documentation}} template; please see that template's page for its usage instructions and parameters.
To use this module from another Lua module, first load it withrequire
:
localdocumentation=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 thetemplate documentation for usage instructions and a list of parameters.
The module has a configuration file atModule: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 atTemplate talk:Documentation to get the attention of a developer.