Module:Citation/CS1/Whitelist/sandbox: Difference between revisions

Content deleted Content added
and here
reset changes list;
 
(88 intermediate revisions by 9 users not shown)
Line 1:
--[[
History of changes since last sync: 20202024-1008-1017
 
 
2020-10-13: support for |editors= withdrawn; see Help_talk:Citation_Style_1#support_for_%7Ceditors%3D_withdrawn
2020-10-13: support for:
|authormask=, |displayauthors=, |editorlink=, |ignore-isbn-error=, |subjectlink=, |authormask#=, |author#mask=,
|editorlink#=, |editor#link=, |subjectlink#=, |subject#link= withdrawn,|lastauthoramp=, |last-author-amp= withdrawn;
see Help_talk:Citation_Style_1#support_for_various_deprecated_parameters_withdrawn
2020-10-22: Deprecate conferenceurl, laydate, laysource, layurl, seriesno, timecaption, and titlelink.
Dash-versions remain (e.g. conference-url). Remove seriesnumber, event-format, event-url, and eventurl
]]
 
 
--[[--------------------------< S U P P O R T E D P A R A M E T E R S >--------------------------------------
Line 16 ⟶ 11:
true - these parameters are valid and supported parameters
false - these parameters are deprecated but still supported
tracked - these parameters are valid and supported parameters tracked in an eponymous properties category
nil - these parameters are no longer supported. remove entirely
]]
 
