Module:Hatnote list
This Lua module is used on 894,000+ pages, or roughly 13578% of all pages. To avoid major disruption and server load, any changes should be tested in the module's /sandbox or /testcases subpages, or in your own module sandbox. The tested changes can be added to this page in a single edit. Consider discussing changes on the talk page before implementing them. |
This module is used in MediaWiki:Wantedpages-summary. Changes to it can cause immediate changes to the Wikipedia user interface. To avoid large-scale disruption, any changes should first be tested in this module's /sandbox or /testcases subpage, or in your own user space. The tested changes can then be added in one single edit to this module. Please discuss any changes on the talk page before implementing them. |
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}}
→PREFIX Lua error at line 99: attempt to call field 'formatPages' (a nil value). POSTFIX
Usage from Lua
To call the module, use <syntaxhighlight lang="lua">local mHatList = require('Module:Hatnote list')</syntaxhighlight> 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.
-------------------------------------------------------------------------------- -- For see -- -- Makes a "For X, see [[Y]]." list from raw parameters. Intended for the -- {{about}} and {{redirect}} templates and their variants. Also incidentally -- introduces andList & orList helpers, useful for other hatnote lists. -------------------------------------------------------------------------------- local mArguments --initialize lazily local mHatnote = require('Module:Hatnote') local libraryUtil = require('libraryUtil') local checkType = libraryUtil.checkType local p = {} function p.andList (list) -- Stringifies a list with "and" return mw.text.listToText(list, nil, (#list > 2 and ',' or '') .. ' and ') end function p.orList (list) -- Stringifies a list with "or" return mw.text.listToText(list, nil, (#list > 2 and ',' or '') .. ' or ') end function p.forSee (frame, from, options) -- Calls _forSee but pulls from the frame. mArguments = require('Module:Arguments') getArgs = mArguments.getArgs local args = getArgs(frame) return p._forSee(args, from, options) end function p._forSee (args, from, options) -- Produces a "For X, see [[Y]]" string from arguments. Expects index gaps -- but not blank or whitespace values; those should be filtered. Ignores -- arguments less than "from", and named arguments. -- Type-checks and defaults checkType("_forSee", 1, args, 'table') checkType("_forSee", 2, from, 'number', true) from = from or 1 checkType("_forSee", 3, options, 'table', true) options = options or {} local defaultOptions = { disambiguator = ' (disambiguation)', forseeForm = 'For %s, see %s.', title = mw.title.getCurrentTitle().text, otherText = 'other uses' } for k, v in pairs(defaultOptions) do if options[k] == nil then options[k] = v end end -- maxArg's gotten manually because getArgs() and table.maxn aren't friends local maxArg = 0 for k, v in pairs(args) do if type(k) == 'number' and k > maxArg then maxArg = k end end -- Structure the data out from the parameter list -- forTable is the wrapper table, with forRow rows -- Rows are tables of a "use" string and a "pages" table of pagename strings local forTable = {} local i = from local terminated = false -- Repeat to generate and append each row repeat -- New empty row local forRow = {} -- If there's a blank use, assume the list's ended, use the default, -- and break at the end of this loop-through. forRow.use = args[i] or options.otherText if not args[i] then terminated = true end -- New empty list of pages forRow.pages = {} -- If there's not at least one page listed, use the default. table.insert(forRow.pages, args[i + 1] or (options.title .. options.disambiguator)) -- If the option after next is "and", do an inner loop where we collect -- items following "and"'s until the "and"'s stop. If there's a blank -- where we'd expect an item, ignore it: "1|and||and|3" → {1, 3} while args[i + 2] == 'and' do if args[i + 3] then table.insert(forRow.pages, args[i + 3]) end -- Increment to the next "and" i = i + 2 end -- Increment to the next use i = i + 2 -- Add the row to the table table.insert(forTable, forRow) until terminated or i > maxArg -- Stringify the table, which is easy because it's structured now local strList = {} for k, v in pairs(forTable) do local useStr = v.use local pagesStr = p.andList(mHatnote.formatPages(unpack(v.pages))) table.insert(strList, string.format(options.forseeForm, useStr, pagesStr)) end return table.concat(strList, ' ') end return p