Xenharmonic Wiki

Module:Infobox MOS: Difference between revisions

← Older edit
Ganaram inukshuk (talk | contribs)
autopatrolled, emailconfirmed
6,211 edits
bugfix nL ns mosses with more than 5 periods having tamnams info
ArrowHead294 (talk | contribs)
15,213 edits
m No need to use NBSP on ones that aren't displayed
 
(12 intermediate revisions by 2 users not shown)
Line 1: Line 1:
local p = {}
local p = {}
local mos = require("Module:MOS")
 
local xp = require("Module:Xenpaper")
local getArgs = require("Module:Arguments").getArgs
local ib = require("Module:Infobox")
local ib = require("Module:Infobox")
local kbvis = require("Module:Keyboard vis")
local kbvis = require("Module:Keyboard vis")
local mos = require("Module:MOS")
local tamnams = require("Module:TAMNAMS")
local tip = require("Module:Template input parse")
local tip = require("Module:Template input parse")
local tamnams = require("Module:TAMNAMS")
local xp = require("Module:Xenpaper")
local yesno = require("Module:Yesno")
local yesno = require("Module:Yesno")
local getArgs = require("Module:Arguments").getArgs
 
-- TODO: REWRITE. REFACTOR. AGAIN.
 
-- TODO: bugfix tamnams lookup breaking for mosses with 5 steps or less; interim
-- fix currently implemented shows smaller mosses as descending from itself.


-- Helper function
-- Helper function
Line 41: Line 47:
end
end
return {{vis}}
return {{["Header"] = vis}}
end
end


