Module:Citation/CS1/Whitelist: Difference between revisions
Jump to navigation
Jump to search
Content added Content deleted
m (1 revision imported) |
Infobox>Trappist the monk (sync from sandbox;) |
||
Line 1: | 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 |
|||
['ARXIV'] = nil, -- not an initialization |
|||
['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 |
|||
['BIBCODE'] = nil, -- not an initialization |
|||
['callsign'] = nil, -- cite interview removed |
|||
['call-sign'] = nil, -- cite interview removed |
|||
['chapterlink'] = nil, -- if ever necessary to link to a chapter article, |chapter= can be wikilinked |
|||
['chapter-link'] = nil, -- |
|||
['city'] = nil, -- cite interview removed |
|||
['coauthor'] = nil, -- redundant to |authorn=; not made part of metadata |
|||
['coauthors'] = nil, -- redundant to |authorn=; not made part of metadata |
|||
['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 |
|||
['doi_brokendate'] = nil, -- alias of doi-broken-date |
|||
['doi_inactivedate'] = nil, -- alias of doi-inactive-date |
|||
['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 |
|||
['in'] = nil, -- ambiguous between use for language, appearance of a lesser work in an edited work |
|||
['interviewers'] = nil, -- only need InterviewerList support |
|||
['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 |
|||
['program'] = nil, -- cite interview removed |
|||
['publisherid'] = nil, -- unique alias of id used by old cite AV media notes and old cite DVD-notes |
|||
['Ref'] = nil, -- non-standard capitalization |
|||
['separator'] = nil, -- this functionality now provided by |mode= |
|||
['template doc demo'] = nil, -- alias of template doc demo |
|||
['titleyear'] = nil, -- unique alias of origyear used by old cite DVD-notes |
|||
['trans_chapter'] = nil, -- alias of trans-chapter |
|||
['trans_title'] = nil, -- alias of trans-title |
|||
['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 >-------------------------------------- |
--[[--------------------------< 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 |
||
]] |
]] |
||
Line 80: | Line 15: | ||
['access-date'] = true, |
['access-date'] = true, |
||
['agency'] = true, |
['agency'] = true, |
||
['airdate'] = true, |
|||
['air-date'] = true, |
|||
['archivedate'] = true, |
['archivedate'] = true, |
||
['archive-date'] = true, |
['archive-date'] = true, |
||
Line 91: | Line 24: | ||
['article-url'] = true, |
['article-url'] = true, |
||
['article-url-access'] = true, |
['article-url-access'] = true, |
||
['arxiv'] = true, -- cite arxiv; here because allowed in cite ... as identifier |
|||
['arxiv'] = true, |
|||
['asin'] = true, |
['asin'] = true, |
||
['ASIN'] = true, |
['ASIN'] = true, |
||
['asin-tld'] = true, |
['asin-tld'] = true, |
||
['ASIN-TLD'] = false, -- not an identifier but an identifier-modifier |
|||
['at'] = true, |
['at'] = true, |
||
['author'] = true, |
['author'] = true, |
||
Line 117: | Line 49: | ||
['chapter-url-access'] = true, |
['chapter-url-access'] = true, |
||
['citeseerx'] = true, |
['citeseerx'] = true, |
||
['class'] = false, -- cite arxiv only; general use deprecated |
|||
['collaboration'] = true, |
['collaboration'] = true, |
||
['conference'] = true, |
['conference'] = true, |
||
Line 135: | Line 66: | ||
['contributor-link'] = true, |
['contributor-link'] = true, |
||
['contributor-mask'] = true, |
['contributor-mask'] = true, |
||
['credits'] = true, -- cite episode, cite serial |
|||
['date'] = true, |
['date'] = true, |
||
['deadurl'] = false, |
|||
['dead-url'] = false, |
|||
['degree'] = true, |
['degree'] = true, |
||
['department'] = true, |
['department'] = true, |
||
Line 177: | Line 105: | ||
['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 |
||
['episodelink'] = true, -- cite episode and cite serial |
|||
['episode-link'] = true, -- cite episode and cite serial |
|||
['eprint'] = true, -- cite arxiv and arxiv identifiers |
|||
['event'] = true, |
['event'] = true, |
||
['event-format'] = true, |
['event-format'] = true, |
||
Line 229: | Line 154: | ||
['laysource'] = true, |
['laysource'] = true, |
||
['lay-source'] = true, |
['lay-source'] = true, |
||
['laysummary'] = false, |
|||
['lay-summary'] = false, |
|||
['lay-format'] = true, |
['lay-format'] = true, |
||
['layurl'] = true, |
['layurl'] = true, |
||
Line 240: | 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 252: | Line 169: | ||
['MR'] = true, |
['MR'] = true, |
||
['name-list-format'] = true, |
['name-list-format'] = true, |
||
['network'] = true, |
|||
['newsgroup'] = true, |
|||
['newspaper'] = true, |
['newspaper'] = true, |
||
['nocat'] = true, |
['nocat'] = true, |
||
Line 293: | Line 208: | ||
['quote'] = true, |
['quote'] = true, |
||
['ref'] = true, |
['ref'] = true, |
||
['registration'] = false, |
|||
['rfc'] = true, |
['rfc'] = true, |
||
['RFC'] = true, |
['RFC'] = true, |
||
['sbn'] = true, |
|||
['SBN'] = true, |
|||
['scale'] = true, |
['scale'] = true, |
||
['script-article'] = true, |
['script-article'] = true, |
||
Line 312: | 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 324: | 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, |
|||
['subject'] = true, |
['subject'] = true, |
||
['subjectlink'] = true, |
['subjectlink'] = true, |
||
['subject-link'] = true, |
['subject-link'] = true, |
||
['subscription'] = false, |
|||
['surname'] = true, |
['surname'] = true, |
||
['s2cid'] = true, |
|||
['S2CID'] = true, |
|||
['s2cid-access'] = true, |
|||
['template-doc-demo'] = true, |
['template-doc-demo'] = true, |
||
['time'] = true, |
['time'] = true, |
||
Line 341: | 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 466: | Line 379: | ||
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. |
|||
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 (when setting a parameter to nil, leave a comment stating the reasons for invalidating the parameter) |
|||
]] |
|||
--[[--------------------------< C I T E A R X I V >---------------------------------------------------------- |
|||
This is a list of parameters that once were but now are no longer supported: |
|||
['ARXIV'] = nil, -- not an initialization |
|||
['version'] = nil, -- this is the cite arxiv parameter; |version= still supported by other cs1|2 templates |
|||
]] |
]] |
||
local |
local preprint_arguments = { |
||
arxiv = { |
|||
['arxiv'] = true, -- cite arxiv and arxiv identifiers |
|||
['arxiv'] = true, -- cite arxiv and arxiv identifiers |
|||
['class'] = true, -- cite arxiv only |
|||
['eprint'] = true, -- cite arxiv and arxiv identifiers |
|||
} |
|||
}, |
|||
biorxiv = { |
|||
['biorxiv'] = true, |
|||
--[[--------------------------< C I T E B I O R X I V >------------------------------------------------------ |
|||
}, |
|||
citeseerx = { |
|||
]] |
|||
['citeseerx'] = true, |
|||
}, |
|||
local biorxiv_basic_arguments = { |
|||
ssrn = { |
|||
['biorxiv'] = true, |
|||
['ssrn'] = true, |
|||
} |
|||
['SSRN'] = true, |
|||
}, |
|||
} |
|||
--[[--------------------------< C I T E C I T E S E E R X >-------------------------------------------------- |
|||
]] |
|||
local citeseerx_basic_arguments = { |
|||
['citeseerx'] = true, |
|||
} |
|||
--[[--------------------------< C I T E S S R N >------------------------------------------------------------ |
|||
]] |
|||
local ssrn_basic_arguments = { |
|||
['ssrn'] = true, |
|||
['SSRN'] = true, |
|||
} |
|||
Line 524: | Line 410: | ||
all three templates |
all three templates |
||
Same conventions for true/false/nil as above. |
|||
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 (when setting a parameter to nil, leave a comment stating the reasons for invalidating the parameter) |
|||
]] |
]] |
||
Line 569: | 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 593: | Line 477: | ||
['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 = { |
|||
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 |
|||
Line 604: | Line 551: | ||
limited_basic_arguments = limited_basic_arguments, |
limited_basic_arguments = limited_basic_arguments, |
||
limited_numbered_arguments = limited_numbered_arguments, |
limited_numbered_arguments = limited_numbered_arguments, |
||
arxiv_basic_arguments = arxiv_basic_arguments, |
|||
preprint_arguments = preprint_arguments, |
|||
biorxiv_basic_arguments = biorxiv_basic_arguments, |
|||
preprint_template_list = template_list_get (preprint_arguments), -- make a template list from preprint_arguments{} table |
|||
citeseerx_basic_arguments = citeseerx_basic_arguments, |
|||
unique_arguments = unique_arguments, |
|||
ssrn_basic_arguments = ssrn_basic_arguments |
|||
unique_param_template_list = template_list_get (unique_arguments), -- make a template list from unique_arguments{} table |
|||
}; |
}; |