Sətir 1: |
Sətir 1: |
| + | |
| + | require('Module:No globals'); |
| | | |
| --[[--------------------------< F O R W A R D D E C L A R A T I O N S >-------------------------------------- | | --[[--------------------------< F O R W A R D D E C L A R A T I O N S >-------------------------------------- |
− | ]]
| |
| | | |
− | local dates, year_date_check, reformat_dates, date_hyphen_to_dash, -- functions in Module:Citation/CS1/Date_validation
| + | each of these counts against the Lua upvalue limit |
− | date_name_xlate
| |
| | | |
− | local is_set, in_array, substitute, error_comment, set_error, select_one, -- functions in Module:Citation/CS1/Utilities
| + | ]] |
− | add_maint_cat, wrap_style, safe_for_italics, is_wikilink, make_wikilink,
| |
− | strip_apostrophe_markup;
| |
| | | |
− | local z ={}; -- tables in Module:Citation/CS1/Utilities | + | local validation; -- functions in Module:Citation/CS1/Date_validation |
| | | |
− | local extract_ids, extract_id_access_levels, build_id_list, is_embargoed; -- functions in Module:Citation/CS1/Identifiers | + | local utilities; -- functions in Module:Citation/CS1/Utilities |
− | | + | local z ={}; -- table of tables in Module:Citation/CS1/Utilities |
− | local make_coins_title, get_coins_pages, COinS; -- functions in Module:Citation/CS1/COinS | |
| | | |
| + | local identifiers; -- functions and tables in Module:Citation/CS1/Identifiers |
| + | local metadata; -- functions in Module:Citation/CS1/COinS |
| local cfg = {}; -- table of configuration tables that are defined in Module:Citation/CS1/Configuration | | local cfg = {}; -- table of configuration tables that are defined in Module:Citation/CS1/Configuration |
| local whitelist = {}; -- table of tables listing valid template parameter names; defined in Module:Citation/CS1/Whitelist | | local whitelist = {}; -- table of tables listing valid template parameter names; defined in Module:Citation/CS1/Whitelist |
Sətir 22: |
Sətir 21: |
| --[[--------------------------< P A G E S C O P E V A R I A B L E S >-------------------------------------- | | --[[--------------------------< P A G E S C O P E V A R I A B L E S >-------------------------------------- |
| | | |
− | delare variables here that have page-wide scope that are not brought in from other modules; thatare created here
| + | declare variables here that have page-wide scope that are not brought in from other modules; that are created here and used here |
− | and used here | |
| | | |
| ]] | | ]] |
| | | |
− | local added_deprecated_cat; -- boolean flag so that the category is added only once | + | local added_deprecated_cat; -- Boolean flag so that the category is added only once |
− | local added_prop_cats = {}; -- list of property categories that have been added to z.properties_cats
| + | local added_vanc_errs; -- Boolean flag so we only emit one Vancouver error / category |
− | local added_vanc_errs; -- boolean flag so we only emit one Vancouver error / category | |
| | | |
| local Frame; -- holds the module's frame table | | local Frame; -- holds the module's frame table |
Sətir 48: |
Sətir 45: |
| local i = 1; | | local i = 1; |
| while i <= count do -- loop through all items in list | | while i <= count do -- loop through all items in list |
− | if is_set( list[i] ) then | + | if utilities.is_set( list[i] ) then |
| return list[i]; -- return the first set list member | | return list[i]; -- return the first set list member |
| end | | end |
| i = i + 1; -- point to next | | i = i + 1; -- point to next |
− | end
| |
− | end
| |
− |
| |
− |
| |
− | --[[--------------------------< A D D _ P R O P _ C A T >--------------------------------------------------------
| |
− |
| |
− | Adds a category to z.properties_cats using names from the configuration file with additional text if any.
| |
− |
| |
− | foreign_lang_source and foreign_lang_source_2 keys have a language code appended to them so that multiple languages
| |
− | may be categorized but multiples of the same language are not categorized.
| |
− |
| |
− | added_prop_cats is a table declared in page scope variables above
| |
− |
| |
− | ]]
| |
− |
| |
− | local function add_prop_cat (key, arguments)
| |
− | if not added_prop_cats [key] then
| |
− | added_prop_cats [key] = true; -- note that we've added this category
| |
− | key = key:gsub ('(foreign_lang_source_?2?)%a%a%a?', '%1'); -- strip lang code from keyname
| |
− | table.insert( z.properties_cats, substitute (cfg.prop_cats [key], arguments)); -- make name then add to table
| |
| end | | end |
| end | | end |
Sətir 81: |
Sətir 58: |
| To prevent duplication, added_vanc_errs is nil until an error message is emitted. | | To prevent duplication, added_vanc_errs is nil until an error message is emitted. |
| | | |
− | added_vanc_errs is a boolean declared in page scope variables above | + | added_vanc_errs is a Boolean declared in page scope variables above |
| | | |
| ]] | | ]] |
Sətir 88: |
Sətir 65: |
| if not added_vanc_errs then | | if not added_vanc_errs then |
| added_vanc_errs = true; -- note that we've added this category | | added_vanc_errs = true; -- note that we've added this category |
− | table.insert( z.message_tail, { set_error( 'vancouver', {source}, true ) } ); | + | table.insert( z.message_tail, { utilities.set_message ( 'err_vancouver', {source}, true ) } ); |
| end | | end |
| end | | end |
Sətir 95: |
Sətir 72: |
| --[[--------------------------< I S _ S C H E M E >------------------------------------------------------------ | | --[[--------------------------< I S _ S C H E M E >------------------------------------------------------------ |
| | | |
− | does this thing that purports to be a uri scheme seem to be a valid scheme? The scheme is checked to see if it | + | does this thing that purports to be a URI scheme seem to be a valid scheme? The scheme is checked to see if it |
| is in agreement with http://tools.ietf.org/html/std66#section-3.1 which says: | | is in agreement with http://tools.ietf.org/html/std66#section-3.1 which says: |
| Scheme names consist of a sequence of characters beginning with a | | Scheme names consist of a sequence of characters beginning with a |
Sətir 118: |
Sətir 95: |
| Single character names are generally reserved; see https://tools.ietf.org/html/draft-ietf-dnsind-iana-dns-01#page-15; | | Single character names are generally reserved; see https://tools.ietf.org/html/draft-ietf-dnsind-iana-dns-01#page-15; |
| see also [[Single-letter second-level domain]] | | see also [[Single-letter second-level domain]] |
− | list of tlds: https://www.iana.org/domains/root/db | + | list of TLDs: https://www.iana.org/domains/root/db |
| | | |
− | rfc952 (modified by rfc 1123) requires the first and last character of a hostname to be a letter or a digit. Between
| + | RFC 952 (modified by RFC 1123) requires the first and last character of a hostname to be a letter or a digit. Between |
| the first and last characters the name may use letters, digits, and the hyphen. | | the first and last characters the name may use letters, digits, and the hyphen. |
| | | |
| Also allowed are IPv4 addresses. IPv6 not supported | | Also allowed are IPv4 addresses. IPv6 not supported |
| | | |
− | domain is expected to be stripped of any path so that the last character in the last character of the tld. tld | + | domain is expected to be stripped of any path so that the last character in the last character of the TLD. tld |
− | is two or more alpha characters. Any preceding '//' (from splitting a url with a scheme) will be stripped | + | is two or more alpha characters. Any preceding '//' (from splitting a URL with a scheme) will be stripped |
− | here. Perhaps not necessary but retained incase it is necessary for IPv4 dot decimal. | + | here. Perhaps not necessary but retained in case it is necessary for IPv4 dot decimal. |
| | | |
| There are several tests: | | There are several tests: |
| the first character of the whole domain name including subdomains must be a letter or a digit | | the first character of the whole domain name including subdomains must be a letter or a digit |
− | internationalized domain name (ascii characters with .xn-- ASCII Compatible Encoding (ACE) prefix xn-- in the tld) see https://tools.ietf.org/html/rfc3490 | + | internationalized domain name (ASCII characters with .xn-- ASCII Compatible Encoding (ACE) prefix xn-- in the TLD) see https://tools.ietf.org/html/rfc3490 |
| single-letter/digit second-level domains in the .org, .cash, and .today TLDs | | single-letter/digit second-level domains in the .org, .cash, and .today TLDs |
| q, x, and z SL domains in the .com TLD | | q, x, and z SL domains in the .com TLD |
Sətir 140: |
Sətir 117: |
| IPv4 dot-decimal address format; TLD not allowed | | IPv4 dot-decimal address format; TLD not allowed |
| | | |
− | returns true if domain appears to be a proper name and tld or IPv4 address, else false | + | returns true if domain appears to be a proper name and TLD or IPv4 address, else false |
| | | |
| ]=] | | ]=] |
Sətir 155: |
Sətir 132: |
| end | | end |
| | | |
− | if domain:match ('^%a+:') then -- hack to detect things that look like s:Page:Title where Page: is namespace at wikisource | + | if domain:match ('^%a+:') then -- hack to detect things that look like s:Page:Title where Page: is namespace at Wikisource |
| return false; | | return false; |
| end | | end |
| | | |
− | local patterns = { -- patterns that look like urls | + | local patterns = { -- patterns that look like URLs |
| '%f[%w][%w][%w%-]+[%w]%.%a%a+$', -- three or more character hostname.hostname or hostname.tld | | '%f[%w][%w][%w%-]+[%w]%.%a%a+$', -- three or more character hostname.hostname or hostname.tld |
| '%f[%w][%w][%w%-]+[%w]%.xn%-%-[%w]+$', -- internationalized domain name with ACE prefix | | '%f[%w][%w][%w%-]+[%w]%.xn%-%-[%w]+$', -- internationalized domain name with ACE prefix |
| '%f[%a][qxz]%.com$', -- assigned one character .com hostname (x.com times out 2015-12-10) | | '%f[%a][qxz]%.com$', -- assigned one character .com hostname (x.com times out 2015-12-10) |
| '%f[%a][iq]%.net$', -- assigned one character .net hostname (q.net registered but not active 2015-12-10) | | '%f[%a][iq]%.net$', -- assigned one character .net hostname (q.net registered but not active 2015-12-10) |
− | '%f[%w][%w]%.%a%a$', -- one character hostname and cctld (2 chars) | + | '%f[%w][%w]%.%a%a$', -- one character hostname and ccTLD (2 chars) |
− | '%f[%w][%w][%w]%.%a%a+$', -- two character hostname and tld | + | '%f[%w][%w][%w]%.%a%a+$', -- two character hostname and TLD |
| '^%d%d?%d?%.%d%d?%d?%.%d%d?%d?%.%d%d?%d?', -- IPv4 address | | '^%d%d?%d?%.%d%d?%d?%.%d%d?%d?%.%d%d?%d?', -- IPv4 address |
| } | | } |
Sətir 171: |
Sətir 148: |
| for _, pattern in ipairs (patterns) do -- loop through the patterns list | | for _, pattern in ipairs (patterns) do -- loop through the patterns list |
| if domain:match (pattern) then | | if domain:match (pattern) then |
− | return true; -- if a match then we think that this thing that purports to be a url is a url | + | return true; -- if a match then we think that this thing that purports to be a URL is a URL |
| end | | end |
| end | | end |
Sətir 186: |
Sətir 163: |
| --[[--------------------------< I S _ U R L >------------------------------------------------------------------ | | --[[--------------------------< I S _ U R L >------------------------------------------------------------------ |
| | | |
− | returns true if the scheme and domain parts of a url appear to be a valid url; else false. | + | returns true if the scheme and domain parts of a URL appear to be a valid URL; else false. |
| | | |
| This function is the last step in the validation process. This function is separate because there are cases that | | This function is the last step in the validation process. This function is separate because there are cases that |
Sətir 195: |
Sətir 172: |
| | | |
| local function is_url (scheme, domain) | | local function is_url (scheme, domain) |
− | if is_set (scheme) then -- if scheme is set check it and domain | + | if utilities.is_set (scheme) then -- if scheme is set check it and domain |
| return is_scheme (scheme) and is_domain_name (domain); | | return is_scheme (scheme) and is_domain_name (domain); |
| else | | else |
− | return is_domain_name (domain); -- scheme not set when url is protocol relative | + | return is_domain_name (domain); -- scheme not set when URL is protocol-relative |
| end | | end |
| end | | end |
Sətir 205: |
Sətir 182: |
| --[[--------------------------< S P L I T _ U R L >------------------------------------------------------------ | | --[[--------------------------< S P L I T _ U R L >------------------------------------------------------------ |
| | | |
− | Split a url into a scheme, authority indicator, and domain. | + | Split a URL into a scheme, authority indicator, and domain. |
| | | |
− | First remove Fully Qualified Domain Name terminator (a dot following tld) (if any) and any path(/), query(?) or fragment(#). | + | First remove Fully Qualified Domain Name terminator (a dot following TLD) (if any) and any path(/), query(?) or fragment(#). |
| | | |
− | If protocol relative url, return nil scheme and domain else return nil for both scheme and domain. | + | If protocol-relative URL, return nil scheme and domain else return nil for both scheme and domain. |
| | | |
− | When not protocol relative, get scheme, authority indicator, and domain. If there is an authority indicator (one | + | When not protocol-relative, get scheme, authority indicator, and domain. If there is an authority indicator (one |
| or more '/' characters immediately following the scheme's colon), make sure that there are only 2. | | or more '/' characters immediately following the scheme's colon), make sure that there are only 2. |
| + | |
| + | Any URL that does not have news: scheme must have authority indicator (//). TODO: are there other common schemes |
| + | like news: that don't use authority indicator? |
| | | |
| Strip off any port and path; | | Strip off any port and path; |
Sətir 223: |
Sətir 203: |
| url_str = url_str:gsub ('([%a%d])%.?[/%?#].*$', '%1'); -- strip FQDN terminator and path(/), query(?), fragment (#) (the capture prevents false replacement of '//') | | url_str = url_str:gsub ('([%a%d])%.?[/%?#].*$', '%1'); -- strip FQDN terminator and path(/), query(?), fragment (#) (the capture prevents false replacement of '//') |
| | | |
− | if url_str:match ('^//%S*') then -- if there is what appears to be a protocol relative url | + | if url_str:match ('^//%S*') then -- if there is what appears to be a protocol-relative URL |
| domain = url_str:match ('^//(%S*)') | | domain = url_str:match ('^//(%S*)') |
| elseif url_str:match ('%S-:/*%S+') then -- if there is what appears to be a scheme, optional authority indicator, and domain name | | elseif url_str:match ('%S-:/*%S+') then -- if there is what appears to be a scheme, optional authority indicator, and domain name |
| scheme, authority, domain = url_str:match ('(%S-:)(/*)(%S+)'); -- extract the scheme, authority indicator, and domain portions | | scheme, authority, domain = url_str:match ('(%S-:)(/*)(%S+)'); -- extract the scheme, authority indicator, and domain portions |
− | authority = authority:gsub ('//', '', 1); -- replace place 1 pair of '/' with nothing; | + | if utilities.is_set (authority) then |
− | if is_set(authority) then -- if anything left (1 or 3+ '/' where authority should be) then
| + | authority = authority:gsub ('//', '', 1); -- replace place 1 pair of '/' with nothing; |
− | return scheme; -- return scheme only making domain nil which will cause an error message | + | if utilities.is_set(authority) then -- if anything left (1 or 3+ '/' where authority should be) then |
| + | return scheme; -- return scheme only making domain nil which will cause an error message |
| + | end |
| + | else |
| + | if not scheme:match ('^news:') then -- except for news:..., MediaWiki won't link URLs that do not have authority indicator; TODO: a better way to do this test? |
| + | return scheme; -- return scheme only making domain nil which will cause an error message |
| + | end |
| end | | end |
| domain = domain:gsub ('(%a):%d+', '%1'); -- strip port number if present | | domain = domain:gsub ('(%a):%d+', '%1'); -- strip port number if present |
Sətir 240: |
Sətir 226: |
| --[[--------------------------< L I N K _ P A R A M _ O K >--------------------------------------------------- | | --[[--------------------------< L I N K _ P A R A M _ O K >--------------------------------------------------- |
| | | |
− | checks the content of |title-link=, |series-link=, |author-link= etc for properly formatted content: no wikilinks, no urls | + | checks the content of |title-link=, |series-link=, |author-link=, etc. for properly formatted content: no wikilinks, no URLs |
| | | |
− | Link parameters are to hold the title of a wikipedia article so none of the WP:TITLESPECIALCHARACTERS are allowed: | + | Link parameters are to hold the title of a Wikipedia article, so none of the WP:TITLESPECIALCHARACTERS are allowed: |
| # < > [ ] | { } _ | | # < > [ ] | { } _ |
− | except the underscore which is used as a space in wiki urls and # which is used for section links | + | except the underscore which is used as a space in wiki URLs and # which is used for section links |
| | | |
| returns false when the value contains any of these characters. | | returns false when the value contains any of these characters. |
| | | |
− | When there are no illegal characters, this function returns TRUE if value DOES NOT appear to be a valid url (the | + | When there are no illegal characters, this function returns TRUE if value DOES NOT appear to be a valid URL (the |
− | |<param>-link= parameter is ok); else false when value appears to be a valid url (the |<param>-link= parameter is NOT ok). | + | |<param>-link= parameter is ok); else false when value appears to be a valid URL (the |<param>-link= parameter is NOT ok). |
| | | |
| ]] | | ]] |
Sətir 259: |
Sətir 245: |
| end | | end |
| | | |
− | scheme, domain = split_url (value); -- get scheme or nil and domain or nil from url; | + | scheme, domain = split_url (value); -- get scheme or nil and domain or nil from URL; |
− | return not is_url (scheme, domain); -- return true if value DOES NOT appear to be a valid url | + | return not is_url (scheme, domain); -- return true if value DOES NOT appear to be a valid URL |
| end | | end |
| | | |
Sətir 268: |
Sətir 254: |
| Use link_param_ok() to validate |<param>-link= value and its matching |<title>= value. | | Use link_param_ok() to validate |<param>-link= value and its matching |<title>= value. |
| | | |
− | |<title>= may be wikilinked but not when |<param>-link= has a value. This function emits an error message when | + | |<title>= may be wiki-linked but not when |<param>-link= has a value. This function emits an error message when |
| that condition exists | | that condition exists |
| + | |
| + | check <link> for inter-language interwiki-link prefix. prefix must be a MediaWiki-recognized language |
| + | code and must begin with a colon. |
| | | |
| ]] | | ]] |
Sətir 275: |
Sətir 264: |
| local function link_title_ok (link, lorig, title, torig) | | local function link_title_ok (link, lorig, title, torig) |
| local orig; | | local orig; |
− | | + | if utilities.is_set (link) then -- don't bother if <param>-link doesn't have a value |
− | if is_set (link) then -- don't bother if <param>-link doesn't have a value | |
| if not link_param_ok (link) then -- check |<param>-link= markup | | if not link_param_ok (link) then -- check |<param>-link= markup |
| orig = lorig; -- identify the failing link parameter | | orig = lorig; -- identify the failing link parameter |
| elseif title:find ('%[%[') then -- check |title= for wikilink markup | | elseif title:find ('%[%[') then -- check |title= for wikilink markup |
| orig = torig; -- identify the failing |title= parameter | | orig = torig; -- identify the failing |title= parameter |
| + | elseif link:match ('^%a+:') then -- if the link is what looks like an interwiki |
| + | local prefix = link:match ('^(%a+):'):lower(); -- get the interwiki prefix |
| + | |
| + | if cfg.inter_wiki_map[prefix] then -- if prefix is in the map, must have preceding colon |
| + | orig = lorig; -- flag as error |
| + | end |
| end | | end |
| end | | end |
| | | |
− | if is_set (orig) then | + | if utilities.is_set (orig) then |
− | table.insert( z.message_tail, { set_error( 'bad_paramlink', orig)}); -- url or wikilink in |title= with |title-link=; | + | link = ''; -- unset |
| + | table.insert( z.message_tail, { utilities.set_message ( 'err_bad_paramlink', orig)}); -- URL or wikilink in |title= with |title-link=; |
| end | | end |
| + | |
| + | return link; -- link if ok, empty string else |
| end | | end |
| | | |
Sətir 294: |
Sətir 291: |
| Determines whether a URL string appears to be valid. | | Determines whether a URL string appears to be valid. |
| | | |
− | First we test for space characters. If any are found, return false. Then split the url into scheme and domain | + | First we test for space characters. If any are found, return false. Then split the URL into scheme and domain |
− | portions, or for protocol relative (//example.com) urls, just the domain. Use is_url() to validate the two | + | portions, or for protocol-relative (//example.com) URLs, just the domain. Use is_url() to validate the two |
− | portions of the url. If both are valid, or for protocol relative if domain is valid, return true, else false. | + | portions of the URL. If both are valid, or for protocol-relative if domain is valid, return true, else false. |
| | | |
− | Because it is different from a standard url, and because this module used external_link() to make external links | + | Because it is different from a standard URL, and because this module used external_link() to make external links |
| that work for standard and news: links, we validate newsgroup names here. The specification for a newsgroup name | | that work for standard and news: links, we validate newsgroup names here. The specification for a newsgroup name |
| is at https://tools.ietf.org/html/rfc5536#section-3.1.4 | | is at https://tools.ietf.org/html/rfc5536#section-3.1.4 |
Sətir 305: |
Sətir 302: |
| | | |
| local function check_url( url_str ) | | local function check_url( url_str ) |
− | if nil == url_str:match ("^%S+$") then -- if there are any spaces in |url=value it can't be a proper url | + | if nil == url_str:match ("^%S+$") then -- if there are any spaces in |url=value it can't be a proper URL |
| return false; | | return false; |
| end | | end |
| local scheme, domain; | | local scheme, domain; |
| | | |
− | scheme, domain = split_url (url_str); -- get scheme or nil and domain or nil from url; | + | scheme, domain = split_url (url_str); -- get scheme or nil and domain or nil from URL; |
| | | |
| if 'news:' == scheme then -- special case for newsgroups | | if 'news:' == scheme then -- special case for newsgroups |
Sətir 316: |
Sətir 313: |
| end | | end |
| | | |
− | return is_url (scheme, domain); -- return true if value appears to be a valid url | + | return is_url (scheme, domain); -- return true if value appears to be a valid URL |
| end | | end |
| | | |
Sətir 323: |
Sətir 320: |
| | | |
| Return true if a parameter value has a string that begins and ends with square brackets [ and ] and the first | | Return true if a parameter value has a string that begins and ends with square brackets [ and ] and the first |
− | non-space characters following the opening bracket appear to be a url. The test will also find external wikilinks | + | non-space characters following the opening bracket appear to be a URL. The test will also find external wikilinks |
− | that use protocol relative urls. Also finds bare urls. | + | that use protocol-relative URLs. Also finds bare URLs. |
| | | |
− | The frontier pattern prevents a match on interwiki links which are similar to scheme:path urls. The tests that | + | The frontier pattern prevents a match on interwiki-links which are similar to scheme:path URLs. The tests that |
− | find bracketed urls are required because the parameters that call this test (currently |title=, |chapter=, |work=, | + | find bracketed URLs are required because the parameters that call this test (currently |title=, |chapter=, |work=, |
| and |publisher=) may have wikilinks and there are articles or redirects like '//Hus' so, while uncommon, |title=[[//Hus]] | | and |publisher=) may have wikilinks and there are articles or redirects like '//Hus' so, while uncommon, |title=[[//Hus]] |
| is possible as might be [[en://Hus]]. | | is possible as might be [[en://Hus]]. |
Sətir 336: |
Sətir 333: |
| local scheme, domain; | | local scheme, domain; |
| | | |
− | if value:match ('%f[%[]%[%a%S*:%S+.*%]') then -- if ext wikilink with scheme and domain: [xxxx://yyyyy.zzz] | + | if value:match ('%f[%[]%[%a%S*:%S+.*%]') then -- if ext. wikilink with scheme and domain: [xxxx://yyyyy.zzz] |
| scheme, domain = split_url (value:match ('%f[%[]%[(%a%S*:%S+).*%]')); | | scheme, domain = split_url (value:match ('%f[%[]%[(%a%S*:%S+).*%]')); |
− | elseif value:match ('%f[%[]%[//%S+.*%]') then -- if protocol relative ext wikilink: [//yyyyy.zzz] | + | elseif value:match ('%f[%[]%[//%S+.*%]') then -- if protocol-relative ext. wikilink: [//yyyyy.zzz] |
| scheme, domain = split_url (value:match ('%f[%[]%[(//%S+).*%]')); | | scheme, domain = split_url (value:match ('%f[%[]%[(//%S+).*%]')); |
− | elseif value:match ('%a%S*:%S+') then -- if bare url with scheme; may have leading or trailing plain text | + | elseif value:match ('%a%S*:%S+') then -- if bare URL with scheme; may have leading or trailing plain text |
| scheme, domain = split_url (value:match ('(%a%S*:%S+)')); | | scheme, domain = split_url (value:match ('(%a%S*:%S+)')); |
− | elseif value:match ('//%S+') then -- if protocol relative bare url: //yyyyy.zzz; may have leading or trailing plain text | + | elseif value:match ('//%S+') then -- if protocol-relative bare URL: //yyyyy.zzz; may have leading or trailing plain text |
| scheme, domain = split_url (value:match ('(//%S+)')); -- what is left should be the domain | | scheme, domain = split_url (value:match ('(//%S+)')); -- what is left should be the domain |
| else | | else |
− | return false; -- didn't find anything that is obviously a url | + | return false; -- didn't find anything that is obviously a URL |
| end | | end |
| | | |
− | return is_url (scheme, domain); -- return true if value appears to be a valid url | + | return is_url (scheme, domain); -- return true if value appears to be a valid URL |
| end | | end |
| | | |
Sətir 361: |
Sətir 358: |
| local error_message = ''; | | local error_message = ''; |
| for k, v in pairs (parameter_list) do -- for each parameter in the list | | for k, v in pairs (parameter_list) do -- for each parameter in the list |
− | if is_parameter_ext_wikilink (v) then -- look at the value; if there is a url add an error message | + | if is_parameter_ext_wikilink (v) then -- look at the value; if there is a URL add an error message |
− | if is_set(error_message) then -- once we've added the first portion of the error message ... | + | if utilities.is_set(error_message) then -- once we've added the first portion of the error message ... |
− | error_message=error_message .. ", "; -- ... add a comma space separator | + | error_message = error_message .. ", "; -- ... add a comma space separator |
| end | | end |
− | error_message=error_message .. "|" .. k .. "="; -- add the failed parameter | + | error_message = error_message .. "|" .. k .. "="; -- add the failed parameter |
| end | | end |
| + | end |
| + | if utilities.is_set (error_message) then -- done looping, if there is an error message, display it |
| + | table.insert( z.message_tail, { utilities.set_message ( 'err_param_has_ext_link', {error_message}, true ) } ); |
| end | | end |
| end | | end |
Sətir 379: |
Sətir 379: |
| local function safe_for_url( str ) | | local function safe_for_url( str ) |
| if str:match( "%[%[.-%]%]" ) ~= nil then | | if str:match( "%[%[.-%]%]" ) ~= nil then |
| + | table.insert( z.message_tail, { utilities.set_message ( 'err_wikilink_in_url', {}, true ) } ); |
| end | | end |
| | | |
Sətir 400: |
Sətir 401: |
| local base_url; | | local base_url; |
| | | |
− | if not is_set( label ) then | + | if not utilities.is_set ( label ) then |
| label = URL; | | label = URL; |
− | if is_set( source ) then | + | if utilities.is_set ( source ) then |
− | error_str = set_error( 'bare_url_missing_title', { wrap_style ('parameter', source) }, false, " " ); | + | error_str = utilities.set_message ( 'err_bare_url_missing_title', { utilities.wrap_style ('parameter', source) }, false, " " ); |
| else | | else |
| error( cfg.messages["bare_url_no_origin"] ); | | error( cfg.messages["bare_url_no_origin"] ); |
Sətir 409: |
Sətir 410: |
| end | | end |
| if not check_url( URL ) then | | if not check_url( URL ) then |
− | error_str = set_error( 'bad_url', {wrap_style ('parameter', source)}, false, " " ) .. error_str; | + | error_str = utilities.set_message ( 'err_bad_url', {utilities.wrap_style ('parameter', source)}, false, " " ) .. error_str; |
| end | | end |
| | | |
− | domain, path = URL:match ('^([/%.%-%+:%a%d]+)([/%?#].*)$'); -- split the url into scheme plus domain and path | + | domain, path = URL:match ('^([/%.%-%+:%a%d]+)([/%?#].*)$'); -- split the URL into scheme plus domain and path |
| if path then -- if there is a path portion | | if path then -- if there is a path portion |
− | path = path:gsub ('[%[%]]', {['[']='%5b',[']']='%5d'}); -- replace '[' and ']' with their percent encoded values | + | path = path:gsub ('[%[%]]', {['['] = '%5b', [']'] = '%5d'}); -- replace '[' and ']' with their percent-encoded values |
| URL = table.concat ({domain, path}); -- and reassemble | | URL = table.concat ({domain, path}); -- and reassemble |
| end | | end |
| | | |
− | base_url = table.concat({ "[", URL, " ", safe_for_url (label), "]" }); -- assemble a wikimarkup url | + | base_url = table.concat({ "[", URL, " ", safe_for_url (label), "]" }); -- assemble a wiki-markup URL |
| | | |
− | if is_set (access) then -- access level (subscription, registration, limited) | + | if utilities.is_set (access) then -- access level (subscription, registration, limited) |
− | base_url = substitute (cfg.presentation['ext-link-access-signal'], {cfg.presentation[access].class, cfg.presentation[access].title, base_url}); -- add the appropriate icon | + | base_url = utilities.substitute (cfg.presentation['ext-link-access-signal'], {cfg.presentation[access].class, cfg.presentation[access].title, base_url}); -- add the appropriate icon |
| end | | end |
| | | |
Sətir 434: |
Sətir 435: |
| parameters in the citation. | | parameters in the citation. |
| | | |
− | added_deprecated_cat is a boolean declared in page scope variables above | + | added_deprecated_cat is a Boolean declared in page scope variables above |
| | | |
| ]] | | ]] |
Sətir 441: |
Sətir 442: |
| if not added_deprecated_cat then | | if not added_deprecated_cat then |
| added_deprecated_cat = true; -- note that we've added this category | | added_deprecated_cat = true; -- note that we've added this category |
| + | table.insert( z.message_tail, { utilities.set_message ( 'err_deprecated_params', {name}, true ) } ); -- add error message |
| end | | end |
| end | | end |
Sətir 447: |
Sətir 449: |
| --[=[-------------------------< K E R N _ Q U O T E S >-------------------------------------------------------- | | --[=[-------------------------< K E R N _ Q U O T E S >-------------------------------------------------------- |
| | | |
− | Apply kerning to open the space between the quote mark provided by the Module and a leading or trailing quote | + | Apply kerning to open the space between the quote mark provided by the module and a leading or trailing quote |
| mark contained in a |title= or |chapter= parameter's value. | | mark contained in a |title= or |chapter= parameter's value. |
| | | |
Sətir 453: |
Sətir 455: |
| "'Unkerned title with leading and trailing single quote marks'" | | "'Unkerned title with leading and trailing single quote marks'" |
| " 'Kerned title with leading and trailing single quote marks' " (in real life the kerning isn't as wide as this example) | | " 'Kerned title with leading and trailing single quote marks' " (in real life the kerning isn't as wide as this example) |
− | Double single quotes (italic or bold wikimarkup) are not kerned. | + | Double single quotes (italic or bold wiki-markup) are not kerned. |
| | | |
− | Replaces unicode quotemarks in plain text or in the label portion of a [[L|D]] style wikilink with typewriter | + | Replaces Unicode quote marks in plain text or in the label portion of a [[L|D]] style wikilink with typewriter |
| quote marks regardless of the need for kerning. Unicode quote marks are not replaced in simple [[D]] wikilinks. | | quote marks regardless of the need for kerning. Unicode quote marks are not replaced in simple [[D]] wikilinks. |
| | | |
− | Call this function for chapter titles, for website titles, etc; not for book titles. | + | Call this function for chapter titles, for website titles, etc.; not for book titles. |
| | | |
| ]=] | | ]=] |
| | | |
| local function kern_quotes (str) | | local function kern_quotes (str) |
− | local cap=''; | + | local cap = ''; |
− | local cap2=''; | + | local cap2 = ''; |
| local wl_type, label, link; | | local wl_type, label, link; |
| | | |
− | wl_type, label, link = is_wikilink (str); -- wl_type is: 0, no wl (text in label variable); 1, [[D]]; 2, [[L|D]] | + | wl_type, label, link = utilities.is_wikilink (str); -- wl_type is: 0, no wl (text in label variable); 1, [[D]]; 2, [[L|D]] |
| | | |
| if 1 == wl_type then -- [[D]] simple wikilink with or without quote marks | | if 1 == wl_type then -- [[D]] simple wikilink with or without quote marks |
| if mw.ustring.match (str, '%[%[[\"“”\'‘’].+[\"“”\'‘’]%]%]') then -- leading and trailing quote marks | | if mw.ustring.match (str, '%[%[[\"“”\'‘’].+[\"“”\'‘’]%]%]') then -- leading and trailing quote marks |
− | str = substitute (cfg.presentation['kern-wl-both'], str); | + | str = utilities.substitute (cfg.presentation['kern-wl-both'], str); |
| elseif mw.ustring.match (str, '%[%[[\"“”\'‘’].+%]%]') then -- leading quote marks | | elseif mw.ustring.match (str, '%[%[[\"“”\'‘’].+%]%]') then -- leading quote marks |
− | str = substitute (cfg.presentation['kern-wl-left'], str); | + | str = utilities.substitute (cfg.presentation['kern-wl-left'], str); |
| elseif mw.ustring.match (str, '%[%[.+[\"“”\'‘’]%]%]') then -- trailing quote marks | | elseif mw.ustring.match (str, '%[%[.+[\"“”\'‘’]%]%]') then -- trailing quote marks |
− | str = substitute (cfg.presentation['kern-wl-right'], str); | + | str = utilities.substitute (cfg.presentation['kern-wl-right'], str); |
| end | | end |
| | | |
| else -- plain text or [[L|D]]; text in label variable | | else -- plain text or [[L|D]]; text in label variable |
− | label= mw.ustring.gsub (label, '[“”]', '\"'); -- replace “” (U+201C & U+201D) with " (typewriter double quote mark) | + | label = mw.ustring.gsub (label, '[“”]', '\"'); -- replace “” (U+201C & U+201D) with " (typewriter double quote mark) |
− | label= mw.ustring.gsub (label, '[‘’]', '\''); -- replace ‘’ (U+2018 & U+2019) with ' (typewriter single quote mark) | + | label = mw.ustring.gsub (label, '[‘’]', '\''); -- replace ‘’ (U+2018 & U+2019) with ' (typewriter single quote mark) |
| | | |
| cap, cap2 = mw.ustring.match (label, "^([\"\'])([^\'].+)"); -- match leading double or single quote but not doubled single quotes (italic markup) | | cap, cap2 = mw.ustring.match (label, "^([\"\'])([^\'].+)"); -- match leading double or single quote but not doubled single quotes (italic markup) |
− | if is_set (cap) then | + | if utilities.is_set (cap) then |
− | label = substitute (cfg.presentation['kern-left'], {cap, cap2}); | + | label = utilities.substitute (cfg.presentation['kern-left'], {cap, cap2}); |
| end | | end |
| | | |
| cap, cap2 = mw.ustring.match (label, "^(.+[^\'])([\"\'])$") -- match trailing double or single quote but not doubled single quotes (italic markup) | | cap, cap2 = mw.ustring.match (label, "^(.+[^\'])([\"\'])$") -- match trailing double or single quote but not doubled single quotes (italic markup) |
− | if is_set (cap) then | + | if utilities.is_set (cap) then |
− | label = substitute (cfg.presentation['kern-right'], {cap, cap2}); | + | label = utilities.substitute (cfg.presentation['kern-right'], {cap, cap2}); |
| end | | end |
| | | |
| if 2 == wl_type then | | if 2 == wl_type then |
− | str = make_wikilink (link, label); -- reassemble the wikilink | + | str = utilities.make_wikilink (link, label); -- reassemble the wikilink |
| else | | else |
| str = label; | | str = label; |
Sətir 504: |
Sətir 506: |
| --[[--------------------------< F O R M A T _ S C R I P T _ V A L U E >---------------------------------------- | | --[[--------------------------< F O R M A T _ S C R I P T _ V A L U E >---------------------------------------- |
| | | |
− | |script-title= holds title parameters that are not written in Latin based scripts: Chinese, Japanese, Arabic, Hebrew, etc. These scripts should | + | |script-title= holds title parameters that are not written in Latin-based scripts: Chinese, Japanese, Arabic, Hebrew, etc. These scripts should |
| not be italicized and may be written right-to-left. The value supplied by |script-title= is concatenated onto Title after Title has been wrapped | | not be italicized and may be written right-to-left. The value supplied by |script-title= is concatenated onto Title after Title has been wrapped |
| in italic markup. | | in italic markup. |
| | | |
− | Regardless of language, all values provided by |script-title= are wrapped in <bdi>...</bdi> tags to isolate rtl languages from the English left to right. | + | Regardless of language, all values provided by |script-title= are wrapped in <bdi>...</bdi> tags to isolate RTL languages from the English left to right. |
| | | |
− | |script-title= provides a unique feature. The value in |script-title= may be prefixed with a two-character ISO639-1 language code and a colon: | + | |script-title= provides a unique feature. The value in |script-title= may be prefixed with a two-character ISO 639-1 language code and a colon: |
| |script-title=ja:*** *** (where * represents a Japanese character) | | |script-title=ja:*** *** (where * represents a Japanese character) |
| Spaces between the two-character code and the colon and the colon and the first script character are allowed: | | Spaces between the two-character code and the colon and the colon and the first script character are allowed: |
Sətir 518: |
Sətir 520: |
| Spaces preceding the prefix are allowed: |script-title = ja:*** *** | | Spaces preceding the prefix are allowed: |script-title = ja:*** *** |
| | | |
− | The prefix is checked for validity. If it is a valid ISO639-1 language code, the lang attribute (lang="ja") is added to the <bdi> tag so that browsers can | + | The prefix is checked for validity. If it is a valid ISO 639-1 language code, the lang attribute (lang="ja") is added to the <bdi> tag so that browsers can |
| know the language the tag contains. This may help the browser render the script more correctly. If the prefix is invalid, the lang attribute | | know the language the tag contains. This may help the browser render the script more correctly. If the prefix is invalid, the lang attribute |
| is not added. At this time there is no error message for this condition. | | is not added. At this time there is no error message for this condition. |
Sətir 529: |
Sətir 531: |
| local lang=''; -- initialize to empty string | | local lang=''; -- initialize to empty string |
| local name; | | local name; |
− | if script_value:match('^%l%l%s*:') then -- if first 3 non-space characters are script language prefix | + | if script_value:match('^%l%l%l?%s*:') then -- if first 3 or 4 non-space characters are script language prefix |
− | lang = script_value:match('^(%l%l)%s*:%s*%S.*'); -- get the language prefix or nil if there is no script | + | lang = script_value:match('^(%l%l%l?)%s*:%s*%S.*'); -- get the language prefix or nil if there is no script |
− | if not is_set (lang) then | + | if not utilities.is_set (lang) then |
− | table.insert( z.message_tail, { set_error( 'script_parameter', {script_param, 'missing title part'}, true ) } ); -- prefix without 'title'; add error message | + | table.insert( z.message_tail, { utilities.set_message ( 'err_script_parameter', {script_param, 'missing title part'}, true ) } ); -- prefix without 'title'; add error message |
| return ''; -- script_value was just the prefix so return empty string | | return ''; -- script_value was just the prefix so return empty string |
| end | | end |
| -- if we get this far we have prefix and script | | -- if we get this far we have prefix and script |
− | name = cfg.lang_code_remap[lang] or mw.language.fetchLanguageName( lang, "en" ); -- get language name so that we can use it to categorize | + | name = cfg.lang_code_remap[lang] or mw.language.fetchLanguageName( lang, cfg.this_wiki_code ); -- get language name so that we can use it to categorize |
− | if is_set (name) then -- is prefix a proper ISO 639-1 language code? | + | if utilities.is_set (name) then -- is prefix a proper ISO 639-1 language code? |
− | script_value = script_value:gsub ('^%l%l%s*:%s*', ''); -- strip prefix from script | + | script_value = script_value:gsub ('^%l+%s*:%s*', ''); -- strip prefix from script |
| -- is prefix one of these language codes? | | -- is prefix one of these language codes? |
| + | if utilities.in_array (lang, cfg.script_lang_codes) then |
| + | utilities.add_prop_cat ('script_with_name', {name, lang}) |
| + | else |
| + | table.insert( z.message_tail, { utilities.set_message ( 'err_script_parameter', {script_param, 'unknown language code'}, true ) } ); -- unknown script-language; add error message |
| + | end |
| lang = ' lang="' .. lang .. '" '; -- convert prefix into a lang attribute | | lang = ' lang="' .. lang .. '" '; -- convert prefix into a lang attribute |
| else | | else |
− | table.insert( z.message_tail, { set_error( 'script_parameter', {script_param, 'invalid language code'}, true ) } ); -- invalid language code; add error message | + | table.insert( z.message_tail, { utilities.set_message ( 'err_script_parameter', {script_param, 'invalid language code'}, true ) } ); -- invalid language code; add error message |
| lang = ''; -- invalid so set lang to empty string | | lang = ''; -- invalid so set lang to empty string |
| end | | end |
| else | | else |
− | table.insert( z.message_tail, { set_error( 'script_parameter', {script_param, 'missing prefix'}, true ) } ); -- no language code prefix; add error message | + | table.insert( z.message_tail, { utilities.set_message ( 'err_script_parameter', {script_param, 'missing prefix'}, true ) } ); -- no language code prefix; add error message |
| end | | end |
− | script_value = substitute (cfg.presentation['bdi'], {lang, script_value}); -- isolate in case script is rtl | + | script_value = utilities.substitute (cfg.presentation['bdi'], {lang, script_value}); -- isolate in case script is RTL |
| | | |
| return script_value; | | return script_value; |
Sətir 561: |
Sətir 568: |
| | | |
| local function script_concatenate (title, script, script_param) | | local function script_concatenate (title, script, script_param) |
− | if is_set (script) then | + | if utilities.is_set (script) then |
− | script = format_script_value (script, script_param); -- <bdi> tags, lang atribute, categorization, etc; returns empty string on error | + | script = format_script_value (script, script_param); -- <bdi> tags, lang attribute, categorization, etc.; returns empty string on error |
− | if is_set (script) then | + | if utilities.is_set (script) then |
| title = title .. ' ' .. script; -- concatenate title and script title | | title = title .. ' ' .. script; -- concatenate title and script title |
| end | | end |
Sətir 580: |
Sətir 587: |
| | | |
| local function wrap_msg (key, str, lower) | | local function wrap_msg (key, str, lower) |
− | if not is_set( str ) then | + | if not utilities.is_set ( str ) then |
| return ""; | | return ""; |
| end | | end |
Sətir 586: |
Sətir 593: |
| local msg; | | local msg; |
| msg = cfg.messages[key]:lower(); -- set the message to lower case before | | msg = cfg.messages[key]:lower(); -- set the message to lower case before |
− | return substitute( msg, str ); -- including template text | + | return utilities.substitute ( msg, str ); -- including template text |
| else | | else |
− | return substitute( cfg.messages[key], str ); | + | return utilities.substitute ( cfg.messages[key], str ); |
| end | | end |
| end | | end |
Sətir 595: |
Sətir 602: |
| --[[--------------------------< W I K I S O U R C E _ U R L _ M A K E >---------------------------------------- | | --[[--------------------------< W I K I S O U R C E _ U R L _ M A K E >---------------------------------------- |
| | | |
− | makes a wikisource url from wikisource interwiki link. returns the url and appropriate label; nil else.
| + | Makes a Wikisource URL from Wikisource interwiki-link. Returns the URL and appropriate label; nil else. |
| | | |
| str is the value assigned to |chapter= (or aliases) or |title= or |title-link= | | str is the value assigned to |chapter= (or aliases) or |title= or |title-link= |
Sətir 604: |
Sətir 611: |
| local wl_type, D, L; | | local wl_type, D, L; |
| local ws_url, ws_label; | | local ws_url, ws_label; |
| + | local wikisource_prefix = table.concat ({'https://', cfg.this_wiki_code, '.wikisource.org/wiki/'}); |
| | | |
− | wl_type, D, L = is_wikilink (str); -- wl_type is 0 (not a wikilink), 1 (simple wikilink), 2 (complex wikilink) | + | wl_type, D, L = utilities.is_wikilink (str); -- wl_type is 0 (not a wikilink), 1 (simple wikilink), 2 (complex wikilink) |
| | | |
| if 0 == wl_type then -- not a wikilink; might be from |title-link= | | if 0 == wl_type then -- not a wikilink; might be from |title-link= |
| str = D:match ('^[Ww]ikisource:(.+)') or D:match ('^[Ss]:(.+)'); -- article title from interwiki link with long-form or short-form namespace | | str = D:match ('^[Ww]ikisource:(.+)') or D:match ('^[Ss]:(.+)'); -- article title from interwiki link with long-form or short-form namespace |
− | if is_set (str) then | + | if utilities.is_set (str) then |
− | ws_url = table.concat ({ -- build a wikisource url | + | ws_url = table.concat ({ -- build a Wikisource URL |
− | 'https://en.wikisource.org/wiki/', -- prefix | + | wikisource_prefix, -- prefix |
| str, -- article title | | str, -- article title |
| }); | | }); |
− | ws_label = str; -- label for the url | + | ws_label = str; -- label for the URL |
| end | | end |
− | elseif 1 == wl_type then -- simple wikilink: [[Wikisource:ws article]] | + | elseif 1 == wl_type then -- simple wikilink: [[Wikisource:ws article]] |
| str = D:match ('^[Ww]ikisource:(.+)') or D:match ('^[Ss]:(.+)'); -- article title from interwiki link with long-form or short-form namespace | | str = D:match ('^[Ww]ikisource:(.+)') or D:match ('^[Ss]:(.+)'); -- article title from interwiki link with long-form or short-form namespace |
− | if is_set (str) then | + | if utilities.is_set (str) then |
− | ws_url = table.concat ({ -- build a wikisource url | + | ws_url = table.concat ({ -- build a Wikisource URL |
− | 'https://en.wikisource.org/wiki/', -- prefix | + | wikisource_prefix, -- prefix |
| str, -- article title | | str, -- article title |
| }); | | }); |
− | ws_label = str; -- label for the url | + | ws_label = str; -- label for the URL |
| end | | end |
| elseif 2 == wl_type then -- non-so-simple wikilink: [[Wikisource:ws article|displayed text]] ([[L|D]]) | | elseif 2 == wl_type then -- non-so-simple wikilink: [[Wikisource:ws article|displayed text]] ([[L|D]]) |
| str = L:match ('^[Ww]ikisource:(.+)') or L:match ('^[Ss]:(.+)'); -- article title from interwiki link with long-form or short-form namespace | | str = L:match ('^[Ww]ikisource:(.+)') or L:match ('^[Ss]:(.+)'); -- article title from interwiki link with long-form or short-form namespace |
− | if is_set (str) then | + | if utilities.is_set (str) then |
| ws_label = D; -- get ws article name from display portion of interwiki link | | ws_label = D; -- get ws article name from display portion of interwiki link |
− | ws_url = table.concat ({ -- build a wikisource url | + | ws_url = table.concat ({ -- build a Wikisource URL |
− | 'https://en.wikisource.org/wiki/', -- prefix | + | wikisource_prefix, -- prefix |
| str, -- article title without namespace from link portion of wikilink | | str, -- article title without namespace from link portion of wikilink |
| }); | | }); |
Sətir 637: |
Sətir 645: |
| | | |
| if ws_url then | | if ws_url then |
− | ws_url = mw.uri.encode (ws_url, 'WIKI'); -- make a usable url | + | ws_url = mw.uri.encode (ws_url, 'WIKI'); -- make a usable URL |
− | ws_url = ws_url:gsub ('%%23', '#'); -- undo percent encoding of anchor | + | ws_url = ws_url:gsub ('%%23', '#'); -- undo percent encoding of fragment marker |
| end | | end |
| | | |
− | return ws_url, ws_label, L or D; -- return proper url or nil and a label or nil | + | return ws_url, ws_label, L or D; -- return proper URL or nil and a label or nil |
| end | | end |
| | | |
Sətir 647: |
Sətir 655: |
| --[[--------------------------< F O R M A T _ P E R I O D I C A L >-------------------------------------------- | | --[[--------------------------< F O R M A T _ P E R I O D I C A L >-------------------------------------------- |
| | | |
− | Format the four periodical parameters: |script-<periodical>=, |<periodical>=, and |trans-<periodical>= into a single Periodical meta- | + | Format the three periodical parameters: |script-<periodical>=, |<periodical>=, and |trans-<periodical>= into a single Periodical meta- |
| parameter. | | parameter. |
| | | |
Sətir 655: |
Sətir 663: |
| local periodical_error = ''; | | local periodical_error = ''; |
| | | |
− | if not is_set (periodical) then | + | if not utilities.is_set (periodical) then |
| periodical = ''; -- to be safe for concatenation | | periodical = ''; -- to be safe for concatenation |
| else | | else |
− | periodical = wrap_style ('italic-title', periodical); -- style | + | periodical = utilities.wrap_style ('italic-title', periodical); -- style |
| end | | end |
| | | |
− | periodical = script_concatenate (periodical, script_periodical, script_periodical_source); -- <bdi> tags, lang atribute, categorization, etc; must be done after title is wrapped | + | periodical = script_concatenate (periodical, script_periodical, script_periodical_source); -- <bdi> tags, lang attribute, categorization, etc.; must be done after title is wrapped |
| | | |
− | if is_set (trans_periodical) then | + | if utilities.is_set (trans_periodical) then |
− | trans_periodical = wrap_style ('trans-italic-title', trans_periodical); | + | trans_periodical = utilities.wrap_style ('trans-italic-title', trans_periodical); |
− | if is_set (periodical) then | + | if utilities.is_set (periodical) then |
− | periodical = periodical .. ' ' .. trans_periodical; | + | periodical = periodical .. ' ' .. trans_periodical; |
− | else -- here when transchapter without chapter or script-chapter | + | else -- here when trans-periodical without periodical or script-periodical |
| periodical = trans_periodical; | | periodical = trans_periodical; |
− | periodical_error = ' ' .. set_error ('trans_missing_title', {'periodical'}); | + | periodical_error = ' ' .. utilities.set_message ('err_trans_missing_title', {'periodical'}); |
| end | | end |
| end | | end |
Sətir 679: |
Sətir 687: |
| --[[--------------------------< F O R M A T _ C H A P T E R _ T I T L E >-------------------------------------- | | --[[--------------------------< F O R M A T _ C H A P T E R _ T I T L E >-------------------------------------- |
| | | |
− | Format the four chapter parameters: |script-chapter=, |chapter=, |trans-chapter=, and |chapter-url= into a single Chapter meta- | + | Format the four chapter parameters: |script-chapter=, |chapter=, |trans-chapter=, and |chapter-url= into a single chapter meta- |
| parameter (chapter_url_source used for error messages). | | parameter (chapter_url_source used for error messages). |
| | | |
| ]] | | ]] |
| | | |
− | local function format_chapter_title (scriptchapter, script_chapter_source, chapter, transchapter, chapterurl, chapter_url_source, no_quotes, access) | + | local function format_chapter_title (script_chapter, script_chapter_source, chapter, chapter_source, trans_chapter, trans_chapter_source, chapter_url, chapter_url_source, no_quotes, access) |
| local chapter_error = ''; | | local chapter_error = ''; |
| | | |
− | local ws_url, ws_label, L = wikisource_url_make (chapter); -- make a wikisource url and label from a wikisource interwiki link | + | local ws_url, ws_label, L = wikisource_url_make (chapter); -- make a wikisource URL and label from a wikisource interwiki link |
| if ws_url then | | if ws_url then |
| ws_label = ws_label:gsub ('_', ''); -- replace underscore separaters with space characters | | ws_label = ws_label:gsub ('_', ''); -- replace underscore separaters with space characters |
Sətir 693: |
Sətir 701: |
| end | | end |
| | | |
− | if not is_set (chapter) then | + | if not utilities.is_set (chapter) then |
| chapter = ''; -- to be safe for concatenation | | chapter = ''; -- to be safe for concatenation |
| else | | else |
| if false == no_quotes then | | if false == no_quotes then |
− | chapter = kern_quotes (chapter); -- if necessary, separate chapter title's leading and trailing quote marks from Module provided quote marks | + | chapter = kern_quotes (chapter); -- if necessary, separate chapter title's leading and trailing quote marks from module provided quote marks |
− | chapter = wrap_style ('quoted-title', chapter); | + | chapter = utilities.wrap_style ('quoted-title', chapter); |
| end | | end |
| end | | end |
| | | |
− | chapter = script_concatenate (chapter, scriptchapter, script_chapter_source); -- <bdi> tags, lang atribute, categorization, etc; must be done after title is wrapped | + | chapter = script_concatenate (chapter, script_chapter, script_chapter_source); -- <bdi> tags, lang attribute, categorization, etc.; must be done after title is wrapped |
| | | |
− | if is_set (chapterurl) then | + | if utilities.is_set (chapter_url) then |
− | chapter = external_link (chapterurl, chapter, chapter_url_source, access); -- adds bare_url_missing_title error if appropriate | + | chapter = external_link (chapter_url, chapter, chapter_url_source, access); -- adds bare_url_missing_title error if appropriate |
| elseif ws_url then | | elseif ws_url then |
| chapter = external_link (ws_url, chapter .. ' ', 'ws link in chapter'); -- adds bare_url_missing_title error if appropriate; space char to move icon away from chap text; TODO: better way to do this? | | chapter = external_link (ws_url, chapter .. ' ', 'ws link in chapter'); -- adds bare_url_missing_title error if appropriate; space char to move icon away from chap text; TODO: better way to do this? |
− | chapter = substitute (cfg.presentation['interwiki-icon'], {cfg.presentation['class-wikisource'], L, chapter}); | + | chapter = utilities.substitute (cfg.presentation['interwiki-icon'], {cfg.presentation['class-wikisource'], L, chapter}); |
| end | | end |
| | | |
− | if is_set (transchapter) then | + | if utilities.is_set (trans_chapter) then |
− | transchapter = wrap_style ('trans-quoted-title', transchapter); | + | trans_chapter = utilities.wrap_style ('trans-quoted-title', trans_chapter); |
− | if is_set (chapter) then | + | if utilities.is_set (chapter) then |
− | chapter = chapter .. ' ' .. transchapter; | + | chapter = chapter .. ' ' .. trans_chapter; |
− | else -- here when transchapter without chapter or script-chapter | + | else -- here when trans_chapter without chapter or script-chapter |
− | chapter = transchapter; | + | chapter = trans_chapter; |
− | chapter_error = ' ' .. set_error ('trans_missing_title', {'chapter'}); | + | chapter_source = trans_chapter_source:match ('trans%-?(.+)'); -- when no chapter, get matching name from trans-<param> |
| + | chapter_error = ' ' .. utilities.set_message ('err_trans_missing_title', {chapter_source}); |
| end | | end |
| end | | end |
− |
| |
− | -- if is_set (chapterurl) then
| |
− | -- chapter = external_link (chapterurl, chapter, chapter_url_source, access); -- adds bare_url_missing_title error if appropriate
| |
− | -- end
| |
| | | |
| return chapter .. chapter_error; | | return chapter .. chapter_error; |
Sətir 731: |
Sətir 736: |
| --[[--------------------------< H A S _ I N V I S I B L E _ C H A R S >---------------------------------------- | | --[[--------------------------< H A S _ I N V I S I B L E _ C H A R S >---------------------------------------- |
| | | |
− | This function searches a parameter's value for nonprintable or invisible characters. The search stops at the | + | This function searches a parameter's value for non-printable or invisible characters. The search stops at the |
| first match. | | first match. |
| | | |
− | This function will detect the visible replacement character when it is part of the wikisource. | + | This function will detect the visible replacement character when it is part of the Wikisource. |
| | | |
| Detects but ignores nowiki and math stripmarkers. Also detects other named stripmarkers (gallery, math, pre, ref) | | Detects but ignores nowiki and math stripmarkers. Also detects other named stripmarkers (gallery, math, pre, ref) |
Sətir 749: |
Sətir 754: |
| local dummy; -- end of matching string; not used but required to hold end position when a capture is returned | | local dummy; -- end of matching string; not used but required to hold end position when a capture is returned |
| local capture; -- used by stripmarker detection to hold name of the stripmarker | | local capture; -- used by stripmarker detection to hold name of the stripmarker |
− | local i=1; | + | local i = 1; |
| local stripmarker, apostrophe; | | local stripmarker, apostrophe; |
| | | |
− | capture = string.match (v, '[%w%p ]*'); -- Test for values that are simple ASCII text and bypass other tests if true | + | capture = string.match (v, '[%w%p ]*'); -- test for values that are simple ASCII text and bypass other tests if true |
− | if capture == v then -- if same there are no unicode characters | + | if capture == v then -- if same there are no Unicode characters |
| return; | | return; |
| end | | end |
| | | |
| while cfg.invisible_chars[i] do | | while cfg.invisible_chars[i] do |
− | local char=cfg.invisible_chars[i][1] -- the character or group name | + | local char = cfg.invisible_chars[i][1] -- the character or group name |
− | local pattern=cfg.invisible_chars[i][2] -- the pattern used to find it | + | local pattern = cfg.invisible_chars[i][2] -- the pattern used to find it |
| position, dummy, capture = mw.ustring.find (v, pattern) -- see if the parameter value contains characters that match the pattern | | position, dummy, capture = mw.ustring.find (v, pattern) -- see if the parameter value contains characters that match the pattern |
| | | |
− | if position and (char == 'zero width joiner') then -- if we found a zero width joiner character | + | if position and (char == 'zero width joiner') then -- if we found a zero-width joiner character |
− | if mw.ustring.find (v, cfg.indic_script) then -- its ok if one of the indic scripts | + | if mw.ustring.find (v, cfg.indic_script) then -- it's ok if one of the Indic scripts |
| position = nil; -- unset position | | position = nil; -- unset position |
| end | | end |
Sətir 770: |
Sətir 775: |
| if position then | | if position then |
| if 'nowiki' == capture or 'math' == capture or -- nowiki and math stripmarkers (not an error condition) | | if 'nowiki' == capture or 'math' == capture or -- nowiki and math stripmarkers (not an error condition) |
− | ('templatestyles' == capture and in_array (param, {'id', 'quote'})) then -- templatestyles stripmarker allowed in these parameters | + | ('templatestyles' == capture and utilities.in_array (param, {'id', 'quote'})) then -- templatestyles stripmarker allowed in these parameters |
| stripmarker = true; -- set a flag | | stripmarker = true; -- set a flag |
| elseif true == stripmarker and 'delete' == char then -- because stripmakers begin and end with the delete char, assume that we've found one end of a stripmarker | | elseif true == stripmarker and 'delete' == char then -- because stripmakers begin and end with the delete char, assume that we've found one end of a stripmarker |
Sətir 782: |
Sətir 787: |
| end | | end |
| | | |
− | table.insert( z.message_tail, { set_error( 'invisible_char', {err_msg, wrap_style ('parameter', param), position}, true ) } ); -- add error message | + | table.insert( z.message_tail, { utilities.set_message ( 'err_invisible_char', {err_msg, utilities.wrap_style ('parameter', param), position}, true ) } ); -- add error message |
| return; -- and done with this parameter | | return; -- and done with this parameter |
| end | | end |
| end | | end |
− | i=i+1; -- bump our index | + | i = i+1; -- bump our index |
| end | | end |
| end | | end |
Sətir 798: |
Sətir 803: |
| ]] | | ]] |
| | | |
− | local function argument_wrapper( args ) | + | local function argument_wrapper ( args ) |
| local origin = {}; | | local origin = {}; |
| | | |
| return setmetatable({ | | return setmetatable({ |
− | ORIGIN = function( self, k ) | + | ORIGIN = function ( self, k ) |
| local dummy = self[k]; --force the variable to be loaded. | | local dummy = self[k]; --force the variable to be loaded. |
| return origin[k]; | | return origin[k]; |
Sətir 816: |
Sətir 821: |
| | | |
| if type( list ) == 'table' then | | if type( list ) == 'table' then |
− | v, origin[k] = select_one( args, list, 'redundant_parameters' ); | + | v, origin[k] = utilities.select_one ( args, list, 'err_redundant_parameters' ); |
| if origin[k] == nil then | | if origin[k] == nil then |
| origin[k] = ''; -- Empty string, not nil | | origin[k] = ''; -- Empty string, not nil |
Sətir 830: |
Sətir 835: |
| -- Empty strings, not nil; | | -- Empty strings, not nil; |
| if v == nil then | | if v == nil then |
− | v = cfg.defaults[k] or ''; | + | v = ''; |
| origin[k] = ''; | | origin[k] = ''; |
| end | | end |
Sətir 851: |
Sətir 856: |
| | | |
| local function nowrap_date (date) | | local function nowrap_date (date) |
− | local cap=''; | + | local cap = ''; |
− | local cap2=''; | + | local cap2 = ''; |
| | | |
| if date:match("^%d%d%d%d%-%d%d%-%d%d$") then | | if date:match("^%d%d%d%d%-%d%d%-%d%d$") then |
− | date = substitute (cfg.presentation['nowrap1'], date); | + | date = utilities.substitute (cfg.presentation['nowrap1'], date); |
| | | |
| elseif date:match("^%a+%s*%d%d?,%s+%d%d%d%d$") or date:match ("^%d%d?%s*%a+%s+%d%d%d%d$") then | | elseif date:match("^%a+%s*%d%d?,%s+%d%d%d%d$") or date:match ("^%d%d?%s*%a+%s+%d%d%d%d$") then |
| cap, cap2 = string.match (date, "^(.*)%s+(%d%d%d%d)$"); | | cap, cap2 = string.match (date, "^(.*)%s+(%d%d%d%d)$"); |
− | date = substitute (cfg.presentation['nowrap2'], {cap, cap2}); | + | date = utilities.substitute (cfg.presentation['nowrap2'], {cap, cap2}); |
| end | | end |
| | | |
Sətir 874: |
Sətir 879: |
| | | |
| local function set_titletype (cite_class, title_type) | | local function set_titletype (cite_class, title_type) |
− | if is_set(title_type) then | + | if utilities.is_set (title_type) then |
− | if "none" == title_type then | + | if 'none' == cfg.keywords_xlate[title_type] then |
− | title_type = ""; -- if |type=none then type parameter not displayed | + | title_type = ''; -- if |type=none then type parameter not displayed |
| end | | end |
| return title_type; -- if |type= has been set to any other value use that value | | return title_type; -- if |type= has been set to any other value use that value |
Sətir 902: |
Sətir 907: |
| | | |
| local function hyphen_to_dash( str ) | | local function hyphen_to_dash( str ) |
− | if not is_set (str) then | + | if not utilities.is_set (str) then |
| return str; | | return str; |
| end | | end |
− | | + | |
− | str, count = str:gsub ('^%(%((.+)%)%)$', '%1'); -- remove accept-this-as-written markup when it wraps all of str | + | local accept; -- Boolean |
− | if 0 ~= count then -- non-zero when markup removed; zero else | + | str, accept = utilities.has_accept_as_written (str); -- remove accept-this-as-written markup when it wraps all of str |
− | return str; -- nothing to do, we're done | + | if accept then |
| + | return str; -- when markup removed, nothing to do, we're done |
| end | | end |
− |
| + | |
− | str = str:gsub ('&[nm]dash;', {['–'] = '–', ['—'] = '—'}); -- replace — and – entities with their characters; semicolon mucks up the text.split | + | str = str:gsub ('&[nm]dash;', {['–'] = '–', ['—'] = '—'}); -- replace — and – entities with their characters; semicolon mucks up the text.split |
| + | str = str:gsub ('-', '-'); -- replace HTML numeric entity with hyphen character |
| + | str = str:gsub (' ', ' '); -- replace entity with generic keyboard space character |
| | | |
| local out = {}; | | local out = {}; |
Sətir 918: |
Sətir 926: |
| for _, item in ipairs (list) do -- for each item in the list | | for _, item in ipairs (list) do -- for each item in the list |
| if mw.ustring.match (item, '^%w*[%.%-]?%w+%s*[%-–—]%s*%w*[%.%-]?%w+$') then -- if a hyphenated range or has endash or emdash separators | | if mw.ustring.match (item, '^%w*[%.%-]?%w+%s*[%-–—]%s*%w*[%.%-]?%w+$') then -- if a hyphenated range or has endash or emdash separators |
− | if item:match ('%a+[%.%-]?%d+%s*%-%s*%a+[%.%-]?%d+') or -- letterdigit hyphen letterdigit (optional separator between letter and digit) | + | if item:match ('^%a+[%.%-]?%d+%s*%-%s*%a+[%.%-]?%d+$') or -- letterdigit hyphen letterdigit (optional separator between letter and digit) |
− | item:match ('%d+[%.%-]?%a+%s*%-%s*%d+[%.%-]?%a+') or -- digitletter hyphen digitletter (optional separator between digit and letter) | + | item:match ('^%d+[%.%-]?%a+%s*%-%s*%d+[%.%-]?%a+$') or -- digitletter hyphen digitletter (optional separator between digit and letter) |
− | item:match ('%d+[%.%-]%d+%s*%-%s*%d+[%.%-]%d+') or -- digit separator digit hyphen digit separator digit | + | item:match ('^%d+[%.%-]%d+%s*%-%s*%d+[%.%-]%d+$') or -- digit separator digit hyphen digit separator digit |
− | item:match ('%d+%s*%-%s*%d+') or -- digit hyphen digit | + | item:match ('^%d+%s*%-%s*%d+$') or -- digit hyphen digit |
− | item:match ('%a+%s*%-%s*%a+') then -- letter hyphen letter | + | item:match ('^%a+%s*%-%s*%a+$') then -- letter hyphen letter |
| item = item:gsub ('(%w*[%.%-]?%w+)%s*%-%s*(%w*[%.%-]?%w+)', '%1–%2'); -- replace hyphen, remove extraneous space characters | | item = item:gsub ('(%w*[%.%-]?%w+)%s*%-%s*(%w*[%.%-]?%w+)', '%1–%2'); -- replace hyphen, remove extraneous space characters |
| else | | else |
− | item = mw.ustring.gsub (item, '%s*[–—]%s*', '–'); -- for endash or emdash separated ranges, replace em with en, remove extraneous white space | + | item = mw.ustring.gsub (item, '%s*[–—]%s*', '–'); -- for endash or emdash separated ranges, replace em with en, remove extraneous whitespace |
| end | | end |
| end | | end |
− | item = item:gsub ('^%(%((.+)%)%)$', '%1'); -- remove the accept-this-as-written markup | + | item = utilities.has_accept_as_written (item); -- remove accept-this-as-written markup when it wraps all of str |
| table.insert (out, item); -- add the (possibly modified) item to the output table | | table.insert (out, item); -- add the (possibly modified) item to the output table |
| end | | end |
Sətir 943: |
Sətir 951: |
| | | |
| local function safe_join( tbl, duplicate_char ) | | local function safe_join( tbl, duplicate_char ) |
− | local f = {}; -- create a function table appropriate to type of 'dupicate character' | + | local f = {}; -- create a function table appropriate to type of 'duplicate character' |
− | if 1 == #duplicate_char then -- for single byte ascii characters use the string library functions | + | if 1 == #duplicate_char then -- for single byte ASCII characters use the string library functions |
− | f.gsub=string.gsub | + | f.gsub = string.gsub |
− | f.match=string.match | + | f.match = string.match |
− | f.sub=string.sub | + | f.sub = string.sub |
| else -- for multi-byte characters use the ustring library functions | | else -- for multi-byte characters use the ustring library functions |
− | f.gsub=mw.ustring.gsub | + | f.gsub = mw.ustring.gsub |
− | f.match=mw.ustring.match | + | f.match = mw.ustring.match |
− | f.sub=mw.ustring.sub | + | f.sub = mw.ustring.sub |
| end | | end |
| | | |
Sətir 964: |
Sətir 972: |
| str = value; -- assign value to it (first time through the loop) | | str = value; -- assign value to it (first time through the loop) |
| elseif value ~= '' then | | elseif value ~= '' then |
− | if value:sub(1,1) == '<' then -- Special case of values enclosed in spans and other markup. | + | if value:sub(1, 1) == '<' then -- special case of values enclosed in spans and other markup. |
− | comp = value:gsub( "%b<>", "" ); -- remove html markup (<span>string</span> -> string) | + | comp = value:gsub( "%b<>", "" ); -- remove HTML markup (<span>string</span> -> string) |
| else | | else |
| comp = value; | | comp = value; |
| end | | end |
| -- typically duplicate_char is sepc | | -- typically duplicate_char is sepc |
− | if f.sub(comp, 1,1) == duplicate_char then -- is first character same as duplicate_char? why test first character? | + | if f.sub(comp, 1, 1) == duplicate_char then -- is first character same as duplicate_char? why test first character? |
| -- Because individual string segments often (always?) begin with terminal punct for the | | -- Because individual string segments often (always?) begin with terminal punct for the |
− | -- preceding segment: 'First element' .. 'sepc next element' .. etc? | + | -- preceding segment: 'First element' .. 'sepc next element' .. etc.? |
| trim = false; | | trim = false; |
− | end_chr = f.sub(str, -1,-1); -- get the last character of the output string | + | end_chr = f.sub(str, -1, -1); -- get the last character of the output string |
− | -- str = str .. "<HERE(enchr=" .. end_chr.. ")" -- debug stuff? | + | -- str = str .. "<HERE(enchr=" .. end_chr .. ")" -- debug stuff? |
| if end_chr == duplicate_char then -- if same as separator | | if end_chr == duplicate_char then -- if same as separator |
− | str = f.sub(str, 1,-2); -- remove it | + | str = f.sub(str, 1, -2); -- remove it |
− | elseif end_chr == "'" then -- if it might be wikimarkup | + | elseif end_chr == "'" then -- if it might be wiki-markup |
− | if f.sub(str, -3,-1) == duplicate_char .. "''" then -- if last three chars of str are sepc'' | + | if f.sub(str, -3, -1) == duplicate_char .. "''" then -- if last three chars of str are sepc'' |
| str = f.sub(str, 1, -4) .. "''"; -- remove them and add back '' | | str = f.sub(str, 1, -4) .. "''"; -- remove them and add back '' |
− | elseif f.sub(str, -5,-1) == duplicate_char .. "]]''" then -- if last five chars of str are sepc]]'' | + | elseif f.sub(str, -5, -1) == duplicate_char .. "]]''" then -- if last five chars of str are sepc]]'' |
| trim = true; -- why? why do this and next differently from previous? | | trim = true; -- why? why do this and next differently from previous? |
− | elseif f.sub(str, -4,-1) == duplicate_char .. "]''" then -- if last four chars of str are sepc]'' | + | elseif f.sub(str, -4, -1) == duplicate_char .. "]''" then -- if last four chars of str are sepc]'' |
| trim = true; -- same question | | trim = true; -- same question |
| end | | end |
− | elseif end_chr == "]" then -- if it might be wikimarkup | + | elseif end_chr == "]" then -- if it might be wiki-markup |
− | if f.sub(str, -3,-1) == duplicate_char .. "]]" then -- if last three chars of str are sepc]] wikilink | + | if f.sub(str, -3, -1) == duplicate_char .. "]]" then -- if last three chars of str are sepc]] wikilink |
| trim = true; | | trim = true; |
− | elseif f.sub(str, -3,-1) == duplicate_char .. '"]' then -- if last three chars of str are sepc"] quoted external link | + | elseif f.sub(str, -3, -1) == duplicate_char .. '"]' then -- if last three chars of str are sepc"] quoted external link |
| trim = true; | | trim = true; |
− | elseif f.sub(str, -2,-1) == duplicate_char .. "]" then -- if last two chars of str are sepc] external link | + | elseif f.sub(str, -2, -1) == duplicate_char .. "]" then -- if last two chars of str are sepc] external link |
| trim = true; | | trim = true; |
− | elseif f.sub(str, -4,-1) == duplicate_char .. "'']" then -- normal case when |url=something & |title=Title. | + | elseif f.sub(str, -4, -1) == duplicate_char .. "'']" then -- normal case when |url=something & |title=Title. |
| trim = true; | | trim = true; |
| end | | end |
| elseif end_chr == " " then -- if last char of output string is a space | | elseif end_chr == " " then -- if last char of output string is a space |
− | if f.sub(str, -2,-1) == duplicate_char .. " " then -- if last two chars of str are <sepc><space> | + | if f.sub(str, -2, -1) == duplicate_char .. " " then -- if last two chars of str are <sepc><space> |
− | str = f.sub(str, 1,-3); -- remove them both | + | str = f.sub(str, 1, -3); -- remove them both |
| end | | end |
| end | | end |
| | | |
| if trim then | | if trim then |
− | if value ~= comp then -- value does not equal comp when value contains html markup | + | if value ~= comp then -- value does not equal comp when value contains HTML markup |
| local dup2 = duplicate_char; | | local dup2 = duplicate_char; |
| if f.match(dup2, "%A" ) then dup2 = "%" .. dup2; end -- if duplicate_char not a letter then escape it | | if f.match(dup2, "%A" ) then dup2 = "%" .. dup2; end -- if duplicate_char not a letter then escape it |
| | | |
− | value = f.gsub(value, "(%b<>)" .. dup2, "%1", 1 ) -- remove duplicate_char if it follows html markup | + | value = f.gsub(value, "(%b<>)" .. dup2, "%1", 1 ) -- remove duplicate_char if it follows HTML markup |
| else | | else |
| value = f.sub(value, 2, -1 ); -- remove duplicate_char when it is first character | | value = f.sub(value, 2, -1 ); -- remove duplicate_char when it is first character |
Sətir 1.022: |
Sətir 1.030: |
| --[[--------------------------< I S _ S U F F I X >------------------------------------------------------------ | | --[[--------------------------< I S _ S U F F I X >------------------------------------------------------------ |
| | | |
− | returns true is suffix is properly formed Jr, Sr, or ordinal in the range 2–9. Puncutation not allowed. | + | returns true is suffix is properly formed Jr, Sr, or ordinal in the range 1–9. Puncutation not allowed. |
| | | |
| ]] | | ]] |
| | | |
| local function is_suffix (suffix) | | local function is_suffix (suffix) |
− | if in_array (suffix, {'Jr', 'Sr', '2nd', '3rd'}) or suffix:match ('^%dth$') then | + | if utilities.in_array (suffix, {'Jr', 'Sr', 'Jnr', 'Snr', '1st', '2nd', '3rd'}) or suffix:match ('^%dth$') then |
| return true; | | return true; |
| end | | end |
Sətir 1.036: |
Sətir 1.044: |
| --[[--------------------------< I S _ G O O D _ V A N C _ N A M E >-------------------------------------------- | | --[[--------------------------< I S _ G O O D _ V A N C _ N A M E >-------------------------------------------- |
| | | |
− | For Vancouver Style, author/editor names are supposed to be rendered in Latin (read ASCII) characters. When a name | + | For Vancouver style, author/editor names are supposed to be rendered in Latin (read ASCII) characters. When a name |
| uses characters that contain diacritical marks, those characters are to converted to the corresponding Latin character. | | uses characters that contain diacritical marks, those characters are to converted to the corresponding Latin character. |
| When a name is written using a non-Latin alphabet or logogram, that name is to be transliterated into Latin characters. | | When a name is written using a non-Latin alphabet or logogram, that name is to be transliterated into Latin characters. |
Sətir 1.052: |
Sətir 1.060: |
| This original test: | | This original test: |
| if nil == mw.ustring.find (last, "^[A-Za-zÀ-ÖØ-öø-ƿDŽ-ɏ%-%s%']*$") or nil == mw.ustring.find (first, "^[A-Za-zÀ-ÖØ-öø-ƿDŽ-ɏ%-%s%'%.]+[2-6%a]*$") then | | if nil == mw.ustring.find (last, "^[A-Za-zÀ-ÖØ-öø-ƿDŽ-ɏ%-%s%']*$") or nil == mw.ustring.find (first, "^[A-Za-zÀ-ÖØ-öø-ƿDŽ-ɏ%-%s%'%.]+[2-6%a]*$") then |
− | was written ouside of the code editor and pasted here because the code editor gets confused between character insertion point and cursor position. | + | was written outside of the code editor and pasted here because the code editor gets confused between character insertion point and cursor position. |
− | The test has been rewritten to use decimal character escape sequence for the individual bytes of the unicode characters so that it is not necessary | + | The test has been rewritten to use decimal character escape sequence for the individual bytes of the Unicode characters so that it is not necessary |
| to use an external editor to maintain this code. | | to use an external editor to maintain this code. |
| | | |
Sətir 1.063: |
Sətir 1.071: |
| ]] | | ]] |
| | | |
− | local function is_good_vanc_name (last, first) | + | local function is_good_vanc_name (last, first, suffix) |
− | local first, suffix = first:match ('(.-),?%s*([%dJS][%drndth]+)%.?$') or first; -- if first has something that looks like a generational suffix, get it | + | if not suffix then |
− | | + | if first:find ('[,%s]') then -- when there is a space or comma, might be first name/initials + generational suffix |
− | if is_set (suffix) then | + | first = first:match ('(.-)[,%s]+'); -- get name/initials |
| + | suffix = first:match ('[,%s]+(.+)$'); -- get generational suffix |
| + | end |
| + | end |
| + | if utilities.is_set (suffix) then |
| if not is_suffix (suffix) then | | if not is_suffix (suffix) then |
− | add_vanc_error ('suffix'); | + | add_vanc_error (cfg.err_msg_supl.suffix); |
| return false; -- not a name with an appropriate suffix | | return false; -- not a name with an appropriate suffix |
| end | | end |
Sətir 1.074: |
Sətir 1.086: |
| if nil == mw.ustring.find (last, "^[A-Za-z\195\128-\195\150\195\152-\195\182\195\184-\198\191\199\132-\201\143%-%s%']*$") or | | if nil == mw.ustring.find (last, "^[A-Za-z\195\128-\195\150\195\152-\195\182\195\184-\198\191\199\132-\201\143%-%s%']*$") or |
| nil == mw.ustring.find (first, "^[A-Za-z\195\128-\195\150\195\152-\195\182\195\184-\198\191\199\132-\201\143%-%s%'%.]*$") then | | nil == mw.ustring.find (first, "^[A-Za-z\195\128-\195\150\195\152-\195\182\195\184-\198\191\199\132-\201\143%-%s%'%.]*$") then |
− | add_vanc_error ('non-Latin character'); | + | add_vanc_error (cfg.err_msg_supl['non-Latin char']); |
− | return false; -- not a string of latin characters; Vancouver requires Romanization | + | return false; -- not a string of Latin characters; Vancouver requires Romanization |
| end; | | end; |
| return true; | | return true; |
Sətir 1.083: |
Sətir 1.095: |
| --[[--------------------------< R E D U C E _ T O _ I N I T I A L S >------------------------------------------ | | --[[--------------------------< R E D U C E _ T O _ I N I T I A L S >------------------------------------------ |
| | | |
− | Attempts to convert names to initials in support of |name-list-format=vanc. | + | Attempts to convert names to initials in support of |name-list-style=vanc. |
| | | |
| Names in |firstn= may be separated by spaces or hyphens, or for initials, a period. See http://www.ncbi.nlm.nih.gov/books/NBK7271/box/A35062/. | | Names in |firstn= may be separated by spaces or hyphens, or for initials, a period. See http://www.ncbi.nlm.nih.gov/books/NBK7271/box/A35062/. |
| | | |
− | Vancouver style requires family rank designations (Jr, II, III, etc) to be rendered as Jr, 2nd, 3rd, etc. See http://www.ncbi.nlm.nih.gov/books/NBK7271/box/A35085/. | + | Vancouver style requires family rank designations (Jr, II, III, etc.) to be rendered as Jr, 2nd, 3rd, etc. See http://www.ncbi.nlm.nih.gov/books/NBK7271/box/A35085/. |
| This code only accepts and understands generational suffix in the Vancouver format because Roman numerals look like, and can be mistaken for, initials. | | This code only accepts and understands generational suffix in the Vancouver format because Roman numerals look like, and can be mistaken for, initials. |
| | | |
− | This function uses ustring functions because firstname initials may be any of the unicode Latin characters accepted by is_good_vanc_name (). | + | This function uses ustring functions because firstname initials may be any of the Unicode Latin characters accepted by is_good_vanc_name (). |
| | | |
| ]] | | ]] |
Sətir 1.098: |
Sətir 1.110: |
| | | |
| if not name then -- if not initials and a suffix | | if not name then -- if not initials and a suffix |
− | name = mw.ustring.match(first, "^(%u+)$"); -- is it just intials? | + | name = mw.ustring.match(first, "^(%u+)$"); -- is it just initials? |
| end | | end |
| | | |
Sətir 1.107: |
Sətir 1.119: |
| return first; -- one or two initials and a valid suffix so nothing to do | | return first; -- one or two initials and a valid suffix so nothing to do |
| else | | else |
− | add_vanc_error ('suffix'); -- one or two initials with invalid suffix so error message | + | add_vanc_error (cfg.err_msg_supl.suffix); -- one or two initials with invalid suffix so error message |
| return first; -- and return first unmolested | | return first; -- and return first unmolested |
| end | | end |
Sətir 1.115: |
Sətir 1.127: |
| end | | end |
| end -- if here then name has 3 or more uppercase letters so treat them as a word | | end -- if here then name has 3 or more uppercase letters so treat them as a word |
− |
| |
| | | |
| local initials, names = {}, {}; -- tables to hold name parts and initials | | local initials, names = {}, {}; -- tables to hold name parts and initials |
Sətir 1.131: |
Sətir 1.142: |
| end | | end |
| if 3 > i then | | if 3 > i then |
− | table.insert (initials, mw.ustring.sub(names[i],1,1)); -- insert the intial at end of initials table | + | table.insert (initials, mw.ustring.sub(names[i], 1, 1)); -- insert the initial at end of initials table |
| end | | end |
| i = i+1; -- bump the counter | | i = i+1; -- bump the counter |
Sətir 1.140: |
Sətir 1.151: |
| | | |
| | | |
− | --[[--------------------------< L I S T _ P E O P L E >------------------------------------------------------- | + | --[[--------------------------< L I S T _ P E O P L E >------------------------------------------------------- |
| | | |
− | Formats a list of people (e.g. authors / editors) | + | Formats a list of people (e.g. authors, contributors, editors, interviewers, translators) |
| + | |
| + | names in the list will be linked when |
| + | |<name>-link= has a value |
| + | |<name>-mask- does NOT have a value; masked names are presumed to have been rendered previously so should have been linked there |
| + | |
| + | when |<name>-mask=0, the associated name is not rendered |
| | | |
| ]] | | ]] |
| | | |
− | local function list_people(control, people, etal) | + | local function list_people (control, people, etal) |
| local sep; | | local sep; |
| local namesep; | | local namesep; |
− | local format = control.format | + | local format = control.format; |
− | local maximum = control.maximum | + | local maximum = control.maximum; |
− | local lastauthoramp = control.lastauthoramp; | + | local lastauthoramp = control.lastauthoramp; -- TODO: delete after deprecation |
− | local text = {} | + | local name_list = {}; |
| | | |
− | if 'vanc' == format then -- Vancouver-like author/editor name styling? | + | if 'vanc' == format then -- Vancouver-like name styling? |
− | sep = cfg.presentation['sep_nl_vanc']; -- name-list separator between authors is a comma | + | sep = cfg.presentation['sep_nl_vanc']; -- name-list separator between names is a comma |
| namesep = cfg.presentation['sep_name_vanc']; -- last/first separator is a space | | namesep = cfg.presentation['sep_name_vanc']; -- last/first separator is a space |
| + | lastauthoramp = nil; -- TODO: delete after deprecation -- unset because isn't used by Vancouver style |
| else | | else |
− | sep = cfg.presentation['sep_nl']; -- name-list separator between authors is a semicolon | + | sep = cfg.presentation['sep_nl']; -- name-list separator between names is a semicolon |
| namesep = cfg.presentation['sep_name']; -- last/first separator is <comma><space> | | namesep = cfg.presentation['sep_name']; -- last/first separator is <comma><space> |
| end | | end |
| | | |
− | if sep:sub(-1,-1) ~= " " then sep = sep .. " " end | + | if sep:sub (-1, -1) ~= " " then sep = sep .. " " end |
− | if is_set (maximum) and maximum < 1 then return "", 0; end -- returned 0 is for EditorCount; not used for authors | + | if utilities.is_set (maximum) and maximum < 1 then return "", 0; end -- returned 0 is for EditorCount; not used for other names |
| | | |
− | for i,person in ipairs(people) do | + | for i, person in ipairs (people) do |
− | if is_set(person.last) then | + | if utilities.is_set (person.last) then |
− | local mask = person.mask | + | local mask = person.mask; |
− | local one | + | local one; |
| local sep_one = sep; | | local sep_one = sep; |
− | if is_set (maximum) and i > maximum then | + | |
| + | if utilities.is_set (maximum) and i > maximum then |
| etal = true; | | etal = true; |
| break; | | break; |
− | elseif (mask ~= nil) then | + | end |
− | local n = tonumber(mask) | + | |
− | if (n ~= nil) then | + | if mask then |
− | one = string.rep("—",n) | + | local n = tonumber (mask); -- convert to a number if it can be converted; nil else |
| + | if n then |
| + | one = 0 ~= n and string.rep("—",n) or nil; -- make a string of (n > 0) mdashes, nil else, to replace name |
| + | person.link = nil; -- don't create link to name if name is replaces with mdash string or has been set nil |
| else | | else |
− | one = mask; | + | one = mask; -- replace name with mask text (must include name-list separator) |
− | sep_one = " "; | + | sep_one = " "; -- modify name-list separator |
| end | | end |
| else | | else |
− | one = person.last | + | one = person.last; -- get surname |
− | local first = person.first | + | local first = person.first -- get given name |
− | if is_set(first) then | + | if utilities.is_set (first) then |
− | if ( "vanc" == format ) then -- if vancouver format | + | if ("vanc" == format) then -- if Vancouver format |
| one = one:gsub ('%.', ''); -- remove periods from surnames (http://www.ncbi.nlm.nih.gov/books/NBK7271/box/A35029/) | | one = one:gsub ('%.', ''); -- remove periods from surnames (http://www.ncbi.nlm.nih.gov/books/NBK7271/box/A35029/) |
| if not person.corporate and is_good_vanc_name (one, first) then -- and name is all Latin characters; corporate authors not tested | | if not person.corporate and is_good_vanc_name (one, first) then -- and name is all Latin characters; corporate authors not tested |
− | first = reduce_to_initials(first) -- attempt to convert first name(s) to initials | + | first = reduce_to_initials (first); -- attempt to convert first name(s) to initials |
| end | | end |
| end | | end |
| one = one .. namesep .. first; | | one = one .. namesep .. first; |
| end | | end |
− | if is_set(person.link) and person.link ~= control.page_name then
| |
− | one = make_wikilink (person.link, one); -- link author/editor if this page is not the author's/editor's page
| |
− | end
| |
| end | | end |
− | table.insert( text, one ) | + | if utilities.is_set (person.link) then |
− | table.insert( text, sep_one )
| + | one = utilities.make_wikilink (person.link, one); -- link author/editor |
| + | end |
| + | if one then -- if <one> has a value (name, mdash replacement, or mask text replacement) |
| + | table.insert (name_list, one); -- add it to the list of names |
| + | table.insert (name_list, sep_one); -- add the proper name-list separator |
| + | end |
| end | | end |
| end | | end |
| | | |
− | local count = #text / 2; -- (number of names + number of separators) divided by 2 | + | local count = #name_list / 2; -- (number of names + number of separators) divided by 2 |
− | if count > 0 then | + | if 0 < count then |
− | if count > 1 and is_set(lastauthoramp) and not etal then | + | if 1 < count and not etal then |
− | text[#text-2] = ", "; -- replace last separator with ampersand text
| + | if 'amp' == format or utilities.is_set (lastauthoramp) then -- TODO: delete lastauthoramp after deprecation |
| + | name_list[#name_list-2] = " & "; -- replace last separator with ampersand text |
| + | elseif 'and' == format then |
| + | if 2 == count then |
| + | name_list[#name_list-2] = cfg.presentation.sep_nl_and; -- replace last separator with 'and' text |
| + | else |
| + | name_list[#name_list-2] = cfg.presentation.sep_nl_end; -- replace last separator with '(sep) and' text |
| + | end |
| + | end |
| end | | end |
− | text[#text] = nil; -- erase the last separator | + | name_list[#name_list] = nil; -- erase the last separator |
| end | | end |
− |
| + | |
− | local result = table.concat(text) -- construct list | + | local result = table.concat (name_list); -- construct list |
− | if etal and is_set (result) then -- etal may be set by |display-authors=etal but we might not have a last-first list | + | if etal and utilities.is_set (result) then -- etal may be set by |display-authors=etal but we might not have a last-first list |
− | result = result .. sep .. ' ' .. cfg.messages['et al']; -- we've go a last-first list and etal so add et al. | + | result = result .. sep .. ' ' .. cfg.messages['et al']; -- we've got a last-first list and etal so add et al. |
| end | | end |
| | | |
− | return result, count | + | return result, count; -- return name-list string and count of number of names (count used for editor names only) |
| end | | end |
| | | |
Sətir 1.226: |
Sətir 1.258: |
| | | |
| ]] | | ]] |
| + | |
| local function anchor_id (namelist, year) | | local function anchor_id (namelist, year) |
| local names={}; -- a table for the one to four names and year | | local names={}; -- a table for the one to four names and year |
Sətir 1.234: |
Sətir 1.267: |
| table.insert (names, year); -- add the year at the end | | table.insert (names, year); -- add the year at the end |
| local id = table.concat(names); -- concatenate names and year for CITEREF id | | local id = table.concat(names); -- concatenate names and year for CITEREF id |
− | if is_set (id) then -- if concatenation is not an empty string | + | if utilities.is_set (id) then -- if concatenation is not an empty string |
| return "CITEREF" .. id; -- add the CITEREF portion | | return "CITEREF" .. id; -- add the CITEREF portion |
| else | | else |
Sətir 1.244: |
Sətir 1.277: |
| --[[--------------------------< N A M E _ H A S _ E T A L >---------------------------------------------------- | | --[[--------------------------< N A M E _ H A S _ E T A L >---------------------------------------------------- |
| | | |
− | Evaluates the content of name parameters (author, editor, etc) for variations on the theme of et al. If found, | + | Evaluates the content of name parameters (author, editor, etc.) for variations on the theme of et al. If found, |
| the et al. is removed, a flag is set to true and the function returns the modified name and the flag. | | the et al. is removed, a flag is set to true and the function returns the modified name and the flag. |
| | | |
Sətir 1.254: |
Sətir 1.287: |
| local function name_has_etal (name, etal, nocat, param) | | local function name_has_etal (name, etal, nocat, param) |
| | | |
− | if is_set (name) then -- name can be nil in which case just return | + | if utilities.is_set (name) then -- name can be nil in which case just return |
| local patterns = cfg.et_al_patterns; --get patterns from configuration | | local patterns = cfg.et_al_patterns; --get patterns from configuration |
| | | |
Sətir 1.262: |
Sətir 1.295: |
| etal = true; -- set flag (may have been set previously here or by |display-<names>=etal) | | etal = true; -- set flag (may have been set previously here or by |display-<names>=etal) |
| if not nocat then -- no categorization for |vauthors= | | if not nocat then -- no categorization for |vauthors= |
− | table.insert( z.message_tail, {set_error ('etal', {param})}); -- and set an error if not added | + | table.insert( z.message_tail, {utilities.set_message ('err_etal', {param})}); -- and set an error if not added |
| end | | end |
| end | | end |
Sətir 1.268: |
Sətir 1.301: |
| end | | end |
| | | |
− | return name, etal; -- | + | return name, etal; |
| + | end |
| + | |
| + | |
| + | --[[--------------------------< N A M E _ I S _ N U M E R I C >------------------------------------------------ |
| + | |
| + | Add maint cat when name parameter value does not contain letters. Does not catch mixed alphanumeric names so |
| + | |last=A. Green (1922-1987) does not get caught in the current version of this test but |first=(1888) is caught. |
| + | |
| + | returns nothing |
| + | |
| + | ]] |
| + | |
| + | local function name_is_numeric (name, list_name) |
| + | if utilities.is_set (name) then |
| + | if mw.ustring.match (name, '^[%A]+$') then -- when name does not contain any letters |
| + | utilities.set_message ('maint_numeric_names', cfg.special_case_translation [list_name]); -- add a maint cat for this template |
| + | end |
| + | end |
| end | | end |
| | | |
Sətir 1.274: |
Sətir 1.325: |
| --[[--------------------------< N A M E _ H A S _ E D _ M A R K U P >------------------------------------------ | | --[[--------------------------< N A M E _ H A S _ E D _ M A R K U P >------------------------------------------ |
| | | |
− | Evaluates the content of author and editor parameters for extranious editor annotations: ed, ed., eds, (Ed.), etc. | + | Evaluates the content of author and editor parameters for extraneous editor annotations: ed, ed., eds, (Ed.), etc. |
| These annotation do not belong in author parameters and are redundant in editor parameters. If found, the function | | These annotation do not belong in author parameters and are redundant in editor parameters. If found, the function |
| adds the editor markup maintenance category. | | adds the editor markup maintenance category. |
| + | |
| + | returns nothing |
| | | |
| ]] | | ]] |
| | | |
| local function name_has_ed_markup (name, list_name) | | local function name_has_ed_markup (name, list_name) |
− | local _, pattern;
| |
| local patterns = cfg.editor_markup_patterns; -- get patterns from configuration | | local patterns = cfg.editor_markup_patterns; -- get patterns from configuration |
| | | |
− | if is_set (name) then | + | if utilities.is_set (name) then |
| for _, pattern in ipairs (patterns) do -- spin through patterns table and | | for _, pattern in ipairs (patterns) do -- spin through patterns table and |
| if name:match (pattern) then | | if name:match (pattern) then |
− | add_maint_cat ('extra_text_names', cfg.special_case_translation [list_name]); -- add a maint cat for this template | + | utilities.set_message ('maint_extra_text_names', cfg.special_case_translation [list_name]); -- add a maint cat for this template |
| break; | | break; |
| end | | end |
| end | | end |
| end | | end |
− | return name; -- and done
| |
| end | | end |
| | | |
Sətir 1.298: |
Sətir 1.349: |
| --[[--------------------------< N A M E _ H A S _ M U L T _ N A M E S >---------------------------------------- | | --[[--------------------------< N A M E _ H A S _ M U L T _ N A M E S >---------------------------------------- |
| | | |
− | Evaluates the content of author and editor (surnames only) parameters for multiple names. Multiple names are | + | Evaluates the content of last/surname (authors etc.) parameters for multiple names. Multiple names are indicated |
− | indicated if there is more than one comma and or semicolon. If found, the function adds the multiple name
| + | if there is more than one comma or any semicolons. If found, the function adds the multiple name maintenance category. |
− | (author or editor) maintenance category.
| + | |
| + | returns nothing |
| | | |
| ]] | | ]] |
| | | |
| local function name_has_mult_names (name, list_name) | | local function name_has_mult_names (name, list_name) |
− | local count, _; | + | local _, commas, semicolons; |
− | if is_set (name) then | + | if utilities.is_set (name) then |
− | _, count = name:gsub ('[;,]', ''); -- count the number of separator-like characters | + | _, commas = name:gsub (',', ''); -- count the number of commas |
| + | _, semicolons = name:gsub (';', ''); -- count the number of semicolons |
| + | |
| + | if 1 < commas or 0 < semicolons then |
| + | utilities.set_message ('maint_mult_names', cfg.special_case_translation [list_name]); -- add a maint message |
| + | end |
| end | | end |
− | return name; -- and done
| |
| end | | end |
| | | |
| | | |
| --[[--------------------------< N A M E _ C H E C K S >-------------------------------------------------------- | | --[[--------------------------< N A M E _ C H E C K S >-------------------------------------------------------- |
| + | |
| This function calls various name checking functions used to validate the content of the various name-holding | | This function calls various name checking functions used to validate the content of the various name-holding |
| parameters. | | parameters. |
Sətir 1.320: |
Sətir 1.377: |
| | | |
| local function name_checks (last, first, list_name) | | local function name_checks (last, first, list_name) |
− | if is_set (last) then | + | local accept_name; |
− | if last:match ('^%(%(.*%)%)$') then -- if wrapped in doubled parentheses, accept as written | + | |
− | last = last:match ('^%(%((.*)%)%)$'); -- strip parens
| + | if utilities.is_set (last) then |
− | else
| + | last, accept_name = utilities.has_accept_as_written (last); -- remove accept-this-as-written markup when it wraps all of <last> |
− | last = name_has_mult_names (last, list_name); -- check for multiple names in the parameter (last only) | + | |
− | last = name_has_ed_markup (last, list_name); -- check for extraneous 'editor' annotation | + | if not accept_name then -- <last> not wrapped in accept-as-written markup |
| + | name_has_mult_names (last, list_name); -- check for multiple names in the parameter (last only) |
| + | name_has_ed_markup (last, list_name); -- check for extraneous 'editor' annotation |
| + | name_is_numeric (last, list_name); -- check for names that are compsed of digits and punctuation |
| end | | end |
| end | | end |
− | if is_set (first) then | + | |
− | if first:match ('^%(%(.*%)%)$') then -- if wrapped in doubled parentheses, accept as written | + | if utilities.is_set (first) then |
− | first = first:match ('^%(%((.*)%)%)$'); -- strip parens | + | first, accept_name = utilities.has_accept_as_written (first); -- remove accept-this-as-written markup when it wraps all of <first> |
− | else
| + | |
− | first = name_has_ed_markup (first, list_name); -- check for extraneous 'editor' annotation | + | if not accept_name then -- <first> not wrapped in accept-as-written markup |
| + | name_has_ed_markup (first, list_name); -- check for extraneous 'editor' annotation |
| + | name_is_numeric (first, list_name); -- check for names that are compsed of digits and punctuation |
| end | | end |
| end | | end |
| + | |
| return last, first; -- done | | return last, first; -- done |
− | end
| + | end |
| | | |
| | | |
Sətir 1.356: |
Sətir 1.419: |
| | | |
| local function extract_names(args, list_name) | | local function extract_names(args, list_name) |
− | local names = {}; -- table of names | + | local names = {}; -- table of names |
− | local last; -- individual name components | + | local last; -- individual name components |
| local first; | | local first; |
| local link; | | local link; |
| local mask; | | local mask; |
− | local i = 1; -- loop counter/indexer | + | local i = 1; -- loop counter/indexer |
− | local n = 1; -- output table indexer | + | local n = 1; -- output table indexer |
− | local count = 0; -- used to count the number of times we haven't found a |last= (or alias for authors, |editor-last or alias for editors) | + | local count = 0; -- used to count the number of times we haven't found a |last= (or alias for authors, |editor-last or alias for editors) |
− | local etal=false; -- return value set to true when we find some form of et al. in an author parameter | + | local etal = false; -- return value set to true when we find some form of et al. in an author parameter |
| | | |
− | local last_alias, first_alias; -- selected parameter aliases used in error messaging | + | local last_alias, first_alias, link_alias; -- selected parameter aliases used in error messaging |
| while true do | | while true do |
− | last, last_alias = select_one( args, cfg.aliases[list_name .. '-Last'], 'redundant_parameters', i ); -- search through args for name components beginning at 1 | + | last, last_alias = utilities.select_one ( args, cfg.aliases[list_name .. '-Last'], 'err_redundant_parameters', i ); -- search through args for name components beginning at 1 |
− | first, first_alias = select_one( args, cfg.aliases[list_name .. '-First'], 'redundant_parameters', i ); | + | first, first_alias = utilities.select_one ( args, cfg.aliases[list_name .. '-First'], 'err_redundant_parameters', i ); |
− | link = select_one( args, cfg.aliases[list_name .. '-Link'], 'redundant_parameters', i ); | + | link, link_alias = utilities.select_one ( args, cfg.aliases[list_name .. '-Link'], 'err_redundant_parameters', i ); |
− | mask = select_one( args, cfg.aliases[list_name .. '-Mask'], 'redundant_parameters', i ); | + | mask = utilities.select_one ( args, cfg.aliases[list_name .. '-Mask'], 'err_redundant_parameters', i ); |
| | | |
| last, etal = name_has_etal (last, etal, false, last_alias); -- find and remove variations on et al. | | last, etal = name_has_etal (last, etal, false, last_alias); -- find and remove variations on et al. |
| first, etal = name_has_etal (first, etal, false, first_alias); -- find and remove variations on et al. | | first, etal = name_has_etal (first, etal, false, first_alias); -- find and remove variations on et al. |
− | last, first= name_checks (last, first, list_name); -- multiple names, extraneous annotation, etc checks | + | last, first = name_checks (last, first, list_name); -- multiple names, extraneous annotation, etc. checks |
| | | |
| if first and not last then -- if there is a firstn without a matching lastn | | if first and not last then -- if there is a firstn without a matching lastn |
− | table.insert( z.message_tail, { set_error( 'first_missing_last', {first_alias, first_alias:gsub('first', 'last')}, true ) } ); -- add this error message | + | local alias = first_alias:find ('given', 1, true) and 'given' or 'first'; -- get first or given form of the alias |
| + | table.insert (z.message_tail, { utilities.set_message ( 'err_first_missing_last', { |
| + | first_alias, -- param name of alias missing its mate |
| + | first_alias:gsub (alias, {['first'] = 'last', ['given'] = 'surname'}), -- make param name appropriate to the alias form |
| + | }, true ) } ); -- add this error message |
| elseif not first and not last then -- if both firstn and lastn aren't found, are we done? | | elseif not first and not last then -- if both firstn and lastn aren't found, are we done? |
| count = count + 1; -- number of times we haven't found last and first | | count = count + 1; -- number of times we haven't found last and first |
Sətir 1.385: |
Sətir 1.452: |
| end | | end |
| else -- we have last with or without a first | | else -- we have last with or without a first |
− | link_title_ok (link, list_name:match ("(%w+)List"):lower() .. '-link' .. i, last, list_name:match ("(%w+)List"):lower() .. '-last' .. i); -- check for improper wikimarkup | + | local result; |
| + | link = link_title_ok (link, link_alias, last, last_alias); -- check for improper wiki-markup |
| + | if first then |
| + | link = link_title_ok (link, link_alias, first, first_alias); -- check for improper wiki-markup |
| + | end |
| | | |
− | names[n] = {last = last, first = first, link = link, mask = mask, corporate=false}; -- add this name to our names list (corporate for |vauthors= only) | + | names[n] = {last = last, first = first, link = link, mask = mask, corporate = false}; -- add this name to our names list (corporate for |vauthors= only) |
| n = n + 1; -- point to next location in the names table | | n = n + 1; -- point to next location in the names table |
| if 1 == count then -- if the previous name was missing | | if 1 == count then -- if the previous name was missing |
− | table.insert( z.message_tail, { set_error( 'missing_name', {list_name:match ("(%w+)List"):lower(), i-1}, true ) } ); -- add this error message | + | table.insert( z.message_tail, { utilities.set_message ( 'err_missing_name', {list_name:match ("(%w+)List"):lower(), i - 1}, true ) } ); -- add this error message |
| end | | end |
| count = 0; -- reset the counter, we're looking for two consecutive missing names | | count = 0; -- reset the counter, we're looking for two consecutive missing names |
Sətir 1.397: |
Sətir 1.468: |
| end | | end |
| | | |
− | return names, etal; -- all done, return our list of names | + | return names, etal; -- all done, return our list of names and the etal flag |
| end | | end |
| | | |
Sətir 1.433: |
Sətir 1.504: |
| end | | end |
| | | |
− | local ietf_code; -- because some languages have both ietf-like codes and iso 639-like codes | + | local ietf_code; -- because some languages have both IETF-like codes and ISO 639-like codes |
| local ietf_name; | | local ietf_name; |
| | | |
− | local languages = mw.language.fetchLanguageNames(this_wiki_code, 'all') -- get a list of language names known to Wikimedia
| + | local langlc = mw.ustring.lower (lang); -- lower-case version for comparisons |
− | -- ('all' is required for North Ndebele, South Ndebele, and Ojibwa)
| |
− | local langlc = mw.ustring.lower(lang); -- lower case version for comparisons | |
| | | |
− | for code, name in pairs(languages) do -- scan the list to see if we can find our language | + | for code, name in pairs (cfg.languages) do -- scan the list to see if we can find our language |
− | if langlc == mw.ustring.lower(name) then | + | if langlc == mw.ustring.lower (name) then |
− | if 2 == code:len() or 3 == code:len() then -- two- or three-character codes only; extensions not supported | + | if 2 == #code or 3 == #code then -- two- or three-character codes only; IETF extensions not supported |
| return name, code; -- so return the name and the code | | return name, code; -- so return the name and the code |
| end | | end |
− | ietf_code = code; -- remember that we found an ietf-like code and save its name | + | ietf_code = code; -- remember that we found an IETF-like code and save its name |
| ietf_name = name; -- but keep looking for a 2- or 3-char code | | ietf_name = name; -- but keep looking for a 2- or 3-char code |
| end | | end |
| end | | end |
− | -- didn't find name with 2- or 3-char code; if ietf-like code found return | + | -- didn't find name with 2- or 3-char code; if IETF-like code found return |
| return ietf_code and ietf_name or lang; -- associated name; return original language text else | | return ietf_code and ietf_name or lang; -- associated name; return original language text else |
| end | | end |
Sətir 1.464: |
Sətir 1.533: |
| | | |
| Languages that are the same as the local wiki are not categorized. MediaWiki does not recognize three-character | | Languages that are the same as the local wiki are not categorized. MediaWiki does not recognize three-character |
− | equivalents of two-character codes: code 'ar' is recognized bit code 'ara' is not. | + | equivalents of two-character codes: code 'ar' is recognized but code 'ara' is not. |
| | | |
| This function supports multiple languages in the form |language=nb, French, th where the language names or codes are | | This function supports multiple languages in the form |language=nb, French, th where the language names or codes are |
− | separated from each other by commas. | + | separated from each other by commas with optional space characters. |
| | | |
| ]] | | ]] |
Sətir 1.477: |
Sətir 1.546: |
| local names_table = {}; -- table made from the value assigned to |language= | | local names_table = {}; -- table made from the value assigned to |language= |
| | | |
− | local this_wiki = mw.getContentLanguage(); -- get a language object for this wiki
| + | local this_wiki_name = mw.language.fetchLanguageName (cfg.this_wiki_code, cfg.this_wiki_code); -- get this wiki's language name |
− | local this_wiki_code = this_wiki:getCode() -- get this wiki's language code
| |
− | local this_wiki_name = mw.language.fetchLanguageName(this_wiki_code, this_wiki_code); -- get this wiki's language name | |
| | | |
| names_table = mw.text.split (lang, '%s*,%s*'); -- names should be a comma separated list | | names_table = mw.text.split (lang, '%s*,%s*'); -- names should be a comma separated list |
Sətir 1.487: |
Sətir 1.554: |
| | | |
| if name then -- there was a remapped code so | | if name then -- there was a remapped code so |
− | lang = lang:gsub ('^(%a%a%a?)%-.*', '%1'); -- strip ietf tags from code | + | if not lang:match ('^%a%a%a?%-x%-%a+$') then -- if not a private IETF tag |
| + | lang = lang:gsub ('^(%a%a%a?)%-.*', '%1'); -- strip IETF tags from code |
| + | end |
| else | | else |
− | if lang:match ('^%a%a%-') then -- strip ietf tags from code; TODO: is there a need to support 3-char with tag? | + | lang = lang:gsub ('^(%a%a%a?)%-.*', '%1'); -- strip any IETF-like tags from code |
− | lang = lang:match ('(%a%a)%-') -- keep only 639-1 code portion to lang; TODO: do something with 3166 alpha 2 country code?
| |
− | end
| |
| if 2 == lang:len() or 3 == lang:len() then -- if two-or three-character code | | if 2 == lang:len() or 3 == lang:len() then -- if two-or three-character code |
− | name = mw.language.fetchLanguageName (lang:lower(), this_wiki_code); -- get language name if |language= is a proper code | + | name = mw.language.fetchLanguageName (lang:lower(), cfg.this_wiki_code); -- get language name if |language= is a proper code |
| end | | end |
| end | | end |
| | | |
− | if is_set (name) then -- if |language= specified a valid code | + | if utilities.is_set (name) then -- if |language= specified a valid code |
| code = lang:lower(); -- save it | | code = lang:lower(); -- save it |
| else | | else |
− | name, code = get_iso639_code (lang, this_wiki_code); -- attempt to get code from name (assign name here so that we are sure of proper capitalization) | + | name, code = get_iso639_code (lang, cfg.this_wiki_code); -- attempt to get code from name (assign name here so that we are sure of proper capitalization) |
| end | | end |
| | | |
− | if is_set (code) then -- only 2- or 3-character codes | + | if utilities.is_set (code) then -- only 2- or 3-character codes |
− | name = cfg.lang_code_remap[code] or name; -- override wikimedia when they misuse language codes/names -- add maint category if not already added | + | name = cfg.lang_code_remap[code] or name; -- override wikimedia when they misuse language codes/names |
| + | |
| + | if cfg.this_wiki_code ~= code then -- when the language is not the same as this wiki's language |
| + | if 2 == code:len() then -- and is a two-character code |
| + | utilities.add_prop_cat ('foreign_lang_source' .. code, {name, code}); -- categorize it; code appended to allow for multiple language categorization |
| + | else -- or is a recognized language (but has a three-character code) |
| + | utilities.add_prop_cat ('foreign_lang_source_2' .. code, {code}); -- categorize it differently TODO: support multiple three-character code categories per cs1|2 template |
| + | end |
| + | elseif cfg.local_lang_cat_enable then -- when the language and this wiki's language are the same and categorization is enabled |
| + | utilities.add_prop_cat ('local_lang_source', {name, code}); -- categorize it |
| + | end |
| + | else |
| + | utilities.set_message ('maint_unknown_lang'); -- add maint category if not already added |
| end | | end |
| | | |
Sətir 1.510: |
Sətir 1.589: |
| name = ''; -- so we can reuse it | | name = ''; -- so we can reuse it |
| end | | end |
− |
| + | |
− | code = #language_list -- reuse code as number of languages in the list
| + | name = utilities.make_sep_list (#language_list, language_list); |
− | if 2 >= code then | + | |
− | name = table.concat (language_list, cfg.messages['parameter-pair-separator']) -- insert '<space>and<space>' between two language names
| |
− | elseif 2 < code then
| |
− | name = table.concat (language_list, ', '); -- and concatenate with '<comma><space>' separators
| |
− | name = name:gsub (', ([^,]+)$', cfg.messages['parameter-final-separator'] .. '%1'); -- replace last '<comma><space>' separator with '<comma><space>and<space>' separator
| |
− | end
| |
| if this_wiki_name == name then | | if this_wiki_name == name then |
| return ''; -- if one language and that language is this wiki's return an empty string (no annotation) | | return ''; -- if one language and that language is this wiki's return an empty string (no annotation) |
Sətir 1.538: |
Sətir 1.612: |
| | | |
| local function set_cs1_style (ps) | | local function set_cs1_style (ps) |
− | if not is_set (ps) then -- unless explicitely set to something | + | if not utilities.is_set (ps) then -- unless explicitly set to something |
| ps = cfg.presentation['ps_cs1']; -- terminate the rendered citation | | ps = cfg.presentation['ps_cs1']; -- terminate the rendered citation |
| end | | end |
Sətir 1.555: |
Sətir 1.629: |
| | | |
| local function set_cs2_style (ps, ref) | | local function set_cs2_style (ps, ref) |
− | if not is_set (ps) then -- if |postscript= has not been set, set cs2 default | + | if not utilities.is_set (ps) then -- if |postscript= has not been set, set cs2 default |
| ps = cfg.presentation['ps_cs2']; -- terminate the rendered citation | | ps = cfg.presentation['ps_cs2']; -- terminate the rendered citation |
| end | | end |
− | if not is_set (ref) then -- if |ref= is not set | + | if not utilities.is_set (ref) then -- if |ref= is not set |
| ref = "harv"; -- set default |ref=harv | | ref = "harv"; -- set default |ref=harv |
| end | | end |
Sətir 1.600: |
Sətir 1.674: |
| sep, ps, ref = get_settings_from_cite_class (ps, ref, cite_class); -- get settings based on the template's CitationClass | | sep, ps, ref = get_settings_from_cite_class (ps, ref, cite_class); -- get settings based on the template's CitationClass |
| end | | end |
− | if 'none' == ps:lower() then -- if assigned value is 'none' then | + | |
| + | if cfg.keywords_xlate[ps:lower()] == 'none' then -- if assigned value is 'none' then |
| ps = ''; -- set to empty string | | ps = ''; -- set to empty string |
| end | | end |
Sətir 1.610: |
Sətir 1.685: |
| --[=[-------------------------< I S _ P D F >------------------------------------------------------------------ | | --[=[-------------------------< I S _ P D F >------------------------------------------------------------------ |
| | | |
− | Determines if a url has the file extension that is one of the pdf file extensions used by [[MediaWiki:Common.css]] when | + | Determines if a URL has the file extension that is one of the PDF file extensions used by [[MediaWiki:Common.css]] when |
− | applying the pdf icon to external links. | + | applying the PDF icon to external links. |
| | | |
| returns true if file extension is one of the recognized extensions, else false | | returns true if file extension is one of the recognized extensions, else false |
Sətir 1.626: |
Sətir 1.701: |
| --[[--------------------------< S T Y L E _ F O R M A T >------------------------------------------------------ | | --[[--------------------------< S T Y L E _ F O R M A T >------------------------------------------------------ |
| | | |
− | Applies css style to |format=, |chapter-format=, etc. Also emits an error message if the format parameter does | + | Applies CSS style to |format=, |chapter-format=, etc. Also emits an error message if the format parameter does |
− | not have a matching url parameter. If the format parameter is not set and the url contains a file extension that | + | not have a matching URL parameter. If the format parameter is not set and the URL contains a file extension that |
− | is recognized as a pdf document by MediaWiki's commons.css, this code will set the format parameter to (PDF) with | + | is recognized as a PDF document by MediaWiki's commons.css, this code will set the format parameter to (PDF) with |
| the appropriate styling. | | the appropriate styling. |
| | | |
Sətir 1.634: |
Sətir 1.709: |
| | | |
| local function style_format (format, url, fmt_param, url_param) | | local function style_format (format, url, fmt_param, url_param) |
− | if is_set (format) then | + | if utilities.is_set (format) then |
− | format = wrap_style ('format', format); -- add leading space, parentheses, resize | + | format = utilities.wrap_style ('format', format); -- add leading space, parentheses, resize |
− | if not is_set (url) then | + | if not utilities.is_set (url) then |
− | format = format .. set_error( 'format_missing_url', {fmt_param, url_param} ); -- add an error message | + | format = format .. ' ' .. utilities.set_message ( 'err_format_missing_url', {fmt_param, url_param} ); -- add an error message |
| end | | end |
− | elseif is_pdf (url) then -- format is not set so if url is a pdf file then | + | elseif is_pdf (url) then -- format is not set so if URL is a PDF file then |
− | format = wrap_style ('format', 'PDF'); -- set format to pdf | + | format = utilities.wrap_style ('format', 'PDF'); -- set format to PDF |
| else | | else |
| format = ''; -- empty string for concatenation | | format = ''; -- empty string for concatenation |
Sətir 1.650: |
Sətir 1.725: |
| --[[--------------------------< G E T _ D I S P L A Y _ N A M E S >-------------------------------------------- | | --[[--------------------------< G E T _ D I S P L A Y _ N A M E S >-------------------------------------------- |
| | | |
− | Returns a number that defines the number of names displayed for author and editor name lists and a boolean flag | + | Returns a number that defines the number of names displayed for author and editor name lists and a Boolean flag |
| to indicate when et al. should be appended to the name list. | | to indicate when et al. should be appended to the name list. |
| | | |
Sətir 1.672: |
Sətir 1.747: |
| | | |
| local function get_display_names (max, count, list_name, etal) | | local function get_display_names (max, count, list_name, etal) |
− | if is_set (max) then | + | if utilities.is_set (max) then |
| if 'etal' == max:lower():gsub("[ '%.]", '') then -- the :gsub() portion makes 'etal' from a variety of 'et al.' spellings and stylings | | if 'etal' == max:lower():gsub("[ '%.]", '') then -- the :gsub() portion makes 'etal' from a variety of 'et al.' spellings and stylings |
| max = count + 1; -- number of authors + 1 so display all author name plus et al. | | max = count + 1; -- number of authors + 1 so display all author name plus et al. |
Sətir 1.678: |
Sətir 1.753: |
| elseif max:match ('^%d+$') then -- if is a string of numbers | | elseif max:match ('^%d+$') then -- if is a string of numbers |
| max = tonumber (max); -- make it a number | | max = tonumber (max); -- make it a number |
| + | if max >= count then -- if |display-xxxxors= value greater than or equal to number of authors/editors |
| + | table.insert( z.message_tail, {utilities.set_message ('err_disp_name', {cfg.special_case_translation [list_name], max}, true)}); -- add error message |
| + | max = nil; |
| + | end |
| else -- not a valid keyword or number | | else -- not a valid keyword or number |
− | table.insert( z.message_tail, { set_error( 'invalid_param_val', {'display-' .. list_name, max}, true ) } ); -- add error message | + | table.insert( z.message_tail, {utilities.set_message ('err_disp_name', {cfg.special_case_translation [list_name], max}, true)}); -- add error message |
| max = nil; -- unset; as if |display-xxxxors= had not been set | | max = nil; -- unset; as if |display-xxxxors= had not been set |
| end | | end |
Sətir 1.702: |
Sətir 1.781: |
| local good_pattern = '^P[^%.Pp]'; -- ok to begin with uppercase P: P7 (pg 7 of section P) but not p123 (page 123) TODO: add Gg for PG or Pg? | | local good_pattern = '^P[^%.Pp]'; -- ok to begin with uppercase P: P7 (pg 7 of section P) but not p123 (page 123) TODO: add Gg for PG or Pg? |
| local bad_pattern = '^[Pp]?[Pp]%.?[ %d]'; | | local bad_pattern = '^[Pp]?[Pp]%.?[ %d]'; |
| + | |
| + | if not page:match (good_pattern) and (page:match (bad_pattern) or page:match ('^[Pp]ages?')) then |
| + | utilities.set_message ('maint_extra_text'); -- add maint cat; |
| + | end |
| end | | end |
| | | |
Sətir 1.708: |
Sətir 1.791: |
| | | |
| split apart a |vauthors= or |veditors= parameter. This function allows for corporate names, wrapped in doubled | | split apart a |vauthors= or |veditors= parameter. This function allows for corporate names, wrapped in doubled |
− | parentheses to also have commas; in the old version of the code, the doubled parnetheses were included in the | + | parentheses to also have commas; in the old version of the code, the doubled parentheses were included in the |
| rendered citation and in the metadata. Individual author names may be wikilinked | | rendered citation and in the metadata. Individual author names may be wikilinked |
| | | |
Sətir 1.722: |
Sətir 1.805: |
| | | |
| while name_table[i] do | | while name_table[i] do |
− | if name_table[i]:match ('^%(%(.*[^%)][^%)]$') then -- first segment of corporate with one or more commas; this segment has the opening doubled parens | + | if name_table[i]:match ('^%(%(.*[^%)][^%)]$') then -- first segment of corporate with one or more commas; this segment has the opening doubled parentheses |
| local name = name_table[i]; | | local name = name_table[i]; |
− | i=i+1; -- bump indexer to next segment | + | i = i + 1; -- bump indexer to next segment |
| while name_table[i] do | | while name_table[i] do |
| name = name .. ', ' .. name_table[i]; -- concatenate with previous segments | | name = name .. ', ' .. name_table[i]; -- concatenate with previous segments |
− | if name_table[i]:match ('^.*%)%)$') then -- if this table member has the closing doubled parens | + | if name_table[i]:match ('^.*%)%)$') then -- if this table member has the closing doubled parentheses |
| break; -- and done reassembling so | | break; -- and done reassembling so |
| end | | end |
− | i=i+1; -- bump indexer | + | i = i + 1; -- bump indexer |
| end | | end |
| table.insert (output_table, name); -- and add corporate name to the output table | | table.insert (output_table, name); -- and add corporate name to the output table |
| table.insert (output_link_table, ''); -- no wikilink | | table.insert (output_link_table, ''); -- no wikilink |
| else | | else |
− | wl_type, label, link = is_wikilink (name_table[i]); -- wl_type is: 0, no wl (text in label variable); 1, [[D]]; 2, [[L|D]] | + | wl_type, label, link = utilities.is_wikilink (name_table[i]); -- wl_type is: 0, no wl (text in label variable); 1, [[D]]; 2, [[L|D]] |
| table.insert (output_table, label); -- add this name | | table.insert (output_table, label); -- add this name |
| if 1 == wl_type then | | if 1 == wl_type then |
Sətir 1.743: |
Sətir 1.826: |
| end | | end |
| end | | end |
− | i = i+1; | + | i = i + 1; |
| end | | end |
| return output_table; | | return output_table; |
Sətir 1.756: |
Sətir 1.839: |
| Author / editor names in |vauthors= or |veditors= must be in Vancouver system style. Corporate or institutional names | | Author / editor names in |vauthors= or |veditors= must be in Vancouver system style. Corporate or institutional names |
| may sometimes be required and because such names will often fail the is_good_vanc_name() and other format compliance | | may sometimes be required and because such names will often fail the is_good_vanc_name() and other format compliance |
− | tests, are wrapped in doubled paranethese ((corporate name)) to suppress the format tests. | + | tests, are wrapped in doubled parentheses ((corporate name)) to suppress the format tests. |
| | | |
| Supports generational suffixes Jr, 2nd, 3rd, 4th–6th. | | Supports generational suffixes Jr, 2nd, 3rd, 4th–6th. |
| | | |
− | This function sets the vancouver error when a reqired comma is missing and when there is a space between an author's initials. | + | This function sets the Vancouver error when a required comma is missing and when there is a space between an author's initials. |
| | | |
| ]] | | ]] |
Sətir 1.776: |
Sətir 1.859: |
| | | |
| for i, v_name in ipairs(v_name_table) do | | for i, v_name in ipairs(v_name_table) do |
− | if v_name:match ('^%(%(.+%)%)$') then -- corporate authors are wrapped in doubled parentheses to supress vanc formatting and error detection | + | first = ''; -- set to empty string for concatenation and because it may have been set for previous author/editor |
− | first = ''; -- set to empty string for concatenation and because it may have been set for previous author/editor
| + | local accept_name; |
− | last = v_name:match ('^%(%((.+)%)%)$') -- remove doubled parntheses
| + | v_name, accept_name = utilities.has_accept_as_written (v_name); -- remove accept-this-as-written markup when it wraps all of <v_name> |
| + | |
| + | -- if v_name:match ('^%(%(.+%)%)$') then -- corporate authors are wrapped in doubled parentheses to suppress vanc formatting and error detection |
| + | -- last = v_name:match ('^%(%((.+)%)%)$') -- remove doubled parentheses |
| + | if accept_name then |
| + | last = v_name; |
| corporate = true; -- flag used in list_people() | | corporate = true; -- flag used in list_people() |
| elseif string.find(v_name, "%s") then | | elseif string.find(v_name, "%s") then |
| if v_name:find('[;%.]') then -- look for commonly occurring punctuation characters; | | if v_name:find('[;%.]') then -- look for commonly occurring punctuation characters; |
− | add_vanc_error ('punctuation'); | + | add_vanc_error (cfg.err_msg_supl.punctuation); |
| end | | end |
| local lastfirstTable = {} | | local lastfirstTable = {} |
− | lastfirstTable = mw.text.split(v_name, "%s") | + | lastfirstTable = mw.text.split(v_name, "%s+") |
− | first = table.remove(lastfirstTable); -- removes and returns value of last element in table which should be author intials | + | first = table.remove(lastfirstTable); -- removes and returns value of last element in table which should be initials or generational suffix |
− | if is_suffix (first) then -- if a valid suffix | + | |
− | suffix = first -- save it as a suffix and | + | if not mw.ustring.match (first, '^%u+$') then -- mw.ustring here so that later we will catch non-Latin characters |
| + | suffix = first; -- not initials so assume that whatever we got is a generational suffix |
| first = table.remove(lastfirstTable); -- get what should be the initials from the table | | first = table.remove(lastfirstTable); -- get what should be the initials from the table |
− | end -- no suffix error message here because letter combination may be result of Romanization; check for digits? | + | end |
− | last = table.concat(lastfirstTable, " ") -- returns a string that is the concatenation of all other names that are not initials | + | last = table.concat(lastfirstTable, ' ') -- returns a string that is the concatenation of all other names that are not initials and generational suffix |
| + | if not utilities.is_set (last) then |
| + | first = ''; -- unset |
| + | last = v_name; -- last empty because something wrong with first |
| + | add_vanc_error (cfg.err_msg_supl.name); |
| + | end |
| if mw.ustring.match (last, '%a+%s+%u+%s+%a+') then | | if mw.ustring.match (last, '%a+%s+%u+%s+%a+') then |
− | add_vanc_error ('missing comma'); -- matches last II last; the case when a comma is missing | + | add_vanc_error (cfg.err_msg_supl['missing comma']); -- matches last II last; the case when a comma is missing |
| end | | end |
| if mw.ustring.match (v_name, ' %u %u$') then -- this test is in the wrong place TODO: move or replace with a more appropriate test | | if mw.ustring.match (v_name, ' %u %u$') then -- this test is in the wrong place TODO: move or replace with a more appropriate test |
− | add_vanc_error ('name'); -- matches a space between two intiials | + | add_vanc_error (cfg.err_msg_supl.name); -- matches a space between two initials |
| end | | end |
| else | | else |
− | first = ''; -- set to empty string for concatenation and because it may have been set for previous author/editor
| |
| last = v_name; -- last name or single corporate name? Doesn't support multiword corporate names? do we need this? | | last = v_name; -- last name or single corporate name? Doesn't support multiword corporate names? do we need this? |
| end | | end |
− |
| + | |
− | if is_set (first) then | + | if utilities.is_set (first) then |
| if not mw.ustring.match (first, "^%u?%u$") then -- first shall contain one or two upper-case letters, nothing else | | if not mw.ustring.match (first, "^%u?%u$") then -- first shall contain one or two upper-case letters, nothing else |
− | add_vanc_error ('initials'); -- too many initials; mixed case initials (which may be ok Romanization); hyphenated initials | + | add_vanc_error (cfg.err_msg_supl.initials); -- too many initials; mixed case initials (which may be ok Romanization); hyphenated initials |
| end | | end |
− | is_good_vanc_name (last, first); -- check first and last before restoring the suffix which may have a non-Latin digit | + | is_good_vanc_name (last, first, suffix); -- check first and last before restoring the suffix which may have a non-Latin digit |
− | if is_set (suffix) then | + | if utilities.is_set (suffix) then |
| first = first .. ' ' .. suffix; -- if there was a suffix concatenate with the initials | | first = first .. ' ' .. suffix; -- if there was a suffix concatenate with the initials |
| suffix = ''; -- unset so we don't add this suffix to all subsequent names | | suffix = ''; -- unset so we don't add this suffix to all subsequent names |
Sətir 1.818: |
Sətir 1.911: |
| end | | end |
| | | |
− | link = select_one( args, cfg.aliases[list_name .. '-Link'], 'redundant_parameters', i ) or v_link_table[i]; | + | link = utilities.select_one ( args, cfg.aliases[list_name .. '-Link'], 'err_redundant_parameters', i ) or v_link_table[i]; |
− | mask = select_one( args, cfg.aliases[list_name .. '-Mask'], 'redundant_parameters', i ); | + | mask = utilities.select_one ( args, cfg.aliases[list_name .. '-Mask'], 'err_redundant_parameters', i ); |
− | names[i] = {last = last, first = first, link = link, mask = mask, corporate=corporate}; -- add this assembled name to our names list | + | names[i] = {last = last, first = first, link = link, mask = mask, corporate = corporate}; -- add this assembled name to our names list |
| end | | end |
| return names, etal; -- all done, return our list of names | | return names, etal; -- all done, return our list of names |
Sətir 1.845: |
Sətir 1.938: |
| | | |
| local function select_author_editor_source (vxxxxors, xxxxors, args, list_name) | | local function select_author_editor_source (vxxxxors, xxxxors, args, list_name) |
− | local lastfirst = false; | + | local lastfirst = false; |
− | if select_one( args, cfg.aliases[list_name .. '-Last'], 'none', 1 ) or -- do this twice incase we have a |first1= without a |last1=; this ... | + | if utilities.select_one ( args, cfg.aliases[list_name .. '-Last'], 'none', 1 ) or -- do this twice in case we have a |first1= without a |last1=; this ... |
− | select_one( args, cfg.aliases[list_name .. '-First'], 'none', 1 ) or -- ... also catches the case where |first= is used with |vauthors= | + | utilities.select_one ( args, cfg.aliases[list_name .. '-First'], 'none', 1 ) or -- ... also catches the case where |first= is used with |vauthors= |
− | select_one( args, cfg.aliases[list_name .. '-Last'], 'none', 2 ) or | + | utilities.select_one ( args, cfg.aliases[list_name .. '-Last'], 'none', 2 ) or |
− | select_one( args, cfg.aliases[list_name .. '-First'], 'none', 2 ) then | + | utilities.select_one ( args, cfg.aliases[list_name .. '-First'], 'none', 2 ) then |
− | lastfirst=true; | + | lastfirst = true; |
| end | | end |
| | | |
− | if (is_set (vxxxxors) and true == lastfirst) or -- these are the three error conditions | + | if (utilities.is_set (vxxxxors) and true == lastfirst) or -- these are the three error conditions |
− | (is_set (vxxxxors) and is_set (xxxxors)) or | + | (utilities.is_set (vxxxxors) and utilities.is_set (xxxxors)) or |
− | (true == lastfirst and is_set (xxxxors)) then | + | (true == lastfirst and utilities.is_set (xxxxors)) then |
| local err_name; | | local err_name; |
| if 'AuthorList' == list_name then -- figure out which name should be used in error message | | if 'AuthorList' == list_name then -- figure out which name should be used in error message |
Sətir 1.862: |
Sətir 1.955: |
| err_name = 'editor'; | | err_name = 'editor'; |
| end | | end |
− | table.insert( z.message_tail, { set_error( 'redundant_parameters', | + | table.insert( z.message_tail, { utilities.set_message ( 'err_redundant_parameters', |
| {err_name .. '-name-list parameters'}, true ) } ); -- add error message | | {err_name .. '-name-list parameters'}, true ) } ); -- add error message |
| end | | end |
| | | |
| if true == lastfirst then return 1 end; -- return a number indicating which author name source to use | | if true == lastfirst then return 1 end; -- return a number indicating which author name source to use |
− | if is_set (vxxxxors) then return 2 end; | + | if utilities.is_set (vxxxxors) then return 2 end; |
− | if is_set (xxxxors) then return 3 end; | + | if utilities.is_set (xxxxors) then return 3 end; |
| return 1; -- no authors so return 1; this allows missing author name test to run in case there is a first without last | | return 1; -- no authors so return 1; this allows missing author name test to run in case there is a first without last |
| end | | end |
Sətir 1.876: |
Sətir 1.969: |
| | | |
| This function is used to validate a parameter's assigned value for those parameters that have only a limited number | | This function is used to validate a parameter's assigned value for those parameters that have only a limited number |
− | of allowable values (yes, y, true, no, etc). When the parameter value has not been assigned a value (missing or empty | + | of allowable values (yes, y, true, live, dead, etc.). When the parameter value has not been assigned a value (missing |
− | in the source template) the function returns true. If the parameter value is one of the list of allowed values returns | + | or empty in the source template) the function returns the value specified by ret_val. If the parameter value is one |
− | true; else, emits an error message and returns false.
| + | of the list of allowed values returns the translated value; else, emits an error message and returns the value |
| + | specified by ret_val. |
| | | |
| ]] | | ]] |
| | | |
− | local function is_valid_parameter_value (value, name, possible) | + | local function is_valid_parameter_value (value, name, possible, ret_val) |
− | if not is_set (value) then | + | if not utilities.is_set (value) then |
− | return true; -- an empty parameter is ok | + | return ret_val; -- an empty parameter is ok |
− | elseif in_array (value, possible) then | + | elseif utilities.in_array (value, possible) then |
− | return true; | + | return cfg.keywords_xlate[value]; -- return translation of parameter keyword |
| else | | else |
− | table.insert( z.message_tail, { set_error( 'invalid_param_val', {name, value}, true ) } ); -- not an allowed value so add error message | + | table.insert( z.message_tail, { utilities.set_message ( 'err_invalid_param_val', {name, value}, true ) } ); -- not an allowed value so add error message |
− | return false | + | return ret_val; |
| end | | end |
| end | | end |
Sətir 1.904: |
Sətir 1.998: |
| | | |
| local function terminate_name_list (name_list, sepc) | | local function terminate_name_list (name_list, sepc) |
− | if (string.sub (name_list,-3,-1) == sepc .. '. ') then -- if already properly terminated | + | if (string.sub (name_list, -3, -1) == sepc .. '. ') then -- if already properly terminated |
| return name_list; -- just return the name list | | return name_list; -- just return the name list |
− | elseif (string.sub (name_list,-1,-1) == sepc) or (string.sub (name_list,-3,-1) == sepc .. ']]') then -- if last name in list ends with sepc char | + | elseif (string.sub (name_list, -1, -1) == sepc) or (string.sub (name_list, -3, -1) == sepc .. ']]') then -- if last name in list ends with sepc char |
| return name_list .. " "; -- don't add another | | return name_list .. " "; -- don't add another |
| else | | else |
− | return name_list .. sepc .. ' '; -- otherwise terninate the name list | + | return name_list .. sepc .. ' '; -- otherwise terminate the name list |
| end | | end |
| end | | end |
Sətir 1.922: |
Sətir 2.016: |
| | | |
| local function format_volume_issue (volume, issue, cite_class, origin, sepc, lower) | | local function format_volume_issue (volume, issue, cite_class, origin, sepc, lower) |
− | if not is_set (volume) and not is_set (issue) then | + | if not utilities.is_set (volume) and not utilities.is_set (issue) then |
| return ''; | | return ''; |
| end | | end |
| | | |
− | if 'magazine' == cite_class or (in_array (cite_class, {'citation', 'map'}) and 'magazine' == origin) then | + | if 'magazine' == cite_class or (utilities.in_array (cite_class, {'citation', 'map'}) and 'magazine' == origin) then |
− | if is_set (volume) and is_set (issue) then | + | if utilities.is_set (volume) and utilities.is_set (issue) then |
| return wrap_msg ('vol-no', {sepc, volume, issue}, lower); | | return wrap_msg ('vol-no', {sepc, volume, issue}, lower); |
− | elseif is_set (volume) then | + | elseif utilities.is_set (volume) then |
| return wrap_msg ('vol', {sepc, volume}, lower); | | return wrap_msg ('vol', {sepc, volume}, lower); |
| else | | else |
| return wrap_msg ('issue', {sepc, issue}, lower); | | return wrap_msg ('issue', {sepc, issue}, lower); |
| end | | end |
| + | end |
| + | |
| + | if 'podcast' == cite_class and utilities.is_set (issue) then |
| + | return wrap_msg ('issue', {sepc, issue}, lower); |
| end | | end |
| | | |
| local vol = ''; -- here for all cites except magazine | | local vol = ''; -- here for all cites except magazine |
| | | |
− | if is_set (volume) then | + | if utilities.is_set (volume) then |
− | if volume:match ('^[MDCLXVI]+$') or volume:match ('^%d+$')then -- volume value is all digits or all uppercase roman numerals | + | if volume:match ('^[MDCLXVI]+$') or volume:match ('^%d+$') then -- volume value is all digits or all uppercase Roman numerals |
− | vol = substitute (cfg.presentation['vol-bold'], {sepc, hyphen_to_dash(volume)}); -- render in bold face | + | vol = utilities.substitute (cfg.presentation['vol-bold'], {sepc, hyphen_to_dash(volume)}); -- render in bold face |
− | elseif (4 < mw.ustring.len(volume)) then -- not all digits or roman numerals and longer than 4 characters | + | elseif (4 < mw.ustring.len(volume)) then -- not all digits or Roman numerals and longer than 4 characters |
− | vol = substitute (cfg.messages['j-vol'], {sepc, volume}); -- not bold | + | vol = utilities.substitute (cfg.messages['j-vol'], {sepc, volume}); -- not bold |
| + | utilities.add_prop_cat ('long_vol'); |
| else -- four or less characters | | else -- four or less characters |
− | vol = substitute (cfg.presentation['vol-bold'], {sepc, hyphen_to_dash(volume)}); -- bold | + | vol = utilities.substitute (cfg.presentation['vol-bold'], {sepc, hyphen_to_dash(volume)}); -- bold |
| end | | end |
| end | | end |
− | if is_set (issue) then | + | if utilities.is_set (issue) then |
− | return vol .. substitute (cfg.messages['j-issue'], issue); | + | return vol .. utilities.substitute (cfg.messages['j-issue'], issue); |
| end | | end |
| return vol; | | return vol; |
Sətir 1.966: |
Sətir 2.065: |
| local function format_pages_sheets (page, pages, sheet, sheets, cite_class, origin, sepc, nopp, lower) | | local function format_pages_sheets (page, pages, sheet, sheets, cite_class, origin, sepc, nopp, lower) |
| if 'map' == cite_class then -- only cite map supports sheet(s) as in-source locators | | if 'map' == cite_class then -- only cite map supports sheet(s) as in-source locators |
− | if is_set (sheet) then | + | if utilities.is_set (sheet) then |
| if 'journal' == origin then | | if 'journal' == origin then |
| return '', '', wrap_msg ('j-sheet', sheet, lower), ''; | | return '', '', wrap_msg ('j-sheet', sheet, lower), ''; |
Sətir 1.972: |
Sətir 2.071: |
| return '', '', wrap_msg ('sheet', {sepc, sheet}, lower), ''; | | return '', '', wrap_msg ('sheet', {sepc, sheet}, lower), ''; |
| end | | end |
− | elseif is_set (sheets) then | + | elseif utilities.is_set (sheets) then |
| if 'journal' == origin then | | if 'journal' == origin then |
| return '', '', '', wrap_msg ('j-sheets', sheets, lower); | | return '', '', '', wrap_msg ('j-sheets', sheets, lower); |
Sətir 1.981: |
Sətir 2.080: |
| end | | end |
| | | |
− | local is_journal = 'journal' == cite_class or (in_array (cite_class, {'citation', 'map', 'interview'}) and 'journal' == origin); | + | local is_journal = 'journal' == cite_class or (utilities.in_array (cite_class, {'citation', 'map', 'interview'}) and 'journal' == origin); |
| | | |
− | if is_set (page) then | + | if utilities.is_set (page) then |
| if is_journal then | | if is_journal then |
− | return substitute (cfg.messages['j-page(s)'], page), '', '', ''; | + | return utilities.substitute (cfg.messages['j-page(s)'], page), '', '', ''; |
| elseif not nopp then | | elseif not nopp then |
− | return substitute (cfg.messages['p-prefix'], {sepc, page}), '', '', ''; | + | return utilities.substitute (cfg.messages['p-prefix'], {sepc, page}), '', '', ''; |
| else | | else |
− | return substitute (cfg.messages['nopp'], {sepc, page}), '', '', ''; | + | return utilities.substitute (cfg.messages['nopp'], {sepc, page}), '', '', ''; |
| end | | end |
− | end | + | elseif utilities.is_set (pages) then |
− | if is_set(pages) then
| |
| if is_journal then | | if is_journal then |
− | return substitute (cfg.messages['j-page(s)'], pages), '', '', ''; | + | return utilities.substitute (cfg.messages['j-page(s)'], pages), '', '', ''; |
| elseif tonumber(pages) ~= nil and not nopp then -- if pages is only digits, assume a single page number | | elseif tonumber(pages) ~= nil and not nopp then -- if pages is only digits, assume a single page number |
− | return '', substitute (cfg.messages['pp-suffix'], {sepc, pages}), '', ''; | + | return '', utilities.substitute (cfg.messages['p-prefix'], {sepc, pages}), '', ''; |
| elseif not nopp then | | elseif not nopp then |
− | return '', substitute (cfg.messages['pp-suffix'], {sepc, pages}), '', ''; | + | return '', utilities.substitute (cfg.messages['pp-prefix'], {sepc, pages}), '', ''; |
| else | | else |
− | return '', substitute (cfg.messages['nopp'], {sepc, pages}), '', ''; | + | return '', utilities.substitute (cfg.messages['nopp'], {sepc, pages}), '', ''; |
| end | | end |
| end | | end |
Sətir 2.012: |
Sətir 2.110: |
| returns one of the in-source locators: page, pages, or at. | | returns one of the in-source locators: page, pages, or at. |
| | | |
− | If any of these are interwiki links to wikisource, returns the label portion of the interwikilink as plain text | + | If any of these are interwiki links to Wikisource, returns the label portion of the interwiki-link as plain text |
− | for use in COinS. This COinS thing is done because here we convert an interwiki link to and external link and | + | for use in COinS. This COinS thing is done because here we convert an interwiki-link to and external link and |
| add an icon span around that; get_coins_pages() doesn't know about the span. TODO: should it? | | add an icon span around that; get_coins_pages() doesn't know about the span. TODO: should it? |
| | | |
Sətir 2.024: |
Sətir 2.122: |
| | | |
| local function insource_loc_get (page, pages, at) | | local function insource_loc_get (page, pages, at) |
− | local ws_url, ws_label, coins_pages, L; -- for wikisource interwikilinks; TODO: this corrupts page metadata (span remains in place after cleanup; fix there?) | + | local ws_url, ws_label, coins_pages, L; -- for Wikisource interwiki-links; TODO: this corrupts page metadata (span remains in place after cleanup; fix there?) |
| | | |
− | if is_set (page) then | + | if utilities.is_set (page) then |
− | if is_set (pages) or is_set(at) then | + | if utilities.is_set (pages) or utilities.is_set (at) then |
| pages = ''; -- unset the others | | pages = ''; -- unset the others |
| at = ''; | | at = ''; |
Sətir 2.033: |
Sətir 2.131: |
| extra_text_in_page_check (page); -- add this page to maint cat if |page= value begins with what looks like p. or pp. | | extra_text_in_page_check (page); -- add this page to maint cat if |page= value begins with what looks like p. or pp. |
| | | |
− | ws_url, ws_label, L = wikisource_url_make (page); -- make ws url from |page= interwiki link; link portion L becomes tool tip label | + | ws_url, ws_label, L = wikisource_url_make (page); -- make ws URL from |page= interwiki link; link portion L becomes tooltip label |
| if ws_url then | | if ws_url then |
| page = external_link (ws_url, ws_label .. ' ', 'ws link in page'); -- space char after label to move icon away from in-source text; TODO: a better way to do this? | | page = external_link (ws_url, ws_label .. ' ', 'ws link in page'); -- space char after label to move icon away from in-source text; TODO: a better way to do this? |
− | page = substitute (cfg.presentation['interwiki-icon'], {cfg.presentation['class-wikisource'], L, page}); | + | page = utilities.substitute (cfg.presentation['interwiki-icon'], {cfg.presentation['class-wikisource'], L, page}); |
| coins_pages = ws_label; | | coins_pages = ws_label; |
| end | | end |
− | elseif is_set (pages) then | + | elseif utilities.is_set (pages) then |
− | if is_set (at) then | + | if utilities.is_set (at) then |
| at = ''; -- unset | | at = ''; -- unset |
| end | | end |
| extra_text_in_page_check (pages); -- add this page to maint cat if |pages= value begins with what looks like p. or pp. | | extra_text_in_page_check (pages); -- add this page to maint cat if |pages= value begins with what looks like p. or pp. |
| | | |
− | ws_url, ws_label, L = wikisource_url_make (pages); -- make ws url from |pages= interwiki link; link portion L becomes tool tip label | + | ws_url, ws_label, L = wikisource_url_make (pages); -- make ws URL from |pages= interwiki link; link portion L becomes tooltip label |
| if ws_url then | | if ws_url then |
| pages = external_link (ws_url, ws_label .. ' ', 'ws link in pages'); -- space char after label to move icon away from in-source text; TODO: a better way to do this? | | pages = external_link (ws_url, ws_label .. ' ', 'ws link in pages'); -- space char after label to move icon away from in-source text; TODO: a better way to do this? |
− | pages = substitute (cfg.presentation['interwiki-icon'], {cfg.presentation['class-wikisource'], L, pages}); | + | pages = utilities.substitute (cfg.presentation['interwiki-icon'], {cfg.presentation['class-wikisource'], L, pages}); |
| coins_pages = ws_label; | | coins_pages = ws_label; |
| end | | end |
− | elseif is_set (at) then | + | elseif utilities.is_set (at) then |
− | ws_url, ws_label, L = wikisource_url_make (at); -- make ws url from |at= interwiki link; link portion L becomes tool tip label | + | ws_url, ws_label, L = wikisource_url_make (at); -- make ws URL from |at= interwiki link; link portion L becomes tooltip label |
| if ws_url then | | if ws_url then |
| at = external_link (ws_url, ws_label .. ' ', 'ws link in at'); -- space char after label to move icon away from in-source text; TODO: a better way to do this? | | at = external_link (ws_url, ws_label .. ' ', 'ws link in at'); -- space char after label to move icon away from in-source text; TODO: a better way to do this? |
− | at = substitute (cfg.presentation['interwiki-icon'], {cfg.presentation['class-wikisource'], L, at}); | + | at = utilities.substitute (cfg.presentation['interwiki-icon'], {cfg.presentation['class-wikisource'], L, at}); |
| coins_pages = ws_label; | | coins_pages = ws_label; |
| end | | end |
Sətir 2.062: |
Sətir 2.160: |
| return page, pages, at, coins_pages; | | return page, pages, at, coins_pages; |
| end | | end |
− |
| |
| | | |
| | | |
| --[=[-------------------------< A R C H I V E _ U R L _ C H E C K >-------------------------------------------- | | --[=[-------------------------< A R C H I V E _ U R L _ C H E C K >-------------------------------------------- |
| | | |
− | Check archive.org urls to make sure they at least look like they are pointing at valid archives and not to the | + | Check archive.org URLs to make sure they at least look like they are pointing at valid archives and not to the |
− | save snapshot url or to calendar pages. When the archive url is 'https://web.archive.org/save/' (or http://...) | + | save snapshot URL or to calendar pages. When the archive URL is 'https://web.archive.org/save/' (or http://...) |
− | archive.org saves a snapshot of the target page in the url. That is something that Wikipedia should not allow | + | archive.org saves a snapshot of the target page in the URL. That is something that Wikipedia should not allow |
| unwitting readers to do. | | unwitting readers to do. |
| | | |
− | When the archive.org url does not have a complete timestamp, archive.org chooses a snapshot according to its own | + | When the archive.org URL does not have a complete timestamp, archive.org chooses a snapshot according to its own |
| algorithm or provides a calendar 'search' result. [[WP:ELNO]] discourages links to search results. | | algorithm or provides a calendar 'search' result. [[WP:ELNO]] discourages links to search results. |
| | | |
| This function looks at the value assigned to |archive-url= and returns empty strings for |archive-url= and | | This function looks at the value assigned to |archive-url= and returns empty strings for |archive-url= and |
| |archive-date= and an error message when: | | |archive-date= and an error message when: |
− | |archive-url= holds an archive.org save command url | + | |archive-url= holds an archive.org save command URL |
− | |archive-url= is an archive.org url that does not have a complete timestamp (YYYYMMDDhhmmss 14 digits) in the | + | |archive-url= is an archive.org URL that does not have a complete timestamp (YYYYMMDDhhmmss 14 digits) in the |
| correct place | | correct place |
| otherwise returns |archive-url= and |archive-date= | | otherwise returns |archive-url= and |archive-date= |
| | | |
− | There are two mostly compatible archive.org urls: | + | There are two mostly compatible archive.org URLs: |
| //web.archive.org/<timestamp>... -- the old form | | //web.archive.org/<timestamp>... -- the old form |
| //web.archive.org/web/<timestamp>... -- the new form | | //web.archive.org/web/<timestamp>... -- the new form |
Sətir 2.090: |
Sətir 2.187: |
| we don't check for these specific flags but we do check the form. | | we don't check for these specific flags but we do check the form. |
| | | |
− | This function supports a preview mode. When the article is rendered in preview mode, this funct may return a modified | + | This function supports a preview mode. When the article is rendered in preview mode, this function may return a modified |
− | archive url: | + | archive URL: |
| for save command errors, return undated wildcard (/*/) | | for save command errors, return undated wildcard (/*/) |
− | for timestamp errors when the timestamp has a wildcard, return the url unmodified | + | for timestamp errors when the timestamp has a wildcard, return the URL unmodified |
| for timestamp errors when the timestamp does not have a wildcard, return with timestamp limited to six digits plus wildcard (/yyyymm*/) | | for timestamp errors when the timestamp does not have a wildcard, return with timestamp limited to six digits plus wildcard (/yyyymm*/) |
| | | |
Sətir 2.100: |
Sətir 2.197: |
| local function archive_url_check (url, date) | | local function archive_url_check (url, date) |
| local err_msg = ''; -- start with the error message empty | | local err_msg = ''; -- start with the error message empty |
− | local path, timestamp, flag; -- portions of the archive.or url | + | local path, timestamp, flag; -- portions of the archive.org URL |
| | | |
− | if (not url:match('//web%.archive%.org/')) and (not url:match('//liveweb%.archive%.org/')) then -- also deprecated liveweb Wayback machine url | + | if (not url:match('//web%.archive%.org/')) and (not url:match('//liveweb%.archive%.org/')) then -- also deprecated liveweb Wayback machine URL |
| return url, date; -- not an archive.org archive, return ArchiveURL and ArchiveDate | | return url, date; -- not an archive.org archive, return ArchiveURL and ArchiveDate |
| end | | end |
| | | |
− | if url:match('//web%.archive%.org/save/') then -- if a save command url, we don't want to allow saving of the target page | + | if url:match('//web%.archive%.org/save/') then -- if a save command URL, we don't want to allow saving of the target page |
− | err_msg = 'save command'; | + | err_msg = cfg.err_msg_supl.save; |
| url = url:gsub ('(//web%.archive%.org)/save/', '%1/*/', 1); -- for preview mode: modify ArchiveURL | | url = url:gsub ('(//web%.archive%.org)/save/', '%1/*/', 1); -- for preview mode: modify ArchiveURL |
| elseif url:match('//liveweb%.archive%.org/') then | | elseif url:match('//liveweb%.archive%.org/') then |
− | err_msg = 'liveweb'; | + | err_msg = cfg.err_msg_supl.liveweb; |
| else | | else |
− | path, timestamp, flag = url:match('//web%.archive%.org/([^%d]*)(%d+)([^/]*)/'); -- split out some of the url parts for evaluation | + | path, timestamp, flag = url:match('//web%.archive%.org/([^%d]*)(%d+)([^/]*)/'); -- split out some of the URL parts for evaluation |
| | | |
− | if not is_set(timestamp) or 14 ~= timestamp:len() then -- path and flag optional, must have 14-digit timestamp here | + | if not utilities.is_set (timestamp) or 14 ~= timestamp:len() then -- path and flag optional, must have 14-digit timestamp here |
− | err_msg = 'timestamp'; | + | err_msg = cfg.err_msg_supl.timestamp; |
| if '*' ~= flag then | | if '*' ~= flag then |
| url=url:gsub ('(//web%.archive%.org/[^%d]*%d?%d?%d?%d?%d?%d?)[^/]*', '%1*', 1) -- for preview, modify ts to be yearmo* max (0-6 digits plus splat) | | url=url:gsub ('(//web%.archive%.org/[^%d]*%d?%d?%d?%d?%d?%d?)[^/]*', '%1*', 1) -- for preview, modify ts to be yearmo* max (0-6 digits plus splat) |
| end | | end |
− | elseif is_set(path) and 'web/' ~= path then -- older archive urls do not have the extra 'web/' path element | + | elseif utilities.is_set (path) and 'web/' ~= path then -- older archive URLs do not have the extra 'web/' path element |
− | err_msg = 'path'; | + | err_msg = cfg.err_msg_supl.path; |
− | elseif is_set (flag) and not is_set (path) then -- flag not allowed with the old form url (without the 'web/' path element) | + | elseif utilities.is_set (flag) and not utilities.is_set (path) then -- flag not allowed with the old form URL (without the 'web/' path element) |
− | err_msg = 'flag'; | + | err_msg = cfg.err_msg_supl.flag; |
− | elseif is_set (flag) and not flag:match ('%a%a_') then -- flag if present must be two alpha characters and underscore (requires 'web/' path element) | + | elseif utilities.is_set (flag) and not flag:match ('%a%a_') then -- flag if present must be two alpha characters and underscore (requires 'web/' path element) |
− | err_msg = 'flag'; | + | err_msg = cfg.err_msg_supl.flag; |
| else | | else |
− | return url, date; -- return archiveURL and ArchiveDate | + | return url, date; -- return ArchiveURL and ArchiveDate |
| end | | end |
| end | | end |
| -- if here, something not right so | | -- if here, something not right so |
− | table.insert( z.message_tail, { set_error( 'archive_url', {err_msg}, true ) } ); -- add error message and | + | table.insert( z.message_tail, { utilities.set_message ( 'err_archive_url', {err_msg}, true ) } ); -- add error message and |
− | if is_set (Frame:preprocess('{{REVISIONID}}')) then | + | if utilities.is_set (Frame:preprocess('{{REVISIONID}}')) then |
− | return '', ''; -- return empty strings for archiveURL and ArchiveDate | + | return '', ''; -- return empty strings for ArchiveURL and ArchiveDate |
| else | | else |
− | return url, date; -- preview mode so return archiveURL and ArchiveDate | + | return url, date; -- preview mode so return ArchiveURL and ArchiveDate |
| end | | end |
| end | | end |
| | | |
| | | |
− | --[[--------------------------< C I T A T I O N 0 >------------------------------------------------------------ | + | --[[--------------------------< P L A C E _ C H E C K >-------------------------------------------------------- |
| + | |
| + | check |place=, |publication-place=, |location= to see if these params include digits. This function added because |
| + | many editors misuse location to specify the in-source location (|page(s)= and |at= are supposed to do that) |
| | | |
− | This is the main function doing the majority of the citation formatting.
| + | returns the original parameter value without modification; added maint cat when parameter value contains digits |
| | | |
| ]] | | ]] |
| | | |
− | local function citation0( config, args) | + | local function place_check (param_val) |
| + | if not utilities.is_set (param_val) then -- parameter empty or omitted |
| + | return param_val; -- return that empty state |
| + | end |
| + | |
| + | if mw.ustring.find (param_val, '%d') then -- not empty, are there digits in the parameter value |
| + | utilities.set_message ('maint_location'); -- yep, add maint cat |
| + | end |
| + | |
| + | return param_val; -- and done |
| + | end |
| + | |
| + | |
| + | --[[--------------------------< I S _ G E N E R I C _ T I T L E >---------------------------------------------- |
| + | |
| + | compares |title= value against list of known generic title patterns. Returns true when pattern matches; nil else |
| + | |
| + | the k/v pairs in 'generic_titles' each contain two tables, one for English and one for another 'local' language |
| + | Each of those tables contain another table that holds the string or pattern (whole title or title fragment) in |
| + | index [1]. index [2] is a Boolean that tells string.find() or mw.ustring.find() to do plain-text search (true) |
| + | or a pattern search (false). The intent of all this complexity is to make these searches as fast as possible so |
| + | that we don't run out of processing time on very large articles. |
| + | |
| + | ]] |
| + | |
| + | local function is_generic_title (title) |
| + | title = mw.ustring.lower(title); -- switch title to lower case |
| + | for _, generic_title in ipairs (cfg.special_case_translation['generic_titles']) do --spin through the list of known generic title fragments |
| + | if title:find (generic_title['en'][1], 1, generic_title['en'][2]) then |
| + | return true; -- found English generic title so done |
| + | elseif generic_title['local'] then -- to keep work load down, generic_title['local'] should be nil except when there is a local version of the generic title |
| + | if mw.ustring.find (title, generic_title['local'][1], 1, generic_title['local'][2]) then -- mw.ustring() because might not be Latin script |
| + | return true; -- found local generic title so done |
| + | end |
| + | end |
| + | end |
| + | end |
| + | |
| + | |
| + | --[[--------------------------< I S _ A R C H I V E D _ C O P Y >---------------------------------------------- |
| + | |
| + | compares |title= to 'Archived copy' (place holder added by bots that can't find proper title); if matches, return true; nil else |
| + | |
| + | ]] |
| + | |
| + | local function is_archived_copy (title) |
| + | title = mw.ustring.lower(title); -- switch title to lower case |
| + | if title:find (cfg.special_case_translation.archived_copy.en) then -- if title is 'Archived copy' |
| + | return true; |
| + | elseif cfg.special_case_translation.archived_copy['local'] then |
| + | if mw.ustring.find (title, cfg.special_case_translation.archived_copy['local']) then -- mw.ustring() because might not be Latin script |
| + | return true; |
| + | end |
| + | end |
| + | end |
| + | |
| + | |
| + | --[[--------------------------< C I T A T I O N 0 >------------------------------------------------------------ |
| + | |
| + | This is the main function doing the majority of the citation formatting. |
| + | |
| + | ]] |
| + | |
| + | local function citation0( config, args) |
| --[[ | | --[[ |
| Load Input Parameters | | Load Input Parameters |
| The argument_wrapper facilitates the mapping of multiple aliases to single internal variable. | | The argument_wrapper facilitates the mapping of multiple aliases to single internal variable. |
| ]] | | ]] |
− | local A = argument_wrapper( args ); | + | local A = argument_wrapper ( args ); |
| local i | | local i |
| | | |
Sətir 2.156: |
Sətir 2.319: |
| -- define different field names for the same underlying things. | | -- define different field names for the same underlying things. |
| | | |
− | -- set default parameter values defined by |mode= parameter.
| + | local Mode = is_valid_parameter_value (A['Mode'], A:ORIGIN('Mode'), cfg.keywords_lists['mode'], ''); |
− | local Mode = A['Mode']; | |
− | if not is_valid_parameter_value (Mode, 'mode', cfg.keywords['mode']) then
| |
− | Mode = '';
| |
− | end
| |
| | | |
| local author_etal; | | local author_etal; |
| local a = {}; -- authors list from |lastn= / |firstn= pairs or |vauthors= | | local a = {}; -- authors list from |lastn= / |firstn= pairs or |vauthors= |
| local Authors; | | local Authors; |
− | local NameListFormat = A['NameListFormat']; | + | |
| + | local NameListStyle = is_valid_parameter_value (A['NameListStyle'], A:ORIGIN('NameListStyle'), cfg.keywords_lists['name-list-style'], ''); |
| local Collaboration = A['Collaboration']; | | local Collaboration = A['Collaboration']; |
| | | |
Sətir 2.173: |
Sətir 2.333: |
| a, author_etal = extract_names (args, 'AuthorList'); -- fetch author list from |authorn= / |lastn= / |firstn=, |author-linkn=, and |author-maskn= | | a, author_etal = extract_names (args, 'AuthorList'); -- fetch author list from |authorn= / |lastn= / |firstn=, |author-linkn=, and |author-maskn= |
| elseif 2 == selected then | | elseif 2 == selected then |
− | NameListFormat = 'vanc'; -- override whatever |name-list-format= might be | + | NameListStyle = 'vanc'; -- override whatever |name-list-style= might be |
| a, author_etal = parse_vauthors_veditors (args, args.vauthors, 'AuthorList'); -- fetch author list from |vauthors=, |author-linkn=, and |author-maskn= | | a, author_etal = parse_vauthors_veditors (args, args.vauthors, 'AuthorList'); -- fetch author list from |vauthors=, |author-linkn=, and |author-maskn= |
| elseif 3 == selected then | | elseif 3 == selected then |
| Authors = A['Authors']; -- use content of |authors= | | Authors = A['Authors']; -- use content of |authors= |
| + | if 'authors' == A:ORIGIN('Authors') then -- but add a maint cat if the parameter is |authors= |
| + | utilities.set_message ('maint_authors'); -- because use of this parameter is discouraged; what to do about the aliases is a TODO: |
| + | end |
| end | | end |
− | if is_set (Collaboration) then | + | if utilities.is_set (Collaboration) then |
| author_etal = true; -- so that |display-authors=etal not required | | author_etal = true; -- so that |display-authors=etal not required |
| end | | end |
Sətir 2.194: |
Sətir 2.357: |
| e, editor_etal = extract_names (args, 'EditorList'); -- fetch editor list from |editorn= / |editor-lastn= / |editor-firstn=, |editor-linkn=, and |editor-maskn= | | e, editor_etal = extract_names (args, 'EditorList'); -- fetch editor list from |editorn= / |editor-lastn= / |editor-firstn=, |editor-linkn=, and |editor-maskn= |
| elseif 2 == selected then | | elseif 2 == selected then |
− | NameListFormat = 'vanc'; -- override whatever |name-list-format= might be | + | NameListStyle = 'vanc'; -- override whatever |name-list-style= might be |
| e, editor_etal = parse_vauthors_veditors (args, args.veditors, 'EditorList'); -- fetch editor list from |veditors=, |editor-linkn=, and |editor-maskn= | | e, editor_etal = parse_vauthors_veditors (args, args.veditors, 'EditorList'); -- fetch editor list from |veditors=, |editor-linkn=, and |editor-maskn= |
| elseif 3 == selected then | | elseif 3 == selected then |
Sətir 2.214: |
Sətir 2.377: |
| local c = {}; -- contributors list from |contributor-lastn= / contributor-firstn= pairs | | local c = {}; -- contributors list from |contributor-lastn= / contributor-firstn= pairs |
| local Contributors; -- assembled contributors name list | | local Contributors; -- assembled contributors name list |
− | local Contribution = A['Contribution']; | + | |
− | if in_array(config.CitationClass, {"book","citation"}) and not is_set(A['Periodical']) then -- |contributor= and |contribution= only supported in book cites | + | local Chapter = A['Chapter']; -- done here so that we have access to |contribution= from |chapter= aliases |
| + | local Chapter_origin = A:ORIGIN ('Chapter'); |
| + | local Contribution; -- because contribution is required for contributor(s) |
| + | if 'contribution' == A:ORIGIN ('Chapter') then |
| + | Contribution = A['Chapter']; -- get the name of the contribution |
| + | end |
| + | |
| + | if utilities.in_array (config.CitationClass, {"book", "citation"}) and not utilities.is_set (A['Periodical']) then -- |contributor= and |contribution= only supported in book cites |
| c = extract_names (args, 'ContributorList'); -- fetch contributor list from |contributorn= / |contributor-lastn=, -firstn=, -linkn=, -maskn= | | c = extract_names (args, 'ContributorList'); -- fetch contributor list from |contributorn= / |contributor-lastn=, -firstn=, -linkn=, -maskn= |
| | | |
| if 0 < #c then | | if 0 < #c then |
− | if not is_set (Contribution) then -- |contributor= requires |contribution= | + | if not utilities.is_set (Contribution) then -- |contributor= requires |contribution= |
− | table.insert( z.message_tail, { set_error( 'contributor_missing_required_param', 'contribution')}); -- add missing contribution error message | + | table.insert( z.message_tail, { utilities.set_message ( 'err_contributor_missing_required_param', 'contribution')}); -- add missing contribution error message |
| c = {}; -- blank the contributors' table; it is used as a flag later | | c = {}; -- blank the contributors' table; it is used as a flag later |
| end | | end |
| if 0 == #a then -- |contributor= requires |author= | | if 0 == #a then -- |contributor= requires |author= |
− | table.insert( z.message_tail, { set_error( 'contributor_missing_required_param', 'author')}); -- add missing author error message | + | table.insert( z.message_tail, { utilities.set_message ( 'err_contributor_missing_required_param', 'author')}); -- add missing author error message |
| c = {}; -- blank the contributors' table; it is used as a flag later | | c = {}; -- blank the contributors' table; it is used as a flag later |
| end | | end |
| end | | end |
| else -- if not a book cite | | else -- if not a book cite |
− | if select_one (args, cfg.aliases['ContributorList-Last'], 'redundant_parameters', 1 ) then -- are there contributor name list parameters? | + | if utilities.select_one (args, cfg.aliases['ContributorList-Last'], 'err_redundant_parameters', 1 ) then -- are there contributor name list parameters? |
− | table.insert( z.message_tail, { set_error( 'contributor_ignored')}); -- add contributor ignored error message | + | table.insert( z.message_tail, { utilities.set_message ( 'err_contributor_ignored')}); -- add contributor ignored error message |
| end | | end |
| Contribution = nil; -- unset | | Contribution = nil; -- unset |
| end | | end |
| | | |
− | if not is_valid_parameter_value (NameListFormat, 'name-list-format', cfg.keywords['name-list-format']) then -- only accepted value for this parameter is 'vanc' | + | if utilities.is_set (Others) then |
− | NameListFormat = ''; -- anything else, set to empty string | + | if 0 == #a and 0 == #e then -- add maint cat when |others= has value and used without |author=, |editor= |
| + | utilities.set_message ('maint_others'); |
| + | end |
| end | | end |
| | | |
| local Year = A['Year']; | | local Year = A['Year']; |
| local PublicationDate = A['PublicationDate']; | | local PublicationDate = A['PublicationDate']; |
− | local OrigYear = A['OrigYear']; | + | local OrigDate = A['OrigDate']; |
| local Date = A['Date']; | | local Date = A['Date']; |
| local LayDate = A['LayDate']; | | local LayDate = A['LayDate']; |
Sətir 2.250: |
Sətir 2.422: |
| local Conference = A['Conference']; | | local Conference = A['Conference']; |
| local TransTitle = A['TransTitle']; | | local TransTitle = A['TransTitle']; |
| + | local TransTitle_origin = A:ORIGIN ('TransTitle'); |
| local TitleNote = A['TitleNote']; | | local TitleNote = A['TitleNote']; |
| local TitleLink = A['TitleLink']; | | local TitleLink = A['TitleLink']; |
− | link_title_ok (TitleLink, A:ORIGIN ('TitleLink'), Title, 'title'); -- check for wikimarkup in |title-link= or wikimarkup in |title= when |title-link= is set
| |
| | | |
− | local Chapter = A['Chapter']; | + | local auto_select = ''; -- default is auto |
| + | local accept_link; |
| + | TitleLink, accept_link = utilities.has_accept_as_written(TitleLink, true); -- test for accept-this-as-written markup |
| + | if (not accept_link) and utilities.in_array (TitleLink, {'none', 'pmc', 'doi'}) then -- check for special keywords |
| + | auto_select = TitleLink; -- remember selection for later |
| + | TitleLink = ''; -- treat as if |title-link= would have been empty |
| + | end |
| + | |
| + | TitleLink = link_title_ok (TitleLink, A:ORIGIN ('TitleLink'), Title, 'title'); -- check for wiki-markup in |title-link= or wiki-markup in |title= when |title-link= is set |
| + | |
| + | local Section = ''; -- {{cite map}} only; preset to empty string for concatenation if not used |
| + | if 'map' == config.CitationClass and 'section' == A:ORIGIN ('Chapter') then |
| + | Section = A['Chapter']; -- get |section= from |chapter= alias list; |chapter= and the other aliases not supported in {{cite map}} |
| + | Chapter = ''; -- unset for now; will be reset later from |map= if present |
| + | end |
| + | |
| local ScriptChapter = A['ScriptChapter']; | | local ScriptChapter = A['ScriptChapter']; |
− | local ScriptChapterOrigin = A:ORIGIN ('ScriptChapter'); | + | local ScriptChapter_origin = A:ORIGIN ('ScriptChapter'); |
− | local ChapterLink -- = A['ChapterLink']; -- deprecated as a parameter but still used internally by cite episode | + | local ChapterLink -- = A['ChapterLink']; -- deprecated as a parameter but still used internally by cite episode |
| local TransChapter = A['TransChapter']; | | local TransChapter = A['TransChapter']; |
| + | local TransChapter_origin = A:ORIGIN ('TransChapter'); |
| local TitleType = A['TitleType']; | | local TitleType = A['TitleType']; |
| local Degree = A['Degree']; | | local Degree = A['Degree']; |
Sətir 2.269: |
Sətir 2.457: |
| ArchiveURL, ArchiveDate = archive_url_check (A['ArchiveURL'], A['ArchiveDate']) | | ArchiveURL, ArchiveDate = archive_url_check (A['ArchiveURL'], A['ArchiveDate']) |
| | | |
− | local UrlStatus = A['UrlStatus']; | + | local UrlStatus = is_valid_parameter_value (A['UrlStatus'], A:ORIGIN('UrlStatus'), cfg.keywords_lists['url-status'], ''); |
− | if 'url-status' == A:ORIGIN ('UrlStatus') then -- interim: TODO: this line goes away
| + | |
− | if not is_valid_parameter_value (UrlStatus, 'url-status', cfg.keywords ['url-status']) then -- set in config.defaults to 'dead'
| |
− | UrlStatus = ''; -- anything else, set to empty string
| |
− | end -- interim: TODO: this line goes away
| |
− | elseif is_set (A:ORIGIN ('UrlStatus')) then -- interim: while both |dead-url= and |url-status= allowed use separate keyword lists; TODO: remove this section
| |
− | if not is_valid_parameter_value (UrlStatus, A:ORIGIN ('UrlStatus'), cfg.keywords ['deadurl']) then -- interim: assume |dead-url=; use those keywords; TODO: this line goes away
| |
− | UrlStatus = ''; -- anything else, set to empty string; interim: TODO: this line goes away
| |
− | end -- interim: TODO: this line goes away
| |
− | end -- interim: TODO: this line goes away
| |
− |
| |
− | if in_array (UrlStatus, {'yes', 'true', 'y'}) then -- TODO: remove this whole thing when |dead-url=[yes|no] parameters removed from articles
| |
− | UrlStatus = 'dead';
| |
− | elseif 'no' == UrlStatus then
| |
− | UrlStatus = 'live';
| |
− | end
| |
− |
| |
| local URL = A['URL'] | | local URL = A['URL'] |
− | local URLorigin = A:ORIGIN('URL'); -- get name of parameter that holds URL | + | local URL_origin = A:ORIGIN('URL'); -- get name of parameter that holds URL |
| local ChapterURL = A['ChapterURL']; | | local ChapterURL = A['ChapterURL']; |
− | local ChapterURLorigin = A:ORIGIN('ChapterURL'); -- get name of parameter that holds ChapterURL | + | local ChapterURL_origin = A:ORIGIN('ChapterURL'); -- get name of parameter that holds ChapterURL |
| local ConferenceFormat = A['ConferenceFormat']; | | local ConferenceFormat = A['ConferenceFormat']; |
| local ConferenceURL = A['ConferenceURL']; | | local ConferenceURL = A['ConferenceURL']; |
− | local ConferenceURLorigin = A:ORIGIN('ConferenceURL'); -- get name of parameter that holds ConferenceURL | + | local ConferenceURL_origin = A:ORIGIN('ConferenceURL'); -- get name of parameter that holds ConferenceURL |
| + | |
| local Periodical = A['Periodical']; | | local Periodical = A['Periodical']; |
| local Periodical_origin = ''; | | local Periodical_origin = ''; |
− | if is_set (Periodical) then
| + | if utilities.is_set (Periodical) then |
− | Periodical_origin = A:ORIGIN('Periodical'); -- get the name of the periodical parameter
| + | Periodical_origin = A:ORIGIN('Periodical'); -- get the name of the periodical parameter |
− | local i;
| + | local i; |
− | Periodical, i = strip_apostrophe_markup (Periodical); -- strip appostrophe markup so that metadata isn't contaminated
| + | Periodical, i = utilities.strip_apostrophe_markup (Periodical); -- strip apostrophe markup so that metadata isn't contaminated |
− | if i then -- non-zero when markup was stripped so emit an error message
| + | if i then -- non-zero when markup was stripped so emit an error message |
− | table.insert( z.message_tail, {set_error ('apostrophe_markup', {Periodical_origin}, true)});
| + | table.insert( z.message_tail, {utilities.set_message ('err_apostrophe_markup', {Periodical_origin}, true)}); |
− | end | + | end |
| + | end |
| + | |
| + | if 'mailinglist' == config.CitationClass then -- special case for {{cite mailing list}} |
| + | if utilities.is_set (Periodical) and utilities.is_set (A ['MailingList']) then -- both set emit an error |
| + | table.insert( z.message_tail, {utilities.set_message ('err_redundant_parameters', {utilities.wrap_style ('parameter', Periodical_origin) .. ' and ' .. utilities.wrap_style ('parameter', 'mailinglist')}, true )}); |
| end | | end |
| + | |
| + | Periodical = A ['MailingList']; -- error or no, set Periodical to |mailinglist= value because this template is {{cite mailing list}} |
| + | Periodical_origin = A:ORIGIN('MailingList'); |
| + | end |
| | | |
| local ScriptPeriodical = A['ScriptPeriodical']; | | local ScriptPeriodical = A['ScriptPeriodical']; |
| local ScriptPeriodical_origin = A:ORIGIN('ScriptPeriodical'); | | local ScriptPeriodical_origin = A:ORIGIN('ScriptPeriodical'); |
− | -- web and news not tested for now because of
| + | |
− | -- Wikipedia:Administrators%27_noticeboard#Is_there_a_semi-automated_tool_that_could_fix_these_annoying_"Cite_Web"_errors?
| + | -- web and news not tested for now because of |
| + | -- Wikipedia:Administrators%27_noticeboard#Is_there_a_semi-automated_tool_that_could_fix_these_annoying_"Cite_Web"_errors? |
| + | if not (utilities.is_set (Periodical) or utilities.is_set (ScriptPeriodical)) then -- 'periodical' templates require periodical parameter |
| + | -- local p = {['journal'] = 'journal', ['magazine'] = 'magazine', ['news'] = 'newspaper', ['web'] = 'website'}; -- for error message |
| + | local p = {['journal'] = 'journal', ['magazine'] = 'magazine'}; -- for error message |
| + | if p[config.CitationClass] then |
| + | table.insert( z.message_tail, {utilities.set_message ('err_missing_periodical', {config.CitationClass, p[config.CitationClass]}, true)}); |
| + | end |
| + | end |
| | | |
| local TransPeriodical = A['TransPeriodical']; | | local TransPeriodical = A['TransPeriodical']; |
| + | local TransPeriodical_origin = A:ORIGIN ('TransPeriodical'); |
| | | |
| local Series = A['Series']; | | local Series = A['Series']; |
Sətir 2.320: |
Sətir 2.512: |
| | | |
| if 'citation' == config.CitationClass then | | if 'citation' == config.CitationClass then |
− | if is_set (Periodical) then | + | if utilities.is_set (Periodical) then |
− | if not in_array (Periodical_origin, {'website', 'mailinglist'}) then -- {{citation}} does not render volume for these 'periodicals' | + | if not utilities.in_array (Periodical_origin, {'website', 'mailinglist'}) then -- {{citation}} does not render volume for these 'periodicals' |
| Volume = A['Volume']; -- but does for all other 'periodicals' | | Volume = A['Volume']; -- but does for all other 'periodicals' |
| end | | end |
− | elseif is_set (ScriptPeriodical) then | + | elseif utilities.is_set (ScriptPeriodical) then |
| if 'script-website' ~= ScriptPeriodical_origin then -- {{citation}} does not render volume for |script-website= | | if 'script-website' ~= ScriptPeriodical_origin then -- {{citation}} does not render volume for |script-website= |
| Volume = A['Volume']; -- but does for all other 'periodicals' | | Volume = A['Volume']; -- but does for all other 'periodicals' |
Sətir 2.331: |
Sətir 2.523: |
| Volume = A['Volume']; -- and does for non-'periodical' cites | | Volume = A['Volume']; -- and does for non-'periodical' cites |
| end | | end |
− | elseif in_array (config.CitationClass, cfg.templates_using_volume) then -- render |volume= for cs1 according to the configuration settings | + | elseif utilities.in_array (config.CitationClass, cfg.templates_using_volume) then -- render |volume= for cs1 according to the configuration settings |
| Volume = A['Volume']; | | Volume = A['Volume']; |
| end | | end |
| | | |
| if 'citation' == config.CitationClass then | | if 'citation' == config.CitationClass then |
− | if is_set (Periodical) and in_array (Periodical_origin, {'journal', 'magazine', 'newspaper', 'periodical', 'work'}) or -- {{citation}} renders issue for these 'periodicals' | + | if utilities.is_set (Periodical) and utilities.in_array (Periodical_origin, {'journal', 'magazine', 'newspaper', 'periodical', 'work'}) or -- {{citation}} renders issue for these 'periodicals' |
− | is_set (ScriptPeriodical) and in_array (ScriptPeriodical_origin, {'script-journal', 'script-magazine', 'script-newspaper', 'script-periodical', 'script-work'}) then -- and these 'script-periodicals' | + | utilities.is_set (ScriptPeriodical) and utilities.in_array (ScriptPeriodical_origin, {'script-journal', 'script-magazine', 'script-newspaper', 'script-periodical', 'script-work'}) then -- and these 'script-periodicals' |
| Issue = hyphen_to_dash (A['Issue']); | | Issue = hyphen_to_dash (A['Issue']); |
| end | | end |
− | elseif in_array (config.CitationClass, cfg.templates_using_issue) then -- conference & map books do not support issue; {{citation}} listed here because included in settings table | + | elseif utilities.in_array (config.CitationClass, cfg.templates_using_issue) then -- conference & map books do not support issue; {{citation}} listed here because included in settings table |
− | if not (in_array (config.CitationClass, {'conference', 'map', 'citation'}) and not (is_set (Periodical) or is_set (ScriptPeriodical))) then | + | if not (utilities.in_array (config.CitationClass, {'conference', 'map', 'citation'}) and not (utilities.is_set (Periodical) or utilities.is_set (ScriptPeriodical))) then |
| Issue = hyphen_to_dash (A['Issue']); | | Issue = hyphen_to_dash (A['Issue']); |
| end | | end |
Sətir 2.347: |
Sətir 2.539: |
| | | |
| local Position = ''; | | local Position = ''; |
− | if not in_array (config.CitationClass, cfg.templates_not_using_page) then | + | if not utilities.in_array (config.CitationClass, cfg.templates_not_using_page) then |
| Page = A['Page']; | | Page = A['Page']; |
| Pages = hyphen_to_dash (A['Pages']); | | Pages = hyphen_to_dash (A['Pages']); |
Sətir 2.354: |
Sətir 2.546: |
| | | |
| local Edition = A['Edition']; | | local Edition = A['Edition']; |
− | local PublicationPlace = A['PublicationPlace'] | + | local PublicationPlace = place_check (A['PublicationPlace'], A:ORIGIN('PublicationPlace')); |
− | local Place = A['Place']; | + | local Place = place_check (A['Place'], A:ORIGIN('Place')); |
| | | |
| local PublisherName = A['PublisherName']; | | local PublisherName = A['PublisherName']; |
| local PublisherName_origin = A:ORIGIN('PublisherName'); | | local PublisherName_origin = A:ORIGIN('PublisherName'); |
− | if is_set (PublisherName) then
| + | if utilities.is_set (PublisherName) then |
− | local i=0;
| + | local i = 0; |
− | PublisherName, i = strip_apostrophe_markup (PublisherName); -- strip appostrophe markup so that metadata isn't contaminated; publisher is never italicized
| + | PublisherName, i = utilities.strip_apostrophe_markup (PublisherName); -- strip apostrophe markup so that metadata isn't contaminated; publisher is never italicized |
| + | if i then -- non-zero when markup was stripped so emit an error message |
| + | table.insert( z.message_tail, {utilities.set_message ('err_apostrophe_markup', {PublisherName_origin}, true)}); |
| + | end |
| + | end |
| | | |
− | if i then -- non-zero when markup was stripped so emit an error message
| + | local Newsgroup = A['Newsgroup']; -- TODO: strip apostrophe markup? |
− | table.insert( z.message_tail, {set_error ('apostrophe_markup', {PublisherName_origin}, true)});
| + | local Newsgroup_origin = A:ORIGIN('Newsgroup'); |
− | end
| |
− | end
| |
| | | |
− | local RegistrationRequired = A['RegistrationRequired']; | + | if 'newsgroup' == config.CitationClass then |
− | if not is_valid_parameter_value (RegistrationRequired, 'registration', cfg.keywords ['yes_true_y']) then | + | if utilities.is_set (PublisherName) then -- general use parameter |publisher= not allowed in cite newsgroup |
− | RegistrationRequired=nil; | + | local error_text, error_state = utilities.set_message ('err_parameter_ignored', {PublisherName_origin}, true); |
| + | if utilities.is_set (error_text) then |
| + | table.insert( z.message_tail, {error_text, error_state} ); |
| + | end |
| end | | end |
| | | |
− | local SubscriptionRequired = A['SubscriptionRequired'];
| + | PublisherName = nil; -- ensure that this parameter is unset for the time being; will be used again after COinS |
− | if not is_valid_parameter_value (SubscriptionRequired, 'subscription', cfg.keywords ['yes_true_y']) then | + | end |
− | SubscriptionRequired=nil;
| |
− | end
| |
| | | |
− | local UrlAccess = A['UrlAccess']; | + | local UrlAccess = is_valid_parameter_value (A['UrlAccess'], A:ORIGIN('UrlAccess'), cfg.keywords_lists['url-access'], nil); |
− | if not is_valid_parameter_value (UrlAccess, 'url-access', cfg.keywords ['url-access']) then
| + | if not utilities.is_set (URL) and utilities.is_set (UrlAccess) then |
− | UrlAccess = nil;
| |
− | end
| |
− | if not is_set(URL) and is_set(UrlAccess) then | |
| UrlAccess = nil; | | UrlAccess = nil; |
− | table.insert( z.message_tail, { set_error( 'param_access_requires_param', {'url'}, true ) } ); | + | table.insert( z.message_tail, { utilities.set_message ( 'err_param_access_requires_param', {'url'}, true ) } ); |
| end | | end |
| | | |
− | if is_set (UrlAccess) and is_set (SubscriptionRequired) then -- while not aliases, these are much the same so if both are set
| + | local ChapterUrlAccess = is_valid_parameter_value (A['ChapterUrlAccess'], A:ORIGIN('ChapterUrlAccess'), cfg.keywords_lists['url-access'], nil); |
− | table.insert( z.message_tail, { set_error( 'redundant_parameters', {wrap_style ('parameter', 'url-access') .. ' and ' .. wrap_style ('parameter', 'subscription')}, true ) } ); -- add error message
| + | if not utilities.is_set (ChapterURL) and utilities.is_set (ChapterUrlAccess) then |
− | SubscriptionRequired = nil; -- unset; prefer |access= over |subscription=
| + | ChapterUrlAccess = nil; |
− | end
| + | table.insert( z.message_tail, { utilities.set_message ( 'err_param_access_requires_param', {A:ORIGIN('ChapterUrlAccess'):gsub ('%-access', '')}, true ) } ); |
− | if is_set (UrlAccess) and is_set (RegistrationRequired) then -- these are not the same but contradictory so if both are set
| + | end |
− | table.insert( z.message_tail, { set_error( 'redundant_parameters', {wrap_style ('parameter', 'url-access') .. ' and ' .. wrap_style ('parameter', 'registration')}, true ) } ); -- add error message
| |
− | RegistrationRequired = nil; -- unset; prefer |access= over |registration=
| |
− | end
| |
| | | |
− | local ChapterUrlAccess = A['ChapterUrlAccess']; | + | local MapUrlAccess = is_valid_parameter_value (A['MapUrlAccess'], A:ORIGIN('MapUrlAccess'), cfg.keywords_lists['url-access'], nil); |
− | if not is_valid_parameter_value (ChapterUrlAccess, A:ORIGIN('ChapterUrlAccess'), cfg.keywords ['url-access']) then -- same as url-access
| + | if not utilities.is_set (A['MapURL']) and utilities.is_set (MapUrlAccess) then |
− | ChapterUrlAccess = nil;
| + | MapUrlAccess = nil; |
− | end
| + | table.insert( z.message_tail, { utilities.set_message ( 'err_param_access_requires_param', {'map-url'}, true ) } ); |
− | if not is_set(ChapterURL) and is_set(ChapterUrlAccess) then
| + | end |
− | ChapterUrlAccess = nil;
| |
− | table.insert( z.message_tail, { set_error( 'param_access_requires_param', {A:ORIGIN('ChapterUrlAccess'):gsub ('%-access', '')}, true ) } );
| |
− | end
| |
− | | |
− | local MapUrlAccess = A['MapUrlAccess']; | |
− | if not is_valid_parameter_value (MapUrlAccess, 'map-url-access', cfg.keywords ['url-access']) then
| |
− | MapUrlAccess = nil;
| |
− | end
| |
− | if not is_set(A['MapURL']) and is_set(MapUrlAccess) then
| |
− | MapUrlAccess = nil;
| |
− | table.insert( z.message_tail, { set_error( 'param_access_requires_param', {'map-url'}, true ) } );
| |
− | end
| |
| | | |
| local Via = A['Via']; | | local Via = A['Via']; |
Sətir 2.424: |
Sətir 2.601: |
| local ID = A['ID']; | | local ID = A['ID']; |
| local ASINTLD = A['ASINTLD']; | | local ASINTLD = A['ASINTLD']; |
− | local IgnoreISBN = A['IgnoreISBN']; | + | local IgnoreISBN = is_valid_parameter_value (A['IgnoreISBN'], A:ORIGIN('IgnoreISBN'), cfg.keywords_lists['yes_true_y'], nil); |
− | if not is_valid_parameter_value (IgnoreISBN, 'ignore-isbn-error', cfg.keywords ['yes_true_y']) then
| |
− | IgnoreISBN = nil; -- anything else, set to empty string
| |
− | end
| |
| local Embargo = A['Embargo']; | | local Embargo = A['Embargo']; |
| local Class = A['Class']; -- arxiv class identifier | | local Class = A['Class']; -- arxiv class identifier |
− |
| |
− | local ID_list = extract_ids( args );
| |
− | if is_set (DoiBroken) and not ID_list['DOI'] then
| |
− | table.insert( z.message_tail, { set_error( 'doibroken_missing_doi', A:ORIGIN('DoiBroken'))});
| |
− | end
| |
− | local ID_access_levels = extract_id_access_levels( args, ID_list );
| |
| | | |
| local Quote = A['Quote']; | | local Quote = A['Quote']; |
| + | local QuotePage = A['QuotePage']; |
| + | local QuotePages = A['QuotePages']; |
| + | local ScriptQuote = A['ScriptQuote']; |
| + | local TransQuote = A['TransQuote']; |
| | | |
| local LayFormat = A['LayFormat']; | | local LayFormat = A['LayFormat']; |
Sətir 2.445: |
Sətir 2.617: |
| local TranscriptFormat = A['TranscriptFormat']; | | local TranscriptFormat = A['TranscriptFormat']; |
| local TranscriptURL = A['TranscriptURL'] | | local TranscriptURL = A['TranscriptURL'] |
− | local TranscriptURLorigin = A:ORIGIN('TranscriptURL'); -- get name of parameter that holds TranscriptURL | + | local TranscriptURL_origin = A:ORIGIN('TranscriptURL'); -- get name of parameter that holds TranscriptURL |
| | | |
− | local LastAuthorAmp = A['LastAuthorAmp']; | + | local LastAuthorAmp = is_valid_parameter_value (A['LastAuthorAmp'], A:ORIGIN('LastAuthorAmp'), cfg.keywords_lists['yes_true_y'], nil); |
− | if not is_valid_parameter_value (LastAuthorAmp, 'last-author-amp', cfg.keywords ['yes_true_y']) then
| |
− | LastAuthorAmp = nil; -- set to empty string
| |
− | end
| |
− | | |
− | local no_tracking_cats = A['NoTracking'];
| |
− | if not is_valid_parameter_value (no_tracking_cats, 'no-tracking', cfg.keywords ['yes_true_y']) then
| |
− | no_tracking_cats = nil; -- set to empty string
| |
− | end
| |
| | | |
| + | local no_tracking_cats = is_valid_parameter_value (A['NoTracking'], A:ORIGIN('NoTracking'), cfg.keywords_lists['yes_true_y'], nil); |
| + | if 'nocat' == A:ORIGIN('NoTracking') then |
| + | utilities.set_message ('maint_nocat'); -- this one so that we get the message; see main categorization at end of citation0() |
| + | end |
| + | |
| --local variables that are not cs1 parameters | | --local variables that are not cs1 parameters |
| local use_lowercase; -- controls capitalization of certain static text | | local use_lowercase; -- controls capitalization of certain static text |
Sətir 2.463: |
Sətir 2.632: |
| local COinS_date = {}; -- holds date info extracted from |date= for the COinS metadata by Module:Date verification | | local COinS_date = {}; -- holds date info extracted from |date= for the COinS metadata by Module:Date verification |
| | | |
− | local DF = A['DF']; -- date format set in cs1|2 template | + | local DF = is_valid_parameter_value (A['DF'], A:ORIGIN('DF'), cfg.keywords_lists['df'], ''); |
− | if not is_valid_parameter_value (DF, 'df', cfg.keywords['date-format']) then -- validate reformatting keyword
| + | if not utilities.is_set (DF) then |
− | DF = ''; -- not valid, set to empty string
| + | DF = cfg.global_df; -- local |df= if present overrides global df set by {{use xxx date}} template |
− | end
| |
− | if not is_set (DF) then | |
− | DF = cfg.global_df; | |
| end | | end |
| | | |
| local sepc; -- separator between citation elements for CS1 a period, for CS2, a comma | | local sepc; -- separator between citation elements for CS1 a period, for CS2, a comma |
| local PostScript; | | local PostScript; |
− | local Ref; | + | local Ref = A['Ref']; |
− | sepc, PostScript, Ref = set_style (Mode:lower(), A['PostScript'], A['Ref'], config.CitationClass); | + | if 'harv' == Ref then |
− | use_lowercase = ( sepc == ',' ); -- used to control capitalization for certain static text | + | utilities.set_message ('maint_ref_harv'); -- add maint cat to identify templates that have this now-extraneous param value |
| + | elseif not utilities.is_set (Ref) then |
| + | Ref = 'harv'; -- set as default when not set externally |
| + | end |
| + | |
| + | sepc, PostScript, Ref = set_style (Mode:lower(), A['PostScript'], Ref, config.CitationClass); |
| + | use_lowercase = ( sepc == ',' ); -- used to control capitalization for certain static text |
| | | |
− | --check this page to see if it is in one of the namespaces that cs1 is not supposed to add to the error categories | + | -- check this page to see if it is in one of the namespaces that cs1 is not supposed to add to the error categories |
− | if not is_set (no_tracking_cats) then -- ignore if we are already not going to categorize this page | + | if not utilities.is_set (no_tracking_cats) then -- ignore if we are already not going to categorize this page |
− | if in_array (this_page.nsText, cfg.uncategorized_namespaces) then | + | if utilities.in_array (this_page.nsText, cfg.uncategorized_namespaces) then |
| no_tracking_cats = "true"; -- set no_tracking_cats | | no_tracking_cats = "true"; -- set no_tracking_cats |
| end | | end |
− | for _,v in ipairs (cfg.uncategorized_subpages) do -- cycle through page name patterns | + | for _, v in ipairs (cfg.uncategorized_subpages) do -- cycle through page name patterns |
| if this_page.text:match (v) then -- test page name against each pattern | | if this_page.text:match (v) then -- test page name against each pattern |
| no_tracking_cats = "true"; -- set no_tracking_cats | | no_tracking_cats = "true"; -- set no_tracking_cats |
Sətir 2.489: |
Sətir 2.661: |
| end | | end |
| end | | end |
− | | + | -- check for extra |page=, |pages= or |at= parameters. (also sheet and sheets while we're at it) |
− | -- check for extra |page=, |pages= or |at= parameters. (also sheet and sheets while we're at it)
| + | utilities.select_one (args, {'page', 'p', 'pp', 'pages', 'at', 'sheet', 'sheets'}, 'err_redundant_parameters'); -- this is a dummy call simply to get the error message and category |
− | select_one( args, {'page', 'p', 'at', 'sheet', 'sheets'}, 'redundant_parameters' ); -- this is a dummy call simply to get the error message and category | |
| | | |
| local coins_pages; | | local coins_pages; |
Sətir 2.497: |
Sətir 2.668: |
| Page, Pages, At, coins_pages = insource_loc_get (Page, Pages, At); | | Page, Pages, At, coins_pages = insource_loc_get (Page, Pages, At); |
| | | |
− | local NoPP = A['NoPP'] | + | local NoPP = is_valid_parameter_value (A['NoPP'], A:ORIGIN('NoPP'), cfg.keywords_lists['yes_true_y'], nil); |
− | if is_set (NoPP) and is_valid_parameter_value (NoPP, 'nopp', cfg.keywords ['yes_true_y']) then
| |
− | NoPP = true;
| |
− | else
| |
− | NoPP = nil; -- unset, used as a flag later
| |
− | end
| |
| | | |
− | if not is_set(PublicationPlace) and is_set(Place) then -- both |publication-place= and |place= (|location=) allowed if different | + | if utilities.is_set (PublicationPlace) and utilities.is_set (Place) then -- both |publication-place= and |place= (|location=) allowed if different |
| + | utilities.add_prop_cat ('location test'); -- add property cat to evaluate how often PublicationPlace and Place are used together |
| + | if PublicationPlace == Place then |
| + | Place = ''; -- unset; don't need both if they are the same |
| + | end |
| + | elseif not utilities.is_set (PublicationPlace) and utilities.is_set (Place) then -- when only |place= (|location=) is set ... |
| PublicationPlace = Place; -- promote |place= (|location=) to |publication-place | | PublicationPlace = Place; -- promote |place= (|location=) to |publication-place |
| end | | end |
− |
| + | |
| if PublicationPlace == Place then Place = ''; end -- don't need both if they are the same | | if PublicationPlace == Place then Place = ''; end -- don't need both if they are the same |
| | | |
Sətir 2.513: |
Sətir 2.684: |
| Parameter remapping for cite encyclopedia: | | Parameter remapping for cite encyclopedia: |
| When the citation has these parameters: | | When the citation has these parameters: |
− | |encyclopedia and |title then map |title to |article and |encyclopedia to |title | + | |encyclopedia= and |title= then map |title= to |article= and |encyclopedia= to |title= |
− | |encyclopedia and |article then map |encyclopedia to |title | + | |encyclopedia= and |article= then map |encyclopedia= to |title= |
| | | |
− | |trans-title maps to |trans-chapter when |title is re-mapped | + | |trans-title= maps to |trans-chapter= when |title= is re-mapped |
− | |url maps to |chapterurl when |title is remapped | + | |url= maps to |chapter-url= when |title= is remapped |
| | | |
− | All other combinations of |encyclopedia, |title, and |article are not modified | + | All other combinations of |encyclopedia=, |title=, and |article= are not modified |
| | | |
| ]] | | ]] |
| | | |
− | local Encyclopedia = A['Encyclopedia']; | + | local Encyclopedia = A['Encyclopedia']; -- used as a flag by this module and by ~/COinS |
| | | |
− | if ( config.CitationClass == "encyclopaedia" ) or ( config.CitationClass == "citation" and is_set (Encyclopedia)) then -- test code for citation | + | if utilities.is_set (Encyclopedia) then -- emit error message when Encyclopedia set but template is other than {{cite encyclopedia}} or {{citation}} |
− | if is_set (Periodical) then -- Periodical is set when |encyclopedia is set | + | if 'encyclopaedia' ~= config.CitationClass and 'citation' ~= config.CitationClass then |
− | if is_set(Title) or is_set (ScriptTitle) then | + | table.insert (z.message_tail, {utilities.set_message ('err_parameter_ignored', {A:ORIGIN ('Encyclopedia')}, true)}); |
− | if not is_set(Chapter) then | + | Encyclopedia = nil; -- unset because not supported by this template |
− | Chapter = Title; -- |encyclopedia and |title are set so map |title to |article and |encyclopedia to |title | + | end |
| + | end |
| + | |
| + | if ('encyclopaedia' == config.CitationClass) or ('citation' == config.CitationClass and utilities.is_set (Encyclopedia)) then |
| + | if utilities.is_set (Periodical) and utilities.is_set (Encyclopedia) then -- when both set emit an error |
| + | table.insert (z.message_tail, {utilities.set_message ('err_redundant_parameters', {utilities.wrap_style ('parameter', A:ORIGIN ('Encyclopedia')) .. ' and ' .. utilities.wrap_style ('parameter', Periodical_origin)}, true )}); |
| + | end |
| + | |
| + | if utilities.is_set (Encyclopedia) then |
| + | Periodical = Encyclopedia; -- error or no, set Periodical to Encyclopedia; allow periodical without encyclopedia |
| + | Periodical_origin = A:ORIGIN ('Encyclopedia'); |
| + | end |
| + | |
| + | if utilities.is_set (Periodical) then -- Periodical is set when |encyclopedia= is set |
| + | if utilities.is_set (Title) or utilities.is_set (ScriptTitle) then |
| + | if not utilities.is_set (Chapter) then |
| + | Chapter = Title; -- |encyclopedia= and |title= are set so map |title= to |article= and |encyclopedia= to |title= |
| ScriptChapter = ScriptTitle; | | ScriptChapter = ScriptTitle; |
− | ScriptChapterOrigin = 'title'; | + | ScriptChapter_origin = A:ORIGIN('ScriptTitle') |
| TransChapter = TransTitle; | | TransChapter = TransTitle; |
| ChapterURL = URL; | | ChapterURL = URL; |
| + | ChapterURL_origin = A:ORIGIN('URL') |
| + | |
| ChapterUrlAccess = UrlAccess; | | ChapterUrlAccess = UrlAccess; |
| | | |
− | if not is_set (ChapterURL) and is_set (TitleLink) then | + | if not utilities.is_set (ChapterURL) and utilities.is_set (TitleLink) then |
− | Chapter = make_wikilink (TitleLink, Chapter); | + | Chapter = utilities.make_wikilink (TitleLink, Chapter); |
| end | | end |
| Title = Periodical; | | Title = Periodical; |
Sətir 2.548: |
Sətir 2.737: |
| ScriptTitle = ''; | | ScriptTitle = ''; |
| end | | end |
− | elseif is_set (Chapter) then -- |title not set | + | elseif utilities.is_set (Chapter) then -- |title= not set |
− | Title = Periodical; -- |encyclopedia set and |article set so map |encyclopedia to |title | + | Title = Periodical; -- |encyclopedia= set and |article= set so map |encyclopedia= to |title= |
| Periodical = ''; -- redundant so unset | | Periodical = ''; -- redundant so unset |
| end | | end |
Sətir 2.555: |
Sətir 2.744: |
| end | | end |
| | | |
− | -- Special case for cite techreport. | + | -- special case for cite techreport. |
| if (config.CitationClass == "techreport") then -- special case for cite techreport | | if (config.CitationClass == "techreport") then -- special case for cite techreport |
− | if is_set(A['Number']) then -- cite techreport uses 'number', which other citations alias to 'issue' | + | if utilities.is_set (A['Number']) then -- cite techreport uses 'number', which other citations alias to 'issue' |
− | if not is_set(ID) then -- can we use ID for the "number"? | + | if not utilities.is_set (ID) then -- can we use ID for the "number"? |
| ID = A['Number']; -- yes, use it | | ID = A['Number']; -- yes, use it |
| else -- ID has a value so emit error message | | else -- ID has a value so emit error message |
− | table.insert( z.message_tail, { set_error('redundant_parameters', {wrap_style ('parameter', 'id') .. ' and ' .. wrap_style ('parameter', 'number')}, true )}); | + | table.insert( z.message_tail, { utilities.set_message ('err_redundant_parameters', {utilities.wrap_style ('parameter', 'id') .. ' and ' .. utilities.wrap_style ('parameter', 'number')}, true )}); |
| end | | end |
| end | | end |
− | end
| |
− |
| |
− | -- special case for cite mailing list
| |
− | if (config.CitationClass == "mailinglist") then
| |
− | Periodical = A ['MailingList'];
| |
− | elseif 'mailinglist' == Periodical_origin then
| |
− | Periodical = ''; -- unset because mailing list is only used for cite mailing list
| |
| end | | end |
| | | |
| -- Account for the oddity that is {{cite conference}}, before generation of COinS data. | | -- Account for the oddity that is {{cite conference}}, before generation of COinS data. |
| if 'conference' == config.CitationClass then | | if 'conference' == config.CitationClass then |
− | if is_set(BookTitle) then | + | if utilities.is_set (BookTitle) then |
| Chapter = Title; | | Chapter = Title; |
− | -- ChapterLink = TitleLink; -- |chapterlink= is deprecated | + | Chapter_origin = 'title'; |
| + | -- ChapterLink = TitleLink; -- |chapter-link= is deprecated |
| ChapterURL = URL; | | ChapterURL = URL; |
| ChapterUrlAccess = UrlAccess; | | ChapterUrlAccess = UrlAccess; |
− | ChapterURLorigin = URLorigin; | + | ChapterURL_origin = URL_origin; |
− | URLorigin = ''; | + | URL_origin = ''; |
| ChapterFormat = Format; | | ChapterFormat = Format; |
| TransChapter = TransTitle; | | TransChapter = TransTitle; |
| + | TransChapter_origin = TransTitle_origin; |
| Title = BookTitle; | | Title = BookTitle; |
| Format = ''; | | Format = ''; |
− | -- TitleLink = ''; | + | -- TitleLink = ''; |
| TransTitle = ''; | | TransTitle = ''; |
| URL = ''; | | URL = ''; |
Sətir 2.600: |
Sətir 2.784: |
| local Sheets = A['Sheets'] or ''; | | local Sheets = A['Sheets'] or ''; |
| if config.CitationClass == "map" then | | if config.CitationClass == "map" then |
| + | if utilities.is_set (Chapter) then |
| + | table.insert( z.message_tail, { utilities.set_message ( 'err_redundant_parameters', {utilities.wrap_style ('parameter', 'map') .. ' and ' .. utilities.wrap_style ('parameter', Chapter_origin)}, true ) } ); -- add error message |
| + | end |
| Chapter = A['Map']; | | Chapter = A['Map']; |
| + | Chapter_origin = A:ORIGIN('Map'); |
| ChapterURL = A['MapURL']; | | ChapterURL = A['MapURL']; |
| + | ChapterURL_origin = A:ORIGIN('MapURL'); |
| + | TransChapter = A['TransMap']; |
| + | ScriptChapter = A['ScriptMap'] |
| + | ScriptChapter_origin = A:ORIGIN('ScriptMap') |
| + | |
| ChapterUrlAccess = MapUrlAccess; | | ChapterUrlAccess = MapUrlAccess; |
− | TransChapter = A['TransMap'];
| |
− | ChapterURLorigin = A:ORIGIN('MapURL');
| |
| ChapterFormat = A['MapFormat']; | | ChapterFormat = A['MapFormat']; |
− |
| + | |
| Cartography = A['Cartography']; | | Cartography = A['Cartography']; |
− | if is_set( Cartography ) then | + | if utilities.is_set ( Cartography ) then |
| Cartography = sepc .. " " .. wrap_msg ('cartography', Cartography, use_lowercase); | | Cartography = sepc .. " " .. wrap_msg ('cartography', Cartography, use_lowercase); |
| end | | end |
| Scale = A['Scale']; | | Scale = A['Scale']; |
− | if is_set( Scale ) then | + | if utilities.is_set ( Scale ) then |
| Scale = sepc .. " " .. Scale; | | Scale = sepc .. " " .. Scale; |
| end | | end |
Sətir 2.619: |
Sətir 2.810: |
| -- Account for the oddities that are {{cite episode}} and {{cite serial}}, before generation of COinS data. | | -- Account for the oddities that are {{cite episode}} and {{cite serial}}, before generation of COinS data. |
| if 'episode' == config.CitationClass or 'serial' == config.CitationClass then | | if 'episode' == config.CitationClass or 'serial' == config.CitationClass then |
− | local AirDate = A['AirDate'];
| |
| local SeriesLink = A['SeriesLink']; | | local SeriesLink = A['SeriesLink']; |
| | | |
− | link_title_ok (SeriesLink, A:ORIGIN ('SeriesLink'), Series, 'series'); -- check for wikimarkup in |series-link= or wikimarkup in |series= when |series-link= is set | + | SeriesLink = link_title_ok (SeriesLink, A:ORIGIN ('SeriesLink'), Series, 'series'); -- check for wiki-markup in |series-link= or wiki-markup in |series= when |series-link= is set |
| | | |
| local Network = A['Network']; | | local Network = A['Network']; |
Sətir 2.628: |
Sətir 2.818: |
| local s, n = {}, {}; | | local s, n = {}, {}; |
| -- do common parameters first | | -- do common parameters first |
− | if is_set(Network) then table.insert(n, Network); end | + | if utilities.is_set (Network) then table.insert(n, Network); end |
− | if is_set(Station) then table.insert(n, Station); end | + | if utilities.is_set (Station) then table.insert(n, Station); end |
| ID = table.concat(n, sepc .. ' '); | | ID = table.concat(n, sepc .. ' '); |
| | | |
− | if not is_set (Date) and is_set (AirDate) then -- promote airdate to date
| |
− | Date = AirDate;
| |
− | end
| |
− |
| |
| if 'episode' == config.CitationClass then -- handle the oddities that are strictly {{cite episode}} | | if 'episode' == config.CitationClass then -- handle the oddities that are strictly {{cite episode}} |
| local Season = A['Season']; | | local Season = A['Season']; |
| local SeriesNumber = A['SeriesNumber']; | | local SeriesNumber = A['SeriesNumber']; |
| | | |
− | if is_set (Season) and is_set (SeriesNumber) then -- these are mutually exclusive so if both are set | + | if utilities.is_set (Season) and utilities.is_set (SeriesNumber) then -- these are mutually exclusive so if both are set |
− | table.insert( z.message_tail, { set_error( 'redundant_parameters', {wrap_style ('parameter', 'season') .. ' and ' .. wrap_style ('parameter', 'seriesno')}, true ) } ); -- add error message | + | table.insert( z.message_tail, { utilities.set_message ( 'err_redundant_parameters', {utilities.wrap_style ('parameter', 'season') .. ' and ' .. utilities.wrap_style ('parameter', 'seriesno')}, true ) } ); -- add error message |
| SeriesNumber = ''; -- unset; prefer |season= over |seriesno= | | SeriesNumber = ''; -- unset; prefer |season= over |seriesno= |
| end | | end |
| -- assemble a table of parts concatenated later into Series | | -- assemble a table of parts concatenated later into Series |
− | if is_set(Season) then table.insert(s, wrap_msg ('season', Season, use_lowercase)); end | + | if utilities.is_set (Season) then table.insert(s, wrap_msg ('season', Season, use_lowercase)); end |
− | if is_set(SeriesNumber) then table.insert(s, wrap_msg ('seriesnum', SeriesNumber, use_lowercase)); end | + | if utilities.is_set (SeriesNumber) then table.insert(s, wrap_msg ('seriesnum', SeriesNumber, use_lowercase)); end |
− | if is_set(Issue) then table.insert(s, wrap_msg ('episode', Issue, use_lowercase)); end | + | if utilities.is_set (Issue) then table.insert(s, wrap_msg ('episode', Issue, use_lowercase)); end |
| Issue = ''; -- unset because this is not a unique parameter | | Issue = ''; -- unset because this is not a unique parameter |
| | | |
| Chapter = Title; -- promote title parameters to chapter | | Chapter = Title; -- promote title parameters to chapter |
| ScriptChapter = ScriptTitle; | | ScriptChapter = ScriptTitle; |
− | ScriptChapterOrigin = 'title'; | + | ScriptChapter_origin = A:ORIGIN('ScriptTitle'); |
− | ChapterLink = TitleLink; -- alias episodelink | + | ChapterLink = TitleLink; -- alias |episode-link= |
| TransChapter = TransTitle; | | TransChapter = TransTitle; |
| ChapterURL = URL; | | ChapterURL = URL; |
| ChapterUrlAccess = UrlAccess; | | ChapterUrlAccess = UrlAccess; |
− | ChapterURLorigin = A:ORIGIN('URL'); | + | ChapterURL_origin = A:ORIGIN('URL'); |
| | | |
| Title = Series; -- promote series to title | | Title = Series; -- promote series to title |
Sətir 2.663: |
Sətir 2.849: |
| Series = table.concat(s, sepc .. ' '); -- this is concatenation of season, seriesno, episode number | | Series = table.concat(s, sepc .. ' '); -- this is concatenation of season, seriesno, episode number |
| | | |
− | if is_set (ChapterLink) and not is_set (ChapterURL) then -- link but not URL | + | if utilities.is_set (ChapterLink) and not utilities.is_set (ChapterURL) then -- link but not URL |
− | Chapter = make_wikilink (ChapterLink, Chapter); | + | Chapter = utilities.make_wikilink (ChapterLink, Chapter); |
− | elseif is_set (ChapterLink) and is_set (ChapterURL) then -- if both are set, URL links episode; | + | elseif utilities.is_set (ChapterLink) and utilities.is_set (ChapterURL) then -- if both are set, URL links episode; |
− | Series = make_wikilink (ChapterLink, Series); | + | Series = utilities.make_wikilink (ChapterLink, Series); |
| end | | end |
| URL = ''; -- unset | | URL = ''; -- unset |
Sətir 2.675: |
Sətir 2.861: |
| Issue = ''; -- unset because this parameter no longer supported by the citation/core version of cite serial | | Issue = ''; -- unset because this parameter no longer supported by the citation/core version of cite serial |
| Chapter = A['Episode']; -- TODO: make |episode= available to cite episode someday? | | Chapter = A['Episode']; -- TODO: make |episode= available to cite episode someday? |
− | if is_set (Series) and is_set (SeriesLink) then | + | if utilities.is_set (Series) and utilities.is_set (SeriesLink) then |
− | Series = make_wikilink (SeriesLink, Series); | + | Series = utilities.make_wikilink (SeriesLink, Series); |
| end | | end |
− | Series = wrap_style ('italic-title', Series); -- series is italicized | + | Series = utilities.wrap_style ('italic-title', Series); -- series is italicized |
| end | | end |
| end | | end |
| -- end of {{cite episode}} stuff | | -- end of {{cite episode}} stuff |
− |
| |
− | -- Account for the oddities that are {{cite arxiv}}, {{cite biorxiv}}, {{cite citeseerx}}, {{cite ssrn}}, before generation of COinS data.
| |
− | do
| |
− | if in_array (config.CitationClass, {'arxiv', 'biorxiv', 'citeseerx', 'ssrn'}) then
| |
− | if not is_set (ID_list[config.CitationClass:upper()]) then -- |arxiv= or |eprint= required for cite arxiv; |biorxiv= & |citeseerx= required for their templates
| |
− | table.insert( z.message_tail, { set_error( config.CitationClass .. '_missing', {}, true ) } ); -- add error message
| |
− | end
| |
− |
| |
− | Periodical = ({['arxiv'] = 'arXiv', ['biorxiv'] = bioRxiv, ['citeseerx'] = 'CiteSeerX', ['ssrn'] = 'Social Science Research Network'})[config.CitationClass];
| |
− | end
| |
− | end
| |
| | | |
| -- handle type parameter for those CS1 citations that have default values | | -- handle type parameter for those CS1 citations that have default values |
− | if in_array(config.CitationClass, {"AV-media-notes", "interview", "mailinglist", "map", "podcast", "pressrelease", "report", "techreport", "thesis"}) then | + | if utilities.in_array (config.CitationClass, {"AV-media-notes", "interview", "mailinglist", "map", "podcast", "pressrelease", "report", "techreport", "thesis"}) then |
| TitleType = set_titletype (config.CitationClass, TitleType); | | TitleType = set_titletype (config.CitationClass, TitleType); |
− | if is_set(Degree) and "Thesis" == TitleType then -- special case for cite thesis | + | if utilities.is_set (Degree) and "Thesis" == TitleType then -- special case for cite thesis |
| TitleType = Degree .. ' ' .. cfg.title_types ['thesis']:lower(); | | TitleType = Degree .. ' ' .. cfg.title_types ['thesis']:lower(); |
| end | | end |
| end | | end |
| | | |
− | if is_set(TitleType) then -- if type parameter is specified | + | if utilities.is_set (TitleType) then -- if type parameter is specified |
− | TitleType = substitute( cfg.messages['type'], TitleType); -- display it in parentheses | + | TitleType = utilities.substitute ( cfg.messages['type'], TitleType); -- display it in parentheses |
| -- TODO: Hack on TitleType to fix bunched parentheses problem | | -- TODO: Hack on TitleType to fix bunched parentheses problem |
| end | | end |
Sətir 2.710: |
Sətir 2.885: |
| local Date_origin; -- to hold the name of parameter promoted to Date; required for date error messaging | | local Date_origin; -- to hold the name of parameter promoted to Date; required for date error messaging |
| | | |
− | if not is_set (Date) then | + | if not utilities.is_set (Date) then |
| Date = Year; -- promote Year to Date | | Date = Year; -- promote Year to Date |
| Year = nil; -- make nil so Year as empty string isn't used for CITEREF | | Year = nil; -- make nil so Year as empty string isn't used for CITEREF |
− | if not is_set (Date) and is_set(PublicationDate) then -- use PublicationDate when |date= and |year= are not set | + | if not utilities.is_set (Date) and utilities.is_set (PublicationDate) then -- use PublicationDate when |date= and |year= are not set |
| Date = PublicationDate; -- promote PublicationDate to Date | | Date = PublicationDate; -- promote PublicationDate to Date |
| PublicationDate = ''; -- unset, no longer needed | | PublicationDate = ''; -- unset, no longer needed |
Sətir 2.736: |
Sətir 2.911: |
| -- AirDate has been promoted to Date so not necessary to check it | | -- AirDate has been promoted to Date so not necessary to check it |
| local date_parameters_list = { | | local date_parameters_list = { |
− | ['access-date'] = {val=AccessDate, name=A:ORIGIN ('AccessDate')}, | + | ['access-date'] = {val = AccessDate, name = A:ORIGIN ('AccessDate')}, |
− | ['archive-date'] = {val=ArchiveDate, name=A:ORIGIN ('ArchiveDate')}, | + | ['archive-date'] = {val = ArchiveDate, name = A:ORIGIN ('ArchiveDate')}, |
− | ['date'] = {val=Date, name=Date_origin}, | + | ['date'] = {val = Date, name = Date_origin}, |
− | ['doi-broken-date'] = {val=DoiBroken, name=A:ORIGIN ('DoiBroken')}, | + | ['doi-broken-date'] = {val = DoiBroken, name = A:ORIGIN ('DoiBroken')}, |
− | ['embargo'] = {val=Embargo, name=A:ORIGIN ('Embargo')}, | + | ['pmc-embargo-date'] = {val = Embargo, name = A:ORIGIN ('Embargo')}, |
− | ['lay-date'] = {val=LayDate, name=A:ORIGIN ('LayDate')}, | + | ['lay-date'] = {val = LayDate, name = A:ORIGIN ('LayDate')}, |
− | ['publication-date'] ={val=PublicationDate, name=A:ORIGIN ('PublicationDate')}, | + | ['publication-date'] = {val = PublicationDate, name = A:ORIGIN ('PublicationDate')}, |
− | ['year'] = {val=Year, name=A:ORIGIN ('Year')}, | + | ['year'] = {val = Year, name = A:ORIGIN ('Year')}, |
| }; | | }; |
− | anchor_year, Embargo, error_message = dates(date_parameters_list, COinS_date);
| |
| | | |
| + | local error_list = {}; |
| + | anchor_year, Embargo = validation.dates(date_parameters_list, COinS_date, error_list); |
| + | |
| + | -- start temporary Julian / Gregorian calendar uncertainty categorization |
| + | if COinS_date.inter_cal_cat then |
| + | utilities.add_prop_cat ('jul_greg_uncertainty'); |
| + | end |
| -- end temporary Julian / Gregorian calendar uncertainty categorization | | -- end temporary Julian / Gregorian calendar uncertainty categorization |
| | | |
− | if is_set (Year) and is_set (Date) then -- both |date= and |year= not normally needed; | + | if utilities.is_set (Year) and utilities.is_set (Date) then -- both |date= and |year= not normally needed; |
− | local mismatch = year_date_check (Year, Date) | + | local mismatch = validation.year_date_check (Year, Date); |
| if 0 == mismatch then -- |year= does not match a year-value in |date= | | if 0 == mismatch then -- |year= does not match a year-value in |date= |
− | if is_set (error_message) then -- if there is already an error message | + | table.insert (error_list, '<code class="cs1-code">|year= / |date= mismatch</code>'); |
− | error_message = error_message .. ', '; -- tack on this additional message
| + | elseif 1 == mismatch then -- |year= matches year-value in |date= |
− | end
| + | utilities.set_message ('maint_date_year'); -- add a maint cat |
− | error_message = error_message .. '|year= / |date= mismatch';
| |
| end | | end |
| end | | end |
| | | |
− | if not is_set(error_message) then -- error free dates only | + | if 0 == #error_list then -- error free dates only; 0 when error_list is empty |
| local modified = false; -- flag | | local modified = false; -- flag |
| | | |
− | if is_set (DF) then -- if we need to reformat dates | + | if utilities.is_set (DF) then -- if we need to reformat dates |
− | modified = reformat_dates (date_parameters_list, DF, false); -- reformat to DF format, use long month names if appropriate | + | modified = validation.reformat_dates (date_parameters_list, DF); -- reformat to DF format, use long month names if appropriate |
| end | | end |
| | | |
− | if true == date_hyphen_to_dash (date_parameters_list) then -- convert hyphens to dashes where appropriate | + | if true == validation.date_hyphen_to_dash (date_parameters_list) then -- convert hyphens to dashes where appropriate |
| modified = true; | | modified = true; |
| + | utilities.set_message ('maint_date_format'); -- hyphens were converted so add maint category |
| end | | end |
| | | |
| -- for those wikis that can and want to have English date names translated to the local language, | | -- for those wikis that can and want to have English date names translated to the local language, |
− | -- uncomment these three lines. Not supported by en.wiki (for obvious reasons) | + | -- uncomment the next three lines. Not supported by en.wiki (for obvious reasons) |
− | -- set date_name_xlate() second argument to true to translate English digits to local digits (will translate ymd dates) | + | -- set validation.date_name_xlate() second argument to true to translate English digits to local digits (will translate ymd dates) |
− | -- if date_name_xlate (date_parameters_list, false) then | + | -- if validation.date_name_xlate (date_parameters_list, false) then |
− | -- modified = true; | + | -- modified = true; |
− | -- end | + | -- end |
| | | |
| if modified then -- if the date_parameters_list values were modified | | if modified then -- if the date_parameters_list values were modified |
Sətir 2.785: |
Sətir 2.966: |
| PublicationDate = date_parameters_list['publication-date'].val; | | PublicationDate = date_parameters_list['publication-date'].val; |
| end | | end |
| + | else |
| + | table.insert (z.message_tail, {utilities.set_message ('err_bad_date', {utilities.make_sep_list (#error_list, error_list)}, true)}); -- add this error message |
| end | | end |
| end -- end of do | | end -- end of do |
| | | |
− | -- Account for the oddity that is {{cite journal}} with |pmc= set and |url= not set. Do this after date check but before COInS. | + | local ID_list_coins = identifiers.extract_ids (args); -- gets identifiers and their values from args; this list used for COinS and source for build_id_list() |
− | -- Here we unset Embargo if PMC not embargoed (|embargo= not set in the citation) or if the embargo time has expired. Otherwise, holds embargo date | + | if utilities.is_set (DoiBroken) and not ID_list_coins['DOI'] then |
− | Embargo = is_embargoed (Embargo);
| + | table.insert (z.message_tail, {utilities.set_message ('err_doibroken_missing_doi', A:ORIGIN('DoiBroken'))}); |
| + | end |
| + | local ID_access_levels = identifiers.extract_id_access_levels (args, ID_list_coins); |
| + | local ID_list = identifiers.build_id_list (ID_list_coins, {IdAccessLevels = ID_access_levels, DoiBroken = DoiBroken, ASINTLD = ASINTLD, IgnoreISBN = IgnoreISBN, Embargo = Embargo, Class = Class}); -- render identifiers |
| + | |
| + | -- Account for the oddities that are {{cite arxiv}}, {{cite biorxiv}}, {{cite citeseerx}}, {{cite ssrn}}, before generation of COinS data. |
| + | if utilities.in_array (config.CitationClass, whitelist.preprint_template_list) then |
| + | if not utilities.is_set (ID_list_coins[config.CitationClass:upper()]) then -- |arxiv= or |eprint= required for cite arxiv; |biorxiv= & |citeseerx= required for their templates |
| + | table.insert (z.message_tail, {utilities.set_message ('err_' .. config.CitationClass .. '_missing', {}, true)}); -- add error message |
| + | end |
| | | |
− | if config.CitationClass == "journal" and not is_set(URL) and is_set(ID_list['PMC']) then | + | Periodical = ({['arxiv'] = 'arXiv', ['biorxiv'] = 'bioRxiv', ['citeseerx'] = 'CiteSeerX', ['ssrn'] = 'Social Science Research Network'})[config.CitationClass]; |
− | if not is_set (Embargo) then -- if not embargoed or embargo has expired
| + | end |
− | URL=cfg.id_handlers['PMC'].prefix .. ID_list['PMC']; -- set url to be the same as the PMC external link if not embargoed
| + | |
− | URLorigin = cfg.id_handlers['PMC'].parameters[1]; -- set URLorigin to parameter name for use in error message if citation is missing a |title=
| + | -- Link the title of the work if no |url= was provided, but we have a |pmc= or a |doi= with |doi-access=free |
− | if is_set(AccessDate) then -- access date requires |url=; pmc created url is not |url= | + | |
− | table.insert( z.message_tail, { set_error( 'accessdate_missing_url', {}, true ) } ); | + | if config.CitationClass == "journal" and not utilities.is_set (URL) and not utilities.is_set (TitleLink) and not utilities.in_array (cfg.keywords_xlate[Title], {'off', 'none'}) then -- TODO: remove 'none' once existing citations have been switched to 'off', so 'none' can be used as token for "no title" instead |
− | AccessDate = ''; -- unset | + | if 'none' ~= cfg.keywords_xlate[auto_select] then -- if auto-linking not disabled |
| + | if identifiers.auto_link_urls[auto_select] then -- manual selection |
| + | URL = identifiers.auto_link_urls[auto_select]; -- set URL to be the same as identifier's external link |
| + | URL_origin = cfg.id_handlers[auto_select:upper()].parameters[1]; -- set URL_origin to parameter name for use in error message if citation is missing a |title= |
| + | elseif identifiers.auto_link_urls['pmc'] then -- auto-select PMC |
| + | URL = identifiers.auto_link_urls['pmc']; -- set URL to be the same as the PMC external link if not embargoed |
| + | URL_origin = cfg.id_handlers['PMC'].parameters[1]; -- set URL_origin to parameter name for use in error message if citation is missing a |title= |
| + | elseif identifiers.auto_link_urls['doi'] then -- auto-select DOI |
| + | URL = identifiers.auto_link_urls['doi']; |
| + | URL_origin = cfg.id_handlers['DOI'].parameters[1]; |
| end | | end |
| + | end |
| | | |
| + | if utilities.is_set (URL) and utilities.is_set (AccessDate) then -- access date requires |url=; identifier-created URL is not |url= |
| + | table.insert( z.message_tail, { utilities.set_message ( 'err_accessdate_missing_url', {}, true ) } ); -- add an error message |
| + | AccessDate = ''; -- unset |
| end | | end |
| end | | end |
Sətir 2.806: |
Sətir 3.011: |
| -- At this point fields may be nil if they weren't specified in the template use. We can use that fact. | | -- At this point fields may be nil if they weren't specified in the template use. We can use that fact. |
| -- Test if citation has no title | | -- Test if citation has no title |
− | if not is_set(Title) and | + | if not utilities.is_set (Title) and not utilities.is_set (TransTitle) and not utilities.is_set (ScriptTitle) then -- has special case for cite episode |
− | not is_set(TransTitle) and
| + | table.insert( z.message_tail, { utilities.set_message ( 'err_citation_missing_title', {'episode' == config.CitationClass and 'series' or 'title'}, true ) } ); |
− | not is_set(ScriptTitle) then
| |
− | if 'episode' == config.CitationClass then
| |
− | end
| |
| end | | end |
| | | |
− | if 'none' == Title and | + | if utilities.in_array (cfg.keywords_xlate[Title], {'off', 'none'}) and |
− | in_array (config.CitationClass, {'journal', 'citation'}) and | + | utilities.in_array (config.CitationClass, {'journal', 'citation'}) and |
− | (is_set (Periodical) or is_set (ScriptPeriodical)) and | + | (utilities.is_set (Periodical) or utilities.is_set (ScriptPeriodical)) and |
| ('journal' == Periodical_origin or 'script-journal' == ScriptPeriodical_origin) then -- special case for journal cites | | ('journal' == Periodical_origin or 'script-journal' == ScriptPeriodical_origin) then -- special case for journal cites |
| Title = ''; -- set title to empty string | | Title = ''; -- set title to empty string |
| + | utilities.set_message ('maint_untitled'); -- add maint cat |
| end | | end |
| | | |
Sətir 2.834: |
Sətir 3.037: |
| local coins_chapter = Chapter; -- default assuming that remapping not required | | local coins_chapter = Chapter; -- default assuming that remapping not required |
| local coins_title = Title; -- et tu | | local coins_title = Title; -- et tu |
− | if 'encyclopaedia' == config.CitationClass or ('citation' == config.CitationClass and is_set (Encyclopedia)) then | + | if 'encyclopaedia' == config.CitationClass or ('citation' == config.CitationClass and utilities.is_set (Encyclopedia)) then |
− | if is_set (Chapter) and is_set (Title) and is_set (Periodical) then -- if all are used then | + | if utilities.is_set (Chapter) and utilities.is_set (Title) and utilities.is_set (Periodical) then -- if all are used then |
| coins_chapter = Title; -- remap | | coins_chapter = Title; -- remap |
| coins_title = Periodical; | | coins_title = Periodical; |
Sətir 2.846: |
Sətir 3.049: |
| | | |
| -- this is the function call to COinS() | | -- this is the function call to COinS() |
− | local OCinSoutput = COinS({ | + | local OCinSoutput = metadata.COinS({ |
− | ['Periodical'] = strip_apostrophe_markup (Periodical), -- no markup in the metadata | + | ['Periodical'] = utilities.strip_apostrophe_markup (Periodical), -- no markup in the metadata |
− | ['Encyclopedia'] = strip_apostrophe_markup (Encyclopedia), | + | ['Encyclopedia'] = Encyclopedia, -- just a flag; content ignored by ~/COinS |
− | ['Chapter'] = make_coins_title (coins_chapter, ScriptChapter), -- Chapter and ScriptChapter stripped of bold / italic wikimarkup | + | ['Chapter'] = metadata.make_coins_title (coins_chapter, ScriptChapter), -- Chapter and ScriptChapter stripped of bold / italic wiki-markup |
| ['Degree'] = Degree; -- cite thesis only | | ['Degree'] = Degree; -- cite thesis only |
− | ['Title'] = make_coins_title (coins_title, ScriptTitle), -- Title and ScriptTitle stripped of bold / italic wikimarkup | + | ['Title'] = metadata.make_coins_title (coins_title, ScriptTitle), -- Title and ScriptTitle stripped of bold / italic wiki-markup |
| ['PublicationPlace'] = PublicationPlace, | | ['PublicationPlace'] = PublicationPlace, |
| ['Date'] = COinS_date.rftdate, -- COinS_date has correctly formatted date if Date is valid; | | ['Date'] = COinS_date.rftdate, -- COinS_date has correctly formatted date if Date is valid; |
| ['Season'] = COinS_date.rftssn, | | ['Season'] = COinS_date.rftssn, |
| + | ['Quarter'] = COinS_date.rftquarter, |
| ['Chron'] = COinS_date.rftchron or (not COinS_date.rftdate and Date) or '', -- chron but if not set and invalid date format use Date; keep this last bit? | | ['Chron'] = COinS_date.rftchron or (not COinS_date.rftdate and Date) or '', -- chron but if not set and invalid date format use Date; keep this last bit? |
| ['Series'] = Series, | | ['Series'] = Series, |
| ['Volume'] = Volume, | | ['Volume'] = Volume, |
| ['Issue'] = Issue, | | ['Issue'] = Issue, |
− | ['Pages'] = coins_pages or get_coins_pages (first_set ({Sheet, Sheets, Page, Pages, At}, 5)), -- pages stripped of external links | + | ['Pages'] = coins_pages or metadata.get_coins_pages (first_set ({Sheet, Sheets, Page, Pages, At}, 5)), -- pages stripped of external links |
| ['Edition'] = Edition, | | ['Edition'] = Edition, |
− | ['PublisherName'] = PublisherName, -- any apostrophe markup already removed | + | ['PublisherName'] = PublisherName or Newsgroup, -- any apostrophe markup already removed from PublisherName |
| ['URL'] = first_set ({ChapterURL, URL}, 2), | | ['URL'] = first_set ({ChapterURL, URL}, 2), |
| ['Authors'] = coins_author, | | ['Authors'] = coins_author, |
− | ['ID_list'] = ID_list, | + | ['ID_list'] = ID_list_coins, |
| ['RawPage'] = this_page.prefixedText, | | ['RawPage'] = this_page.prefixedText, |
| }, config.CitationClass); | | }, config.CitationClass); |
| | | |
| -- Account for the oddities that are {{cite arxiv}}, {{cite biorxiv}}, {{cite citeseerx}}, and {{cite ssrn}} AFTER generation of COinS data. | | -- Account for the oddities that are {{cite arxiv}}, {{cite biorxiv}}, {{cite citeseerx}}, and {{cite ssrn}} AFTER generation of COinS data. |
− | if in_array (config.CitationClass, {'arxiv', 'biorxiv', 'citeseerx', 'ssrn'}) then -- we have set rft.jtitle in COinS to arXiv, bioRxiv, CiteSeerX, or ssrn now unset so it isn't displayed | + | if utilities.in_array (config.CitationClass, whitelist.preprint_template_list) then -- we have set rft.jtitle in COinS to arXiv, bioRxiv, CiteSeerX, or ssrn now unset so it isn't displayed |
| Periodical = ''; -- periodical not allowed in these templates; if article has been published, use cite journal | | Periodical = ''; -- periodical not allowed in these templates; if article has been published, use cite journal |
| end | | end |
| | | |
| -- special case for cite newsgroup. Do this after COinS because we are modifying Publishername to include some static text | | -- special case for cite newsgroup. Do this after COinS because we are modifying Publishername to include some static text |
− | if 'newsgroup' == config.CitationClass then | + | if 'newsgroup' == config.CitationClass and utilities.is_set (Newsgroup) then |
− | if is_set (PublisherName) then
| + | PublisherName = utilities.substitute (cfg.messages['newsgroup'], external_link( 'news:' .. Newsgroup, Newsgroup, Newsgroup_origin, nil )); |
− | PublisherName = substitute (cfg.messages['newsgroup'], external_link( 'news:' .. PublisherName, PublisherName, PublisherName_origin, nil ));
| |
− | end
| |
| end | | end |
| | | |
Sətir 2.887: |
Sətir 3.089: |
| local last_first_list; | | local last_first_list; |
| local control = { | | local control = { |
− | format = NameListFormat, -- empty string or 'vanc' | + | format = NameListStyle, -- empty string or 'vanc' |
| maximum = nil, -- as if display-authors or display-editors not set | | maximum = nil, -- as if display-authors or display-editors not set |
| lastauthoramp = LastAuthorAmp, | | lastauthoramp = LastAuthorAmp, |
− | page_name = this_page.text, -- get current page name so that we don't wikilink to it via editorlinkn
| |
| mode = Mode | | mode = Mode |
| }; | | }; |
Sətir 2.898: |
Sətir 3.099: |
| last_first_list, EditorCount = list_people(control, e, editor_etal); | | last_first_list, EditorCount = list_people(control, e, editor_etal); |
| | | |
− | if is_set (Editors) then | + | if utilities.is_set (Editors) then |
| Editors, editor_etal = name_has_etal (Editors, editor_etal, false, 'editors'); -- find and remove variations on et al. | | Editors, editor_etal = name_has_etal (Editors, editor_etal, false, 'editors'); -- find and remove variations on et al. |
| if editor_etal then | | if editor_etal then |
| Editors = Editors .. ' ' .. cfg.messages['et al']; -- add et al. to editors parameter beause |display-editors=etal | | Editors = Editors .. ' ' .. cfg.messages['et al']; -- add et al. to editors parameter beause |display-editors=etal |
− | EditorCount = 2; -- with et al., |editors= is multiple names; spoof to display (eds.) annotation
| |
− | else
| |
− | EditorCount = 2; -- we don't know but assume |editors= is multiple names; spoof to display (eds.) annotation
| |
| end | | end |
| + | EditorCount = 2; -- we don't know but assume |editors= is multiple names; spoof to display (eds.) annotation |
| else | | else |
| Editors = last_first_list; -- either an author name list or an empty string | | Editors = last_first_list; -- either an author name list or an empty string |
Sətir 2.931: |
Sətir 3.130: |
| last_first_list = list_people(control, a, author_etal); | | last_first_list = list_people(control, a, author_etal); |
| | | |
− | if is_set (Authors) then | + | if utilities.is_set (Authors) then |
| Authors, author_etal = name_has_etal (Authors, author_etal, false, 'authors'); -- find and remove variations on et al. | | Authors, author_etal = name_has_etal (Authors, author_etal, false, 'authors'); -- find and remove variations on et al. |
| if author_etal then | | if author_etal then |
Sətir 2.941: |
Sətir 3.140: |
| end -- end of do | | end -- end of do |
| | | |
− | if is_set (Authors) and is_set (Collaboration) then | + | if utilities.is_set (Authors) and utilities.is_set (Collaboration) then |
| Authors = Authors .. ' (' .. Collaboration .. ')'; -- add collaboration after et al. | | Authors = Authors .. ' (' .. Collaboration .. ')'; -- add collaboration after et al. |
| end | | end |
Sətir 2.948: |
Sətir 3.147: |
| | | |
| -- apply |[xx-]format= styling; at the end, these parameters hold correctly styled format annotation, | | -- apply |[xx-]format= styling; at the end, these parameters hold correctly styled format annotation, |
− | -- an error message if the associated url is not set, or an empty string for concatenation | + | -- an error message if the associated URL is not set, or an empty string for concatenation |
| ArchiveFormat = style_format (ArchiveFormat, ArchiveURL, 'archive-format', 'archive-url'); | | ArchiveFormat = style_format (ArchiveFormat, ArchiveURL, 'archive-format', 'archive-url'); |
| ConferenceFormat = style_format (ConferenceFormat, ConferenceURL, 'conference-format', 'conference-url'); | | ConferenceFormat = style_format (ConferenceFormat, ConferenceURL, 'conference-format', 'conference-url'); |
Sətir 2.956: |
Sətir 3.155: |
| | | |
| -- special case for chapter format so no error message or cat when chapter not supported | | -- special case for chapter format so no error message or cat when chapter not supported |
− | if not (in_array(config.CitationClass, {'web', 'news', 'journal', 'magazine', 'pressrelease', 'podcast', 'newsgroup', 'arxiv', 'biorxiv', 'citeseerx', 'ssrn'}) or | + | if not (utilities.in_array (config.CitationClass, {'web', 'news', 'journal', 'magazine', 'pressrelease', 'podcast', 'newsgroup', 'arxiv', 'biorxiv', 'citeseerx', 'ssrn'}) or |
− | ('citation' == config.CitationClass and (is_set (Periodical) or is_set (ScriptPeriodical)) and not is_set (Encyclopedia))) then | + | ('citation' == config.CitationClass and (utilities.is_set (Periodical) or utilities.is_set (ScriptPeriodical)) and not utilities.is_set (Encyclopedia))) then |
| ChapterFormat = style_format (ChapterFormat, ChapterURL, 'chapter-format', 'chapter-url'); | | ChapterFormat = style_format (ChapterFormat, ChapterURL, 'chapter-format', 'chapter-url'); |
| end | | end |
| | | |
− | if not is_set(URL) then | + | if not utilities.is_set (URL) then |
− | if in_array(config.CitationClass, {"web","podcast", "mailinglist"}) or -- |url= required for cite web, cite podcast, and cite mailinglist | + | if utilities.in_array (config.CitationClass, {"web", "podcast", "mailinglist"}) or -- |url= required for cite web, cite podcast, and cite mailinglist |
| ('citation' == config.CitationClass and ('website' == Periodical_origin or 'script-website' == ScriptPeriodical_origin)) then -- and required for {{citation}} with |website= or |script-website= | | ('citation' == config.CitationClass and ('website' == Periodical_origin or 'script-website' == ScriptPeriodical_origin)) then -- and required for {{citation}} with |website= or |script-website= |
− | table.insert( z.message_tail, { set_error( 'cite_web_url', {}, true ) } ); | + | table.insert( z.message_tail, { utilities.set_message ( 'err_cite_web_url', {}, true ) } ); |
| end | | end |
| | | |
| -- do we have |accessdate= without either |url= or |chapter-url=? | | -- do we have |accessdate= without either |url= or |chapter-url=? |
− | if is_set(AccessDate) and not is_set(ChapterURL)then -- ChapterURL may be set when URL is not set; | + | if utilities.is_set (AccessDate) and not utilities.is_set (ChapterURL) then -- ChapterURL may be set when URL is not set; |
− | table.insert( z.message_tail, { set_error( 'accessdate_missing_url', {}, true ) } ); | + | table.insert( z.message_tail, { utilities.set_message ( 'err_accessdate_missing_url', {}, true ) } ); |
| AccessDate = ''; | | AccessDate = ''; |
| end | | end |
| end | | end |
| | | |
− | local OriginalURL, OriginalURLorigin, OriginalFormat, OriginalAccess; | + | local OriginalURL, OriginalURL_origin, OriginalFormat, OriginalAccess; |
− | -- DeadURL = DeadURL:lower(); -- used later when assembling archived text
| |
| UrlStatus = UrlStatus:lower(); -- used later when assembling archived text | | UrlStatus = UrlStatus:lower(); -- used later when assembling archived text |
− | if is_set( ArchiveURL ) then | + | if utilities.is_set ( ArchiveURL ) then |
− | if is_set (ChapterURL) then -- if chapter-url is set apply archive url to it | + | if utilities.is_set (ChapterURL) then -- if chapter-url= is set apply archive url to it |
| OriginalURL = ChapterURL; -- save copy of source chapter's url for archive text | | OriginalURL = ChapterURL; -- save copy of source chapter's url for archive text |
− | OriginalURLorigin = ChapterURLorigin; -- name of chapter-url parameter for error messages | + | OriginalURL_origin = ChapterURL_origin; -- name of |chapter-url= parameter for error messages |
| OriginalFormat = ChapterFormat; -- and original |chapter-format= | | OriginalFormat = ChapterFormat; -- and original |chapter-format= |
− | -- if 'no' ~= DeadURL then
| + | |
| if 'live' ~= UrlStatus then | | if 'live' ~= UrlStatus then |
− | ChapterURL = ArchiveURL -- swap-in the archive's url | + | ChapterURL = ArchiveURL -- swap-in the archive's URL |
− | ChapterURLorigin = A:ORIGIN('ArchiveURL') -- name of archive-url parameter for error messages | + | ChapterURL_origin = A:ORIGIN('ArchiveURL') -- name of |archive-url= parameter for error messages |
| ChapterFormat = ArchiveFormat or ''; -- swap in archive's format | | ChapterFormat = ArchiveFormat or ''; -- swap in archive's format |
− | ChapterUrlAccess = nil; -- restricted access levels do not make sense for archived urls | + | ChapterUrlAccess = nil; -- restricted access levels do not make sense for archived URLs |
| end | | end |
− | elseif is_set (URL) then | + | elseif utilities.is_set (URL) then |
| OriginalURL = URL; -- save copy of original source URL | | OriginalURL = URL; -- save copy of original source URL |
− | OriginalURLorigin = URLorigin; -- name of url parameter for error messages | + | OriginalURL_origin = URL_origin; -- name of URL parameter for error messages |
| OriginalFormat = Format; -- and original |format= | | OriginalFormat = Format; -- and original |format= |
| OriginalAccess = UrlAccess; | | OriginalAccess = UrlAccess; |
− | -- if 'no' ~= DeadURL then -- if URL set then archive-url applies to it
| + | |
− | if 'live' ~= UrlStatus then -- if URL set then archive-url applies to it | + | if 'live' ~= UrlStatus then -- if URL set then |archive-url= applies to it |
− | URL = ArchiveURL -- swap-in the archive's url | + | URL = ArchiveURL -- swap-in the archive's URL |
− | URLorigin = A:ORIGIN('ArchiveURL') -- name of archive url parameter for error messages | + | URL_origin = A:ORIGIN('ArchiveURL') -- name of archive URL parameter for error messages |
| Format = ArchiveFormat or ''; -- swap in archive's format | | Format = ArchiveFormat or ''; -- swap in archive's format |
− | UrlAccess = nil; -- restricted access levels do not make sense for archived urls | + | UrlAccess = nil; -- restricted access levels do not make sense for archived URLs |
| end | | end |
| end | | end |
| end | | end |
| | | |
− | if in_array(config.CitationClass, {'web','news','journal', 'magazine', 'pressrelease', 'podcast', 'newsgroup', 'arxiv', 'biorxiv', 'citeseerx', 'ssrn'}) or -- if any of the 'periodical' cites except encyclopedia | + | if utilities.in_array (config.CitationClass, {'web', 'news', 'journal', 'magazine', 'pressrelease', 'podcast', 'newsgroup', 'arxiv', 'biorxiv', 'citeseerx', 'ssrn'}) or -- if any of the 'periodical' cites except encyclopedia |
− | ('citation' == config.CitationClass and (is_set (Periodical) or is_set (ScriptPeriodical)) and not is_set (Encyclopedia)) then | + | ('citation' == config.CitationClass and (utilities.is_set (Periodical) or utilities.is_set (ScriptPeriodical)) and not utilities.is_set (Encyclopedia)) then |
| local chap_param; | | local chap_param; |
− | if is_set (Chapter) then -- get a parameter name from one of these chapter related meta-parameters | + | if utilities.is_set (Chapter) then -- get a parameter name from one of these chapter related meta-parameters |
| chap_param = A:ORIGIN ('Chapter') | | chap_param = A:ORIGIN ('Chapter') |
− | elseif is_set (TransChapter) then | + | elseif utilities.is_set (TransChapter) then |
| chap_param = A:ORIGIN ('TransChapter') | | chap_param = A:ORIGIN ('TransChapter') |
− | elseif is_set (ChapterURL) then | + | elseif utilities.is_set (ChapterURL) then |
| chap_param = A:ORIGIN ('ChapterURL') | | chap_param = A:ORIGIN ('ChapterURL') |
− | elseif is_set (ScriptChapter) then | + | elseif utilities.is_set (ScriptChapter) then |
− | chap_param = ScriptChapterOrigin; | + | chap_param = ScriptChapter_origin; |
− | else is_set (ChapterFormat) | + | else utilities.is_set (ChapterFormat) |
| chap_param = A:ORIGIN ('ChapterFormat') | | chap_param = A:ORIGIN ('ChapterFormat') |
| end | | end |
| | | |
− | if is_set (chap_param) then -- if we found one | + | if utilities.is_set (chap_param) then -- if we found one |
− | table.insert( z.message_tail, { set_error( 'chapter_ignored', {chap_param}, true ) } ); -- add error message | + | table.insert( z.message_tail, { utilities.set_message ( 'err_chapter_ignored', {chap_param}, true ) } ); -- add error message |
| Chapter = ''; -- and set them to empty string to be safe with concatenation | | Chapter = ''; -- and set them to empty string to be safe with concatenation |
| TransChapter = ''; | | TransChapter = ''; |
Sətir 3.029: |
Sətir 3.227: |
| else -- otherwise, format chapter / article title | | else -- otherwise, format chapter / article title |
| local no_quotes = false; -- default assume that we will be quoting the chapter parameter value | | local no_quotes = false; -- default assume that we will be quoting the chapter parameter value |
− | if is_set (Contribution) and 0 < #c then -- if this is a contribution with contributor(s) | + | if utilities.is_set (Contribution) and 0 < #c then -- if this is a contribution with contributor(s) |
− | if in_array (Contribution:lower(), cfg.keywords.contribution) then -- and a generic contribution title | + | if utilities.in_array (Contribution:lower(), cfg.keywords_lists.contribution) then -- and a generic contribution title |
| no_quotes = true; -- then render it unquoted | | no_quotes = true; -- then render it unquoted |
| end | | end |
| end | | end |
| | | |
− | Chapter = format_chapter_title (ScriptChapter, ScriptChapterOrigin, Chapter, TransChapter, ChapterURL, ChapterURLorigin, no_quotes, ChapterUrlAccess); -- Contribution is also in Chapter | + | Chapter = format_chapter_title (ScriptChapter, ScriptChapter_origin, Chapter, Chapter_origin, TransChapter, TransChapter_origin, ChapterURL, ChapterURL_origin, no_quotes, ChapterUrlAccess); -- Contribution is also in Chapter |
− | if is_set (Chapter) then | + | if utilities.is_set (Chapter) then |
| Chapter = Chapter .. ChapterFormat ; | | Chapter = Chapter .. ChapterFormat ; |
− | if 'map' == config.CitationClass and is_set (TitleType) then | + | if 'map' == config.CitationClass and utilities.is_set (TitleType) then |
| Chapter = Chapter .. ' ' .. TitleType; -- map annotation here; not after title | | Chapter = Chapter .. ' ' .. TitleType; -- map annotation here; not after title |
| end | | end |
− | Chapter = Chapter.. sepc .. ' '; | + | Chapter = Chapter .. sepc .. ' '; |
− | elseif is_set (ChapterFormat) then -- |chapter= not set but |chapter-format= is so ... | + | elseif utilities.is_set (ChapterFormat) then -- |chapter= not set but |chapter-format= is so ... |
| Chapter = ChapterFormat .. sepc .. ' '; -- ... ChapterFormat has error message, we want to see it | | Chapter = ChapterFormat .. sepc .. ' '; -- ... ChapterFormat has error message, we want to see it |
| end | | end |
| end | | end |
| | | |
− | -- Format main title. | + | -- Format main title |
| + | local plain_title = false; |
| + | local accept_title; |
| + | Title, accept_title = utilities.has_accept_as_written (Title, true); -- remove accept-this-as-written markup when it wraps all of <Title> |
| + | if accept_title and ('' == Title) then -- only support forced empty for now "(())" |
| + | Title = cfg.messages['notitle']; -- replace by predefined "No title" message |
| + | -- TODO: utilities.set_message ( 'err_redundant_parameters', ...); -- issue proper error message instead of muting |
| + | ScriptTitle = ''; -- just mute for now |
| + | TransTitle = ''; -- just mute for now |
| + | plain_title = true; -- suppress text decoration for descriptive title |
| + | utilities.set_message ('maint_untitled'); -- add maint cat |
| + | end |
| | | |
− | if Title:match ('^%(%(.*%)%)$') then -- if keep as written markup: | + | if not accept_title then -- <Title> not wrapped in accept-as-written markup |
− | Title= Title:gsub ('^%(%((.*)%)%)$', '%1') -- remove the markup
| + | if '...' == Title:sub (-3) then -- if ellipsis is the last three characters of |title= |
− | else
| |
− | if '...' == Title:sub (-3) then -- if elipsis is the last three characters of |title= | |
| Title = Title:gsub ('(%.%.%.)%.+$', '%1'); -- limit the number of dots to three | | Title = Title:gsub ('(%.%.%.)%.+$', '%1'); -- limit the number of dots to three |
| elseif not mw.ustring.find (Title, '%.%s*%a%.$') and -- end of title is not a 'dot-(optional space-)letter-dot' initialism ... | | elseif not mw.ustring.find (Title, '%.%s*%a%.$') and -- end of title is not a 'dot-(optional space-)letter-dot' initialism ... |
| not mw.ustring.find (Title, '%s+%a%.$') then -- ...and not a 'space-letter-dot' initial (''Allium canadense'' L.) | | not mw.ustring.find (Title, '%s+%a%.$') then -- ...and not a 'space-letter-dot' initial (''Allium canadense'' L.) |
− | Title = mw.ustring.gsub(Title, '%'..sepc..'$', ''); -- remove any trailing separator character; sepc and ms.ustring() here for languages that use multibyte separator characters | + | Title = mw.ustring.gsub(Title, '%' .. sepc .. '$', ''); -- remove any trailing separator character; sepc and ms.ustring() here for languages that use multibyte separator characters |
| + | end |
| + | |
| + | if utilities.is_set (ArchiveURL) and is_archived_copy (Title) then |
| + | utilities.set_message ('maint_archived_copy'); -- add maintenance category before we modify the content of Title |
| + | end |
| + | |
| + | if is_generic_title (Title) then |
| + | table.insert (z.message_tail, {utilities.set_message ( 'err_generic_title', {}, true ) } ); -- set an error message |
| end | | end |
| end | | end |
− |
| + | |
− | if in_array(config.CitationClass, {'web', 'news', 'journal', 'magazine', 'pressrelease', 'podcast', 'newsgroup', 'mailinglist', 'interview', 'arxiv', 'biorxiv', 'citeseerx', 'ssrn'}) or | + | if (not plain_title) and (utilities.in_array (config.CitationClass, {'web', 'news', 'journal', 'magazine', 'pressrelease', 'podcast', 'newsgroup', 'mailinglist', 'interview', 'arxiv', 'biorxiv', 'citeseerx', 'ssrn'}) or |
− | ('citation' == config.CitationClass and (is_set (Periodical) or is_set (ScriptPeriodical)) and not is_set (Encyclopedia)) or | + | ('citation' == config.CitationClass and (utilities.is_set (Periodical) or utilities.is_set (ScriptPeriodical)) and not utilities.is_set (Encyclopedia)) or |
− | ('map' == config.CitationClass and (is_set (Periodical) or is_set (ScriptPeriodical))) then -- special case for cite map when the map is in a periodical treat as an article | + | ('map' == config.CitationClass and (utilities.is_set (Periodical) or utilities.is_set (ScriptPeriodical)))) then -- special case for cite map when the map is in a periodical treat as an article |
− | Title = kern_quotes (Title); -- if necessary, separate title's leading and trailing quote marks from Module provided quote marks | + | Title = kern_quotes (Title); -- if necessary, separate title's leading and trailing quote marks from module provided quote marks |
− | Title = wrap_style ('quoted-title', Title); | + | Title = utilities.wrap_style ('quoted-title', Title); |
− | Title = script_concatenate (Title, ScriptTitle, 'script-title'); -- <bdi> tags, lang atribute, categorization, etc; must be done after title is wrapped | + | Title = script_concatenate (Title, ScriptTitle, 'script-title'); -- <bdi> tags, lang attribute, categorization, etc.; must be done after title is wrapped |
− | TransTitle= wrap_style ('trans-quoted-title', TransTitle ); | + | TransTitle = utilities.wrap_style ('trans-quoted-title', TransTitle ); |
− | elseif 'report' == config.CitationClass then -- no styling for cite report | + | elseif plain_title or ('report' == config.CitationClass) then -- no styling for cite report and descriptive titles (otherwise same as above) |
− | Title = script_concatenate (Title, ScriptTitle, 'script-title'); -- <bdi> tags, lang atribute, categorization, etc; must be done after title is wrapped | + | Title = script_concatenate (Title, ScriptTitle, 'script-title'); -- <bdi> tags, lang attribute, categorization, etc.; must be done after title is wrapped |
− | TransTitle= wrap_style ('trans-quoted-title', TransTitle ); -- for cite report, use this form for trans-title | + | TransTitle = utilities.wrap_style ('trans-quoted-title', TransTitle ); -- for cite report, use this form for trans-title |
| else | | else |
− | Title = wrap_style ('italic-title', Title); | + | Title = utilities.wrap_style ('italic-title', Title); |
− | Title = script_concatenate (Title, ScriptTitle, 'script-title'); -- <bdi> tags, lang atribute, categorization, etc; must be done after title is wrapped | + | Title = script_concatenate (Title, ScriptTitle, 'script-title'); -- <bdi> tags, lang attribute, categorization, etc.; must be done after title is wrapped |
− | TransTitle = wrap_style ('trans-italic-title', TransTitle); | + | TransTitle = utilities.wrap_style ('trans-italic-title', TransTitle); |
| end | | end |
| | | |
| local TransError = ""; | | local TransError = ""; |
− | if is_set(TransTitle) then | + | if utilities.is_set (TransTitle) then |
− | if is_set(Title) then | + | if utilities.is_set (Title) then |
| TransTitle = " " .. TransTitle; | | TransTitle = " " .. TransTitle; |
| else | | else |
− | TransError = " " .. set_error( 'trans_missing_title', {'title'} ); | + | TransError = " " .. utilities.set_message ( 'err_trans_missing_title', {'title'} ); |
| end | | end |
| end | | end |
| | | |
− | if is_set(Title) then | + | if utilities.is_set (Title) then -- TODO: is this the right place to be making Wikisource URLs? |
− | if not is_set (TitleLink) and is_set (URL) then | + | if utilities.is_set (TitleLink) and utilities.is_set (URL) then |
− | Title = external_link (URL, Title, URLorigin, UrlAccess) .. TransTitle .. TransError .. Format; | + | table.insert( z.message_tail, { utilities.set_message ( 'err_wikilink_in_url', {}, true ) } ); -- set an error message because we can't have both |
| + | TitleLink = ''; -- unset |
| + | end |
| + | |
| + | if not utilities.is_set (TitleLink) and utilities.is_set (URL) then |
| + | Title = external_link (URL, Title, URL_origin, UrlAccess) .. TransTitle .. TransError .. Format; |
| URL = ''; -- unset these because no longer needed | | URL = ''; -- unset these because no longer needed |
| Format = ""; | | Format = ""; |
− | elseif is_set (TitleLink) and not is_set (URL) then | + | elseif utilities.is_set (TitleLink) and not utilities.is_set (URL) then |
| local ws_url; | | local ws_url; |
| ws_url = wikisource_url_make (TitleLink); -- ignore ws_label return; not used here | | ws_url = wikisource_url_make (TitleLink); -- ignore ws_label return; not used here |
| if ws_url then | | if ws_url then |
| Title = external_link (ws_url, Title .. ' ', 'ws link in title-link'); -- space char after Title to move icon away from italic text; TODO: a better way to do this? | | Title = external_link (ws_url, Title .. ' ', 'ws link in title-link'); -- space char after Title to move icon away from italic text; TODO: a better way to do this? |
− | Title = substitute (cfg.presentation['interwiki-icon'], {cfg.presentation['class-wikisource'], TitleLink, Title}); | + | Title = utilities.substitute (cfg.presentation['interwiki-icon'], {cfg.presentation['class-wikisource'], TitleLink, Title}); |
| Title = Title .. TransTitle .. TransError; | | Title = Title .. TransTitle .. TransError; |
| else | | else |
− | Title = make_wikilink (TitleLink, Title) .. TransTitle .. TransError; | + | Title = utilities.make_wikilink (TitleLink, Title) .. TransTitle .. TransError; |
| end | | end |
| else | | else |
− | local ws_url, ws_label; | + | local ws_url, ws_label, L; -- Title has italic or quote markup by the time we get here which causes is_wikilink() to return 0 (not a wikilink) |
− | ws_url, ws_label, L = wikisource_url_make (Title); -- make ws url from |title= interwiki link; link portion L becomes tool tip label | + | ws_url, ws_label, L = wikisource_url_make (Title:gsub('[\'"](.-)[\'"]', '%1')); -- make ws URL from |title= interwiki link (strip italic or quote markup); link portion L becomes tooltip label |
| if ws_url then | | if ws_url then |
| Title = Title:gsub ('%b[]', ws_label); -- replace interwiki link with ws_label to retain markup | | Title = Title:gsub ('%b[]', ws_label); -- replace interwiki link with ws_label to retain markup |
| Title = external_link (ws_url, Title .. ' ', 'ws link in title'); -- space char after Title to move icon away from italic text; TODO: a better way to do this? | | Title = external_link (ws_url, Title .. ' ', 'ws link in title'); -- space char after Title to move icon away from italic text; TODO: a better way to do this? |
− | Title = substitute (cfg.presentation['interwiki-icon'], {cfg.presentation['class-wikisource'], L, Title}); | + | Title = utilities.substitute (cfg.presentation['interwiki-icon'], {cfg.presentation['class-wikisource'], L, Title}); |
| Title = Title .. TransTitle .. TransError; | | Title = Title .. TransTitle .. TransError; |
| else | | else |
Sətir 3.116: |
Sətir 3.336: |
| end | | end |
| | | |
− | if is_set(Place) then | + | if utilities.is_set (Place) then |
| Place = " " .. wrap_msg ('written', Place, use_lowercase) .. sepc .. " "; | | Place = " " .. wrap_msg ('written', Place, use_lowercase) .. sepc .. " "; |
| end | | end |
| | | |
− | if is_set (Conference) then | + | if utilities.is_set (Conference) then |
− | if is_set (ConferenceURL) then | + | if utilities.is_set (ConferenceURL) then |
− | Conference = external_link( ConferenceURL, Conference, ConferenceURLorigin, nil ); | + | Conference = external_link( ConferenceURL, Conference, ConferenceURL_origin, nil ); |
| end | | end |
| Conference = sepc .. " " .. Conference .. ConferenceFormat; | | Conference = sepc .. " " .. Conference .. ConferenceFormat; |
− | elseif is_set(ConferenceURL) then | + | elseif utilities.is_set (ConferenceURL) then |
− | Conference = sepc .. " " .. external_link( ConferenceURL, nil, ConferenceURLorigin, nil ); | + | Conference = sepc .. " " .. external_link( ConferenceURL, nil, ConferenceURL_origin, nil ); |
| end | | end |
| | | |
− | if not is_set(Position) then | + | if not utilities.is_set (Position) then |
| local Minutes = A['Minutes']; | | local Minutes = A['Minutes']; |
| local Time = A['Time']; | | local Time = A['Time']; |
| | | |
− | if is_set(Minutes) then | + | if utilities.is_set (Minutes) then |
− | if is_set (Time) then | + | if utilities.is_set (Time) then |
− | table.insert( z.message_tail, { set_error( 'redundant_parameters', {wrap_style ('parameter', 'minutes') .. ' and ' .. wrap_style ('parameter', 'time')}, true ) } ); | + | table.insert( z.message_tail, { utilities.set_message ( 'err_redundant_parameters', {utilities.wrap_style ('parameter', 'minutes') .. ' and ' .. utilities.wrap_style ('parameter', 'time')}, true ) } ); |
| end | | end |
| Position = " " .. Minutes .. " " .. cfg.messages['minutes']; | | Position = " " .. Minutes .. " " .. cfg.messages['minutes']; |
| else | | else |
− | if is_set(Time) then | + | if utilities.is_set (Time) then |
| local TimeCaption = A['TimeCaption'] | | local TimeCaption = A['TimeCaption'] |
− | if not is_set(TimeCaption) then | + | if not utilities.is_set (TimeCaption) then |
| TimeCaption = cfg.messages['event']; | | TimeCaption = cfg.messages['event']; |
| if sepc ~= '.' then | | if sepc ~= '.' then |
Sətir 3.157: |
Sətir 3.377: |
| Page, Pages, Sheet, Sheets = format_pages_sheets (Page, Pages, Sheet, Sheets, config.CitationClass, Periodical_origin, sepc, NoPP, use_lowercase); | | Page, Pages, Sheet, Sheets = format_pages_sheets (Page, Pages, Sheet, Sheets, config.CitationClass, Periodical_origin, sepc, NoPP, use_lowercase); |
| | | |
− | At = is_set(At) and (sepc .. " " .. At) or ""; | + | At = utilities.is_set (At) and (sepc .. " " .. At) or ""; |
− | Position = is_set(Position) and (sepc .. " " .. Position) or ""; | + | Position = utilities.is_set (Position) and (sepc .. " " .. Position) or ""; |
| if config.CitationClass == 'map' then | | if config.CitationClass == 'map' then |
− | local Section = A['Section'];
| + | local Sections = A['Sections']; -- Section (singular) is an alias of Chapter so set earlier |
− | local Sections = A['Sections']; | |
| local Inset = A['Inset']; | | local Inset = A['Inset']; |
| | | |
− | if is_set( Inset ) then | + | if utilities.is_set ( Inset ) then |
| Inset = sepc .. " " .. wrap_msg ('inset', Inset, use_lowercase); | | Inset = sepc .. " " .. wrap_msg ('inset', Inset, use_lowercase); |
| end | | end |
| | | |
− | if is_set( Sections ) then | + | if utilities.is_set ( Sections ) then |
| Section = sepc .. " " .. wrap_msg ('sections', Sections, use_lowercase); | | Section = sepc .. " " .. wrap_msg ('sections', Sections, use_lowercase); |
− | elseif is_set( Section ) then | + | elseif utilities.is_set ( Section ) then |
| Section = sepc .. " " .. wrap_msg ('section', Section, use_lowercase); | | Section = sepc .. " " .. wrap_msg ('section', Section, use_lowercase); |
| end | | end |
Sətir 3.176: |
Sətir 3.395: |
| end | | end |
| | | |
− | if is_set (Language) then | + | if utilities.is_set (Language) then |
− | Language = language_parameter (Language); -- format, categories, name from ISO639-1, etc | + | Language = language_parameter (Language); -- format, categories, name from ISO639-1, etc. |
| else | | else |
| Language=""; -- language not specified so make sure this is an empty string; | | Language=""; -- language not specified so make sure this is an empty string; |
Sətir 3.185: |
Sətir 3.404: |
| end | | end |
| | | |
− | Others = is_set(Others) and (sepc .. " " .. Others) or ""; | + | Others = utilities.is_set (Others) and (sepc .. " " .. Others) or ""; |
| | | |
− | if is_set (Translators) then | + | if utilities.is_set (Translators) then |
| Others = safe_join ({sepc .. ' ', wrap_msg ('translated', Translators, use_lowercase), Others}, sepc); | | Others = safe_join ({sepc .. ' ', wrap_msg ('translated', Translators, use_lowercase), Others}, sepc); |
| end | | end |
− | if is_set (Interviewers) then | + | if utilities.is_set (Interviewers) then |
| Others = safe_join ({sepc .. ' ', wrap_msg ('interview', Interviewers, use_lowercase), Others}, sepc); | | Others = safe_join ({sepc .. ' ', wrap_msg ('interview', Interviewers, use_lowercase), Others}, sepc); |
| end | | end |
| | | |
− | TitleNote = is_set(TitleNote) and (sepc .. " " .. TitleNote) or ""; | + | TitleNote = utilities.is_set (TitleNote) and (sepc .. " " .. TitleNote) or ""; |
− | if is_set (Edition) then | + | if utilities.is_set (Edition) then |
| + | if Edition:match ('%f[%a][Ee]d%.?$') or Edition:match ('%f[%a][Ee]dition$') then |
| + | utilities.set_message ('maint_extra_text', 'edition'); -- add maint cat |
| + | end |
| Edition = " " .. wrap_msg ('edition', Edition); | | Edition = " " .. wrap_msg ('edition', Edition); |
| else | | else |
Sətir 3.201: |
Sətir 3.423: |
| end | | end |
| | | |
− | Series = is_set (Series) and wrap_msg ('series', {sepc, Series}) or ""; -- not the same as SeriesNum | + | Series = utilities.is_set (Series) and wrap_msg ('series', {sepc, Series}) or ""; -- not the same as SeriesNum |
− | OrigYear = is_set (OrigYear) and wrap_msg ('origyear', OrigYear) or ''; | + | OrigDate = utilities.is_set (OrigDate) and wrap_msg ('origdate', OrigDate) or ''; |
− | Agency = is_set (Agency) and wrap_msg ('agency', {sepc, Agency}) or ""; | + | Agency = utilities.is_set (Agency) and wrap_msg ('agency', {sepc, Agency}) or ""; |
| Volume = format_volume_issue (Volume, Issue, config.CitationClass, Periodical_origin, sepc, use_lowercase); | | Volume = format_volume_issue (Volume, Issue, config.CitationClass, Periodical_origin, sepc, use_lowercase); |
| | | |
| ------------------------------------ totally unrelated data | | ------------------------------------ totally unrelated data |
− | Via = is_set (Via) and wrap_msg ('via', Via) or ''; | + | Via = utilities.is_set (Via) and wrap_msg ('via', Via) or ''; |
− | | |
− | --[[
| |
− | Subscription implies paywall; Registration does not. If both are used in a citation, the subscription required link
| |
− | note is displayed. There are no error messages for this condition.
| |
− |
| |
− | ]]
| |
− | if is_set (SubscriptionRequired) then
| |
− | SubscriptionRequired = sepc .. " " .. cfg.messages['subscription']; -- subscription required message
| |
− | elseif is_set (RegistrationRequired) then
| |
− | SubscriptionRequired = sepc .. " " .. cfg.messages['registration']; -- registration required message
| |
− | else
| |
− | SubscriptionRequired = ''; -- either or both might be set to something other than yes true y
| |
− | end
| |
| | | |
− | if is_set(AccessDate) then | + | if utilities.is_set (AccessDate) then |
| local retrv_text = " " .. cfg.messages['retrieved'] | | local retrv_text = " " .. cfg.messages['retrieved'] |
| | | |
| AccessDate = nowrap_date (AccessDate); -- wrap in nowrap span if date in appropriate format | | AccessDate = nowrap_date (AccessDate); -- wrap in nowrap span if date in appropriate format |
| if (sepc ~= ".") then retrv_text = retrv_text:lower() end -- if mode is cs2, lower case | | if (sepc ~= ".") then retrv_text = retrv_text:lower() end -- if mode is cs2, lower case |
− | AccessDate = substitute (retrv_text, AccessDate); -- add retrieved text | + | AccessDate = utilities.substitute (retrv_text, AccessDate); -- add retrieved text |
| | | |
− | AccessDate = substitute (cfg.presentation['accessdate'], {sepc, AccessDate}); -- allow editors to hide accessdates | + | AccessDate = utilities.substitute (cfg.presentation['accessdate'], {sepc, AccessDate}); -- allow editors to hide accessdates |
| end | | end |
| | | |
− | if is_set(ID) then ID = sepc .." ".. ID; end | + | if utilities.is_set (ID) then ID = sepc .. " " .. ID; end |
− | if "thesis" == config.CitationClass and is_set(Docket) then | + | if "thesis" == config.CitationClass and utilities.is_set (Docket) then |
− | ID = sepc .." Docket ".. Docket .. ID; | + | ID = sepc .. " Docket " .. Docket .. ID; |
| end | | end |
− | if "report" == config.CitationClass and is_set(Docket) then -- for cite report when |docket= is set | + | if "report" == config.CitationClass and utilities.is_set (Docket) then -- for cite report when |docket= is set |
| ID = sepc .. ' ' .. Docket; -- overwrite ID even if |id= is set | | ID = sepc .. ' ' .. Docket; -- overwrite ID even if |id= is set |
| end | | end |
| | | |
− | ID_list = build_id_list( ID_list, {IdAccessLevels=ID_access_levels, DoiBroken = DoiBroken, ASINTLD = ASINTLD, IgnoreISBN = IgnoreISBN, Embargo=Embargo, Class = Class} ); | + | if utilities.is_set (URL) then |
| + | URL = " " .. external_link( URL, nil, URL_origin, UrlAccess ); |
| + | end |
| + | |
| + | if utilities.is_set (Quote) or utilities.is_set (TransQuote) or utilities.is_set (ScriptQuote) then |
| | | |
− | if is_set(URL) then
| + | if utilities.is_set (Quote) then |
− | URL = " " .. external_link( URL, nil, URLorigin, UrlAccess );
| + | if Quote:sub(1, 1) == '"' and Quote:sub(-1, -1) == '"' then -- if first and last characters of quote are quote marks |
− | end
| + | Quote = Quote:sub(2, -2); -- strip them off |
| + | end |
| + | end |
| + | |
| + | Quote = utilities.wrap_style ('quoted-text', Quote ); -- wrap in <q>...</q> tags |
| + | |
| + | if utilities.is_set (ScriptQuote) then |
| + | Quote = script_concatenate (Quote, ScriptQuote, 'script-quote'); -- <bdi> tags, lang attribute, categorization, etc.; must be done after quote is wrapped |
| + | end |
| | | |
− | if is_set(Quote) then
| + | if utilities.is_set (TransQuote) then |
− | if Quote:sub(1,1) == '"' and Quote:sub(-1,-1) == '"' then -- if first and last characters of quote are quote marks
| + | if TransQuote:sub(1, 1) == '"' and TransQuote:sub(-1, -1) == '"' then -- if first and last characters of |trans-quote are quote marks |
− | Quote = Quote:sub(2,-2); -- strip them off
| + | TransQuote = TransQuote:sub(2, -2); -- strip them off |
| + | end |
| + | Quote = Quote .. " " .. utilities.wrap_style ('trans-quoted-title', TransQuote ); |
| end | | end |
− | Quote = sepc .." " .. wrap_style ('quoted-text', Quote ); -- wrap in <q>...</q> tags | + | |
| + | if utilities.is_set (QuotePage) or utilities.is_set (QuotePages) then -- add page prefix |
| + | local quote_prefix = ''; |
| + | if utilities.is_set (QuotePage) then |
| + | if not NoPP then |
| + | quote_prefix = utilities.substitute (cfg.messages['p-prefix'], {sepc, QuotePage}), '', '', ''; |
| + | else |
| + | quote_prefix = utilities.substitute (cfg.messages['nopp'], {sepc, QuotePage}), '', '', ''; |
| + | end |
| + | elseif utilities.is_set (QuotePages) then |
| + | if tonumber(QuotePages) ~= nil and not NoPP then -- if only digits, assume single page |
| + | quote_prefix = utilities.substitute (cfg.messages['p-prefix'], {sepc, QuotePages}), '', ''; |
| + | elseif not NoPP then |
| + | quote_prefix = utilities.substitute (cfg.messages['pp-prefix'], {sepc, QuotePages}), '', ''; |
| + | else |
| + | quote_prefix = utilities.substitute (cfg.messages['nopp'], {sepc, QuotePages}), '', ''; |
| + | end |
| + | end |
| + | |
| + | Quote = quote_prefix .. ": " .. Quote; |
| + | else |
| + | Quote = sepc .. " " .. Quote; |
| + | end |
| + | |
| PostScript = ""; -- cs1|2 does not supply terminal punctuation when |quote= is set | | PostScript = ""; -- cs1|2 does not supply terminal punctuation when |quote= is set |
| end | | end |
| | | |
| local Archived | | local Archived |
− | if is_set(ArchiveURL) then | + | if utilities.is_set (ArchiveURL) then |
− | if not is_set(ArchiveDate) then | + | local arch_text; |
− | ArchiveDate = set_error('archive_missing_date'); | + | if not utilities.is_set (ArchiveDate) then |
| + | ArchiveDate = utilities.set_message ('err_archive_missing_date'); |
| end | | end |
| if "live" == UrlStatus then | | if "live" == UrlStatus then |
− | local arch_text = cfg.messages['archived']; | + | arch_text = cfg.messages['archived']; |
| if sepc ~= "." then arch_text = arch_text:lower() end | | if sepc ~= "." then arch_text = arch_text:lower() end |
− | Archived = sepc .. " " .. substitute( cfg.messages['archived-live'], | + | Archived = sepc .. " " .. utilities.substitute ( cfg.messages['archived-live'], |
| { external_link( ArchiveURL, arch_text, A:ORIGIN('ArchiveURL'), nil ) .. ArchiveFormat, ArchiveDate } ); | | { external_link( ArchiveURL, arch_text, A:ORIGIN('ArchiveURL'), nil ) .. ArchiveFormat, ArchiveDate } ); |
− | if not is_set(OriginalURL) then | + | if not utilities.is_set (OriginalURL) then |
− | Archived = Archived .. " " .. set_error('archive_missing_url'); | + | Archived = Archived .. " " .. utilities.set_message ('err_archive_missing_url'); |
| end | | end |
− | elseif is_set(OriginalURL) then -- UrlStatus is empty, 'dead', 'unfit', 'usurped', 'bot: unknown' | + | elseif utilities.is_set (OriginalURL) then -- UrlStatus is empty, 'dead', 'unfit', 'usurped', 'bot: unknown' |
− | local arch_text = cfg.messages['archived-dead']; | + | if utilities.in_array (UrlStatus, {'unfit', 'usurped', 'bot: unknown'}) then |
− | if sepc ~= "." then arch_text = arch_text:lower() end
| + | arch_text = cfg.messages['archived-unfit']; |
− | if in_array (UrlStatus, {'unfit', 'usurped', 'bot: unknown'}) then
| + | if sepc ~= "." then arch_text = arch_text:lower() end |
− | Archived = sepc .. " " .. 'Archived from the original on ' .. ArchiveDate; -- format already styled | + | Archived = sepc .. " " .. arch_text .. ArchiveDate; -- format already styled |
| + | if 'bot: unknown' == UrlStatus then |
| + | utilities.set_message ('maint_bot_unknown'); -- and add a category if not already added |
| + | else |
| + | utilities.set_message ('maint_unfit'); -- and add a category if not already added |
| + | end |
| else -- UrlStatus is empty, 'dead' | | else -- UrlStatus is empty, 'dead' |
− | Archived = sepc .. " " .. substitute( arch_text, | + | arch_text = cfg.messages['archived-dead']; |
− | { external_link( OriginalURL, cfg.messages['original'], OriginalURLorigin, OriginalAccess ) .. OriginalFormat, ArchiveDate } ); -- format already styled | + | if sepc ~= "." then arch_text = arch_text:lower() end |
| + | Archived = sepc .. " " .. utilities.substitute ( arch_text, |
| + | { external_link( OriginalURL, cfg.messages['original'], OriginalURL_origin, OriginalAccess ) .. OriginalFormat, ArchiveDate } ); -- format already styled |
| end | | end |
− | else | + | else -- OriginalUrl not set |
− | local arch_text = cfg.messages['archived-missing']; | + | arch_text = cfg.messages['archived-missing']; |
| if sepc ~= "." then arch_text = arch_text:lower() end | | if sepc ~= "." then arch_text = arch_text:lower() end |
− | Archived = sepc .. " " .. substitute( arch_text, | + | Archived = sepc .. " " .. utilities.substitute ( arch_text, |
− | { set_error('archive_missing_url'), ArchiveDate } ); | + | { utilities.set_message ('err_archive_missing_url'), ArchiveDate } ); |
| end | | end |
− | elseif is_set (ArchiveFormat) then | + | elseif utilities.is_set (ArchiveFormat) then |
| Archived = ArchiveFormat; -- if set and ArchiveURL not set ArchiveFormat has error message | | Archived = ArchiveFormat; -- if set and ArchiveURL not set ArchiveFormat has error message |
| else | | else |
Sətir 3.289: |
Sətir 3.543: |
| | | |
| local Lay = ''; | | local Lay = ''; |
− | if is_set(LayURL) then | + | if utilities.is_set (LayURL) then |
− | if is_set(LayDate) then LayDate = " (" .. LayDate .. ")" end | + | if utilities.is_set (LayDate) then LayDate = " (" .. LayDate .. ")" end |
− | if is_set(LaySource) then | + | if utilities.is_set (LaySource) then |
− | LaySource = " – ''" .. safe_for_italics(LaySource) .. "''"; | + | LaySource = " – ''" .. utilities.safe_for_italics (LaySource) .. "''"; |
| else | | else |
| LaySource = ""; | | LaySource = ""; |
Sətir 3.301: |
Sətir 3.555: |
| Lay = sepc .. " " .. external_link( LayURL, cfg.messages['lay summary']:lower(), A:ORIGIN('LayURL'), nil ) .. LayFormat .. LaySource .. LayDate | | Lay = sepc .. " " .. external_link( LayURL, cfg.messages['lay summary']:lower(), A:ORIGIN('LayURL'), nil ) .. LayFormat .. LaySource .. LayDate |
| end | | end |
− | elseif is_set (LayFormat) then -- Test if |lay-format= is given without giving a |lay-url= | + | elseif utilities.is_set (LayFormat) then -- Test if |lay-format= is given without giving a |lay-url= |
| Lay = sepc .. LayFormat; -- if set and LayURL not set, then LayFormat has error message | | Lay = sepc .. LayFormat; -- if set and LayURL not set, then LayFormat has error message |
| end | | end |
| | | |
− | if is_set(Transcript) then | + | if utilities.is_set (Transcript) then |
− | if is_set(TranscriptURL) then | + | if utilities.is_set (TranscriptURL) then |
− | Transcript = external_link( TranscriptURL, Transcript, TranscriptURLorigin, nil ); | + | Transcript = external_link( TranscriptURL, Transcript, TranscriptURL_origin, nil ); |
| end | | end |
| Transcript = sepc .. ' ' .. Transcript .. TranscriptFormat; | | Transcript = sepc .. ' ' .. Transcript .. TranscriptFormat; |
− | elseif is_set(TranscriptURL) then | + | elseif utilities.is_set (TranscriptURL) then |
− | Transcript = external_link( TranscriptURL, nil, TranscriptURLorigin, nil ); | + | Transcript = external_link( TranscriptURL, nil, TranscriptURL_origin, nil ); |
| end | | end |
| | | |
| local Publisher; | | local Publisher; |
− | if is_set(PublicationDate) then | + | if utilities.is_set (PublicationDate) then |
| PublicationDate = wrap_msg ('published', PublicationDate); | | PublicationDate = wrap_msg ('published', PublicationDate); |
| end | | end |
− | if is_set(PublisherName) then | + | if utilities.is_set (PublisherName) then |
− | if is_set(PublicationPlace) then | + | if utilities.is_set (PublicationPlace) then |
| Publisher = sepc .. " " .. PublicationPlace .. ": " .. PublisherName .. PublicationDate; | | Publisher = sepc .. " " .. PublicationPlace .. ": " .. PublisherName .. PublicationDate; |
| else | | else |
| Publisher = sepc .. " " .. PublisherName .. PublicationDate; | | Publisher = sepc .. " " .. PublisherName .. PublicationDate; |
| end | | end |
− | elseif is_set(PublicationPlace) then | + | elseif utilities.is_set (PublicationPlace) then |
| Publisher= sepc .. " " .. PublicationPlace .. PublicationDate; | | Publisher= sepc .. " " .. PublicationPlace .. PublicationDate; |
| else | | else |
Sətir 3.331: |
Sətir 3.585: |
| | | |
| -- Several of the above rely upon detecting this as nil, so do it last. | | -- Several of the above rely upon detecting this as nil, so do it last. |
− | if (is_set (Periodical) or is_set (ScriptPeriodical) or is_set (TransPeriodical)) then | + | if (utilities.is_set (Periodical) or utilities.is_set (ScriptPeriodical) or utilities.is_set (TransPeriodical)) then |
− | if is_set(Title) or is_set(TitleNote) then | + | if utilities.is_set (Title) or utilities.is_set (TitleNote) then |
− | Periodical = sepc .. " " .. format_periodical (ScriptPeriodical, ScriptPeriodical_origin, Periodical, TransPeriodical); | + | Periodical = sepc .. " " .. format_periodical (ScriptPeriodical, ScriptPeriodical_origin, Periodical, TransPeriodical, TransPeriodical_origin); |
| else | | else |
− | Periodical = format_periodical (ScriptPeriodical, ScriptPeriodical_origin, Periodical, TransPeriodical); | + | Periodical = format_periodical (ScriptPeriodical, ScriptPeriodical_origin, Periodical, TransPeriodical, TransPeriodical_origin); |
| end | | end |
| end | | end |
Sətir 3.345: |
Sətir 3.599: |
| if "speech" == config.CitationClass then -- cite speech only | | if "speech" == config.CitationClass then -- cite speech only |
| TitleNote = " (Speech)"; -- annotate the citation | | TitleNote = " (Speech)"; -- annotate the citation |
− | if is_set (Periodical) then -- if Periodical, perhaps because of an included |website= or |journal= parameter | + | if utilities.is_set (Periodical) then -- if Periodical, perhaps because of an included |website= or |journal= parameter |
− | if is_set (Conference) then -- and if |event= is set | + | if utilities.is_set (Conference) then -- and if |event= is set |
| Conference = Conference .. sepc .. " "; -- then add appropriate punctuation to the end of the Conference variable before rendering | | Conference = Conference .. sepc .. " "; -- then add appropriate punctuation to the end of the Conference variable before rendering |
| end | | end |
Sətir 3.359: |
Sətir 3.613: |
| local tcommon2; -- used for book cite when |contributor= is set | | local tcommon2; -- used for book cite when |contributor= is set |
| | | |
− | if in_array(config.CitationClass, {"journal","citation"}) and is_set(Periodical) then | + | if utilities.in_array (config.CitationClass, {"journal", "citation"}) and utilities.is_set (Periodical) then |
− | if is_set(Others) then Others = safe_join ({Others, sepc .. " "}, sepc) end -- add terminal punctuation & space; check for dup sepc; TODO why do we need to do this here? | + | if utilities.is_set (Others) then Others = safe_join ({Others, sepc .. " "}, sepc) end -- add terminal punctuation & space; check for dup sepc; TODO why do we need to do this here? |
| tcommon = safe_join( {Others, Title, TitleNote, Conference, Periodical, Format, TitleType, Series, Language, Edition, Publisher, Agency, Volume}, sepc ); | | tcommon = safe_join( {Others, Title, TitleNote, Conference, Periodical, Format, TitleType, Series, Language, Edition, Publisher, Agency, Volume}, sepc ); |
− | elseif in_array(config.CitationClass, {"book","citation"}) and not is_set(Periodical) then -- special cases for book cites | + | elseif utilities.in_array (config.CitationClass, {"book", "citation"}) and not utilities.is_set (Periodical) then -- special cases for book cites |
− | if is_set (Contributors) then -- when we are citing foreword, preface, introduction, etc | + | if utilities.is_set (Contributors) then -- when we are citing foreword, preface, introduction, etc. |
| tcommon = safe_join( {Title, TitleNote}, sepc ); -- author and other stuff will come after this and before tcommon2 | | tcommon = safe_join( {Title, TitleNote}, sepc ); -- author and other stuff will come after this and before tcommon2 |
| tcommon2 = safe_join( {Conference, Periodical, Format, TitleType, Series, Language, Volume, Others, Edition, Publisher, Agency}, sepc ); | | tcommon2 = safe_join( {Conference, Periodical, Format, TitleType, Series, Language, Volume, Others, Edition, Publisher, Agency}, sepc ); |
Sətir 3.371: |
Sətir 3.625: |
| | | |
| elseif 'map' == config.CitationClass then -- special cases for cite map | | elseif 'map' == config.CitationClass then -- special cases for cite map |
− | if is_set (Chapter) then -- map in a book; TitleType is part of Chapter | + | if utilities.is_set (Chapter) then -- map in a book; TitleType is part of Chapter |
| tcommon = safe_join( {Title, Format, Edition, Scale, Series, Language, Cartography, Others, Publisher, Volume}, sepc ); | | tcommon = safe_join( {Title, Format, Edition, Scale, Series, Language, Cartography, Others, Publisher, Volume}, sepc ); |
− | elseif is_set (Periodical) then -- map in a periodical | + | elseif utilities.is_set (Periodical) then -- map in a periodical |
| tcommon = safe_join( {Title, TitleType, Format, Periodical, Scale, Series, Language, Cartography, Others, Publisher, Volume}, sepc ); | | tcommon = safe_join( {Title, TitleType, Format, Periodical, Scale, Series, Language, Cartography, Others, Publisher, Volume}, sepc ); |
| else -- a sheet or stand-alone map | | else -- a sheet or stand-alone map |
Sətir 3.395: |
Sətir 3.649: |
| local idcommon; | | local idcommon; |
| if 'audio-visual' == config.CitationClass or 'episode' == config.CitationClass then -- special case for cite AV media & cite episode position transcript | | if 'audio-visual' == config.CitationClass or 'episode' == config.CitationClass then -- special case for cite AV media & cite episode position transcript |
− | idcommon = safe_join( { ID_list, URL, Archived, Transcript, AccessDate, Via, SubscriptionRequired, Lay, Quote }, sepc ); | + | idcommon = safe_join( { ID_list, URL, Archived, Transcript, AccessDate, Via, Lay, Quote }, sepc ); |
| else | | else |
− | idcommon = safe_join( { ID_list, URL, Archived, AccessDate, Via, SubscriptionRequired, Lay, Quote }, sepc ); | + | idcommon = safe_join( { ID_list, URL, Archived, AccessDate, Via, Lay, Quote }, sepc ); |
| end | | end |
| | | |
Sətir 3.403: |
Sətir 3.657: |
| local pgtext = Position .. Sheet .. Sheets .. Page .. Pages .. At; | | local pgtext = Position .. Sheet .. Sheets .. Page .. Pages .. At; |
| | | |
− | if is_set(Date) then | + | if utilities.is_set (Date) then |
− | if is_set (Authors) or is_set (Editors) then -- date follows authors or editors when authors not set | + | if utilities.is_set (Authors) or utilities.is_set (Editors) then -- date follows authors or editors when authors not set |
− | Date = " (" .. Date ..")" .. OrigYear .. sepc .. " "; -- in paranetheses | + | Date = " (" .. Date .. ")" .. OrigDate .. sepc .. " "; -- in parentheses |
| else -- neither of authors and editors set | | else -- neither of authors and editors set |
− | if (string.sub(tcommon,-1,-1) == sepc) then -- if the last character of tcommon is sepc | + | if (string.sub(tcommon, -1, -1) == sepc) then -- if the last character of tcommon is sepc |
− | Date = " " .. Date .. OrigYear; -- Date does not begin with sepc | + | Date = " " .. Date .. OrigDate; -- Date does not begin with sepc |
| else | | else |
− | Date = sepc .. " " .. Date .. OrigYear; -- Date begins with sepc | + | Date = sepc .. " " .. Date .. OrigDate; -- Date begins with sepc |
| end | | end |
| end | | end |
| end | | end |
− | if is_set(Authors) then | + | if utilities.is_set (Authors) then |
− | if (not is_set (Date)) then -- when date is set it's in parentheses; no Authors termination | + | if (not utilities.is_set (Date)) then -- when date is set it's in parentheses; no Authors termination |
| Authors = terminate_name_list (Authors, sepc); -- when no date, terminate with 0 or 1 sepc and a space | | Authors = terminate_name_list (Authors, sepc); -- when no date, terminate with 0 or 1 sepc and a space |
| end | | end |
− | if is_set(Editors) then | + | if utilities.is_set (Editors) then |
| local in_text = " "; | | local in_text = " "; |
| local post_text = ""; | | local post_text = ""; |
− | if is_set(Chapter) and 0 == #c then | + | if utilities.is_set (Chapter) and 0 == #c then |
| in_text = in_text .. cfg.messages['in'] .. " " | | in_text = in_text .. cfg.messages['in'] .. " " |
| if (sepc ~= '.') then | | if (sepc ~= '.') then |
Sətir 3.434: |
Sətir 3.688: |
| Editors = terminate_name_list (in_text .. Editors .. post_text, sepc); -- terminate with 0 or 1 sepc and a space | | Editors = terminate_name_list (in_text .. Editors .. post_text, sepc); -- terminate with 0 or 1 sepc and a space |
| end | | end |
− | if is_set (Contributors) then -- book cite and we're citing the intro, preface, etc | + | if utilities.is_set (Contributors) then -- book cite and we're citing the intro, preface, etc. |
| local by_text = sepc .. ' ' .. cfg.messages['by'] .. ' '; | | local by_text = sepc .. ' ' .. cfg.messages['by'] .. ' '; |
| if (sepc ~= '.') then by_text = by_text:lower() end -- lowercase for cs2 | | if (sepc ~= '.') then by_text = by_text:lower() end -- lowercase for cs2 |
| Authors = by_text .. Authors; -- author follows title so tweak it here | | Authors = by_text .. Authors; -- author follows title so tweak it here |
− | if is_set (Editors) and is_set (Date) then -- when Editors make sure that Authors gets terminated | + | if utilities.is_set (Editors) and utilities.is_set (Date) then -- when Editors make sure that Authors gets terminated |
| Authors = terminate_name_list (Authors, sepc); -- terminate with 0 or 1 sepc and a space | | Authors = terminate_name_list (Authors, sepc); -- terminate with 0 or 1 sepc and a space |
| end | | end |
− | if (not is_set (Date)) then -- when date is set it's in parentheses; no Contributors termination | + | if (not utilities.is_set (Date)) then -- when date is set it's in parentheses; no Contributors termination |
| Contributors = terminate_name_list (Contributors, sepc); -- terminate with 0 or 1 sepc and a space | | Contributors = terminate_name_list (Contributors, sepc); -- terminate with 0 or 1 sepc and a space |
| end | | end |
Sətir 3.448: |
Sətir 3.702: |
| text = safe_join( {Authors, Date, Chapter, Place, Editors, tcommon, pgtext, idcommon }, sepc ); | | text = safe_join( {Authors, Date, Chapter, Place, Editors, tcommon, pgtext, idcommon }, sepc ); |
| end | | end |
− | elseif is_set(Editors) then | + | elseif utilities.is_set (Editors) then |
− | if is_set(Date) then | + | if utilities.is_set (Date) then |
| if EditorCount <= 1 then | | if EditorCount <= 1 then |
| Editors = Editors .. ", " .. cfg.messages['editor']; | | Editors = Editors .. ", " .. cfg.messages['editor']; |
Sətir 3.464: |
Sətir 3.718: |
| text = safe_join( {Editors, Date, Chapter, Place, tcommon, pgtext, idcommon}, sepc ); | | text = safe_join( {Editors, Date, Chapter, Place, tcommon, pgtext, idcommon}, sepc ); |
| else | | else |
− | if in_array(config.CitationClass, {"journal","citation"}) and is_set(Periodical) then | + | if utilities.in_array (config.CitationClass, {"journal", "citation"}) and utilities.is_set (Periodical) then |
| text = safe_join( {Chapter, Place, tcommon, pgtext, Date, idcommon}, sepc ); | | text = safe_join( {Chapter, Place, tcommon, pgtext, Date, idcommon}, sepc ); |
| else | | else |
Sətir 3.471: |
Sətir 3.725: |
| end | | end |
| | | |
− | if is_set(PostScript) and PostScript ~= sepc then | + | if utilities.is_set (PostScript) and PostScript ~= sepc then |
| text = safe_join( {text, sepc}, sepc ); --Deals with italics, spaces, etc. | | text = safe_join( {text, sepc}, sepc ); --Deals with italics, spaces, etc. |
− | text = text:sub(1,-sepc:len()-1); | + | text = text:sub(1, -sepc:len() - 1); |
| end | | end |
| | | |
Sətir 3.481: |
Sətir 3.735: |
| local options = {}; | | local options = {}; |
| | | |
− | if is_set(config.CitationClass) and config.CitationClass ~= "citation" then | + | if utilities.is_set (config.CitationClass) and config.CitationClass ~= "citation" then |
− | options.class = config.CitationClass; | + | options.class = string.format ('%s %s %s', 'citation', config.CitationClass, utilities.is_set (Mode) and Mode or 'cs1'); -- class=citation required for blue highlight when used with |ref= |
− | options.class = "citation " .. config.CitationClass; -- class=citation required for blue highlight when used with |ref=
| |
| else | | else |
− | options.class = "citation"; | + | options.class = string.format ('%s %s', 'citation', utilities.is_set (Mode) and Mode or 'cs2'); |
| end | | end |
| | | |
− | if is_set(Ref) and Ref:lower() ~= "none" then -- set reference anchor if appropriate | + | if utilities.is_set (Ref) and 'none' ~= cfg.keywords_xlate[Ref:lower()] then |
| local id = Ref | | local id = Ref |
| if ('harv' == Ref ) then | | if ('harv' == Ref ) then |
Sətir 3.510: |
Sətir 3.763: |
| end | | end |
| | | |
− | if string.len(text:gsub("<span[^>/]*>(.-)</span>", "%1"):gsub("%b<>","")) <= 2 then -- remove <span> tags and other html-like markup; then get length of what remains | + | if string.len(text:gsub("<span[^>/]*>(.-)</span>", "%1"):gsub("%b<>", "")) <= 2 then -- remove <span> tags and other HTML-like markup; then get length of what remains |
| z.error_categories = {}; | | z.error_categories = {}; |
− | text = set_error('empty_citation'); | + | text = utilities.set_message ('err_empty_citation'); |
| z.message_tail = {}; | | z.message_tail = {}; |
| end | | end |
Sətir 3.518: |
Sətir 3.771: |
| local render = {}; -- here we collect the final bits for concatenation into the rendered citation | | local render = {}; -- here we collect the final bits for concatenation into the rendered citation |
| | | |
− | if is_set(options.id) then -- here we wrap the rendered citation in <cite ...>...</cite> tags | + | if utilities.is_set (options.id) then -- here we wrap the rendered citation in <cite ...>...</cite> tags |
− | table.insert (render, substitute (cfg.presentation['cite-id'], {mw.uri.anchorEncode(options.id), mw.text.nowiki(options.class), text})); -- when |ref= is set | + | table.insert (render, utilities.substitute (cfg.presentation['cite-id'], {mw.uri.anchorEncode(options.id), mw.text.nowiki(options.class), text})); -- when |ref= is set |
| else | | else |
− | table.insert (render, substitute (cfg.presentation['cite'], {mw.text.nowiki(options.class), text})); -- all other cases | + | table.insert (render, utilities.substitute (cfg.presentation['cite'], {mw.text.nowiki(options.class), text})); -- all other cases |
| end | | end |
| | | |
− | table.insert (render, substitute (cfg.presentation['ocins'], {OCinSoutput})); -- append metadata to the citation | + | table.insert (render, utilities.substitute (cfg.presentation['ocins'], {OCinSoutput})); -- append metadata to the citation |
| | | |
| if 0 ~= #z.message_tail then | | if 0 ~= #z.message_tail then |
| table.insert (render, ' '); | | table.insert (render, ' '); |
| for i,v in ipairs( z.message_tail ) do | | for i,v in ipairs( z.message_tail ) do |
− | if is_set(v[1]) then | + | if utilities.is_set (v[1]) then |
| if i == #z.message_tail then | | if i == #z.message_tail then |
− | table.insert (render, error_comment( v[1], v[2] )); | + | table.insert (render, utilities.error_comment ( v[1], v[2] )); |
| else | | else |
− | table.insert (render, error_comment( v[1] .. "; ", v[2] )); | + | table.insert (render, utilities.error_comment ( v[1] .. "; ", v[2] )); |
| end | | end |
| end | | end |
Sətir 3.545: |
Sətir 3.798: |
| table.insert (maint, v); -- maint msg is the category name | | table.insert (maint, v); -- maint msg is the category name |
| table.insert (maint, ' ('); -- open the link text | | table.insert (maint, ' ('); -- open the link text |
− | table.insert (maint, make_wikilink (':Category:' .. v, 'link')); -- add the link | + | table.insert (maint, utilities.make_wikilink (':Category:' .. v, 'link')); -- add the link |
| table.insert (maint, ')'); -- and close it | | table.insert (maint, ')'); -- and close it |
| table.insert (maint_msgs, table.concat (maint)); -- assemble new maint message and add it to the maint_msgs table | | table.insert (maint_msgs, table.concat (maint)); -- assemble new maint message and add it to the maint_msgs table |
| end | | end |
− | table.insert (render, substitute (cfg.presentation['hidden-maint'], table.concat (maint_msgs, ' '))); -- wrap the group of maint message with proper presentation and save | + | table.insert (render, utilities.substitute (cfg.presentation['hidden-maint'], table.concat (maint_msgs, ' '))); -- wrap the group of maint message with proper presentation and save |
| end | | end |
| | | |
− | no_tracking_cats = no_tracking_cats:lower();
| + | if not no_tracking_cats then |
− | if in_array(no_tracking_cats, {"", "no", "false", "n"}) then | |
| for _, v in ipairs( z.error_categories ) do | | for _, v in ipairs( z.error_categories ) do |
− | table.insert (render, make_wikilink ('Category:' .. v)); | + | table.insert (render, utilities.make_wikilink ('Category:' .. v)); |
| end | | end |
| for _, v in ipairs( z.maintenance_cats ) do -- append maintenance categories | | for _, v in ipairs( z.maintenance_cats ) do -- append maintenance categories |
− | table.insert (render, make_wikilink ('Category:' .. v)); | + | table.insert (render, utilities.make_wikilink ('Category:' .. v)); |
| end | | end |
| for _, v in ipairs( z.properties_cats ) do -- append properties categories | | for _, v in ipairs( z.properties_cats ) do -- append properties categories |
− | table.insert (render, make_wikilink ('Category:' .. v)); | + | table.insert (render, utilities.make_wikilink ('Category:' .. v)); |
| end | | end |
| + | elseif 'nocat' == A:ORIGIN('NoTracking') then -- peculiar special case; can't track nocat without tracking nocat |
| + | table.insert (render, utilities.make_wikilink ('Category:CS1 maint: nocat')); -- hand-set this category because it is supposed to be temporary |
| end | | end |
| | | |
Sətir 3.580: |
Sətir 3.834: |
| ]] | | ]] |
| | | |
− | local function validate (name, cite_class) | + | local function validate (name, cite_class, empty) |
| local name = tostring (name); | | local name = tostring (name); |
| + | local enum_name; -- for enumerated parameters, is name with enumerator replaced with '#' |
| local state; | | local state; |
− | | + | local function state_test (state, name) -- local function to do testing of state values |
− | if in_array (cite_class, {'arxiv', 'biorxiv', 'citeseerx', 'ssrn'}) then -- limited parameter sets allowed for these templates
| |
− | state = whitelist.limited_basic_arguments[name];
| |
| if true == state then return true; end -- valid actively supported parameter | | if true == state then return true; end -- valid actively supported parameter |
| if false == state then | | if false == state then |
| + | if empty then return nil; end -- deprecated empty parameters are treated as unknowns |
| deprecated_parameter (name); -- parameter is deprecated but still supported | | deprecated_parameter (name); -- parameter is deprecated but still supported |
| return true; | | return true; |
| end | | end |
| + | return nil; |
| + | end |
| + | |
| + | if name:find ('#') then -- # is a cs1|2 reserved character so parameters with # not permitted |
| + | return nil; |
| + | end |
| + | |
| + | if utilities.in_array (cite_class, whitelist.preprint_template_list ) then -- limited parameter sets allowed for these templates |
| + | state = whitelist.limited_basic_arguments[name]; |
| + | if true == state_test (state, name) then return true; end |
| | | |
− | state = whitelist[cite_class .. '_basic_arguments'][name]; -- look in the parameter-list for the template identified by cite_class | + | state = whitelist.preprint_arguments[cite_class][name]; -- look in the parameter-list for the template identified by cite_class |
| + | if true == state_test (state, name) then return true; end |
| | | |
− | if true == state then return true; end -- valid actively supported parameter
| |
− | if false == state then
| |
− | deprecated_parameter (name); -- parameter is deprecated but still supported
| |
− | return true;
| |
− | end
| |
| -- limited enumerated parameters list | | -- limited enumerated parameters list |
− | name = name:gsub("%d+", "#" ); -- replace digit(s) with # (last25 becomes last#) (mw.ustring because non-Western 'local' digits) | + | enum_name = name:gsub("%d+", "#" ); -- replace digit(s) with # (last25 becomes last#) (mw.ustring because non-Western 'local' digits) |
− | state = whitelist.limited_numbered_arguments[name]; | + | state = whitelist.limited_numbered_arguments[enum_name]; |
− | if true == state then return true; end -- valid actively supported parameter | + | if true == state_test (state, name) then return true; end |
− | if false == state then
| |
− | deprecated_parameter (name); -- parameter is deprecated but still supported
| |
− | return true;
| |
− | end
| |
| | | |
| return false; -- not supported because not found or name is set to nil | | return false; -- not supported because not found or name is set to nil |
| end -- end limited parameter-set templates | | end -- end limited parameter-set templates |
| + | |
| + | if utilities.in_array (cite_class, whitelist.unique_param_template_list) then -- experiment for template-specific parameters for templates that accept parameters from the basic argument list |
| + | state = whitelist.unique_arguments[cite_class][name]; -- look in the template-specific parameter-lists for the template identified by cite_class |
| + | if true == state_test (state, name) then return true; end |
| + | end -- if here, fall into general validation |
| | | |
| state = whitelist.basic_arguments[name]; -- all other templates; all normal parameters allowed | | state = whitelist.basic_arguments[name]; -- all other templates; all normal parameters allowed |
− |
| + | if true == state_test (state, name) then return true; end |
− | if true == state then return true; end -- valid actively supported parameter | + | |
− | if false == state then
| |
− | deprecated_parameter (name); -- parameter is deprecated but still supported
| |
− | return true;
| |
− | end
| |
| -- all enumerated parameters allowed | | -- all enumerated parameters allowed |
− | name = name:gsub("%d+", "#" ); -- replace digit(s) with # (last25 becomes last#) (mw.ustring because non-Western 'local' digits) | + | enum_name = name:gsub("%d+", "#" ); -- replace digit(s) with # (last25 becomes last#) (mw.ustring because non-Western 'local' digits) |
− | state = whitelist.numbered_arguments[name]; | + | state = whitelist.numbered_arguments[enum_name]; |
| + | if true == state_test (state, name) then return true; end |
| + | |
| + | return false; -- not supported because not found or name is set to nil |
| + | end |
| | | |
− | if true == state then return true; end -- valid actively supported parameter | + | |
− | if false == state then | + | --[=[-------------------------< I N T E R _ W I K I _ C H E C K >---------------------------------------------- |
− | deprecated_parameter (name); -- parameter is deprecated but still supported | + | |
− | return true; | + | check <value> for inter-language interwiki-link markup. <prefix> must be a MediaWiki-recognized language |
| + | code. when these values have the form (without leading colon): |
| + | [[<prefix>:link|label]] return label as plain-text |
| + | [[<prefix>:link]] return <prefix>:link as plain-text |
| + | |
| + | return value as is else |
| + | |
| + | ]=] |
| + | |
| + | local function inter_wiki_check (parameter, value) |
| + | local prefix = value:match ('%[%[(%a+):'); -- get an interwiki prefix if one exists |
| + | local _; |
| + | |
| + | if prefix and cfg.inter_wiki_map[prefix:lower()] then -- if prefix is in the map, needs preceding colon so |
| + | table.insert( z.message_tail, {utilities.set_message ('err_bad_paramlink', parameter)}); -- emit an error message |
| + | _, value, _ = utilities.is_wikilink (value); -- extract label portion from wikilink |
| end | | end |
− |
| + | return value; |
− | return false; -- not supported because not found or name is set to nil | |
| end | | end |
| | | |
Sətir 3.636: |
Sətir 3.911: |
| Look at the contents of a parameter. If the content has a string of characters and digits followed by an equal | | Look at the contents of a parameter. If the content has a string of characters and digits followed by an equal |
| sign, compare the alphanumeric string to the list of cs1|2 parameters. If found, then the string is possibly a | | sign, compare the alphanumeric string to the list of cs1|2 parameters. If found, then the string is possibly a |
− | parameter that is missing its pipe: | + | parameter that is missing its pipe. There are two tests made: |
− | {{cite ... |title=Title access-date=2016-03-17}} | + | {{cite ... |title=Title access-date=2016-03-17}} -- the first parameter has a value and whitespace separates that value from the missing pipe parameter name |
− | | + | {{cite ... |title=access-date=2016-03-17}} -- the first parameter has no value (whitespace after the first = is trimmed by MediaWiki) |
− | cs1|2 shares some parameter names with xml/html atributes: class=, title=, etc. To prevent false positives xml/html | + | cs1|2 shares some parameter names with XML/HTML attributes: class=, title=, etc. To prevent false positives XML/HTML |
| tags are removed before the search. | | tags are removed before the search. |
| | | |
Sətir 3.648: |
Sətir 3.923: |
| local function missing_pipe_check (parameter, value) | | local function missing_pipe_check (parameter, value) |
| local capture; | | local capture; |
− | value = value:gsub ('%b<>', ''); -- remove xml/html tags because attributes: class=, title=, etc | + | value = value:gsub ('%b<>', ''); -- remove XML/HTML tags because attributes: class=, title=, etc. |
| | | |
| capture = value:match ('%s+(%a[%w%-]+)%s*=') or value:match ('^(%a[%w%-]+)%s*='); -- find and categorize parameters with possible missing pipes | | capture = value:match ('%s+(%a[%w%-]+)%s*=') or value:match ('^(%a[%w%-]+)%s*='); -- find and categorize parameters with possible missing pipes |
− | if capture and validate (capture) then -- if the capture is a valid parameter name | + | if capture and validate (capture) then -- if the capture is a valid parameter name |
− | table.insert( z.message_tail, {set_error ('missing_pipe',parameter)}); | + | table.insert( z.message_tail, {utilities.set_message ('err_missing_pipe', parameter)}); |
| end | | end |
| end | | end |
Sətir 3.664: |
Sətir 3.939: |
| | | |
| local function has_extraneous_punc (param, value) | | local function has_extraneous_punc (param, value) |
| + | if 'number' == type (param) then |
| + | return; |
| + | end |
| + | |
| + | param = param:gsub ('%d+', '#'); -- enumerated name-list mask params allow terminal punct; normalize |
| if cfg.punct_skip[param] then | | if cfg.punct_skip[param] then |
| return; -- parameter name found in the skip table so done | | return; -- parameter name found in the skip table so done |
| + | end |
| + | |
| + | if value:match ('[,;:]$') then |
| + | utilities.set_message ('maint_extra_punct'); -- has extraneous punctuation; add maint cat |
| end | | end |
| end | | end |
Sətir 3.677: |
Sətir 3.961: |
| | | |
| local function citation(frame) | | local function citation(frame) |
− | Frame = frame; -- save a copy incase we need to display an error message in preview mode | + | Frame = frame; -- save a copy in case we need to display an error message in preview mode |
| local pframe = frame:getParent() | | local pframe = frame:getParent() |
− | local validation, utilities, identifiers, metadata, styles; | + | local styles; |
| | | |
| if nil ~= string.find (frame:getTitle(), 'sandbox', 1, true) then -- did the {{#invoke:}} use sandbox version? | | if nil ~= string.find (frame:getTitle(), 'sandbox', 1, true) then -- did the {{#invoke:}} use sandbox version? |
Sətir 3.698: |
Sətir 3.982: |
| metadata = require ('Module:Citation/CS1/COinS'); | | metadata = require ('Module:Citation/CS1/COinS'); |
| styles = 'Module:Citation/CS1/styles.css'; | | styles = 'Module:Citation/CS1/styles.css'; |
− |
| |
| end | | end |
| | | |
− | utilities.set_selected_modules (cfg); -- so that functions in Utilities can see the cfg tables | + | utilities.set_selected_modules (cfg); -- so that functions in Utilities can see the selected cfg tables |
| identifiers.set_selected_modules (cfg, utilities); -- so that functions in Identifiers can see the selected cfg tables and selected Utilities module | | identifiers.set_selected_modules (cfg, utilities); -- so that functions in Identifiers can see the selected cfg tables and selected Utilities module |
| validation.set_selected_modules (cfg, utilities); -- so that functions in Date validataion can see selected cfg tables and the selected Utilities module | | validation.set_selected_modules (cfg, utilities); -- so that functions in Date validataion can see selected cfg tables and the selected Utilities module |
| metadata.set_selected_modules (cfg, utilities); -- so that functions in COinS can see the selected cfg tables and selected Utilities module | | metadata.set_selected_modules (cfg, utilities); -- so that functions in COinS can see the selected cfg tables and selected Utilities module |
− |
| |
− | dates = validation.dates; -- imported functions from Module:Citation/CS1/Date validation
| |
− | year_date_check = validation.year_date_check;
| |
− | reformat_dates = validation.reformat_dates;
| |
− | date_hyphen_to_dash = validation.date_hyphen_to_dash;
| |
− | date_name_xlate = validation.date_name_xlate;
| |
− |
| |
− | is_set = utilities.is_set; -- imported functions from Module:Citation/CS1/Utilities
| |
− | in_array = utilities.in_array;
| |
− | substitute = utilities.substitute;
| |
− | error_comment = utilities.error_comment;
| |
− | set_error = utilities.set_error;
| |
− | select_one = utilities.select_one;
| |
− | add_maint_cat = utilities.add_maint_cat;
| |
− | wrap_style = utilities.wrap_style;
| |
− | safe_for_italics = utilities.safe_for_italics;
| |
− | is_wikilink = utilities.is_wikilink;
| |
− | make_wikilink = utilities.make_wikilink;
| |
− | strip_apostrophe_markup = utilities.strip_apostrophe_markup;
| |
| | | |
| z = utilities.z; -- table of error and category tables in Module:Citation/CS1/Utilities | | z = utilities.z; -- table of error and category tables in Module:Citation/CS1/Utilities |
− |
| |
− | extract_ids = identifiers.extract_ids; -- imported functions from Module:Citation/CS1/Identifiers
| |
− | build_id_list = identifiers.build_id_list;
| |
− | is_embargoed = identifiers.is_embargoed;
| |
− | extract_id_access_levels = identifiers.extract_id_access_levels;
| |
− |
| |
− | make_coins_title = metadata.make_coins_title; -- imported functions from Module:Citation/CS1/COinS
| |
− | get_coins_pages = metadata.get_coins_pages;
| |
− | COinS = metadata.COinS;
| |
| | | |
| local args = {}; -- table where we store all of the template's arguments | | local args = {}; -- table where we store all of the template's arguments |
Sətir 3.741: |
Sətir 3.996: |
| | | |
| local config = {}; -- table to store parameters from the module {{#invoke:}} | | local config = {}; -- table to store parameters from the module {{#invoke:}} |
− | for k, v in pairs( frame.args ) do | + | for k, v in pairs( frame.args ) do -- get parameters from the {{#invoke}} frame |
| config[k] = v; | | config[k] = v; |
− | -- args[k] = v; -- debug tool that allows us to render a citation from module {{#invoke:}} | + | -- args[k] = v; -- crude debug support that allows us to render a citation from module {{#invoke:}}; skips parameter validation; TODO: keep? |
| end | | end |
| | | |
| local capture; -- the single supported capture when matching unknown parameters using patterns | | local capture; -- the single supported capture when matching unknown parameters using patterns |
− | for k, v in pairs( pframe.args ) do | + | local empty_unknowns = {}; -- sequence table to hold empty unknown params for error message listing |
| + | for k, v in pairs( pframe.args ) do -- get parameters from the parent (template) frame |
| + | v = mw.ustring.gsub (v, '^%s*(.-)%s*$', '%1'); -- trim leading/trailing whitespace; when v is only whitespace, becomes empty string |
| if v ~= '' then | | if v ~= '' then |
| if ('string' == type (k)) then | | if ('string' == type (k)) then |
Sətir 3.755: |
Sətir 4.012: |
| error_text = ""; | | error_text = ""; |
| if type( k ) ~= 'string' then | | if type( k ) ~= 'string' then |
− | -- Exclude empty numbered parameters | + | -- exclude empty numbered parameters |
| if v:match("%S+") ~= nil then | | if v:match("%S+") ~= nil then |
− | error_text, error_state = set_error( 'text_ignored', {v}, true ); | + | error_text, error_state = utilities.set_message ( 'err_text_ignored', {v}, true ); |
| end | | end |
| elseif validate( k:lower(), config.CitationClass ) then | | elseif validate( k:lower(), config.CitationClass ) then |
− | error_text, error_state = set_error( 'parameter_ignored_suggest', {k, k:lower()}, true ); -- suggest the lowercase version of the parameter | + | error_text, error_state = utilities.set_message ( 'err_parameter_ignored_suggest', {k, k:lower()}, true ); -- suggest the lowercase version of the parameter |
| else | | else |
| if nil == suggestions.suggestions then -- if this table is nil then we need to load it | | if nil == suggestions.suggestions then -- if this table is nil then we need to load it |
Sətir 3.770: |
Sətir 4.027: |
| end | | end |
| for pattern, param in pairs (suggestions.patterns) do -- loop through the patterns to see if we can suggest a proper parameter | | for pattern, param in pairs (suggestions.patterns) do -- loop through the patterns to see if we can suggest a proper parameter |
− | capture = k:match (pattern); -- the whole match if no caputre in pattern else the capture if a match | + | capture = k:match (pattern); -- the whole match if no capture in pattern else the capture if a match |
| if capture then -- if the pattern matches | | if capture then -- if the pattern matches |
− | param = substitute (param, capture); -- add the capture to the suggested parameter (typically the enumerator) | + | param = utilities.substitute (param, capture); -- add the capture to the suggested parameter (typically the enumerator) |
| if validate (param, config.CitationClass) then -- validate the suggestion to make sure that the suggestion is supported by this template (necessary for limited parameter lists) | | if validate (param, config.CitationClass) then -- validate the suggestion to make sure that the suggestion is supported by this template (necessary for limited parameter lists) |
− | error_text, error_state = set_error ('parameter_ignored_suggest', {k, param}, true); -- set the suggestion error message | + | error_text, error_state = utilities.set_message ('err_parameter_ignored_suggest', {k, param}, true); -- set the suggestion error message |
| else | | else |
− | error_text, error_state = set_error( 'parameter_ignored', {param}, true ); -- suggested param not supported by this template | + | error_text, error_state = utilities.set_message ( 'err_parameter_ignored', {param}, true ); -- suggested param not supported by this template |
| + | v = ''; -- unset |
| end | | end |
| end | | end |
| end | | end |
− | if not is_set (error_text) then -- couldn't match with a pattern, is there an expicit suggestion? | + | if not utilities.is_set (error_text) then -- couldn't match with a pattern, is there an expicit suggestion? |
| if suggestions.suggestions[ k:lower() ] ~= nil then | | if suggestions.suggestions[ k:lower() ] ~= nil then |
− | error_text, error_state = set_error( 'parameter_ignored_suggest', {k, suggestions.suggestions[ k:lower() ]}, true ); | + | error_text, error_state = utilities.set_message ( 'err_parameter_ignored_suggest', {k, suggestions.suggestions[ k:lower() ]}, true ); |
| else | | else |
− | error_text, error_state = set_error( 'parameter_ignored', {k}, true ); | + | error_text, error_state = utilities.set_message ( 'err_parameter_ignored', {k}, true ); |
| v = ''; -- unset value assigned to unrecognized parameters (this for the limited parameter lists) | | v = ''; -- unset value assigned to unrecognized parameters (this for the limited parameter lists) |
| end | | end |
Sətir 3.793: |
Sətir 4.051: |
| end | | end |
| end | | end |
− | missing_pipe_check (k, v); -- do we think that there is a parameter that is missing a pipe? | + | |
− | -- TODO: is this the best place for this translation? | + | args[k] = v; -- save this parameter and its value |
− | args[k] = v;
| + | |
− | elseif args[k] ~= nil or (k == 'postscript') then -- here when v is empty string
| + | elseif not utilities.is_set (v) then -- for empty parameters |
− | args[k] = v; -- why do we do this? we don't support 'empty' parameters
| + | if not validate (k, config.CitationClass, true) then -- is this empty parameter a valid parameter |
− | end | + | k = ('' == k) and '(empty string)' or k; -- when k is empty string (or was space(s) trimmed to empty string), replace with descriptive text |
| + | table.insert (empty_unknowns, utilities.wrap_style ('parameter', k)); -- format for error message and add to the list |
| + | end |
| + | -- crude debug support that allows us to render a citation from module {{#invoke:}} TODO: keep? |
| + | -- elseif args[k] ~= nil or (k == 'postscript') then -- when args[k] has a value from {{#invoke}} frame (we don't normally do that) |
| + | -- args[k] = v; -- overwrite args[k] with empty string from pframe.args[k] (template frame); v is empty string here |
| + | end -- not sure about the postscript bit; that gets handled in parameter validation; historical artifact? |
| end | | end |
| + | |
| + | if 0 ~= #empty_unknowns then -- create empty unknown error message |
| + | table.insert (z.message_tail, {utilities.set_message ('err_param_unknown_empty', { |
| + | 1 == #empty_unknowns and '' or 's', |
| + | utilities.make_sep_list (#empty_unknowns, empty_unknowns) |
| + | }, true )}); |
| + | end |
| | | |
| for k, v in pairs( args ) do | | for k, v in pairs( args ) do |
| if 'string' == type (k) then -- don't evaluate positional parameters | | if 'string' == type (k) then -- don't evaluate positional parameters |
− | has_invisible_chars (k, v); | + | has_invisible_chars (k, v); -- look for invisible characters |
− | has_extraneous_punc (k, v); -- look for extraneous terminal punctuation in parameter values
| |
| end | | end |
| + | has_extraneous_punc (k, v); -- look for extraneous terminal punctuation in parameter values |
| + | missing_pipe_check (k, v); -- do we think that there is a parameter that is missing a pipe? |
| + | args[k] = inter_wiki_check (k, v); -- when language interwiki-linked parameter missing leading colon replace with wiki-link label |
| end | | end |
| + | |
| return table.concat ({citation0( config, args), frame:extensionTag ('templatestyles', '', {src=styles})}); | | return table.concat ({citation0( config, args), frame:extensionTag ('templatestyles', '', {src=styles})}); |
| end | | end |