Module:Citation/CS1/Whitelist: Difference between revisions

Revision as of 12:45, 5 December 2015

Latest revision as of 18:39, 17 August 2024

(26 intermediate revisions by 2 users not shown)

Line 1:

--[[--------------------------< P A R A M E T E R S N O T S U P P O R T E D >------------------------------

This is a list of parameters that once were but now are no longer supported:

['albumlink'] = nil, -- unique alias of titlelink used by old cite AV media notes

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

['artist'] = nil, -- unique alias of others used by old cite AV media notes

['Author'] = nil, -- non-standard capitalization

['authorformat'] = nil, -- primarily used to support Vancouver format which functionality now part of name-list-format

['author-format'] = nil, -- primarily used to support Vancouver format which functionality now part of name-list-format

['author-name-separator'] = nil,-- primarily used to support Vancouver format which functionality now part of name-list-format

['author-separator'] = nil, -- primarily used to support Vancouver format which functionality now part of name-list-format

['began'] = nil, -- module handles date ranges; cite episode and cite series

['chapterlink'] = nil, -- if ever necessary to link to a chapter article, |chapter= can be wikilinked

['chapter-link'] = nil, --

['cointerviewers'] = nil, -- unique alias of others used by old cite interview

['day'] = nil, -- deprecated in {{citation/core}} and somehow undeprecated in Module:Citation/CS1 and now finally removed

['director'] = nil, -- unique alias of author used by old cite DVD-notes

['DoiBroken'] = nil, -- not used, non-standard captialization

['Editor'] = nil, -- non-standard capitalization

['editorformat'] = nil, -- primarily used to support Vancouver format which functionality now part of name-list-format

['EditorSurname'] = nil, -- non-standard capitalization

['editor-format'] = nil, -- primarily used to support Vancouver format which functionality now part of name-list-format

['EditorGiven'] = nil, -- non-standard capitalization

['editor-name-separator'] = nil,-- primarily used to support Vancouver format which functionality now part of name-list-format

['editor-separator'] = nil, -- primarily used to support Vancouver format which functionality now part of name-list-format

['Embargo'] = nil, -- not used, non-standard capitalization

['ended'] = nil, -- module handles date ranges; cite episode and cite series

['month'] = nil, -- functionality supported by |date=

['name-separator'] = nil, -- primarily used to support Vancouver format which functionality now part of name-list-format

['notestitle'] = nil, -- unique alias of chapter used by old cite AV media notes

['PPrefix'] = nil, -- non-standard capitalization

['PPPrefix'] = nil, -- not used, non-standard capitalization

['pp-prefix'] = nil, -- not used, not documented

['p-prefix'] = nil, -- not used, not documented

['publisherid'] = nil, -- unique alias of id used by old cite AV media notes and old cite DVD-notes

['Ref'] = nil, -- non-statndard capitalization

['separator'] = nil, -- this functionality now provided by |mode=

['titleyear'] = nil, -- unique alias of origyear used by old cite DVD-notes

['Author#'] = nil, -- non-standard capitalization

['authors#'] = nil, -- no need for multiple lists of author names

['Editor#'] = nil, -- non-standard capitalization

['editors#'] = nil, -- no need for multiple lists of editor names

['EditorGiven#'] = nil, -- non-standard capitalization

['EditorSurname#'] = nil, -- non-standard capitalization

]]

--[[--------------------------< S U P P O R T E D P A R A M E T E R S >--------------------------------------

Line 54 ⟶ 4:

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

]]

local whitelistbasic_arguments_t = {}

