Moodul:Citation/CS1/Whitelist: erinevus redaktsioonide vahel

Eemaldatud sisu Lisatud sisu
Resümee puudub
Resümee puudub
1. rida:
 
--[[
--[[--------------------------< S U P P O R T E D P A R A M E T E R S >--------------------------------------
Because a steady-state signal conveys no useful information, whitelist.basic_arguments[] list items now can have three values:
 
Because a steady-state signal conveys no useful information, whitelist.basic_arguments[] list items can have three values:
true - these parameters are valid and supported parameters
false - these parameters are deprecated but still supported
nil - these parameters are no longer supported. (whenremove setting a parameter to nil, leave a comment stating the reasons for invalidating the parameter)entirely
]]
whitelist = {
 
local basic_arguments = {
['accessdate'] = true,
['access-date'] = true,
['agency'] = true,
['airdate'] = true,
['air-date'] = true,
['albumlink'] = false, -- deprecated; set to nil after 1 October 2014; a unique alias of titlelink used by old cite AV media notes
['albumtype'] = nil, -- controled inappropriate functionality in the old cite AV media notes
['archivedate'] = true,
['archive-date'] = true,
['archive-format'] = true,
['archiveurl'] = true,
['archive-url'] = true,
['article'] = true,
['article-format'] = true,
['artist'] = false, -- deprecated; set to nil after 1 October 2014; a unique alias of others used by old cite AV media notes
['arxivarticle-url'] = true,
['ARXIVarticle-url-access'] = true,
['arxiv'] = true, -- cite arxiv; here because allowed in cite ... as identifier
['asin'] = true,
['ASIN'] = true,
['asin-tld'] = true,
['ASIN-TLD'] = true,
['at'] = true,
['author'] = true,
['Author'] = true,
['author-first'] = true,
['authorformatauthor-given'] = true,
['author-format'] = true,
['author-last'] = true,
['author-surname'] = true,
['authorlink'] = true,
['author-link'] = true,
['authormask'] = truefalse, -- deprecated
['author-mask'] = true,
['author-name-separator'] = true,
['authors'] = true,
['author-separator'] = true,
['bibcode'] = true,
['BIBCODEbibcode-access'] = true,
['biorxiv'] = true, -- cite biorxiv; here because allowed in cite ... as identifier
['booktitle'] = true,
['book-title'] = true,
['callsign']=true, -- cite interview
['call-sign']=true, -- cite interview
['cartography'] = true,
['chapter'] = true,
['chapterlinkchapter-format'] = true,
['chapter-link'] = true,
['chapterurl'] = true,
['chapter-url'] = true,
['citychapter-url-access'] = true, -- cite interview
['citeseerx'] = true, -- cite citeseerx; here because allowed in cite ... as identifier
['coauthor'] = false,
['coauthorscollaboration'] = falsetrue,
['cointerviewers'] = false, -- cite interview
['conference'] = true,
['conference-format'] = true,
['conferenceurl'] = true,
['conference-url'] = true,
['contribution'] = true,
['contribution-format'] = true,
['contributionurl'] = true,
['contribution-url'] = true,
['contribution-url-access'] = true,
['contributor'] = true,
['contributor-first'] = true,
['contributor-given'] = true,
['contributor-last'] = true,
['contributor-surname'] = true,
['contributor-link'] = true,
['contributor-mask'] = true,
['date'] = true,
['day'] = false,
['deadurl'] = true,
['dead-url'] = true,
['degree'] = true,
['department'] = true,
['df'] = true,
['dictionary'] = true,
['directordisplayauthors'] = false, -- deprecated; set to nil after 1 October 2014; a unique alias of author used by old cite DVD-notes
['displayauthors'] = true,
['display-authors'] = true,
['displayeditorsdisplay-contributors'] = true,
['display-editors'] = true,
['display-interviewers'] = true,
['display-subjects'] = true,
['display-translators'] = true,
['docket'] = true,
['doi'] = true,
['DOI'] = true,
['DoiBrokendoi-access'] = true,
['doi-broken'] = true,
['doi_brokendate'] = true,
['doi-broken-date'] = true,
['doi_inactivedate'] = true,
['doi-inactive-date'] = true,
['edition'] = true,
['editor'] = true,
['Editor'] = true,
['editor-first'] = true,
['editorformat'] = true,
['editor-format'] = true,
['EditorGiven'] = true,
['editor-given'] = true,
['editor-last'] = true,
['editorlinkeditor-surname'] = true,
['editorlink'] = false, -- deprecated
['editor-link'] = true,
['editormask'] = true,
['editor-mask'] = true,
['editors'] = false, -- deprecated
['editor-name-separator'] = true,
['editorseissn'] = true,
['editor-separatorEISSN'] = true,
['EditorSurname'] = true,
['editor-surname'] = true,
['embargo'] = true,
['Embargo'] = true,
['encyclopaedia'] = true,
['encyclopedia'] = true,
['entry'] = true,
['episodelinkentry-format'] = true,
['episodeentry-linkurl'] = true,
['entry-url-access'] = true,
['eprint'] = true, -- cite arxiv; here because allowed in cite ... as identifier
['event'] = true,
['event-format'] = true,
['eventurl'] = true,
['event-url'] = true,
115. rida ⟶ 109. rida:
['format'] = true,
['given'] = true,
['hdl'] = true,
['HDL'] = true,
['hdl-access'] = true,
['host'] = true,
['id'] = true,
['ID'] = true,
['ignore-isbn-error'] = false, -- deprecated
['ignoreisbnerror'] = true,
['ignore-isbn-error'] = true,
['in'] = true,
['inset'] = true,
['institution'] = true,
['interviewer'] = true, --cite interview
['interviewer-first'] = true,
['interviewer-given'] = true,
['interviewer-last'] = true,
['interviewer-surname'] = true,
['interviewer-link'] = true,
['interviewer-mask'] = true,
['isbn'] = true,
['ISBN'] = true,
['isbn13'] = true,
['ISBN13'] = true,
['ismn'] = true,
['ISMN'] = true,
['issn'] = true,
['ISSN'] = true,
136. rida ⟶ 138. rida:
['jstor'] = true,
['JSTOR'] = true,
['jstor-access'] = true,
['lang'] = true,
['language'] = true,
['last'] = true,
['lastauthoramp'] = truefalse, -- deprecated
['last-author-amp'] = truefalse, -- deprecated
['laydate'] = true,
['lay-date'] = true,
['laysource'] = true,
['lay-source'] = true,
['laysummarylay-format'] = true,
['lay-summary'] = true,
['layurl'] = true,
['lay-url'] = true,
151. rida ⟶ 154. rida:
['LCCN'] = true,
['location'] = true,
['script-title'] = true,
['magazine'] = true,
['medium'] = true,
['minutes'] = true,
['monthmode'] = falsetrue,
['mr'] = true,
['MR'] = true,
['name-separatorlist-format'] = true,
['networkname-list-style'] = true,
['newsgroup'] = true,
['newspaper'] = true,
['nocat'] = true,
['no-cat'] = true,
['nopp'] = true,
['no-pp'] = true,
['notestitle'] = false, -- deprecated; set to nil after 1 October 2014; a unique alias of chapter used by old cite AV media notes
['notracking'] = true,
['no-tracking'] = true,
['number'] = true,
174. rida ⟶ 172. rida:
['ol'] = true,
['OL'] = true,
['ol-access'] = true,
['orig-date'] = true,
['origyear'] = true,
['orig-year'] = true,
['osti'] = true,
['OSTI'] = true,
['osti-access'] = true,
['others'] = true,
['p'] = true,
187. rida ⟶ 188. rida:
['pmc'] = true,
['PMC'] = true,
['pmc-embargo-date'] = true,
['pmid'] = true,
['PMID'] = true,
['postscript'] = true,
['pp'] = true,
['PPPrefix'] = true,
['pp-prefix'] = true,
['PPrefix'] = true,
['p-prefix'] = true,
['program']=true, -- cite interview
['publicationdate'] = true,
['publication-date'] = true,
201. rida ⟶ 198. rida:
['publication-place'] = true,
['publisher'] = true,
['publisherid'] = false, -- deprecated; set to nil after 1 October 2014; a unique alias of others used by old cite AV media notes and old cite DVD-notes
['quotation'] = true,
['quote'] = true,
['quote-page'] = true,
['quote-pages'] = true,
['ref'] = true,
['Ref'] = true,
['registration'] = true,
['rfc'] = true,
['RFC'] = true,
['sbn'] = true,
['SBN'] = true,
['scale'] = true,
['script-article'] = true,
['script-chapter'] = true,
['script-contribution'] = true,
['script-entry'] = true,
['script-journal'] = true,
['script-magazine'] = true,
['script-newspaper'] = true,
['script-periodical'] = true,
['script-quote'] = true,
['script-section'] = true,
['script-title'] = true,
['script-website'] = true,
['script-work'] = true,
['season'] = true,
['section'] = true,
['section-format'] = true,
['sectionurl'] = true,
['section-url'] = true,
['separatorsection-url-access'] = true,
['series'] = true,
['serieslink'] = true,
222. rida ⟶ 234. rida:
['seriesnumber'] = true,
['series-number'] = true,
['ssrn'] = true, -- cite ssrn; these two here because allowed in cite ... as identifier
['series-separator'] = true,
['ssrn'] = true,
['SSRN'] = true,
['station'] = true,
['subject'] = true,
['subjectlink'] = truefalse, -- deprecated
['subject-link'] = true,
['subscriptionsubject-mask'] = true,
['surname'] = true,
['template doc demos2cid'] = true,
['S2CID'] = true,
['s2cid-access'] = true,
['template-doc-demo'] = true,
['time'] = true,
239. rida ⟶ 251. rida:
['titlelink'] = true,
['title-link'] = true,
['translator'] = true,
['titleyear'] = false, -- deprecated; set to nil after 1 October 2014; a unique alias of origyear used by old cite DVD-notes
['trans_chaptertranslator-first'] = true,
['translator-given'] = true,
['translator-last'] = true,
['translator-surname'] = true,
['translator-link'] = true,
['translator-mask'] = true,
['trans-article'] = true,
['trans-chapter'] = true,
['transcripttrans-contribution'] = true,
['transcripturltrans-entry'] = true,
['transcripttrans-urljournal'] = true,
['trans_titletrans-magazine'] = true,
['trans-newspaper'] = true,
['trans-periodical'] = true,
['trans-quote'] = true,
['trans-section'] = true,
['trans-title'] = true,
['trans-website'] = true,
['trans-work'] = true,
['type'] = true,
['url'] = true,
['URL'] = true,
['url-access'] = true,
['url-status'] = true,
['vauthors'] = true,
['veditors'] = true,
['version'] = true,
['via'] = true,
258. rida ⟶ 286. rida:
['zbl'] = true,
['ZBL'] = true,
}
['otsinguaeg'] = true,
['kasutatud'] = true,
['agentuur'] = true,
['arhiiviaeg'] = true,
['arhiivimisaeg'] = true,
['arhiiviurl'] = true,
['arhiivimisurl'] = true,
['autorid'] = true,
['kaasautor'] = true,
['kaasautorid'] = true,
['väljaanne'] = true,
['toimetajad'] = true,
['formaat'] = true,
['keeles'] = true,
['kuu'] = true,
['leheküljed'] = true,
['väljaandja'] = true,
['aeg'] = true,
['pealkiri'] = true,
['aasta'] = true,
['kuupäev'] = true,
['kellaaeg'] = true,
['ajakiri'] = true,
['ajaleht'] = true,
['veebisait'] = true,
},
 
local numbered_arguments = {
['author#'] = true,
['Author#'] = true,
['author-first#'] = true,
['author#-first'] = true,
['author-given#'] = true,
['author#-given'] = true,
['author-last#'] = true,
['author#-last'] = true,
['author-surname#'] = true,
['author#-surname'] = true,
['author-link#'] = true,
['author#link'] = true,
['author#-link'] = true,
['authorlink#'] = true,
['author#link'] = true,
['author-mask#'] = true,
['author#mask'] = true,
['author#-mask'] = true,
['authormask#'] = truefalse, -- deprecated
['author#mask'] = false, -- deprecated
['authors#'] = true,
['contributor#'] = true,
['contributor-first#'] = true,
['contributor#-first'] = true,
['contributor-given#'] = true,
['contributor#-given'] = true,
['contributor-last#'] = true,
['contributor#-last'] = true,
['contributor-surname#'] = true,
['contributor#-surname'] = true,
['contributor-link#'] = true,
['contributor#-link'] = true,
['contributor-mask#'] = true,
['contributor#-mask'] = true,
['editor#'] = true,
['Editor#'] = true,
['editor-first#'] = true,
['editor#-first'] = true,
['EditorGiven#'] = true,
['editor#-given'] = true,
['editor-given#'] = true,
['editor#-given'] = true,
['editor-last#'] = true,
['editor#-last'] = true,
['editor-surname#'] = true,
['editor#-surname'] = true,
['editor-link#'] = true,
['editor#link'] = true,
['editor#-link'] = true,
['editorlink#'] = truefalse, -- deprecated
['editor#link'] = false, -- deprecated
['editor-mask#'] = true,
['editor#mask'] = true,
['editor#-mask'] = true,
['editormask#'] = true,
['editors#'] = true,
['EditorSurname#'] = true,
['editor#-surname'] = true,
['editor-surname#'] = true,
['first#'] = true,
['given#'] = true,
['host#'] = true,
['interviewer#'] = true,
['interviewer-first#'] = true,
['interviewer#-first'] = true,
['interviewer-given#'] = true,
['interviewer#-given'] = true,
['interviewer-last#'] = true,
['interviewer#-last'] = true,
['interviewer-surname#'] = true,
['interviewer#-surname'] = true,
['interviewer-link#'] = true,
['interviewer#-link'] = true,
['interviewer-mask#'] = true,
['interviewer#-mask'] = true,
['last#'] = true,
['subject#'] = true,
['subject-link#'] = true,
['subject#link'] = true,
['subject#-link'] = true,
['subjectlink#'] = truefalse, -- deprecated
['subject#link'] = false, -- deprecated
['subject-mask#'] = true,
['subject#-mask'] = true,
['surname#'] = true,
['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,
}
 
 
--[[--------------------------< 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, and cite ssrn are preprint templates that use the limited set of parameters
defined in the limited_basic_arguments and limited_numbered_arguments tables. Those lists are supplemented with a
template-specific list of parameters that are required by the particular template and may be 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/nil as above.
 
]]
 
local preprint_arguments = {
arxiv = {
['arxiv'] = true, -- cite arxiv and arxiv identifiers
['class'] = true,
['eprint'] = true, -- cite arxiv and arxiv identifiers
},
biorxiv = {
['biorxiv'] = true,
},
citeseerx = {
['citeseerx'] = true,
},
ssrn = {
['ssrn'] = true,
['SSRN'] = true,
},
}
 
 
--[[--------------------------< 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 >----------------------
 
This is an experiment that attempts to use validate() and a limited list of valid parameters to validate the
parameters provided in a cite arxiv, cite biorxiv, or cite citeseerx templates. These parameters are common to
all three templates
 
Same conventions for true/false/nil as above.
]]
['eesnimi#'] = true,
 
['autor-eesnimi#'] = true,
local limited_basic_arguments = {
["perekonnanimi#"] = true,
["autorid#"'at'] = true,
["autor#"'author'] = true,
["autorilink#"'author-first'] = true,
["autorimask#"'author-given'] = true,
["autor#mask"'author-last'] = true,
["toimetaja#'author-eesnimi"surname'] = true,
["toimetaja#'author-perekonnanimi"link'] = true,
["toimetaja-perekonnanimi#"'authorlink'] = true,
["Toimetaja#"'author-mask'] = true,
['authormask'] = false, -- deprecated
["toimetaja#"] = true,
["toimetajad#"'authors'] = true,
["toimetaja-link#"'collaboration'] = true,
["toimetajalink#"'date'] = true,
["toimetaja-mask#"'df'] = true,
["toimetajamask#"'display-authors'] = true,
['displayauthors'] = false, -- deprecated
},
['first'] = true,
};
['given'] = true,
['language'] = true,
['last'] = true,
['last-author-amp'] = false, -- deprecated
['lastauthoramp'] = false, -- deprecated
['mode'] = true,
['name-list-format'] = true,
['name-list-style'] = true,
['nocat'] = true,
['no-tracking'] = true,
['p'] = true,
['page'] = true,
['pages'] = true,
['postscript'] = true,
['pp'] = true,
['quotation'] = true,
['quote'] = true,
['ref'] = true,
['surname'] = true,
['template-doc-demo'] = true,
['title'] = true,
['trans-title'] = true,
['url'] = true,
['URL'] = true,
['vauthors'] = true,
['year'] = true,
}
 
local limited_numbered_arguments = {
['author#'] = true,
['author-first#'] = true,
['author#-first'] = true,
['author-given#'] = true,
['author#-given'] = true,
['author-last#'] = true,
['author#-last'] = true,
['author-surname#'] = true,
['author#-surname'] = true,
['author-link#'] = true,
['author#-link'] = true,
['authorlink#'] = true,
['author#link'] = true,
['author-mask#'] = true,
['author#-mask'] = true,
['authormask#'] = false, -- deprecated
['author#mask'] = false, -- deprecated
['first#'] = true,
['given#'] = true,
['last#'] = true,
['surname#'] = true,
}
 
 
--[[--------------------------< U N I Q U E _ A R G U M E N T S >----------------------------------------------
 
Some templates have unique parameters. Those templates and their unique parameters are listed here. Keys in this
table are the template's CitationClass parameter value
 
Same conventions for true/false/nil as above.
 
]]
 
local unique_arguments = {
['audio-visual'] = {
['transcript'] = true,
['transcript-format'] = true,
['transcripturl'] = true,
['transcript-url'] = true,
},
episode = {
['airdate'] = true,
['air-date'] = true,
['credits'] = true,
['episodelink'] = true, -- alias of |title-link=
['episode-link'] = true, -- alias of |title-link=
['network'] = true,
['station'] = true,
['transcript'] = true,
['transcript-format'] = true,
['transcripturl'] = true,
['transcript-url'] = true,
},
mailinglist = {
['mailinglist'] = true,
['mailing-list'] = true,
},
map = {
['inset'] = true,
['map'] = true,
['map-format'] = true,
['mapurl'] = true,
['map-url'] = true,
['map-url-access'] = true,
['script-map'] = true,
['sections'] = true,
['sheet'] = true,
['sheets'] = true,
['trans-map'] = true,
},
newsgroup = {
['message-id'] = true,
['newsgroup'] = true,
},
serial = {
['airdate'] = true,
['air-date'] = true,
['credits'] = true,
['episode'] = true, -- cite serial only TODO: make available to cite episode?
['episodelink'] = true, -- aliases of |title-link=
['episode-link'] = true,
['network'] = true,
['station'] = true,
},
}
 
 
--[[--------------------------< T E M P L A T E _ L I S T _ G E T >--------------------------------------------
 
gets a list of the templates from table t
 
]]
 
local function template_list_get (t)
local out = {}; -- a table for output
for k, _ in pairs (t) do -- spin through the table and collect the keys
table.insert (out, k) -- add each key to the output table
end
return out; -- and done
end
 
 
--[[--------------------------< E X P O R T E D T A B L E S >------------------------------------------------
]]
 
return {
basic_arguments = basic_arguments,
numbered_arguments = numbered_arguments,
limited_basic_arguments = limited_basic_arguments,
limited_numbered_arguments = limited_numbered_arguments,
 
preprint_arguments = preprint_arguments,
return whitelist;
preprint_template_list = template_list_get (preprint_arguments), -- make a template list from preprint_arguments{} table
unique_arguments = unique_arguments,
unique_param_template_list = template_list_get (unique_arguments), -- make a template list from unique_arguments{} table
};