Module:Footnotes/sandbox
< Module:Footnotes
Jump to navigation
Jump to search
Revision as of 15:42, 12 August 2018 by test>Trappist the monk (initial hack at Template:sfnm support;)
Documentation for this module may be created at Module:Footnotes/sandbox/doc
require('Module:No globals');
--[[--------------------------< A R G S _ D E F A U L T >------------------------------------------------------
a table to specify initial values.
]]
local args_default = {
bracket_left = '',
bracket_right = '',
bracket_year_left = '',
bracket_year_right = '',
postscript = '',
page = '',
pages = '',
location = '',
article = '',
page_sep = ", p. ",
pages_sep = ", pp. ",
ref = '',
};
--[[--------------------------< I S _ Y E A R >----------------------------------------------------------------
evaluates param to see if it is one of these forms with or without lowercase letter disambiguator:
YYYY
n.d.
nd
c. YYYY
YYYY–YYYY (separator is endash)
return true when param has a recognized form; false else
]]
local function is_year (param)
return param:match ('^%d%d%d%d?%l?$') or param:match ('^n%.d%.%l?$') or param:match ('^nd%l?$') or param:match ('^c%. %d%d%d%d?%l?$') or param:match ('^%d%d%d%d–%d%d%d%d%l?$');
end
--[[--------------------------< C O R E >----------------------------------------------------------------------
returns an anchor link (CITEREF) formed from one to four author names, year, and insource location (|p=, |pp=, loc=)
]]
local function core( args )
local result;
if args.P5 ~= '' then
if is_year (args.P5) then
result = table.concat ({args.P1, ' et al. ', args.bracket_year_left, args.P5, args.bracket_year_right});
else
args.P5 = ''; -- when P5 not a year don't include in anchor
result = table.concat ({args.P1, ' et al.'}); -- and don't render it
end
elseif args.P4 ~= '' then
if is_year (args.P4) then
result = table.concat ({args.P1, ', ', args.P2, ' & ', args.P3, ' ', args.bracket_year_left, args.P4, args.bracket_year_right}); -- three names and a year
else
result = table.concat ({args.P1, ' et al.'}); -- four names
end
elseif args.P3 ~= '' then
if is_year (args.P3) then
result = table.concat ({args.P1, ' & ', args.P2, ' ', args.bracket_year_left, args.P3, args.bracket_year_right}); -- two names and a year
else
result = table.concat ({args.P1, ', ', args.P2, ' ', ' & ', args.P3}); -- three names
end
elseif args.P2 ~= '' then
if is_year (args.P2) then
result = table.concat ({args.P1, ' ', args.bracket_year_left, args.P2, args.bracket_year_right}); -- one name and year
else
result = table.concat ({args.P1, ' & ', args.P2}); -- two names
end
else
result = args.P1; -- one name
end
-- when author-date result ends with a dot (typically when the last positional parameter holds 'n.d.')
-- and when no in-source location (no |p=, |pp=, or |loc=)
-- and when the first or only character in args.postscript is a dot
-- remove the author-date result trailing dot
-- the author-date result trailing dot will be replaced later with the content of args.postscript (usually a dot)
if ('.' == result:sub(-1)) and ('.' == args.postscript:sub(1)) and ('' == args.page) and ('' == args.pages) and ('' == args.location) then
result = result:gsub ('%.$', '');
end
if args.ref ~= 'none' then
if args.ref ~= '' then
result = table.concat ({'[[', args.article, '#', mw.uri.anchorEncode (args.ref), '|', result, ']]'});
else
result = table.concat ({'[[', args.article, '#CITEREF', mw.uri.anchorEncode (table.concat ({args.P1, args.P2, args.P3, args.P4, args.P5})), '|', result, ']]'});
end
end
if args.page ~= '' then
result = table.concat ({result, args.page_sep, args.page});
elseif args.pages ~= ''then
result = table.concat ({result, args.pages_sep, args.pages});
end
if args.location ~= '' then
result = table.concat ({result, ', ', args.location});
end
result = table.concat ({args.bracket_left, result, args.bracket_right, args.postscript}):gsub ('%s+', ' '); -- strip redundant spaces
return result;
end
--[[--------------------------< A R G S _ F E T C H >---------------------------------------------------------
Because all of the templates share a common set of parameters, a single common function to fetch those parameters
from frame and parent frame.
]]
local function args_fetch (frame, ps)
local args = args_default; -- create a copy of the default table
local pframe = frame:getParent(); -- point to the template's parameter table
for k, v in pairs (frame.args) do -- override defaults with values provided in the #invoke: if any
args[k] = v;
end
args.postscript = pframe.args.postscript or pframe.args.ps or ps;
if 'none' == args.postscript then
args.postscript = '';
end
args.page = pframe.args.p or pframe.args.page or '';
args.pages = pframe.args.pp or pframe.args.pages or '';
args.location = pframe.args.loc or '';
args.ref = pframe.args.ref or pframe.args.Ref or '';
for i, v in ipairs ({'P1', 'P2', 'P3', 'P4', 'P5'}) do -- loop through the five positional parameters and trim if set else empty string
args[v] = (pframe.args[i] and mw.text.trim (pframe.args[i])) or '';
end
return args;
end
--[[--------------------------< H A R V A R D _ C I T A T I O N >----------------------------------------------
common entry point for:
{{harvard citation}} aka {{harv}}
{{Harvard citation no brackets}} aka {{harvnb}}
{{harvcol}}
{{harvcolnb}}
{{harvcoltxt}}
{{Harvard citation text}} aka {{harvtxt}}
{{Harvp}}
Distinguishing features (brackets and page separators) are specified in this module's {{#invoke}} in the respective templates.
]]
local function harvard_citation (frame)
local args = args_fetch (frame, ''); -- get the template and invoke parameters; default postscript is empty string
return core (args);
end
--[[--------------------------< S T R I P _ U R L >------------------------------------------------------------
used only by sfn(). This function fixes an issue with reference tooltip gadget where the tooltip is not displayed
when an insource locator (|p=, |pp=, |loc=) has an external wikilink that contains a # character
strip uri-reserved characters from urls in |p=, |pp-, and |loc= parameters The researved characters are:
!#$&'()*+,/:;=?@[]
]]
local function strip_url (pages)
local escaped_uri;
if not pages or ('' == pages) then
return pages;
end
for uri in pages:gmatch ('%[(%a[%w%+%.%-]*://%S+)') do -- for each external link get the uri
escaped_uri = uri:gsub ("([%(%)%.%%%+%-%*%?%[%^%$%]])", "%%%1" ); -- save a copy with lua pattern characters escaped
uri = uri:gsub ("[!#%$&'%(%)%*%+,/:;=%?@%[%]%.%%]", ''); -- remove reserved characters and '%' because '%20' (space character) is a lua 'invalid capture index'
pages = pages:gsub (escaped_uri, uri, 1); -- replace original uri with the stripped version
end
return pages;
end
--[[--------------------------< S F N >------------------------------------------------------------------------
entry point for {{sfn}} and {{sfnp}}
]]
local function sfn (frame)
local args = args_fetch (frame, '.'); -- get the template and invoke parameters; default postscript is a dot
local result = core (args); -- go make a CITEREF anchor
-- put it all together and then strip redundant spaces
local name = table.concat ({'FOOTNOTE', args.P1, args.P2, args.P3, args.P4, args.P5, strip_url (args.page), strip_url (args.pages), strip_url (args.location)}):gsub ('%s+', ' ');
return frame:extensionTag ({name='ref', args={name=name}, content=result});
end
local function sfnt( frame )
local args = args_default;
args.article = mw.title.getCurrentTitle().subjectPageTitle.fullText;
return f.sfn(frame, args);
end
--[[--------------------------< S F N M >----------------------------------------------------------------------
entry point for {{sfnm}} and {{sfnmp}}
|na1= (e.g., |1a1= or |4a1=) through |na10= – authors of the work cited
|ny= – year
|nloc= – location cited
|np= – page cited
|npp= – pages cited
|nps= – quote or comment; defaults to nothing; unlike e.g. {{sfn}} the value none does not mean nothing; a semicolon (;) will be placed between items regardless of the value of this parameter
|ps= – terminating quote or comment; defaults to period (.)
{{{1}}} = frame.args[1] = frame.args['1a1']
{{{2}}} = frame.args[2] = frame.args['1y']
{{{3}}} = frame.args[3] = frame.args['2a1']
{{{4}}} = frame.args[4] = frame.args['2y']
...
{{{19}}} = frame.args[19] = frame.args['10a1']
{{{20}}} = frame.args[20] = frame.args['10y']
]]
local function sfnm (frame)
local args = args_default; -- create a copy of the default table
local pframe = frame:getParent(); -- point to the template's parameter table
local i; -- index of source; this iss the 'n' in na1, ny, etc
local offset = 0; -- used to calculate positional parameter 'number'
local out = {}; -- table to hold rendered sources
local footnote = {}; -- all author, date, insource location stuff becomes part of the reference's footnote id
for k, v in pairs (frame.args) do -- override defaults with values provided in the #invoke: if any
args[k] = v;
end
args.postscript = pframe.args.postscript or pframe.args.ps or '.'; -- this is the postscript for the whole not for the individual sources
-- if 'none' == args.postscript then -- not an sfnm parameter value; should it be?
-- args.postscript = '';
-- end
table.insert (footnote, 'FOOTNOTE'); -- initialize the footnote id table
for i=1, 10 do -- individual source parameters; TODO remove the artificial limit
if not pframe.args[table.concat ({i, 'a1'})] and not pframe.args[i+offset] then
break; -- no na1 or matching positional parameter so done
end
if pframe.args[i+offset] then -- does this source use positional parameters?
args.P1 = mw.text.trim (pframe.args[i+offset]); -- yes, only one author supported
args.P2 = mw.text.trim (pframe.args[i+offset+1]) or pframe.args[table.concat ({i, 'y'})] or ''; -- when positional author year may or may not also be positional
for j, v in ipairs ({'P3', 'P4', 'P5'}) do -- blank the rest of these for this source
args[v] = '';
end
else -- this source uses named parameters
for j, v in ipairs ({'P1', 'P2', 'P3', 'P4', 'P5'}) do -- initialize for this source
args[v] = '';
end
for j, v in ipairs ({'P1', 'P2', 'P3', 'P4', 'P5'}) do -- extract author and year parameters for this source
args[v] = pframe.args[table.concat ({i, 'a', j})] or ''; -- attempt to assign author name
if '' == args[v] then -- when there wasn't an author name
args[v] = pframe.args[table.concat ({i, 'y'})] or ''; -- attempt to assign year
break; -- done with author/date for this source
end
end
end
args.page = pframe.args[table.concat ({i, 'p'})] or ''; -- insource locations for this source
args.pages = pframe.args[table.concat ({i, 'pp'})] or '';
args.location = pframe.args[table.concat ({i, 'loc'})] or '';
-- args.ref = pframe.args[table.concat ({i, 'ref'})] or ''; -- not an sfnm parameter; should it be?
table.insert (out, core (args)); -- save the rendering of this source
for k, v in ipairs ({'P1', 'P2', 'P3', 'P4', 'P5'}) do -- create the FOOTNOTE id
if '' ~= args[v] then
table.insert (footnote, args[v]);
end
end
for k, v in ipairs ({'page', 'pages', 'loc'}) do -- these done separately so that we can strip uri-reserved characters from extlinked page numbers
if '' ~= args[v] then
table.insert (footnote, strip_url (args[v]))
end
end
offset = offset + 1; -- bump the offset and go around again
end
local name = table.concat (footnote):gsub ('%s+', ' '); -- put the footnote together and strip redundant space
local result = table.concat ({table.concat (out, '; '), args.ps});
return frame:extensionTag ({name='ref', args={name=name}, content=result});
end
--[[--------------------------< E X P O R T T A B L E >------------------------------------------------------
]]
return {
harvard_citation = harvard_citation,
sfn = sfn,
sfnm = sfnm,
sfnt = sfnt,
};