Module:Hatnote list: Difference between revisions

Jump to navigation Jump to search

Module:Hatnote list (view source)

Revision as of 12:25, 5 May 2016

3,228 bytes added ,  5 May 2016
Updated from sandbox
>Nihiltres
(Simplified p.forSee)
>Nihiltres
(Updated from sandbox)
Line 1: Line 1:
--------------------------------------------------------------------------------
--------------------------------------------------------------------------------
-- For see
--                           Module:Hatnote list                              --
--
--                                                                            --
-- Makes a "For X, see [[Y]]." list from raw parameters. Intended for the
-- This module produces and formats lists for use in hatnotes. In particular, --
-- {{about}} and {{redirect}} templates and their variants. Also incidentally
-- it implements the for-see list, i.e. lists of "For X, see Y" statements,  --
-- introduces andList & orList helpers, useful for other hatnote lists.
-- as used in {{about}}, {{redirect}}, and their variants. Also introduced    --
-- are andList & orList helpers for formatting lists with those conjunctions. --
--------------------------------------------------------------------------------
--------------------------------------------------------------------------------


Line 13: Line 14:
local p = {}
local p = {}


--------------------------------------------------------------------------------
-- List stringification helper functions
--
-- These functions are used for stringifying lists, usually page lists inside
-- the "Y" portion of "For X, see Y" for-see items.
--------------------------------------------------------------------------------
--default options table used across the list stringification functions
local stringifyListDefaultOptions = {
conjunction = "and",
separator = ",",
altSeparator = ";",
space = " "
}
-- Stringifies a list generically; probably shouldn't be used directly
function stringifyList(list, options)
-- Type-checks, defaults, and a shortcut
checkType("stringifyList", 1, list, "table")
if #list == 0 then return nil end
checkType("stringifyList", 2, options, "table", true)
options = options or {}
for k, v in pairs(stringifyListDefaultOptions) do
if options[k] == nil then options[k] = v end
end
local s = options.space
-- Set the separator; if any item contains it, use the alternate separator
local separator = options.separator
for k, v in pairs(list) do
if string.find(v, separator) then
separator = options.altSeparator
break
end
end
-- Set the conjunction, apply Oxford comma, and force a comma if #1 has "§"
local conjunction = s .. options.conjunction .. s
if #list == 2 and string.find(list[1], "§") or #list > 2 then
conjunction = separator .. conjunction
end
-- Return the formatted string
return mw.text.listToText(list, separator .. s, conjunction)
end
-- Stringifies a list with "and"
function p.andList (list)
function p.andList (list)
-- Stringifies a list with "and"
return stringifyList(list, {conjunction = "and"})
return mw.text.listToText(list, nil, (#list > 2 and ',' or '') .. ' and ')
end
end


-- Stringifies a list with "or"
function p.orList (list)
function p.orList (list)
-- Stringifies a list with "or"
return stringifyList(list, {conjunction = "or"})
return mw.text.listToText(list, nil, (#list > 2 and ',' or '') .. ' or ')
end
end


function p.forSee (frame, from, options)
--------------------------------------------------------------------------------
-- Calls _forSee but pulls from the frame.
-- For see
mArguments = require('Module:Arguments')
--
return p._forSee(mArguments.getArgs(frame), from, options)
-- Makes a "For X, see [[Y]]." list from raw parameters. Intended for the
end
-- {{about}} and {{redirect}} templates and their variants.
--------------------------------------------------------------------------------


function p._forSee (args, from, options)
--default options table used across the forSee family of functions
-- Produces a "For X, see [[Y]]" string from arguments. Expects index gaps
local forSeeDefaultOptions = {
-- but not blank or whitespace values; those should be filtered. Ignores
disambiguator = ' (disambiguation)',
-- arguments less than "from", and named arguments.
title = mw.title.getCurrentTitle().text,
otherText = 'other uses',
forseeForm = 'For %s, see %s.',
punctuationCollapseReplacements = {
["%.%.$"] = ".",
["%?%.$"] = "?",
["%!%.$"] = "!",
["%.%]%]%.$"] = ".]]",
["%?%]%]%.$"] = "?]]",
["%!%]%]%.$"] = "!]]"
}
}


-- Structures arguments into a table for stringification, & options
function p.forSeeArgsToTable (args, from, options)
-- Type-checks and defaults
-- Type-checks and defaults
checkType("_forSee", 1, args, 'table')
checkType("forSeeArgsToTable", 1, args, 'table')
checkType("_forSee", 2, from, 'number', true)
checkType("forSeeArgsToTable", 2, from, 'number', true)
from = from or 1
from = from or 1
checkType("_forSee", 3, options, 'table', true)
checkType("forSeeArgsToTable", 3, options, 'table', true)
options = options or {}
options = options or {}
local defaultOptions = {
for k, v in pairs(forSeeDefaultOptions) do
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
if options[k] == nil then options[k] = v end
end
end
-- maxArg's gotten manually because getArgs() and table.maxn aren't friends
-- maxArg's gotten manually because getArgs() and table.maxn aren't friends
local maxArg = 0
local maxArg = 0
Line 55: Line 106:
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
Line 89: Line 139:
table.insert(forTable, forRow)
table.insert(forTable, forRow)
until terminated or i > maxArg
until terminated or i > maxArg
return forTable
end


-- Stringify the table, which is easy because it's structured now
-- Takes a table as formatted by forSeeArgsToTable and stringifies it
function p.forSeeTableToString (forSeeTable, options)
-- Type-checks and defaults
checkType("forSeeTableToString", 1, forSeeTable, "table")
checkType("forSeeTableToString", 2, options, "table", true)
options = options or {}
for k, v in pairs(forSeeDefaultOptions) do
if options[k] == nil then options[k] = v end
end
-- Format each for-see item and make a table containing them
local strList = {}
local strList = {}
for k, v in pairs(forTable) do
for k, v in pairs(forSeeTable) do
local useStr = v.use
local useStr = v.use or options.otherText
local pagesStr = p.andList(mHatnote.formatPages(unpack(v.pages)))
local pagesStr = p.andList(mHatnote.formatPages(unpack(v.pages))) or
table.insert(strList, string.format(options.forseeForm, useStr, pagesStr))
mHatnote._formatLink(options.title .. options.disambiguator)
local forSeeStr = string.format(options.forseeForm, useStr, pagesStr)
for k, v in pairs(options.punctuationCollapseReplacements) do
forSeeStr = string.gsub(forSeeStr, k, v)
end
table.insert(strList, forSeeStr)
end
end
-- Return the concatenated list
return table.concat(strList, ' ')
return table.concat(strList, ' ')
end
-- 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.
function p._forSee (args, from, options)
local forSeeTable = p.forSeeArgsToTable(args, from, options)
return p.forSeeTableToString(forSeeTable, options)
end
-- Calls _forSee but pulls from the frame.
function p.forSee (frame, from, options)
mArguments = require('Module:Arguments')
return p._forSee(mArguments.getArgs(frame), from, options)
end
end


return p
return p
Anonymous user
Retrieved from "https://wiki.randomisland.ca/wiki/Special:MobileDiff/3249"

Navigation menu