Module:Harvc: Difference between revisions

Revision as of 22:52, 28 August 2019

Latest revision as of 16:13, 26 January 2025

(22 intermediate revisions by 6 users not shown)

Line 1:

require('Module:No globalsstrict')

local code_open_tag = '<code styleclass="color: inheritcs1-code">'; -- background:cs1-code inherit;class border:defined inherit;in paddingModule: inherit;">';Citation/CS1/styles.css

local lock_icons = { --icon classes are defined in Module:Citation/CS1/styles.css

['registration'] = {'id-lock-registration', 'Free registration required'},

['limited'] = {'id-lock-limited', 'Free access subject to limited trial, subscription normally required'},

['subscription'] = {'id-lock-subscription', 'Paid subscription required'},

}

--[[--------------------------< T A R G E T _ C H E C K >------------------------------------------------------

check to see if target of harvc exists in the page somewhere. Uses the target check mechanism from Module:Footnotes

setting |ignore-errors=yes in {{harvc}} will override this check

]]

local function target_check (anchor_id, ignore)

local whitelist_check = require('Module:Footnotes').target_check

local args = {ignore=ignore, template='Harvc', show=true}

return whitelist_check(anchor_id, args)

end

--[[--------------------------< I S _ S E T >------------------------------------------------------------------

Whether variable is set or not. A varablevariable is set when it is not nil and not empty.

]]

Line 24 ⟶ 44:

c. YYYY

YYYY–YYYY (separator is endash)

YYYY–YY (separator is endash)

when anchor_year present, year portion must be same as year param and must have disambiguator

Line 43 ⟶ 64:

'^(nd)%l?$', -- nd

'^(c%. %d%d%d%d?)%l?$', -- c. YYY or c. YYYY

'^(%d%d%d%d–%d%d%d%d)%l?$', -- YYYY–YYYY

'^(%d%d%d%d–%d%d)%l?$' -- YYYY–YY

}

Line 66 ⟶ 88:

if not ay then

return ' invalid ' .. code_open_tag .. '|anchor-year</code>.'; -- ay not set, so anchor_year is malformed

end

-- if not anchor_year:match ('%l$') then

-- return ' ' .. code_open_tag .. '|anchor-year=</code> missing dab.'; -- anchor_year must end with a disambiguator letter

-- end

if y ~= ay then

Line 100 ⟶ 122:

if is_set (mask) then -- mask this author

mask =if tonumber (mask); -- because the value provided might not be a numberthen

if is_set (mask) then

name = string.rep ('—', mask) -- make a string that number length of mdashes

else

name = mask; -- mask is not a number so use the mask text

end

end

Line 127 ⟶ 150:

local source = ''; -- editor/author date list that forms a CITEREF link to a full citation

local in_text = ' In ';

local result; -- the assemby of the above output

-- form the CITEREF anchor

if is_set (args.id) then

args.id = mw.uri.anchorEncode (args.id)

span_open_tag = '<span id="' .. args.id .. '" class="citation">'; -- for use when contributor name is same as source name

else

span_open_taglocal citeref = '<span id="CITEREF' .. table.concat (args.citeref) .. (is_set (args['anchor-year']) and args['anchor-year'] or args.year) .. '" class="citation">';

citeref = mw.uri.anchorEncode (citeref);

span_open_tag = '<span id="' .. citeref .. '" class="citation">';

end

--[[

form the contributors display list:

if |name-list-formatstyle=harv, display is similar to {{sfn}} and {{harv}}, 1 to 4 last names;

if |display-authors= is empty or omitted, display is similar to cs1|2: display all names in last, first order

if |display-authors=etal then displays all author names in last, first order and append et al.

if value assigned to |display-authors= is less than the number of author last names, displays the specified number of author names in last, first order followed by et al.

]]

if 'harv' ~= args.name_list_formatname_list_style then -- default cs1|2 style contributor list

local i = 1;

local count;

Line 167 ⟶ 192:

count = #args.last; -- set count to display all of the authors

end

while i <= count do

if is_set (contributors) then

Line 178 ⟶ 203:

if true == etal then

contributors = contributors .. ' et al.'; -- append et al.

elseif 'yesamp' == args.last_author_ampname_list_style then

contributors = contributors:gsub('; ([^;]+)$', ' & %1') -- replace last separator with ' & '

end

Line 211 ⟶ 236:

--assemble CITEREF wikilink

local anchor_id;

