Module:homophones

local export = {}

local links_module = "Module:links" local parameter_utilities_module = "Module:parameter utilities" local pron_qualifier_module = "Module:pron qualifier"

--[==[ Meant to be called from a module. `data` is a table containing the following fields: passed to {full_link} in Module:links except for `lang` and `sc` (which are copied from the outer level), and in addition can contain left and right regular and accent qualifier fields: ** `term`: the homophone itself; ** `separator`: {nil} or the string used to separate this homophone from the preceding one when displayed; defaults to    the top-level `separator`; ** `alt`: display text for the homophone, as in l; ** `gloss`: gloss for the homophone, as in l;  ** `tr`: transliteration for the homophone, as in l;  ** `ts`: transcription for the homophone, as in l;  ** `genders`: list of genders for the homophone, as in l;  ** `pos`: part of speech of the homophone, as in l;  ** `lit`: literal meaning of the homophone, as in l;  ** `id`: sense ID for the homophone, as in l;  ** `lang`: optional lang code, overriding the lang code in the top-level `lang` field; ** `sc`: optional script code, overriding the script code in the top-level `sc` field; ** `q`: {nil} or a list of left regular qualifier strings, formatted using {format_qualifier} in Module:qualifier and displayed directly before the homophone in question; ** `qq`: {nil} or a list of right regular qualifier strings, displayed directly after the homophone in question; ** `qualifiers`: {nil} or a list of qualifier strings; currently displayed on the right but that may change; for compatibility purposes only, do not use in new code; ** `a`: {nil} or a list of left accent qualifier strings, formatted using {format_qualifiers} in    Module:accent qualifier and displayed directly before the homophone in question; ** `aa`: {nil} or a list of right accent qualifier strings, displayed directly after the homophone in question; ** `refs`: {nil} or a list of references or reference specs to add after the pronunciation and any posttext and qualifiers; the value of a list item is either a string containing the reference text (typically a call to a	 citation template such as cite-book, or a template wrapping such a call), or an object with fields `text` (the reference text), `name` (the name of the reference, as in 	 or ) and/or `group` (the group of the reference, as in	 or	 ); this uses a parser function to format the reference appropriately and insert a footnote number that hyperlinks to the actual reference, located in the section; {", "}; overridable at the individual homophone level; and displayed before the initial caption; Module:accent qualifier and dispalyed before the initial caption; or {"Homophones"} (otherwise); a colon and space is automatically added after the caption;
 * `lang`: language object for the homophones;
 * `homophones`: a list of homophones, each described by an object which can contain all the fields in the object
 * `separator`: {nil} or a string, specifying the separator displayed before all homophones but the first; by default,
 * `q`: {nil} or a list of left regular qualifier strings, formatted using {format_qualifier} in Module:qualifier
 * `qq`: {nil} or a list of right regular qualifier strings, displayed after all homophones;
 * `a`: {nil} or a list of left accent qualifier strings, formatted using {format_qualifiers} in
 * `aa`: {nil} or a list of right accent qualifier strings, displayed after all homophones;
 * `sc`: {nil} or script object for the homophones;
 * `sort`: {nil} or sort key;
 * `caption`: {nil} or string specifying the caption to use, in place of {"Homophone"} (if there is a single homophone),
 * `nocaption`: If true, suppress the caption display.
 * `nocat`: If true, suppress categorization.

If both regular and accent qualifiers on the same side and at the same level are specified, the accent qualifiers precede the regular qualifiers on both left and right.

WARNING: Destructively modifies the objects inside the `homophones` field. ]==] function export.format_homophones(data) local hmptexts = {} local hmpcats = {}

local m_links = require(links_module) local overall_sep = data.separator or ", " for i, hmp in ipairs(data.homophones) do		hmp.lang = hmp.lang or data.lang hmp.sc = hmp.sc or data.sc		local text = m_links.full_link(hmp) if hmp.q and hmp.q[1] or hmp.qq and hmp.qq[1] or hmp.qualifiers and hmp.qualifiers[1] or hmp.a and hmp.a[1] or hmp.aa and hmp.aa[1] or hmp.refs and hmp.refs[1] then -- FIXME, change handling of `qualifiers` text = require(pron_qualifier_module).format_qualifiers { lang = hmp.lang, text = text, q = hmp.q,				qq = hmp.qq, qualifiers = hmp.qualifiers, qualifiers_right = true, a = hmp.a,				aa = hmp.aa, refs = hmp.refs, }		end table.insert(hmptexts, hmp.separator or i > 1 and overall_sep or "") table.insert(hmptexts, text) end

table.insert(hmpcats, data.lang:getFullName .. " terms with homophones") local text = table.concat(hmptexts) local caption = data.nocaption and "" or (		data.caption or "Homophone" .. (#data.homophones > 1 and "s" or "") .. ""	) .. ": "	text = caption .. text if data.q and data.q[1] or data.qq and data.qq[1] or data.a and data.a[1] or data.aa and data.aa[1] then text = require(pron_qualifier_module).format_qualifiers { lang = data.lang, text = text, q = data.q,			qq = data.qq, a = data.a,			aa = data.aa, }	end text = "" .. text .. " "	if not data.nocat then local categories = require("Module:utilities").format_categories(hmpcats, data.lang, data.sort) text = text .. categories end return text end

--[==[ Entry point for homophones template (also written homophone and hmp). ]==] function export.show(frame) local parent_args = frame:getParent.args local compat = parent_args.lang local offset = compat and 0 or 1 local lang_arg = compat and "lang" or 1

local params = { [lang_arg] = {required = true, type = "language", default = "en"}, [1 + offset] = {list = true, required = true, allow_holes = true, default = "term"}, ["caption"] = {}, ["nocaption"] = {type = "boolean"}, ["nocat"] = {type = "boolean"}, ["sort"] = {}, }

local m_param_utils = require(parameter_utilities_module)

local param_mods = m_param_utils.construct_param_mods { {group = {"link", "ref", "a", "q"}}, }	local homophones, args = m_param_utils.process_list_arguments { params = params, param_mods = param_mods, raw_args = parent_args, process_args_before_parsing = function(args) -- FIXME: temporary. if args.q.default then error("Use of q= in Template:homophones no longer permitted; use qq1=; in a month or two, q= will return as an overall left qualifier") end if args.q.maxindex > 0 then error("Use of qN= in Template:homophones no longer permitted; use qqN=; in a month or two, qN= will return as left qualifiers") end end, termarg = 1 + offset, parse_lang_prefix = true, track_module = "homophones", lang = lang_arg, sc = "sc.default", }

local data = { lang = args[lang_arg], homophones = homophones, caption = args.caption, nocaption = args.nocaption, nocat = args.nocat, sc = args.sc.default, sort = args.sort, q = args.q.default, qq = args.qq.default, a = args.a.default, aa = args.aa.default, }

return export.format_homophones(data) end

return export