Module:Citation/CS1/Whitelist: Difference between revisions

    From Nonbinary Wiki
    (sync from sandbox;)
    (sync from sandbox;)
    Line 15: Line 15:
    ['access-date'] = true,
    ['access-date'] = true,
    ['agency'] = true,
    ['agency'] = true,
    -- ['airdate'] = true, -- cite episode and cite serial only
    -- ['air-date'] = true, -- cite episode and cite serial only
    ['archivedate'] = true,
    ['archivedate'] = true,
    ['archive-date'] = true,
    ['archive-date'] = true,
    Line 26: Line 24:
    ['article-url'] = true,
    ['article-url'] = true,
    ['article-url-access'] = 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,
    Line 68: Line 66:
    ['contributor-link'] = true,
    ['contributor-link'] = true,
    ['contributor-mask'] = true,
    ['contributor-mask'] = true,
    -- ['credits'] = true, -- cite episode, cite serial
    ['date'] = true,
    ['date'] = true,
    ['degree'] = true,
    ['degree'] = true,
    Line 108: Line 105:
    ['entry-url'] = true,
    ['entry-url'] = true,
    ['entry-url-access'] = true,
    ['entry-url-access'] = true,
    -- ['episode'] = true, -- cite serial only TODO: make available to cite episode?
    -- ['episodelink'] = true, -- cite episode and cite serial
    -- ['episode-link'] = true, -- cite episode and cite serial
    ['eprint'] = true, -- cite arxiv; here because allowed in cite ... as identifier
    ['eprint'] = true, -- cite arxiv; here because allowed in cite ... as identifier
    ['event'] = true,
    ['event'] = true,
    Line 169: Line 163:
    ['mailinglist'] = true, -- cite mailing list only
    ['mailinglist'] = true, -- cite mailing list only
    ['mailing-list'] = 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
    ['map-url-access'] = true, -- cite map only
    ['medium'] = true,
    ['medium'] = true,
    -- ['message-id'] = true, -- cite newsgroup
    ['minutes'] = true,
    ['minutes'] = true,
    ['mode'] = true,
    ['mode'] = true,
    Line 181: Line 169:
    ['MR'] = true,
    ['MR'] = true,
    ['name-list-format'] = true,
    ['name-list-format'] = true,
    -- ['network'] = true, -- cite episode and cite serial only
    -- ['newsgroup'] = true, -- cite newsgroup
    ['newspaper'] = true,
    ['newspaper'] = true,
    ['nocat'] = true,
    ['nocat'] = true,
    Line 233: Line 219:
    ['script-journal'] = true,
    ['script-journal'] = true,
    ['script-magazine'] = true,
    ['script-magazine'] = true,
    ['script-map'] = true,
    ['script-newspaper'] = true,
    ['script-newspaper'] = true,
    ['script-periodical'] = true,
    ['script-periodical'] = true,
    Line 243: Line 228:
    ['section'] = true,
    ['section'] = true,
    ['section-format'] = true,
    ['section-format'] = true,
    ['sections'] = true, -- cite map only
    ['sectionurl'] = true,
    ['sectionurl'] = true,
    ['section-url'] = true,
    ['section-url'] = true,
    Line 255: Line 239:
    ['series-number'] = true,
    ['series-number'] = true,
    ['series-separator'] = true,
    ['series-separator'] = true,
    ['sheet'] = true, -- cite map only
    ['sheets'] = true, -- cite map only
    ['ssrn'] = true,
    ['ssrn'] = true,
    ['SSRN'] = true,
    ['SSRN'] = true,
    -- ['station'] = true, -- cite episode and cite serial only
    ['subject'] = true,
    ['subject'] = true,
    ['subjectlink'] = true,
    ['subjectlink'] = true,
    Line 274: Line 255:
    ['titlelink'] = true,
    ['titlelink'] = true,
    ['title-link'] = true,
    ['title-link'] = true,
    ['trans-map'] = true,
    ['transcript'] = true,
    ['transcript'] = true,
    ['transcript-format'] = true,
    ['transcript-format'] = true,
    Line 472: Line 452:
    ['template-doc-demo'] = true,
    ['template-doc-demo'] = true,
    ['title'] = true,
    ['title'] = true,
    ['trans-title'] = true,
    ['url'] = true,
    ['url'] = true,
    ['URL'] = true,
    ['URL'] = true,
    Line 517: Line 498:
    ['network'] = true,
    ['network'] = true,
    ['station'] = true,
    ['station'] = true,
    },
    map = {
    ['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 = {
    newsgroup = {

    Revision as of 13:18, 11 July 2020

    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
    	nil - these parameters are no longer supported. remove entirely
    	
    ]]
    
    local whitelist = {}
    
    local basic_arguments = {
    	['accessdate'] = true,
    	['access-date'] = true,
    	['agency'] = true,
    	['archivedate'] = true,
    	['archive-date'] = true,
    	['archive-format'] = true,
    	['archiveurl'] = true,
    	['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-last'] = true,
    	['authorlink'] = true,
    	['author-link'] = true,
    	['authormask'] = true,
    	['author-mask'] = true,
    	['authors'] = true,
    	['bibcode'] = true,
    	['bibcode-access'] = true,
    	['biorxiv'] = true,
    	['booktitle'] = true,
    	['book-title'] = true,
    	['cartography'] = true,
    	['chapter'] = true,
    	['chapter-format'] = true,
    	['chapterurl'] = true,
    	['chapter-url'] = true,
    	['chapter-url-access'] = true,
    	['citeseerx'] = true,
    	['collaboration'] = true,
    	['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-last'] = true,
    	['contributor-given'] = true,
    	['contributor-surname'] = true,
    	['contributor-link'] = true,
    	['contributor-mask'] = true,
    	['date'] = true,
    	['degree'] = true,
    	['department'] = true,
    	['df'] = true,
    	['dictionary'] = true,
    	['displayauthors'] = true,
    	['display-authors'] = true,
    	['display-contributors'] = true,
    	['displayeditors'] = true,
    	['display-editors'] = true,
    	['display-interviewers'] = true,
    	['display-translators'] = true,
    	['docket'] = true,
    	['doi'] = true,
    	['DOI'] = true,
    	['doi-access'] = true,
    	['doi-broken'] = true,
    	['doi-broken-date'] = true,
    	['doi-inactive-date'] = true,
    	['edition'] = true,
    	['editor'] = true,
    	['editor-first'] = true,
    	['editor-given'] = true,
    	['editor-last'] = true,
    	['editorlink'] = true,
    	['editor-link'] = true,
    	['editormask'] = true,
    	['editor-mask'] = true,
    	['editors'] = true,
    	['editor-surname'] = true,
    	['eissn'] = true,
    	['EISSN'] = true,
    	['embargo'] = 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,
    	['event-format'] = true,
    	['eventurl'] = true,
    	['event-url'] = true,
    	['first'] = true,
    	['format'] = true,
    	['given'] = true,
    	['hdl'] = true,
    	['HDL'] = true,
    	['hdl-access'] = true,
    	['host'] = true,
    	['id'] = true,
    	['ID'] = true,
    	['ignoreisbnerror'] = true,
    	['ignore-isbn-error'] = true,
    	['inset'] = true,
    	['institution'] = true,
    	['interviewer'] = true,
    	['interviewer-first'] = true,
    	['interviewer-last'] = true,
    	['interviewerlink'] = true,
    	['interviewer-link'] = true,
    	['interviewermask'] = 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,
    	['lastauthoramp'] = true,
    	['last-author-amp'] = true,
    	['laydate'] = true,
    	['lay-date'] = true,
    	['laysource'] = true,
    	['lay-source'] = 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
    	['medium'] = true,
    	['minutes'] = true,
    	['mode'] = true,
    	['mr'] = true,
    	['MR'] = true,
    	['name-list-format'] = true,
    	['newspaper'] = true,
    	['nocat'] = true,
    	['no-cat'] = true,
    	['nopp'] = true,
    	['no-pp'] = true,
    	['notracking'] = true,
    	['no-tracking'] = true,
    	['number'] = true,
    	['oclc'] = true,
    	['OCLC'] = true,
    	['ol'] = true,
    	['OL'] = true,
    	['ol-access'] = 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,
    	['pmid'] = true,
    	['PMID'] = true,
    	['postscript'] = true,
    	['pp'] = true,
    	['publicationdate'] = true,
    	['publication-date'] = true,
    	['publicationplace'] = true,
    	['publication-place'] = true,
    	['publisher'] = true,
    	['quotation'] = true,
    	['quote'] = 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-section'] = true,
    	['script-title'] = true,
    	['script-website'] = true,
    	['script-work'] = true,
    	['season'] = true,
    	['section'] = true,
    	['section-format'] = true,
    	['sectionurl'] = true,
    	['section-url'] = true,
    	['section-url-access'] = true,
    	['series'] = true,
    	['serieslink'] = true,
    	['series-link'] = true,
    	['seriesno'] = true,
    	['series-no'] = true,
    	['seriesnumber'] = true,
    	['series-number'] = true,
    	['series-separator'] = true,
    	['ssrn'] = true,
    	['SSRN'] = true,
    	['subject'] = true,
    	['subjectlink'] = true,
    	['subject-link'] = true,
    	['surname'] = true,
    	['s2cid'] = true,
    	['S2CID'] = true,
    	['s2cid-access'] = true,
    	['template-doc-demo'] = true,
    	['time'] = true,
    	['timecaption'] = true,
    	['time-caption'] = true,
    	['title'] = true,
    	['titlelink'] = true,
    	['title-link'] = true,
    	['transcript'] = true,
    	['transcript-format'] = true,
    	['transcripturl'] = true,
    	['transcript-url'] = true,
    	['translator'] = true,
    	['translator-first'] = true,
    	['translator-last'] = true,
    	['translator-given'] = 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-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-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,
    	['contributor#'] = true,
    	['contributor-first#'] = true,
    	['contributor#-first'] = true,
    	['contributor-last#'] = true,
    	['contributor#-last'] = true,
    	['contributor-given#'] = true,
    	['contributor#-given'] = 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-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-last#'] = true,
    	['interviewer#-last'] = 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#'] = true,
    	['surname#'] = true,
    	['translator#'] = true,
    	['translator-first#'] = true,
    	['translator#-first'] = true,
    	['translator-last#'] = true,
    	['translator#-last'] = true,
    	['translator-given#'] = true,
    	['translator#-given'] = 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,														-- cite arxiv only
    		['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.
    	
    ]]
    
    local limited_basic_arguments = {
    	['at'] = true,
    	['author'] = true,
    	['author-first'] = true,
    	['author-last'] = true,
    	['authorlink'] = true,
    	['author-link'] = true,
    	['authormask'] = true,
    	['author-mask'] = true,
    	['authors'] = true,
    	['collaboration'] = true,
    	['date'] = true,
    	['df'] = true,
    	['displayauthors'] = true,
    	['display-authors'] = true,
    	['first'] = true,
    	['given'] = true,
    	['language'] = true,
    	['last'] = true,
    	['lastauthoramp'] = true,
    	['last-author-amp'] = true,
    	['mode'] = true,
    	['name-list-format'] = true,
    	['nocat'] = true,
    	['no-cat'] = true,
    	['notracking'] = 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-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,
    	['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 = {
    	episode = {
    		['airdate'] = true,
    		['air-date'] = true,
    		['credits'] = true,
    		['episodelink'] = true,													-- aliases of |title-link=
    		['episode-link'] = true,
    		['network'] = true,
    		['station'] = true,
    		},
    	map = {
    		['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,
    	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
    	};