Module:ko-pron
Documentation for this module may be created at Module:ko-pron/doc
local export = {}
local m_ko_utilities = require("Module:ko")
local m_data = mw.loadData("Module:ko-pron/data")
local gsub = mw.ustring.gsub
local match = mw.ustring.match
local sub = mw.ustring.sub
local char = mw.ustring.char
local codepoint = mw.ustring.codepoint
local PAGENAME = mw.title.getCurrentTitle().text
local system_lookup = {
["ph"] = 1, ["rr"] = 2, ["rrr"] = 3,
["mr"] = 4, ["yr"] = 5, ["ipa"] = 6,
}
local question_mark = "<sup><small>[[:en:Wiktionary:About Korean/Romanization|?]]</small></sup>"
local system_list = {
{
abbreviation = "ph",
display = "ການອອກສຽງຮັງກູ: ",
separator = "/",
},
{
abbreviation = "rr",
display = "Revised Romanization" .. question_mark,
separator = "/",
},
{
abbreviation = "rrr",
display = "Revised Romanization (translit.)" .. question_mark,
separator = "/"
},
{
abbreviation = "mc",
display = "McCune–Reischauer" .. question_mark,
separator = "/"
},
{
abbreviation = "yr",
display = "Yale Romanization" .. question_mark,
separator = "/"
},
{
abbreviation = "ipa",
display = "(<i>[[:en:w:South Korean standard language|SK ມາດຕະຖານ]]/[[:en:w:Seoul dialect|ເຊອຸນ]]</i>) [[:en:Wiktionary:International Phonetic Alphabet|IPA]]<sup>([[:en:Appendix:Korean pronunciation|key]])</sup>: ",
separator = " ~ "
}
}
--[[
vowel_variation:
rules for vowel transformation.
key:
the number of a syllable's vowel (vowel_id):
math.floor(((codepoint('가') - 0xAC00) % 588) / 28) = 0
math.floor(((codepoint('개') - 0xAC00) % 588) / 28) = 1
value:
an integer that is added to the decimal codepoint of the syllable
char(codepoint('개') + 112) = '게'
allowed_vowel_scheme:
a list of which systems vowel transformation is reflected in.
key:
vowel_id .. "-" .. system_index
system_index: see system_list above. IPA is #6
value:
1, representing true
]]
local final_syllable_conversion = { [""] = "Ø", ["X"] = "" }
local com_mc = { ["g"] = "k", ["d"] = "t", ["b"] = "p", ["j"] = "ch", ["sy"] = "s", ["s"] = "ss" }
local com_ph = { ["ᄀ"] = "ᄁ", ["ᄃ"] = "ᄄ", ["ᄇ"] = "ᄈ", ["ᄉ"] = "ᄊ", ["ᄌ"] = "ᄍ" }
local vowel_variation = {
[1] = 112, -- 개→게
[3] = 112, -- 걔→계
[10] = 140, -- 괘→궤
[7] = -56, -- 계→게
[11] = 112, -- 괴→궤
[16] = 0, -- 귀→귀
}
local allowed_vowel_scheme = {
["1-1"] = 1,
["1-6"] = 1,
["3-1"] = 1,
["3-6"] = 1,
["10-1"] = 1,
["10-6"] = 1,
["7-1"] = 1,
["7-6"] = 1,
["11-1"] = 1,
["11-6"] = 1,
["16-6"] = 1,
}
local ambiguous_intersyllabic_rr = { ["oe"] = 1, ["eo"] = 1, ["eu"] = 1, ["ae"] = 1, ["ui"] = 1 }
local ambiguous_intersyllabic_mr = { ["oe"] = 1, ["ae"] = 1 }
local function decompose_syllable(word)
local decomposed_syllables = {}
for syllable in mw.text.gsplit(word, "") do
table.insert(decomposed_syllables, m_ko_utilities.decompose_jamo(syllable))
end
return decomposed_syllables
end
local function tidy_phonetic(original, romanised)
local j, k, w = 1, 1, {}
for i = 1, mw.ustring.len(romanised) do
local romanised_syllable = mw.ustring.sub(romanised, k, k)
local original_syllable = mw.ustring.sub(original, j, j)
if romanised_syllable ~= original_syllable then
table.insert(w, '<b>'..romanised_syllable..'</b>')
if match(original_syllable, "[^ː ]") then k = k + 1 end
if match(romanised_syllable, "[^ː ]") then j = j + 1 end
else
table.insert(w, '<span>'..romanised_syllable..'</span>')
j, k = j + 1, k + 1
end
end
return table.concat(w)
end
local function tidy_ipa(ipa)
ipa = gsub(ipa, "ʌ̹ː", "ɘː")
ipa = gsub(ipa, "ɭɭi", "ʎʎi")
ipa = gsub(ipa, "ɭɭj", "ʎʎ")
ipa = gsub(ipa, "s([ʰ͈])ɥi" ,"ʃ%1ɥi")
ipa = gsub(ipa, "ss͈([ji])" ,"ɕɕ͈%1")
ipa = gsub(ipa, "s([ʰ͈])([ji])" ,"ɕ%1%2")
ipa = gsub(ipa, "nj", "ɲ")
ipa = gsub(ipa, "([ʑɕ])([ʰ͈]?)j", "%1%2")
ipa = gsub(ipa, "kʰ[ijɯ]", {
["kʰi"] = "kçi",
["kʰj"] = "kç",
["kʰɯ"] = "kxɯ" }
)
ipa = gsub(ipa, "[hɦ][ijɯouw]", {
["hi"] = "çi",
["hj"] = "ç",
["hɯ"] = "xɯ",
["ho"] = "ɸʷo",
["hu"] = "ɸʷu",
["hw"] = "ɸw",
["ɦi"] = "ʝi",
["ɦj"] = "ʝ",
["ɦɯ"] = "ɣɯ",
["ɦo"] = "βo",
["ɦu"] = "βu",
["ɦw"] = "βw" }
)
if match(ipa, "ɥi") then
local midpoint = math.floor(mw.ustring.len(ipa) / 2)
ipa = sub(ipa, 1, midpoint) .. gsub(sub(ipa, midpoint+1, -1), "ɥi", "y")
end
return ipa
end
function export.romanise(text_param, system_index, args)
if type(text_param) == "table" then
args = text_param:getParent().args
system_index = args[2] or 2
text_param = args[1]
end
local p, optional_params = {}, { "nn", "l", "com", "cap", "ni" }
for _, pm in ipairs(optional_params) do
p[pm] = { }
if args[pm] then
for pp in mw.text.gsplit(args[pm], ",") do p[pm][tonumber(pp) or pp] = 1 end
end
end
local vowel_ui_i, vowel_ui_e, no_batchim, batchim_reduce, s_variation, iotation =
args.ui, args.uie, args.nobc, args.bcred, args.svar, args.iot
system_index = system_lookup[system_index] or system_index
text_param = gsub(text_param, '["](.)', "%1")
for primitive_word in mw.ustring.gmatch(text_param, "[%-ᄀ-ᄒ".."ᅡ-ᅵ".."ᆨ-ᇂ" .. "ㄱ-ㅣ가-힣' ]+") do
local the_original = primitive_word
primitive_word = gsub(primitive_word, "'''", "ß")
local bold_position, bold_count = {}, 0
while match(primitive_word, "ß") do
bold_position[(mw.ustring.find(primitive_word, "ß")) + bold_count] = true
primitive_word = gsub(primitive_word, "ß", "", 1)
bold_count = bold_count + 1
end
local has_vowel = {}
for ch in mw.ustring.gmatch(primitive_word, ".") do
local jungseong = math.floor(((codepoint(ch) - 0xAC00) % 588) / 28)
if not match(ch, "[예옛례롄]") and match(ch, "[가-힣]") then has_vowel[jungseong] = true end
end
local word_set = { primitive_word }
local function add_respelling(variable, modification, modification2)
modification2 = modification2 or function(x) return x end
if variable and match(system_index, "[16]") then
variable = tonumber(variable)
local pre_length = #word_set
for i = 1, pre_length do
local item = mw.text.split(word_set[i], "")
item[variable] = modification(item[variable])
item[variable + 1] = modification2(item[variable + 1])
word_set[pre_length + i] = table.concat(item)
end
end
end
add_respelling(vowel_ui_i, function(x) return "이" end)
add_respelling(vowel_ui_e, function(x) return "에" end)
add_respelling(no_batchim,
function(x) return char(codepoint(x) - (codepoint(x) - 0xAC00) % 28) end,
function(y) return char(codepoint(y) + 588) end)
add_respelling(s_variation, function(x) return char(codepoint(x) - 12) end)
add_respelling(iotation, function(x) return char(codepoint(x) + 56) end)
for vowel_id, vowel_variation_increment in pairs(vowel_variation) do
if has_vowel[vowel_id] and allowed_vowel_scheme[vowel_id .. "-" .. system_index] then
local pre_length = #word_set
for i = 1, pre_length do
local item = mw.text.split(word_set[i], "")
for num, it in ipairs(item) do
if math.floor(((codepoint(it) - 0xAC00) % 588) / 28) == vowel_id then
item[num] = char(codepoint(it) + vowel_variation_increment)
end
end
if vowel_id == 11 then
table.insert(word_set, i, table.concat(item))
else
table.insert(word_set, table.concat(item))
end
end
end
end
local word_set_romanisations = {}
for _, respelling in ipairs(word_set) do
local decomposed_syllables = decompose_syllable(respelling)
local romanisation = {}
local bold_insert_count = 0
for index = 0, #decomposed_syllables, 1 do
local this_syllable_text = index ~= 0 and sub(respelling, index, index) or ""
if this_syllable_text == "-" then
-- skip it, it will be handled below
else
local syllable = decomposed_syllables[index] or { initial = "Ø", vowel = "Ø", final = "X" }
local next_index = index
local next_syllable_text
local saw_hyphen_after = false
while true do
next_index = next_index + 1
next_syllable_text = next_index > #decomposed_syllables and "" or sub(respelling, next_index, next_index)
if next_syllable_text ~= "-" then
break
end
saw_hyphen_after = true
end
local next_syllable = decomposed_syllables[next_index] or { initial = "Ø", vowel = "Ø", final = "Ø" }
syllable.final = final_syllable_conversion[syllable.final] or syllable.final
if system_index == 5 and syllable.vowel == "ᅮ" and match(syllable.initial, "[ᄆᄇᄈᄑ]") then
syllable.vowel = "ᅳ"
end
if match(system_index, "[1246]") then
if match(syllable.initial, "[ᄌᄍᄎ]") then
if syllable.vowel == "ᅣ" then
syllable.vowel = "ᅡ"
elseif syllable.vowel == "ᅤ" then
syllable.vowel = "ᅢ"
elseif syllable.vowel == "ᅧ" then
syllable.vowel = "ᅥ"
elseif syllable.vowel == "ᅨ" then
syllable.vowel = "ᅦ"
elseif syllable.vowel == "ᅭ" then
syllable.vowel = "ᅩ"
elseif syllable.vowel == "ᅲ" then
syllable.vowel = "ᅮ"
end
end
end
if match(system_index, "[16]") then
if syllable.vowel == "ᅴ" and this_syllable_text ~= "의" then
syllable.vowel = "ᅵ"
end
end
if match(system_index, "[1246]") then
if this_syllable_text == "넓" then
if match(next_syllable.initial, "[ᄌᄉ]") then
syllable.final = "ᆸ"
elseif next_syllable.initial == "ᄃ" then
if match(next_syllable.vowel, "[^ᅡᅵ]") then
syllable.final = "ᆸ"
end
end
end
end
local vowel = m_data.vowels[syllable.vowel][system_index]
if p.nn[next_index] and match(system_index, "[1246]") then
next_syllable.initial = "ᄂ"
end
if p.com[index] and match(system_index, "[16]") then
next_syllable.initial = com_ph[next_syllable.initial] or next_syllable.initial
end
if p.ni[next_index] and system_index ~= 3 then
next_syllable.initial = (system_index == 5 and syllable.final == "ᆯ") and "ᄅ" or "ᄂ"
end
if match(system_index, "[1246]") then
if tonumber(batchim_reduce or -1) == index then
syllable.final = m_data.boundary[syllable.final .. "-Ø"][1]
end
if index ~= 0 and this_syllable_text == "밟" then
syllable.final = "ᆸ"
end
if syllable.final .. next_syllable.initial == "ᆺᄋ" and not
match(next_syllable_text, "[이아어은으음읍을었았있없에입의]") then
syllable.final = "ᆮ"
end
if tonumber(batchim_reduce or -1) ~= index then
if match(syllable.final .. next_syllable.initial, "ᇀᄋ") then
if next_syllable.vowel == "ᅵ" then
syllable.final = "ᆾ"
elseif next_syllable.vowel == "ᅧ" then
syllable.final = "ᆾ"
next_syllable.vowel = "ᅥ"
end
elseif match(syllable.final .. next_syllable.initial, "ᆴᄋ") then
if next_syllable.vowel == "ᅵ" then
syllable.final = "ᆯ"
next_syllable.initial = "ᄎ"
elseif next_syllable.vowel == "ᅧ" then
syllable.final = "ᆯ"
next_syllable.initial = "ᄎ"
next_syllable.vowel = "ᅥ"
end
elseif match(syllable.final .. next_syllable.initial, "ᆮᄋ") and tonumber(s_variation or -1) ~= index then
if next_syllable.vowel == "ᅵ" then
syllable.final = "ᆽ"
elseif next_syllable.vowel == "ᅧ" then
syllable.final = "ᆽ"
next_syllable.vowel = "ᅥ"
end
elseif match(syllable.final .. next_syllable.initial, "ᆮᄒ") then
if next_syllable.vowel == "ᅵ" then
syllable.final = "ᆾ"
next_syllable.initial = "ᄋ"
elseif next_syllable.vowel == "ᅧ" then
syllable.final = "ᆾ"
next_syllable.initial = "ᄋ"
next_syllable.vowel = "ᅥ"
end
elseif match(syllable.final .. next_syllable.initial .. next_syllable.vowel, "[ᆬᆽᆾ][ᄋᄒ]ᅧ") then
next_syllable.vowel = "ᅥ"
end
end
end
local bound = syllable.final .. "-" .. next_syllable.initial
if not m_data.boundary[bound] then
require("Module:debug").track("ko-pron/no boundary data")
mw.log("No boundary data for " .. bound .. ".")
return nil
end
local junction = m_data.boundary[bound][system_index]
if bold_position[index + bold_insert_count + 1] and system_index == 2 then
junction = gsub(junction, "^.*$", function(matched)
local a, b = match(matched, "^(ng%-?)(.?)$")
if not a or not b then a, b = match(matched, "^(.?%-?)(.*)$") end
return match(syllable.final .. next_syllable.initial, "^Ø?[ᄀ-ᄒ]$")
and "'''" .. (a or "") .. (b or "")
or (a or "") .. "'''" .. (b or "") end)
bold_insert_count = bold_insert_count + 1
end
if p.l[index] or (p.l["y"] and index == 1) then
-- FIXME, verify this code still works with final/initial cons changes
if system_index == 1 then
if #junction == 0 then
junction = junction .. "ː"
else
junction = gsub(junction, "^(.)(.?)$", function(a, b)
return match(a, "[ᆨ-ᇂ]") and a .. "ː" .. b or "ː" .. a .. b end)
end
elseif system_index == 5 then
vowel = gsub(vowel, "([aeiou])", "%1̄")
elseif system_index == 6 then
vowel = vowel .. "ː[[Category:Korean terms with long vowels in the first syllable]]"
end
end
if (p.l["y"] or p.l[1]) and index == 0 and system_index == 6 and #decomposed_syllables > 1 then
vowel = vowel .. "ˈ"
end
if p.com[index] then
-- FIXME, verify this code still works with final/initial cons changes
junction = gsub(junction, "(.)$", function(next_letter)
return
(system_index == 5 and "q" or "") ..
(system_index == 4
and (com_mc[next_letter..(p.cap["y"] or "")] or com_mc[next_letter] or next_letter)
or next_letter) end)
end
if p.ni[next_index] and system_index == 5 then
-- FIXME, verify this code still works with final/initial cons changes
junction = gsub(junction, "([nl])$", "<sup>%1</sup>")
end
local final_cons, initial_cons = match(junction, "^(.*);(.*)$")
if not final_cons then
if system_index == 2 then
error("Need a semicolon in the boundary value for " .. bound)
end
-- FIXME, throw an error for all systems once we've added semicolons everywhere
final_cons = junction
initial_cons = ""
end
if system_index == 2 then
table.insert(romanisation, vowel .. final_cons .. (saw_hyphen_after and "-" or "") .. initial_cons)
else
table.insert(romanisation, vowel .. junction)
end
end
end
local temp_romanisation = table.concat(romanisation)
if p.cap["y"] and match(system_index, "[234]") then
temp_romanisation = mw.ustring.upper(sub(temp_romanisation, 1, 1)) .. sub(temp_romanisation, 2, -1)
end
if system_index == 1 then
temp_romanisation = tidy_phonetic(primitive_word, mw.ustring.toNFC(temp_romanisation))
elseif match(system_index, "[23]") then
for i = 1, 2 do
temp_romanisation = gsub(temp_romanisation, "(.)…(.)", function(a, b)
return a .. (ambiguous_intersyllabic_rr[a .. b] and "'" or "") .. b end)
temp_romanisation = gsub(temp_romanisation, "wo'e", "woe")
temp_romanisation = gsub(temp_romanisation, "yo'e", "yoe")
temp_romanisation = gsub(temp_romanisation, "we'o", "weo")
temp_romanisation = gsub(temp_romanisation, "we'u", "weu")
temp_romanisation = gsub(temp_romanisation, "ye'u", "yeu")
temp_romanisation = gsub(temp_romanisation, "yu'i", "yui")
end
elseif system_index == 4 then
for i = 1, 2 do
temp_romanisation = gsub(temp_romanisation, "(.)…(.)", function(a, b)
return a .. (ambiguous_intersyllabic_mr[a .. b] and "'" or "") .. b end)
temp_romanisation = gsub(temp_romanisation, "yo'e", "yoe")
temp_romanisation = gsub(temp_romanisation, "a'e", "aë")
temp_romanisation = gsub(temp_romanisation, "o'e", "oë")
temp_romanisation = gsub(temp_romanisation, "n'k", "nk")
temp_romanisation = gsub(temp_romanisation, "swi", "shwi")
end
elseif system_index == 6 then
temp_romanisation = "[" .. temp_romanisation .. "]"
end
if match(system_index, "[16]") then
temp_romanisation = mw.ustring.gsub(temp_romanisation, "ː", "(ː)")
end
table.insert(word_set_romanisations, temp_romanisation)
end
text_param = gsub(
text_param,
require("Module:utilities").pattern_escape(the_original),
table.concat(word_set_romanisations, system_list[system_index].separator),
1
)
end
if system_index == 6 then
text_param = tidy_ipa(text_param)
end
return text_param
end
function export.make(frame, scheme)
local params = {
[1] = { default = PAGENAME, list = true },
["a"] = {},
["audio"] = { alias_of = "a" },
["nn"] = {},
["l"] = {},
["com"] = {},
["cap"] = {},
["ui"] = {},
["uie"] = {},
["nobc"] = {},
["ni"] = {},
["bcred"] = {},
["svar"] = {},
["iot"] = {},
}
local args = require("Module:parameters").process(frame:getParent().args, params)
local results = {}
for _, text_param in ipairs(args[1]) do
local current_word_dataset = {}
for system_index, system in pairs(system_list) do
local romanised = export.romanise(text_param, system_index, args)
table.insert(current_word_dataset, romanised)
end
table.insert(results, current_word_dataset)
end
local output_result = { [1] = {}, [2] = {}, [3] = {}, [4] = {}, [5] = {}, [6] = {} }
for _, result in ipairs(results) do
for result_index, value in ipairs(result) do
table.insert(output_result[result_index], value)
end
end
local html_ul = mw.html.create( "ul" )
:done()
local html_li_ipa = mw.html.create( "li" )
:wikitext( system_list[6].display )
:tag( "span" )
:addClass( "IPA" )
:wikitext( table.concat(output_result[6], system_list[6].separator) )
:done()
:done()
local html_li_ph = mw.html.create( "li" )
:addClass( "ko-pron__ph" )
:wikitext( system_list[1].display )
:tag( "span" )
:addClass( "Kore" )
:attr( "lang", "ko" )
:wikitext( "[" .. table.concat(output_result[1], system_list[1].separator) .. "]" )
:done()
:done()
if args.a then
html_li_ipa
:tag( "ul" )
:tag( "li" )
:wikitext( mw.getCurrentFrame():expandTemplate{
title = "Template:audio",
args = { "ko", args.a == "y" and "Ko-" .. PAGENAME .. ".ogg" or args.a }} )
:done()
:done()
:done()
end
if args.l then
html_li_ph
:tag( "ul" )
:tag( "li" )
:addClass( "ko-pron__note-vowel-length" )
:wikitext( 'Though still prescriptive in Standard Korean, most speakers in both Koreas no longer distinguish vowel length.' )
:done()
:done()
:done()
end
html_ul
:node( html_li_ipa )
:node( html_li_ph )
:done()
local html_table = mw.html.create( "table" )
:addClass( "ko-pron" )
:addClass( "mw-collapsible" )
:addClass( "mw-collapsed" )
:tag( "tr" )
:tag( "th" )
:attr( "colspan", 2 )
:wikitext( "Romanizations" )
:done()
:done()
:done()
for roman_index = 2, 5 do
html_table
:tag( "tr" )
:tag( "th" )
:wikitext( system_list[roman_index].display )
:done()
:tag( "td" )
:addClass( "IPA" )
:wikitext( table.concat(output_result[roman_index], system_list[roman_index].separator) )
:done()
:done()
:done()
end
return tostring(html_ul) .. tostring(html_table) .. require("Module:TemplateStyles")("Template:ko-IPA/style.css")
end
function export.make_hanja(frame, scheme)
local params = {
[1] = { list = true },
["l"] = {},
}
local args = require("Module:parameters").process(frame:getParent().args, params)
local results = {
[1] = {},
[6] = {},
}
for _, text_param in ipairs(args[1]) do
for _, system_index in pairs({1, 6}) do
local romanised = export.romanise(text_param, system_index, args)
table.insert(results[system_index], romanised)
end
end
local html_ul = mw.html.create( "ul" )
:done()
local html_li_ipa = mw.html.create( "li" )
:wikitext( system_list[6].display )
:tag( "span" )
:addClass( "IPA" )
:wikitext( table.concat(results[6], system_list[6].separator) )
:done()
:done()
local html_li_ph = mw.html.create( "li" )
:addClass( "ko-pron__ph" )
:wikitext( system_list[1].display )
:tag( "span" )
:addClass( "Kore" )
:attr( "lang", "ko" )
:wikitext( "[" .. table.concat(results[1], system_list[1].separator) .. "]" )
:done()
:done()
if args.l then
html_li_ph
:tag( "ul" )
:tag( "li" )
:addClass( "ko-pron__note-vowel-length" )
:wikitext( 'Though still prescriptive in Standard Korean, most speakers in both Koreas no longer distinguish vowel length.' )
:done()
:done()
:done()
end
html_ul
:node( html_li_ipa )
:node( html_li_ph )
:done()
return tostring(html_ul) .. require("Module:TemplateStyles")("Template:ko-IPA/style.css")
end
return export