Anonymous user
Module:Convert: Difference between revisions
update from sandbox per Template talk:Convert:Module version 3
(update from sandbox per Template talk:Convert#Module v2 soon) |
(update from sandbox per Template talk:Convert:Module version 3) |
||
Line 1:
-- Convert a value from one unit of measurement to another.
-- Example: {{convert|123|lb|kg}} --> 123 pounds (56 kg)
-- See [[:en:Template:Convert/Transwiki guide]] if copying to another wiki.
local MINUS = '−' -- Unicode U+2212 MINUS SIGN (UTF-8: e2 88 92)
Line 14 ⟶ 15:
-- Conversion data and message text are defined in separate modules.
local config, maxsigfig
local numdot
local numsep, numsep_remove
local default_exceptions, link_exceptions, all_units
local text_code
Line 22 ⟶ 24:
-- Use translation_table in convert/text to change the following.
local group_method = 3 -- code for how many digits are in a group
local per_word = 'per' -- for units like "
local plural_suffix = 's' -- only other useful value is probably '' to disable plural unit names
Line 31 ⟶ 33:
local extra_module -- name of module with extra units
local extra_units -- nil or table of extra units from extra_module
local function from_en(text)
Line 62 ⟶ 53:
-- and no separators (they have to be removed here to handle cases like
-- numsep = '.' and numdot = ',' with input "1.234.567,8").
if
text = text:gsub(
end
if numdot ~= '.' then
text = text:gsub(
end
if to_en_table then
Line 80 ⟶ 71:
-- Set configuration options from template #invoke or defaults.
config = frame.args
maxsigfig = config.maxsigfig or 14 -- maximum number of significant figures
-- Scribunto sets the global variable 'mw'.
Line 93 ⟶ 82:
spell_module = "ConvertNumeric"
else
local sandbox =
data_module = "Module:Convert/data" .. sandbox
text_module = "Module:Convert/text" .. sandbox
Line 106 ⟶ 95:
local translation = text_code.translation_table
if translation then
numdot = translation.numdot
numsep = translation.numsep
if translation.group then
group_method = translation.group
Line 133 ⟶ 124:
end
end
numdot = config.numdot or numdot or '.' -- decimal mark before fractional digits
numsep = config.numsep or numsep or ',' -- group separator for numbers
-- numsep should be ',' or '.' or '' or ' ' or a Unicode character.
-- numsep_remove must work in a regex to identify separators to be removed.
numsep_remove = (numsep == '.') and '%.' or numsep
end
Line 331 ⟶ 327:
-- END: Code required only for built-in units.
------------------------------------------------------------------------
local function get_range(word)
-- Return a range (string or table) corresponding to word (like "to"),
-- or return nil if not a range word.
local ranges = text_code.ranges
return ranges.types[word] or ranges.types[ranges.aliases[word]]
end
local function check_mismatch(unit1, unit2)
Line 369 ⟶ 372:
local unit_mt = {
-- Metatable to get missing values for a unit that does not accept SI prefixes
-- Warning: The boolean value 'false' is returned for any missing field
-- so __index is not called twice for the same field in a given unit.
Line 403:
end
}
local function prefixed_name(unit, name, index)
-- Return unit name with SI prefix inserted at correct position.
-- index = 1 (name1), 2 (name2), 3 (name1_us), 4 (name2_us).
-- The position is a byte (not character) index, so use Lua's sub().
local pos = rawget(unit, 'prefix_position')
if type(pos) == 'string' then
pos = tonumber(split(pos, ',')[index])
end
if pos then
return name:sub(1, pos - 1) .. unit.si_name .. name:sub(pos)
end
return unit.si_name .. name
end
local unit_prefixed_mt = {
-- Metatable to get missing values for a unit that accepts SI prefixes
-- Before use, fields si_name, si_prefix must be defined.
-- The unit must define _symbol, _name1 and
-- may define _sym_us, _name1_us, _name2_us
-- (_sym_us, _name2_us may be defined for a language using sp=us
-- to refer to a variant unrelated to U.S. units).
__index = function (self, key)
local value
Line 413 ⟶ 430:
value = self.si_prefix .. self._symbol
elseif key == 'sym_us' then
value = rawget(self
if value then
value = self.si_prefix .. value
else
value = self.symbol
end
elseif key == 'name1' then
value = prefixed_name(self, self._name1, 1)
elseif key == 'name2' then
value = rawget(self
if value then
value = prefixed_name(self, value, 2)
else
value = self.name1 .. plural_suffix
end
elseif key == 'name1_us' then
value = rawget(self, '_name1_us')
if value then
else
value = self.name1
end
elseif key == 'name2_us' then
if value then
value = prefixed_name(self, value, 4)
elseif rawget(self, '_name1_us') then
value = self.name1_us .. plural_suffix
else
Line 575 ⟶ 601:
result.sp_us = force_sp_us
if result.prefixes then
result.
result.
return true, setmetatable(result, unit_prefixed_mt)
end
return true, setmetatable(result, unit_mt)
Line 673 ⟶ 699:
end
end
if not get_range(unitcode) then -- do not require extra if looking up a range word which cannot be a unit
if not extra_units then
local success, extra = pcall(function () return require(extra_module).extra_units end)
if success and type(extra) == 'table' then
extra_units = extra
end
end
if extra_units then
-- A unit in one data table might refer to a unit in the other table, so
-- switch between them, relying on fails or depth to terminate loops.
if not fails[unitcode] then
local other = (utable == all_units) and extra_units or all_units
local success, result = lookup(unitcode, opt_sp_us, what, other, fails, depth)
if success then
return true, result
end
end
end
end
if to_en_table then
-- At fawiki it is common to translate all digits so a unit like "km2" becomes "km۲".
local en_code = ustring.gsub(unitcode, '%d', to_en_table)
if en_code ~= unitcode then
return lookup(en_code, opt_sp_us, what, utable, fails, depth)
end
end
Line 806 ⟶ 841:
return ''
end
local mid = (inout == (parms.opt_flip and 'out' or 'in')) and parms.mid or ''
if
if
return '-' .. hyphenated(id) .. mid, true
end
if
end
end
return sep .. id ..
end
Line 1,538 ⟶ 1,573:
-- Return true if successful or return false, t where t is an error message table.
if kv_pairs.adj and kv_pairs.sing then
-- For
-- as the latter is a deprecated alias for the former.
if kv_pairs.adj ~= kv_pairs.sing and kv_pairs.sing ~= '' then
Line 1,605 ⟶ 1,640:
local cfg_abbr = config.abbr
if cfg_abbr then
-- Don't warn if invalid because every convert would show that warning.
if cfg_abbr == 'on always' then
parms.abbr = 'on'
elseif cfg_abbr == '
elseif parms.abbr == nil then
if cfg_abbr == 'on default' then
parms.abbr = 'on'
elseif cfg_abbr == 'off default' then
parms.abbr = 'off'
end
end
Line 1,660 ⟶ 1,700:
-- i = index to next entry in parms after those processed here
-- or return false, t where t is an error message table.
local valinfo = collection() -- numbered table of input values
local range = collection() -- numbered table of range items (having, for example, 2 range items requires 3 input values)
Line 1,677 ⟶ 1,716:
local success, result = extract_number(parms, valstr, i > 1)
if not success and valstr and i < 20 then -- check i to limit abuse
for _, sep in ipairs(text_code.ranges.words) do
local start, stop = valstr:find(sep, 2, true) -- start at 2 to skip any negative sign for range '-'
if start then
Line 1,701 ⟶ 1,740:
valinfo:add(info)
local next = strip(parms[i])
local range_item =
if not range_item then
break
Line 1,786 ⟶ 1,825:
end
if parms.opt_ignore_error then -- display given unit code with no error (for use with {{val}})
in_unit_table =
end
in_unit_table = setmetatable({ symbol = in_unit, name2 = in_unit,
default = "m", defkey = "m", linkey = "m",
utype = "length", scale = 1, bad_mcode = in_unit_table }, unit_mt)
end
end
Line 1,845 ⟶ 1,886:
end
if parms.opt_adj_mid then
next = parms[i]
i = i + 1
Line 2,369 ⟶ 2,409:
local function variable_name(clean, unit_table)
-- For
-- Parameter clean is the unsigned rounded value in en digits, as a string.
-- Value Source Example for "m"
Line 2,757 ⟶ 2,797:
if composite then
-- Simplify: assume there is no range, and no decoration.
local mid = (not parms.opt_flip) and parms.mid or ''
local sep1 = ' '
local sep2 = ' '
if parms.opt_adjectival and want_name then
sep1 = '-'
end
local parts = { first_unit.valinfo[1].show .. sep1 .. id1 }
Line 2,936 ⟶ 2,971:
not (abbr == 'on' or abbr == 'out' or abbr == 'mos')
local want_link = (parms.lk == 'on' or parms.lk == 'out')
local mid = parms.opt_flip and parms.mid or ''
local sep1 = ' '
local sep2 = ' '
if parms.opt_adjectival and want_name then
sep1 = '-'
end
local do_spell = parms.opt_spell_out
Line 2,974 ⟶ 3,004:
decimals = ''
else
local p1, p2 = show:find(numdot, 1, true)
decimals = p1 and show:sub(p2 + 1) or '' -- text after numdot, if any
end
fmt = '%.' .. ulen(decimals) .. 'f' -- to reproduce precision
Line 3,003 ⟶ 3,035:
id = variable_name(clean, out_current)
else
if parms.opt_adjectival then
key = 'name1'
elseif tfrac then
if thisvalue == 0 then
key = 'name1'
end
elseif parms.opt_singular then
if 0 < thisvalue and thisvalue < 1.0001 then
key = 'name1'
end
else
if thisvalue == 1 then
key = 'name1'
end
end
id = out_current[key]
end
else
Line 3,162 ⟶ 3,210:
local wikitext
if bad_input_mcode then
if bad_input_mcode == '' then
wikitext = parts[1]
else
wikitext = parts[1] .. message(bad_input_mcode)
end
elseif parms.table_joins then
wikitext = parms.table_joins[1] .. parts[1] .. parms.table_joins[2] .. parts[2]
| |||