Diferencia entre revisiones de «Módulo:Hatnote list/doc»
(Basic docs) |
m (→Usage from Lua: tweak case to match usage elsewhere) |
||
| Línea 6: | Línea 6: | ||
== Usage from Lua == | == Usage from Lua == | ||
| − | To call the module, use <source lang="lua">local | + | To call the module, use <source lang="lua">local mHatList = require('Module:Hatnote list')</source> or similar, then access its methods through the <code>mHatList</code> variable (or whatever was used). |
===andList=== | ===andList=== | ||
Revisión del 20:01 8 abr 2016
| 26x26px | This module is rated as alpha. It is ready for third party input, and may be used on a few pages to see if problems arise, but should be watched. Suggestions for new features or changes in their input and output mechanisms are welcome. |
Usage from wikitext
This module cannot be used from wikitext.
Usage from Lua
To call the module, use <source lang="lua">local mHatList = require('Module:Hatnote list')</source> or similar, then access its methods through the mHatList variable (or whatever was used).
andList
andList takes a list in table form, and returns a string with the list separated with "and" and commas as appropriate.
orList
orList takes a list in table form, and returns a string with the list separated with "or" and commas as appropriate.
forSee
_forSee takes three arguments: a table of trimmed arguments with blanks removed, a "from" number with the index to start at, and an options table, and returns a string with a number of "For X, see [[Y]]" sentences. The links are formatted using the methods from Module:Hatnote.
As a convenience, the forSee method (without the leading underscore) takes the same arguments except with a frame instead of an args table, using getArgs() from Module:Arguments to preprocess the arguments.
