Module:Citation/CS1/Whitelist: Difference between revisions

    From Nonbinary Wiki
    m>Trappist the monk
    (Synch from sandbox;)
     
    (33 intermediate revisions by 7 users not shown)
    Line 1: Line 1:
    --[[
     
    Because a steady-state signal conveys no useful information, whitelist.basic_arguments[] list items now can have three values:
    --[[--------------------------< 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 can have three values:
    true - these parameters are valid and supported parameters
    true - these parameters are valid and supported parameters
    false - these parameters are deprecated but still supported
    false - these parameters are deprecated but still supported
    nil - these parameters are no longer supported (when setting a parameter to nil, leave a comment stating the reasons for invalidating the parameter)
    discouraged - pre-deprecation purgatory; may someday be deprecated; or not
    nil - these parameters are no longer supported. remove entirely
    ]]
    ]]
    whitelist = {


    basic_arguments = {
    local basic_arguments = {
        ['accessdate'] = true,
    ['accessdate'] = 'discouraged',
        ['agency'] = true,
    ['access-date'] = true,
        ['airdate'] = true,
    ['agency'] = true,
        ['albumlink'] = false, -- deprecated; set to nil after 1 October 2014; a unique alias of titlelink used by old cite AV media notes
    ['archivedate'] = 'discouraged',
        ['albumtype'] = nil, -- controled inappropriate functionality in the old cite AV media notes
    ['archive-date'] = true,
        ['archivedate'] = true,
    ['archive-format'] = true,
        ['archive-date'] = true,
    ['archiveurl'] = 'discouraged',
        ['archiveurl'] = true,
    ['archive-url'] = true,
        ['archive-url'] = true,
    ['article'] = 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
    ['article-url'] = true,
        ['arxiv'] = true,
    ['article-url-access'] = true,
        ['ARXIV'] = true,
    ['arxiv'] = true, -- cite arxiv; here because allowed in cite ... as identifier
        ['asin'] = true,
    ['asin'] = true,
        ['ASIN'] = true,
    ['ASIN'] = true,
        ['asin-tld'] = true,
    ['asin-tld'] = true,
        ['ASIN-TLD'] = true,
    ['at'] = true,
        ['at'] = true,
    ['author'] = true,
        ['author'] = true,
    ['author-first'] = true,
        ['Author'] = true,
    ['author-given'] = true,
        ['author-first'] = true,
    ['author-last'] = true,
        ['authorformat'] = true,
    ['author-surname'] = true,
        ['author-format'] = true,
    ['authorlink'] = 'discouraged',
        ['author-last'] = true,
    ['author-link'] = true,
        ['authorlink'] = true,
    ['author-mask'] = true,
        ['author-link'] = true,
    ['authors'] = true,
        ['authormask'] = true,
    ['bibcode'] = true,
        ['author-mask'] = true,
    ['bibcode-access'] = true,
        ['author-name-separator'] = true,
    ['biorxiv'] = true, -- cite biorxiv; here because allowed in cite ... as identifier
        ['authors'] = true,
    ['booktitle'] = false,
        ['author-separator'] = true,
    ['book-title'] = true,
        ['bibcode'] = true,
    ['cartography'] = true,
        ['BIBCODE'] = true,
    ['chapter'] = true,
        ['booktitle'] = true,
    ['chapter-format'] = true,
    ['callsign']=true, -- cite interview
    ['chapterurl'] = false,
        ['cartography'] = true,
    ['chapter-url'] = true,
        ['chapter'] = true,
    ['chapter-url-access'] = true,
        ['chapterlink'] = true,
    ['citeseerx'] = true, -- cite citeseerx; here because allowed in cite ... as identifier
        ['chapterurl'] = true,
    ['collaboration'] = true,
        ['chapter-url'] = true,
    ['conference'] = true,
    ['city']=true, -- cite interview
    ['conference-format'] = true,
        ['coauthor'] = false,
    ['conference-url'] = true,
        ['coauthors'] = false,
    ['contribution'] = true,
        ['cointerviewers'] = false, -- cite interview
    ['contribution-format'] = true,
        ['conference'] = true,
    ['contribution-url'] = true,
        ['conferenceurl'] = true,
    ['contribution-url-access'] = true,
        ['conference-url'] = true,
    ['contributor'] = true,
        ['contribution'] = true,
    ['contributor-first'] = true,
        ['contributionurl'] = true,
    ['contributor-given'] = true,
        ['contribution-url'] = true,
    ['contributor-last'] = true,
        ['date'] = true,
    ['contributor-surname'] = true,
        ['day'] = false,
    ['contributor-link'] = true,
        ['deadurl'] = true,
    ['contributor-mask'] = true,
        ['degree'] = true,
    ['date'] = true,
        ['department'] = true,
    ['degree'] = true,
        ['dictionary'] = true,
    ['department'] = true,
        ['director'] = false, -- deprecated; set to nil after 1 October 2014; a unique alias of author used by old cite DVD-notes
    ['df'] = true,
        ['displayauthors'] = true,
    ['dictionary'] = true,
        ['display-authors'] = true,
    ['display-authors'] = true,
        ['displayeditors'] = true,
    ['display-contributors'] = true,
        ['display-editors'] = true,
    ['display-editors'] = true,
        ['docket'] = true,
    ['display-interviewers'] = true,
        ['doi'] = true,
    ['display-subjects'] = true,
        ['DOI'] = true,
    ['display-translators'] = true,
        ['DoiBroken'] = true,
    ['docket'] = true,
        ['doi_brokendate'] = true,
    ['doi'] = true,
        ['doi_inactivedate'] = true,
    ['DOI'] = true,
        ['edition'] = true,
    ['doi-access'] = true,
        ['editor'] = true,
    ['doi-broken-date'] = true,
        ['Editor'] = true,
    ['edition'] = true,
        ['editor-first'] = true,
    ['editor'] = true,
        ['editorformat'] = true,
    ['editor-first'] = true,
        ['editor-format'] = true,
    ['editor-given'] = true,
        ['EditorGiven'] = true,
    ['editor-last'] = true,
        ['editor-last'] = true,
    ['editor-surname'] = true,
        ['editorlink'] = true,
    ['editor-link'] = true,
        ['editor-link'] = true,
    ['editor-mask'] = true,
        ['editormask'] = true,
    ['eissn'] = true,
        ['editor-mask'] = true,
    ['EISSN'] = true,
        ['editor-name-separator'] = true,
    ['encyclopaedia'] = true,
        ['editors'] = true,
    ['encyclopedia'] = true,
        ['editor-separator'] = true,
    ['entry'] = true,
        ['EditorSurname'] = true,
    ['entry-format'] = true,
        ['embargo'] = true,
    ['entry-url'] = true,
        ['Embargo'] = true,
    ['entry-url-access'] = true,
        ['encyclopaedia'] = true,
    ['eprint'] = true, -- cite arxiv; here because allowed in cite ... as identifier
        ['encyclopedia'] = true,
    ['event'] = true, -- synonym of conference in /Config, but used in Cite speech?
        ['entry'] = true,
    ['first'] = true,
        ['episodelink'] = true,
    ['format'] = true,
        ['event'] = true,
    ['given'] = true,
        ['eventurl'] = true,
    ['hdl'] = true,
        ['first'] = true,
    ['HDL'] = true,
        ['format'] = true,
    ['hdl-access'] = true,
        ['given'] = true,
    ['host'] = true,
        ['host'] = true,
    ['id'] = true,
        ['id'] = true,
    ['ID'] = true,
        ['ID'] = true,
    ['institution'] = true,
        ['ignoreisbnerror'] = true,
    ['interviewer'] = true,
        ['ignore-isbn-error'] = true,
    ['interviewer-first'] = true,
        ['in'] = true,
    ['interviewer-given'] = true,
        ['inset'] = true,
    ['interviewer-last'] = true,
        ['institution'] = true,
    ['interviewer-surname'] = true,
    ['interviewer'] = true, --cite interview
    ['interviewer-link'] = true,
        ['isbn'] = true,
    ['interviewer-mask'] = true,
        ['ISBN'] = true,
    ['isbn'] = true,
        ['isbn13'] = true,
    ['ISBN'] = true,
        ['ISBN13'] = true,
    ['isbn13'] = true,
        ['issn'] = true,
    ['ISBN13'] = true,
        ['ISSN'] = true,
    ['ismn'] = true,
        ['issue'] = true,
    ['ISMN'] = true,
        ['jfm'] = true,
    ['issn'] = true,
        ['JFM'] = true,
    ['ISSN'] = true,
        ['journal'] = true,
    ['issue'] = true,
        ['jstor'] = true,
    ['jfm'] = true,
        ['JSTOR'] = true,
    ['JFM'] = true,
        ['language'] = true,
    ['journal'] = true,
        ['last'] = true,
    ['jstor'] = true,
        ['lastauthoramp'] = true,
    ['JSTOR'] = true,
        ['laydate'] = true,
    ['jstor-access'] = true,
        ['laysource'] = true,
    ['lang'] = true,
        ['laysummary'] = true,
    ['language'] = true,
        ['layurl'] = true,
    ['last'] = true,
        ['lccn'] = true,
    ['lay-date'] = true,
        ['LCCN'] = true,
    ['lay-source'] = true,
        ['location'] = true,
    ['lay-format'] = true,
        ['magazine'] = true,
    ['lay-url'] = true,
        ['medium'] = true,
    ['lccn'] = true,
        ['minutes'] = true,
    ['LCCN'] = true,
        ['month'] = false,
    ['location'] = true,
        ['mr'] = true,
    ['magazine'] = true,
        ['MR'] = true,
    ['medium'] = true,
        ['name-separator'] = true,
    ['minutes'] = true,
        ['network'] = true,
    ['mode'] = true,
        ['newspaper'] = true,
    ['mr'] = true,
        ['nocat'] = true,
    ['MR'] = true,
        ['nopp'] = true,
    ['name-list-style'] = true,
        ['notestitle'] = false, -- deprecated; set to nil after 1 October 2014; a unique alias of chapter used by old cite AV media notes
    ['newspaper'] = true,
        ['notracking'] = true,
    ['nopp'] = false,
        ['no-tracking'] = true,
    ['no-pp'] = true,
        ['number'] = true,
    ['no-tracking'] = true,
        ['oclc'] = true,
    ['number'] = true,
        ['OCLC'] = true,
    ['oclc'] = true,
        ['ol'] = true,
    ['OCLC'] = true,
        ['OL'] = true,
    ['ol'] = true,
        ['origyear'] = true,
    ['OL'] = true,
        ['osti'] = true,
    ['ol-access'] = true,
        ['OSTI'] = true,
    ['orig-date'] = true,
        ['others'] = true,
    ['origyear'] = 'discouraged',
        ['p'] = true,
    ['orig-year'] = true,
        ['page'] = true,
    ['osti'] = true,
        ['pages'] = true,
    ['OSTI'] = true,
        ['people'] = true,
    ['osti-access'] = true,
        ['periodical'] = true,
    ['others'] = true,
        ['place'] = true,
    ['p'] = true,
        ['pmc'] = true,
    ['page'] = true,
        ['PMC'] = true,
    ['pages'] = true,
        ['pmid'] = true,
    ['people'] = true,
        ['PMID'] = true,
    ['periodical'] = true,
        ['postscript'] = true,
    ['place'] = true,
        ['pp'] = true,
    ['pmc'] = true,
        ['PPPrefix'] = true,
    ['PMC'] = true,
        ['PPrefix'] = true,
    ['pmc-embargo-date'] = true,
    ['program']=true, -- cite interview
    ['pmid'] = true,
        ['publicationdate'] = true,
    ['PMID'] = true,
        ['publication-date'] = true,
    ['postscript'] = true,
        ['publicationplace'] = true,
    ['pp'] = true,
        ['publication-place'] = true,
    ['publicationdate'] = false,
        ['publisher'] = true,
    ['publication-date'] = 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
    ['publicationplace'] = false,
        ['quotation'] = true,
    ['publication-place'] = true,
        ['quote'] = true,
    ['publisher'] = true,
        ['ref'] = true,
    ['quotation'] = true,
        ['Ref'] = true,
    ['quote'] = true,
        ['registration'] = true,
    ['quote-page'] = true,
        ['rfc'] = true,
    ['quote-pages'] = true,
        ['RFC'] = true,
    ['ref'] = true,
        ['scale'] = true,
    ['rfc'] = true,
        ['season'] = true,
    ['RFC'] = true,
        ['section'] = true,
    ['sbn'] = true,
        ['sectionurl'] = true,
    ['SBN'] = true,
        ['separator'] = true,
    ['scale'] = true,
        ['series'] = true,
    ['script-article'] = true,
        ['serieslink'] = true,
    ['script-chapter'] = true,
        ['seriesno'] = true,
    ['script-contribution'] = true,
        ['seriesnumber'] = true,
    ['script-entry'] = true,
        ['series-separator'] = true,
    ['script-journal'] = true,
        ['ssrn'] = true,
    ['script-magazine'] = true,
        ['SSRN'] = true,
    ['script-newspaper'] = true,
        ['station'] = true,
    ['script-periodical'] = true,
        ['subject'] = true,
    ['script-quote'] = true,
        ['subjectlink'] = true,
    ['script-section'] = true,
        ['subscription'] = true,
    ['script-title'] = true,
        ['surname'] = true,
    ['script-website'] = true,
        ['template doc demo'] = true,
    ['script-work'] = true,
        ['time'] = true,
    ['season'] = true,
        ['timecaption'] = true,
    ['section'] = true,
        ['title'] = true,
    ['section-format'] = true,
        ['titlelink'] = true,
    ['section-url'] = true,
        ['titleyear'] = false, -- deprecated; set to nil after 1 October 2014; a unique alias of origyear used by old cite DVD-notes
    ['section-url-access'] = true,
        ['trans_chapter'] = true,
    ['series'] = true,
        ['trans-chapter'] = true,
    ['serieslink'] = false,
        ['transcript'] = true,
    ['series-link'] = true,
        ['transcripturl'] = true,
    ['series-no'] = true,
        ['transcript-url'] = true,
    ['series-number'] = true,
        ['trans_title'] = true,
    ['ssrn'] = true, -- cite ssrn; these two here because allowed in cite ... as identifier
        ['trans-title'] = true,
    ['SSRN'] = true,
        ['type'] = true,
    ['subject'] = true,
        ['url'] = true,
    ['subject-link'] = true,
        ['URL'] = true,
    ['subject-mask'] = true,
        ['version'] = true,
    ['surname'] = true,
        ['via'] = true,
    ['s2cid'] = true,
        ['volume'] = true,
    ['S2CID'] = true,
        ['website'] = true,
    ['s2cid-access'] = true,
        ['work'] = true,
    ['template-doc-demo'] = true,
        ['year'] = true,
    ['time'] = true,
        ['zbl'] = true,
    ['time-caption'] = true,
        ['ZBL'] = true,
    ['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-article'] = true,
    ['trans-chapter'] = true,
    ['trans-contribution'] = 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,
    ['version'] = true,
    ['via'] = true,
    ['volume'] = true,
    ['website'] = true,
    ['work'] = true,
    ['year'] = true,
    ['zbl'] = true,
    ['ZBL'] = true,
    }
     
    local 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#'] = 'discouraged',
    ['author#link'] = 'discouraged',
    ['author-mask#'] = true,
    ['author#-mask'] = 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-first#'] = true,
    ['editor#-first'] = 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-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-link#'] = true,
    ['subject#-link'] = true,
    ['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/dicouraged/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 >----------------------
     
    cite arxiv, cite biorxiv, cite citeseerx, 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.
     
    Same conventions for true/false/dicouraged/nil as above.
    ]]
     
    local limited_basic_arguments = {
    ['at'] = true,
    ['author'] = true,
    ['author-first'] = true,
    ['author-given'] = true,
    ['author-last'] = true,
    ['author-surname'] = true,
    ['author-link'] = true,
    ['authorlink'] = 'discouraged',
    ['author-mask'] = true,
    ['authors'] = 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,
    ['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#'] = 'discouraged',
    ['author#link'] = 'discouraged',
    ['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/dicouraged/nil as above.
     
    ]]
     
    local unique_arguments = {
    ['audio-visual'] = {
    ['transcript'] = true,
    ['transcript-format'] = true,
    ['transcripturl'] = false,
    ['transcript-url'] = true,
    },
    episode = {
    ['airdate'] = 'discouraged',
    ['air-date'] = true,
    ['credits'] = true,
    ['episodelink'] = false, -- alias of |title-link=
    ['episode-link'] = true, -- alias of |title-link=
    ['network'] = true,
    ['station'] = true,
    ['transcript'] = true,
    ['transcript-format'] = true,
    ['transcripturl'] = false,
    ['transcript-url'] = true,
    },
    mailinglist = {
    ['mailinglist'] = false,
    ['mailing-list'] = true,
    },
    map = {
    ['inset'] = true,
    ['map'] = true,
    ['map-format'] = true,
    ['mapurl'] = false,
    ['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'] = 'discouraged',
    ['air-date'] = true,
    ['credits'] = true,
    ['episode'] = true, -- cite serial only TODO: make available to cite episode?
    ['episodelink'] = false,
    ['episode-link'] = true, -- alias of |title-link=
    ['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 >------------------------------------------------
    ]]


    numbered_arguments = {
    return {
        ['author#'] = true,
    basic_arguments = basic_arguments,
        ['Author#'] = true,
    numbered_arguments = numbered_arguments,
        ['author-first#'] = true,
    limited_basic_arguments = limited_basic_arguments,
        ['author#-first'] = true,
    limited_numbered_arguments = limited_numbered_arguments,
        ['author-last#'] = true,
        ['author#-last'] = true,
        ['author-link#'] = true,
        ['author#link'] = true,
        ['author#-link'] = true,
        ['authorlink#'] = true,
        ['author-mask#'] = true,
        ['author#mask'] = true,
        ['author#-mask'] = true,
        ['authormask#'] = true,
        ['authors#'] = true,
        ['editor#'] = true,
        ['Editor#'] = true,
        ['editor-first#'] = true,
        ['editor#-first'] = true,
        ['EditorGiven#'] = true,
        ['editor-last#'] = true,
        ['editor#-last'] = true,
        ['editor-link#'] = true,
        ['editor#link'] = true,
        ['editor#-link'] = true,
        ['editorlink#'] = true,
        ['editor-mask#'] = true,
        ['editor#mask'] = true,
        ['editor#-mask'] = true,
        ['editormask#'] = true,
        ['editors#'] = true,
        ['EditorSurname#'] = true,
        ['first#'] = true,
        ['given#'] = true,
        ['last#'] = true,
        ['subject#'] = true,
        ['subjectlink#'] = true,
        ['surname#'] = true,
    },
    };


    return whitelist;
    preprint_arguments = preprint_arguments,
    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
    };

    Latest revision as of 11:41, 21 May 2021

    Documentation for this module may be created at Module:Citation/CS1/Whitelist/doc

    
    --[[--------------------------< 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 can have three values:
    	true - these parameters are valid and supported parameters
    	false - these parameters are deprecated but still supported
    	discouraged - pre-deprecation purgatory; may someday be deprecated; or not
    	nil - these parameters are no longer supported. remove entirely
    	
    ]]
    
    local basic_arguments = {
    	['accessdate'] = 'discouraged',
    	['access-date'] = true,
    	['agency'] = true,
    	['archivedate'] = 'discouraged',
    	['archive-date'] = true,
    	['archive-format'] = true,
    	['archiveurl'] = 'discouraged',
    	['archive-url'] = true,
    	['article'] = true,
    	['article-format'] = 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,
    	['at'] = true,
    	['author'] = true,
    	['author-first'] = true,
    	['author-given'] = true,
    	['author-last'] = true,
    	['author-surname'] = true,
    	['authorlink'] = 'discouraged',
    	['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'] = false,
    	['book-title'] = true,
    	['cartography'] = true,
    	['chapter'] = true,
    	['chapter-format'] = true,
    	['chapterurl'] = false,
    	['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,
    	['conference-url'] = true,
    	['contribution'] = true,
    	['contribution-format'] = 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,
    	['degree'] = true,
    	['department'] = true,
    	['df'] = true,
    	['dictionary'] = true,
    	['display-authors'] = true,
    	['display-contributors'] = true,
    	['display-editors'] = true,
    	['display-interviewers'] = true,
    	['display-subjects'] = true,
    	['display-translators'] = true,
    	['docket'] = true,
    	['doi'] = true,
    	['DOI'] = true,
    	['doi-access'] = true,
    	['doi-broken-date'] = true,
    	['edition'] = true,
    	['editor'] = true,
    	['editor-first'] = true,
    	['editor-given'] = true,
    	['editor-last'] = true,
    	['editor-surname'] = true,
    	['editor-link'] = true,
    	['editor-mask'] = true,
    	['eissn'] = true,
    	['EISSN'] = true,
    	['encyclopaedia'] = true,
    	['encyclopedia'] = true,
    	['entry'] = true,
    	['entry-format'] = true,
    	['entry-url'] = true,
    	['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,
    	['given'] = true,
    	['hdl'] = true,
    	['HDL'] = true,
    	['hdl-access'] = true,
    	['host'] = true,
    	['id'] = true,
    	['ID'] = true,
    	['institution'] = true,
    	['interviewer'] = true,
    	['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,
    	['issue'] = true,
    	['jfm'] = true,
    	['JFM'] = true,
    	['journal'] = true,
    	['jstor'] = true,
    	['JSTOR'] = true,
    	['jstor-access'] = true,
    	['lang'] = true,
    	['language'] = true,
    	['last'] = true,
    	['lay-date'] = true,
    	['lay-source'] = true,
    	['lay-format'] = true,
    	['lay-url'] = true,
    	['lccn'] = true,
    	['LCCN'] = true,
    	['location'] = true,
    	['magazine'] = true,
    	['medium'] = true,
    	['minutes'] = true,
    	['mode'] = true,
    	['mr'] = true,
    	['MR'] = true,
    	['name-list-style'] = true,
    	['newspaper'] = true,
    	['nopp'] = false,
    	['no-pp'] = true,
    	['no-tracking'] = true,
    	['number'] = true,
    	['oclc'] = true,
    	['OCLC'] = true,
    	['ol'] = true,
    	['OL'] = true,
    	['ol-access'] = true,
    	['orig-date'] = true,
    	['origyear'] = 'discouraged',
    	['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,
    	['publicationdate'] = false,
    	['publication-date'] = true,
    	['publicationplace'] = false,
    	['publication-place'] = true,
    	['publisher'] = true,
    	['quotation'] = true,
    	['quote'] = true,
    	['quote-page'] = true,
    	['quote-pages'] = true,
    	['ref'] = 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,
    	['section-url'] = true,
    	['section-url-access'] = true,
    	['series'] = true,
    	['serieslink'] = false,
    	['series-link'] = true,
    	['series-no'] = true,
    	['series-number'] = true,
    	['ssrn'] = true,															-- cite ssrn; these two here because allowed in cite ... as identifier
    	['SSRN'] = true,
    	['subject'] = true,
    	['subject-link'] = true,
    	['subject-mask'] = true,
    	['surname'] = true,
    	['s2cid'] = true,
    	['S2CID'] = true,
    	['s2cid-access'] = true,
    	['template-doc-demo'] = true,
    	['time'] = true,
    	['time-caption'] = true,
    	['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-article'] = true,
    	['trans-chapter'] = true,
    	['trans-contribution'] = 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,
    	['version'] = true,
    	['via'] = true,
    	['volume'] = true,
    	['website'] = true,
    	['work'] = true,
    	['year'] = true,
    	['zbl'] = true,
    	['ZBL'] = true,
    }
    
    local 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#'] = 'discouraged',
    	['author#link'] = 'discouraged',
    	['author-mask#'] = true,
    	['author#-mask'] = 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-first#'] = true,
    	['editor#-first'] = 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-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-link#'] = true,
    	['subject#-link'] = true,
    	['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/dicouraged/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 >----------------------
    
    cite arxiv, cite biorxiv, cite citeseerx, 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.
    
    Same conventions for true/false/dicouraged/nil as above.
    	
    ]]
    
    local limited_basic_arguments = {
    	['at'] = true,
    	['author'] = true,
    	['author-first'] = true,
    	['author-given'] = true,
    	['author-last'] = true,
    	['author-surname'] = true,
    	['author-link'] = true,
    	['authorlink'] = 'discouraged',
    	['author-mask'] = true,
    	['authors'] = 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,
    	['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#'] = 'discouraged',
    	['author#link'] = 'discouraged',
    	['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/dicouraged/nil as above.
    
    ]]
    
    local unique_arguments = {
    	['audio-visual'] = {
    		['transcript'] = true,
    		['transcript-format'] = true,
    		['transcripturl'] = false,
    		['transcript-url'] = true,
    		},
    	episode = {
    		['airdate'] = 'discouraged',
    		['air-date'] = true,
    		['credits'] = true,
    		['episodelink'] = false,												-- alias of |title-link=
    		['episode-link'] = true,												-- alias of |title-link=
    		['network'] = true,
    		['station'] = true,
    		['transcript'] = true,
    		['transcript-format'] = true,
    		['transcripturl'] = false,
    		['transcript-url'] = true,
    		},
    	mailinglist = {
    		['mailinglist'] = false,
    		['mailing-list'] = true,
    		},
    	map = {
    		['inset'] = true,
    		['map'] = true,
    		['map-format'] = true,
    		['mapurl'] = false,
    		['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'] = 'discouraged',
    		['air-date'] = true,
    		['credits'] = true,
    		['episode'] = true,														-- cite serial only TODO: make available to cite episode?
    		['episodelink'] = false,
    		['episode-link'] = true,												-- alias of |title-link=
    		['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,
    	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
    	};