Xenharmonic Wiki

Module:MOS modes: Difference between revisions

← Older editNewer edit →
Ganaram inukshuk (talk | contribs)
autopatrolled, emailconfirmed
6,211 edits
m Added limit of 3 supplementary columns
Ganaram inukshuk (talk | contribs)
autopatrolled, emailconfirmed
6,211 edits
Update comments, code
Line 9: Line 9:
-- TODO:
-- TODO:
-- - Add ability to autocollapse on large mos pages (say, more than 12 modes)
-- - Add ability to autocollapse on large mos pages (say, more than 12 modes)
-- - Code cleanup, adopt new functions where needed (low priority)


-- "Main" function
-- "Main" function
Line 15: Line 14:
function p._mos_modes(input_mos, mode_names, headers, entries, is_collapsed)
function p._mos_modes(input_mos, mode_names, headers, entries, is_collapsed)
local is_collapsed = is_collapsed == true
local is_collapsed = is_collapsed == true
local input_mos = input_mos or mos.new(5,2)
local mode_names = mode_names or {}
local headers = headers or {}
local entries = entries or {}
-- Mos is entered as a scale signature "xL ys" or "xL ys<p/q>" since the mos module can parse that format
-- Get UDPs and CPOs
local input_mos = input_mos or mos.parse(scale_sig)
local udps = tamnams.mos_mode_udps(input_mos)
local cpos = tamnams.mos_mode_cpos(input_mos)
-- Get the mos's mode names, if given
local mode_names = mode_names or {}
-- Get the mos's modes and the mode count
-- Get the mos's modes
local mos_modes = mos.modes_by_brightness(input_mos)
local mos_modes = mos.modes_by_brightness(input_mos)
local periods = mos.period_count(input_mos)
local mossteps_per_period = mos.period_step_count(input_mos)


-- This is for entering multiple columns of info, if a single column of mode names isn't enough
-- Check whether to add mode names
-- For n headers, the number of entries must match the number of modes times the number of headers
local add_mode_names = #mode_names == #mos_modes
-- or else column data won't be added
local headers = headers or {}
local entries = entries or {}


-- To determine whether to add additional columns, determine whether the number of entries
-- Check whether the number of headers times the number of modes equals the
-- and the number of columns are greater than zero, and if so, determine whether the number of entries
-- number of entries. Supplementary info can only be added if this condition
-- is equal to the number of headers times the number of modes
-- is met. Limited to 3 columns of supplementary info.
local add_columns = #headers > 0 and #entries > 0
local add_columns = #headers > 0 and #entries > 0
if add_columns then
if add_columns then
Line 41: Line 37:
end
end
-- Get the number of mossteps in the bright gen
-- Headers
-- Used for calculating rotational order
local bright_gen = mos.bright_gen(input_mos)
local mossteps_per_bright_gen = mos.bright_gen_step_count(input_mos)
-- Make a table with a column for the mode (as a string of L's and s's) and UDP
local result = "{| class=\"wikitable sortable mw-collapsible" .. (is_collapsed and " mw-collapsed\"\n" or "\"\n")
local result = "{| class=\"wikitable sortable mw-collapsible" .. (is_collapsed and " mw-collapsed\"\n" or "\"\n")
.. "|+ style=\"font-size: 105%;\" | Modes of " .. mos.as_string(input_mos) .. "\n" -- To create the scale signature with〈〉instead of <>
.. "|+ style=\"font-size: 105%;\" | Modes of " .. mos.as_string(input_mos) .. "\n"
.. "|-\n"
.. "|-\n"
.. "! [[UDP]] !! Rotational order !! Step pattern"
.. "! [[UDP]] !! Rotational order !! Step pattern"
-- If there are mode names (if the mode names array is not nil), then add a column for mode names
-- Add header for mode names, if provided.
if #mode_names == #mos_modes then
if add_mode_names then
result = result .. " !! class=\"unsortable\" | Mode names"
result = result .. " !! class=\"unsortable\" | Mode names"
end
end
-- Add columns
-- Add column headers for supplementary info, if provided.
-- If mode names and columns are used, mode names come first
if add_columns then
if add_columns then
for i = 1, #headers do
for i = 1, #headers do
Line 68: Line 58:
-- Enter each row
-- Enter each row
-- As of coding, mos mode listings are fairly inconsistent or nonexistent, but consist of
-- the UDP, step pattern, and any mode names(s) in some order
-- This table orders them as UDP, step pattern, and mode names, as that's more common
for i = 1, #mos_modes do
for i = 1, #mos_modes do
result = result .. "|-\n"
result = result .. "|-\n"
-- Add the UDP
-- Add the UDP and brightness order
result = result .. "| " .. tamnams.udp_as_string(#mos_modes - i - 1, i - 1, periods)
result = result .. "| "   .. udps[i]
result = result .. " || " .. cpos[i]
-- Add the mode's rotational order
local bright_gens_up = mossteps_per_bright_gen * (i - 1)
local rotational_order = bright_gens_up % mossteps_per_period + 1
result = result .. " || " .. rotational_order


-- Add the mode's step pattern
-- Add the mode's step pattern
Line 86: Line 69:
-- Add the mode's name, if given
-- Add the mode's name, if given
if #mode_names == #mos_modes then
if add_mode_names then
result = result .. " || " .. mode_names[i]
result = result .. " || " .. mode_names[i]
end
end
Line 107: Line 90:
-- Wrapper function; to be called by template
-- Wrapper function; to be called by template
function p.modes_table(frame)
function p.modes_table(frame)
-- Mos is entered as a scale signature "xL ys" or "xL ys<p/q>" since the mos module can parse that format
local scale_sig = frame.args["Scale Signature"] or "5L 2s"
local scale_sig = frame.args["Scale Signature"] or "5L 2s"
local input_mos = mos.parse(scale_sig)
local input_mos = mos.parse(scale_sig)
Line 132: Line 114:
end
end


-- This is for entering multiple columns of info, if a single column of mode names isn't enough
-- Get supplementary info
-- For n headers, the number of entries must match the number of modes times the number of headers
-- or else column data won't be added
local headers_unparsed = frame.args["Table Headers"]
local headers_unparsed = frame.args["Table Headers"]
local headers = tip.parse_entries(headers_unparsed)
local headers = tip.parse_entries(headers_unparsed)
Retrieved from "https://en.xen.wiki/w/Module:MOS_modes"