Module:Documentation/doc

This module implements Documentation and LuaDocumentation. It is best to see those pages, as they are mainly used there. It also has methods so it can be used in regular modules.

Loading the module
To load this module and make its method available for use, Add this line of code to the start of your module:

All methods described below will be available under the loaded table.

Alternatively, you can use this module using the code below by using Module:LoadLib.

Depending on the settings you used in, the methods of this module may be available under their respective variables in the module this module was loaded in.

Main function/Constructor
The table this module returns is a class, meaning you can call it as a normal function (Be sure to name the variable you require it under uppercase, as it is considered a best practice in coding to name classes uppercase). This also means you can use it as a normal module.

Syntax

 * - The template/module name to transclude the documentation subpage from. The namespace prefix depends on the type of documentation specified.
 * - The type of documentation box to display. This can be either Module or Template. Templates do not have a testcases unit, and will display a hidden template notice. Modules will have no notice, but will have a testcases unit. Each link in the module is changed according to the type specified. This defaults to Module.

Example

 * Produces:

Alternative Usage

 * Produces:

Methods
All methods are available below as fields under the required object name.

documentation.template
This method returns the documentation box in template mode with the transclusion title as. See for example output.

documentation.module
This method returns the documentation box in module mode with the transclusion title as. See for example output.

Exporting
This module comes with a configuration to make it easier to port it to other wikis and translate. This configuration can be found at Module:Documentation/Config. This is so you do not need to directly edit the code, just the configuration. All keys are commented to show which ones belong to which.

You can change the message values accordingly to your wiki's needs.