Module:Documentation/doc: Difference between revisions

From HIBIKIFORUM
Jump to navigation Jump to search
mNo edit summary
mNo edit summary
 
(One intermediate revision by the same user not shown)
Line 3: Line 3:
{{Uses TemplateStyles|Module:Documentation/styles.css}}
{{Uses TemplateStyles|Module:Documentation/styles.css}}


This module displays a wrapper container for documentation for templates, Lua modules, or other pages. The {{tl|documentation}} template invokes it.
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 {{tl|Documentation}} template; please see that template's page for its usage instructions and parameters.
For most uses, you should use the {{tlf|Documentation}} template; please see that template's page for its usage instructions and parameters.


== Use in other modules ==
== Use in other modules ==
Line 22: Line 22:
</syntaxhighlight>
</syntaxhighlight>


Please refer to the [[Template:Documentation/doc|template documentation]] for usage instructions and a list of parameters.
Please refer to the template documentation for usage instructions and a list of parameters.


<includeonly>{{sandbox other||{{testcases other||
<includeonly>{{sandbox other||{{testcases other||

Latest revision as of 02:08, 12 June 2023

Light bulb.png }}
It contains usage information, categories and other content that is not part of the original module page.

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.