Line 47: Line 53:
-- Adds categories
-- Adds categories
function p.categorize(input_mos)
function p.categorize(input_mos)
local input_mos = input_mos or mos.new(5,2)
local input_mos = input_mos or mos.new(5, 2)
-- Add to category of abstact mosses
-- Add to category of abstact mosses
local categories = "[[Category:Abstract MOS patterns]]"
local categories = " [[Category:Abstract MOS patterns]]"
-- Add notecount category if the notecount is greater than 3
-- Add notecount category if the notecount is greater than 3
local notecount = input_mos.nL + input_mos.ns
local notecount = input_mos.nL + input_mos.ns
if notecount > 3 then
if notecount > 3 then
categories = categories .. string.format("[[Category:%d-tone scales]]", notecount)
categories = categories .. string.format(" [[Category:%d-tone scales]]", notecount)
end
end
Line 70: Line 76:
if tamnams_name ~= nil then
if tamnams_name ~= nil then
categories = categories .. string.format("[[Category:%s]]", tamnams_name)
categories = categories .. string.format(" [[Category:%s]]", tamnams_name)
end
end
else
else
categories = categories .. "[[Category:Nonoctave]]"
categories = categories .. " [[Category:Nonoctave]]"
end
end
Line 96: Line 102:
local adjacent_links = {
local adjacent_links = {
mos.is_valid(adjacent_mosses[1]) and string.format("[[%s|↖ %s]]", mos.as_long_string(adjacent_mosses[1]), mos.as_string(adjacent_mosses[1]), true) or "",
mos.is_valid(adjacent_mosses[1]) and string.format("[[%s|↖ %s]]", mos.as_long_string(adjacent_mosses[1], false), mos.as_string(adjacent_mosses[1]), true) or "",
mos.is_valid(adjacent_mosses[2]) and string.format("[[%s|↑ %s]]", mos.as_long_string(adjacent_mosses[2]), mos.as_string(adjacent_mosses[2]), true) or "",
mos.is_valid(adjacent_mosses[2]) and string.format("[[%s|↑ %s]]", mos.as_long_string(adjacent_mosses[2], false), mos.as_string(adjacent_mosses[2]), true) or "",
mos.is_valid(adjacent_mosses[3]) and string.format("[[%s|%s ↗]]", mos.as_long_string(adjacent_mosses[3]), mos.as_string(adjacent_mosses[3]), true) or "",
mos.is_valid(adjacent_mosses[3]) and string.format("[[%s|%s ↗]]", mos.as_long_string(adjacent_mosses[3], false), mos.as_string(adjacent_mosses[3]), true) or "",
mos.is_valid(adjacent_mosses[4]) and string.format("[[%s|← %s]]", mos.as_long_string(adjacent_mosses[4]), mos.as_string(adjacent_mosses[4]), true) or "",
mos.is_valid(adjacent_mosses[4]) and string.format("[[%s|← %s]]", mos.as_long_string(adjacent_mosses[4], false), mos.as_string(adjacent_mosses[4]), true) or "",
mos.is_valid(adjacent_mosses[5]) and string.format("[[%s|%s →]]", mos.as_long_string(adjacent_mosses[5]), mos.as_string(adjacent_mosses[5]), true) or "",
mos.is_valid(adjacent_mosses[5]) and string.format("[[%s|%s →]]", mos.as_long_string(adjacent_mosses[5], false), mos.as_string(adjacent_mosses[5]), true) or "",
mos.is_valid(adjacent_mosses[6]) and string.format("[[%s|↙ %s]]", mos.as_long_string(adjacent_mosses[6]), mos.as_string(adjacent_mosses[6]), true) or "",
mos.is_valid(adjacent_mosses[6]) and string.format("[[%s|↙ %s]]", mos.as_long_string(adjacent_mosses[6], false), mos.as_string(adjacent_mosses[6]), true) or "",
mos.is_valid(adjacent_mosses[7]) and string.format("[[%s|↓ %s]]", mos.as_long_string(adjacent_mosses[7]), mos.as_string(adjacent_mosses[7]), true) or "",
mos.is_valid(adjacent_mosses[7]) and string.format("[[%s|↓ %s]]", mos.as_long_string(adjacent_mosses[7], false), mos.as_string(adjacent_mosses[7]), true) or "",
mos.is_valid(adjacent_mosses[8]) and string.format("[[%s|%s ↘]]", mos.as_long_string(adjacent_mosses[8]), mos.as_string(adjacent_mosses[8]), true) or ""
mos.is_valid(adjacent_mosses[8]) and string.format("[[%s|%s ↘]]", mos.as_long_string(adjacent_mosses[8], false), mos.as_string(adjacent_mosses[8]), true) or ""
}
}
Line 129: Line 135:
local period_in_cents = equave_in_cents / number_of_periods
local period_in_cents = equave_in_cents / number_of_periods
local step_pattern = string.format("...%d steps...", input_mos.nL+input_mos.ns)
local step_pattern = string.format("...%d steps...", input_mos.nL + input_mos.ns)
if input_mos.nL + input_mos.ns <= 40 then
if input_mos.nL + input_mos.ns <= 40 then
local brightest_mode = mos.brightest_mode(input_mos)
local brightest_mode = mos.brightest_mode(input_mos)
Line 137: Line 143:
local section_header = "Scale structure"
local section_header = "Scale structure"
local section_entries = {
local section_entries = {
{string.format("<div style=\"margin-top: 0.6em;\"><b>%s</b></div>", section_header)},
{ ["Header"] = string.format("<div style=\"margin-top: 0.6em;\"><b>%s</b></div>", section_header)},
{"[[Step pattern]]", step_pattern},
{ ["Header"] = "[[Step pattern]]", ["Data"] = step_pattern},
{"[[Equave]]", string.format("%s (%.1f{{c}})", equave_as_string, equave_in_cents)},
{ ["Header"] = "[[Equave]]"     , ["Data"] = string.format("%s (%.1f{{c}})", equave_as_string, equave_in_cents) },
{"[[Period]]", string.format("%s (%.1f{{c}})", period_as_string, period_in_cents)}
{ ["Header"] = "[[Period]]"     , ["Data"] = string.format("%s (%.1f{{c}})", period_as_string, period_in_cents) }
}
}


