Module:Hatnote list: Difference between revisions
Jump to navigation
Jump to search
>Nihiltres (Moved form of for-see statement into options) |
>Nihiltres m (Changed some variable and structure names: forRow's second item is a table called "pages" instead of a table called "see" now; more logical naming) |
||
Line 78: | Line 78: | ||
if not args[i] then terminated = true end | if not args[i] then terminated = true end | ||
-- New empty list of pages | -- New empty list of pages | ||
forRow. | forRow.pages = {} | ||
-- If there's not at least one page listed, assume the list's ended, use | -- If there's not at least one page listed, assume the list's ended, use | ||
-- the default, and break at end of this loop-through. | -- the default, and break at end of this loop-through. | ||
table.insert(forRow. | 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 | -- 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 | -- items following "and"'s until the "and"'s stop. If there's a blank | ||
Line 87: | Line 87: | ||
while args[i + 2] == 'and' do | while args[i + 2] == 'and' do | ||
if args[i + 3] then | if args[i + 3] then | ||
table.insert(forRow. | table.insert(forRow.pages, args[i + 3]) | ||
end | end | ||
-- Increment to the next "and" | -- Increment to the next "and" | ||
Line 102: | Line 102: | ||
for k, v in pairs(forTable) do | for k, v in pairs(forTable) do | ||
local useStr = v.use | local useStr = v.use | ||
local | local pagesStr = p.andList(mHatnote.formatPages(unpack(v.pages))) | ||
table.insert(strList, string.format(options.forseeForm, useStr, | table.insert(strList, string.format(options.forseeForm, useStr, pagesStr)) | ||
end | end | ||
return mw.text.listToText(strList, ' ', ' ') | return mw.text.listToText(strList, ' ', ' ') |
Revision as of 10:29, 27 April 2016
Documentation for this module may be created at Module:Hatnote list/doc
-------------------------------------------------------------------------------- -- 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 (andTable) -- Stringifies a list with "and" local andString = (#andTable > 2 and mw.text.listToText(andTable, nil, ', and ')) or mw.text.listToText(andTable) return andString end function p.orList (orTable) -- Stringifies a list with "or" local orString = (#andTable > 2 and mw.text.listToText(andTable, nil, ', or ')) or mw.text.listToText(andTable, nil, ' or ') return orString 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 -- Each row's a table with one "use" string and one "see" table 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, assume the list's ended, use -- the default, and break at end of this loop-through. 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 mw.text.listToText(strList, ' ', ' ') end return p