sync from sandbox;
(Created page with " --[[--------------------------< 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 lo...") |
>Trappist the monk (sync from sandbox;) |
||
Line 1: | Line 1: | ||
--[[--------------------------< S U P P O R T E D P A R A M E T E R S >-------------------------------------- | --[[--------------------------< S U P P O R T E D P A R A M E T E R S >-------------------------------------- | ||
Line 70: | Line 5: | ||
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 | nil - these parameters are no longer supported. remove entirely | ||
]] | ]] | ||
local basic_arguments = { | local basic_arguments = { | ||
Line 80: | Line 13: | ||
['access-date'] = true, | ['access-date'] = true, | ||
['agency'] = true, | ['agency'] = true, | ||
['archivedate'] = true, | ['archivedate'] = true, | ||
['archive-date'] = true, | ['archive-date'] = true, | ||
Line 91: | Line 22: | ||
['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, | ||
['asin-tld'] = true, | ['asin-tld'] = true, | ||
['at'] = true, | ['at'] = true, | ||
['author'] = true, | ['author'] = true, | ||
['author-first'] = true, | ['author-first'] = true, | ||
['author-given'] = true, | |||
['author-last'] = true, | ['author-last'] = true, | ||
['author-surname'] = true, | |||
['authorlink'] = true, | ['authorlink'] = true, | ||
['author-link'] = true, | ['author-link'] = true, | ||
['author-mask'] = true, | ['author-mask'] = true, | ||
['authors'] = true, | ['authors'] = true, | ||
['bibcode'] = true, | ['bibcode'] = true, | ||
['bibcode-access'] = true, | ['bibcode-access'] = true, | ||
['biorxiv'] = true, | ['biorxiv'] = true, -- cite biorxiv; here because allowed in cite ... as identifier | ||
['booktitle'] = true, | ['booktitle'] = true, | ||
['book-title'] = true, | ['book-title'] = true, | ||
Line 116: | Line 47: | ||
['chapter-url'] = true, | ['chapter-url'] = true, | ||
['chapter-url-access'] = true, | ['chapter-url-access'] = true, | ||
['citeseerx'] = true, | ['citeseerx'] = true, -- cite citeseerx; here because allowed in cite ... as identifier | ||
['collaboration'] = true, | ['collaboration'] = true, | ||
['conference'] = true, | ['conference'] = true, | ||
['conference-format'] = true, | ['conference-format'] = true, | ||
['conferenceurl'] = | ['conferenceurl'] = false, | ||
['conference-url'] = true, | ['conference-url'] = true, | ||
['contribution'] = true, | ['contribution'] = true, | ||
['contribution-format'] = true, | ['contribution-format'] = true, | ||
['contributionurl'] = | ['contributionurl'] = false, | ||
['contribution-url'] = true, | ['contribution-url'] = true, | ||
['contribution-url-access'] = true, | ['contribution-url-access'] = true, | ||
['contributor'] = true, | ['contributor'] = true, | ||
['contributor-first'] = true, | ['contributor-first'] = 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, | ||
['date'] = true, | ['date'] = true, | ||
['degree'] = true, | ['degree'] = true, | ||
['department'] = true, | ['department'] = true, | ||
['df'] = true, | ['df'] = true, | ||
['dictionary'] = true, | ['dictionary'] = true, | ||
['display-authors'] = true, | ['display-authors'] = true, | ||
['display-contributors'] = true, | ['display-contributors'] = true, | ||
['display-editors'] = true, | ['display-editors'] = true, | ||
['display-interviewers'] = true, | ['display-interviewers'] = true, | ||
['display-subjects'] = true, | |||
['display-translators'] = true, | ['display-translators'] = true, | ||
['docket'] = true, | ['docket'] = true, | ||
Line 154: | Line 80: | ||
['DOI'] = true, | ['DOI'] = true, | ||
['doi-access'] = true, | ['doi-access'] = true, | ||
['doi-broken-date'] = true, | ['doi-broken-date'] = true, | ||
['edition'] = true, | ['edition'] = true, | ||
['editor'] = true, | ['editor'] = true, | ||
Line 162: | Line 86: | ||
['editor-given'] = true, | ['editor-given'] = true, | ||
['editor-last'] = true, | ['editor-last'] = true, | ||
[' | ['editor-surname'] = true, | ||
['editor-link'] = true, | ['editor-link'] = true, | ||
['editor-mask'] = true, | ['editor-mask'] = true, | ||
['eissn'] = true, | ['eissn'] = true, | ||
['EISSN'] = true, | ['EISSN'] = true, | ||
['encyclopaedia'] = true, | ['encyclopaedia'] = true, | ||
['encyclopedia'] = true, | ['encyclopedia'] = true, | ||
Line 177: | Line 97: | ||
['entry-url'] = true, | ['entry-url'] = true, | ||
['entry-url-access'] = 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? | |||
['eprint'] = true, -- cite arxiv | |||
['event'] = true, | |||
['first'] = true, | ['first'] = true, | ||
['format'] = true, | ['format'] = true, | ||
Line 194: | Line 108: | ||
['id'] = true, | ['id'] = true, | ||
['ID'] = true, | ['ID'] = true, | ||
['institution'] = true, | ['institution'] = true, | ||
['interviewer'] = true, | ['interviewer'] = true, | ||
['interviewer-first'] = true, | ['interviewer-first'] = true, | ||
['interviewer-given'] = true, | |||
['interviewer-last'] = true, | ['interviewer-last'] = true, | ||
[' | ['interviewer-surname'] = true, | ||
['interviewer-link'] = true, | ['interviewer-link'] = true, | ||
['interviewer-mask'] = true, | ['interviewer-mask'] = true, | ||
['isbn'] = true, | ['isbn'] = true, | ||
Line 223: | Line 134: | ||
['language'] = true, | ['language'] = true, | ||
['last'] = true, | ['last'] = true, | ||
['laydate'] = false, | |||
['laydate'] = | |||
['lay-date'] = true, | ['lay-date'] = true, | ||
['laysource'] = | ['laysource'] = false, | ||
['lay-source'] = true, | ['lay-source'] = true, | ||
['lay-format'] = true, | ['lay-format'] = true, | ||
['layurl'] = | ['layurl'] = false, | ||
['lay-url'] = true, | ['lay-url'] = true, | ||
['lccn'] = true, | ['lccn'] = true, | ||
Line 238: | Line 145: | ||
['location'] = true, | ['location'] = true, | ||
['magazine'] = true, | ['magazine'] = true, | ||
['medium'] = true, | ['medium'] = true, | ||
['minutes'] = true, | ['minutes'] = true, | ||
['mode'] = true, | ['mode'] = true, | ||
Line 252: | Line 151: | ||
['MR'] = true, | ['MR'] = true, | ||
['name-list-format'] = true, | ['name-list-format'] = true, | ||
[' | ['name-list-style'] = true, | ||
['newspaper'] = true, | ['newspaper'] = true, | ||
['nopp'] = true, | ['nopp'] = true, | ||
['no-pp'] = true, | ['no-pp'] = true, | ||
['no-tracking'] = true, | ['no-tracking'] = true, | ||
['number'] = true, | ['number'] = true, | ||
Line 267: | Line 162: | ||
['OL'] = true, | ['OL'] = true, | ||
['ol-access'] = true, | ['ol-access'] = true, | ||
['orig-date'] = true, | |||
['origyear'] = true, | ['origyear'] = true, | ||
['orig-year'] = true, | ['orig-year'] = true, | ||
Line 281: | Line 177: | ||
['pmc'] = true, | ['pmc'] = true, | ||
['PMC'] = true, | ['PMC'] = true, | ||
['pmc-embargo-date'] = true, | |||
['pmid'] = true, | ['pmid'] = true, | ||
['PMID'] = true, | ['PMID'] = true, | ||
Line 292: | Line 189: | ||
['quotation'] = true, | ['quotation'] = true, | ||
['quote'] = true, | ['quote'] = true, | ||
['quote-page'] = true, | |||
['quote-pages'] = true, | |||
['ref'] = true, | ['ref'] = true, | ||
['rfc'] = true, | ['rfc'] = true, | ||
['RFC'] = true, | ['RFC'] = true, | ||
['sbn'] = true, | |||
['SBN'] = true, | |||
['scale'] = true, | ['scale'] = true, | ||
['script-article'] = true, | ['script-article'] = true, | ||
Line 305: | Line 205: | ||
['script-newspaper'] = true, | ['script-newspaper'] = true, | ||
['script-periodical'] = true, | ['script-periodical'] = true, | ||
['script-quote'] = true, | |||
['script-section'] = true, | ['script-section'] = true, | ||
['script-title'] = true, | ['script-title'] = true, | ||
Line 312: | Line 213: | ||
['section'] = true, | ['section'] = true, | ||
['section-format'] = true, | ['section-format'] = true, | ||
['sectionurl'] = false, | |||
['sectionurl'] = | |||
['section-url'] = true, | ['section-url'] = true, | ||
['section-url-access'] = true, | ['section-url-access'] = true, | ||
Line 319: | Line 219: | ||
['serieslink'] = true, | ['serieslink'] = true, | ||
['series-link'] = true, | ['series-link'] = true, | ||
['seriesno'] = | ['seriesno'] = false, | ||
['series-no'] = true, | ['series-no'] = true, | ||
['series-number'] = true, | ['series-number'] = true, | ||
[' | ['ssrn'] = true, -- cite ssrn; these two here because allowed in cite ... as identifier | ||
['SSRN'] = true, | ['SSRN'] = true, | ||
['subject'] = true, | ['subject'] = true, | ||
['subject-link'] = true, | ['subject-link'] = true, | ||
[' | ['subject-mask'] = true, | ||
['surname'] = true, | ['surname'] = true, | ||
['s2cid'] = true, | |||
['S2CID'] = true, | |||
['s2cid-access'] = true, | |||
['template-doc-demo'] = true, | ['template-doc-demo'] = true, | ||
['time'] = true, | ['time'] = true, | ||
['timecaption'] = | ['timecaption'] = false, | ||
['time-caption'] = true, | ['time-caption'] = true, | ||
['title'] = true, | ['title'] = true, | ||
['titlelink'] = | ['titlelink'] = false, | ||
['title-link'] = true, | ['title-link'] = true, | ||
['translator'] = true, | ['translator'] = true, | ||
['translator-first'] = true, | ['translator-first'] = true, | ||
['translator-given'] = true, | ['translator-given'] = true, | ||
['translator-last'] = true, | |||
['translator-surname'] = true, | ['translator-surname'] = true, | ||
['translator-link'] = true, | ['translator-link'] = true, | ||
Line 361: | Line 253: | ||
['trans-newspaper'] = true, | ['trans-newspaper'] = true, | ||
['trans-periodical'] = true, | ['trans-periodical'] = true, | ||
['trans-quote'] = true, | |||
['trans-section'] = true, | ['trans-section'] = true, | ||
['trans-title'] = true, | ['trans-title'] = true, | ||
Line 386: | Line 279: | ||
['author-first#'] = true, | ['author-first#'] = true, | ||
['author#-first'] = true, | ['author#-first'] = true, | ||
['author-given#'] = true, | |||
['author#-given'] = true, | |||
['author-last#'] = true, | ['author-last#'] = true, | ||
['author#-last'] = true, | ['author#-last'] = true, | ||
['author-surname#'] = true, | |||
['author#-surname'] = true, | |||
['author-link#'] = true, | ['author-link#'] = true, | ||
['author#-link'] = true, | ['author#-link'] = true, | ||
['authorlink#'] = true, | ['authorlink#'] = true, | ||
['author#link'] = true, | |||
['author-mask#'] = true, | ['author-mask#'] = true, | ||
['author#-mask'] = true, | ['author#-mask'] = true, | ||
['contributor#'] = true, | ['contributor#'] = true, | ||
['contributor-first#'] = true, | ['contributor-first#'] = true, | ||
['contributor#-first'] = true, | ['contributor#-first'] = true, | ||
['contributor-given#'] = true, | |||
['contributor#-given'] = true, | |||
['contributor-last#'] = true, | ['contributor-last#'] = true, | ||
['contributor#-last'] = true, | ['contributor#-last'] = true, | ||
['contributor-surname#'] = true, | ['contributor-surname#'] = true, | ||
['contributor#-surname'] = true, | ['contributor#-surname'] = true, | ||
Line 412: | Line 307: | ||
['editor-first#'] = true, | ['editor-first#'] = true, | ||
['editor#-first'] = true, | ['editor#-first'] = true, | ||
['editor-given#'] = true, | |||
['editor#-given'] = true, | ['editor#-given'] = true, | ||
['editor-last#'] = true, | ['editor-last#'] = true, | ||
['editor#-last'] = true, | ['editor#-last'] = true, | ||
['editor-surname#'] = true, | |||
['editor#-surname'] = true, | |||
['editor-link#'] = true, | ['editor-link#'] = true, | ||
['editor#-link'] = true, | ['editor#-link'] = true, | ||
['editor-mask#'] = true, | ['editor-mask#'] = true, | ||
['editor#-mask'] = true, | ['editor#-mask'] = true, | ||
['first#'] = true, | ['first#'] = true, | ||
['given#'] = true, | ['given#'] = true, | ||
Line 432: | Line 323: | ||
['interviewer-first#'] = true, | ['interviewer-first#'] = true, | ||
['interviewer#-first'] = true, | ['interviewer#-first'] = true, | ||
['interviewer-given#'] = true, | |||
['interviewer#-given'] = true, | |||
['interviewer-last#'] = true, | ['interviewer-last#'] = true, | ||
['interviewer#-last'] = true, | ['interviewer#-last'] = true, | ||
['interviewer-surname#'] = true, | |||
['interviewer#-surname'] = true, | |||
['interviewer-link#'] = true, | ['interviewer-link#'] = true, | ||
['interviewer#-link'] = true, | ['interviewer#-link'] = true, | ||
Line 441: | Line 336: | ||
['subject#'] = true, | ['subject#'] = true, | ||
['subject-link#'] = true, | ['subject-link#'] = true, | ||
['subject#-link'] = true, | ['subject#-link'] = true, | ||
[' | ['subject-mask#'] = true, | ||
['subject#-mask'] = true, | |||
['surname#'] = true, | ['surname#'] = true, | ||
['translator#'] = true, | ['translator#'] = true, | ||
['translator-first#'] = true, | ['translator-first#'] = true, | ||
['translator#-first'] = true, | ['translator#-first'] = true, | ||
['translator-given#'] = true, | |||
['translator#-given'] = true, | |||
['translator-last#'] = true, | ['translator-last#'] = true, | ||
['translator#-last'] = true, | ['translator#-last'] = true, | ||
['translator-surname#'] = true, | ['translator-surname#'] = true, | ||
['translator#-surname'] = true, | ['translator#-surname'] = true, | ||
Line 466: | Line 361: | ||
defined in the limited_basic_arguments and limited_numbered_arguments tables. Those lists are supplemented with a | 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 | 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 | local preprint_arguments = { | ||
['ssrn'] = true, | 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, | |||
}, | |||
} | |||
Line 524: | Line 392: | ||
all three templates | all three templates | ||
Same conventions for true/false/nil as above. | |||
]] | ]] | ||
Line 535: | Line 400: | ||
['author'] = true, | ['author'] = true, | ||
['author-first'] = true, | ['author-first'] = true, | ||
['author-given'] = true, | |||
['author-last'] = true, | ['author-last'] = true, | ||
['author-surname'] = true, | |||
['author-link'] = true, | |||
['authorlink'] = true, | ['authorlink'] = true, | ||
['author-mask'] = true, | ['author-mask'] = true, | ||
['authors'] = true, | ['authors'] = true, | ||
Line 544: | Line 410: | ||
['date'] = true, | ['date'] = true, | ||
['df'] = true, | ['df'] = true, | ||
['display-authors'] = true, | ['display-authors'] = true, | ||
['first'] = true, | ['first'] = true, | ||
Line 550: | Line 415: | ||
['language'] = true, | ['language'] = true, | ||
['last'] = true, | ['last'] = true, | ||
['mode'] = true, | ['mode'] = true, | ||
['name-list-format'] = true, | ['name-list-format'] = true, | ||
[' | ['name-list-style'] = true, | ||
['no-tracking'] = true, | ['no-tracking'] = true, | ||
['p'] = true, | ['p'] = true, | ||
Line 569: | Line 430: | ||
['template-doc-demo'] = true, | ['template-doc-demo'] = true, | ||
['title'] = true, | ['title'] = true, | ||
['trans-title'] = true, | |||
['url'] = true, | ['url'] = true, | ||
['URL'] = true, | ['URL'] = true, | ||
Line 579: | Line 441: | ||
['author-first#'] = true, | ['author-first#'] = true, | ||
['author#-first'] = true, | ['author#-first'] = true, | ||
['author-given#'] = true, | |||
['author#-given'] = true, | |||
['author-last#'] = true, | ['author-last#'] = true, | ||
['author#-last'] = true, | ['author#-last'] = true, | ||
['author-surname#'] = true, | |||
['author#-surname'] = true, | |||
['author-link#'] = true, | ['author-link#'] = true, | ||
['author#-link'] = true, | ['author#-link'] = true, | ||
['authorlink#'] = true, | ['authorlink#'] = true, | ||
['author#link'] = true, | |||
['author-mask#'] = true, | ['author-mask#'] = true, | ||
['author#-mask'] = true, | ['author#-mask'] = true, | ||
['first#'] = true, | ['first#'] = true, | ||
['given#'] = true, | ['given#'] = true, | ||
['last#'] = true, | ['last#'] = true, | ||
['surname#'] = true, | ['surname#'] = true, | ||
} | } | ||
--[[--------------------------< U N I Q U E _ A R G U M E N T S >---------------------------------------------- | |||
Some templates have unique parameters. Those templates and their unique parameters are listed here. Keys in this | |||
table are the template's CitationClass parameter value | |||
Same conventions for true/false/nil as above. | |||
]] | |||
local unique_arguments = { | |||
['audio-visual'] = { | |||
['transcript'] = true, | |||
['transcript-format'] = true, | |||
['transcripturl'] = true, | |||
['transcript-url'] = true, | |||
}, | |||
episode = { | |||
['airdate'] = true, | |||
['air-date'] = true, | |||
['credits'] = true, | |||
['episodelink'] = true, -- alias of |title-link= | |||
['episode-link'] = true, -- alias of |title-link= | |||
['network'] = true, | |||
['station'] = true, | |||
['transcript'] = true, | |||
['transcript-format'] = true, | |||
['transcripturl'] = true, | |||
['transcript-url'] = true, | |||
}, | |||
mailinglist = { | |||
['mailinglist'] = true, | |||
['mailing-list'] = true, | |||
}, | |||
map = { | |||
['inset'] = true, | |||
['map'] = true, | |||
['map-format'] = true, | |||
['mapurl'] = true, | |||
['map-url'] = true, | |||
['map-url-access'] = true, | |||
['script-map'] = true, | |||
['sections'] = true, | |||
['sheet'] = true, | |||
['sheets'] = true, | |||
['trans-map'] = true, | |||
}, | |||
newsgroup = { | |||
['message-id'] = true, | |||
['newsgroup'] = true, | |||
}, | |||
serial = { | |||
['airdate'] = true, | |||
['air-date'] = true, | |||
['credits'] = true, | |||
['episode'] = true, -- cite serial only TODO: make available to cite episode? | |||
['episodelink'] = true, -- aliases of |title-link= | |||
['episode-link'] = true, | |||
['network'] = true, | |||
['station'] = true, | |||
}, | |||
} | |||
--[[--------------------------< T E M P L A T E _ L I S T _ G E T >-------------------------------------------- | |||
gets a list of the templates from table t | |||
]] | |||
local function template_list_get (t) | |||
local out = {}; -- a table for output | |||
for k, _ in pairs (t) do -- spin through the table and collect the keys | |||
table.insert (out, k) -- add each key to the output table | |||
end | |||
return out; -- and done | |||
end | |||
Line 604: | Line 546: | ||
limited_basic_arguments = limited_basic_arguments, | limited_basic_arguments = limited_basic_arguments, | ||
limited_numbered_arguments = limited_numbered_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 | |||
}; | }; |