Template:Lua Install/doc — dev

About this template

Description: This template instructs users on how to install global Lua modules on their wiki.
Syntax: Note that all the parameters are optional. See #Parameters for defaults.

{{Lua Install|modulepage = <module pagename>|function = <name of function to use>|invocable = <1/0>|moduleinv = <{{t|{{{modulepage}}}|function|...|i=1}}>|template = <1/0>|templatepage = <template pagename>|templateinv = <{{t|{{{modulepage}}}|function|i=1}}>|templateuse = <{{t|{{{templatepage}}}|...}}>|stylesheet = <1/0>|stylepage = <PAGENAME>}}

Dependencies: Module:Install and Module:I18n.
Translation: The template translations are stored at:

Preview

{{Lua Install
| modulepage = Sandbox
| invocable  = 1
}}

Lua installation

Module:

Create Module:Sandbox on your wiki with the following code:

return require('Dev:Sandbox')

Module invocation:

The module can be invoked with the following syntax:

{{#invoke:Sandbox|main|<...>}}

Template:

Create Template:Sandbox on your wiki with the following code:

{{#invoke:Sandbox|main}}

Template usage:

The template can be used with the following syntax:

{{Sandbox|<...>}}

Parameters

modulepage: Purpose: Page name of the module. It's assumed to be in the Module namespace, so don't include the namespace name.; Default: {{SUBPAGENAME}}.
function: Purpose: Entrypoint function of the module.; Default: main.
invocable: Purpose: Whether the module supports direct invocation outside of its module using {{#invoke}}. Accepts 1 or 0.; Default: 0 (false).
moduleinv: Dependency: invocable = 1; Purpose: Custom module invocation (optional). Use {{t|i = 1}}.; Default: {{t|{{{modulepage}}}|{{{function|main}}}|...|i = 1}}.
template: Purpose: Whether the module supports templating via the main entry point or the specified function. Accepts 1 or 0.; Default: 1 (true).
templatepage: Dependency: template = 1; Purpose: Page name of the template. It's assumed to be in the Template namespace, so don't include the namespace name.; Default: {{{modulepage}}}.
templateinv: Dependency: template = 1; Purpose: Custom template invocation (optional). Use {{t|i = 1}}.; Default: {{t|{{{modulepage}}}|{{{function|main}}}|i = 1}}.
templateuse: Dependency: template = 1; Purpose: Custom template usage (optional). Use {{t}}.; Default: {{t|{{{templatepage}}}|...}}.
stylesheet: Purpose: Boolean - whether the module has styling (accepts 1 or 0).; Default: 0
stylepage: Dependency: stylesheet = 1; Purpose: Pagename of CSS styling (without extension or namespace).; Default: Global Lua Modules/{{{modulepage}}}

TemplateData

Instructs users on how to install global Lua modules on their wiki.

Template parameters
Parameter		Description	Type	Status
Module Page	`modulepage`	Custom module name. It's assumed to be in the "Module:" namespace, so don't include the namespace name. Default {{SUBPAGENAME}}	String	optional
Invocable	`invocable`	Whether the module supports direct invocation outside of its template via {{#invoke}}. Default 0	Boolean	optional
Module Invocation	`moduleinv`	Custom module usage. Default {{t\|{{{modulepage}}}\|main\|...\|i=1}}	Content	optional
Template	`template`	Whether the module has an accompanying template. Default 1	Boolean	optional
Template Page	`templatepage`	Custom template name. It's assumed to be in the "Template:" namespace, so don't include the namespace name. Default {{{modulepage}}}	Template	optional
Template Contents	`templateinv`	Custom template contents. Default {{t\|{{{modulepage}}}\|main\|i=1}}	Content	optional
Template Usage	`templateuse`	Custom template usage. Default {{t\|{{{templatepage}}}\|...}}	Content	optional
Requires StyleSheet	`stylesheet`	Whether the module has a StyleSheet that needs to be installed. Default 0	Boolean	optional
StyleSheet Page	`stylepage`	Custom CSS page name. It's assumed to be in the "MediaWiki:" namespace and have the ".css" extension, so don't include the namespace name or the file extension. Default Global_Lua_Modules/{{{modulepage}}}	String	optional