فایل پی دی اف کامل پاورپوینت پودمان:Citation/CS1/en PDF

توجه : این فایل به صورت فایل power point (پاور پوینت) ارائه میگردد

 فایل پی دی اف کامل پاورپوینت پودمان:Citation/CS1/en PDF دارای ۱۲۰ اسلاید می باشد و دارای تنظیمات کامل در PowerPoint می باشد و آماده ارائه یا چاپ است

شما با استفاده ازاین پاورپوینت میتوانید یک ارائه بسیارعالی و با شکوهی داشته باشید و همه حاضرین با اشتیاق به مطالب شما گوش خواهند داد.

لطفا نگران مطالب داخل پاورپوینت نباشید، مطالب داخل اسلاید ها بسیار ساده و قابل درک برای شما می باشد، ما عالی بودن این فایل رو تضمین می کنیم.

توجه : در صورت  مشاهده  بهم ریختگی احتمالی در متون زیر ،دلیل ان کپی کردن این مطالب از داخل فایل می باشد و در فایل اصلی فایل پی دی اف کامل پاورپوینت پودمان:Citation/CS1/en PDF،به هیچ وجه بهم ریختگی وجود ندارد

---

بخشی از متن فایل پی دی اف کامل پاورپوینت پودمان:Citation/CS1/en PDF :

توضیحات این پودمان می‌تواند در پودمان:Citation/CS1/en/توضیحات قرار گیرد.

local numConv = require("module:Numeral converter2").convert
local cs1 ={};

–[[————————–< 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/en/Date_validation
date_name_xlate

local is_set, in_array, substitute, error_comment, set_error, select_one,– functions in Module:Citation/CS1/en/Utilities
add_maint_cat, wrap_style, safe_for_italics, is_wikilink, make_wikilink;

local z ={};– tables in Module:Citation/CS1/en/Utilities

local extract_ids, extract_id_access_levels, build_id_list, is_embargoed;– functions in Module:Citation/CS1/en/Identifiers

local make_coins_title, get_coins_pages, COinS;– functions in Module:Citation/CS1/en/COinS

local cfg = {};– table of configuration tables that are defined in Module:Citation/CS1/en/Configuration
local whitelist = {};– table of tables listing valid template parameter names; defined in Module:Citation/CS1/en/Whitelist

–[[————————–< 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
and used here

]]

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 Frame;– holds the module”s frame table

–[[————————–< F I R S T _ S E T >————————————————————

Locates and returns the first set value in a table of values where the order established in the table,
left-to-right (or top-to-bottom), is the order in which the values are evaluated. Returns nil if none are set.

This version replaces the original “for _, val in pairs do” and a similar version that used ipairs. With the pairs
version the order of evaluation could not be guaranteed. With the ipairs version, a nil value would terminate
the for-loop before it reached the actual end of the list.

]]

local function first_set (list, count)
local i = 1;
while i <= count do– loop through all items in list
if is_set( list[i] ) then
return list[i];– return the first set list member
end
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

–[[————————–< A D D _ V A N C _ E R R O R >—————————————————-

Adds a single Vancouver system error message to the template”s output regardless of how many error actually exist.
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

]]

local function add_vanc_error (source)
if not added_vanc_errs then
added_vanc_errs = true;– note that we”ve added this category
table.insert( z.message_tail, { set_error( “vancouver”, {source}, true ) } );
end
end

–[[————————–< 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
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
letter and followed by any combination of letters, digits, plus
("+"), period ("."), or hyphen ("-").

returns true if it does, else false

]]

local function is_scheme (scheme)
return scheme and scheme:match (“^%a[%a%d%+%.%-]*:”);– true if scheme is set and matches the pattern
end

–[=[————————-< I S _ D O M A I N _ N A M E >————————————————–

Does this thing that purports to be a domain name seem to be a valid domain name

Syntax defined here: http://tools.ietf.org/html/rfc1034#section-3.5
BNF defined here: https://tools.ietf.org/html/rfc4234
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]]
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
the first and last characters the name may use letters, digits, and the hyphen.

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
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.

There are several tests:
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
single-letter/digit second-level domains in the .org and .cash TLDs
q, x, and z SL domains in the .com TLD
i and q SL domains in the .net TLD
single-letter SL domains in the ccTLDs (where the ccTLD is two letters)
two-character SL domains in gTLDs (where the gTLD is two or more letters)
three-plus-character SL domains in gTLDs (where the gTLD is two or more letters)
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

]=]

local function is_domain_name (domain)
if not domain then
return false;– if not set, abandon
end

domain = domain:gsub (“^//”, “”);– strip “//” from domain name if present; done here so we only have to do it once

if not domain:match (“^[%a%d]”) then– first character must be letter or digit
return false;
end
— Do most common case first
if domain:match (“%f[%a%d][%a%d][%a%d%-]+[%a%d]%.%a%a+$”) then– three or more character hostname.hostname or hostname.tld
return true;
elseif domain:match (“%f[%a%d][%a%d][%a%d%-]+[%a%d]%.xn%-%-[%a%d]+$”) then– internationalized domain name with ACE prefix
return true;
elseif domain:match (“%f[%a%d][%a%d]%.cash$”) then– one character/digit .cash hostname
return true;
elseif domain:match (“%f[%a%d][%a%d]%.org$”) then– one character/digit .org hostname
return true;
elseif domain:match (“%f[%a][qxz]%.com$”) then– assigned one character .com hostname (x.com times out 2015-12-10)
return true;
elseif domain:match (“%f[%a][iq]%.net$”) then– assigned one character .net hostname (q.net registered but not active 2015-12-10)
return true;
elseif domain:match (“%f[%a%d][%a%d]%.%a%a$”) then– one character hostname and cctld (2 chars)
return true;
elseif domain:match (“%f[%a%d][%a%d][%a%d]%.%a%a+$”) then– two character hostname and tld
return true;
elseif domain:match (“^%d%d%d%.%d%d%d%.%d%d%d%.%d%d%d”) then– IPv4 address
return true;
else
return false;
end
end

–[[————————–< I S _ U R L >——————————————————————

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
are not covered by split_url(), for example is_parameter_ext_wikilink() which is looking for bracketted external
wikilinks.

]]

local function is_url (scheme, domain)
if is_set (scheme) then– if scheme is set check it and domain
return is_scheme (scheme) and is_domain_name (domain);
else
return is_domain_name (domain);– scheme not set when url is protocol relative
end
end

–[[————————–< S P L I T _ U R L >————————————————————

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(#).

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
or more “/” characters immediately following the scheme”s colon), make sure that there are only 2.

Strip off any port and path;

]]

local function split_url (url_str)
local scheme, authority, domain;

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
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
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 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
domain = domain:gsub (“(%a):%d+”, “%1”);– strip port number if present
end

return scheme, domain;
end

–[[————————–< 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

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

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
|<param>-link= parameter is ok); else false when value appears to be a valid url (the |<param>-link= parameter is NOT ok).

]]