Line 165: Line 171:
local section_header = p.annotate_section_header(input_mos, "Generator size")
local section_header = p.annotate_section_header(input_mos, "Generator size")
local section_entries = {
local section_entries = {
{section_header},
{ ["Header"] = section_header},
{"[[Bright]]", string.format("%s to %s (%.1f{{c}} to %.1f{{c}})", bright_min_in_steps, bright_max_in_steps, bright_min_in_cents, bright_max_in_cents)},
{ ["Header"] = "[[Bright]]", ["Data"] = string.format("%s to %s (%.1f{{c}} to %.1f{{c}})", bright_min_in_steps, bright_max_in_steps, bright_min_in_cents, bright_max_in_cents) },
{"[[Dark]]"  , string.format("%s to %s (%.1f{{c}} to %.1f{{c}})", dark_min_in_steps, dark_max_in_steps, dark_min_in_cents, dark_max_in_cents)},
{ ["Header"] = "[[Dark]]"  , ["Data"] = string.format("%s to %s (%.1f{{c}} to %.1f{{c}})", dark_min_in_steps, dark_max_in_steps, dark_min_in_cents, dark_max_in_cents) },
}
}
Line 199: Line 205:
-- step count is 5 or less; currently unsupported) or not.
-- step count is 5 or less; currently unsupported) or not.
local is_octave_equivalent  = mos.is_octave_equivalent(input_mos)
local is_octave_equivalent  = mos.is_octave_equivalent(input_mos)
local is_within_named_range  = mos.equave_step_count(input_mos) <= 10
local has_tamnams_name      = tamnams.lookup_name(input_mos) ~= nil
local is_within_named_range  = mos.step_count(input_mos) <= 10
local is_within_period_count = mos.period_count(input_mos) <= 5
local is_within_period_count = mos.period_count(input_mos) <= 5
local is_root_mos = input_mos.nL == input_mos.ns
local is_root_mos = input_mos.nL == input_mos.ns
Line 205: Line 212:
local section_header = "TAMNAMS information"
local section_header = "TAMNAMS information"
local section_entries = nil
local section_entries = nil
if is_octave_equivalent and is_within_named_range then
if is_octave_equivalent and has_tamnams_name then
section_entries = {
section_entries = {
{string.format("<div style=\"margin-top: 0.6em;\"><b>%s</b></div>", section_header)},
{ ["Header"] = string.format("<div style=\"margin-top: 0.6em;\"><b>%s</b></div>", section_header) },
{"[[TAMNAMS#Mos_pattern_names | Name]]"   , tamnams.lookup_name  (input_mos)},
{ ["Header"] = "[[TAMNAMS#Mos_pattern_names | Name]]"   , ["Data"] = tamnams.lookup_name  (input_mos) },
{"[[TAMNAMS#Mos_pattern_names | Prefix]]" , tamnams.lookup_prefix(input_mos) .. "-"},
{ ["Header"] = "[[TAMNAMS#Mos_pattern_names | Prefix]]" , ["Data"] = tamnams.lookup_prefix(input_mos) .. "-" },
{"[[TAMNAMS#Mos_pattern_names | Abbrev.]]", tamnams.lookup_abbrev(input_mos)}
{ ["Header"] = "[[TAMNAMS#Mos_pattern_names | Abbrev.]]" , ["Data"] = tamnams.lookup_abbrev(input_mos) }
}
}
elseif is_octave_equivalent and not is_within_named_range and not is_root_mos then
elseif is_octave_equivalent and not has_tamnams_name and not is_root_mos and not is_within_named_range then
-- Lookup closest named ancestor mos
-- Lookup closest named ancestor mos
local ancestor_mos, ratio_1, ratio_2, generations = tamnams.find_ancestor_info(input_mos)
local ancestor_mos, ratio_1, ratio_2, generations = tamnams.find_ancestor_info(input_mos)
Line 228: Line 235:
section_entries = {
section_entries = {
{string.format("<div style=\"margin-top: 0.6em;\"><b>%s</b></div>", section_header)},
{ ["Header"] = string.format("<div style=\"margin-top: 0.6em;\"><b>%s</b></div>", section_header) },
{"Related to", ancestor_entry},
{ ["Header"] = "Related to" , ["Data"] = ancestor_entry },
{"With tunings", step_ratio_range_entry}
{ ["Header"] = "With tunings", ["Data"] = step_ratio_range_entry }
}
}
end
end
Line 256: Line 263:
local section_entries = {
local section_entries = {
{string.format("<div style=\"margin-top: 0.6em;\"><b>%s</b></div>", section_header)},
{ ["Header"] = string.format("<div style=\"margin-top: 0.6em;\"><b>%s</b></div>", section_header)},
{"Name(s)", scale_names}
{ ["Header"] = "Name(s)", ["Data"] = scale_names}
}  
}  
return section_entries
return section_entries
Line 293: Line 300:
local section_header = "Related MOS scales"
local section_header = "Related MOS scales"
local section_entries = {
local section_entries = {
{string.format("<div style=\"margin-top: 0.6em;\"><b>%s</b></div>", section_header)},
{ ["Header"] = string.format("<div style=\"margin-top: 0.6em;\"><b>%s</b></div>", section_header)},
{"[[Operations_on_MOSes#Parent_MOS | Parent]]", parent_scalesig},
{ ["Header"] = "[[Operations_on_MOSes#Parent_MOS | Parent]]"         , ["Data"] = parent_scalesig },
{"[[Operations_on_MOSes#Sister_MOS | Sister]]", sister_scalesig},
{ ["Header"] = "[[Operations_on_MOSes#Sister_MOS | Sister]]"         , ["Data"] = sister_scalesig },
{"[[Operations_on_MOSes#Daughter_MOS | Daughters]]", soft_scalesig .. ", " .. hard_scalesig},
{ ["Header"] = "[[Operations_on_MOSes#Daughter_MOS | Daughters]]"   , ["Data"] = soft_scalesig .. ", " .. hard_scalesig },
{"[[Operations_on_MOSes#Neutralization | Neutralized]]", neutral_scalesig},
{ ["Header"] = "[[Operations_on_MOSes#Neutralization | Neutralized]]", ["Data"] = neutral_scalesig},
{"[[Flought_scale | 2-Flought]]", soft_flought_scalesig .. ", " .. hard_flought_scalesig}
{ ["Header"] = "[[Flought_scale | 2-Flought]]"                       , ["Data"] = soft_flought_scalesig .. ", " .. hard_flought_scalesig }
}
}
Line 309: Line 316:
function p.equal_tunings(input_mos)
function p.equal_tunings(input_mos)
local input_mos = input_mos or mos.new(5, 2)
local input_mos = input_mos or mos.new(5, 2)
local bright_gen = mos.bright_gen(input_mos)
local bright_gen = mos.bright_gen(input_mos)
local step_ratios = {
local step_ratios = {
{ 1, 1 },
{ 1, 1 },
Line 325: Line 330:
local section_header = p.annotate_section_header(input_mos, "Equal tunings")
local section_header = p.annotate_section_header(input_mos, "Equal tunings")
local section_entries = {{section_header}}
local section_entries = {{ ["Header"] = section_header }}
for i = 1, #step_ratios do
for i = 1, #step_ratios do
Line 342: Line 347:
local text = string.format("[[%s|%s]] (%.1f{{c}})", ed_as_string, gen_in_steps, gen_in_cents)
local text = string.format("[[%s|%s]] (%.1f{{c}})", ed_as_string, gen_in_steps, gen_in_cents)
table.insert(section_entries, { caption, text })
table.insert(section_entries, { ["Header"] = caption, ["Data"] = text })
end
end


Line 349: Line 354:


-- New "main" function
-- New "main" function
function p._infobox_mos(input_mos, other_names_unparsed)
function p._infobox_mos(input_mos)
local input_mos = input_mos or mos.new(4,5,3)
local input_mos = input_mos or mos.new(4, 5, 3)
local other_names_unparsed = other_names_unparsed or ""
local other_names_unparsed = ""
local other_names_parsed = tip.parse_entries(other_names_unparsed) or tip.parse_entries(other_names_unparsed, ",")
local other_names_parsed = tip.parse_entries(other_names_unparsed) or tip.parse_entries(other_names_unparsed, ",")
Line 400: Line 405:
["Title"] = mos.as_long_string(input_mos),
["Title"] = mos.as_long_string(input_mos),
["Rows"] = sections,
["Rows"] = sections,
["name"] = "Infobox MOS"
}
}
Line 415: Line 421:
local other_names = args["othernames"] or nil
local other_names = args["othernames"] or nil
local debug_mode = yesno(args["debug"], false)
local debug_mode = yesno(args["debug"], false)
local wtext = yesno(frame.args["wtext"] or args["wtext"])
local result = p._infobox_mos(input_mos, other_names)
local result = p._infobox_mos(input_mos)
if not debug_mode then
if not debug_mode then
result = result .. p.categorize(input_mos)
result = result .. p.categorize(input_mos)
end
if wtext then
result = "<syntaxhighlight lang=\"wikitext\">" .. result .. "</syntaxhighlight>"
end
end
Retrieved from "https://en.xen.wiki/w/Module:Infobox_MOS"