Module:Citation/CS1/Configuration: Difference between revisions

List of namespaces that should not be included in citation error categories. Same as setting notracking = true by default

local uncategorized_namespaces = { 'User', 'Talk', 'User_talk', 'Wikipedia_talk', 'File_talk', 'Template_talk', 'Help_talk', 'Category_talk', 'Portal_talk', 'Book_talk', 'Draft_talk', 'Education_Program_talk', 'Module_talk', 'MediaWiki_talk' };

local uncategorized_subpages = {'/[Ss]andbox', '/[Tt]estcases'}; -- list of Lua patterns found in page names of pages we should not categorize

['edition'] = '($1 ed.)',

['et al'] = 'et al.',

['section'] = '§ $1',

['sections'] = '§§ $1',

['unknown_manual_ID'] = 'Unrecognized manual ID mode',

['unknown_ID_mode'] = 'Unrecognized ID mode',

"[;,]? *[\"']*%f[%a][Ee][Tt]%.? *[Aa][Ll][Ii][Aa][%.\"']*$", -- variations on the 'et alia' theme

"[;,]? *%f[%a]and [Oo]thers", -- and alternate to et al.

--[[--------------------------< P R E S E N T A T I O N >------------------------------------------------------

Fixed presentation markup.  Originally part of citation_config.messages it has been moved into its own, more semantically

correct place.

-- various access levels, for |access=, |doi-access=, |arxiv=, ...

-- narrow no-break space &#8239; may work better than nowrap CSS. Or not? Browser support?

['trans-quoted-title'] = "&#91;$1&#93;", -- for |trans-title= and |trans-quote=

--[[--------------------------< A L I A S E S >----------------------------------------------------------------

Parameter names on the right side in the assignements in this table must have been defined in the Whitelist

before they will be recognized as valid parameter names

['ChapterFormat'] = {'chapter-format', 'contribution-format', 'entry-format', 'article-format', 'section-format'};

['ChapterURL'] = {'chapter-url', 'contribution-url', 'entry-url', 'article-url', 'section-url', 'chapterurl', 'contributionurl', 'sectionurl'}, -- Used by InternetArchiveBot

['ChapterUrlAccess'] = {'chapter-url-access', 'contribution-url-access', 'entry-url-access', 'article-url-access', 'section-url-access'}, -- Used by InternetArchiveBot

['ConferenceFormat'] = {'conference-format', 'event-format'},

['ConferenceURL'] = {'conference-url', 'event-url', 'conferenceurl', 'eventurl'}, -- Used by InternetArchiveBot

['DisplayAuthors'] = {'display-authors', 'display-subjects', 'displayauthors'},

['NoTracking'] = {'no-tracking', 'template-doc-demo', 'nocat'},

['ScriptChapter'] = {'script-chapter', 'script-contribution', 'script-entry', 'script-article', 'script-section'},

['ScriptPeriodical'] = {'script-journal', 'script-magazine', 'script-newspaper', 'script-periodical', 'script-website', 'script-work'},

['SeriesNumber'] = {'series-number', 'series-no', 'seriesnumber', 'seriesno'},

['TransChapter'] = {'trans-article', 'trans-chapter', 'trans-contribution', 'trans-entry', 'trans-section'},

['TransPeriodical'] = {'trans-journal', 'trans-magazine', 'trans-newspaper', 'trans-periodical', 'trans-website', 'trans-work'},

['AuthorList-First'] = {"first#", "author-first#", "author#-first", "given#", "author-given#", "author#-given"},

['AuthorList-Last'] = {"last#", "author-last#", "author#-last", "surname#", "author-surname#", "author#-surname", "author#", "subject#", 'host#'},

['AuthorList-Link'] = {"author-link#", "author#-link", "subject-link#", "subject#-link", "authorlink#", "author#link", "subjectlink#", "subject#link"},

['AuthorList-Mask'] = {"author-mask#", "author#-mask", "subject-mask#", "subject#-mask", "authormask#", "author#mask"},

['ContributorList-First'] = {'contributor-first#', 'contributor#-first', 'contributor-given#', 'contributor#-given'},

['ContributorList-Last'] = {'contributor-last#', 'contributor#-last', 'contributor-surname#', 'contributor#-surname', 'contributor#'},

['EditorList-Last'] = {"editor-last#", "editor#-last", "editor-surname#", "editor#-surname", "editor#"},

['EditorList-Link'] = {"editor-link#", "editor#-link", "editorlink#", "editor#link"}, -- unhyphenated forms to be deprecated

['InterviewerList-First'] = {'interviewer-first#', 'interviewer#-first', 'interviewer-given#', 'interviewer#-given'},

['InterviewerList-Last'] = {'interviewer-last#', 'interviewer#-last', 'interviewer-surname#', 'interviewer#-surname', 'interviewer#'},

['TranslatorList-First'] = {'translator-first#', 'translator#-first', 'translator-given#', 'translator#-given'},

['TranslatorList-Last'] = {'translator-last#', 'translator#-last', 'translator-surname#', 'translator#-surname', 'translator#'},

--[[--------------------------< P U N C T _ S K I P >----------------------------------------------------------

'ArchiveURL', 'ChapterURL', 'ConferenceURL', 'LayURL', 'MapURL', 'TranscriptURL', 'URL', -- url-holding parameters

 

This table is primarily here to support internationalization.  Translations in this table are used, for example,

when an error message, category name, etc., is extracted from the English alias key.  There may be other cases where

-- Lua patterns to match pseudo-titles used by Internet Archive bot and others as place holder for unknown |title= value

{

['en'] = {'^wayback%s+machine$', false}, -- patterns in this table to be lowercase only

['local'] = nil, -- leave this nil except when there is a matching generic title in your language

},

This table of tables lists local language date names and fallback English date names. The code in Date_validation

will look first in the local table for valid date names. If date names are not found in the local table, the code

will look in the English table.

Because citations can be copied to the local wiki from en.wiki, the English is required when the date-name translation

function date_name_xlate() is used.

In these tables, season numbering is defined by Extended Date/Time Format (EDTF) Specification (https://www.loc.gov/standards/datetime/)

which became part of ISO 8601 in 2019.  See '§Sub-year groupings'. The standard defines various divisions using

numbers 21-41. CS1|2 only supports generic seasons. EDTF does support the distinction between north and south

hemispere seasons but CS1|2 has no way to make that distinction.

The standard does not address 'named' dates so, for the purposes of CS1|2, Easter and Christmas are defined here as 98 and 99, which

should be out of the ISO 8601 (EDTF) range of uses for a while.

--[[--------------------------< V O L U M E ,  I S S U E ,  P A G E S >----------------------------------------

--[[--------------------------< K E Y W O R D S >--------------------------------------------------------------

--[[--------------------------< K E Y W O R D S  T A B L E >--------------------------------------------------

this is a list of keywords; each key in the list is associated with a table of synonymous keywords possibly from

different languages.

for I18N: add local-language keywords to value table; do not change the key. For example, adding the German keyword 'ja':

Because CS1|2 templates from en.wiki articles are often copied to other local wikis, it is recommended that the English

keywords remain in these tables.

['amp'] = {'&', 'amp', 'ampersand'}, -- |name-list-style=

['and'] = {'and', 'serial'}, -- |name-list-style=

['affirmative'] = {'yes', 'true', 'y'}, -- |ignore-isbn-error=, |last-author-amp=, |no-tracking=, |no-pp= -- Used by InternetArchiveBot

--[[--------------------------< X L A T E _ K E Y W O R D S >--------------------------------------------------

--[[--------------------------< M A K E _ K E Y W O R D S _ L I S T >------------------------------------------

--[[--------------------------< K E Y W O R D S _ L I S T S >--------------------------------------------------

this is a list of lists of valid keywords for the various parameters in [key]. Generally the keys in this table

are the canonical en.wiki parameter names though some are contrived because of use in multiple differently named

parameters: ['yes_true_y'], ['id-access'].

The function make_keywords_list() extracts the individual keywords from the appropriate list in keywords{}.

The lists in this table are used to validate the keyword assignment for the parameters named in this table's keys.

--[[--------------------------< S T R I P M A R K E R S >------------------------------------------------------

Common pattern definition location for stripmarkers so that we don't have to go hunting for them if (when)

MediaWiki changes their form.

--[[--------------------------< I N V I S I B L E _ C H A R A C T E R S >--------------------------------------

This table holds non-printing or invisible characters indexed either by name or by Unicode group. Values are decimal

representations of UTF-8 codes.  The table is organized as a table of tables because the Lua pairs keyword returns

table data in an arbitrary order.  Here, we want to process the table from top to bottom because the entries at

the top of the table are also found in the ranges specified by the entries at the bottom of the table.

Also here is a pattern that recognizes stripmarkers that begin and end with the delete characters.  The nowiki

stripmarker is not an error but some others are because the parameter values that include them become part of the

template's metadata before stripmarker replacement.

Indic script makes use of zero width joiner as a character modifier so zwj characters must be left in.  This

pattern covers all of the unicode characters for these languages:

--[[--------------------------< L A N G U A G E  S U P P O R T >----------------------------------------------

local inter_wiki_map = {}; -- map of inter-wiki prefixes that are language-code prefixes

for k, v in pairs (mw.site.interwikiMap ('local')) do -- spin through the base inter-wiki map (limited to local)

--[[--------------------------< S C R I P T _ L A N G _ C O D E S >--------------------------------------------

This table is used to hold ISO 639-1 two-character and ISO 639-3 three-character language codes that apply only

to |script-title= and |script-chapter=

'am', 'ar', 'be', 'bg', 'bn', 'bo', 'bs', 'dv', 'dz', 'el', 'fa',

'gu', 'he', 'hi', 'hy', 'ja', 'ka', 'kk', 'km', 'kn', 'ko', 'ku',

'lo', 'mk', 'ml', 'mn', 'mr', 'my', 'ne', 'or', 'ota', 'ps', 'ru',

'sd', 'si', 'sr', 'ta', 'tg', 'th', 'ug', 'uk', 'ur', 'uz', 'yi', 'zh'

--[[--------------------------< L A N G U A G E  R E M A P P I N G >------------------------------------------

--[[--------------------------< P R O P E R T I E S _ C A T E G O R I E S >------------------------------------

Here we name properties categories

--[[--------------------------< T I T L E _ T Y P E S >--------------------------------------------------------

--[[=========================<< E R R O R  M E S S A G I N G >>===============================================

--[[--------------------------< E R R O R  M E S S A G E  S U P P L I M E N T S >----------------------------

I18N for those messages that are supplemented with additional specific text that describes the reason for

the error

--[[--------------------------< E R R O R _ C O N D I T I O N S >----------------------------------------------

Error condition table.  This table has two sections: errors at the top, maintenance at the bottom.  Maint 'messaging'

does not have a 'message' (message=nil)

The following contains a list of IDs for various error conditions defined in the code.  For each ID, we specify a

text message to display, an error category to include, and whether the error message should be wrapped as a hidden comment.

TODO: rename error_conditions{} to something more generic; create separate error and maint tables inside that?

category = 'Pages using citations with accessdate and no URL',

category = 'Pages with archiveurl citation errors',

category = 'Pages with archiveurl citation errors',

category = 'Pages with archiveurl citation errors',

message = 'Check date values in: $1', -- $1 is parameter name

err_bad_oclc = {

message = 'Check <code class="cs1-code">&#124;oclc=</code> value',

anchor = 'bad_oclc',

category = 'CS1 errors: OCLC',

bad_s2cid_err = {

category = 'Pages with URL errors',

category = 'CS1 errors: ZBL',

category = 'Pages with citations having bare URLs',

category = 'Pages with citations lacking titles',

category = 'Pages using web citations with no URL',

category = 'Pages with empty citations',

category = 'CS1 errors: missing name', -- author, contributor, editor, interviewer, translator

category = 'Pages using citations with format and no URL',

category = 'Pages with citations using unsupported parameters',

category = 'Pages with citations using unsupported parameters',

category = 'Pages with citations having redundant parameters',

category = 'CS1 errors: ssrn', -- same as bad arxiv

category = 'Pages with citations using unnamed parameters',

hidden = true

--[[--------------------------< M A I N T >--------------------------------------------------------------------

maint messages do not have a message (message = nil); otherwise the structure is the same as error messages

category = 'CS1 maint: BOT: original-url status unknown',

category = 'CS1 maint: unfit url',

category = 'CS1 maint: ZBL',

The following contains a list of values for various defined identifiers.  For each identifier we specify a

variety of information necessary to properly render the identifier in the citation.

q: wikidata q number for the identifier

label: the label preceeding the identifier; label is linked to a wikipedia article (in this order):

wikidata-supplied article name for the local wiki from id_handlers['<id>'].q

prefix: the first part of a url that will be concatenated with a second part which usually contains the identifier

encode: true if uri should be percent encoded; otherwise false

for others make a url using the value in prefix, use the keyword: pre (not checked; any text other than 'info' or 'rft' works here)

the value must be a valid access level for an identifier (see ['id-access'] in this file).

to the parameter that should control it (normally 'id-access')

prefix = '//arxiv.org/abs/', -- protocol relative tested 2013-09-04

COinS = nil, -- no COinS for this id (needs thinking on implementation because |asin-tld=)

link = 'International_Standard_Serial_Number#Electronic_ISSN',

prefix = '//www.jstor.org/stable/', -- protocol relative tested 2013-09-04

encode = false,

prefix = '//lccn.loc.gov/', -- protocol relative tested 2015-12-28

prefix = '//www.ams.org/mathscinet-getitem?mr=', -- protocol relative tested 2013-09-04

COinS = nil, -- no COinS for this id (needs thinking on implementation because /authors/books/works/OL)

prefix = '//www.osti.gov/biblio/', -- protocol relative tested 2018-09-12

suffix = " ",

q = '',

prefix = '//ssrn.com/abstract=', -- protocol relative tested 2013-09-04

--[[--------------------------< E X P O R T S >----------------------------------------------------------------