Module:Documentation/doc: Difference between revisions
Content deleted Content added
No edit summary Tags: Reverted Mobile edit Mobile web edit |
m Reverted edit by 172.56.200.177 (talk) to last version by Awesome Aasim |
||
| Line 1: | Line 1: | ||
{{Used in system|in [[MediaWiki:Scribunto-doc-page-show]] and [[MediaWiki:Scribunto-doc-page- |
{{Used in system|in [[MediaWiki:Scribunto-doc-page-show]] and [[MediaWiki:Scribunto-doc-page-does-not-exist]]}} |
||
{{Module |protected}} |
{{Module rating|protected}} |
||
{{Lua|Module:Documentation/config| |
{{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 blue box containing documentation for [[Help:Template|templates]], [[Wikipedia:| modules]], or other pages. The {{tl|documentation}} template invokes it. |
This module displays a blue box containing documentation for [[Help:Template|templates]], [[Wikipedia:Lua|Lua modules]], or other pages. The {{tl|documentation}} template invokes it. |
||
== Normal usage == |
== Normal usage == |
||
| Line 13: | Line 13: | ||
To use this module from another Lua module, first load it with <code>require</code>: |
To use this module from another Lua module, first load it with <code>require</code>: |
||
<syntaxhighlight lang=" |
<syntaxhighlight lang="lua"> |
||
local documentation = require('Module:Documentation').main |
local documentation = require('Module:Documentation').main |
||
</syntaxhighlight> |
</syntaxhighlight> |
||
Then you can simply call it using a table of arguments. |
Then you can simply call it using a table of arguments. |
||
<syntaxhighlight |
<syntaxhighlight lang="lua"> |
||
documentation{content = 'Some documentation', ['link box'] = 'My custom link box'} |
documentation{content = 'Some documentation', ['link box'] = 'My custom link box'} |
||
</syntaxhighlight> |
|||
</syntax highlight> |
|||
Please refer to the [[Template:Documentation/doc|template documentation]] for usage instructions and a list of parameters. |
Please refer to the [[Template:Documentation/doc|template documentation]] for usage instructions and a list of parameters. |
||
| 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 <span class=" |
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]]. |
|||
Revision as of 14:00, 14 June 2024
 | This Lua module is used in MediaWiki:Scribunto-doc-page-show and MediaWiki:Scribunto-doc-page-does-not-exist, and on approximately 184,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. |
 | This module depends on the following other modules: |
 | This module uses TemplateStyles: |
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:
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
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.