Difference between revisions of "Module:Documentation/doc"
m (1 revision imported) |
(mediawiki page of lua documentation) |
||
| Line 1: | Line 1: | ||
| + | {{used in system}} |
||
| − | {{Module rating| |
+ | {{Module rating|protected}} |
| − | <!-- Add categories where indicated at the bottom of this page and interwikis at Wikidata --> |
||
| ⚫ | |||
{{Uses TemplateStyles|Module:Documentation/styles.css}} |
{{Uses TemplateStyles|Module:Documentation/styles.css}} |
||
| ⚫ | |||
| ⚫ | |||
| ⚫ | |||
== Normal usage == |
== Normal usage == |
||
| − | For most uses, you should use the {{ |
+ | For most uses, you should use the {{tl|documentation}} template; please see that template's page for its usage instructions and parameters. |
== Use in other modules == |
== Use in other modules == |
||
| Line 26: | Line 26: | ||
== Porting to other wikis == |
== 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 [ |
+ | 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 [[MediaWiki:Scribunto-doc-page-show]] and [[MediaWiki:Scribunto-doc-page-does-not-exist]]. |
||
| − | <includeonly>{{Sandbox other|| |
||
| − | <!-- Categories below this line; interwikis at Wikidata --> |
||
| − | [[Category:Modules{{#translation:}}]] |
||
| − | }}</includeonly><noinclude> |
||
| − | [[Category:Module documentation pages{{#translation:}}]] |
||
| − | </noinclude> |
||
Revision as of 12:26, 20 October 2021
 | This Lua module is used in system messages, and on approximately 124,000 pages. Changes to it can cause immediate changes to the Wikipedia user interface. To avoid major disruption and server load, any changes should be tested in the module's /sandbox or /testcases subpages, or in your own module sandbox. The tested changes can be added to this page in a single edit. Please discuss changes on the talk page before implementing them. |
 | <translate> This module is [[<tvar name=1>Special:MyLanguage/Category:Modules subject to page protection</tvar>|subject to {{<tvar name=2>#if:</tvar>|cascading|page}} protection]].</translate> <translate> It is a highly visible module in use by a very large number of pages.</translate> <translate> Because vandalism or mistakes would affect many pages, and even trivial editing might cause substantial load on the servers, it is [[<tvar name=1>Special:MyLanguage/Project:Protected page</tvar>|protected]] from editing.</translate> |
 | This module depends on the following other modules: |
Lua error: callParserFunction: function "#translation" was not found. This module displays a blue 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:
<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 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.