local function link_param_ok (value)
local scheme, domain;
if value:find (“[<>%[%]|{}]”) then– if any prohibited characters
return false;
end

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
end

–[[————————–< L I N K _ T I T L E _ O K >—————————————————

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
that condition exists

]]

local function link_title_ok (link, lorig, title, torig)
local orig;

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
orig = lorig;– identify the failing link parameter
elseif title:find (“%[%[“) then– check |title= for wikilink markup
orig = torig;– identify the failing |title= parameter
end
end

if is_set (orig) then
table.insert( z.message_tail, { set_error( “bad_paramlink”, orig)});– url or wikilink in |title= with |title-link=;
end
end

–[[————————–< C H E C K _ U R L >————————————————————

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
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.

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
is at https://tools.ietf.org/html/rfc5536#section-3.1.4

]]

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
return false;
end
local scheme, domain;

scheme, domain = split_url (url_str);– get scheme or nil and domain or nil from url;

if “news:” == scheme then– special case for newsgroups
return domain:match(“^[%a%d%+%-_]+%.[%a%d%+%-_%.]*[%a%d%+%-_]$”);
end

return is_url (scheme, domain);– return true if value appears to be a valid url
end

–[=[————————-< I S _ P A R A M E T E R _ E X T _ W I K I L I N K >—————————-

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
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
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]]
is possible as might be [[en://Hus]].

]=]

local function is_parameter_ext_wikilink (value)
local scheme, domain;

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+).*%]”));
elseif value:match (“%f[%[]%[//%S+.*%]”) then– if protocol relative ext wikilink: [//yyyyy.zzz]
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
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
scheme, domain = split_url (value:match (“(//%S+)”));– what is left should be the domain
else
return false;– didn”t find anything that is obviously a url
end

return is_url (scheme, domain);– return true if value appears to be a valid url
end

–[[————————-< C H E C K _ F O R _ U R L >—————————————————–

loop through a list of parameters and their values. Look at the value and if it has an external link, emit an error message.

]]

local function check_for_url (parameter_list)
local error_message = “”;
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_set(error_message) then– once we”ve added the first portion of the error message …
error_message=error_message .. ", ";– … add a comma space separator
end
error_message=error_message .. "&#124;" .. k .. "=";– add the failed parameter
end
end
if is_set (error_message) then– done looping, if there is an error message, display it
table.insert( z.message_tail, { set_error( “param_has_ext_link”, {error_message}, true ) } );
end
end

–[[————————–< S A F E _ F O R _ U R L >——————————————————

Escape sequences for content that will be used for URL descriptions

]]

local function safe_for_url( str )
if str:match( "%[%[.-%]%]" ) ~= nil then
table.insert( z.message_tail, { set_error( “wikilink_in_url”, {}, true ) } );
end

return str:gsub( “[%[%]\n]”, {
[“[“] = “&#91;”,
[“]”] = “&#93;”,
[“\n”] = ” ” } );
end

–[[————————–< E X T E R N A L _ L I N K >—————————————————-

Format an external link with error checking

]]

local function external_link( URL, label, source, access)
local error_str = "";
local domain;
local path;
local base_url;

if not is_set( label ) then
label = URL;
if is_set( source ) then
error_str = set_error( “bare_url_missing_title”, { wrap_style (“parameter”, source) }, false, " " );
else
error( cfg.messages["bare_url_no_origin"] );
end
end
if not check_url( URL ) then
error_str = set_error( “bad_url”, {wrap_style (“parameter”, source)}, false, " " ) .. error_str;
end

domain, path = URL:match (“^([/%.%-%+:%a%d]+)([/%#].*)$”);– split the url into scheme plus domain and path
if path then– if there is a path portion
path = path:gsub (“[%[%]]”, {[“[“]=”%5b”,[“]”]=”%5d”});– replace “[” and “]” with their percent encoded values
URL = table.concat ({domain, path});– and reassemble
end

base_url = table.concat({ "[", URL, " ", safe_for_url (label), "]" });– assemble a wikimarkup url

if 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
end

return table.concat ({base_url, error_str});
end

–[[————————–< D E P R E C A T E D _ P A R A M E T E R >————————————–

Categorize and emit an error message when the citation contains one or more deprecated parameters. The function includes the
offending parameter name to the error message. Only one error message is emitted regardless of the number of deprecated
parameters in the citation.

added_deprecated_cat is a boolean declared in page scope variables above

]]

local function deprecated_parameter(name)
if not added_deprecated_cat then
added_deprecated_cat = true;– note that we”ve added this category
table.insert( z.message_tail, { set_error( “deprecated_params”, {name}, true ) } );– add error message
end
end

–[=[————————-< 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
mark contained in a |title= or |chapter= parameter”s value.

This function will positive kern either single or double quotes:
"”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)
Double single quotes (italic or bold wikimarkup) are not kerned.

Replaces unicode quotemarks 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.

Call this function for chapter titles, for website titles, etc; not for book titles.

]=]

local function kern_quotes (str)
local cap=””;
local cap2=””;
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]]

if 1 == wl_type then– [[D]] simple wikilink with or without quote marks
if mw.ustring.match (str, “%[%[[\"“””‘’].+[\"“””‘’]%]%]”) then– leading and trailing quote marks
str = substitute (cfg.presentation[“kern-wl-both”], str);
elseif mw.ustring.match (str, “%[%[[\"“””‘’].+%]%]”)then– leading quote marks
str = substitute (cfg.presentation[“kern-wl-left”], str);
elseif mw.ustring.match (str, “%[%[.+[\"“””‘’]%]%]”) then– trailing quote marks
str = substitute (cfg.presentation[“kern-wl-right”], str);
end

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+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)
if is_set (cap) then
label = substitute (cfg.presentation[“kern-left”], {cap, cap2});
end

cap, cap2 = mw.ustring.match (label, "^(.+[^”])([\"”])$")– match trailing double or single quote but not doubled single quotes (italic markup)
if is_set (cap) then
label = substitute (cfg.presentation[“kern-right”], {cap, cap2});
end

if 2 == wl_type then
str = make_wikilink (link, label);– reassemble the wikilink
else
str = label;
end
end
return str;
end

–[[————————–< 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
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.

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=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:
|script-title=ja : *** ***
|script-title=ja: *** ***
|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
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.

Supports |script-title= and |script-chapter=

TODO: error messages when prefix is invalid ISO639-1 code; when script_value has prefix but no script;
]]

local function format_script_value (script_value)
local lang=””;– initialize to empty string
local name;
if script_value:match(“^%l%l%s*:”) then– if first 3 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
if not is_set (lang) then
return “”;– script_value was just the prefix so return empty string
end
— if we get this far we have prefix and script
name = cfg.lang_code_remap[lang] or mw.language.fetchLanguageName( lang, "fa" );– 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
script_value = script_value:gsub (“^%l%l%s*:%s*”, “”);– strip prefix from script
— is prefix one of these language codes
if in_array (lang, cfg.script_lang_codes) then
add_prop_cat (“script_with_name”, {name, lang})
else
add_prop_cat (“script”)
end
lang = ” lang="” .. lang .. “" “;– convert prefix into a lang attribute
else
lang = “”;– invalid so set lang to empty string
end
end
script_value = substitute (cfg.presentation[“bdi”], {lang, script_value});– isolate in case script is rtl

return script_value;
end

–[[————————–< S C R I P T _ C O N C A T E N A T E >——————————————

Initially for |title= and |script-title=, this function concatenates those two parameter values after the script value has been
wrapped in <bdi> tags.
]]

local function script_concatenate (title, script)
if is_set (script) then
script = format_script_value (script);– <bdi> tags, lang atribute, categorization, etc; returns empty string on error
if is_set (script) then
title = title .. ” ” .. script;– concatenate title and script title
end
end
return title;
end

–[[————————–< W R A P _ M S G >————————————————————–

Applies additional message text to various parameter values. Supplied string is wrapped using a message_list
configuration taking one argument. Supports lower case text for {{citation}} templates. Additional text taken
from citation_config.messages – the reason this function is similar to but separate from wrap_style().

]]

local function wrap_msg (key, str, lower)
if not is_set( str ) then
return "";
end
if true == lower then
local msg;
msg = cfg.messages[key]:lower();– set the message to lower case before
return substitute( msg, str );– including template text
else
return substitute( cfg.messages[key], str );
end
end

–[[————————–< 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-
parameter (chapter_url_source used for error messages).

]]

local function format_chapter_title (scriptchapter, chapter, transchapter, chapterurl, chapter_url_source, no_quotes, access)
local chapter_error = “”;

if not is_set (chapter) then
chapter = “”;– to be safe for concatenation
else
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 = wrap_style (“quoted-title”, chapter);
end
end

chapter = script_concatenate (chapter, scriptchapter)– <bdi> tags, lang atribute, categorization, etc; must be done after title is wrapped

if is_set (chapterurl) then
chapter = external_link (chapterurl, chapter, chapter_url_source, access);– adds bare_url_missing_title error if appropriate
end

if is_set (transchapter) then
transchapter = wrap_style (“trans-quoted-title”, transchapter);
if is_set (chapter) then
chapter = chapter .. ” ” .. transchapter;
else– here when transchapter without chapter or script-chapter
chapter = transchapter;–
chapter_error = ” ” .. set_error (“trans_missing_title”, {“chapter”});
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;
end

–[[————————–< 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
first match.

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)
and identifies them with a slightly different error message. See also coins_cleanup().

Detects but ignores the character pattern that results from the transclusion of {{“}} templates.

Output of this function is an error message that identifies the character or the Unicode group, or the stripmarker
that was detected along with its position (or, for multi-byte characters, the position of its first byte) in the
parameter value.

]]

local function has_invisible_chars (param, v)
local position = “”;– position of invisible char or starting position of stripmarker
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 i=1;
local stripmarker, apostrophe;

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
return;
end

while cfg.invisible_chars[i] do
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
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 mw.ustring.find (v, cfg.indic_script) then– its ok if one of the indic scripts
position = nil;– unset position
end
end

if position then
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
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
position = nil;– unset
else
local err_msg;
if capture then
err_msg = capture .. ” ” .. char;
else
err_msg = char .. ” ” .. “character”;
end

table.insert( z.message_tail, { set_error( “invisible_char”, {err_msg, wrap_style (“parameter”, param), position}, true ) } );– add error message
return;– and done with this parameter
end
end
i=i+1;– bump our index
end
end

–[[————————–< A R G U M E N T _ W R A P P E R >———————————————-

Argument wrapper. This function provides support for argument mapping defined in the configuration file so that
multiple names can be transparently aliased to single internal variable.

]]

local function argument_wrapper( args )
local origin = {};

return setmetatable({
ORIGIN = function( self, k )
local dummy = self[k]; –force the variable to be loaded.
return origin[k];
end
},
{
__index = function ( tbl, k )
if origin[k] ~= nil then
return nil;
end

local args, list, v = args, cfg.aliases[k];

if type( list ) == “table” then
v, origin[k] = select_one( args, list, “redundant_parameters” );
if origin[k] == nil then
origin[k] = “”; — Empty string, not nil
end
elseif list ~= nil then
v, origin[k] = args[list], list;
else
— maybe let through instead of raising an error
— v, origin[k] = args[k], k;
error( cfg.messages[“unknown_argument_map”] );
end

— Empty strings, not nil;
if v == nil then
v = cfg.defaults[k] or “”;
origin[k] = “”;
end

tbl = rawset( tbl, k, v );
return v;
end,
});
end

–[[————————–< N O W R A P _ D A T E >——————————————————–

When date is YYYY-MM-DD format wrap in nowrap span: <span …>YYYY-MM-DD</span>. When date is DD MMMM YYYY or is
MMMM DD, YYYY then wrap in nowrap span: <span …>DD MMMM</span> YYYY or <span …>MMMM DD,</span> YYYY

DOES NOT yet support MMMM YYYY or any of the date ranges.

]]

local function nowrap_date (date)
local cap=””;
local cap2=””;

if date:match("^%d%d%d%d%-%d%d%-%d%d$") then
date = 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
cap, cap2 = string.match (date, "^(.*)%s+(%d%d%d%d)$");
date = substitute (cfg.presentation[“nowrap2”], {cap, cap2});
end

return date;
end

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

This function sets default title types (equivalent to the citation including |type=<default value>) for those templates that have defaults.
Also handles the special case where it is desirable to omit the title type from the rendered citation (|type=none).

]]

local function set_titletype (cite_class, title_type)
if is_set(title_type) then
if "none" == title_type then
title_type = "";– if |type=none then type parameter not displayed
end
return title_type;– if |type= has been set to any other value use that value
end

return cfg.title_types [cite_class] or “”;– set template”s default title type; else empty string for concatenation
end

–[[————————–< H Y P H E N _ T O _ D A S H >————————————————–

Converts a hyphen to a dash under certain conditions. The hyphen must separate like items; unlike items are
returned unmodified. These forms are modified:
letter – letter (A – B)
digit – digit (4-5)
digit separator digit – digit separator digit (4.1-4.5 or 4-1-4-5)
letterdigit – letterdigit (A1-A5) (an optional separator between letter and digit is supported – a.1-a.5 or a-1-a-5)
digitletter – digitletter (5a – 5d) (an optional separator between letter and digit is supported – ۵.a-5.d or 5-a-5-d)

any other forms are returned unmodified.

str may be a comma- or semicolon-separated list

]]

local function hyphen_to_dash( str )
if not is_set (str) then
return str;
end

str, count = str:gsub (“^%(%((.+)%)%)$”, “%1”);– remove accept-this-as-written markup when it wraps all of str
if 0 ~= count then– non-zero when markup removed; zero else
return str;– nothing to do, we”re done
end

local out = {};
local list = mw.text.split (str, “%s*[,;]%s*”);– split str at comma or semicolon separators if there are any

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 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+[%.%-]%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 (“%a+%s*%-%s*%a+”) then– letter hyphen letter
item = item:gsub (“(%w*[%.%-]%w+)%s*%-%s*(%w*[%.%-]%w+)”, “%1–%۲”);– replace hyphen, remove extraneous space characters
else
item = mw.ustring.gsub (item, “%s*[–—]%s*”, “–”);– for endash or emdash separated ranges, replace em with en, remove extraneous white space
end
end
item = item:gsub (“^%(%((.+)%)%)$”, “%1”);– remove the accept-this-as-written markup
table.insert (out, item);– add the (possibly modified) item to the output table
end

return table.concat (out, “, “);– concatenate the output table into a comma separated string
end

–[[————————–< S A F E _ J O I N >————————————————————

Joins a sequence of strings together while checking for duplicate separation characters.

]]

local function safe_join( tbl, duplicate_char )
local f = {};– create a function table appropriate to type of “dupicate character”
if 1 == #duplicate_char then– for single byte ascii characters use the string library functions
f.gsub=string.gsub
f.match=string.match
f.sub=string.sub
else– for multi-byte characters use the ustring library functions
f.gsub=mw.ustring.gsub
f.match=mw.ustring.match
f.sub=mw.ustring.sub
end

local str = “”;– the output string
local comp = “”;– what does “comp” mean
local end_chr = “”;
local trim;
for _, value in ipairs( tbl ) do
if value == nil then value = “”; end

if str == “” then– if output string is empty
str = value;– assign value to it (first time through the loop)
elseif value ~= “” then
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)
else
comp = value;
end
— 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
— Because individual string segments often (always) begin with terminal punct for the
— preceding segment: “First element” .. “sepc next element” .. etc
trim = false;
end_chr = f.sub(str, -1,-1);– get the last character of the output string
— str = str .. "<HERE(enchr=" .. end_chr.. ")"– debug stuff
if end_chr == duplicate_char then– if same as separator
str = f.sub(str, 1,-2);– remove it
elseif end_chr == "”" then– if it might be wikimarkup
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 “”
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
elseif f.sub(str, -4,-1) == duplicate_char .. "]””" then– if last four chars of str are sepc]””
trim = true;– same question
end
elseif end_chr == "]" then– if it might be wikimarkup
if f.sub(str, -3,-1) == duplicate_char .. "]]" then– if last three chars of str are sepc]] wikilink
trim = true;
elseif f.sub(str, -3,-1) == duplicate_char .. “"]” then– if last three chars of str are sepc"] quoted external link
trim = true;
elseif f.sub(str, -2,-1) == duplicate_char .. "]" then– if last two chars of str are sepc] external link
trim = true;
elseif f.sub(str, -4,-1) == duplicate_char .. "””]" then– normal case when |url=something & |title=Title.
trim = true;
end
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>
str = f.sub(str, 1,-3);– remove them both
end
end

if trim then
if value ~= comp then — value does not equal comp when value contains html markup
local dup2 = duplicate_char;
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
else
value = f.sub(value, 2, -1 );– remove duplicate_char when it is first character
end
end
end
str = str .. value;–add it to the output string
end
end
return str;
end

–[[————————–< I S _ S U F F I X >————————————————————

returns true is suffix is properly formed Jr, Sr, or ordinal in the range 2–۹. Puncutation not allowed.

]]

local function is_suffix (suffix)
if in_array (suffix, {“Jr”, “Sr”, “2nd”, “3rd”}) or suffix:match (“^%dth$”) then
return true;
end
return false;
end

–[[————————–< 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
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.
These things are not currently possible in this module so are left to the editor to do.

This test allows |first= and |last= names to contain any of the letters defined in the four Unicode Latin character sets
[http://www.unicode.org/charts/PDF/U0000.pdf C0 Controls and Basic Latin] 0041–۰۰۵A, 0061–۰۰۷A
[http://www.unicode.org/charts/PDF/U0080.pdf C1 Controls and Latin-1 Supplement] 00C0–۰۰D6, 00D8–۰۰F6, 00F8–۰۰FF
[http://www.unicode.org/charts/PDF/U0100.pdf Latin Extended-A] 0100–۰۱۷F
[http://www.unicode.org/charts/PDF/U0180.pdf Latin Extended-B] 0180–۰۱BF, 01C4–۰۲۴F

|lastn= also allowed to contain hyphens, spaces, and apostrophes. (http://www.ncbi.nlm.nih.gov/books/NBK7271/box/A35029/)
|firstn= also allowed to contain hyphens, spaces, apostrophes, and periods

This original test:
if nil == mw.ustring.find (last, "^[A-Za-zA—-%-%s%”]*$") or nil == mw.ustring.find (first, "^[A-Za-zA—-%-%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.
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.

\۱۹۵\۱۲۸-\۱۹۵\۱۵۰ – A- (U+00C0–U+00D6 – C0 controls)
\۱۹۵\۱۵۲-\۱۹۵\۱۸۲ – – (U+00D8-U+00F6 – C0 controls)
\۱۹۵\۱۸۴-\۱۹۸\۱۹۱ – – (U+00F8-U+01BF – C0 controls, Latin extended A & B)
\۱۹۹\۱۳۲-\۲۰۱\۱۴۳ – – (U+01C4-U+024F – Latin extended B)

]]

local function is_good_vanc_name (last, first)
local first, suffix = first:match (“(.-),%s*([%dJS][%drndth]+)%.$”) or first;– if first has something that looks like a generational suffix, get it

if is_set (suffix) then
if not is_suffix (suffix) then
add_vanc_error (“suffix”);
return false;– not a name with an appropriate suffix
end
end
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
add_vanc_error (“non-Latin character”);
return false;– not a string of latin characters; Vancouver requires Romanization
end;
return true;
end

–[[————————–< 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.

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/.
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 ().

]]

local function reduce_to_initials(first)
local name, suffix = mw.ustring.match(first, "^(%u+) ([%dJS][%drndth]+)$");

if not name then– if not initials and a suffix
name = mw.ustring.match(first, "^(%u+)$");– is it just intials
end

if name then– if first is initials with or without suffix
if 3 > mw.ustring.len (name) then– if one or two initials
if suffix then– if there is a suffix
if is_suffix (suffix) then– is it legitimate
return first;– one or two initials and a valid suffix so nothing to do
else
add_vanc_error (“suffix”);– one or two initials with invalid suffix so error message
return first;– and return first unmolested
end
else
return first;– one or two initials without suffix; nothing to do
end
end
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 i = 1;– counter for number of initials

names = mw.text.split (first, “[%s,]+”);– split into a table of names and possible suffix

while names[i] do– loop through the table
if 1 < i and names[i]:match (“[%dJS][%drndth]+%.$”) then– if not the first name, and looks like a suffix (may have trailing dot)
names[i] = names[i]:gsub (“%.”, “”);– remove terminal dot if present
if is_suffix (names[i]) then– if a legitimate suffix
table.insert (initials, ” ” .. names[i]);– add a separator space, insert at end of initials table
break;– and done because suffix must fall at the end of a name
end– no error message if not a suffix; possibly because of Romanization
end
if 3 > i then
table.insert (initials, mw.ustring.sub(names[i],1,1));– insert the intial at end of initials table
end
i = i+1;– bump the counter
end

return table.concat(initials)– Vancouver format does not include spaces.
end

–[[————————–< L I S T _ P E O P L E >——————————————————-

Formats a list of people (e.g. authors / editors)

]]

local function list_people(control, people, etal)
local sep;
local namesep;
local format = control.format
local maximum = control.maximum
local lastauthoramp = control.lastauthoramp;
local text = {}

if “vanc” == format then– Vancouver-like author/editor name styling
sep = cfg.presentation[“sep_nl_vanc”];– name-list separator between authors is a comma
namesep = cfg.presentation[“sep_name_vanc”];– last/first separator is a space
else
sep = cfg.presentation[“sep_nl”];– name-list separator between authors is a semicolon
namesep = cfg.presentation[“sep_name”];– last/first separator is <comma><space>
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

for i,person in ipairs(people) do
if is_set(person.last) then
local mask = person.mask
local one
local sep_one = sep;
if is_set (maximum) and i > maximum then
etal = true;
break;
elseif (mask ~= nil) then
local n = tonumber(mask)
if (n ~= nil) then
one = string.rep("&mdash;",n)
else
one = mask;
sep_one = " ";
end
else
one = person.last
local first = person.first
if is_set(first) then
if ( "vanc" == format ) then– if vancouver format
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
first = reduce_to_initials(first)– attempt to convert first name(s) to initials
end
end
one = one .. namesep .. first;
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
table.insert( text, one )
table.insert( text, sep_one )
end
end

local count = #text / 2;– (number of names + number of separators) divided by 2
if count > 0 then
if count > 1 and is_set(lastauthoramp) and not etal then
text[#text-2] = " & ";– replace last separator with ampersand text
end
text[#text] = nil;– erase the last separator
end

local result = table.concat(text)– 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
result = result .. sep .. ” ” .. cfg.messages[“et al”];– we”ve go a last-first list and etal so add et al.
end

return result, count
end

–[[————————–< A N C H O R _ I D >————————————————————

Generates a CITEREF anchor ID if we have at least one name or a date. Otherwise returns an empty string.

namelist is one of the contributor-, author-, or editor-name lists chosen in that order. year is Year or anchor_year.

]]
local function anchor_id (namelist, year)
local names={};– a table for the one to four names and year
for i,v in ipairs (namelist) do– loop through the list and take up to the first four last names
names[i] = v.last
if i == 4 then break end– if four then done
end
table.insert (names, year);– add the year at the end
local id = table.concat(names);– concatenate names and year for CITEREF id
if is_set (id) then– if concatenation is not an empty string
return "CITEREF" .. id;– add the CITEREF portion
else
return “”;– return an empty string; no reason to include CITEREF id in this citation
end
end

–[[————————–< N A M E _ H A S _ E T A L >—————————————————-

Evaluates the content of author and editor name parameters 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.

This function never sets the flag to false but returns it”s previous state because it may have been set by
previous passes through this function or by the parameters |display-authors=etal or |display-editors=etal

]]

local function name_has_etal (name, etal, nocat)

if is_set (name) then– name can be nil in which case just return
local etal_pattern = "[;,] *[\"”]*%f[%a][Ee][Tt] *[Aa][Ll][%.\"”]*$"– variations on the “et al” theme
local others_pattern = "[;,] *%f[%a]and [Oo]thers";– and alternate to et al.

if name:match (etal_pattern) then– variants on et al.
name = name:gsub (etal_pattern, “”);– if found, remove
etal = true;– set flag (may have been set previously here or by |display-authors=etal)
if not nocat then– no categorization for |vauthors=
add_maint_cat (“etal”);– and add a category if not already added
end
elseif name:match (others_pattern) then– if not “et al.”, then “and others”
name = name:gsub (others_pattern, “”);– if found, remove
etal = true;– set flag (may have been set previously here or by |display-authors=etal)
if not nocat then– no categorization for |vauthors=
add_maint_cat (“etal”);– and add a category if not already added
end
end
end
return name, etal;–
end

–[[————————–< 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.
These annotation do not belong in author parameters and are redundant in editor parameters. If found, the function
adds the editor markup maintenance category.

]]

local function name_has_ed_markup (name, list_name)
local _, pattern;
local patterns = {– these patterns match annotations at end of name
“%f[%(%[][%(%[]%s*[Ee][Dd][Ss]%.%s*[%)%]]$”,– (ed) or (eds): leading “(“, case insensitive “ed”, optional “s”, “.” and/or “)”
“[,%.%s]%f[e]eds%.$”,– ed or eds: without “(“or “)”; case sensitive (ED could be initials Ed could be name)
“%f[%(%[][%(%[]%s*[Ee][Dd][Ii][Tt][Oo][Rr][Ss]%.%s*[%)%]]$”,– (editor) or (editors): leading “(“, case insensitive, optional “.” and/or “)”
“[,%.%s]%f[Ee][Ee][Dd][Ii][Tt][Oo][Rr][Ss]%.$”,– editor or editors: without “(“or “)”; case insensitive

— these patterns match annotations at beginning of name
“^eds[%.,;]”,– ed. or eds.: lower case only, optional “s”, requires “.”
“^[%(%[]%s*[Ee][Dd][Ss]%.%s*[%)%]]”,– (ed) or (eds): also sqare brackets, case insensitive, optional “s”, “.”
“^[%(%[]%s*[Ee][Dd][Ii][Tt][Oo][Rr][Ss]%A”,– (editor or (editors: also sq brackets, case insensitive, optional brackets, “s”
“^[%(%[]%s*[Ee][Dd][Ii][Tt][Ee][Dd]%A”,– (edited: also sq brackets, case insensitive, optional brackets
}

if is_set (name) then
for _, pattern in ipairs (patterns) do– spin through patterns table and
if name:match (pattern) then
add_maint_cat (“extra_text_names”, cfg.special_case_translation [list_name]);– add a maint cat for this template
break;
end
end
end
return name;– and done
end

–[[————————–< 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
indicated if there is more than one comma and or semicolon. If found, the function adds the multiple name
(author or editor) maintenance category.

]]

local function name_has_mult_names (name, list_name)
local count, _;
if is_set (name) then
_, count = name:gsub (“[;,]”, “”);– count the number of separator-like characters

if 1 < count then– param could be |author= or |editor= so one separator character is acceptable
add_maint_cat (“mult_names”, cfg.special_case_translation [list_name]);– more than one separator indicates multiple names so add a maint cat for this template
end
end
return name;– and done
end

–[[————————–< 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
parameters.

]]

local function name_checks (last, first, list_name)
if is_set (last) then
if last:match (“^%(%(.*%)%)$”) then– if wrapped in doubled parentheses, accept as written
last = last:match (“^%(%((.*)%)%)$”);– strip parens
else
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
end
end
if is_set (first) then
if first:match (“^%(%(.*%)%)$”) then– if wrapped in doubled parentheses, accept as written
first = first:match (“^%(%((.*)%)%)$”);– strip parens
else
first = name_has_ed_markup (first, list_name);– check for extraneous “editor” annotation
end
end
return last, first;– done
end

–[[————————–< E X T R A C T _ N A M E S >—————————————————-
Gets name list from the input arguments

Searches through args in sequential order to find |lastn= and |firstn= parameters (or their aliases), and their matching link and mask parameters.
Stops searching when both |lastn= and |firstn= are not found in args after two sequential attempts: found |last1=, |last2=, and |last3= but doesn”t
find |last4= and |last5= then the search is done.

This function emits an error message when there is a |firstn= without a matching |lastn=. When there are “holes” in the list of last names, |last1= and |last3=
are present but |last2= is missing, an error message is emitted. |lastn= is not required to have a matching |firstn=.

When an author or editor parameter contains some form of “et al.”, the “et al.” is stripped from the parameter and a flag (etal) returned
that will cause list_people() to add the static “et al.” text from Module:Citation/CS1/en/Configuration. This keeps “et al.” out of the
template”s metadata. When this occurs, the page is added to a maintenance category.

]]

local function extract_names(args, list_name)
local names = {};– table of names
local last;– individual name components
local first;
local link;
local mask;
local i = 1;– loop counter/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 etal=false;– return value set to true when we find some form of et al. in an author parameter

local err_msg_list_name = list_name:match ("(%w+)List") .. “s list”;– modify AuthorList or EditorList for use in error messages if necessary
while true do
last = select_one( args, cfg.aliases[list_name .. “-Last”], “redundant_parameters”, i );– search through args for name components beginning at 1
first = select_one( args, cfg.aliases[list_name .. “-First”], “redundant_parameters”, i );
link = select_one( args, cfg.aliases[list_name .. “-Link”], “redundant_parameters”, i );
mask = select_one( args, cfg.aliases[list_name .. “-Mask”], “redundant_parameters”, i );

last, etal = name_has_etal (last, etal, false);– find and remove variations on et al.
first, etal = name_has_etal (first, etal, false);– find and remove variations on et al.
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
table.insert( z.message_tail, { set_error( “first_missing_last”, {err_msg_list_name, i}, true ) } );– add this error message
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
if 2 <= count then– two missing names and we give up
break;– normal exit or there is a two-name hole in the list; can”t tell which
end
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

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
if 1 == count then– if the previous name was missing
table.insert( z.message_tail, { set_error( “missing_name”, {err_msg_list_name, i-1}, true ) } );– add this error message
end
count = 0;– reset the counter, we”re looking for two consecutive missing names
end
i = i + 1;– point to next args location
end

return names, etal;– all done, return our list of names
end

–[[————————–< G E T _ I S O 6 3 9 _ C O D E >————————————————

Validates language names provided in |language= parameter if not an ISO639-1 or 639-2 code.

Returns the language name and associated two- or three-character code. Because case of the source may be incorrect
or different from the case that WikiMedia uses, the name comparisons are done in lower case and when a match is
found, the Wikimedia version (assumed to be correct) is returned along with the code. When there is no match, we
return the original language name string.

mw.language.fetchLanguageNames(<local wiki language>, “all”) returns a list of languages that in some cases may include
extensions. For example, code “cbk-zam” and its associated name “Chavacano de Zamboanga” (MediaWiki does not support
code “cbk” or name “Chavacano”. Most (all) of these languages are not used a “language” codes per se, rather they
are used as sub-domain names: cbk-zam.wikipedia.org. These names can be found (for the time being) at
https://phabricator.wikimedia.org/diffusion/ECLD/browse/master/LocalNames/LocalNamesEn.php

Names but that are included in the list will be found if that name is provided in the |language= parameter. For example,
if |language=Chavacano de Zamboanga, that name will be found with the associated code “cbk-zam”. When names are found
and the associated code is not two or three characters, this function returns only the Wikimedia language name.

Adapted from code taken from Module:Check ISO 639-1.

]]

local function get_iso639_code (lang, this_wiki_code)
if cfg.lang_name_remap[lang:lower()] then– if there is a remapped name (because MediaWiki uses something that we don”t think is correct)
return cfg.lang_name_remap[lang:lower()][1], cfg.lang_name_remap[lang:lower()][2];– for this language “name”, return a possibly new name and appropriate code
end

local languages = mw.language.fetchLanguageNames(this_wiki_code, “all”)– get a list of language names known to Wikimedia
— (“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
if langlc == mw.ustring.lower(name) then
if 2 ~= code:len() and 3 ~= code:len() then– two- or three-character codes only; extensions not supported
return name;– so return the name but not the code
end
return name, code;– found it, return name to ensure proper capitalization and the the code
end
end
return lang;– not valid language; return language in original case and nil for the code
end

–[[————————–< L A N G U A G E _ P A R A M E T E R >——————————————

Gets language name from a provided two- or three-character ISO 639 code. If a code is recognized by MediaWiki,
use the returned name; if not, then use the value that was provided with the language parameter.

When |language= contains a recognized language (either code or name), the page is assigned to the category for
that code: Category:Norwegian-language sources (no). For valid three-character code languages, the page is assigned
to the single category for “639-2” codes: Category:CS1 ISO 639-2 language sources.

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.

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.

]]

local function language_parameter (lang)
local code;– the two- or three-character language code
local name;– the language name
local language_list = {};– table of language names to be rendered
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_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

for _, lang in ipairs (names_table) do– reuse lang

if lang:match (“^%a%a%-“) then– strip ietf language tags from code; TODO: is there a need to support 3-char with tag
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
name = mw.language.fetchLanguageName( lang:lower(), this_wiki_code);– get language name if |language= is a proper code
if not is_set (name) then
name = cfg.lang_code_remap[lang];– not supported by MediaWiki; is it in remap
end
end

if is_set (name) then– if |language= specified a valid code
code = lang:lower();– save it
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)
end

if 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

if this_wiki_code ~= code and “en” ~= code then– when the language is not the same as this wiki”s language or en (FaLocalization)
if 2 == code:len() then– and is a two-character code
add_prop_cat (“foreign_lang_source” .. code, {name, code})– categorize it
else– or is a recognized language (but has a three-character code)
add_prop_cat (“foreign_lang_source_2” .. code, {code})– categorize it differently TODO: support mutliple three-character code categories per cs1|2 template
end
end
else
add_maint_cat (“unknown_lang”);– add maint category if not already added
end

table.insert (language_list, name);
name = “”;– so we can reuse it
end

code = #language_list– reuse code as number of languages in the list
if 2 >= code then
name = table.concat (language_list, ” and “)– insert “<space>and<space>” between two language names
elseif 2 < code then
language_list[code] = “and ” .. language_list[code];– prepend last name with “and<space>”
name = table.concat (language_list, “, “)– and concatenate with “<comma><space>” separators
end
if this_wiki_name == name or “انگلیسی” == name then–FaLocalization: "or “انگلیسی” == name"
return “”;– if one language and that language is this wiki”s return an empty string (no annotation)
end
return (" " .. wrap_msg (“language”, name));– otherwise wrap with “(in …)”
–[[ TODO: should only return blank or name rather than full list
so we can clean up the bunched parenthetical elements Language, Type, Format
]]
end

–[[————————–< S E T _ C S 1 _ S T Y L E >—————————————————-

Set style settings for CS1 citation templates. Returns separator and postscript settings
At en.wiki, for cs1:
ps gets:”.”
sep gets:”.”

]]

local function set_cs1_style (ps)
if not is_set (ps) then– unless explicitely set to something
ps = cfg.presentation[“ps_cs1”];– terminate the rendered citation
end
return cfg.presentation[“sep_cs1″], ps;– element separator
end

–[[————————–< S E T _ C S 2 _ S T Y L E >—————————————————-

Set style settings for CS2 citation templates. Returns separator, postscript, ref settings
At en.wiki, for cs2:
ps gets:”” (empty string – no terminal punctuation)
sep gets:”,”

]]

local function set_cs2_style (ps, ref)
if not is_set (ps) then– if |postscript= has not been set, set cs2 default
ps = cfg.presentation[“ps_cs2”];– terminate the rendered citation
end
if not is_set (ref) then– if |ref= is not set
ref = "harv";– set default |ref=harv
end
return cfg.presentation[“sep_cs2”], ps, ref;– element separator
end

–[[————————–< G E T _ S E T T I N G S _ F R O M _ C I T E _ C L A S S >———————-

When |mode= is not set or when its value is invalid, use config.CitationClass and parameter values to establish
rendered style.

]]

local function get_settings_from_cite_class (ps, ref, cite_class)
local sep;
if (cite_class == "citation") then– for citation templates (CS2)
sep, ps, ref = set_cs2_style (ps, ref);
else– not a citation template so CS1
sep, ps = set_cs1_style (ps);
end

return sep, ps, ref– return them all
end

–[[————————–< S E T _ S T Y L E >————————————————————

Establish basic style settings to be used when rendering the citation. Uses |mode= if set and valid or uses
config.CitationClass from the template”s #invoke: to establish style.

]]

local function set_style (mode, ps, ref, cite_class)
local sep;
if “cs2” == mode then– if this template is to be rendered in CS2 (citation) style
sep, ps, ref = set_cs2_style (ps, ref);
elseif “cs1” == mode then– if this template is to be rendered in CS1 (cite xxx) style
sep, ps = set_cs1_style (ps);
else– anything but cs1 or cs2
sep, ps, ref = get_settings_from_cite_class (ps, ref, cite_class);– get settings based on the template”s CitationClass
end
if “none” == ps:lower() then– if assigned value is “none” then
ps = “”;– set to empty string
end

return sep, ps, ref
end

–[=[————————-< 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
applying the pdf icon to external links.

returns true if file extension is one of the recognized extensions, else false

]=]

local function is_pdf (url)
return url:match (“%.pdf$”) or url:match (“%.PDF$”) or url:match (“%.pdf[%#]”) or url:match (“%.PDF[%#]”);
end

–[[————————–< 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
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
the appropriate styling.

]]

local function style_format (format, url, fmt_param, url_param)
if is_set (format) then
format = wrap_style (“format”, format);– add leading space, parentheses, resize
if not is_set (url) then
format = format .. set_error( “format_missing_url”, {fmt_param, url_param} );– add an error message
end
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
else
format = “”;– empty string for concatenation
end
return format;
end

–[[————————–< G E T _ D I S P L A Y _ A U T H O R S _ E D I T O R S >————————

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.

When the value assigned to |display-xxxxors= is a number greater than or equal to zero, return the number and
the previous state of the “etal” flag (false by default but may have been set to true if the name list contains
some variant of the text “et al.”).

When the value assigned to |display-xxxxors= is the keyword “etal”, return a number that is one greater than the
number of authors in the list and set the “etal” flag true. This will cause the list_people() to display all of
the names in the name list followed by “et al.”

In all other cases, returns nil and the previous state of the “etal” flag.

inputs:
max: A[“DisplayAuthors”] or A[“DisplayEditors”]; a number or some flavor of etal
count: #a or #e
list_name: “authors” or “editors”
etal: author_etal or editor_etal

]]

local function get_display_authors_editors (max, count, list_name, etal)
if is_set (max) then
max = numConv(“en” , max);
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.
etal = true;– overrides value set by extract_names()
elseif max:match (“^%d+$”) then– if is a string of numbers
max = tonumber (max);– make it a number
if max >= count then– if |display-xxxxors= value greater than or equal to number of authors/editors
add_maint_cat (“disp_auth_ed”, cfg.special_case_translation [list_name]);
end
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
max = nil;– unset; as if |display-xxxxors= had not been set
end
end

return max, etal;
end

–[[————————–< E X T R A _ T E X T _ I N _ P A G E _ C H E C K >——————————

Adds page to Category:CS1 maint: extra text if |page= or |pages= has what appears to be some form of p. or pp.
abbreviation in the first characters of the parameter content.

check Page and Pages for extraneous p, p., pp, and pp. at start of parameter value:
good pattern: “^P[^%.P%l]” matches when |page(s)= begins PX or P# but not Px where x and X are letters and # is a dgiit
bad pattern: “^[Pp][Pp]” matches matches when |page(s)= begins pp or pP or Pp or PP

]]

local function extra_text_in_page_check (page)
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]”;

if not page:match (good_pattern) and (page:match (bad_pattern) or page:match (“^[Pp]ages”)) then
add_maint_cat (“extra_text”);
end
end

–[=[————————-< G E T _ V _ N A M E _ T A B L E >———————————————-

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
rendered citation and in the metadata. Individual author names may be wikilinked

|vauthors=Jones AB, [[E. B. White|White EB]], ((Black, Brown, and Co.))

]=]

local function get_v_name_table (vparam, output_table, output_link_table)
local name_table = mw.text.split(vparam, "%s*,%s*");– names are separated by commas
local wl_type, label, link;– wl_type not used here; just a place holder

local i = 1;

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
local name = name_table[i];
i=i+1;– bump indexer to next segment
while name_table[i] do
name = name .. “, ” .. name_table[i];– concatenate with previous segments
if name_table[i]:match (“^.*%)%)$”) then– if this table member has the closing doubled parens
break;– and done reassembling so
end
i=i+1;– bump indexer
end
table.insert (output_table, name);– and add corporate name to the output table
table.insert (output_link_table, “”);– no wikilink
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]]
table.insert (output_table, label);– add this name
if 1 == wl_type then
table.insert (output_link_table, label);– simple wikilink [[D]]
else
table.insert (output_link_table, link);– no wikilink or [[L|D]]; add this link if there is one, else empty string
end
end
i = i+1;
end
return output_table;
end

–[[————————–< P A R S E _ V A U T H O R S _ V E D I T O R S >——————————–

This function extracts author / editor names from |vauthors= or |veditors= and finds matching |xxxxor-maskn= and
|xxxxor-linkn= in args. It then returns a table of assembled names just as extract_names() does.

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
tests, are wrapped in doubled paranethese ((corporate name)) to suppress the format tests.

Supports generational suffixes Jr, 2nd, 3rd, 4th–۶th.

This function sets the vancouver error when a reqired comma is missing and when there is a space between an author”s initials.

]]

local function parse_vauthors_veditors (args, vparam, list_name)
local names = {};– table of names assembled from |vauthors=, |author-maskn=, |author-linkn=
local v_name_table = {};
local v_link_table = {};– when name is wikilinked, targets go in this table
local etal = false;– return value set to true when we find some form of et al. vauthors parameter
local last, first, link, mask, suffix;
local corporate = false;

vparam, etal = name_has_etal (vparam, etal, true);– find and remove variations on et al. do not categorize (do it here because et al. might have a period)
v_name_table = get_v_name_table (vparam, v_name_table, v_link_table);– names are separated by commas

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
last = v_name:match (“^%(%((.+)%)%)$”)– remove doubled parntheses
corporate = true;– flag used in list_people()
elseif string.find(v_name, "%s") then
if v_name:find(“[;%.]”) then– look for commonly occurring punctuation characters;
add_vanc_error (“punctuation”);
end
local lastfirstTable = {}
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
if is_suffix (first) then– if a valid suffix
suffix = first– save it as a suffix and
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
last = table.concat(lastfirstTable, " ")– returns a string that is the concatenation of all other names that are not initials
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
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
add_vanc_error (“name”);– matches a space between two intiials
end
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
end

if is_set (first) then
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
end
is_good_vanc_name (last, first);– check first and last before restoring the suffix which may have a non-Latin digit
if is_set (suffix) then
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
end
else
if not corporate then
is_good_vanc_name (last, “”);
end
end

link = select_one( args, cfg.aliases[list_name .. “-Link”], “redundant_parameters”, i ) or v_link_table[i];
mask = select_one( args, cfg.aliases[list_name .. “-Mask”], “redundant_parameters”, i );
names[i] = {last = last, first = first, link = link, mask = mask, corporate=corporate};– add this assembled name to our names list
end
return names, etal;– all done, return our list of names
end

–[[————————–< S E L E C T _ A U T H O R _ E D I T O R _ S O U R C E >————————

Select one of |authors=, |authorn= / |lastn / firstn=, or |vauthors= as the source of the author name list or
select one of |editors=, |editorn= / editor-lastn= / |editor-firstn= or |veditors= as the source of the editor name list.

Only one of these appropriate three will be used. The hierarchy is: |authorn= (and aliases) highest and |authors= lowest and
similarly, |editorn= (and aliases) highest and |editors= lowest

When looking for |authorn= / |editorn= parameters, test |xxxxor1= and |xxxxor2= (and all of their aliases); stops after the second
test which mimicks the test used in extract_names() when looking for a hole in the author name list. There may be a better
way to do this, I just haven”t discovered what that way is.

Emits an error message when more than one xxxxor name source is provided.

In this function, vxxxxors = vauthors or veditors; xxxxors = authors or editors as appropriate.

]]

local function select_author_editor_source (vxxxxors, xxxxors, args, list_name)
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 …
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
select_one( args, cfg.aliases[list_name .. “-First”], “none”, 2 ) then
lastfirst=true;
end

if (is_set (vxxxxors) and true == lastfirst) or– these are the three error conditions
(is_set (vxxxxors) and is_set (xxxxors)) or
(true == lastfirst and is_set (xxxxors)) then
local err_name;
if “AuthorList” == list_name then– figure out which name should be used in error message
err_name = “author”;
else
err_name = “editor”;
end
table.insert( z.message_tail, { set_error( “redundant_parameters”,
{err_name .. “-name-list parameters”}, true ) } );– add error message
end

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 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
end

–[[————————–< I S _ V A L I D _