Module:Age: Difference between revisions

4,412 bytes added ,  3 years ago
m
29 revisions imported from wikipedia:Module:Age: see Topic:Vtixlm0q28eo6jtf
(update from sandbox: implement Template:Death date and age)
m (29 revisions imported from wikipedia:Module:Age: see Topic:Vtixlm0q28eo6jtf)
 
(6 intermediate revisions by one other user not shown)
Line 1: Line 1:
-- Implement various "age of" and other date-related templates.
-- Implement various "age of" and other date-related templates.
local mtext = {
-- Message and other text that should be localized.
-- Also need to localize text in table names in function dateDifference.
['mt-bad-param1'] =            'Invalid parameter $1',
['mt-bad-param2'] =            'Parameter $1=$2 is invalid',
['mt-bad-show'] =              'Parameter show=$1 is not supported here',
['mt-cannot-add'] =            'Cannot add "$1"',
['mt-conflicting-show'] =      'Parameter show=$1 conflicts with round=$2',
['mt-date-wrong-order'] =      'The second date must be later in time than the first date',
['mt-dd-future'] =              'Death date (first date) must not be in the future',
['mt-dd-wrong-order'] =        'Death date (first date) must be later in time than the birth date (second date)',
['mt-invalid-bd-age'] =        'Invalid birth date for calculating age',
['mt-invalid-dates-age'] =      'Invalid dates for calculating age',
['mt-invalid-end'] =            'Invalid end date in second parameter',
['mt-invalid-start'] =          'Invalid start date in first parameter',
['mt-need-jdn'] =              'Need valid Julian date number',
['mt-need-valid-bd'] =          'Need valid birth date: year, month, day',
['mt-need-valid-bd2'] =        'Need valid birth date (second date): year, month, day',
['mt-need-valid-date'] =        'Need valid date',
['mt-need-valid-dd'] =          'Need valid death date (first date): year, month, day',
['mt-need-valid-ymd'] =        'Need valid year, month, day',
['mt-need-valid-ymd-current'] = 'Need valid year|month|day or "currentdate"',
['mt-need-valid-ymd2'] =        'Second date should be year, month, day',
['mt-template-bad-name'] =      'The specified template name is not valid',
['mt-template-x'] =            'The template invoking this must have "|template=x" where x is the wanted operation',
['txt-and'] =                  ' and ',
['txt-or'] =                    ' or ',
['txt-category'] =              'Category:Age error',
['txt-comma-and'] =            ', and ',
['txt-error'] =                'Error: ',
['txt-format-default'] =        'mf',  -- 'df' (day first = dmy) or 'mf' (month first = mdy)
['txt-module-convertnumeric'] = 'Module:ConvertNumeric',
['txt-module-date'] =          'Module:Date',
['txt-sandbox'] =              'sandbox',
['txt-bda'] = '<span style="display:none"> (<span class="bday">$1</span>) </span>$2<span class="noprint ForceAgeToShow"> (age&nbsp;$3)</span>',
['txt-dda'] = '$2<span style="display:none">($1)</span> (aged&nbsp;$3)',
['txt-bda-disp'] = 'disp_raw',  -- disp_raw → age is a number only; disp_age → age is a number and unit (normally years but months or days if very young)
['txt-dda-disp'] = 'disp_raw',
['txt-dmy'] = '%-d %B %-Y',
['txt-mdy'] = '%B %-d, %-Y',
}
local isWarning = {
['mt-bad-param1'] = true,
}
local translate, from_en, to_en, isZero
if translate then
-- Functions to translate from en to local language and reverse go here.
-- See example at [[:bn:Module:বয়স]].
else
from_en = function (text)
return text
end
isZero = function (text)
return tonumber(text) == 0
end
end


local _Date, _currentDate
local _Date, _currentDate
Line 5: Line 64:
-- Return objects exported from the date module or its sandbox.
-- Return objects exported from the date module or its sandbox.
if not _Date then
if not _Date then
local sandbox = frame:getTitle():find('sandbox', 1, true) and '/sandbox' or ''
local sandbox = frame:getTitle():find(mtext['txt-sandbox'], 1, true) and ('/' .. mtext['txt-sandbox']) or ''
local datemod = require('Module:Date' .. sandbox)
local datemod = require(mtext['txt-module-date'] .. sandbox)
_Date = datemod._Date
local realDate = datemod._Date
_currentDate = datemod._current
_currentDate = datemod._current
if to_en then
_Date = function (...)
local args = {}
for i, v in ipairs({...}) do
args[i] = to_en(v)
end
return realDate(unpack(args))
end
else
_Date = realDate
end
end
end
return _Date, _currentDate
return _Date, _currentDate
Line 46: Line 116:
end
end
return text
return text
end
local function dateFormat(args)
-- Return string for wanted date format.
local default = mtext['txt-format-default']
local other = default == 'df' and 'mf' or 'df'
local wanted = stripToNil(args[other]) and other or default
return wanted == 'df' and mtext['txt-dmy'] or mtext['txt-mdy']
end
local function substituteParameters(text, ...)
-- Return text after substituting any given parameters for $1, $2, etc.
return mw.message.newRawMessage(text, ...):plain()
end
end


