Munurin millum rættingarnar hjá "Module:Documentation/doc"
EileenSanda (kjak | íkøst) Stovnaði síðu við "This module displays a blue box containing documentation for templates, Lua modules, or other pages. The {{tl|documentation}} template invoke..." |
s Bot: Erstatt forældet <source> -tag og parameteren "enclose" [https://lists.wikimedia.org/pipermail/wikitech-ambassadors/2020-April/002284.html] |
||
| Linja 9: | Linja 9: | ||
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="lua"> |
||
local documentation = require('Module:Documentation').main |
local documentation = require('Module:Documentation').main |
||
</syntaxhighlight> |
|||
</source> |
|||
Then you can simply call it using a table of arguments. |
Then you can simply call it using a table of arguments. |
||
< |
<syntaxhighlight lang="lua"> |
||
documentation{content = 'Some documentation', ['link box'] = 'My custom link box'} |
documentation{content = 'Some documentation', ['link box'] = 'My custom link box'} |
||
</syntaxhighlight> |
|||
</source> |
|||
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. |
||
Seinasta endurskoðan sum var 22. apr 2020 kl. 16:37
This module displays a blue box containing documentation for templates, Lua modules, or other pages. The {{documentation}} template invokes it.
Normal usage[rætta wikitekst]
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[rætta wikitekst]
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[rætta wikitekst]
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.