Bharatpedia

Module:Citation/CS1/Whitelist: Difference between revisions

Module Talk

Module:Citation/CS1/Whitelist (view source)

Revision as of 14:47, 30 September 2023

3,091 bytes removed ,  30 September 2023
Undo revision 431502 by WikiDwarf (talk)
(Update)
Tag: Reverted
(Undo revision 431502 by WikiDwarf (talk))
Tags: Undo Reverted
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 4: 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
tracked - these parameters are valid and supported parameters tracked in an eponymous properties category
nil - these parameters are no longer supported. remove entirely
nil - these parameters are no longer supported. remove entirely
]]
]]


local basic_arguments_t = {
local basic_arguments = {
['accessdate'] = true,
['accessdate'] = true,
['access-date'] = true,
['access-date'] = true,
Line 20: Line 20:
['article'] = true,
['article'] = true,
['article-format'] = true,
['article-format'] = true,
['article-number'] = true, -- {{cite journal}}, {{cite conference}}; {{citation}} when |journal= has a value
['article-url'] = true,
['article-url'] = true,
['article-url-access'] = true,
['article-url-access'] = true,
Line 40: Line 39:
['bibcode-access'] = true,
['bibcode-access'] = true,
['biorxiv'] = true, -- cite biorxiv; here because allowed in cite ... as identifier
['biorxiv'] = true, -- cite biorxiv; here because allowed in cite ... as identifier
['booktitle'] = true,
['book-title'] = true,
['cartography'] = true,
['chapter'] = true,
['chapter'] = true,
['chapter-format'] = true,
['chapter-format'] = true,
['chapterurl'] = true,
['chapter-url'] = true,
['chapter-url'] = true,
['chapter-url-access'] = true,
['chapter-url-access'] = true,
['citeseerx'] = true, -- cite citeseerx; here because allowed in cite ... as identifier
['citeseerx'] = true, -- cite citeseerx; here because allowed in cite ... as identifier
['collaboration'] = true,
['collaboration'] = true,
['conference'] = true,
['conference-format'] = true,
['conferenceurl'] = false,
['conference-url'] = true,
['contribution'] = true,
['contribution'] = true,
['contribution-format'] = true,
['contribution-format'] = true,
['contributionurl'] = false,
['contribution-url'] = true,
['contribution-url'] = true,
['contribution-url-access'] = true,
['contribution-url-access'] = true,
Line 58: Line 66:
['contributor-mask'] = true,
['contributor-mask'] = true,
['date'] = true,
['date'] = true,
['degree'] = true,
['department'] = true,
['department'] = true,
['df'] = true,
['df'] = true,
Line 67: Line 76:
['display-subjects'] = true,
['display-subjects'] = true,
['display-translators'] = true,
['display-translators'] = true,
['docket'] = true,
['doi'] = true,
['doi'] = true,
['DOI'] = true,
['DOI'] = true,
Line 88: Line 98:
['entry-url-access'] = true,
['entry-url-access'] = true,
['eprint'] = true, -- cite arxiv; here because allowed in cite ... as identifier
['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,
['first'] = true,
['format'] = true,
['format'] = true,
Line 94: Line 105:
['HDL'] = true,
['HDL'] = true,
['hdl-access'] = true,
['hdl-access'] = true,
['host'] = true, -- unique to certain templates?
['host'] = true,
['id'] = true,
['id'] = true,
['ID'] = true,
['ID'] = true,
['institution'] = true, -- constrain to cite thesis?
['institution'] = true,
['interviewer'] = true,
['interviewer'] = true,
['interviewer-first'] = true,
['interviewer-first'] = true,
Line 107: Line 118:
['isbn'] = true,
['isbn'] = true,
['ISBN'] = true,
['ISBN'] = true,
['isbn13'] = true,
['ISBN13'] = true,
['ismn'] = true,
['ismn'] = true,
['ISMN'] = true,
['ISMN'] = true,
Line 121: Line 134:
['language'] = true,
['language'] = true,
['last'] = true,
['last'] = true,
['laydate'] = false,
['lay-date'] = true,
['laysource'] = false,
['lay-source'] = true,
['lay-format'] = true,
['layurl'] = false,
['lay-url'] = true,
['lccn'] = true,
['lccn'] = true,
['LCCN'] = true,
['LCCN'] = true,
Line 126: Line 146:
['magazine'] = true,
['magazine'] = true,
['medium'] = true,
['medium'] = true,
['medrxiv'] = true, -- cite medrxiv; here because allowed in cite ... as identifier
['minutes'] = true,
['minutes'] = true, -- constrain to cite AV media and podcast?
['mode'] = true,
['mode'] = true,
['mr'] = true,
['mr'] = true,
['MR'] = true,
['MR'] = true,
['name-list-format'] = true,
['name-list-style'] = true,
['name-list-style'] = true,
['newspaper'] = true,
['newspaper'] = true,
['nopp'] = true,
['no-pp'] = true,
['no-pp'] = true,
['no-tracking'] = true,
['no-tracking'] = true,
Line 161: Line 182:
['postscript'] = true,
['postscript'] = true,
['pp'] = true,
['pp'] = true,
['publicationdate'] = true,
['publication-date'] = true,
['publication-date'] = true,
['publicationplace'] = true,
['publication-place'] = true,
['publication-place'] = true,
['publisher'] = true,
['publisher'] = true,
Line 187: Line 210:
['script-website'] = true,
['script-website'] = true,
['script-work'] = true,
['script-work'] = true,
['season'] = true,
['section'] = true,
['section'] = true,
['section-format'] = true,
['section-format'] = true,
['sectionurl'] = false,
['section-url'] = true,
['section-url'] = true,
['section-url-access'] = true,
['section-url-access'] = true,
['series'] = true,
['series'] = true,
['ssrn'] = true, -- cite ssrn; these three here because allowed in cite ... as identifier
['serieslink'] = true,
['series-link'] = true,
['seriesno'] = false,
['series-no'] = true,
['series-number'] = true,
['ssrn'] = true, -- cite ssrn; these two here because allowed in cite ... as identifier
['SSRN'] = true,
['SSRN'] = true,
['ssrn-access'] = true,
['subject'] = true,
['subject'] = true,
['subject-first'] = true,
['subject-given'] = true,
['subject-last'] = true,
['subject-link'] = true,
['subject-link'] = true,
['subject-mask'] = true,
['subject-mask'] = true,
['subject-surname'] = true,
['surname'] = true,
['surname'] = true,
['s2cid'] = true,
['s2cid'] = true,
Line 207: Line 232:
['s2cid-access'] = true,
['s2cid-access'] = true,
['template-doc-demo'] = true,
['template-doc-demo'] = true,
['time'] = true, -- constrain to cite av media and podcast?
['time'] = true,
['time-caption'] = true, -- constrain to cite av media and podcast?
['timecaption'] = false,
['time-caption'] = true,
['title'] = true,
['title'] = true,
['titlelink'] = false,
['title-link'] = true,
['title-link'] = true,
['title-note'] = true,
['translator'] = true,
['translator'] = true,
['translator-first'] = true,
['translator-first'] = true,
Line 247: Line 273:
['zbl'] = true,
['zbl'] = true,
['ZBL'] = true,
['ZBL'] = true,
}
}


local numbered_arguments_t = {
local numbered_arguments = {
['author#'] = true,
['author#'] = true,
['author-first#'] = true,
['author-first#'] = true,
Line 309: Line 335:
['last#'] = true,
['last#'] = true,
['subject#'] = true,
['subject#'] = true,
['subject-first#'] = true,
['subject#-first'] = true,
['subject-given#'] = true,
['subject#-given'] = true,
['subject-last#'] = true,
['subject#-last'] = true,
['subject-link#'] = true,
['subject-link#'] = true,
['subject#-link'] = true,
['subject#-link'] = true,
['subject-mask#'] = true,
['subject-mask#'] = true,
['subject#-mask'] = true,
['subject#-mask'] = true,
['subject-surname#'] = true,
['subject#-surname'] = true,
['surname#'] = true,
['surname#'] = true,
['translator#'] = true,
['translator#'] = true,
Line 335: Line 353:
['translator-mask#'] = true,
['translator-mask#'] = 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 >--------------------
--[[--------------------------< P R E P R I N T  S U P P O R T E D  P A R A M E T E R S >--------------------


Cite arXiv, cite biorxiv, cite citeseerx, cite medrxiv, and cite ssrn are preprint templates that use the limited
Cite arXiv, cite biorxiv, cite citeseerx, and cite ssrn are preprint templates that use the limited set of parameters
set of parameters defined in the limited_basic_arguments and limited_numbered_arguments tables.  Those lists are
defined in the limited_basic_arguments and limited_numbered_arguments tables.  Those lists are supplemented with a
supplemented with a template-specific list of parameters that are required by the particular template and may be
template-specific list of parameters that are required by the particular template and may be exclusive to one of the
exclusive to one of the preprint templates.  Some of these parameters may also be available to the general cs1|2
preprint templates.  Some of these parameters may also be available to the general cs1|2 templates.
templates.


Same conventions for true/false/tracked/nil as above.
Same conventions for true/false/nil as above.


]]
]]


local preprint_arguments_t = {
local preprint_arguments = {
arxiv = {
arxiv = {
['arxiv'] = true, -- cite arxiv and arxiv identifiers
['arxiv'] = true, -- cite arxiv and arxiv identifiers
Line 361: Line 378:
citeseerx = {
citeseerx = {
['citeseerx'] = true,
['citeseerx'] = true,
},
medrxiv = {
['medrxiv'] = true,
},
},
ssrn = {
ssrn = {
['ssrn'] = true,
['ssrn'] = true,
['SSRN'] = true,
['SSRN'] = true,
['ssrn-access'] = true,
},
},
}
}
Line 375: Line 388:
--[[--------------------------< 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 >----------------------
--[[--------------------------< L I M I T E D  S U P P O R T E D  P A R A M E T E R S >----------------------


cite arxiv, cite biorxiv, cite citeseerx, cite medrxiv, and cite ssrn templates are preprint templates so are
This is an experiment that attempts to use validate() and a limited list of valid parameters to validate the
allowed only a limited subset of parameters allowed to all other cs1|2 templates.  The limited subset is defined
parameters provided in a cite arxiv, cite biorxiv, or cite citeseerx templates.  These parameters are common to
here.
all three templates


This list of parameters also used by {{cite document}}
Same conventions for true/false/nil as above.
 
Same conventions for true/false/tracked/nil as above.
]]
]]


local limited_basic_arguments_t = {
local limited_basic_arguments = {
['at'] = true,
['at'] = true,
['author'] = true,
['author'] = true,
Line 405: Line 416:
['last'] = true,
['last'] = true,
['mode'] = true,
['mode'] = true,
['name-list-format'] = true,
['name-list-style'] = true,
['name-list-style'] = true,
['no-tracking'] = true,
['no-tracking'] = true,
Line 419: Line 431:
['title'] = true,
['title'] = true,
['trans-title'] = true,
['trans-title'] = true,
['url'] = true,
['URL'] = true,
['vauthors'] = true,
['vauthors'] = true,
['year'] = true,
['year'] = true,
}
}


local limited_numbered_arguments_t = {
local limited_numbered_arguments = {
['author#'] = true,
['author#'] = true,
['author-first#'] = true,
['author-first#'] = true,
Line 451: Line 465:
table are the template's CitationClass parameter value
table are the template's CitationClass parameter value


Same conventions for true/false/tracked/nil as above.
Same conventions for true/false/nil as above.


]]
]]


local unique_arguments_t = {
local unique_arguments = {
['audio-visual'] = {
['audio-visual'] = {
['transcript'] = true,
['transcript'] = true,
['transcript-format'] = true,
['transcript-format'] = true,
['transcripturl'] = true,
['transcript-url'] = true,
['transcript-url'] = true,
},
conference = {
['book-title'] = true,
['conference'] = true,
['conference-format'] = true,
['conference-url'] = true,
['event'] = true,
},
},
episode = {
episode = {
Line 472: Line 480:
['air-date'] = true,
['air-date'] = true,
['credits'] = true,
['credits'] = true,
['episodelink'] = true, -- alias of |title-link=
['episode-link'] = true, -- alias of |title-link=
['episode-link'] = true, -- alias of |title-link=
['network'] = true,
['network'] = true,
['season'] = true,
['series-link'] = true,
['series-no'] = true,
['series-number'] = true,
['station'] = true,
['station'] = true,
['transcript'] = true,
['transcript'] = true,
['transcript-format'] = true,
['transcript-format'] = true,
['transcripturl'] = true,
['transcript-url'] = true,
['transcript-url'] = true,
},
},
mailinglist = {
mailinglist = {
['mailinglist'] = true,
['mailing-list'] = true,
['mailing-list'] = true,
},
},
map = {
map = {
['cartography'] = true,
['inset'] = true,
['inset'] = true,
['map'] = true,
['map'] = true,
['map-format'] = true,
['map-format'] = true,
['mapurl'] = true,
['map-url'] = true,
['map-url'] = true,
['map-url-access'] = true,
['map-url-access'] = true,
Line 502: Line 509:
['message-id'] = true,
['message-id'] = true,
['newsgroup'] = true,
['newsgroup'] = true,
},
report = {
['docket'] = true,
},
},
serial = {
serial = {
Line 511: Line 515:
['credits'] = true,
['credits'] = true,
['episode'] = true, -- cite serial only TODO: make available to cite episode?
['episode'] = true, -- cite serial only TODO: make available to cite episode?
['episode-link'] = true, -- alias of |title-link=
['episodelink'] = true, -- aliases of |title-link=
['episode-link'] = true,
['network'] = true,
['network'] = true,
['series-link'] = true,
['station'] = true,
['station'] = true,
},
},
speech = {
['conference'] = true,
['conference-format'] = true,
['conference-url'] = true,
['event'] = true,
},
thesis = {
['degree'] = true,
['docket'] = true,
},
}
--[[--------------------------< C I T E _ D O C U M E N T >----------------------------------------------------
Special case for cite document.  This template takes the limited basic and limited enumerated parameters plus
others that are apply only to standalone published sources that cannot be cited any other way; no url, book,
periodical, etc parameters; limited support for name lists and named identifiers.
when validating parameters in {{cite document}} templates, the basic and
]]
local document_arguments_t = {
['bibcode'] = true,
['bibcode-access'] = true,
['doi'] = true,
['DOI'] = true,
['doi-access'] = true,
['doi-broken-date'] = true,
['hdl'] = true,
['HDL'] = true,
['hdl-access'] = true,
['id'] = true,
['ID'] = true,
['jfm'] = true,
['JFM'] = true,
['lang'] = true,
['location'] = true,
['mr'] = true,
['MR'] = true,
['no-pp'] = true,
['orig-date'] = true,
['origyear'] = true,
['orig-year'] = true,
['osti'] = true,
['OSTI'] = true,
['osti-access'] = true,
['place'] = true,
['publisher'] = true,
['quote-page'] = true,
['quote-pages'] = true,
['script-quote'] = true,
['script-title'] = true,
['title-link'] = true,
['translator'] = true,
['translator-first'] = true,
['translator-given'] = true,
['translator-last'] = true,
['translator-surname'] = true,
['translator-link'] = true,
['translator-mask'] = true,
['trans-quote'] = true,
['type'] = true,
['zbl'] = true,
['ZBL'] = true,
}
local document_numbered_arguments_t = {
['translator#'] = true,
['translator-first#'] = true,
['translator#-first'] = true,
['translator-given#'] = true,
['translator#-given'] = true,
['translator-last#'] = true,
['translator#-last'] = true,
['translator-surname#'] = true,
['translator#-surname'] = true,
['translator-link#'] = true,
['translator#-link'] = true,
['translator-mask#'] = true,
['translator#-mask'] = true,
}
}
--[[--------------------------< L I S T _ C O M B I N E >------------------------------------------------------
makes one table from a list of tables.  <lists_t> is a sequence of tables to be combined
]]
local function list_combine (lists_t)
local out_t = {};
for _, list_t in ipairs (lists_t) do -- for each list in <lists_t>
for k, v in pairs (list_t) do -- extract each k/v pair
out_t[k] = v; -- add to <out_t>
end
end
return out_t; -- and done
end




Line 626: Line 530:


local function template_list_get (t)
local function template_list_get (t)
local out_t = {}; -- a table for output
local out = {}; -- a table for output
for k, _ in pairs (t) do -- spin through the table and collect the keys
for k, _ in pairs (t) do -- spin through the table and collect the keys
table.insert (out_t, k) -- add each key to the output table
table.insert (out, k) -- add each key to the output table
end
end
return out_t; -- and done
return out; -- and done
end
end


Line 638: Line 542:


return {
return {
preprint_arguments_t = preprint_arguments_t,
basic_arguments = basic_arguments,
preprint_template_list_t = template_list_get (preprint_arguments_t), -- make a template list from preprint_arguments{} table
numbered_arguments = numbered_arguments,
unique_arguments_t = unique_arguments_t,
limited_basic_arguments = limited_basic_arguments,
unique_param_template_list_t = template_list_get (unique_arguments_t), -- make a template list from unique_arguments{} table
limited_numbered_arguments = limited_numbered_arguments,
 
document_parameters_t = list_combine ({limited_basic_arguments_t, limited_numbered_arguments_t, document_arguments_t, document_numbered_arguments_t});
preprint_arguments = preprint_arguments,
common_parameters_t = list_combine ({basic_arguments_t, numbered_arguments_t});
preprint_template_list = template_list_get (preprint_arguments), -- make a template list from preprint_arguments{} table
limited_parameters_t = list_combine ({limited_basic_arguments_t, limited_numbered_arguments_t});
unique_arguments = unique_arguments,
unique_param_template_list = template_list_get (unique_arguments), -- make a template list from unique_arguments{} table
};
};
Retrieved from "https://en.bharatpedia.org/wiki/Special:MobileDiff/431503"