Module:Citation/CS1/Date validation/sandbox: Difference between revisions

no edit summary
m (1 revision imported)
No edit summary
Line 1: Line 1:
--[[
--[[
History of changes since last sync: 2021-04-10
History of changes since last sync: 2022-07-01


2021-04-30: extend allowed dates in |pmc-embargo-date= validation to two years; Help_talk:Citation_Style_1#|pmc-embargo-date=_validation
2022-07-11: limit CITEREF dab to |date=, |year, |publication-date=; see Help_talk:Citation_Style_1/Archive_84#CITEREF_disambiguators_in_date-holding_parameters_other_than_|date=_and_|year=
2021-05-01: revise month-name validation; see Help_talk:Citation_Style_1#i18n_tweaks
2021-05-02: add support to allow editors to see citations that emit properties cats; see Help_talk:Citation_Style_1#highlighting_cs1|2_citations_that_emit_properties_categories


]]
]]
Line 579: Line 577:
elseif mw.ustring.match(date_string, patterns['Sy-y'][1]) then -- special case Winter/Summer year-year; year separated with unspaced endash
elseif mw.ustring.match(date_string, patterns['Sy-y'][1]) then -- special case Winter/Summer year-year; year separated with unspaced endash
month, year, anchor_year, year2 = mw.ustring.match(date_string, patterns['Sy-y'][1]);
month, year, anchor_year, year2 = mw.ustring.match(date_string, patterns['Sy-y'][1]);
if 'Winter' ~= month and 'Summer' ~= month then return false end; -- 'month' can only be Winter or Summer
month = get_season_number (month, param); -- <month> can only be winter or summer; also for metadata
anchor_year = year .. '–' .. anchor_year; -- assemble anchor_year from both years
if (month ~= cfg.date_names['en'].season['Winter']) and (month ~= cfg.date_names['en'].season['Summer']) then
return false; -- not Summer or Winter; abandon
end
anchor_year = year .. '–' .. anchor_year; -- assemble anchor_year from both years
if 1 ~= tonumber(year2) - tonumber(year) then return false; end -- must be sequential years, left to right, earlier to later
if 1 ~= tonumber(year2) - tonumber(year) then return false; end -- must be sequential years, left to right, earlier to later
if not is_valid_year(year2) then return false; end -- no year farther in the future than next year
if not is_valid_year(year2) then return false; end -- no year farther in the future than next year
month = get_season_number (month, param); -- for metadata


elseif mw.ustring.match(date_string, patterns['My-My'][1]) then -- month/season year - month/season year; separated by spaced endash
elseif mw.ustring.match(date_string, patterns['My-My'][1]) then -- month/season year - month/season year; separated by spaced endash
Line 635: Line 635:


if 13 > tonumber(year2) then return false; end -- don't allow 2003-05 which might be May 2003
if 13 > tonumber(year2) then return false; end -- don't allow 2003-05 which might be May 2003
year2 = century .. year2; -- add the century to year2 for comparisons
year2 = century .. year2; -- add the century to year2 for comparisons
if tonumber(year) >= tonumber(year2) then return false; end -- left to right, earlier to later, not the same
if tonumber(year) >= tonumber(year2) then return false; end -- left to right, earlier to later, not the same
if not is_valid_year(year2) then return false; end -- no year farther in the future than next year
if not is_valid_year(year2) then return false; end -- no year farther in the future than next year
Line 647: Line 647:
else
else
return false; -- date format not one of the MOS:DATE approved formats
return false; -- date format not one of the MOS:DATE approved formats
end
if param ~= 'date' then -- CITEREF disambiguation only allowed in |date=; |year= & |publication-date= promote to date
if anchor_year:match ('%l$') then
return false;
end
end
end


Line 906: Line 912:
end
end


