Module:Documentation/doc: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| Line 1: | Line 1: | ||
{{Documentation subpage}} | {{Documentation subpage}} | ||
{{Lua|Module:Documentation/config|Module:Arguments}} | {{Lua|Module:Documentation/config|Module:Arguments}} | ||
This module displays a section containing documentation for [[ | This module displays a section containing documentation for [[Help:Templates|templates]], [[Help:Modules|modules]], or other pages. It implements the {{tl|documentation}} template. | ||
==Usage | ==Usage== | ||
In most cases, you should use the {{tl|documentation}} template. Refer to the template's documentation for usage instructions and parameters. | In most cases, you should use the {{tl|documentation}} template. Refer to the template's documentation for usage instructions and parameters. | ||
To use this module from another module, first <code>require</code> it: | To use this module from another module, first <code>require</code> it: | ||
| Line 16: | Line 14: | ||
Then call the function with a table of arguments: | Then call the function with a table of arguments: | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
documentation{content = 'Some documentation', ['link box'] = 'My custom link box'} | documentation{content = 'Some documentation', ['link box'] = 'My custom link box'} | ||
</syntaxhighlight> | </syntaxhighlight> | ||
{{Adapted from Wikipedia|Module:Documentation}} | {{Adapted from Wikipedia|Module:Documentation}} | ||
Revision as of 02:35, 15 June 2023
This subpage provides documentation for Module:Documentation.
This module displays a section containing documentation for templates, modules, or other pages. It implements the {{documentation}} template.
Usage
In most cases, you should use the {{documentation}} template. Refer to the template's documentation for usage instructions and parameters.
To use this module from another module, first require it:
local documentation = require('Module:Documentation').main
Then call the function with a table of arguments:
documentation{content = 'Some documentation', ['link box'] = 'My custom link box'}
This module was adapted from Module:Documentation on Wikipedia.
Adaptation is noted for reference and attribution only. This module may differ from the original in function or in usage.
Adaptation is noted for reference and attribution only. This module may differ from the original in function or in usage.