|
|
| Line 1: |
Line 1: |
| {{Module rating|release}}
| | - |
| <!-- Add categories where indicated at the bottom of this page and interwikis at Wikidata -->
| |
| {{Lua|Module:Documentation/config|Module:Documentation/i18n|Module:Arguments|Module:Message box|Module:Module wikitext|Module:TNT}}
| |
| {{Uses TemplateStyles|Module:Documentation/styles.css}}
| |
| {{Uses TNT|Documentation}}
| |
| This [[module]] displays a blue box containing documentation for [[Special:MyLanguage/Help:templates|templates]], [[Special:MyLanguage/Lua scripting|Lua modules]], or other pages. The {{tlx|documentation}} template invokes it.
| |
| | |
| == Normal usage ==
| |
| | |
| For most uses, you should use the {{tlx|documentation}} 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 <code>require</code>:
| |
| | |
| <syntaxhighlight lang="lua">
| |
| local documentation = require('Module:Documentation').main
| |
| </syntaxhighlight>
| |
| | |
| Then you can simply call it using a table of arguments.
| |
| <syntaxhighlight lang="lua">
| |
| 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.
| |
| | |
| == 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.
| |
| | |
| To display Module documentation on the Module's page itself, you should create [[MediaWiki:Scribunto-doc-page-show]] accordingly. (See also [[Extension:Scribunto/Lua reference manual#Module 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.
| |
| | |
| <includeonly>{{Sandbox other||
| |
| <!-- Categories below this line; interwikis at Wikidata -->
| |
| [[Category:Modules{{#translation:}}]]
| |
| }}</includeonly><noinclude>
| |
| [[Category:Module documentation pages{{#translation:}}]]
| |
| </noinclude>
| |
