This module implements {{Documentation}}.
Installation
Dependencies
Documentation
Package items
documentation.main(args)(function)- This function defines logic flow for the module. ; Messages:
- 'main-div-id' --> 'template-documentation'
- 'main-div-classes' --> 'template-documentation iezoomfix'
- Parameter:
args- table of arguments passed by the user (table|Frame) - Returns: (string)
documentation.startBox(args, env)(function)- This function generates the start box. The actual work is done by p.makeStartBoxLinksData and p.renderStartBoxLinks which make the [view] [edit] [history] [purge] links, and by p.makeStartBoxData and p.renderStartBox which generate the box HTML.
- Parameters:
args- a table of arguments passed by the user (table|Frame)env- environment table containing title objects, etc., generated with p.getEnvironment (Environment; optional)
- Returns: (string|nil)
documentation.content(args, env)(function)- Displays the documentation contents ; Messages
- 'content-box-div-classes' --> 'template-documentation-content'
- Parameters:
args- a table of arguments passed by the user (table|Frame)env- environment table containing title objects, etc., generated with p.getEnvironment (Environment; optional)
- Returns: (string)
documentation.contentTitle(args, env)(function)- Gets the content title
- Parameters:
args- a table of arguments passed by the user (table|Frame)env- environment table containing title objects, etc., generated with p.getEnvironment (Environment; optional)
- Returns: (string)
documentation.endBox(args, env)(function)- This function generates the end box (also known as the link box). The HTML is generated by the
{{fmbox}}template, courtesy of Module:Message box. ; Messages:- 'fmbox-id' --> 'documentation-meta-data'
- 'fmbox-style' --> 'background-color: #ecfcf4'
- 'fmbox-textstyle' --> 'font-style: italic'
- Parameters:
args- a table of arguments passed by the user (table|Frame)env- environment table containing title objects, etc., generated with p.getEnvironment (Environment; optional)
- Returns: (string)
See also