Mòideal:Hatnote list/doc

O Wiktionary

This is the documentation page for Mòideal:Hatnote list

(deasbaireachd⧼tpt-languages-separator⧽deasaich⧼tpt-languages-separator⧽eachdraidh⧼tpt-languages-separator⧽ceanglaichean⧼tpt-languages-separator⧽doc⧼tpt-languages-separator⧽bogsa-gainmhich⧼tpt-languages-separator⧽cùisean deuchainn)

Ùsaid bho uiciteacsa - Usage from wikitext

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}}

Ùsaid bho Lua - Usage from Lua

To call the module, use

local mHatList = require('Mòideal:Hatnote list')

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 Mòideal: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 Mòideal:Arguments to preprocess the arguments.