Module:TOC/doc

From Miranda NG
Jump to navigation Jump to search

This is a documentation subpage for Module:TOC .
It contains usage information, categories and other content that is not part of the original template page.

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

Usage

Avaiable 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.