-- yMd is not supported at en.wiki; if yMd is supported at your wiki, uncomment the next line
-- yMd is not supported at en.wiki; when yMd is supported at your wiki, uncomment the next line
-- if 'yMd' == format_param and in_array (pattern_idx, {'yMd', 'Md-dy', 'd-dMy', 'dM-dMy', 'Md-Mdy', 'dMy-dMy', 'Mdy-Mdy'}) then -- these formats not convertable; yMd not supported at en.wiki
-- if 'yMd' == format_param and in_array (pattern_idx, {'yMd', 'Md-dy', 'd-dMy', 'dM-dMy', 'Md-Mdy', 'dMy-dMy', 'Mdy-Mdy'}) then -- these formats not convertable; yMd not supported at en.wiki
-- if yMd is supported at your wiki, remove or comment-out the next line
if 'yMd' == format_param then -- yMd not supported at en.wiki; when yMd is supported at your wiki, remove or comment-out this line
if 'yMd' == format_param then -- yMd not supported at en.wiki
return; -- not a reformattable date
return; -- not a reformattable date
end
end
Line 926: Line 931:
};
};


if t.a then -- if this date has an anchor year capture
if t.a then -- if this date has an anchor year capture (all convertable date formats except ymd)
t.y = t.a; -- use the anchor year capture when reassembling the date
if t.y2 then -- for year range date formats
t.y2 = t.a; -- use the anchor year capture when reassembling the date
else -- here for single date formats (except ymd)
t.y = t.a; -- use the anchor year capture when reassembling the date
end
end
end


if tonumber(t.m) then -- if raw month is a number (converting from ymd)
if tonumber(t.m) then -- if raw month is a number (converting from ymd)
if 's' == mon_len then -- if we are to use abbreviated month names
if 's' == mon_len then -- if we are to use abbreviated month names
t.m = cfg.date_names['inv_local_s'][tonumber(t.m)]; -- convert it to a month name
t.m = cfg.date_names['inv_local_short'][tonumber(t.m)]; -- convert it to a month name
else
else
t.m = cfg.date_names['inv_local_l'][tonumber(t.m)]; -- convert it to a month name
t.m = cfg.date_names['inv_local_long'][tonumber(t.m)]; -- convert it to a month name
end
end
t.d = t.d:gsub ('0(%d)', '%1'); -- strip leading '0' from day if present
t.d = t.d:gsub ('0(%d)', '%1'); -- strip leading '0' from day if present
Line 949: Line 958:
t[mon] = get_month_number (t[mon]); -- get the month number for this month (is length agnostic)
t[mon] = get_month_number (t[mon]); -- get the month number for this month (is length agnostic)
if 0 == t[mon] then return; end -- seasons and named dates can't be converted
if 0 == t[mon] then return; end -- seasons and named dates can't be converted
t[mon] = (('s' == mon_len) and cfg.date_names['inv_local_s'][t[mon]]) or cfg.date_names['inv_local_l'][t[mon]]; -- fetch month name according to length
t[mon] = (('s' == mon_len) and cfg.date_names['inv_local_short'][t[mon]]) or cfg.date_names['inv_local_long'][t[mon]]; -- fetch month name according to length
end
end
end
end
Line 1,036: Line 1,045:
end -- if
end -- if
end -- for
end -- for
return result; -- declare boolean result and done
return result; -- declare boolean result and done
end
end


