Module:Template input utils: Difference between revisions
m minor renaming |
mNo edit summary |
||
| (6 intermediate revisions by the same user not shown) | |||
| Line 3: | Line 3: | ||
-- TODO: move tip functions here? See [[Module:Template input parse]] | -- TODO: move tip functions here? See [[Module:Template input parse]] | ||
-- TODO: | |||
-- Add param name normalization: params close enough to snake_case are normal- | |||
-- ized to snake_case | |||
-- Library module for common operations with handling template input. | -- Library module for common operations with handling template input. | ||
-- - Numbered <anything> to table extract args and places them into a table. | -- - Numbered <anything> to table extract args and places them into a table. | ||
-- Normalize params to snake case (may change to a different form later); | |||
-- anything close enough to snake case is converted to snake case: | |||
-- TRAIN_CASE, KEBEB-CASE, no dashes (OK!) | |||
-- PascalCase, camelCase (will not convert properly) | |||
-- Function work-in-progress | |||
function p.normalize_params(args) | |||
-- Local function for normalizing strings | |||
-- Spaces and dashes turn into underscores | |||
-- and all capital letters become lowercase | |||
local function normalize(input_string) | |||
local cleaned_string = string.gsub(string.lower(input_string), "[%-%s]", "_") | |||
end | |||
end | |||
-- Extracts numbered args (from frame.args) and stores them into one table. | -- Extracts numbered args (from frame.args) and stores them into one table. | ||
| Line 13: | Line 33: | ||
-- table, as it may require further processing (EG, parsing to number, ratio, | -- table, as it may require further processing (EG, parsing to number, ratio, | ||
-- kv-pairs, etc). | -- kv-pairs, etc). | ||
function p.numbered_args_to_table(args, max_num, key_fmt) | function p.numbered_args_to_table(args, max_num, key_fmt, keep_originals) | ||
local max_num = max_num or 100 | local max_num = max_num or 100 | ||
local key_fmt = key_fmt or "Entry %d" | local key_fmt = key_fmt or "Entry %d" | ||
local keep_originals = keep_originals or false -- Denotes whether to keep originals in table or remove them; default false | |||
local entries = {} | local entries = {} | ||
| Line 22: | Line 43: | ||
local entry = args[key] -- Extract | local entry = args[key] -- Extract | ||
table.insert(entries, entry) -- Insert | table.insert(entries, entry) -- Insert | ||
args[key] = nil -- Remove original | if not keep_originals then | ||
args[key] = nil -- Remove original | |||
end | |||
end | end | ||
| Line 35: | Line 58: | ||
-- table, as it may require further processing (EG, parsing to number, ratio, | -- table, as it may require further processing (EG, parsing to number, ratio, | ||
-- kv-pairs, etc). | -- kv-pairs, etc). | ||
function p.numbered_header_data_args_to_table(args, max_num, header_fmt, data_fmt | function p.numbered_header_data_args_to_table(args, max_num, keep_originals, is_strict_pair, header_fmt, data_fmt) | ||
local max_num = max_num or 100 | local max_num = max_num or 100 | ||
local header_fmt = header_fmt or "Header %d" | local header_fmt = header_fmt or "Header %d" | ||
local data_fmt = data_fmt or "Data %d" | local data_fmt = data_fmt or "Data %d" | ||
local is_strict_pair = is_strict_pair or false -- Denotes whether a pair must have both header and data | local is_strict_pair = is_strict_pair or false -- Denotes whether a pair must have both header and data | ||
local keep_originals = keep_originals or false -- Denotes whether to keep originals in table or remove them; default false | |||
local entries = {} | local entries = {} | ||
| Line 60: | Line 84: | ||
-- Remove originals | -- Remove originals | ||
args[header_key] = nil | if not keep_originals then | ||
args[header_key] = nil | |||
args[data_key] = nil | |||
end | |||
end | end | ||