Line 55: Line 138:
end
end


local function message(msg, id)
local function message(msg, ...)
-- Return formatted message text for an error or warning.
-- Return formatted message text for an error or warning.
local function getText(msg)
return mtext[msg] or error('Bug: message "' .. tostring(msg) .. '" not defined')
end
local categories = {
local categories = {
error = '[[Category:Age error]]',
error = mtext['txt-category'],
warning = '[[Category:Age error]]',  -- same as error until determine whether 'Age warning' would be worthwhile
warning = mtext['txt-category'],
}
}
local a, b, category
local a, b, k, category
if id == 'warning' then
local text = substituteParameters(getText(msg), ...)
if isWarning[msg] then
a = '<sup>[<i>'
a = '<sup>[<i>'
b = '</i>]</sup>'
b = '</i>]</sup>'
k = 'warning'
else
else
a = '<strong class="error">Error: '
a = '<strong class="error">' .. getText('txt-error')
b = '</strong>'
b = '</strong>'
k = 'error'
end
end
if mw.title.getCurrentTitle():inNamespaces(0) then
if mw.title.getCurrentTitle():inNamespaces(0) then
-- Category only in namespaces: 0=article.
-- Category only in namespaces: 0=article.
category = categories[id or 'error']
category = '[[' .. categories[k] .. ']]'
end
end
return
return
a ..
a ..
mw.text.nowiki(msg) ..
mw.text.nowiki(text) ..
b ..
b ..
(category or '')
(category or '')
Line 106: Line 195:
-- i == 1 for the first number which can optionally start with an uppercase letter.
-- i == 1 for the first number which can optionally start with an uppercase letter.
number = tostring(number)
number = tostring(number)
return require('Module:ConvertNumeric').spell_number(
return require(mtext['txt-module-convertnumeric']).spell_number(
number,
number,
nil,                      -- fraction numerator
nil,                      -- fraction numerator
Line 123: Line 212:
if mw.ustring.len(extra) > 1 then
if mw.ustring.len(extra) > 1 then
-- Parameter "~" gives "~3" whereas "over" gives "over 3".
-- Parameter "~" gives "~3" whereas "over" gives "over 3".
extra = extra .. ' '
if extra:sub(-6, -1) ~= '&nbsp;' then
extra = extra .. ' '
end
end
end
if flagCurrent then
if flagCurrent then
Line 148: Line 239:
sortKey = string.format('%d', sortKey) .. string.format('%015.0f', math.floor(value * 10^(14-mag)))
sortKey = string.format('%d', sortKey) .. string.format('%015.0f', math.floor(value * 10^(14-mag)))
end
end
local lhs, rhs
local result
if sortable == 'sortable_table' then
if sortable == 'sortable_table' then
lhs = 'data-sort-value="'
result = 'data-sort-value="_SORTKEY_"|'
rhs = '"|'
elseif sortable == 'sortable_debug' then
result = '<span data-sort-value="_SORTKEY_♠"><span style="border:1px solid">_SORTKEY_♠</span></span>'
else
else
lhs = sortable == 'sortable_debug' and
result = '<span data-sort-value="_SORTKEY_♠"></span>'
'<span style="border:1px solid;display:inline;" class="sortkey">' or
'<span style="display:none" class="sortkey">'
rhs = '♠</span>'
end
end
return lhs .. sortKey .. rhs
return (result:gsub('_SORTKEY_', sortKey))
end
end
end
end
Line 204: Line 293:
hm = { 'H', 'M', id = 'hm' },
hm = { 'H', 'M', id = 'hm' },
hms = { 'H', 'M', 'S', id = 'hms' },
hms = { 'H', 'M', 'S', id = 'hms' },
M = { 'M', id = 'M' },
s = { 'S', id = 's' },
d = { 'd', id = 'd' },
d = { 'd', id = 'd' },
dh = { 'd', 'H', id = 'dh' },
dh = { 'd', 'H', id = 'dh' },
Line 252: Line 343:
return 'error'
return 'error'
end
end
return message('Need valid date')
return message('mt-need-valid-date')
end
end
local add = stripToNil(args.add)
local add = stripToNil(args.add)
Line 259: Line 350:
date = date + item
date = date + item
if not date then
if not date then
return message('Cannot add "' .. item .. '"')
return message('mt-cannot-add', item)
end
end
end
end
Line 272: Line 363:
result = date[show]
result = date[show]
if result == nil then
if result == nil then
result = date:text(show)
result = from_en(date:text(show))
elseif type(result) == 'boolean' then
elseif type(result) == 'boolean' then
result = result and '1' or '0'
result = result and '1' or '0'
else
else
result = tostring(result)
result = from_en(tostring(result))
end
end
end
end
return (sortKey or '') .. (result or '')
return (sortKey or '') .. makeExtra(args) .. (result or '')
end
end


local function rangeJoin(range)
local function rangeJoin(range)
-- Return text to be used between a range of ages.
-- Return text to be used between a range of ages.
return range == 'dash' and '–' or '&nbsp;or '
return range == 'dash' and '–' or mtext['txt-or']
end
end


Line 316: Line 407:
local name = names[components[i]]
local name = names[components[i]]
if name then
if name then
local plural = names.plural
if type(name) == 'table' then
if not plural or (islist and v[2] or v) == 1 then
name = mw.getContentLanguage():plural(islist and v[2] or v, name)
plural = ''
end
end
text:add(vstr .. sep .. name .. plural)
text:add(vstr .. sep .. name)
else
else
text:add(vstr)
text:add(vstr)
Line 335: Line 425:
elseif options.join == 'sep_serialcomma' and text.n > 2 then
elseif options.join == 'sep_serialcomma' and text.n > 2 then
first = ', '
first = ', '
last = ', and '
last = mtext['txt-comma-and']
else
else
first = ', '
first = ', '
last = ' and '
last = mtext['txt-and']
end
end
for i, v in ipairs(text) do
for i, v in ipairs(text) do
Line 368: Line 458:
-- which have been validated.
-- which have been validated.
local names = {
local names = {
-- Each name is:
-- * a string if no plural form of the name is used; or
-- * a table of strings, one of which is selected using the rules at
--  https://translatewiki.net/wiki/Plural/Mediawiki_plural_rules
abbr_off = {
abbr_off = {
plural = 's',
sep = '&nbsp;',
sep = '&nbsp;',
y = 'year',
y = {'year', 'years'},
m = 'month',
m = {'month', 'months'},
w = 'week',
w = {'week', 'weeks'},
d = 'day',
d = {'day', 'days'},
H = 'hour',
H = {'hour', 'hours'},
M = 'minute',
M = {'minute', 'minutes'},
S = 'second',
S = {'second', 'seconds'},
},
},
abbr_on = {
abbr_on = {
Line 389: Line 482:
},
},
abbr_infant = {      -- for {{age for infant}}
abbr_infant = {      -- for {{age for infant}}
plural = 's',
sep = '&nbsp;',
sep = '&nbsp;',
y = 'yr',
y = {'yr', 'yrs'},
m = 'mo',
m = {'mo', 'mos'},
w = 'wk',
w = {'wk', 'wks'},
d = 'day',
d = {'day', 'days'},
H = 'hr',
H = {'hr', 'hrs'},
M = 'min',
M = {'min', 'mins'},
S = 'sec',
S = {'sec', 'secs'},
},
},
abbr_raw = {},
abbr_raw = {},
Line 478: Line 570:
(textOptions.suffix or '')
(textOptions.suffix or '')
end
end
return message('Parameter show=' .. show.id .. ' is not supported here')
return message('mt-bad-show', show.id)
end
end


Line 533: Line 625:
end
end
if getopt.omitZero and i % 3 ~= 1 then  -- omit zero months and days as unknown values but keep year 0 which is 1 BCE
if getopt.omitZero and i % 3 ~= 1 then  -- omit zero months and days as unknown values but keep year 0 which is 1 BCE
if tonumber(fields[i]) == 0 then
if isZero(fields[i]) then
fields[i] = nil
fields[i] = nil
getopt.partial = true
getopt.partial = true
Line 552: Line 644:
for i = 1, nrDates do
for i = 1, nrDates do
local index = i == 1 and 1 or 4
local index = i == 1 and 1 or 4
dates[i] = Date(fields[index], fields[index+1], fields[index+2])
local y, m, d = fields[index], fields[index+1], fields[index+2]
if (m == 2 or m == '2') and (d == 29 or d == '29') then
-- Workaround error with following which attempt to use invalid date 2001-02-29.
-- {{age_ymwd|year1=2001|year2=2004|month2=2|day2=29}}
-- {{age_ymwd|year1=2001|month1=2|year2=2004|month2=1|day2=29}}
-- TODO Get rid of wantMixture because even this ugly code does not handle
-- 'Feb' or 'February' or 'feb' or 'february'.
if not ((y % 4 == 0 and y % 100 ~= 0) or y % 400 == 0) then
d = 28
end
end
dates[i] = Date(y, m, d)
end
end
else
else
Line 578: Line 681:
end
end
if not dates[1] then
if not dates[1] then
return message(getopt.missing1 or 'Need valid year, month, day')
return message(getopt.missing1 or 'mt-need-valid-ymd')
end
end
if getopt.single then
if getopt.single then
Line 584: Line 687:
end
end
if not dates[2] then
if not dates[2] then
return message(getopt.missing2 or 'Second date should be year, month, day')
return message(getopt.missing2 or 'mt-need-valid-ymd2')
end
end
return dates[1], dates[2]
return dates[1], dates[2]
Line 595: Line 698:
local name = frame.args.template
local name = frame.args.template
if not name then
if not name then
return message('The template invoking this must have "|template=x" where x is the wanted operation')
return message('mt-template-x')
end
end
local args = frame:getParent().args
local args = frame:getParent().args
Line 692: Line 795:
local spec = specs[name]
local spec = specs[name]
if not spec then
if not spec then
return message('The specified template name is not valid')
return message('mt-template-bad-name')
end
end
if name == 'age_days' then
if name == 'age_days' then
Line 756: Line 859:
}
}
if (spec.negative or frame.args.negative) == 'error' and parms.diff.isnegative then
if (spec.negative or frame.args.negative) == 'error' and parms.diff.isnegative then
return message('The second date should not be before the first date')
return message('mt-date-wrong-order')
end
end
return dateDifference(parms)
return from_en(dateDifference(parms))
end
end


Line 765: Line 868:
local args = frame:getParent().args
local args = frame:getParent().args
local options = {
local options = {
missing1 = 'Need valid birth date: year, month, day',
missing1 = 'mt-need-valid-bd',
noMissing = true,
noMissing = true,
single = true,
single = true,
Line 776: Line 879:
local diff = Date('currentdate') - date
local diff = Date('currentdate') - date
if diff.isnegative or diff.years > 150 then
if diff.isnegative or diff.years > 150 then
return message('Invalid birth date for calculating age')
return message('mt-invalid-bd-age')
end
end
local disp, show = 'disp_raw', 'y'
local disp = mtext['txt-bda-disp']
local show = 'y'
if diff.years < 2 then
if diff.years < 2 then
disp = 'disp_age'
disp = 'disp_age'
Line 787: Line 891:
end
end
end
end
local df = stripToNil(args.df)  -- day first (dmy); default is month first (mdy)
local result = substituteParameters(
local result = df and
mtext['txt-bda'],
'%-d %B %-Y' or
date:text('%-Y-%m-%d'),
'%B %-d, %-Y'
from_en(date:text(dateFormat(args))),
result = '(<span class="bday">%-Y-%m-%d</span>) </span>' .. result
from_en(dateDifference({
result = '<span style="display:none"> ' ..
date:text(result) ..
'<span class="noprint ForceAgeToShow"> ' ..
'(age&nbsp;' ..
dateDifference({
diff = diff,
diff = diff,
show = show,
show = show,
Line 802: Line 901:
disp = disp,
disp = disp,
sep = 'sep_space',
sep = 'sep_space',
}) ..
}))
')</span>'
)
local warnings = tonumber(frame.args.warnings)
local warnings = tonumber(frame.args.warnings)
if warnings and warnings > 0 then
if warnings and warnings > 0 then
Line 832: Line 931:
end
end
if invalid then
if invalid then
result = result .. message('invalid parameter ' .. invalid, 'warning')
result = result .. message('mt-bad-param1', invalid)
end
end
end
end
Line 842: Line 941:
local args = frame:getParent().args
local args = frame:getParent().args
local options = {
local options = {
missing1 = 'Need valid death date (first date): year, month, day',
missing1 = 'mt-need-valid-dd',
missing2 = 'Need valid birth date (second date): year, month, day',
missing2 = 'mt-need-valid-bd2',
noMissing = true,
noMissing = true,
partial = true,
partial = true,
Line 853: Line 952:
local diff = date1 - date2
local diff = date1 - date2
if diff.isnegative then
if diff.isnegative then
return message('Death date (first date) must occur after birth date (second date)')
return message('mt-dd-wrong-order')
end
local Date = getExports(frame)
local today = Date('currentdate') + 1  -- one day in future allows for timezones
if date1 > today then
return message('mt-dd-future')
end
end
local years
local years
Line 863: Line 967:
end
end
if years > 150 then
if years > 150 then
return message('Invalid dates for calculating age')
return message('mt-invalid-dates-age')
end
end
local df = stripToNil(args.df)  -- day first (dmy); default is month first (mdy)
local fmt_date, fmt_ymd
local result
if date1.day then  -- y, m, d known
if date1.day then  -- y, m, d known
result = (df and
fmt_date = dateFormat(args)
'%-d %B %-Y' or
fmt_ymd = '%-Y-%m-%d'
'%B %-d, %-Y') ..
'<span style="display:none">(%-Y-%m-%d)</span>'
elseif date1.month then  -- y, m known; d unknown
elseif date1.month then  -- y, m known; d unknown
result =
fmt_date = '%B %-Y'
'%B %-Y' ..
fmt_ymd = '%-Y-%m-00'
'<span style="display:none">(%-Y-%m-00)</span>'
else  -- y known; m, d unknown
else  -- y known; m, d unknown
result =
fmt_date = '%-Y'
'%-Y' ..
fmt_ymd = '%-Y-00-00'
'<span style="display:none">(%-Y-00-00)</span>'
end
end
result = date1:text(result) ..
local result = substituteParameters(
' (aged&nbsp;' ..
mtext['txt-dda'],
dateDifference({
date1:text(fmt_ymd),
from_en(date1:text(fmt_date)),
from_en(dateDifference({
diff = diff,
diff = diff,
show = 'y',
show = 'y',
abbr = 'abbr_off',
abbr = 'abbr_off',
disp = 'disp_raw',
disp = mtext['txt-dda-disp'],
range = 'dash',
range = 'dash',
sep = 'sep_space',
sep = 'sep_space',
}) ..
}))
')'
)
local warnings = tonumber(frame.args.warnings)
local warnings = tonumber(frame.args.warnings)
if warnings and warnings > 0 then
if warnings and warnings > 0 then
Line 914: Line 1,015:
end
end
if invalid then
if invalid then
result = result .. message('invalid parameter ' .. invalid, 'warning')
result = result .. message('mt-bad-param1', invalid)
end
end
end
end
Line 940: Line 1,041:
local date = Date('juliandate', args[1], args[2])
local date = Date('juliandate', args[1], args[2])
if date then
if date then
return date:text()
return from_en(date:text())
end
end
return message('Need valid Julian date number')
return message('mt-need-jdn')
end
end


Line 955: Line 1,056:
return tostring(date.jd)
return tostring(date.jd)
end
end
return message('Need valid year/month/day or "currentdate"')
return message('mt-need-valid-ymd-current')
end
end


Line 974: Line 1,075:
local date1 = Date(fix, 'partial', stripToNil(args[1]) or 'currentdatetime')
local date1 = Date(fix, 'partial', stripToNil(args[1]) or 'currentdatetime')
if not date1 then
if not date1 then
return message('Invalid start date in first parameter')
return message('mt-invalid-start')
end
end
local date2 = Date(fix, 'partial', stripToNil(args[2]) or 'currentdatetime')
local date2 = Date(fix, 'partial', stripToNil(args[2]) or 'currentdatetime')
if not date2 then
if not date2 then
return message('Invalid end date in second parameter')
return message('mt-invalid-end')
end
end
parms.diff = date2 - date1
parms.diff = date2 - date1
Line 986: Line 1,087:
parm = translate[parm]
parm = translate[parm]
if parm == nil then  -- test for nil because false is a valid setting
if parm == nil then  -- test for nil because false is a valid setting
return message('Parameter ' .. argname .. '=' .. args[argname] .. ' is invalid')
return message('mt-bad-param2', argname, args[argname])
end
end
parms[argname] = parm
parms[argname] = parm
Line 997: Line 1,098:
if show then
if show then
if show.id ~= round then
if show.id ~= round then
return message('Parameter show=' .. args.show .. ' conflicts with round=' .. args.round)
return message('mt-conflicting-show', args.show, args.round)
end
end
else
else
Line 1,005: Line 1,106:
parms.round = true
parms.round = true
end
end
return dateDifference(parms)
return from_en(dateDifference(parms))
end
end