Template:Helper module

Template documentation

This documentation is transcluded from Template:Helper module/doc. [edit] [history] [purge]

Template:Helper module invokes function main in Module:Helper module using Lua.

{{#ifeq:Template|Module|

{{#replace:Template:Helper module|/doc}} is invoked by Template:Helper module.{{#ifeq:{{{category}}}|no||{{#ifeq:Helper module|doc||}}}}

|

{{#replace:Template:Helper module|/doc}} invokes Module:Helper module using Lua.{{#ifeq:{{{category}}}|no||{{#ifeq:Helper module|doc||}}}}

}}

Provides documentation for functions of modules that contain functions useful for other modules. This template should be part of a comment, and should be at the top of the source code, before any <pre> or <nowiki> tags. There is no limit to the number of functions this template can list.

This template is called by OtherX:Lua/Helper modules to help produce a dynamic table.

{{Helper module
|name = Name of the module (no namespace prefix)
|fname1 = Name of first function as it is called in modules
|ftype1 = Argument types of parameters
|fuse1 = Purpose of the function
...
|fname# = Name of tenth function as it is called in modules
|ftype# = Argument types of parameters
|fuse# = Purpose of the function
}}