Line 1,068: Line 1,077:
--[[-------------------------< D A T E _ N A M E _ X L A T E >------------------------------------------------
--[[-------------------------< D A T E _ N A M E _ X L A T E >------------------------------------------------


Attempts to translate English month names to local-language month names using names supplied by MediaWiki's
Attempts to translate English date names to local-language date names using names supplied by MediaWiki's
date parser function.  This is simple name-for-name replacement and may not work for all languages.
date parser function.  This is simple name-for-name replacement and may not work for all languages.


Line 1,082: Line 1,091:
local date;
local date;
local sources_t = {
{cfg.date_names.en.long, cfg.date_names.inv_local_long}, -- for translating long English month names to long local month names
{cfg.date_names.en.short, cfg.date_names.inv_local_short}, -- short month names
{cfg.date_names.en.quarter, cfg.date_names.inv_local_quarter}, -- quarter date names
{cfg.date_names.en.season, cfg.date_names.inv_local_season}, -- season date nam
{cfg.date_names.en.named, cfg.date_names.inv_local_named}, -- named dates
}
local function is_xlateable (month) -- local function to get local date name that replaces existing English-language date name
for _, date_names_t in ipairs (sources_t) do -- for each sequence table in date_names_t
if date_names_t[1][month] then -- if date name is English month (long or short), quarter, season or named and
if date_names_t[2][date_names_t[1][month]] then -- if there is a matching local date name
return date_names_t[2][date_names_t[1][month]]; -- return the local date name
end
end
end
end
for param_name, param_val in pairs(date_parameters_list) do -- for each date-holding parameter in the list
for param_name, param_val in pairs(date_parameters_list) do -- for each date-holding parameter in the list
if is_set(param_val.val) then -- if the parameter has a value
if is_set(param_val.val) then -- if the parameter has a value
date = param_val.val;
date = param_val.val;
for month in mw.ustring.gmatch (date, '%a+') do -- iterate through all dates in the date (single date or date range)
for month in mw.ustring.gmatch (date, '[%a ]+') do -- iterate through all date names in the date (single date or date range)
if cfg.date_names.en.long[month] then
month = mw.text.trim (month); -- this because quarterly dates contain whitespace
mode = 'F'; -- English name is long so use long local name
xlate = is_xlateable (month); -- get translate <month>; returns translation or nil
elseif cfg.date_names.en.short[month] then
mode = 'M'; -- English name is short so use short local name
-- if cfg.date_names.en.long[month] then -- long month dates
else
-- if cfg.date_names.inv_local_long[cfg.date_names.en.long[month]] then
mode = nil; -- not an English month name; could be local language month name or an English season name
-- xlate = cfg.date_names.inv_local_long[cfg.date_names.en.long[month]];
end
-- end
---- mode = 'F'; -- English name is long so use long local name
if mode then -- might be a season
-- elseif cfg.date_names.en.short[month] then -- short month dates
xlate = lang_object:formatDate(mode, '1' .. month); -- translate the month name to this local language
-- if cfg.date_names.inv_local_short[cfg.date_names.en.short[month]] then
-- xlate = cfg.date_names.inv_local_short[cfg.date_names.en.short[month]];
-- end
---- mode = 'M'; -- English name is short so use short local name
-- elseif cfg.date_names.en.quarter[month] then -- quarter dates
-- if cfg.date_names.inv_local_quarter[cfg.date_names.en.quarter[month]] then
-- xlate = cfg.date_names.inv_local_quarter[cfg.date_names.en.quarter[month]];
-- end
-- elseif cfg.date_names.en.season[month] then -- season dates
-- if cfg.date_names.inv_local_season[cfg.date_names.en.season[month]] then
-- xlate = cfg.date_names.inv_local_season[cfg.date_names.en.season[month]];
-- end
-- elseif cfg.date_names.en.named[month] then -- named dates
-- if cfg.date_names.inv_local_named[cfg.date_names.en.named[month]] then
-- xlate = cfg.date_names.inv_local_named[cfg.date_names.en.named[month]];
-- end
-- else
-- xlate=nil; -- not an English month name; could be local language month name
---- mode = nil; -- not an English month name; could be local language month name or an English season name
-- end
 
if xlate then
-- if mode then -- might be a season
-- xlate = lang_object:formatDate(mode, '1' .. month); -- translate the month name to this local language
date = mw.ustring.gsub (date, month, xlate); -- replace the English with the translation
date = mw.ustring.gsub (date, month, xlate); -- replace the English with the translation
date_parameters_list[param_name].val = date; -- save the translated date
date_parameters_list[param_name].val = date; -- save the translated date