Difference between revisions of "Module:Check bibcode"
Jump to navigation
Jump to search
blackwiki>MusikAnimal m (Protected "Module:Check bibcode": High-risk template or module; match protection with associated template ([Edit=Require autoconfirmed or confirmed access] (indefinite))) |
blackwiki>Trappist the monk (trim whitespace that may be present in template; update to match changes to cs1|2) |
||
| Line 1: | Line 1: | ||
require('Module:No globals'); | require('Module:No globals'); | ||
| − | |||
--[[--------------------------< B I B C O D E >-------------------------------------------------------------------- | --[[--------------------------< B I B C O D E >-------------------------------------------------------------------- | ||
| Line 14: | Line 13: | ||
1–4 must be digits and must represent a year in the range of 1000 – next year | 1–4 must be digits and must represent a year in the range of 1000 – next year | ||
5 must be a letter | 5 must be a letter | ||
| − | + | 6–8 must be letter, digit, ampersand, or dot (ampersand cannot directly precede a dot; &. ) | |
| − | |||
9–18 must be letter, digit, or dot | 9–18 must be letter, digit, or dot | ||
19 must be a letter or dot | 19 must be a letter or dot | ||
| Line 28: | Line 26: | ||
err_type = 'length'; | err_type = 'length'; | ||
else | else | ||
| − | year = id:match ("^(%d%d%d%d)[%a][% | + | year = id:match ("^(%d%d%d%d)[%a][%w&%.][%w&%.][%w&%.][%w.]+[%a%.]$") -- |
if not year then -- if nil then no pattern match | if not year then -- if nil then no pattern match | ||
err_type = 'value'; -- so value error | err_type = 'value'; -- so value error | ||
| Line 57: | Line 55: | ||
]=] | ]=] | ||
| − | function | + | local function check_bibcode (frame) |
| − | local err_type = bibcode (frame.args[1]); | + | local err_type = bibcode (mw.text.trim (frame.args[1])); -- trim leading and trailing white space before evaluation |
if err_type then | if err_type then | ||
return '<span style="font-size:100%" class="error citation-comment">Check bibcode: ' .. err_type .. ' ([[Template:Bibcode#Error_messages|help]])</span>'; | return '<span style="font-size:100%" class="error citation-comment">Check bibcode: ' .. err_type .. ' ([[Template:Bibcode#Error_messages|help]])</span>'; | ||
end | end | ||
| − | return ''; | + | return ''; -- return empty string when bibcode appears to be valid |
end | end | ||
| − | return | + | |
| + | --[[--------------------------< E X P O R T E D F U N C T I O N S >------------------------------------------ | ||
| + | ]] | ||
| + | |||
| + | return { | ||
| + | check_bibcode = check_bibcode, | ||
| + | } | ||
Revision as of 15:08, 20 January 2020
Documentation for this module may be created at Module:Check bibcode/doc
require('Module:No globals');
--[[--------------------------< B I B C O D E >--------------------------------------------------------------------
Validates (sort of) a bibcode id.
Format for bibcodes is specified here: http://adsabs.harvard.edu/abs_doc/help_pages/data.html#bibcodes
But, this: 2015arXiv151206696F is apparently valid so apparently, the only things that really matter are length, 19 characters
and first four digits must be a year. This function makes these tests:
length must be 19 characters
characters in position
1–4 must be digits and must represent a year in the range of 1000 – next year
5 must be a letter
6–8 must be letter, digit, ampersand, or dot (ampersand cannot directly precede a dot; &. )
9–18 must be letter, digit, or dot
19 must be a letter or dot
]]
local function bibcode (id)
local err_type;
local year;
if 19 ~= id:len() then
err_type = 'length';
else
year = id:match ("^(%d%d%d%d)[%a][%w&%.][%w&%.][%w&%.][%w.]+[%a%.]$") --
if not year then -- if nil then no pattern match
err_type = 'value'; -- so value error
else
local next_year = tonumber(os.date ('%Y'))+1; -- get the current year as a number and add one for next year
year = tonumber (year); -- convert year portion of bibcode to a number
if (1000 > year) or (year > next_year) then
err_type = 'year'; -- year out of bounds
end
if id:find('&%.') then
err_type = 'journal'; -- journal abbreviation must not have '&.' (if it does its missing a letter)
end
end
end
return err_type;
end
--[=[-------------------------< E N T R Y P O I N T S >------------------------------------------------------
This module is mostly a copy of the bibcode validation used in [[Module:Citation/CS1]]
call this module with:
{{#invoke:check bibcode|check_bibcode|{{{1|}}}}}
where {{{1|}}} is the bibcode
]=]
local function check_bibcode (frame)
local err_type = bibcode (mw.text.trim (frame.args[1])); -- trim leading and trailing white space before evaluation
if err_type then
return '<span style="font-size:100%" class="error citation-comment">Check bibcode: ' .. err_type .. ' ([[Template:Bibcode#Error_messages|help]])</span>';
end
return ''; -- return empty string when bibcode appears to be valid
end
--[[--------------------------< E X P O R T E D F U N C T I O N S >------------------------------------------
]]
return {
check_bibcode = check_bibcode,
}