local basic_argumentsbasic_arguments_t = {
['accessdate'] = true,
['access-date'] = true,
Line 31 ⟶ 27:
['article'] = true,
['article-format'] = true,
['article-number'] = true, -- {{cite journal}}, {{cite conference}}; {{citation}} when |journal= has a value
['article-url'] = true,
['article-url-access'] = true,
Line 46 ⟶ 43:
['author-link'] = true,
['author-mask'] = true,
['authors'] = true,
['bibcode'] = true,
['bibcode-access'] = true,
['biorxiv'] = true, -- cite biorxiv; here because allowed in cite ... as identifier
['booktitle'] = true,
['book-title'] = true,
['cartography'] = true,
['chapter'] = true,
['chapter-format'] = true,
['chapterurl'] = true,
['chapter-url'] = true,
['chapter-url-access'] = true,
['citeseerx'] = true, -- cite citeseerx; here because allowed in cite ... as identifier
['collaboration'] = true,
['conference'] = true,
['conference-format'] = true,
['conferenceurl'] = false,
['conference-url'] = true,
['contribution'] = true,
['contribution-format'] = true,
['contributionurl'] = true,
['contribution-url'] = true,
['contribution-url-access'] = true,
Line 77 ⟶ 64:
['contributor-mask'] = true,
['date'] = true,
['degree'] = true,
['department'] = true,
['df'] = true,
Line 87 ⟶ 73:
['display-subjects'] = true,
['display-translators'] = true,
['docket'] = true,
['doi'] = true,
['DOI'] = true,
Line 109 ⟶ 94:
['entry-url-access'] = true,
['eprint'] = true, -- cite arxiv; here because allowed in cite ... as identifier
['event'] = true, -- synonym of conference in /Config, but used in Cite speech?
['first'] = true,
['format'] = true,
Line 116 ⟶ 100:
['HDL'] = true,
['hdl-access'] = true,
['host'] = true, -- unique to certain templates?
['id'] = true,
['ID'] = true,
['institution'] = true, -- constrain to cite thesis?
['interviewer'] = true,
['interviewer-first'] = true,
Line 129 ⟶ 113:
['isbn'] = true,
['ISBN'] = true,
['isbn13'] = true,
['ISBN13'] = true,
['ismn'] = true,
['ISMN'] = true,
Line 145 ⟶ 127:
['language'] = true,
['last'] = true,
['laydate'] = false,
['lay-date'] = true,
['laysource'] = false,
['lay-source'] = true,
['lay-format'] = true,
['layurl'] = false,
['lay-url'] = true,
['lccn'] = true,
['LCCN'] = true,
Line 157 ⟶ 132:
['magazine'] = true,
['medium'] = true,
['medrxiv'] = true, -- cite medrxiv; here because allowed in cite ... as identifier
['minutes'] = true,
['minutes'] = true, -- constrain to cite AV media and podcast?
['mode'] = true,
['mr'] = true,
['MR'] = true,
['name-list-format'] = true,
['name-list-style'] = true,
['newspaper'] = true,
['nocat'] = true,
['nopp'] = true,
['no-pp'] = true,
['no-tracking'] = true,
Line 184 ⟶ 157:
['page'] = true,
['pages'] = true,
['people'] = true,
['periodical'] = true,
['place'] = true,
Line 194 ⟶ 166:
['postscript'] = true,
['pp'] = true,
['publicationdate'] = true,
['publication-date'] = true,
['publicationplace'] = true,
['publication-place'] = true,
['publisher'] = true,
Line 212 ⟶ 182:
['script-chapter'] = true,
['script-contribution'] = true,
['script-encyclopaedia'] = true,
['script-encyclopedia'] = true,
['script-entry'] = true,
['script-journal'] = true,
Line 222 ⟶ 194:
['script-website'] = true,
['script-work'] = true,
['season'] = true,
['section'] = true,
['section-format'] = true,
['sectionurl'] = true,
['section-url'] = true,
['section-url-access'] = true,
['series'] = true,
['ssrn'] = true, -- cite ssrn; these three here because allowed in cite ... as identifier
['serieslink'] = true,
['series-link'] = true,
['seriesno'] = false,
['series-no'] = true,
['series-number'] = true,
['ssrn'] = true, -- cite ssrn; these two here because allowed in cite ... as identifier
['SSRN'] = true,
['ssrn-access'] = true,
['subject'] = true,
['subject-first'] = true,
['subject-given'] = true,
['subject-last'] = true,
['subject-link'] = true,
['subject-mask'] = true,
['subject-surname'] = true,
['surname'] = true,
['s2cid'] = true,
Line 244 ⟶ 214:
['s2cid-access'] = true,
['template-doc-demo'] = true,
['time'] = true, -- constrain to cite av media and podcast?
['time-caption'] = true, -- constrain to cite av media and podcast?
['timecaption'] = false,
['time-caption'] = true,
['title'] = true,
['titlelink'] = false,
['title-link'] = true,
['title-note'] = true,
['translator'] = true,
['translator-first'] = true,
Line 260 ⟶ 229:
['trans-chapter'] = true,
['trans-contribution'] = true,
['trans-encyclopaedia'] = true,
['trans-encyclopedia'] = true,
['trans-entry'] = true,
['trans-journal'] = true,
Line 285 ⟶ 256:
['zbl'] = true,
['ZBL'] = true,
}
 
local numbered_argumentsnumbered_arguments_t = {
['author#'] = true,
['author-first#'] = true,
Line 347 ⟶ 318:
['last#'] = true,
['subject#'] = true,
['subject-first#'] = true,
['subject#-first'] = true,
['subject-given#'] = true,
['subject#-given'] = true,
['subject-last#'] = true,
['subject#-last'] = true,
['subject-link#'] = true,
['subject#-link'] = true,
['subject-mask#'] = true,
['subject#-mask'] = true,
['subject-surname#'] = true,
['subject#-surname'] = true,
['surname#'] = true,
['translator#'] = true,
Line 365 ⟶ 344:
['translator-mask#'] = true,
['translator#-mask'] = true,
}
 
 
--[[--------------------------< P R E P R I N T S U P P O R T E D P A R A M E T E R S >--------------------
 
Cite arXiv, cite biorxiv, cite citeseerx, cite medrxiv, and cite ssrn are preprint templates that use the limited set of parameters
set of parameters defined in the limited_basic_arguments and limited_numbered_arguments tables. Those lists are supplemented with a
supplemented with a template-specific list of parameters that are required by the particular template and may be exclusive to one of the
exclusive to one of the preprint templates. Some of these parameters may also be available to the general cs1|2
templates.
 
Same conventions for true/false/tracked/nil as above.
 
]]
 
