Module:Documentation/doc: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
mNo edit summary |
||
| (8 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
This module displays a | {{Documentation subpage}} | ||
{{Lua|Module:Documentation/config|Module:Arguments|Module:Message box|Module:Module wikitext|Module:Protection banner}} | |||
{{Uses TemplateStyles|Module:Documentation/styles.css}} | |||
This module displays a wrapper container for documentation for templates and other pages. The {{tl|Documentation}} template invokes it. | |||
== Normal usage == | == Normal usage == | ||
For most uses, you should use the {{tlf|Documentation}} template; please see that template's page for its usage instructions and parameters. | |||
For most uses, you should use the | |||
== Use in other modules == | == Use in other modules == | ||
To use this module from another Lua module, first load it with | To use this module from another Lua module, first load it with {{code|require}}: | ||
< | <syntaxhighlight lang="lua"> | ||
local documentation = require('Module:Documentation').main | local documentation = require('Module:Documentation').main | ||
</ | </syntaxhighlight> | ||
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> | ||
Please refer to the template documentation for usage instructions and a list of parameters. | |||
<includeonly>{{sandbox other||{{testcases other|| | |||
<!-- Categories below this line, please --> | |||
[[Category:Modules]] | |||
}}}}</includeonly> | |||
Latest revision as of 02:08, 12 June 2023
|
It contains usage information, categories and other content that is not part of the original module page.
|
|---|
 | This module depends on the following other modules: |
 | This module uses TemplateStyles: |
This module displays a wrapper container for documentation for templates and 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.