local basic_arguments = {

['accessdate'] = true,

['access-date'] = true,

['agency'] = true,

['airdate'] = true,

['air-date'] = true,

['archivedate'] = true,

['archive-date'] = true,

Line 72 ⟶ 19:

['archive-url'] = true,

['article'] = true,

['arxivarticle-format'] = true,

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

['ARXIV'] = true,

['article-url'] = true,

['article-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-first'] = true,

['author-given'] = true,

['author-last'] = true,

['author-surname'] = true,

['authorlink'] = true,

['author-link'] = true,

['authormask'] = true,

['author-mask'] = true,

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

['chapter-format'] = true,

['chapterurl'] = true,

['chapter-url'] = true,

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

['city'] = true, -- cite interview, cite episode, cite serial

['classciteseerx'] = true, -- cite arxivciteseerx; here because allowed in cite and... arxivas identifiersidentifier

['coauthorcollaboration'] = falsetrue, -- deprecated

['coauthors'] = false, -- deprecated

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

['credits'] = true, -- cite episode, cite serial

['date'] = true,

['deadurl'] = true,

['dead-url'] = true,

['degree'] = true,

['department'] = true,

['df'] = true,

['dictionary'] = true,

['displayauthors'] = true,

['display-authors'] = true,

['displayeditorsdisplay-contributors'] = true,

['display-editors'] = true,

['docketdisplay-interviewers'] = true,

['display-subjects'] = true,

['display-translators'] = true,

['doi'] = true,

['DOI'] = true,

['doi-brokenaccess'] = true,

['doi_brokendate'] = true,

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

['doi_inactivedate'] = true,

['doi-inactive-date'] = true,

['edition'] = true,

['editor'] = true,

Line 139 ⟶ 75:

['editor-given'] = true,

['editor-last'] = true,

['editorlinkeditor-surname'] = true,

['editor-link'] = true,

['editormask'] = true,

['editor-mask'] = true,

['editorseissn'] = true,

['editor-surnameEISSN'] = true,

['embargo'] = true,

['encyclopaedia'] = true,

['encyclopedia'] = true,

['entry'] = true,

['entry-format'] = true,

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

['entry-url'] = true,

['episodelink'] = true, -- cite episode and cite serial

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

['episode-link'] = true, -- cite episode and cite serial

['eprint'] = true, -- cite arxiv; andhere arxivbecause identifiersallowed in cite ... as identifier

['event'] = true,

['event-format'] = true,

['eventurl'] = true,

['event-url'] = true,

['first'] = true,

['format'] = true,

['given'] = true,

['hosthdl'] = true,

['HDL'] = true,

['hdl-access'] = true,

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

['id'] = true,

['ID'] = true,

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

['ignoreisbnerror'] = true,

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

['ininterviewer-first'] = true,

['insetinterviewer-given'] = true,

['institutioninterviewer-last'] = true,

['interviewer-surname'] = true, --cite interview

['interviewersinterviewer-link'] = true, --cite interview

['interviewer-mask'] = true,

['isbn'] = true,

['ISBN'] = true,

['isbn13'] = true,

['ISBN13'] = true,

['ismn'] = true,

['ISMN'] = true,

Line 184 ⟶ 116:

['jstor'] = true,

['JSTOR'] = true,

['jstor-access'] = true,

['lang'] = true,

['language'] = true,

['last'] = true,

['lastauthoramp'] = true,

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

['laydate'] = true,

['lay-date'] = true,

['laysource'] = true,

['lay-source'] = true,

['laysummary'] = true,

['lay-summary'] = true,

['lay-format'] = true,

['layurl'] = true,

['lay-url'] = true,

['lccn'] = true,

['LCCN'] = true,

['___location'] = true,

['magazine'] = true,

['mailinglist'] = true, -- cite mailing list only

['mailing-list'] = true, -- cite mailing list only

['map'] = true, -- cite map only

['map-format'] = true, -- cite map only

['mapurl'] = true, -- cite map only

['map-url'] = true, -- cite map only

['medium'] = true,

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

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

['mode'] = true,

['mr'] = true,

['MR'] = true,

['name-list-formatstyle'] = true,

['network'] = true,

['newsgroup'] = true,

['newspaper'] = true,

['nocat'] = true,

['no-cat'] = true,

['nopp'] = true,

['no-pp'] = true,

['notracking'] = true,

['no-tracking'] = true,

['number'] = true,

Line 228 ⟶ 139:

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

['page'] = true,

['pages'] = true,

['people'] = true,

['periodical'] = true,

['place'] = true,

['pmc'] = true,

['PMC'] = true,

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

['pmid'] = true,

['PMID'] = true,

['postscript'] = true,

['pp'] = true,

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

['publicationdate'] = true,

['publication-date'] = true,

['publicationplace'] = true,

['publication-place'] = true,

['publisher'] = true,

['quotation'] = true,

['quote'] = true,

['quote-page'] = true,

['quote-pages'] = 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-encyclopaedia'] = true,

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

['seasonscript-website'] = true,

['script-work'] = true,

['section'] = true,

['section-format'] = true,

['sections'] = true, -- cite map only

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

['series-no'] = true,

['seriesnumber'] = true,

['series-number'] = true,

['series-separator'] = true,

['sheet'] = true, -- cite map only

['sheets'] = true, -- cite map only

['ssrn'] = true,

['SSRN'] = true,

['stationssrn-access'] = true,

['subject'] = true,

['subjectlinksubject-first'] = true,

['subject-given'] = true,

['subject-last'] = true,

['subject-link'] = true,

['subscriptionsubject-mask'] = true,

['subject-surname'] = true,

['surname'] = true,

['template doc demos2cid'] = true,

['S2CID'] = true,

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

['time-caption'] = true,

['title'] = true,

['titlelink'] = true,

['title-link'] = true,

['trans_chaptertitle-note'] = true,

['trans-chapter'] = true,

['trans-map'] = true,

['transcript'] = true,

['transcript-format'] = true,

['transcripturl'] = true,

['transcript-url'] = true,

['trans_title'] = true,

['trans-title'] = true,

['translator'] = true,

['translator-first'] = true,

['translator-lastgiven'] = true,

['translator-last'] = true,

['translator-surname'] = true,

['translator-link'] = true,

['translator-mask'] = true,

['trans-article'] = true,

['trans-chapter'] = true,

['trans-contribution'] = true,

['trans-encyclopaedia'] = true,

['trans-encyclopedia'] = true,

['trans-entry'] = true,

['trans-journal'] = true,

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

Line 319 ⟶ 249:

['zbl'] = true,

['ZBL'] = true,

}

local numbered_argumentsnumbered_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,

['author#-link'] = true,

['authorlink#'] = true,

['author#link'] = true,

['author-mask#'] = true,

['author#mask'] = true,

['author#-mask'] = true,

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

Line 347 ⟶ 283:

['editor-first#'] = true,

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

['editor-mask#'] = true,

['editor#mask'] = true,

['editor#-mask'] = true,

['editormask#'] = 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-first#'] = true,

['subject#-first'] = true,

['subject-given#'] = true,

['subject#-given'] = true,

['subject-last#'] = true,

['subject#-last'] = true,

['subject-link#'] = true,

['subject#link'] = true,

['subject#-link'] = true,

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

}

return {basic_arguments = basic_arguments, numbered_arguments = numbered_arguments};

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

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});

};