local preprint_argumentspreprint_arguments_t = {
arxiv = {
['arxiv'] = true, -- cite arxiv and arxiv identifiers
Line 390 ⟶ 370:
citeseerx = {
['citeseerx'] = true,
},
medrxiv = {
['medrxiv'] = true,
},
ssrn = {
['ssrn'] = true,
['SSRN'] = true,
['ssrn-access'] = true,
},
}
Line 400 ⟶ 384:
--[[--------------------------< L I M I T E D S U P P O R T E D P A R A M E T E R S >----------------------
 
cite arxiv, cite biorxiv, cite citeseerx, cite medrxiv, and cite ssrn templates are preprint templates so are
This is an experiment that attempts to use validate() and a limited list of valid parameters to validate the
allowed only a limited subset of parameters allowed to all other cs1|2 templates. The limited subset is defined
parameters provided in a cite arxiv, cite biorxiv, or cite citeseerx templates. These parameters are common to
here.
all three templates
 
This list of parameters also used by {{cite document}}
 
Same conventions for true/false/tracked/nil as above.
]]
 
local limited_basic_argumentslimited_basic_arguments_t = {
['at'] = true,
['author'] = true,
Line 418 ⟶ 404:
['authorlink'] = true,
['author-mask'] = true,
['authors'] = true,
['collaboration'] = true,
['date'] = true,
Line 428 ⟶ 413:
['last'] = true,
['mode'] = true,
['name-list-format'] = true,
['name-list-style'] = true,
['nocat'] = true,
['no-tracking'] = true,
['p'] = true,
Line 444 ⟶ 427:
['title'] = true,
['trans-title'] = true,
['url'] = true,
['URL'] = true,
['vauthors'] = true,
['year'] = true,
}
 
local limited_numbered_argumentslimited_numbered_arguments_t = {
['author#'] = true,
['author-first#'] = true,
Line 478 ⟶ 459:
table are the template's CitationClass parameter value
 
Same conventions for true/false/tracked/nil as above.
 
]]
 
local unique_argumentsunique_arguments_t = {
['audio-visual'] = {
['people'] = true,
['transcript'] = true,
['transcript-format'] = true,
['transcripturl'] = true,
['transcript-url'] = true,
},
conference = {
['book-title'] = true,
['conference'] = true,
['conference-format'] = true,
['conference-url'] = true,
['event'] = true,
},
episode = {
Line 493 ⟶ 481:
['air-date'] = true,
['credits'] = true,
['episodelink'] = true, -- alias of |title-link=
['episode-link'] = true, -- alias of |title-link=
['network'] = true,
['people'] = true,
['season'] = true,
['series-link'] = true,
['series-no'] = true,
['series-number'] = true,
['station'] = true,
['transcript'] = true,
['transcript-format'] = true,
['transcripturl'] = true,
['transcript-url'] = true,
},
mailinglist = {
['mailinglist'] = true,
['mailing-list'] = true,
},
map = {
['cartography'] = true,
['inset'] = true,
['map'] = true,
['map-format'] = true,
['mapurl'] = true,
['map-url'] = true,
['map-url-access'] = true,
Line 522 ⟶ 512:
['message-id'] = true,
['newsgroup'] = true,
},
report = {
['docket'] = true,
},
serial = {
Line 528 ⟶ 521:
['credits'] = true,
['episode'] = true, -- cite serial only TODO: make available to cite episode?
['episodelinkepisode-link'] = true, -- aliasesalias of |title-link=
['episode-link'] = true,
['network'] = true,
['people'] = true,
['series-link'] = true,
['station'] = true,
},
speech = {
['conference'] = true,
['conference-format'] = true,
['conference-url'] = true,
['event'] = true,
},
thesis = {
['degree'] = true,
['docket'] = true,
},
}
 
 
--[[--------------------------< C I T E _ D O C U M E N T >----------------------------------------------------
 
Special case for cite document. This template takes the limited basic and limited enumerated parameters plus
others that are apply only to standalone published sources that cannot be cited any other way; no url, book,
periodical, etc parameters; limited support for name lists and named identifiers.
 
when validating parameters in {{cite document}} templates, the basic and
 
]]
 
