विभाग: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 = {
        ['अनुवादीत पुस्तकशीर्षक'] = true,
        ['लेखक1'] = true,
        ['लेखक2'] = true,
        ['लेखक3'] = true,
        ['लेखक4'] = true,
        ['लेखक5'] = true,
        ['लेखक6'] = true,
        ['लेखक7'] = true,
        ['लेखक8'] = true,
        ['लेखक9'] = true,
        ['पुस्तकशीर्षक'] = true,
        ['काम'] = true,
        ['कृती'] = true,
        ['दिनांक'] = true,
        ['भाषा'] = true,
        ['प्रकाशक'] = true,
        ['अवतरण'] = true,
        ['शीर्षक'] = true,
        ['दुवा'] = true,
        ['संकेतस्थळ'] = true,
        ['कार्य'] = true,
        ['आडनाव'] = true,
        ['सदस्यता'] = true,
        ['बिबकोड'] = true,
        ['ज्ञानकोश'] = true,
        ['विश्वकोश'] = true,
        ['जर्नल'] = true,
        ['accessdate'] = true,
        ['access-date'] = true,
        ['अॅक्सेसदिनांक'] = true,
        ['ॲक्सेसदिनांक'] = true,
        ['अक्सेसदिनांक'] = true,
        ['df'] = true,
        ['फॉरमॅट'] = true,
        ['पहिले नाव'] = true,
        ['पहिलेनाव'] = true,
        ['लेखक'] = true,
        ['लेखक 1'] = true,
        ['लेखक 2'] = true,
        ['अ‍ॅक्सेसदिनांक'] =true,
        ['लेखक 3'] = true,
        ['लेखक 4'] = true,
        ['लेखक 5'] = true,
        ['लेखक 6'] = true,
        ['लेखक 7'] = true,
        ['लेखक 8'] = true,
        ['लेखक 9'] = true,
        ['लेखक२दुवा'] = true,
        ['लेखक३'] = true,
        ['लेखक४'] = true,
        ['लेखक५'] = true,
        ['लेखक६'] = true,
        ['लेखक७'] = true,
        ['लेखक८'] = true,
        ['लेखक९'] = true,
        ['आडनाव1'] = true,
        ['आडनाव2'] = true,
        ['आडनाव3'] = true,
        ['आडनाव4'] = true,
        ['आडनाव5'] = true,
        ['आडनाव6'] = true,
        ['आडनाव7'] = true,
        ['आडनाव8'] = true,
        ['आडनाव9'] = true,
        ['पहिले नाव1'] = true,
        ['पहिले नाव2'] = true,
        ['पहिले नाव3'] = true,
        ['पहिले नाव4'] = true,
        ['पहिले नाव5'] = true,
        ['पहिले नाव6'] = true,
        ['पहिले नाव7'] = true,
        ['पहिले नाव8'] = true,
        ['पहिले नाव9'] = true,
        ['लेखकदुवा'] = true,
        ['वर्ष'] = true,
        ['ठिकाण'] = true,
        ['स्थान'] = true,
        ['जागा'] = true,
        ['आय.एस.बी.एन.'] = true,
        ['आयएसबीएन'] = true,
        ['आय.डी.'] = true,
        ['डी.ओ.आई.'] = true,
        ['पान'] = true,
        ['पृष्ठ'] = true,
        ['पाने'] = true,
        ['पृष्ठे'] = true,
        ['अवतरण'] = true,
        ['quote'] = true,
        ['महिना'] = true,
        ['जर्नल'] = true,
        ['आवृत्ती'] = true,
        ['खंड'] = true,
        ['अंक'] = true,
        ['दिनांक'] = true,
        ['सहलेखक'] = true,
        ['पुस्तकशीर्षक'] = true,
        ['सहभाग'] = true,
        ['ज्ञानकोश'] = true,
        ['वृत्तसंस्था'] = true,
        ['वर्तमानपत्र'] = true,
        ['प्रकाशन स्थळ'] = true,
        ['संपादक'] = true,
        ['अनुवादीत शीर्षक'] = true,
        ['लेखनाव'] = true,
        ['प्रकाशन ठिकाण'] = true,
        ['प्रकाशन वर्ष'] = true,
        ['शोधक'] = true,
        ['जारी दिनांक'] = true,
        ['स्वामित्त्व क्रमांक'] = true,
        ['देश संकेतांक'] = true,
        ['काम'] = true,
        ['प्रकार'] = true,
        ['आई.एस.एस.एन.'] = true,
        ['पी.एम.आई.डी'] = true,
        ['प्रकरण'] = true,
        ['पुस्तक'] = true,
        ['संभाषण'] = true,
        ['बातमी'] = true,
        ['प्रेस रिलीज'] = true,
        ['मुलाखत'] = true,
        ['विषय'] = true,
        ['विषयदुवा'] = true,
        ['विषय दोन'] = true,
        ['विषय दोनदुवा'] = true,
        ['विषय तीन'] = true,
        ['विषय तीनदुवा'] = true,
        ['विषय चार'] = true,
        ['मुलाखतकार'] = true,
        ['सह मुलाखतकार'] = true,
        ['प्रकार'] = true,
        ['कार्यक्रम'] = true,
        ['शहर'] = true,
        ['विदा संकेतस्थळ दुवा'] = true,
        ['विदा दिनांक'] = true,
        ['मृतदुवा'] = true,
        ['भाग'] = true,
        ['भाग दुवा'] = true,
        ['मालिका'] = true,
        ['मालिका दुवा'] = true,
        ['आभार'] = true,
        ['नेटवर्क'] = true,
        ['केंद्र'] = true,
        ['प्रसारण दिनांक'] = true,
        ['सुरुवात'] = true,
        ['शेवट'] = true,
        ['हंगाम'] = true,
        ['मालिका क्रमांक'] = true,
        ['क्रमांक'] = true,
        ['मिनिटे'] = true,
        ['कार्यक्रम प्रसारण'] = true,
        ['प्रसारण दुवा'] = true,
        ['चलचित्र'] = true,
        ['लोक'] = true,
        ['माध्यम'] = true,
        ['वेळ'] = true,
        ['ओ.सी.एल.सी.'] = true,
        ['संदर्भ'] = true,
        ['डिओआय'] = true,
        ['पीएमआयडी'] = true,
        ['डीओआय'] = true,
        ['अनुवादित शीर्षक'] = true,
        ['जर्नल'] = true,
	['access-date'] = true,
	['agency'] = true,
--	['airdate'] = true,															-- cite episode and cite serial only
--	['air-date'] = true,														-- cite episode and cite serial only
	['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,
	['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,
--	['credits'] = true,															-- cite episode, cite serial
	['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,
--	['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
	['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
	['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,
--	['message-id'] = true,														-- cite newsgroup
	['minutes'] = true,
	['mode'] = true,
	['mr'] = true,
	['MR'] = true,
	['name-list-format'] = true,
--	['network'] = true,															-- cite episode and cite serial only
--	['newsgroup'] = true,														-- cite newsgroup
	['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-map'] = 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,
	['sections'] = true,														-- cite map only
	['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,
	['sheet'] = true,															-- cite map only
	['sheets'] = true,															-- cite map only
	['ssrn'] = true,
	['SSRN'] = true,
--	['station'] = true,															-- cite episode and cite serial only
	['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,
	['शीर्षक'] = true,
	['titlelink'] = true,
	['title-link'] = true,
	['trans-map'] = 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,
        ['लेखक#'] = true,
        ['लेखक-पहिले नाव#'] = true,
        ['लेखक#-पहिले नाव'] = true,
        ['लेखक-आडनाव#'] = true,
        ['लेखक#-आडनाव'] = true,
        ['लेखक#दुवा'] = true,
        ['लेखक#-दुवा'] = true,
        ['लेखकदुवा#'] = 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,
        ['शीर्षक'] = 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,
		},
	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
	};