More actions
m Protected "Module:Documentation/doc": Initial wiki setup ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite)) |
No edit summary |
||
| Line 1: | Line 1: | ||
{{Used in system|in | {{Used in system|in MediaWiki:Scribunto-doc-page-show, in MediaWiki:Scribunto-doc-page-does-not-exist}} | ||
{{Module rating|protected}} | {{Module rating|protected}} | ||
{{Lua|Module:Documentation/config|Module:Arguments|Module:Message box|Module:Module wikitext|Module:Protection banner}} | {{Lua|Module:Documentation/config|Module:Arguments|Module:Message box|Module:Module wikitext|Module:Protection banner}} | ||
{{Uses TemplateStyles|Module:Documentation/styles.css}} | {{Uses TemplateStyles|Module:Documentation/styles.css}} | ||
This module displays a green box containing documentation for | This module displays a green box containing documentation for templates, Lua modules, or other pages. The {{tl|documentation}} template invokes it. | ||
== Normal usage == | == Normal usage == | ||
| Line 22: | Line 22: | ||
</syntaxhighlight> | </syntaxhighlight> | ||
Please refer to the | Please refer to the template documentation for usage instructions and a list of parameters. | ||
== Porting to other wikis == | == Porting to other wikis == | ||
The module has a configuration file at | 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 <span class="plainlinks">[https://en.wikipedia.org/wiki/Template_talk:Documentation Template talk:Documentation]</span><!-- this link uses external link syntax because it is intended to direct users from third-party wikis to the Wikipedia template talk page; in this situation, an internal link would unhelpfully just point to their local template talk page, and the existence of any given interwiki prefix cannot be assumed --> 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 | 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.<noinclude> | ||
[[Category:Module documentation pages]] | [[Category:Module documentation pages]] | ||
</noinclude> | </noinclude> | ||
Revision as of 17:06, 6 April 2025
 | This module depends on the following other modules: |
 | This module uses TemplateStyles: |
This module displays a green box containing documentation for templates, Lua modules, or other pages. The {{documentation}} template invokes it.
Normal usage
For most uses, you should use the {{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 require:
local documentation = require('Module:Documentation').mainThen 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. 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.