source = "[[#CITEREF" .. mw.uri.anchorEncode(table.concat ({args.in1, args.in2, args.in3, args.in4, args.year})) .. "|" .. source .. "]]";

local target_err_msg;

if '' ~= args.ref then

anchor_id = mw.uri.anchorEncode (args.ref)

else

source anchor_id = "[[#CITEREF" .. mw.uri.anchorEncode(table.concat ({'CITEREF', args.in1, args.in2, args.in3, args.in4, args.year})) .. "|" .. source .. "]]";

end

target_err_msg = target_check (anchor_id, args.ignore); -- see if there is a target for this anchor_id

source = '[[#' .. anchor_id .. "|" .. source .. "]]";

-- special case for afterword, foreword, introduction, preface

local no_quotes = ({['afterword']=true, ['foreword']=true, ['introduction']=true, ['preface']=true})[args.contribution:lower()];

--combine contribution with url to make external link

if args.url ~= '' then

args.contribution = '[' .. args.url .. ' ' .. args.contribution .. ']'; -- format external link

if args['url-access'] then

if lock_icons[args['url-access']] then

args.contribution = table.concat ({ -- add access icon markup to this item

'<span class="', -- open the opening span tag; icon classes are defined in Module:Citation/CS1/styles.css

lock_icons[args['url-access']][1], -- add the appropriate lock icon class

'" title="', -- and the title attribute

lock_icons[args['url-access']][2], -- for an appropriate tool tip

'">', -- close the opening span tag

args.contribution,

'</span>', -- and close the span

});

end

end

end

Line 245 ⟶ 297:

-- and put it all together

local result = {}; -- the assemby of the above output

result = span_open_tag .. contributors .. ' "' .. args.contribution .. '"' .. args.sepc .. in_text .. source .. args.p .. args.ps .. '</span>' .. args.err_msg;

table.insert (result, span_open_tag);

table.insert (result, contributors);

table.insert (result, no_quotes and ' ' or ' "'); -- foreword, afterword, introduction, preface contributions are not quoted; all other contributions are

table.insert (result, args.contribution);

table.insert (result, no_quotes and '' or '"'); -- foreword, afterword, introduction, preface contributions are not quoted; all other contributions are

table.insert (result, args.sepc);

table.insert (result, in_text);

table.insert (result, source);

table.insert (result, args.p);

table.insert (result, args.ps);

table.insert (result, args.err_msg);

if not is_set(args.err_msg) then

table.insert (result, target_err_msg)

end

table.insert (result, '</span>');

return table.concat (result); -- make a string and done

end

Line 287 ⟶ 354:

args.display_authors = pframe.args['display-authors']; -- the number of contributor names to display; cs1|2 format includes first names

args.name_list_formatname_list_style = pframe.args['name-list-formatstyle'] or ''; -- when set to 'harv' display contributor list in sfn or harv style

args.last_author_ampname_list_style = args.last_author_ampname_list_style:lower(); -- make it case agnostic

args.last_author_amp = pframe.args['last-author-amp'] or -- yes only; |last-author-amp=no does not work (though it does in cs1|2)

pframe.args['lastauthoramp'] or '';

args.last_author_amp = args.last_author_amp:lower(); -- make it case agnostic

if is_set (pframe.args.last) or is_set (pframe.args.last1) or

is_set (pframe.args.author) or is_set (pframe.args.author1) then -- must have at least this to continue

Line 313 ⟶ 378:

end

args.pif 0 == pframe.#args.plast or '';then -- source page number(s)|last= oris ___locationrequired

args.pperr_msg = pframe.args.pperr_msg or.. ' no authors in contributor list.';

end

args.p = pframe.args.p or pframe.args.page or ''; -- source page number(s) or ___location

args.pp = pframe.args.pp or pframe.args.pages or '';

args.loc = pframe.args.loc or '';

args.ref = pframe.args.ref or pframe.args.Ref or ''; -- used to match |ref=<text> in cs1|2 source template

args.ignore = 'yes' == pframe.args['ignore-err']; -- suppress false-positive 'no target' errors

if 'cs2' == pframe.args.mode then

Line 341 ⟶ 412:

pframe.args['chapter-url'] or

pframe.args['contribution-url'] or '';

args['url-access'] = pframe.args['url-access'];

args.year = pframe.args.year or ''; -- required

Line 359 ⟶ 432:

end

return table.concat ({frame:extensionTag ('templatestyles', '', {src='Module:Citation/CS1/styles.css'}), core (args)});

return core (args);

end