Module:Convert/text: Difference between revisions
Jump to navigation
Jump to search
Content added Content deleted
(define exponent in eng_scales so it does not need to be set at run-time) |
(add sortable=on, sp=us, customary_units; tweak) |
||
Line 1: | Line 1: | ||
--[[ Text |
--[[ Text used by Module:Convert. |
||
Nearly all of the text displayed by Module:Convert is in this module |
|||
⚫ | |||
(apart from the unit definitions in Module:Convert/data). |
|||
Module:Convert responds to text parameters, and can display text. |
|||
⚫ | |||
Nearly all that text is defined in: |
|||
* Module:Convert/data (unit definitions) |
|||
* Module:Convert/text (parameter and message definitions) |
|||
In addition to the parameters defined here, Module:Convert accepts built-in |
|||
parameters shown in the following examples: |
|||
debug=yes Can be used with sortable=on. |
|||
precision=3 Not needed because "3" means "precision=3". |
|||
sigfig=3 To set number of output significant figures. |
|||
]] |
]] |
||
-- Some units can be qualified with one of the following prefixes, when linked. |
|||
local customary_units = { |
|||
'[[United States customary units|US]] ', |
|||
'[[United States customary units|U.S.]] ', |
|||
'[[Imperial unit|imperial]] ', |
|||
'[[Imperial unit|imp]] ', |
|||
} |
|||
-- Names when using engineering notation (a prefix of "eN" where N is a number). |
-- Names when using engineering notation (a prefix of "eN" where N is a number). |
||
-- key = { "name", "linked name, if link wanted" } |
-- key = { "name", "linked name, if link wanted", exponent = key } |
||
local eng_scales = { |
local eng_scales = { |
||
["3"] = { "thousand", exponent = 3 }, |
["3"] = { "thousand", exponent = 3 }, |
||
Line 15: | Line 32: | ||
} |
} |
||
-- When appropriate, the following categories can be included in the output. |
|||
local all_categories = { |
local all_categories = { |
||
general = '[[Category:Convert error]]', |
general = '[[Category:Convert error]]', |
||
Line 26: | Line 44: | ||
local unitcode_replace = { ['{'] = '<code style="background:transparent;">', ['}'] = '</code>' } |
local unitcode_replace = { ['{'] = '<code style="background:transparent;">', ['}'] = '</code>' } |
||
-- All messages that may be displayed if a problem occurs. |
|||
local all_messages = { |
local all_messages = { |
||
-- All output messages. |
|||
-- One of the following prefixes is inserted before each message. |
-- One of the following prefixes is inserted before each message. |
||
cvt_prefix_error = '<span style="color:black; background-color:orange;">[[Module talk:Convert|Conversion error]]:', |
cvt_prefix_error = '<span style="color:black; background-color:orange;">[[Module talk:Convert|Conversion error]]:', |
||
Line 36: | Line 54: | ||
-- regex = gsub_regex, |
-- regex = gsub_regex, |
||
-- replace = gsub_table, |
-- replace = gsub_table, |
||
-- warning = true, -- |
-- warning = true, -- omitted for an error message |
||
-- } |
-- } |
||
cvt_bad_default = { 'Unit "%s" has an invalid default', 'unknown' }, |
cvt_bad_default = { 'Unit "%s" has an invalid default', 'unknown' }, |
||
Line 59: | Line 77: | ||
} |
} |
||
-- Text to join input value/unit with output value/unit. |
|||
local disp_joins = { |
local disp_joins = { |
||
['or'] = { ' or ' , '' }, |
['or'] = { ' or ' , '' }, |
||
Line 71: | Line 90: | ||
} |
} |
||
-- Text to separate values in a range. |
|||
local range_types = { |
|||
['by'] = ' by ', |
['by'] = ' by ', |
||
['-'] = '–', |
['-'] = '–', |
||
Line 94: | Line 114: | ||
} |
} |
||
-- Valid option names. |
|||
local local_option_name = { |
local local_option_name = { |
||
-- ["en name used in this module"] = "local text for option name" |
-- ["en name used in this module"] = "local text for option name" |
||
Line 101: | Line 122: | ||
["lk"] = "lk", |
["lk"] = "lk", |
||
["sing"] = "sing", |
["sing"] = "sing", |
||
["sortable"] = "sortable", |
|||
["sp"] = "sp", |
|||
} |
} |
||
-- Valid option values. |
|||
-- Convention: parms.opt_xxx refers to an option that is set here |
-- Convention: parms.opt_xxx refers to an option that is set here |
||
-- (not intended to be set by the template which invokes this module). |
-- (not intended to be set by the template which invokes this module). |
||
Line 109: | Line 133: | ||
-- parms["opt_nocomma"] = true |
-- parms["opt_nocomma"] = true |
||
-- parms["abbr"] = nil |
-- parms["abbr"] = nil |
||
-- The |
-- The result is that parms.abbr will be nil, or will have one of the |
||
-- |
-- listed values that do not start with "opt_". |
||
local en_option_value = { |
local en_option_value = { |
||
["abbr"] = { |
["abbr"] = { |
||
Line 130: | Line 154: | ||
["mid"] = "opt_adj_mid", -- adj=on with user-specified text before input unit |
["mid"] = "opt_adj_mid", -- adj=on with user-specified text before input unit |
||
["nocomma"] = "opt_nocomma", -- no numsep in input or output numbers |
["nocomma"] = "opt_nocomma", -- no numsep in input or output numbers |
||
["off"] = "", -- ignored ( |
["off"] = "", -- ignored (off is the default) |
||
["on"] = "opt_adjectival", -- unit name is singular and hyphenated |
["on"] = "opt_adjectival", -- unit name is singular and hyphenated |
||
["pre"] = "opt_one_preunit", -- user-specified text before input unit |
["pre"] = "opt_one_preunit", -- user-specified text before input unit |
||
Line 165: | Line 189: | ||
["lk"] = { |
["lk"] = { |
||
["in"] = "in", -- link LHS unit name or symbol |
["in"] = "in", -- link LHS unit name or symbol |
||
["off"] = "", -- ignored ( |
["off"] = "", -- ignored (off is the default) |
||
["on"] = "on", -- link all unit names or symbols |
["on"] = "on", -- link all unit names or symbols |
||
["out"] = "out", -- link RHS unit name or symbol |
["out"] = "out", -- link RHS unit name or symbol |
||
}, |
|||
["sortable"] = { |
|||
["off"] = "", -- ignored (off is the default) |
|||
["on"] = "opt_sortable", -- output numeric hidden sort field for use in a sortable table |
|||
}, |
|||
["sp"] = { |
|||
["us"] = "opt_sp_us", -- use U.S. spelling (like "meter" instead of default "metre") |
|||
}, |
}, |
||
} |
} |
||
Line 174: | Line 205: | ||
all_categories = all_categories, |
all_categories = all_categories, |
||
all_messages = all_messages, |
all_messages = all_messages, |
||
customary_units = customary_units, |
|||
disp_joins = disp_joins, |
disp_joins = disp_joins, |
||
en_option_value = en_option_value, |
en_option_value = en_option_value, |