local export = {}
local force_cat = false -- for testing
local function tag_rhyme(rhyme, lang)
local formatted_rhyme, cat
-- FIXME, should not be here. Telugu should use IPA as well.
if lang:getCode() == "te" then
formatted_rhyme = require("Module:script utilities").tag_text(rhyme, lang)
cat = ""
else
formatted_rhyme, cat = require("Module:IPA").format_IPA(lang, rhyme, true)
end
return formatted_rhyme, cat
end
local function make_rhyme_link(lang, link_rhyme, display_rhyme)
local retval
if not link_rhyme then
retval = table.concat{"[[Rhymes:", lang:getCanonicalName(), "|", lang:getCanonicalName(), "]]"}
else
local formatted_rhyme, cat = tag_rhyme(display_rhyme or link_rhyme, lang)
retval = table.concat{"[[Rhymes:", lang:getCanonicalName(), "/", link_rhyme, "|", formatted_rhyme, "]]", cat}
end
return retval
end
function export.show_row(frame)
local params = {
[1] = {required = true},
[2] = {required = true},
[3] = {},
}
local args = frame.getParent and frame:getParent().args or frame
if (not args[1] or args[1] == "") and mw.title.getCurrentTitle().nsText == "Template" then
return '[[Rhymes:English/aɪmz|<span class="IPA">-aɪmz</span>]]'
end
local args = require("Module:parameters").process(args, params)
local lang = require("Module:languages").getByCode(args[1], 1)
return make_rhyme_link(lang, args[2], "-" .. args[2]) .. (args[3] and (" (''" .. args[3] .. "'')") or "")
end
local function add_syllable_categories(categories, lang, rhyme, num_syl)
local prefix = "Rhymes:" .. lang .. "/" .. rhyme
table.insert(categories, prefix)
if num_syl then
for _, n in ipairs(num_syl) do
local c
if n > 1 then
c = prefix .. "/" .. n .. " syllables"
else
c = prefix .. "/1 syllable"
end
table.insert(categories, c)
end
end
end
--[=[
Meant to be called from a module. `data` is a table in the following format:
{
lang = LANGUAGE_OBJECT,
rhymes = {
{rhyme = "RHYME",
q = nil or {"LEFT_QUALIFIER", "LEFT_QUALIFIER", ...},
qualifiers = nil or {"LEFT_QUALIFIER", "LEFT_QUALIFIER", ...},
qq = nil or {"RIGHT_QUALIFIER", "RIGHT_QUALIFIER", ...},
a = nil or {"LEFT_ACCENT_QUALIFIER", "LEFT_ACCENT_QUALIFIER", ...},
aa = nil or {"RIGHT_ACCENT_QUALIFIER", "RIGHT_ACCENT_QUALIFIER", ...},
num_syl = nil or {#SYL, #SYL, ...}
}, ...},
qualifiers = nil or {"QUALIFIER", "QUALIFIER", ...},
num_syl = nil or {#SYL, #SYL, ...},
caption = nil or "CAPTION",
nocaption = BOOLEAN,
sort = nil or "SORTKEY",
force_cat = BOOLEAN,
}
Here:
* `lang` is a language object.
* `rhymes` is the list of rhymes to display. RHYME is the IPA rhyme, without initial hyphen. LEFT_QUALIFIER is a
qualifier string to display before the specific rhyme in question, formatted using format_qualifier() in
[[Module:qualifier]]. RIGHT_QUALIFIER similarly displays after the rhyme. LEFT_ACCENT_QUALIFIER is an accent qualifier
(as in {{a}}) to display before the rhyme, and RIGHT_ACCENT_QUALIFIER similarly displays after the rhyme.
#SYL is the number of syllables of the word or words containing this rhyme, for categorization purposes (see below).
* `qualifiers` (at top level), if non-nil, is a list of qualifier strings to display after the caption "Rhymes:" and
before the formatted rhymes, formatted using format_qualifier() in [[Module:qualifier]].
* `num_syl` (at top level), if non-nil, a list of the number(s) of syllables of the word or words with each rhyme
specified in `rhymes`. This applies to all rhymes specified in `rhymes`, while the corresponding `num_syl` attached
to an individual rhyme applies only to that rhyme (and overrides the global `num_syl`, if both are given).
* `caption`, if specified, overrides the default caption "Rhymes". A colon and space is automatically added after
the caption.
* `nocaption`, if specified, suppresses the caption entirely.
* `sort`, if specified, is the sort key for categories.
* `force_cat`, if specified, forces categories even on non-mainspace pages (for testing).
Note that the number of syllables is currently used only for categorization; if present, an extra category will
be added such as [[Category:Rhymes:Italian/ino/3 syllables]] in addition to [[Category:Rhymes:Italian/ino]].
]=]
function export.format_rhymes(data)
local langname = data.lang:getCanonicalName()
local links = {}
local categories = {}
for i, r in ipairs(data.rhymes) do
local rhyme = r.rhyme
local link = make_rhyme_link(data.lang, rhyme, "-" .. rhyme)
if r.q and r.q[1] or r.qq and r.qq[1] or r.qualifiers and r.qualifiers[1]
or r.a and r.a[1] or r.aa and r.aa[1] then
link = require("Module:pron qualifier").format_qualifiers(r, link)
end
table.insert(links, link)
add_syllable_categories(categories, langname, rhyme, r.num_syl or data.num_syl)
end
local ret = data.nocaption and "" or (data.caption or "Rhymes") .. ": "
if data.qualifiers and data.qualifiers[1] then
ret = require("Module:qualifier").format_qualifier(data.qualifiers) .. " " .. ret
end
return ret .. table.concat(links, ", ") ..
require("Module:utilities").format_categories(categories, data.lang, data.sort, nil, force_cat or data.force_cat)
end
function export.show(frame)
local args = frame.getParent and frame:getParent().args or frame
local compat = args["lang"]
local offset = compat and 0 or 1
local params = {
[1 + offset] = {required = true, list = true, default = "aɪmz"},
[compat and "lang" or 1] = {required = true, default = "en"},
["s"] = {},
["srhymes"] = {list = "s", allow_holes = true, require_index = true},
["q"] = {},
["qrhymes"] = {list = "q", allow_holes = true, require_index = true},
["caption"] = {},
["nocaption"] = {type = "boolean"},
["sort"] = {},
}
local args = require("Module:parameters").process(args, params)
local lang = args[compat and "lang" or 1]
lang = require("Module:languages").getByCode(lang, compat and "lang" or 1)
-- temporary tracking code to find usage of {{rhymes}} in various languages
-- [[Special:WhatLinksHere/Template:tracking/rhymes/LANGCODE]]
local code = lang:getCode()
if code == "it" or code == "es" then
require("Module:debug").track("rhymes/" .. code)
end
local function parse_num_syl(val)
val = mw.text.split(val, "%s*,%s*")
local ret = {}
for _, v in ipairs(val) do
local n = tonumber(v) or error("Unrecognized #syllables '" .. v .. "', should be a number")
table.insert(ret, n)
end
return ret
end
local rhymes = {}
for i, rhyme in ipairs(args[1 + offset]) do
local rhymeobj = {rhyme = rhyme}
if args.srhymes[i] then
rhymeobj.num_syl = parse_num_syl(args.srhymes[i])
end
if args.qrhymes[i] then
rhymeobj.qualifiers = {args.qrhymes[i]}
end
table.insert(rhymes, rhymeobj)
end
return export.format_rhymes {
lang = lang,
rhymes = rhymes,
num_syl = args.s and parse_num_syl(args.s) or nil,
qualifiers = args.q and {args.q} or nil,
caption = args.caption,
nocaption = args.nocaption,
sort = args.sort,
}
end
-- {{rhymes nav}}
function export.show_nav(frame)
-- Gather parameters
local args = frame:getParent().args
local lang = args[1] or (mw.title.getCurrentTitle().nsText == "Template" and "und") or error("Language code has not been specified. Please pass parameter 1 to the template.")
lang = require("Module:languages").getByCode(lang, 1)
local parts = {}
local i = 2
while args[i] do
local part = args[i]; if part == "" then part = nil end
table.insert(parts, part)
i = i + 1
end
-- Create steps
local steps = {"» [[Wiktionary:Rhymes|Rhymes]]", "» " .. make_rhyme_link(lang)}
local categories = {}
if #parts > 0 then
local last = parts[#parts]
parts[#parts] = nil
local prefix = ""
for i, part in ipairs(parts) do
prefix = prefix .. part
parts[i] = prefix
end
for _, part in ipairs(parts) do
table.insert(steps, "» " .. make_rhyme_link(lang, part .. "-", "-" .. part .. "-"))
end
if last == "-" then
table.insert(steps, "» " .. make_rhyme_link(lang, prefix, "-" .. prefix))
table.insert(categories, "[[Category:" .. lang:getCanonicalName() .. " rhymes" .. (prefix == "" and "" or "/" .. prefix .. "-") .. "| ]]")
elseif mw.title.getCurrentTitle().text == lang:getCanonicalName() .. "/" .. prefix .. last .. "-" then
table.insert(steps, "» " .. make_rhyme_link(lang, prefix .. last .. "-", "-" .. prefix .. last .. "-"))
table.insert(categories, "[[Category:" .. lang:getCanonicalName() .. " rhymes/" .. prefix .. last .. "-|-]]")
else
table.insert(steps, "» " .. make_rhyme_link(lang, prefix .. last, "-" .. prefix .. last))
table.insert(categories, "[[Category:" .. lang:getCanonicalName() .. " rhymes" .. (prefix == "" and "" or "/" .. prefix .. "-") .. "|" .. last .. "]]")
end
elseif lang:getCode() ~= "und" then
table.insert(categories, "[[Category:" .. lang:getCanonicalName() .. " rhymes| ]]")
end
frame:callParserFunction("DISPLAYTITLE",
mw.title.getCurrentTitle().fullText:gsub(
"/(.+)$",
function (rhyme)
return "/" .. tag_rhyme(rhyme, lang)
end))
return table.concat(steps, " ") .. table.concat(categories)
end
return export