local document_arguments_t = {
['bibcode'] = true,
['bibcode-access'] = true,
['doi'] = true,
['DOI'] = true,
['doi-access'] = true,
['doi-broken-date'] = true,
['hdl'] = true,
['HDL'] = true,
['hdl-access'] = true,
['id'] = true,
['ID'] = true,
['jfm'] = true,
['JFM'] = true,
['lang'] = true,
['___location'] = true,
['mr'] = true,
['MR'] = true,
['no-pp'] = true,
['orig-date'] = true,
['origyear'] = true,
['orig-year'] = true,
['osti'] = true,
['OSTI'] = true,
['osti-access'] = true,
['place'] = true,
['publisher'] = true,
['quote-page'] = true,
['quote-pages'] = true,
['script-quote'] = true,
['script-title'] = true,
['title-link'] = true,
['translator'] = true,
['translator-first'] = true,
['translator-given'] = true,
['translator-last'] = true,
['translator-surname'] = true,
['translator-link'] = true,
['translator-mask'] = true,
['trans-quote'] = true,
['type'] = true,
['zbl'] = true,
['ZBL'] = true,
}
 
local document_numbered_arguments_t = {
['translator#'] = true,
['translator-first#'] = true,
['translator#-first'] = true,
['translator-given#'] = true,
['translator#-given'] = true,
['translator-last#'] = true,
['translator#-last'] = true,
['translator-surname#'] = true,
['translator#-surname'] = true,
['translator-link#'] = true,
['translator#-link'] = true,
['translator-mask#'] = true,
['translator#-mask'] = true,
}
 
 
--[[--------------------------< L I S T _ C O M B I N E >------------------------------------------------------
 
makes one table from a list of tables. <lists_t> is a sequence of tables to be combined
 
]]
 
local function list_combine (lists_t)
local out_t = {};
 
for _, list_t in ipairs (lists_t) do -- for each list in <lists_t>
for k, v in pairs (list_t) do -- extract each k/v pair
out_t[k] = v; -- add to <out_t>
end
end
return out_t; -- and done
end
 
 
Line 543 ⟶ 637:
 
local function template_list_get (t)
local outout_t = {}; -- a table for output
for k, _ in pairs (t) do -- spin through the table and collect the keys
table.insert (outout_t, k) -- add each key to the output table
end
return outout_t; -- and done
end
 
Line 555 ⟶ 649:
 
return {
preprint_arguments_t = preprint_arguments_t,
basic_arguments = basic_arguments,
preprint_template_list_t = template_list_get (preprint_arguments_t), -- make a template list from preprint_arguments{} table
numbered_arguments = numbered_arguments,
unique_arguments_t = unique_arguments_t,
limited_basic_arguments = limited_basic_arguments,
unique_param_template_list_t = template_list_get (unique_arguments_t), -- make a template list from unique_arguments{} table
limited_numbered_arguments = limited_numbered_arguments,
 
document_parameters_t = list_combine ({limited_basic_arguments_t, limited_numbered_arguments_t, document_arguments_t, document_numbered_arguments_t});
preprint_arguments = preprint_arguments,
common_parameters_t = list_combine ({basic_arguments_t, numbered_arguments_t});
preprint_template_list = template_list_get (preprint_arguments), -- make a template list from preprint_arguments{} table
limited_parameters_t = list_combine ({limited_basic_arguments_t, limited_numbered_arguments_t});
unique_arguments = unique_arguments,
unique_param_template_list = template_list_get (unique_arguments), -- make a template list from unique_arguments{} table
};