Module:Hatnote list: Difference between revisions
Content added Content deleted
m (Actually applied andList's formatted option in forSeeTableToString) |
(Updated from sandbox) |
||
Line 45: | Line 45: | ||
-- Set the separator; if any item contains it, use the alternate separator |
-- Set the separator; if any item contains it, use the alternate separator |
||
local separator = options.separator |
local separator = options.separator |
||
--searches display text only |
|||
function searchDisp(t, f) |
|||
return string.find(string.sub(t, (string.find(t, '|') or 0) + 1), f) |
|||
⚫ | |||
for k, v in pairs(list) do |
for k, v in pairs(list) do |
||
if |
if searchDisp(v, separator) then |
||
separator = options.altSeparator |
separator = options.altSeparator |
||
break |
break |
||
Line 53: | Line 57: | ||
-- Set the conjunction, apply Oxford comma, and force a comma if #1 has "§" |
-- Set the conjunction, apply Oxford comma, and force a comma if #1 has "§" |
||
local conjunction = s .. options.conjunction .. s |
local conjunction = s .. options.conjunction .. s |
||
if #list == 2 and |
if #list == 2 and searchDisp(list[1], "§") or #list > 2 then |
||
conjunction = separator .. conjunction |
conjunction = separator .. conjunction |
||
end |
end |
||
Line 60: | Line 64: | ||
end |
end |
||
--DRY function |
|||
-- Stringifies a list with "and" |
|||
function |
function conjList (conj, list, fmt) |
||
return stringifyList(list, {conjunction = |
return stringifyList(list, {conjunction = conj, formatted = fmt}) |
||
end |
end |
||
-- Stringifies |
-- Stringifies lists with "and" or "or" |
||
function p. |
function p.andList (...) return conjList("and", ...) end |
||
function p.orList (...) return conjList("or", ...) end |
|||
return stringifyList(list, {conjunction = "or", formatted = formatted}) |
|||
⚫ | |||
-------------------------------------------------------------------------------- |
-------------------------------------------------------------------------------- |
||
Line 79: | Line 82: | ||
--default options table used across the forSee family of functions |
--default options table used across the forSee family of functions |
||
local forSeeDefaultOptions = { |
local forSeeDefaultOptions = { |
||
andKeyword = 'and', |
|||
title = mw.title.getCurrentTitle().text, |
title = mw.title.getCurrentTitle().text, |
||
otherText = 'other uses', |
otherText = 'other uses', |
||
forSeeForm = 'For %s, see %s.' |
|||
⚫ | |||
punctuationCollapseReplacements = { |
|||
--Collapses duplicate punctuation |
|||
function punctuationCollapse (text) |
|||
local replacements = { |
|||
["%.%.$"] = ".", |
["%.%.$"] = ".", |
||
["%?%.$"] = "?", |
["%?%.$"] = "?", |
||
Line 90: | Line 98: | ||
["%!%]%]%.$"] = "!]]" |
["%!%]%]%.$"] = "!]]" |
||
} |
} |
||
for k, v in pairs(replacements) do text = string.gsub(text, k, v) end |
|||
⚫ | |||
return text |
|||
⚫ | |||
-- Structures arguments into a table for stringification, & options |
-- Structures arguments into a table for stringification, & options |
||
Line 108: | Line 118: | ||
if type(k) == 'number' and k > maxArg then maxArg = k end |
if type(k) == 'number' and k > maxArg then maxArg = k end |
||
end |
end |
||
-- Structure the data out from the parameter list |
-- Structure the data out from the parameter list: |
||
-- forTable is the wrapper table, with forRow rows |
-- * forTable is the wrapper table, with forRow rows |
||
-- Rows are tables of a "use" string |
-- * Rows are tables of a "use" string & a "pages" table of pagename strings |
||
-- * Blanks are left empty for defaulting elsewhere, but can terminate list |
|||
local forTable = {} |
local forTable = {} |
||
local i = from |
local i = from |
||
local terminated = false |
local terminated = false |
||
-- |
-- Loop to generate rows |
||
repeat |
repeat |
||
-- New empty row |
-- New empty row |
||
local forRow = {} |
local forRow = {} |
||
-- |
-- On blank use, assume list's ended & break at end of this loop |
||
-- defaulting elsewhere, and break at the end of this loop-through. |
|||
forRow.use = args[i] |
forRow.use = args[i] |
||
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.pages = {} |
forRow.pages = {} |
||
-- |
-- Insert first pages item if present |
||
table.insert(forRow.pages, args[i + 1]) |
table.insert(forRow.pages, args[i + 1]) |
||
-- If the |
-- If the param after next is "and", do inner loop to collect params |
||
-- |
-- until the "and"'s stop. Blanks are ignored: "1|and||and|3" → {1, 3} |
||
⚫ | |||
-- where we'd expect an item, ignore it: "1|and||and|3" → {1, 3} |
|||
⚫ | |||
if args[i + 3] then |
if args[i + 3] then |
||
table.insert(forRow.pages, args[i + 3]) |
table.insert(forRow.pages, args[i + 3]) |
||
end |
end |
||
-- Increment to |
-- Increment to next "and" |
||
i = i + 2 |
i = i + 2 |
||
end |
end |
||
-- Increment to |
-- Increment to next use |
||
i = i + 2 |
i = i + 2 |
||
-- |
-- Append the row |
||
table.insert(forTable, forRow) |
table.insert(forTable, forRow) |
||
until terminated or i > maxArg |
until terminated or i > maxArg |
||
Line 145: | Line 154: | ||
end |
end |
||
-- |
-- Stringifies a table as formatted by forSeeArgsToTable |
||
function p.forSeeTableToString (forSeeTable, options) |
function p.forSeeTableToString (forSeeTable, options) |
||
-- Type-checks and defaults |
-- Type-checks and defaults |
||
Line 154: | Line 163: | ||
if options[k] == nil then options[k] = v end |
if options[k] == nil then options[k] = v end |
||
end |
end |
||
-- |
-- Stringify each for-see item into a list |
||
local strList = {} |
local strList = {} |
||
for k, v in pairs(forSeeTable) do |
for k, v in pairs(forSeeTable) do |
||
Line 160: | Line 169: | ||
local pagesStr = p.andList(v.pages, true) or |
local pagesStr = p.andList(v.pages, true) or |
||
mHatnote._formatLink(mHatnote.disambiguate(options.title)) |
mHatnote._formatLink(mHatnote.disambiguate(options.title)) |
||
local forSeeStr = string.format(options. |
local forSeeStr = string.format(options.forSeeForm, useStr, pagesStr) |
||
⚫ | |||
for k, v in pairs(options.punctuationCollapseReplacements) do |
|||
⚫ | |||
⚫ | |||
table.insert(strList, forSeeStr) |
table.insert(strList, forSeeStr) |
||
end |
end |
||
Line 171: | Line 178: | ||
-- Produces a "For X, see [[Y]]" string from arguments. Expects index gaps |
-- Produces a "For X, see [[Y]]" string from arguments. Expects index gaps |
||
-- but not blank |
-- but not blank/whitespace values. Ignores named args and args < "from". |
||
-- arguments less than "from", and named arguments. |
|||
function p._forSee (args, from, options) |
function p._forSee (args, from, options) |
||
local forSeeTable = p.forSeeArgsToTable(args, from, options) |
local forSeeTable = p.forSeeArgsToTable(args, from, options) |
||
Line 178: | Line 184: | ||
end |
end |
||
-- |
-- As _forSee, but uses the frame. |
||
function p.forSee (frame, from, options) |
function p.forSee (frame, from, options) |
||
mArguments = require('Module:Arguments') |
mArguments = require('Module:Arguments') |