Módulo:Hatnote list/doc
Esta é a página de documentação de Módulo:Hatnote list
Esta é uma subpágina de documentação para Módulo:Hatnote list (Clique na ligação se você quer vê-la diretamente). Ela contém informações sobre o uso, categorias e outros conteúdos que não são parte da predefinição propriamente dita. |
Este módulo depende dos seguintes outros módulos: |
Usage from wikitext
[editar]This module is not designed be used directly from wikitext even though forSee
does take an initial frame
argument and could potentially be used from wikitext, e.g.:
{{hatnote|PREFIX {{#invoke:Hatnote list|forSee|{{tl|For}}|Module:For|{{tl|About}}|Module:About}} POSTFIX}}
→
Usage from Lua
[editar]To call the module, use
local mHatList = require('Module:Hatnote list')
or similar, then access its methods through the mHatList
variable (or whatever was used).
andList
[editar]andList
takes a list in table form, and returns a string with the list separated with "and" and commas as appropriate.
orList
[editar]orList
takes a list in table form, and returns a string with the list separated with "or" and commas as appropriate.
forSee
[editar]_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.