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

Revision as of 18:14, 23 March 2014

Latest revision as of 22:48, 17 August 2024

(342 intermediate revisions by 18 users not shown)

Line 1:

--[[

History of changes since last sync: 20142024-0208-1517

2014-03-09: Add subject and subject link for cite interview migration;

2014-03-11: Add artist, albumlink, albumtype, notestitle, publisherid for cite AV media notes;

]]

--[[

--[[--------------------------< 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

niltracked - these parameters are novalid longerand supported (when setting a parameter to nil, leave a comment statingparameters thetracked reasonsin foran invalidatingeponymous theproperties parameter)category

nil - these parameters are no longer supported. remove entirely

]]

whitelist = {

local basic_arguments_t = {

basic_arguments = {

['accessdate'] = true,

['agencyaccess-date'] = true,

['airdateagency'] = true,

['archivedate'] = true,

['albumlink'] = false, -- deprecated; set to nil after 1 October 2014; a unique alias of titlelink used by old cite AV media notes

['archive-date'] = true,

['albumtype'] = nil, -- controled inappropriate functionality in the old cite AV media notes

['archivedatearchive-format'] = true,

['archive-datearchiveurl'] = true,

['archiveurlarchive-url'] = true,

['archive-urlarticle'] = true,

['article-format'] = true,

['article-number'] = true, -- {{cite journal}}, {{cite conference}}; {{citation}} when |journal= has a value

['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,

['ASINasin'] = true,

['asin-tldASIN'] = true,

['ASINasin-TLDtld'] = true,

['at'] = true,

['author'] = true,

['Authorauthor-first'] = true,

['author-firstgiven'] = true,

['authorformatauthor-last'] = true,

['author-formatsurname'] = true,

['author-lastauthorlink'] = true,

['authorlinkauthor-link'] = true,

['author-linkmask'] = true,

['authormaskbibcode'] = true,

['authorbibcode-maskaccess'] = true,

['biorxiv'] = true, -- cite biorxiv; here because allowed in cite ... as identifier

['author-name-separator'] = true,

['authorschapter'] = true,

['authorchapter-separatorformat'] = true,

['bibcodechapter-url'] = true,

['BIBCODEchapter-url-access'] = true,

['citeseerx'] = true, -- cite citeseerx; here because allowed in cite ... as identifier

['booktitle'] = true,

['callsigncollaboration'] = true, -- cite interview

['cartographycontribution'] = true,

['chaptercontribution-format'] = true,

['chapterlinkcontribution-url'] = true,

['chapterurlcontribution-url-access'] = true,

['chapter-urlcontributor'] = true,

['citycontributor-first'] = true, -- cite interview

['coauthorcontributor-given'] = falsetrue,

['coauthorscontributor-last'] = falsetrue,

['contributor-surname'] = true,

['cointerviewers'] = false, -- cite interview

['conferencecontributor-link'] = true,

['conferenceurlcontributor-mask'] = true,

['conference-urldate'] = true,

['contributiondepartment'] = true,

['contributionurldf'] = true,

['contribution-urldictionary'] = true,

['datedisplay-authors'] = true,

['daydisplay-contributors'] = falsetrue,

['deadurldisplay-editors'] = true,

['degreedisplay-interviewers'] = true,

['departmentdisplay-subjects'] = true,

['dictionarydisplay-translators'] = true,

['doi'] = true,

['director'] = false, -- deprecated; set to nil after 1 October 2014; a unique alias of author used by old cite DVD-notes

['displayauthorsDOI'] = true,

['displaydoi-authorsaccess'] = true,

['displayeditorsdoi-broken-date'] = true,

['display-editorsedition'] = true,

['docketeditor'] = true,

['doieditor-first'] = true,

['DOIeditor-given'] = true,

['DoiBrokeneditor-last'] = true,

['doi_brokendateeditor-surname'] = true,

['doi_inactivedateeditor-link'] = true,

['editioneditor-mask'] = true,

['editoreissn'] = true,

['EditorEISSN'] = true,

['editor-firstencyclopaedia'] = true,

['editorformatencyclopedia'] = true,

['editor-formatentry'] = true,

['EditorGivenentry-format'] = true,

['editorentry-lasturl'] = true,

['editorlinkentry-url-access'] = true,

['eprint'] = true, -- cite arxiv; here because allowed in cite ... as identifier

['editor-link'] = true,

['editormaskfirst'] = true,

['editor-maskformat'] = true,

['editor-name-separatorgiven'] = true,

['editorshdl'] = true,

['editor-separatorHDL'] = true,

['EditorSurnamehdl-access'] = true,

['host'] = true, -- unique to certain templates?

['embargo'] = true,

['Embargoid'] = true,

['encyclopaediaID'] = true,

['institution'] = true, -- constrain to cite thesis?

['encyclopedia'] = true,

['entryinterviewer'] = true,

['episodelinkinterviewer-first'] = true,

['eventinterviewer-given'] = true,

['eventurlinterviewer-last'] = true,

['firstinterviewer-surname'] = true,

['formatinterviewer-link'] = true,

['giveninterviewer-mask'] = true,

['hostisbn'] = true,

['idISBN'] = true,

['IDismn'] = true,

['ignoreisbnerrorISMN'] = true,

['ignore-isbn-errorissn'] = true,

['inISSN'] = true,

['insetissue'] = true,

['institutionjfm'] = true,

['interviewerJFM'] = true; --cite interview,

['isbnjournal'] = true,

['ISBNjstor'] = true,

['isbn13JSTOR'] = true,

['ISBN13jstor-access'] = true,

['issnlang'] = true,

['ISSNlanguage'] = true,

['issuelast'] = true,

['jfmlccn'] = true,

['JFMLCCN'] = true,

['journal___location'] = true,

['jstormagazine'] = true,

['JSTORmedium'] = true,

['medrxiv'] = true, -- cite medrxiv; here because allowed in cite ... as identifier

['language'] = true,

['minutes'] = true, -- constrain to cite AV media and podcast?

['last'] = true,

['lastauthorampmode'] = true,

['laydatemr'] = true,

['laysourceMR'] = true,

['laysummaryname-list-style'] = true,

['layurlnewspaper'] = true,

['lccnno-pp'] = true,

['LCCNno-tracking'] = true,

['___locationnumber'] = true,

['magazineoclc'] = true,

['mediumOCLC'] = true,

['minutesol'] = true,

['monthOL'] = falsetrue,

['mrol-access'] = true,

['MRorig-date'] = true,

['name-separatororigyear'] = true,

['networkorig-year'] = true,

['newspaperosti'] = true,

['nocatOSTI'] = true,

['nopposti-access'] = true,

['others'] = true,

['notestitle'] = false; -- deprecated; set to nil after 1 October 2014; a unique alias of chapter used by old cite AV media notes

['notrackingp'] = true,

['no-trackingpage'] = true,

['numberpages'] = true,

['oclcperiodical'] = true,

['OCLCplace'] = true,

['olpmc'] = true,

['OLPMC'] = true,

['origyearpmc-embargo-date'] = true,

['ostipmid'] = true,

['OSTIPMID'] = true,

['otherspostscript'] = true,

['ppp'] = true,

['pagepublication-date'] = true,

['pagespublication-place'] = true,

['peoplepublisher'] = true,

['periodicalquotation'] = true,

['placequote'] = true,

['pmcquote-page'] = true,

['PMCquote-pages'] = true,

['pmidref'] = true,

['PMIDrfc'] = true,

['postscriptRFC'] = true,

['ppsbn'] = true,

['PPPrefixSBN'] = true,

['PPrefixscale'] = true,

['programscript-article'] = true, -- cite interview

['publicationdatescript-chapter'] = true,

['publicationscript-datecontribution'] = true,

['publicationplacescript-encyclopaedia'] = true,

['publicationscript-placeencyclopedia'] = true,

['publisherscript-entry'] = true,

['script-journal'] = 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

['quotationscript-magazine'] = true,

['quotescript-newspaper'] = true,

['refscript-periodical'] = true,

['Refscript-quote'] = true,

['registrationscript-section'] = true,

['rfcscript-title'] = true,

['RFCscript-website'] = true,

['scalescript-work'] = true,

['seasonsection'] = true,

['section-format'] = true,

['sectionurlsection-url'] = true,

['separatorsection-url-access'] = true,

['series'] = true,

['ssrn'] = true, -- cite ssrn; these three here because allowed in cite ... as identifier

['serieslink'] = true,

['seriesnoSSRN'] = true,

['seriesnumberssrn-access'] = true,

['series-separatorsubject'] = true,

['ssrnsubject-first'] = true,

['SSRNsubject-given'] = true,

['stationsubject-last'] = true,

['subject-link'] = true,

['subjectlinksubject-mask'] = true,

['subscriptionsubject-surname'] = true,

['surname'] = true,

['template doc demos2cid'] = true,

['timeS2CID'] = true,

['timecaptions2cid-access'] = true,

['titletemplate-doc-demo'] = true,

['time'] = true, -- constrain to cite av media and podcast?

['titlelink'] = true,

['time-caption'] = true, -- constrain to cite av media and podcast?

['titleyear'] = false, -- deprecated; set to nil after 1 October 2014; a unique alias of origyear used by old cite DVD-notes

['trans_chaptertitle'] = true,

['transtitle-chapterlink'] = true,

['transcripttitle-note'] = true,

['transcripturltranslator'] = true,

['transcripttranslator-urlfirst'] = true,

['trans_titletranslator-given'] = true,

['transtranslator-titlelast'] = true,

['typetranslator-surname'] = true,

['urltranslator-link'] = true,

['URLtranslator-mask'] = true,

['versiontrans-article'] = true,

['viatrans-chapter'] = true,

['volumetrans-contribution'] = true,

['websitetrans-encyclopaedia'] = true,

['worktrans-encyclopedia'] = true,

['yeartrans-entry'] = true,

['zbltrans-journal'] = true,

['ZBLtrans-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,

['volume'] = true,

['website'] = true,

['work'] = true,

['year'] = true,

['zbl'] = true,

['ZBL'] = true,

}

local numbered_arguments_t = {

numbered_arguments = {

['author#'] = true,

['Authorauthor-first#'] = true,

['author#-first#'] = true,

['author#-firstgiven#'] = true,

['author-last#-given'] = true,

['author#-last#'] = true,

['author-link#-last'] = true,

['author-surname#link'] = true,

['author#-linksurname'] = true,

['authorlinkauthor-link#'] = true,

['author-mask#-link'] = true,

['authorauthorlink#mask'] = true,

['author#-masklink'] = true,

['authormaskauthor-mask#'] = true,

['authorsauthor#-mask'] = true,

['editorcontributor#'] = true,

['Editorcontributor-first#'] = true,

['editorcontributor#-first#'] = true,

['editor#contributor-firstgiven#'] = true,

['EditorGivencontributor#-given'] = true,

['editorcontributor-last#'] = true,

['editorcontributor#-last'] = true,

['editorcontributor-linksurname#'] = true,

['editorcontributor#link-surname'] = true,

['editor#contributor-link#'] = true,

['editorlinkcontributor#-link'] = true,

['editorcontributor-mask#'] = true,

['editorcontributor#-mask'] = true,

['editor#-mask'] = true,

['editormaskeditor-first#'] = true,

['editorseditor#-first'] = true,

['EditorSurnameeditor-given#'] = true,

['firsteditor#-given'] = true,

['giveneditor-last#'] = true,

['lasteditor#-last'] = true,

['subjecteditor-surname#'] = true,

['subjectlinkeditor#-surname'] = true,

['surnameeditor-link#'] = true,

['editor#-link'] = true,

},

['editor-mask#'] = true,

};

['editor#-mask'] = 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-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,

['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, cite medrxiv, 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/tracked/nil as above.

]]

local preprint_arguments_t = {

arxiv = {

['arxiv'] = true, -- cite arxiv and arxiv identifiers

['class'] = true,

['eprint'] = true, -- cite arxiv and arxiv identifiers

},

biorxiv = {

['biorxiv'] = true,

},

citeseerx = {

['citeseerx'] = true,

},

medrxiv = {

['medrxiv'] = true,

},

ssrn = {

['ssrn'] = true,

['SSRN'] = true,

['ssrn-access'] = 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 >----------------------

cite arxiv, cite biorxiv, cite citeseerx, cite medrxiv, and cite ssrn templates are preprint templates so are

allowed only a limited subset of parameters allowed to all other cs1|2 templates. The limited subset is defined

here.

This list of parameters also used by {{cite document}}

Same conventions for true/false/tracked/nil as above.

]]

local limited_basic_arguments_t = {

['at'] = true,

['author'] = true,

['author-first'] = true,

['author-given'] = true,

['author-last'] = true,

['author-surname'] = true,

['author-link'] = true,

['authorlink'] = true,

['author-mask'] = true,

['collaboration'] = true,

['date'] = true,

['df'] = true,

['display-authors'] = true,

['first'] = true,

['given'] = true,

['language'] = true,

['last'] = true,

['mode'] = true,

['name-list-style'] = 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,

['vauthors'] = true,

['year'] = true,

}

local limited_numbered_arguments_t = {

['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,

['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/tracked/nil as above.

]]

local unique_arguments_t = {

['audio-visual'] = {

['people'] = true,

['transcript'] = true,

['transcript-format'] = true,

['transcript-url'] = true,

},

conference = {

['book-title'] = true,

['conference'] = true,

['conference-format'] = true,

['conference-url'] = true,

['event'] = true,

},

episode = {

['airdate'] = true,

['air-date'] = true,

['credits'] = true,

['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,

['transcript-url'] = true,

},

mailinglist = {

['mailing-list'] = true,

},

map = {

['cartography'] = true,

['inset'] = true,

['map'] = true,

['map-format'] = 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,

},

report = {

['docket'] = true,

},

serial = {

['airdate'] = true,

['air-date'] = true,

['credits'] = true,

['episode'] = true, -- cite serial only TODO: make available to cite episode?

['episode-link'] = true, -- alias of |title-link=

['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

--[[--------------------------< 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_t = {}; -- a table for output

for k, _ in pairs (t) do -- spin through the table and collect the keys

table.insert (out_t, k) -- add each key to the output table

end

return out_t; -- and done

end

--[[--------------------------< E X P O R T E D T A B L E S >------------------------------------------------

]]

return whitelist;{

preprint_arguments_t = preprint_arguments_t,

preprint_template_list_t = template_list_get (preprint_arguments_t), -- make a template list from preprint_arguments{} table

unique_arguments_t = unique_arguments_t,

unique_param_template_list_t = template_list_get (unique_arguments_t), -- make a template list from unique_arguments{} table

document_parameters_t = list_combine ({limited_basic_arguments_t, limited_numbered_arguments_t, document_arguments_t, document_numbered_arguments_t});

common_parameters_t = list_combine ({basic_arguments_t, numbered_arguments_t});

limited_parameters_t = list_combine ({limited_basic_arguments_t, limited_numbered_arguments_t});

};