Jump to content

Module:TOCyears/doc: Difference between revisions

From Wikipedia, the free encyclopedia
Content deleted Content added
m Corrected a typo.
m change source to syntaxhighlight
Line 31: Line 31:
Load the module like this:
Load the module like this:


<source lang="lua">
<syntaxhighlight lang="lua">
local mTOC = require('Module:TOC')
local mTOC = require('Module:TOC')
</syntaxhighlight>
</source>


You can then use the functions with the following syntax:
You can then use the functions with the following syntax:


<source lang="lua">
<syntaxhighlight lang="lua">
mTOC.func(args)
mTOC.func(args)
</syntaxhighlight>
</source>


"func" should be changed to one of the Lua function names in the table above. These all start with an underscore ("_"). The <var>args</var> variable is a table of arguments to be passed to the function. Please see the template documentation for available arguments.
"func" should be changed to one of the Lua function names in the table above. These all start with an underscore ("_"). The <var>args</var> variable is a table of arguments to be passed to the function. Please see the template documentation for available arguments.

Revision as of 13:28, 7 July 2020

This module implements various table of contents (TOC) templates. At the moment, it implements {{TOCyears}} and {{List TOC}}.

Usage

Available functions

#invoke function Lua function Template
years _years {{TOCyears}}
list _list {{List TOC}}

From wikitext

From wikitext this module should usually be used through one of the templates in the table above. However, it is also possible to use it with the following syntax:

{{#invoke:TOC|function|args}}

The function names are listed in the table in the "#invoke function" column, and args are the arguments that would normally be added by the template. Please see the template documentation for each template for available parameters.

From Lua

Load the module like this:

local mTOC = require('Module:TOC')

You can then use the functions with the following syntax:

mTOC.func(args)

"func" should be changed to one of the Lua function names in the table above. These all start with an underscore ("_"). The args variable is a table of arguments to be passed to the function. Please see the template documentation for available arguments.