Module:Citation/CS1/Whitelist

The educational technology and digital learning wiki
Jump to navigation Jump to search

Documentation for this module may be created at Module:Citation/CS1/Whitelist/doc

  1 --[[--------------------------< P A R A M E T E R S   N O T   S U P P O R T E D >------------------------------
  2 
  3 This is a list of parameters that once were but now are no longer supported:
  4 
  5 	['albumlink'] = nil,			-- unique alias of titlelink used by old cite AV media notes
  6 	['albumtype'] = nil,			-- controled inappropriate functionality in the old cite AV media notes
  7 	['artist'] = nil,				-- unique alias of others used by old cite AV media notes
  8 	['Author'] = nil,				-- non-standard capitalization
  9 	['authorformat'] = nil,			-- primarily used to support Vancouver format which functionality now part of name-list-format
 10 	['author-format'] = nil,		-- primarily used to support Vancouver format which functionality now part of name-list-format
 11 	['author-name-separator'] = nil,-- primarily used to support Vancouver format which functionality now part of name-list-format
 12 	['author-separator'] = nil,		-- primarily used to support Vancouver format which functionality now part of name-list-format
 13 	['began'] = nil,				-- module handles date ranges; cite episode and cite series
 14 	['chapterlink'] = nil,			-- if ever necessary to link to a chapter article, |chapter= can be wikilinked 
 15 	['chapter-link'] = nil,			-- 
 16 	['cointerviewers'] = nil,		-- unique alias of others used by old cite interview
 17 	['day'] = nil,					-- deprecated in {{citation/core}} and somehow undeprecated in Module:Citation/CS1 and now finally removed
 18 	['director'] = nil,				-- unique alias of author used by old cite DVD-notes
 19 	['DoiBroken'] = nil,			-- not used, non-standard captialization
 20 	['Editor'] = nil,				-- non-standard capitalization
 21 	['editorformat'] = nil,			-- primarily used to support Vancouver format which functionality now part of name-list-format
 22 	['EditorSurname'] = nil,		-- non-standard capitalization
 23 	['editor-format'] = nil,		-- primarily used to support Vancouver format which functionality now part of name-list-format
 24 	['EditorGiven'] = nil,			-- non-standard capitalization
 25 	['editor-name-separator'] = nil,-- primarily used to support Vancouver format which functionality now part of name-list-format
 26 	['editor-separator'] = nil,		-- primarily used to support Vancouver format which functionality now part of name-list-format
 27 	['Embargo'] = nil,				-- not used, non-standard capitalization
 28 	['ended'] = nil,				-- module handles date ranges; cite episode and cite series
 29 	['month'] = nil,				-- functionality supported by |date=
 30 	['name-separator'] = nil,		-- primarily used to support Vancouver format which functionality now part of name-list-format
 31 	['notestitle'] = nil,			-- unique alias of chapter used by old cite AV media notes
 32 	['PPrefix'] = nil,				-- non-standard capitalization
 33 	['PPPrefix'] = nil,				-- not used, non-standard capitalization
 34 	['pp-prefix'] = nil,			-- not used, not documented
 35 	['p-prefix'] = nil,				-- not used, not documented
 36 	['publisherid'] = nil,			-- unique alias of id used by old cite AV media notes and old cite DVD-notes
 37 	['Ref'] = nil,					-- non-standard capitalization
 38 	['separator'] = nil,			-- this functionality now provided by |mode=
 39 	['titleyear'] = nil,			-- unique alias of origyear used by old cite DVD-notes
 40 
 41 	['Author#'] = nil,				-- non-standard capitalization
 42 	['authors#'] = nil,				-- no need for multiple lists of author names
 43 	['Editor#'] = nil,				-- non-standard capitalization
 44 	['editors#'] = nil,				-- no need for multiple lists of editor names
 45 	['EditorGiven#'] = nil,			-- non-standard capitalization
 46 	['EditorSurname#'] = nil,		-- non-standard capitalization
 47 
 48 ]]
 49 
 50 --[[--------------------------< S U P P O R T E D   P A R A M E T E R S >--------------------------------------
 51 
 52 Because a steady-state signal conveys no useful information, whitelist.basic_arguments[] list items can have three values:
 53 	true - these parameters are valid and supported parameters
 54 	false - these parameters are deprecated but still supported
 55 	nil - these parameters are no longer supported (when setting a parameter to nil, leave a comment stating the reasons for invalidating the parameter)
 56 	
 57 ]]
 58 
 59 local whitelist = {}
 60 
 61 local basic_arguments = {
 62 	['accessdate'] = true,
 63 	['access-date'] = true,
 64 	['agency'] = true,
 65 	['airdate'] = true,
 66 	['air-date'] = true,
 67 	['archivedate'] = true,
 68 	['archive-date'] = true,
 69 	['archive-format'] = true,
 70 	['archiveurl'] = true,
 71 	['archive-url'] = true,
 72 	['article'] = true,
 73 	['arxiv'] = true,
 74 	['ARXIV'] = true,
 75 	['asin'] = true,
 76 	['ASIN'] = true,
 77 	['asin-tld'] = true,
 78 	['ASIN-TLD'] = true,
 79 	['at'] = true,
 80 	['author'] = true,
 81 	['author-first'] = true,
 82 	['author-last'] = true,
 83 	['authorlink'] = true,
 84 	['author-link'] = true,
 85 	['authormask'] = true,
 86 	['author-mask'] = true,
 87 	['authors'] = true,
 88 	['bibcode'] = true,
 89 	['BIBCODE'] = true,
 90 	['booktitle'] = true,
 91 	['book-title'] = true,
 92 	['callsign'] = true,			-- cite interview
 93 	['call-sign'] = true,			-- cite interview
 94 	['cartography'] = true,
 95 	['chapter'] = true,
 96 	['chapter-format'] = true,
 97 	['chapterurl'] = true,
 98 	['chapter-url'] = true,
 99 	['city'] = true,				-- cite interview, cite episode, cite serial
100 	['class'] = true,				-- cite arxiv and arxiv identifiers
101 	['coauthor'] = false,			-- deprecated
102 	['coauthors'] = false,			-- deprecated
103 	['collaboration'] = true,
104 	['conference'] = true,
105 	['conference-format'] = true,
106 	['conferenceurl'] = true,
107 	['conference-url'] = true,
108 	['contribution'] = true,
109 	['contribution-format'] = true,
110 	['contributionurl'] = true,
111 	['contribution-url'] = true,
112 	['contributor'] = true,
113 	['contributor-first'] = true,
114 	['contributor-last'] = true,
115 	['contributor-link'] = true,
116 	['contributor-mask'] = true,
117 	['credits'] = true,				-- cite episode, cite serial
118 	['date'] = true,
119 	['deadurl'] = true,
120 	['dead-url'] = true,
121 	['degree'] = true,
122 	['department'] = true,
123 	['df'] = true,
124 	['dictionary'] = true,
125 	['displayauthors'] = true,
126 	['display-authors'] = true,
127 	['displayeditors'] = true,
128 	['display-editors'] = true,
129 	['docket'] = true,
130 	['doi'] = true,
131 	['DOI'] = true,
132 	['doi-broken'] = true,
133 	['doi_brokendate'] = true,
134 	['doi-broken-date'] = true,
135 	['doi_inactivedate'] = true,
136 	['doi-inactive-date'] = true,
137 	['edition'] = true,
138 	['editor'] = true,
139 	['editor-first'] = true,
140 	['editor-given'] = true,
141 	['editor-last'] = true,
142 	['editorlink'] = true,
143 	['editor-link'] = true,
144 	['editormask'] = true,
145 	['editor-mask'] = true,
146 	['editors'] = true,
147 	['editor-surname'] = true,
148 	['eissn'] = true,
149 	['EISSN'] = true,
150 	['embargo'] = true,
151 	['encyclopaedia'] = true,
152 	['encyclopedia'] = true,
153 	['entry'] = true,
154 	['episode'] = true,															-- cite serial only TODO: make available to cite episode?
155 	['episodelink'] = true,														-- cite episode and cite serial
156 	['episode-link'] = true,													-- cite episode and cite serial
157 	['eprint'] = true,															-- cite arxiv and arxiv identifiers
158 	['event'] = true,
159 	['event-format'] = true,
160 	['eventurl'] = true,
161 	['event-url'] = true,
162 	['first'] = true,
163 	['format'] = true,
164 	['given'] = true,
165 	['hdl'] = true,
166 	['HDL'] = true,
167 	['host'] = true,
168 	['id'] = true,
169 	['ID'] = true,
170 	['ignoreisbnerror'] = true,
171 	['ignore-isbn-error'] = true,
172 	['in'] = true,
173 	['inset'] = true,
174 	['institution'] = true,
175 	['interviewer'] = true,				--cite interview
176 	['interviewers'] = true,			--cite interview
177 	['isbn'] = true,
178 	['ISBN'] = true,
179 	['isbn13'] = true,
180 	['ISBN13'] = true,
181 	['ismn'] = true,
182 	['ISMN'] = true,
183 	['issn'] = true,
184 	['ISSN'] = true,
185 	['issue'] = true,
186 	['jfm'] = true,
187 	['JFM'] = true,
188 	['journal'] = true,
189 	['jstor'] = true,
190 	['JSTOR'] = true,
191 	['language'] = true,
192 	['last'] = true,
193 	['lastauthoramp'] = true,
194 	['last-author-amp'] = true,
195 	['laydate'] = true,
196 	['lay-date'] = true,
197 	['laysource'] = true,
198 	['lay-source'] = true,
199 	['laysummary'] = true,
200 	['lay-summary'] = true,
201 	['lay-format'] = true,
202 	['layurl'] = true,
203 	['lay-url'] = true,
204 	['lccn'] = true,
205 	['LCCN'] = true,
206 	['location'] = true,
207 	['magazine'] = true,
208 	['mailinglist'] = true,				-- cite mailing list only
209 	['mailing-list'] = true,			-- cite mailing list only
210 	['map'] = true,						-- cite map only
211 	['map-format'] = true,				-- cite map only
212 	['mapurl'] = true,					-- cite map only
213 	['map-url'] = true,					-- cite map only
214 	['medium'] = true,
215 	['message-id'] = true,			-- cite newsgroup
216 	['minutes'] = true,
217 	['mode'] = true,
218 	['mr'] = true,
219 	['MR'] = true,
220 	['name-list-format'] = true,
221 	['network'] = true,
222 	['newsgroup'] = true,
223 	['newspaper'] = true,
224 	['nocat'] = true,
225 	['no-cat'] = true,
226 	['nopp'] = true,
227 	['no-pp'] = true,
228 	['notracking'] = true,
229 	['no-tracking'] = true,
230 	['number'] = true,
231 	['oclc'] = true,
232 	['OCLC'] = true,
233 	['ol'] = true,
234 	['OL'] = true,
235 	['origyear'] = true,
236 	['orig-year'] = true,
237 	['osti'] = true,
238 	['OSTI'] = true,
239 	['others'] = true,
240 	['p'] = true,
241 	['page'] = true,
242 	['pages'] = true,
243 	['people'] = true,
244 	['periodical'] = true,
245 	['place'] = true,
246 	['pmc'] = true,
247 	['PMC'] = true,
248 	['pmid'] = true,
249 	['PMID'] = true,
250 	['postscript'] = true,
251 	['pp'] = true,
252 	['program'] = true,				-- cite interview
253 	['publicationdate'] = true,
254 	['publication-date'] = true,
255 	['publicationplace'] = true,
256 	['publication-place'] = true,
257 	['publisher'] = true,
258 	['quotation'] = true,
259 	['quote'] = true,
260 	['ref'] = true,
261 	['registration'] = true,
262 	['rfc'] = true,
263 	['RFC'] = true,
264 	['scale'] = true,
265 	['script-chapter'] = true,
266 	['script-title'] = true,
267 	['season'] = true,
268 	['section'] = true,
269 	['section-format'] = true,
270 	['sections'] = true,					-- cite map only
271 	['sectionurl'] = true,
272 	['section-url'] = true,
273 	['series'] = true,
274 	['serieslink'] = true,
275 	['series-link'] = true,
276 	['seriesno'] = true,
277 	['series-no'] = true,
278 	['seriesnumber'] = true,
279 	['series-number'] = true,
280 	['series-separator'] = true,
281 	['sheet'] = true,															-- cite map only
282 	['sheets'] = true,															-- cite map only
283 	['ssrn'] = true,
284 	['SSRN'] = true,
285 	['station'] = true,
286 	['subject'] = true,
287 	['subjectlink'] = true,
288 	['subject-link'] = true,
289 	['subscription'] = true,
290 	['surname'] = true,
291 	['template doc demo'] = true,
292 	['template-doc-demo'] = true,
293 	['time'] = true,
294 	['timecaption'] = true,
295 	['time-caption'] = true,
296 	['title'] = true,
297 	['titlelink'] = true,
298 	['title-link'] = true,
299 	['trans_chapter'] = true,
300 	['trans-chapter'] = true,
301 	['trans-map'] = true,
302 	['transcript'] = true,
303 	['transcript-format'] = true,
304 	['transcripturl'] = true,
305 	['transcript-url'] = true,
306 	['trans_title'] = true,
307 	['trans-title'] = true,
308 	['translator'] = true,
309 	['translator-first'] = true,
310 	['translator-last'] = true,
311 	['translator-link'] = true,
312 	['translator-mask'] = true,
313 	['type'] = true,
314 	['url'] = true,
315 	['URL'] = true,
316 	['vauthors'] = true,
317 	['veditors'] = true,
318 	['version'] = true,
319 	['via'] = true,
320 	['volume'] = true,
321 	['website'] = true,
322 	['work'] = true,
323 	['year'] = true,
324 	['zbl'] = true,
325 	['ZBL'] = true,
326 }
327 
328 local numbered_arguments = {
329 	['author#'] = true,
330 	['author-first#'] = true,
331 	['author#-first'] = true,
332 	['author-last#'] = true,
333 	['author#-last'] = true,
334 	['author-link#'] = true,
335 	['author#link'] = true,
336 	['author#-link'] = true,
337 	['authorlink#'] = true,
338 	['author-mask#'] = true,
339 	['author#mask'] = true,
340 	['author#-mask'] = true,
341 	['authormask#'] = true,
342 	['contributor#'] = true,
343 	['contributor-first#'] = true,
344 	['contributor#-first'] = true,
345 	['contributor-last#'] = true,
346 	['contributor#-last'] = true,
347 	['contributor-link#'] = true,
348 	['contributor#-link'] = true,
349 	['contributor-mask#'] = true,
350 	['contributor#-mask'] = true,
351 	['editor#'] = true,
352 	['editor-first#'] = true,
353 	['editor#-first'] = true,
354 	['editor#-given'] = true,
355 	['editor-given#'] = true,
356 	['editor-last#'] = true,
357 	['editor#-last'] = true,
358 	['editor-link#'] = true,
359 	['editor#link'] = true,
360 	['editor#-link'] = true,
361 	['editorlink#'] = true,
362 	['editor-mask#'] = true,
363 	['editor#mask'] = true,
364 	['editor#-mask'] = true,
365 	['editormask#'] = true,
366 	['editor#-surname'] = true,
367 	['editor-surname#'] = true,
368 	['first#'] = true,
369 	['given#'] = true,
370 	['last#'] = true,
371 	['subject#'] = true,
372 	['subject-link#'] = true,
373 	['subject#link'] = true,
374 	['subject#-link'] = true,
375 	['subjectlink#'] = true,
376 	['surname#'] = true,
377 	['translator#'] = true,
378 	['translator-first#'] = true,
379 	['translator#-first'] = true,
380 	['translator-last#'] = true,
381 	['translator#-last'] = true,
382 	['translator-link#'] = true,
383 	['translator#-link'] = true,
384 	['translator-mask#'] = true,
385 	['translator#-mask'] = true,
386 }
387 
388 return {basic_arguments = basic_arguments, numbered_arguments = numbered_arguments};