לדלג לתוכן

יחידה:Citation/CS1: הבדלים בין גרסאות בדף

מתוך צפונות ויקי
זמני
מ 111 גרסאות של הדף wikipedia:he:יחידה:Citation/CS1 יובאו
 
(51 גרסאות ביניים של 6 משתמשים אינן מוצגות)
שורה 1: שורה 1:
-- Copied from English Wikipedia and changed for Hebrew Wikipedia --


local z = {
local z = {
שורה 8: שורה 9:
}
}


--[[--------------------------< F O R W A R D  D E C L A R A T I O N S >--------------------------------------
]]
local dates, year_date_check -- functions in Module:Citation/CS1/Date_validation


--[[--------------------------< I S _ S E T >------------------------------------------------------------------
function local_date( date_string, format )
 
if format==nil then
Returns true if argument is set; false otherwise. Argument is 'set' when it exists (not nil) or when it is not an empty string.
if date_string:match("^%d%d%d%d%-%d%d%-%d%d$") then --year month day format
This function is global because it is called from both this module and from Date validation
format = 'j xg Y'
elseif date_string:match("^%a+ +[1-9]%d?, +[1-9]%d%d%d%a?$") then -- month day, year
format = 'j xg Y'
elseif date_string:match("^[1-9]%d? +%a+ +[1-9]%d%d%d%a?$") then -- day-initial: day month year
format = 'j xg Y'
elseif date_string:match("^%a+ +%d%d%d%d%a?$") then -- month/season year
format='F Y'
--list of accepted formats derived from Citation/CS1/Date validation - in case we may want to localize them later
--elseif date_string:match("^%a+ +[1-9]%d?–[1-9]%d?, +[1-9]%d%d%d%a?$") then -- month-initial day range: month day–day, year; days are separated by endash
--elseif date_string:match("^[1-9]%d?–[1-9]%d? +%a+ +[1-9]%d%d%d%a?$") then -- day-range-initial: day–day month year; days are separated by endash
--elseif date_string:match("^[1-9]%d? +%a+ – [1-9]%d? +%a+ +[1-9]%d%d%d%a?$") then -- day initial month-day-range: day month - day month year; uses spaced endash
--elseif date_string:match("^%a+ +[1-9]%d? – %a+ +[1-9]%d?, +[1-9]%d%d%d?%a?$") then -- month initial month-day-range: month day – month day, year;  uses spaced endash
--elseif date_string:match("^[1-9]%d? +%a+ +[1-9]%d%d%d – [1-9]%d? +%a+ +[1-9]%d%d%d%a?$") then -- day initial month-day-year-range: day month year - day month year; uses spaced endash
--elseif date_string:match("^%a+ +[1-9]%d?, +[1-9]%d%d%d – %a+ +[1-9]%d?, +[1-9]%d%d%d%a?$") then -- month initial month-day-year-range: month day, year – month day, year;  uses spaced endash
--elseif date_string:match("^%a+ +[1-9]%d%d%d–%d%d%a?$") then -- special case Winter/Summer year-year (YYYY-YY); year separated with unspaced endash
--elseif date_string:match("^%a+ +[1-9]%d%d%d–[1-9]%d%d%d%a?$") then -- special case Winter/Summer year-year; year separated with unspaced endash
--elseif date_string:match("^%a+ +[1-9]%d%d%d% – %a+ +[1-9]%d%d%d%a?$") then -- month/season year - month/season year; separated by spaced endash
--elseif date_string:match ("^%a+–%a+ +[1-9]%d%d%d%a?$") then -- month/season range year; months separated by endash
--elseif date_string:match("^[1-9]%d%d%d?–[1-9]%d%d%d?%a?$") then -- Year range: YYY-YYY or YYY-YYYY or YYYY–YYYY; separated by unspaced endash; 100-9999
--elseif date_string:match("^[1-9]%d%d%d–%d%d%a?$") then -- Year range: YYYY–YY; separated by unspaced endash
--elseif date_string:match("^[1-9]%d%d%d?%a?$") then -- year; here accept either YYY or YYYY
else
--return date_string
error('Unsupported format')
end
end
return  mw.getContentLanguage():formatDate(format, date_string)
end


]]
-- Whether variable is set or not
function is_set( var )
function is_set( var )
return not (var == nil or var == '');
return not (var == nil or var == '');
end
end


--[[--------------------------< F I R S T _ S E T >------------------------------------------------------------
-- First set variable or nil if none
 
function first_set(...)
First set variable or nil if none
 
]]
 
local function first_set(...)
local list = {...};
local list = {...};
for _, var in pairs(list) do
for _, var in pairs(list) do
שורה 37: שורה 58:
end
end


--[[--------------------------< I N _ A R R A Y >--------------------------------------------------------------
-- Whether needle is in haystack
 
function inArray( needle, haystack )
Whether needle is in haystack
 
]]
 
local function in_array( needle, haystack )
if needle == nil then
if needle == nil then
return false;
return false;
שורה 55: שורה 71:
end
end


--[[--------------------------< S U B S T I T U T E >----------------------------------------------------------
--[[
 
Categorize and emit an error message when the citation contains one or more deprecated parameters.  Because deprecated parameters (currently |month=,
Populates numbered arguments in a message string using an argument table.
|coauthor=, and |coauthors=) aren't related to each other and because these parameters may be concatenated into the variables used by |date= and |author#= (and aliases)
 
details of which parameter caused the error message are not provided.  Only one error message is emitted regardless of the number of deprecated parameters in the citation.
]]
]]
function deprecated_parameter()
if true ~= Page_in_deprecated_cat then -- if we haven't been here before then set a
Page_in_deprecated_cat=true; -- sticky flag so that if there are more than one deprecated parameter the category is added only once
table.insert( z.message_tail, { seterror( 'deprecated_params', {}, true ) } ); -- add error message
end
end


local function substitute( msg, args )
-- Populates numbered arguments in a message string using an argument table.
function substitute( msg, args )
return args and mw.message.newRawMessage( msg, args ):plain() or msg;
return args and mw.message.newRawMessage( msg, args ):plain() or msg;
end
end


--[[--------------------------< E R R O R _ C O M M E N T >----------------------------------------------------
--[[--------------------------< K E R N _ Q U O T E S >--------------------------------------------------------


Wraps error messages with css markup according to the state of hidden.
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.
 
Call this function for chapter titles, for website titles, etc; not for book titles.


]]
]]
local function error_comment( content, hidden )
 
return substitute( hidden and cfg.presentation['hidden-error'] or cfg.presentation['visible-error'], content );
function kern_quotes (str)
local cap='';
local cap2='';
cap, cap2 = str:match ("^([\"\'])([^\'].+)"); -- match leading double or single quote but not double single quotes
if is_set (cap) then
str = substitute (cfg.presentation['kern-left'], {cap, cap2});
end
 
cap, cap2 = str:match ("^(.+[^\'])([\"\'])$")
if is_set (cap) then
str = substitute (cfg.presentation['kern-right'], {cap, cap2});
end
return str;
end
end


--[[--------------------------< S E T _ E R R O R >--------------------------------------------------------------
--[[--------------------------< 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.


Sets an error condition and returns the appropriate error message.  The actual placement of the error message in the output is
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.
the responsibility of the calling function.


]]
|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:
local function set_error( error_id, arguments, raw, prefix, suffix )
|script-title=ja:*** *** (where * represents a Japanese character)
local error_state = cfg.error_conditions[ error_id ];
Spaces between the two-character code and the colon and the colon and the first script character are allowed:
|script-title=ja : *** ***
prefix = prefix or "";
|script-title=ja: *** ***
suffix = suffix or "";
|script-title=ja :*** ***
Spaces preceding the prefix are allowed: |script-title = ja:*** ***
if error_state == nil then
error( cfg.messages['undefined_error'] );
elseif is_set( error_state.category ) then
table.insert( z.error_categories, error_state.category );
end
local message = substitute( error_state.message, arguments );
message = message .. " ([[" .. cfg.messages['help page link'] ..
"#" .. error_state.anchor .. "|" ..
cfg.messages['help page label'] .. "]])";
z.error_ids[ error_id ] = true;
if in_array( error_id, { 'bare_url_missing_title', 'trans_missing_title' } )
and z.error_ids['citation_missing_title'] then
return '', false;
end
message = table.concat({ prefix, message, suffix });
if raw == true then
return message, error_state.hidden;
end
return error_comment( message, error_state.hidden );
end


--[[--------------------------< C H E C K _ U R L >------------------------------------------------------------
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.


Determines whether a URL string is valid.
At this writing, only |script-title= is supported.  It is anticipated that additional parameters will be created to use this function.
 
At present the only check is whether the string appears to be prefixed with a URI scheme.  It is not determined whether
the URI scheme is valid or whether the URL is otherwise well formed.


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


local function check_url( url_str )
function format_script_value (script_value)
return url_str:sub(1,2) == "//" or url_str:match( "^[^/]*:" ) ~= nil; -- Protocol-relative or URL scheme
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 = mw.language.fetchLanguageName( lang, "he" ); -- 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 inArray (lang, {'ar', 'bs', 'dv', 'el', 'en', 'he', 'fa', 'hy', 'ja', 'ko', 'ku', 'ps', 'ru', 'sd', 'sr', 'th', 'uk', 'ug', 'yi', 'zh'}) then
table.insert( z.properties_cats, 'ציטוט עם תסריט בשפה זרה ('..name..')'); -- categorize in language-specific categories
else
table.insert( z.properties_cats, 'ציטוט משתמש בתסריט בשפה זרה'); -- use this category as a catchall until language-specific category is available
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
end


--[[--------------------------< S A F E _ F O R _ I T A L I C S >----------------------------------------------
--[[--------------------------< S C R I P T _ C O N C A T E N A T E >------------------------------------------
 
Protects a string that will be wrapped in wiki italic markup '' ... ''
 
Note: We cannot use <i> for italics, as the expected behavior for italics specified by ''...'' in the title is that
they will be inverted (i.e. unitalicized) in the resulting references.  In addition, <i> and '' tend to interact
poorly under Mediawiki's HTML tidy.


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 safe_for_italics( str )
function script_concatenate (title, script)
if not is_set(str) then
if is_set (script) then
return str;
script = format_script_value (script); -- <bdi> tags, lang atribute, categorization, etc; returns empty string on error
else
if is_set (script) then
if str:sub(1,1) == "'" then str = "<span />" .. str; end
title = title .. ' ' .. script; -- concatenate title and script title
if str:sub(-1,-1) == "'" then str = str .. "<span />"; end
end
-- Remove newlines as they break italics.
return str:gsub( '\n', ' ' );
end
end
return title;
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


--[[--------------------------< W R A P _ S T Y L E >----------------------------------------------------------
--[[--------------------------< W R A P _ S T Y L E >----------------------------------------------------------
שורה 173: שורה 194:
]]
]]


local function wrap_style (key, str)
function wrap_style (key, str, lang)
if not is_set( str ) then
if not is_set( str ) then
return "";
return "";
elseif in_array( key, { 'italic-title', 'trans-italic-title' } ) then
elseif inArray( key, { 'italic-title', 'trans-italic-title' } ) then
str = safe_for_italics( str );
-- avoid italics for hebrew script
local isHebrew = mw.ustring.find( str, '[א-ת]' )
if (is_set(lang) and lang == 'he') or (isHebrew~=nil) then
return str
else
str = '<span dir="auto">'..safeforitalics( str )..'</span>';
end
end
end


שורה 183: שורה 210:
end
end


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


Format an external link with error checking
--[[--------------------------< 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 external_link( URL, label, source )
function wrap_msg (key, str, lower)
local error_str = "";
if not is_set( str ) then
if not is_set( label ) then
return "";
label = URL;
end
if is_set( source ) then
if true == lower then
error_str = set_error( 'bare_url_missing_title', { wrap_style ('parameter', source) }, false, " " );
local msg;
else
msg = cfg.messages[key]:lower(); -- set the message to lower case before
error( cfg.messages["bare_url_no_origin"] );
str = substitute( msg, {str} ); -- including template text
end
return str;
end
else
if not check_url( URL ) then
return substitute( cfg.messages[key], {str} );
error_str = set_error( 'bad_url', {}, false, " " ) .. error_str;
end
end
return table.concat({ "[", URL, " ", safe_for_url( label ), "]", error_str });
end
end


--[[--------------------------< E X T E R N A L _ L I N K _ I D >----------------------------------------------
--[[--------------------------< F O R M A T _ C H A P T E R _ T I T L E >--------------------------------------


Formats a wiki style external link
Format the three chapter parameters: |chapter=, |trans-chapter=, and |chapter-url= into a single Chapter meta-
parameter (chapter_url_source used for error messages).


]]
]]


local function external_link_id(options)
function format_chapter_title (chapter, transchapter, chapterurl, chapter_url_source)
local url_string = options.id;
local chapter_error = '';
if options.encode == true or options.encode == nil then
-- our code
url_string = mw.uri.encode( url_string );
if is_set (transchapter) then
transchapter = '<span class="mw-content-rtl">' .. transchapter .. "</span>";
end
end
return mw.ustring.format( '[[%s|%s]]%s[%s%s%s %s]',
-- our code end
options.link, options.label, options.separator or "&nbsp;",
if not is_set (chapter) then
options.prefix, url_string, options.suffix or "",
chapter = ''; -- just to be safe for concatenation
mw.text.nowiki(options.id)
if is_set (transchapter) then
);
chapter = wrap_style ('trans-quoted-title', transchapter);
end
chapter_error = " " .. seterror ('trans_missing_chapter');
end
if is_set (chapterurl) then
chapter = externallink (chapterurl, chapter, chapter_url_source); -- adds bare_url_missing_title error if appropriate
end
return chapter .. chapter_error;
else -- here when chapter is set
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);
if is_set (transchapter) then
transchapter = wrap_style ('trans-quoted-title', transchapter);
chapter = chapter .. ' ' .. transchapter;
end
if is_set (chapterurl) then
chapter = externallink (chapterurl, chapter); -- adds bare_url_missing_title error if appropriate
end
end
return chapter;
end


--[[
--[[
Categorize and emit an error message when the citation contains one or more deprecated parametersBecause deprecated parameters (currently |month=,
Argument wrapperThis function provides support for argument
|coauthor=, and |coauthors=) aren't related to each other and because these parameters may be concatenated into the variables used by |date= and |author#= (and aliases)
mapping defined in the configuration file so that multiple names
details of which parameter caused the error message are not provided.  Only one error message is emitted regardless of the number of deprecated parameters in the citation.
can be transparently aliased to single internal variable.
]]
]]
local function deprecated_parameter(name)
function argument_wrapper( args )
if true ~= Page_in_deprecated_cat then -- if we haven't been here before then set a
local origin = {};
Page_in_deprecated_cat=true; -- sticky flag so that if there are more than one deprecated parameter the category is added only once
table.insert( z.message_tail, { set_error( 'deprecated_params', {name}, true ) } ); -- add error message
return setmetatable({
end
ORIGIN = function( self, k )
end
local dummy = self[k]; --force the variable to be loaded.
 
return origin[k];
--[[--------------------------< K E R N _ Q U O T E S >--------------------------------------------------------
end
 
},
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:
__index = function ( tbl, k )
"'Unkerned title with leading and trailing single quote marks'"
if origin[k] ~= nil then
" 'Kerned title with leading and trailing single quote marks' " (in real life the kerning isn't as wide as this example)
return nil;
Double single quotes (italic or bold wikimarkup) are not kerned.
end
 
Call this function for chapter titles, for website titles, etc; not for book titles.
local args, list, v = args, cfg.aliases[k];
 
]]
if type( list ) == 'table' then
 
v, origin[k] = selectone( args, list, 'redundant_parameters' );
local function kern_quotes (str)
if origin[k] == nil then
local cap='';
origin[k] = ''; -- Empty string, not nil
local cap2='';
end
elseif list ~= nil then
cap, cap2 = str:match ("^([\"\'])([^\'].+)"); -- match leading double or single quote but not double single quotes
v, origin[k] = args[list], list;
if is_set (cap) then
else
str = substitute (cfg.presentation['kern-left'], {cap, cap2});
-- maybe let through instead of raising an error?
end
-- v, origin[k] = args[k], k;
 
error( cfg.messages['unknown_argument_map'] );
cap, cap2 = str:match ("^(.+[^\'])([\"\'])$")
end
if is_set (cap) then
str = substitute (cfg.presentation['kern-right'], {cap, cap2});
-- Empty strings, not nil;
end
if v == nil then
return str;
v = cfg.defaults[k] or '';
origin[k] = '';
end
tbl = rawset( tbl, k, v );
return v;
end,
});
end
end


--[[--------------------------< F O R M A T _ S C R I P T _ V A L U E >----------------------------------------
--[[
Looks for a parameter's name in the whitelist.


|script-title= holds title parameters that are not written in Latin based scripts: Chinese, Japanese, Arabic, Hebrew, etc. These scripts should
Parameters in the whitelist can have three values:
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
true - active, supported parameters
in italic markup.
false - deprecated, supported parameters
nil - unsupported parameters
]]
function validate( name )
local name = tostring( name );
local state = whitelist.basic_arguments[ name ];
-- Normal arguments
if true == state then return true; end -- valid actively supported parameter
if false == state then
deprecated_parameter (); -- parameter is deprecated but still supported
return true;
end
-- Arguments with numbers in them
name = name:gsub( "%d+", "#" ); -- replace digit(s) with # (last25 becomes last#
state = whitelist.numbered_arguments[ name ];
if true == state then return true; end -- valid actively supported parameter
if false == state then
deprecated_parameter (); -- parameter is deprecated but still supported
return true;
end
return false; -- Not supported because not found or name is set to nil
end


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.
--[[--------------------------< E R R O R C O M M E N T >------------------------------------------------------


|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:
Wraps error messages with css markup according to the state of hidden.
|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
function errorcomment( content, hidden )
is not added.  At this time there is no error message for this condition.
return substitute( hidden and cfg.presentation['hidden-error'] or cfg.presentation['visible-error'], content );
end


At this writing, only |script-title= is supportedIt is anticipated that additional parameters will be created to use this function.
--[[
 
Sets an error condition and returns the appropriate error messageThe actual placement
TODO: error messages when prefix is invalid ISO639-1 code; when script_value has prefix but no script;
of the error message in the output is the responsibility of the calling function.
]]
]]
 
function seterror( error_id, arguments, raw, prefix, suffix )
local function format_script_value (script_value)
local error_state = cfg.error_conditions[ error_id ];
local lang=''; -- initialize to empty string
local name;
prefix = prefix or "";
if script_value:match('^%l%l%s*:') then -- if first 3 non-space characters are script language prefix
suffix = suffix or "";
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
if error_state == nil then
return ''; -- script_value was just the prefix so return empty string
error( cfg.messages['undefined_error'] );
end
elseif is_set( error_state.category ) then
-- if we get this far we have prefix and script
table.insert( z.error_categories, error_state.category );
name = mw.language.fetchLanguageName( lang, "en" ); -- get language name so that we can use it to categorize
end
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
local message = substitute( error_state.message, arguments );
-- is prefix one of these language codes?
if in_array (lang, {'ar', 'bg', 'bs', 'dv', 'el', 'fa', 'hy', 'ja', 'ka', 'ko', 'ku', 'he', 'ps', 'ru', 'sd', 'sr', 'th', 'uk', 'ug', 'yi', 'zh'}) then
message = "<span dir=ltr class=registered_only>" .. message .. " ([[" .. cfg.messages['help page link'] ..
table.insert( z.properties_cats, 'CS1 uses ' .. name .. '-language script ('..lang..')'); -- categorize in language-specific categories
"#" .. error_state.anchor .. "|" ..
else
cfg.messages['help page label'] .. "]])" .. "</span>";
table.insert( z.properties_cats, 'CS1 uses foreign language script'); -- use this category as a catchall until language-specific category is available
end
z.error_ids[ error_id ] = true;
lang = ' lang="' .. lang .. '" '; -- convert prefix into a lang attribute
if inArray( error_id, { 'bare_url_missing_title', 'trans_missing_title' } )
else
and z.error_ids['citation_missing_title'] then
lang = ''; -- invalid so set lang to empty string
return '', false;
end
end
end
script_value = substitute (cfg.presentation['bdi'], {lang, script_value}); -- isolate in case script is rtl
message = table.concat({ prefix, message, suffix });
if raw == true then
return message, error_state.hidden;
end
return errorcomment( message, error_state.hidden );
end


return script_value;
-- Formats a wiki style external link
function externallinkid(options)
local url_string = options.id;
if options.encode == true or options.encode == nil then
url_string = mw.uri.encode( url_string );
end
return mw.ustring.format( '[[%s|%s]]%s[%s%s%s %s]',
options.link, options.label, options.separator or "&nbsp;",
options.prefix, url_string, options.suffix or "",
mw.text.nowiki(options.id)
);
end
end


--[[--------------------------< S C R I P T _ C O N C A T E N A T E >------------------------------------------
-- Formats a wiki style internal link
function internallinkid(options)
return mw.ustring.format( '[[%s|%s]]%s[[%s%s%s|%s]]',
options.link, options.label, options.separator or "&nbsp;",
options.prefix, options.id, options.suffix or "",
mw.text.nowiki(options.id)
);
end


Initially for |title= and |script-title=, this function concatenates those two parameter values after the script value has been
-- Format an external link with error checking
wrapped in <bdi> tags.
function externallink( URL, label, source )
]]
local error_str = "";
 
if not is_set( label ) then
local function script_concatenate (title, script)
label = URL;
if is_set (script) then
if is_set( source ) then
script = format_script_value (script); -- <bdi> tags, lang atribute, categorization, etc; returns empty string on error
error_str = seterror( 'bare_url_missing_title', { wrap_style ('parameter', source) }, false, " " );
if is_set (script) then
else
title = title .. ' ' .. script; -- concatenate title and script title
error( cfg.messages["bare_url_no_origin"] );
end
end
end
if not checkurl( URL ) then
error_str = seterror( 'bad_url', {}, false, " " ) .. error_str;
end
end
return title;
return table.concat({ "[", URL, " ", safeforurl( label ), "]", error_str });
end
end


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


--[[--------------------------< W R A P _ M S G >--------------------------------------------------------------
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


Applies additional message text to various parameter values. Supplied string is wrapped using a message_list
DOES NOT yet support MMMM YYYY or any of the date ranges.
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)
function nowrap_date (date)
if not is_set( str ) then
local cap='';
return "";
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
end
if true == lower then
local msg;
return date;
msg = cfg.messages[key]:lower(); -- set the message to lower case before
str = substitute( msg, {str} ); -- including template text
return str;
else
return substitute( cfg.messages[key], {str} );
end
end
end
--[[--------------------------< S E L E C T _ O N E >----------------------------------------------------------


Chooses one matching parameter from a list of parameters to consider
--[[--------------------------< A M A Z O N >------------------------------------------------------------------
Generates an error if more than one match is present.
 
Formats a link to Amazon.  Do simple error checking: asin must be mix of 10 numeric or uppercase alpha
characters.  If a mix, first character must be uppercase alpha; if all numeric, asins must be 10-digit
isbn. If 10-digit isbn, add a maintenance category so a bot or awb script can replace |asin= with |isbn=.
Error message if not 10 characters, if not isbn10, if mixed and first character is a digit.


]]
]]


local function select_one( args, possible, error_condition, index )
function amazon(id, domain)
local value = nil;
local err_cat = ""
local selected = '';
 
local error_list = {};
if not id:match("^[%d%u][%d%u][%d%u][%d%u][%d%u][%d%u][%d%u][%d%u][%d%u][%d%u]$") then
err_cat = ' ' .. seterror ('bad_asin'); -- asin is not a mix of 10 uppercase alpha and numeric characters
if index ~= nil then index = tostring(index); end
else
if id:match("^%d%d%d%d%d%d%d%d%d%d$") then -- if 10-digit numeric
-- Handle special case of "#" replaced by empty string
if checkisbn( id ) then -- see if asin value is isbn10
if index == '1' then
table.insert( z.maintenance_cats, "תבנית ציטוט משתמשת בקוד ספר בתור ASIN"); -- add to maint category
for _, v in ipairs( possible ) do
elseif not is_set (err_cat) then
v = v:gsub( "#", "" );
err_cat = ' ' .. seterror ('bad_asin'); -- asin is not isbn10
if is_set(args[v]) then
if value ~= nil and selected ~= v then
table.insert( error_list, v );
else
value = args[v];
selected = v;
end
end
end
end
elseif not id:match("^%u[%d%u]+$") then
err_cat =  ' ' .. seterror ('bad_asin'); -- asin doesn't begin with uppercase alpha
end
end
if not is_set(domain) then
domain = "com";
elseif inArray (domain, {'jp', 'uk'}) then -- Japan, United Kingdom
domain = "co." .. domain;
elseif inArray (domain, {'au', 'br', 'mx'}) then -- Australia, Brazil, Mexico
domain = "com." .. domain;
end
end
local handler = cfg.id_handlers['ASIN'];
for _, v in ipairs( possible ) do
return externallinkid({link = handler.link,
if index ~= nil then
label=handler.label , prefix="//www.amazon."..domain.."/dp/",id=id,
v = v:gsub( "#", index );
encode=handler.encode, separator = handler.separator}) .. err_cat;
end
if is_set(args[v]) then
if value ~= nil and selected ~=  v then
table.insert( error_list, v );
else
value = args[v];
selected = v;
end
end
end
if #error_list > 0 then
local error_str = "";
for _, k in ipairs( error_list ) do
if error_str ~= "" then error_str = error_str .. cfg.messages['parameter-separator'] end
error_str = error_str .. wrap_style ('parameter', k);
end
if #error_list > 1 then
error_str = error_str .. cfg.messages['parameter-final-separator'];
else
error_str = error_str .. cfg.messages['parameter-pair-separator'];
end
error_str = error_str .. wrap_style ('parameter', selected);
table.insert( z.message_tail, { set_error( error_condition, {error_str}, true ) } );
end
return value, selected;
end
end


--[[--------------------------< F O R M A T _ C H A P T E R _ T I T L E >--------------------------------------
--[[
 
format and error check arXiv identifier.  There are two valid forms of the identifier:
Format the three chapter parameters: |chapter=, |trans-chapter=, and |chapter-url= into a single Chapter meta-
the first form, valid only between date codes 9108 and 0703 is:
parameter (chapter_url_source used for error messages).
arXiv:<archive>.<class>/<date code><number><version>
 
where:
<archive> is a string of alpha characters - may be hyphenated; no other punctuation
<class> is a string of alpha characters - may be hyphenated; no other punctuation
<date code> is four digits in the form YYMM where YY is the last two digits of the four-digit year and MM is the month number January = 01
first digit of YY for this form can only 9 and 0
<number> is a three-digit number
<version> is a 1 or more digit number preceded with a lowercase v; no spaces (undocumented)
the second form, valid from April 2007 is:
arXiv:<date code>.<number><version>
where:
<date code> is four digits in the form YYMM where YY is the last two digits of the four-digit year and MM is the month number January = 01
<number> is a four-digit number
<version> is a 1 or more digit number preceded with a lowercase v; no spaces
]]
]]


local function format_chapter_title (chapter, transchapter, chapterurl, chapter_url_source)
function arxiv (id)
local chapter_error = '';
local handler = cfg.id_handlers['ARXIV'];
local year, month, version;
local err_cat = ""
if not is_set (chapter) then
year, month, version = id:match("^%a[%a%.%-]+/([90]%d)([01]%d)%d%d%d([v%d]*)$"); -- test for the 9108-0703 format
chapter = ''; -- just to be safe for concatenation
if not year then -- arXiv id is not proper 9108-0703 form
if is_set (transchapter) then
year, month, version = id:match("^(%d%d)([01]%d)%.%d%d%d%d([v%d]*)$"); -- test for the 0704- format
chapter = wrap_style ('trans-quoted-title', transchapter);
if not year then
chapter_error = " " .. set_error ('trans_missing_chapter');
err_cat = ' ' .. seterror( 'bad_arxiv' ); -- arXiv id doesn't match either format
else -- id is the 0704- format
year = tonumber(year);
month = tonumber(month);
if ((7 > year) or (1 > month and 12 < month)) or -- is year invalid or is month invalid? (doesn't test for future years)
((7 == year) and (4 > month)) or -- when year is 07, is month invalid (before April)?
is_set (version) and nil == version:match("v%d+") then -- is version proper format of single 'v' followed by digits?
err_cat = ' ' .. seterror( 'bad_arxiv' ); -- set error message
end
end
end
if is_set (chapterurl) then
else -- id is the 9108-0703 format; are the date values ok
chapter = external_link (chapterurl, chapter, chapter_url_source); -- adds bare_url_missing_title error if appropriate
year = tonumber(year);
month = tonumber(month);
if ((91 > year and 7 < year) or (1 > month and 12 < month)) or -- if invalid year or invalid month
((91 == year and 8 > month) or (7 == year and 3 < month)) or -- if years ok, are starting and ending months ok?
is_set (version) and nil == version:match("v%d+") then -- is version proper format of single 'v' followed by digits?
err_cat = ' ' .. seterror( 'bad_arxiv' ); -- set error message
end
end
return chapter .. chapter_error;
end
else -- here when chapter is set
 
chapter = kern_quotes (chapter); -- if necessary, separate chapter title's leading and trailing quote marks from Module provided quote marks
return externallinkid({link = handler.link, label = handler.label,
chapter = wrap_style ('quoted-title', chapter);
prefix=handler.prefix,id=id,separator=handler.separator, encode=handler.encode}) .. err_cat;
if is_set (transchapter) then
transchapter = wrap_style ('trans-quoted-title', transchapter);
chapter = chapter .. ' ' .. transchapter;
end
if is_set (chapterurl) then
chapter = external_link (chapterurl, chapter); -- adds bare_url_missing_title error if appropriate
end
end
return chapter;
end
end


--[[
--[[
Argument wrapper. This function provides support for argument
lccn normalization (http://www.loc.gov/marc/lccn-namespace.html#normalization)
mapping defined in the configuration file so that multiple names
1. Remove all blanks.
can be transparently aliased to single internal variable.
2. If there is a forward slash (/) in the string, remove it, and remove all characters to the right of the forward slash.
3. If there is a hyphen in the string:
a. Remove it.
b. Inspect the substring following (to the right of) the (removed) hyphen. Then (and assuming that steps 1 and 2 have been carried out):
1. All these characters should be digits, and there should be six or less. (not done in this function)
2. If the length of the substring is less than 6, left-fill the substring with zeroes until the length is six.
 
Returns a normalized lccn for lccn() to validate.  There is no error checking (step 3.b.1) performed in this function.
]]
]]
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


--[[
function normalize_lccn (lccn)
Looks for a parameter's name in the whitelist.
lccn = lccn:gsub ("%s", ""); -- 1. strip whitespace
 
if nil ~= string.find (lccn,'/') then
lccn = lccn:match ("(.-)/"); -- 2. remove forward slash and all character to the right of it
end
 
local prefix
local suffix
prefix, suffix = lccn:match ("(.+)%-(.+)"); -- 3.a remove hyphen by splitting the string into prefix and suffix
 
if nil ~= suffix then -- if there was a hyphen
suffix=string.rep("0", 6-string.len (suffix)) .. suffix; -- 3.b.2 left fill the suffix with 0s if suffix length less than 6
lccn=prefix..suffix; -- reassemble the lccn
end
return lccn;
end
 
--[[
Format LCCN link and do simple error checking.  LCCN is a character string 8-12 characters long. The length of the LCCN dictates the character type of the first 1-3 characters; the
rightmost eight are always digits. http://info-uri.info/registry/OAIHandler?verb=GetRecord&metadataPrefix=reg&identifier=info:lccn/
 
length = 8 then all digits
length = 9 then lccn[1] is lower case alpha
length = 10 then lccn[1] and lccn[2] are both lower case alpha or both digits
length = 11 then lccn[1] is lower case alpha, lccn[2] and lccn[3] are both lower case alpha or both digits
length = 12 then lccn[1] and lccn[2] are both lower case alpha


Parameters in the whitelist can have three values:
true - active, supported parameters
false - deprecated, supported parameters
nil - unsupported parameters
]]
]]
local function validate( name )
function lccn(lccn)
local name = tostring( name );
local handler = cfg.id_handlers['LCCN'];
local state = whitelist.basic_arguments[ name ];
local err_cat = ''; -- presume that LCCN is valid
local id = lccn; -- local copy of the lccn
-- Normal arguments
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
-- Arguments with numbers in them
name = name:gsub( "%d+", "#" ); -- replace digit(s) with # (last25 becomes last#
state = whitelist.numbered_arguments[ name ];
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
return false; -- Not supported because not found or name is set to nil
end


id = normalize_lccn (id); -- get canonical form (no whitespace, hyphens, forward slashes)
local len = id:len(); -- get the length of the lccn


-- Formats a wiki style internal link
if 8 == len then
local function internal_link_id(options)
if id:match("[^%d]") then -- if LCCN has anything but digits (nil if only digits)
return mw.ustring.format( '[[%s|%s]]%s[[%s%s%s|%s]]',
err_cat = ' ' .. seterror( 'bad_lccn' ); -- set an error message
options.link, options.label, options.separator or "&nbsp;",
end
options.prefix, options.id, options.suffix or "",
elseif 9 == len then -- LCCN should be adddddddd
mw.text.nowiki(options.id)
if nil == id:match("%l%d%d%d%d%d%d%d%d") then -- does it match our pattern?
);
err_cat = ' ' .. seterror( 'bad_lccn' ); -- set an error message
end
end
elseif 10 == len then -- LCCN should be aadddddddd or dddddddddd
if id:match("[^%d]") then -- if LCCN has anything but digits (nil if only digits) ...
if nil == id:match("^%l%l%d%d%d%d%d%d%d%d") then -- ... see if it matches our pattern
err_cat = ' ' .. seterror( 'bad_lccn' ); -- no match, set an error message
end
end
elseif 11 == len then -- LCCN should be aaadddddddd or adddddddddd
if not (id:match("^%l%l%l%d%d%d%d%d%d%d%d") or id:match("^%l%d%d%d%d%d%d%d%d%d%d")) then -- see if it matches one of our patterns
err_cat = ' ' .. seterror( 'bad_lccn' ); -- no match, set an error message
end
elseif 12 == len then -- LCCN should be aadddddddddd
if not id:match("^%l%l%d%d%d%d%d%d%d%d%d%d") then -- see if it matches our pattern
err_cat = ' ' .. seterror( 'bad_lccn' ); -- no match, set an error message
end
else
err_cat = ' ' .. seterror( 'bad_lccn' ); -- wrong length, set an error message
end


if not is_set (err_cat) and nil ~= lccn:find ('%s') then
err_cat = ' ' .. seterror( 'bad_lccn' ); -- lccn contains a space, set an error message
end


--[[--------------------------< N O W R A P _ D A T E >--------------------------------------------------------
return externallinkid({link = handler.link, label = handler.label,
 
prefix=handler.prefix,id=lccn,separator=handler.separator, encode=handler.encode}) .. err_cat;
When date is YYYY-MM-DD format wrap in nowrap span: <span ...>YYYY-MM-DD</span>. When date is DD MMMM YYYY or is
end
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.


--[[
Format PMID and do simple error checking.  PMIDs are sequential numbers beginning at 1 and counting up.  This code checks the PMID to see that it
contains only digits and is less than test_limit; the value in local variable test_limit will need to be updated periodically as more PMIDs are issued.
]]
]]
 
function pmid(id)
local function nowrap_date (date)
local test_limit = 30000000; -- update this value as PMIDs approach
local cap='';
local handler = cfg.id_handlers['PMID'];
local cap2='';
local err_cat = ''; -- presume that PMID is valid
 
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
if id:match("[^%d]") then -- if PMID has anything but digits
cap, cap2 = string.match (date, "^(.*)%s+(%d%d%d%d)$");
err_cat = ' ' .. seterror( 'bad_pmid' ); -- set an error message
date = substitute (cfg.presentation['nowrap2'], {cap, cap2});
else -- PMID is only digits
local id_num = tonumber(id); -- convert id to a number for range testing
if 1 > id_num or test_limit < id_num then -- if PMID is outside test limit boundaries
err_cat = ' ' .. seterror( 'bad_pmid' ); -- set an error message
end
end
end
return date;
return externallinkid({link = handler.link, label = handler.label,
prefix=handler.prefix,id=id,separator=handler.separator, encode=handler.encode}) .. err_cat;
end
end


--[[--------------------------< IS _ V A L I D _ I S X N >-----------------------------------------------------
--[[
 
Determines if a PMC identifier's online version is embargoed. Compares the date in |embargo= against today's date. If embargo date is
ISBN-10 and ISSN validator code calculates checksum across all isbn/issn digits including the check digit. ISBN-13 is checked in check_isbn().
in the future, returns true; otherwise, returns false because the embargo has expired or |embargo= not set in this cite.
If the number is valid the result will be 0. Before calling this function, issbn/issn must be checked for length and stripped of dashes,
spaces and other non-isxn characters.
 
]]
]]
 
function is_embargoed(embargo)
local function is_valid_isxn (isxn_str, len)
if is_set(embargo) then
local temp = 0;
local lang = mw.getContentLanguage();
isxn_str = { isxn_str:byte(1, len) }; -- make a table of bytes
local good1, embargo_date, good2, todays_date;
len = len+1; -- adjust to be a loop counter
good1, embargo_date = pcall( lang.formatDate, lang, 'U', embargo );
for i, v in ipairs( isxn_str ) do -- loop through all of the bytes and calculate the checksum
good2, todays_date = pcall( lang.formatDate, lang, 'U' );
if v == string.byte( "X" ) then -- if checkdigit is X
temp = temp + 10*( len - i ); -- it represents 10 decimal
if good1 and good2 and tonumber( embargo_date ) >= tonumber( todays_date ) then --is embargo date is in the future?
else
return true; -- still embargoed
temp = temp + tonumber( string.char(v) )*(len-i);
end
end
end
end
return temp % 11 == 0; -- returns true if calculation result is zero
return false; -- embargo expired or |embargo= not set
end
end


--[[
Format a PMC, do simple error checking, and check for embargoed articles.


--[[--------------------------< C H E C K _ I S B N >------------------------------------------------------------
The embargo parameter takes a date for a value. If the embargo date is in the future
 
the PMC identifier will not be linked to the article.  If the embargo specifies a date in the past, or if it is empty or omitted, then
Determines whether an ISBN string is valid
the PMC identifier is linked to the article through the link at cfg.id_handlers['PMC'].prefix.


PMCs are sequential numbers beginning at 1 and counting up.  This code checks the PMC to see that it contains only digits and is less
than test_limit; the value in local variable test_limit will need to be updated periodically as more PMCs are issued.
]]
]]
function pmc(id, embargo)
local test_limit = 6000000; -- update this value as PMCs approach
local handler = cfg.id_handlers['PMC'];
local err_cat =  ''; -- presume that PMC is valid
local text;


local function check_isbn( isbn_str )
if id:match("[^%d]") then -- if PMC has anything but digits
if nil ~= isbn_str:match("[^%s-0-9X]") then return false; end -- fail if isbn_str contains anything but digits, hyphens, or the uppercase X
err_cat = ' ' .. seterror( 'bad_pmc' ); -- set an error message
isbn_str = isbn_str:gsub( "-", "" ):gsub( " ", "" ); -- remove hyphens and spaces
else -- PMC is only digits
local len = isbn_str:len();
local id_num = tonumber(id); -- convert id to a number for range testing
if 1 > id_num or test_limit < id_num then -- if PMC is outside test limit boundaries
if len ~= 10 and len ~= 13 then
err_cat = ' ' .. seterror( 'bad_pmc' ); -- set an error message
return false;
end
end
end
 
if len == 10 then
if is_embargoed(embargo) then
if isbn_str:match( "^%d*X?$" ) == nil then return false; end
text="[[" .. handler.link .. "|" .. handler.label .. "]]:" .. handler.separator .. id .. err_cat; --still embargoed so no external link
return is_valid_isxn(isbn_str, 10);
else
else
local temp = 0;
text = externallinkid({link = handler.link, label = handler.label, --no embargo date, ok to link to article
if isbn_str:match( "^97[89]%d*$" ) == nil then return false; end -- isbn13 begins with 978 or 979
prefix=handler.prefix,id=id,separator=handler.separator, encode=handler.encode}) .. err_cat;
isbn_str = { isbn_str:byte(1, len) };
for i, v in ipairs( isbn_str ) do
temp = temp + (3 - 2*(i % 2)) * tonumber( string.char(v) );
end
return temp % 10 == 0;
end
end
return text;
end
end


--[[--------------------------< I S S N >----------------------------------------------------------------------
-- Formats a DOI and checks for DOI errors.


Validate and format an issnThis code fixes the case where an editor has included an ISSN in the citation but has separated the two groups of four
-- DOI names contain two parts: prefix and suffix separated by a forward slash.
digits with a space. When that condition occurred, the resulting link looked like this:
-- Prefix: directory indicator '10.' followed by a registrant code
-- Suffix: character string of any length chosen by the registrant


|issn=0819 4327 gives: [http://www.worldcat.org/issn/0819 4327 0819 4327]  -- can't have spaces in an external link
-- This function checks a DOI name for: prefix/suffixIf the doi name contains spaces or endashes,
-- or, if it ends with a period or a comma, this function will emit a bad_doi error message.
This code now prevents that by inserting a hyphen at the issn midpointIt also validates the issn for length and makes sure that the checkdigit agrees
with the calculated value.  Incorrect length (8 digits), characters other than 0-9 and X, or checkdigit / calculated value mismatch will all cause a check issn
error message.  The issn is always displayed with a hyphen, even if the issn was given as a single group of 8 digits.


]]
-- DOI names are case-insensitive and can incorporate any printable Unicode characters so the test for spaces, endash,
-- and terminal punctuation may not be technically correct but it appears, that in practice these characters are rarely if ever used in doi names.


local function issn(id)
function doi(id, inactive)
local issn_copy = id; -- save a copy of unadulterated issn; use this version for display if issn does not validate
local cat = ""
local handler = cfg.id_handlers['ISSN'];
local handler = cfg.id_handlers['DOI'];
local text;
local text;
local valid_issn = true;
if is_set(inactive) then
local inactive_year = inactive:match("%d%d%d%d") or ''; -- try to get the year portion from the inactive date
text = "[[" .. handler.link .. "|" .. handler.label .. "]]:" .. id;
if is_set(inactive_year) then
table.insert( z.error_categories, "פרמטר DOI לא בתוקף משנת " .. inactive_year );
else
table.insert( z.error_categories, "תבנית ציטוט עם בעיות בתוקף ה-DOI" ); -- when inactive doesn't contain a recognizable year
end
inactive = " (" .. cfg.messages['inactive'] .. " " .. inactive .. ")"
else
text = externallinkid({link = handler.link, label = handler.label,
prefix=handler.prefix,id=id,separator=handler.separator, encode=handler.encode})
inactive = ""
end


id=id:gsub( "[%s-]", "" ); -- strip spaces, hyphens, and endashes from the issn
if nil == id:match("^10%.[^%s–]-/[^%s–]-[^%.,]$") then -- doi must begin with '10.', must contain a fwd slash, must not contain spaces or endashes, and must not end with period or comma
 
cat = ' ' .. seterror( 'bad_doi' );
if 8 ~= id:len() or nil == id:match( "^%d*X?$" ) then -- validate the issn: 8 digits long, containing only 0-9 or X in the last position
valid_issn=false; -- wrong length or improper character
else
valid_issn=is_valid_isxn(id, 8); -- validate issn
end
end
return text .. inactive .. cat
end


if true == valid_issn then
-- Formats an OpenLibrary link, and checks for associated errors.
id = string.sub( id, 1, 4 ) .. "-" .. string.sub( id, 5 ); -- if valid, display correctly formatted version
function openlibrary(id)
else
local code = id:match("^%d+([AMW])$"); -- only digits followed by 'A', 'M', or 'W'
id = issn_copy; -- if not valid, use the show the invalid issn with error message
local handler = cfg.id_handlers['OL'];
 
if ( code == "A" ) then
return externallinkid({link=handler.link, label=handler.label,
prefix="http://openlibrary.org/authors/OL",id=id, separator=handler.separator,
encode = handler.encode})
elseif ( code == "M" ) then
return externallinkid({link=handler.link, label=handler.label,
prefix="http://openlibrary.org/books/OL",id=id, separator=handler.separator,
encode = handler.encode})
elseif ( code == "W" ) then
return externallinkid({link=handler.link, label=handler.label,
prefix= "http://openlibrary.org/works/OL",id=id, separator=handler.separator,
encode = handler.encode})
else
return externallinkid({link=handler.link, label=handler.label,
prefix= "http://openlibrary.org/OL",id=id, separator=handler.separator,
encode = handler.encode}) ..
' ' .. seterror( 'bad_ol' );
end
end
text = external_link_id({link = handler.link, label = handler.label,
prefix=handler.prefix,id=id,separator=handler.separator, encode=handler.encode})
if false == valid_issn then
text = text .. ' ' .. set_error( 'bad_issn' ) -- add an error message if the issn is invalid
end
return text
end
end


--[[--------------------------< A M A Z O N >------------------------------------------------------------------
--[[
 
Validate and format an issnThis code fixes the case where an editor has included an ISSN in the citation but has separated the two groups of four
Formats a link to AmazonDo simple error checking: asin must be mix of 10 numeric or uppercase alpha
digits with a spaceWhen that condition occurred, the resulting link looked like this:
charactersIf a mix, first character must be uppercase alpha; if all numeric, asins must be 10-digit
isbn. If 10-digit isbn, add a maintenance category so a bot or awb script can replace |asin= with |isbn=.
Error message if not 10 characters, if not isbn10, if mixed and first character is a digit.


|issn=0819 4327 gives: [http://www.worldcat.org/issn/0819 4327 0819 4327]  -- can't have spaces in an external link
This code now prevents that by inserting a hyphen at the issn midpoint.  It also validates the issn for length and makes sure that the checkdigit agrees
with the calculated value.  Incorrect length (8 digits), characters other than 0-9 and X, or checkdigit / calculated value mismatch will all cause a check issn
error message.  The issn is always displayed with a hyphen, even if the issn was given as a single group of 8 digits.
]]
]]
function issn(id)
local issn_copy = id; -- save a copy of unadulterated issn; use this version for display if issn does not validate
local handler = cfg.id_handlers['ISSN'];
local text;
local valid_issn = true;


local function amazon(id, domain)
id=id:gsub( "[%s-–]", "" ); -- strip spaces, hyphens, and endashes from the issn
local err_cat = ""


if not id:match("^[%d%u][%d%u][%d%u][%d%u][%d%u][%d%u][%d%u][%d%u][%d%u][%d%u]$") then
if 8 ~= id:len() or nil == id:match( "^%d*X?$" ) then -- validate the issn: 8 digits long, containing only 0-9 or X in the last position
err_cat = ' ' .. set_error ('bad_asin'); -- asin is not a mix of 10 uppercase alpha and numeric characters
valid_issn=false; -- wrong length or improper character
else
else
if id:match("^%d%d%d%d%d%d%d%d%d[%dX]$") then -- if 10-digit numeric (or 9 digits with terminal X)
valid_issn=is_valid_isxn(id, 8); -- validate issn
if check_isbn( id ) then -- see if asin value is isbn10
table.insert( z.maintenance_cats, 'CS1 maint: ASIN uses ISBN'); -- add to maint category
elseif not is_set (err_cat) then
err_cat =  ' ' .. set_error ('bad_asin'); -- asin is not isbn10
end
elseif not id:match("^%u[%d%u]+$") then
err_cat =  ' ' .. set_error ('bad_asin'); -- asin doesn't begin with uppercase alpha
end
end
end
if not is_set(domain) then  
 
domain = "com";
if true == valid_issn then
elseif in_array (domain, {'jp', 'uk'}) then -- Japan, United Kingdom
id = string.sub( id, 1, 4 ) .. "-" .. string.sub( id, 5 ); -- if valid, display correctly formatted version
domain = "co." .. domain;
else
elseif in_array (domain, {'au', 'br', 'mx'}) then -- Australia, Brazil, Mexico
id = issn_copy; -- if not valid, use the show the invalid issn with error message
domain = "com." .. domain;
end
end
local handler = cfg.id_handlers['ASIN'];
return external_link_id({link = handler.link,
text = externallinkid({link = handler.link, label = handler.label,
label=handler.label , prefix="//www.amazon."..domain.."/dp/",id=id,
prefix=handler.prefix,id=id,separator=handler.separator, encode=handler.encode})
encode=handler.encode, separator = handler.separator}) .. err_cat;
end
if false == valid_issn then
text = text .. ' ' .. seterror( 'bad_issn' ) -- add an error message if the issn is invalid
end
return text
end


--[[--------------------------< A R X I V >--------------------------------------------------------------------
--[[--------------------------< M E S S A G E _ I D >----------------------------------------------------------


See: http://arxiv.org/help/arxiv_identifier
Validate and format a usenet message id.  Simple error checking, looks for 'id-left@id-right' not enclosed in
'<' and/or '>' angle brackets.


format and error check arXiv identifier.  There are three valid forms of the identifier:
]]
the first form, valid only between date codes 9108 and 0703 is:
arXiv:<archive>.<class>/<date code><number><version>
where:
<archive> is a string of alpha characters - may be hyphenated; no other punctuation
<class> is a string of alpha characters - may be hyphenated; no other punctuation
<date code> is four digits in the form YYMM where YY is the last two digits of the four-digit year and MM is the month number January = 01
first digit of YY for this form can only 9 and 0
<number> is a three-digit number
<version> is a 1 or more digit number preceded with a lowercase v; no spaces (undocumented)
the second form, valid from April 2007 through December 2014 is:
arXiv:<date code>.<number><version>
where:
<date code> is four digits in the form YYMM where YY is the last two digits of the four-digit year and MM is the month number January = 01
<number> is a four-digit number
<version> is a 1 or more digit number preceded with a lowercase v; no spaces


the third form, valid from January 2015 is:
function message_id (id)
arXiv:<date code>.<number><version>
local handler = cfg.id_handlers['USENETID'];
where:
<date code> and <version> are as defined for 0704-1412
<number> is a five-digit number
]]


local function arxiv (id)
text = externallinkid({link = handler.link, label = handler.label,
local handler = cfg.id_handlers['ARXIV'];
prefix=handler.prefix,id=id,separator=handler.separator, encode=handler.encode})
local year, month, version;
local err_cat = ""
if not id:match('^.+@.+$') or not id:match('^[^<].*[^>]$')then -- doesn't have '@' or has one or first or last character is '< or '>'
text = text .. ' ' .. seterror( 'bad_message_id' ) -- add an error message if the message id is invalid
end
if id:match("^%a[%a%.%-]+/[90]%d[01]%d%d%d%d$") or id:match("^%a[%a%.%-]+/[90]%d[01]%d%d%d%dv%d+$") then -- test for the 9108-0703 format w/ & w/o version
return text
year, month = id:match("^%a[%a%.%-]+/([90]%d)([01]%d)%d%d%d[v%d]*$");
end
year = tonumber(year);
month = tonumber(month);
if ((not (90 < year or 8 > year)) or (1 > month or 12 < month)) or -- if invalid year or invalid month
((91 == year and 7 > month) or (7 == year and 3 < month)) then -- if years ok, are starting and ending months ok?
err_cat = ' ' .. set_error( 'bad_arxiv' ); -- set error message
end
elseif id:match("^%d%d[01]%d%.%d%d%d%d$") or id:match("^%d%d[01]%d%.%d%d%d%dv%d+$") then -- test for the 0704-1412 w/ & w/o version
year, month = id:match("^(%d%d)([01]%d)%.%d%d%d%d[v%d]*$");
year = tonumber(year);
month = tonumber(month);
if ((7 > year) or (14 < year) or (1 > month or 12 < month)) or -- is year invalid or is month invalid? (doesn't test for future years)
((7 == year) and (4 > month)) then --or -- when year is 07, is month invalid (before April)?
err_cat = ' ' .. set_error( 'bad_arxiv' ); -- set error message
end
elseif id:match("^%d%d[01]%d%.%d%d%d%d%d$") or id:match("^%d%d[01]%d%.%d%d%d%d%dv%d+$") then -- test for the 1501- format w/ & w/o version
year, month = id:match("^(%d%d)([01]%d)%.%d%d%d%d%d[v%d]*$");
year = tonumber(year);
month = tonumber(month);
if ((15 > year) or (1 > month or 12 < month)) then -- is year invalid or is month invalid? (doesn't test for future years)
err_cat = ' ' .. set_error( 'bad_arxiv' ); -- set error message
end
else
err_cat = ' ' .. set_error( 'bad_arxiv' ); -- arXiv id doesn't match any format
end


return external_link_id({link = handler.link, label = handler.label,
prefix=handler.prefix,id=id,separator=handler.separator, encode=handler.encode}) .. err_cat;
end




--[[
--[[
lccn normalization (http://www.loc.gov/marc/lccn-namespace.html#normalization)
This function sets default title types (equivalent to the citation including |type=<default value>) for those citations that have defaults.
1. Remove all blanks.
Also handles the special case where it is desirable to omit the title type from the rendered citation (|type=none).
2. If there is a forward slash (/) in the string, remove it, and remove all characters to the right of the forward slash.
]]
3. If there is a hyphen in the string:
function set_titletype(cite_class, title_type)
a. Remove it.
if is_set(title_type) then
b. Inspect the substring following (to the right of) the (removed) hyphen. Then (and assuming that steps 1 and 2 have been carried out):
if "none" == title_type then
1. All these characters should be digits, and there should be six or less. (not done in this function)
title_type = ""; -- if |type=none then type parameter not displayed
2. If the length of the substring is less than 6, left-fill the substring with zeroes until the length is six.
end
return title_type; -- if |type= has been set to any other value use that value
end


Returns a normalized lccn for lccn() to validate.  There is no error checking (step 3.b.1) performed in this function.
if "AV-media-notes" == cite_class or "DVD-notes" == cite_class then -- if this citation is cite AV media notes or cite DVD notes
]]
return "Media notes"; -- display AV media notes / DVD media notes annotation


local function normalize_lccn (lccn)
elseif "podcast" == cite_class then -- if this citation is cite podcast
lccn = lccn:gsub ("%s", ""); -- 1. strip whitespace
return "Podcast"; -- display podcast annotation


if nil ~= string.find (lccn,'/') then
elseif "pressrelease" == cite_class then -- if this citation is cite press release
lccn = lccn:match ("(.-)/"); -- 2. remove forward slash and all character to the right of it
return "Press release"; -- display press release annotation
end


local prefix
elseif "techreport" == cite_class then -- if this citation is cite techreport
local suffix
return "Technical report"; -- display techreport annotation
prefix, suffix = lccn:match ("(.+)%-(.+)"); -- 3.a remove hyphen by splitting the string into prefix and suffix
 
if nil ~= suffix then -- if there was a hyphen
suffix=string.rep("0", 6-string.len (suffix)) .. suffix; -- 3.b.2 left fill the suffix with 0s if suffix length less than 6
lccn=prefix..suffix; -- reassemble the lccn
end
return lccn;
elseif "thesis" == cite_class then -- if this citation is cite thesis (degree option handled after this function returns)
return "Thesis"; -- display simple thesis annotation (without |degree= modification)
end
end
end


--[[
--[[
Format LCCN link and do simple error checking.  LCCN is a character string 8-12 characters long. The length of the LCCN dictates the character type of the first 1-3 characters; the
Determines whether a URL string is valid
rightmost eight are always digits. http://info-uri.info/registry/OAIHandler?verb=GetRecord&metadataPrefix=reg&identifier=info:lccn/
 
At present the only check is whether the string appears to
be prefixed with a URI scheme.  It is not determined whether
the URI scheme is valid or whether the URL is otherwise well
formed.
]]
function checkurl( url_str )
-- Protocol-relative or URL scheme
return url_str:sub(1,2) == "//" or url_str:match( "^[^/]*:" ) ~= nil;
end
 
-- Removes irrelevant text and dashes from ISBN number
-- Similar to that used for Special:BookSources
function cleanisbn( isbn_str )
return isbn_str:gsub( "[^-0-9X]", "" );
end


length = 8 then all digits
--[[--------------------------< E S C A P E _ L U A _ M A G I C _ C H A R S >----------------------------------
length = 9 then lccn[1] is lower case alpha
length = 10 then lccn[1] and lccn[2] are both lower case alpha or both digits
length = 11 then lccn[1] is lower case alpha, lccn[2] and lccn[3] are both lower case alpha or both digits
length = 12 then lccn[1] and lccn[2] are both lower case alpha


Returns a string where all of lua's magic characters have been escaped.  This is important because functions like
string.gsub() treat their pattern and replace strings as patterns, not literal strings.
]]
]]
local function lccn(lccn)
function escape_lua_magic_chars (argument)
local handler = cfg.id_handlers['LCCN'];
argument = argument:gsub("%%", "%%%%"); -- replace % with %%
local err_cat = ''; -- presume that LCCN is valid
argument = argument:gsub("([%^%$%(%)%.%[%]%*%+%-%?])", "%%%1"); -- replace all other lua magic pattern characters
local id = lccn; -- local copy of the lccn
return argument;
end


id = normalize_lccn (id); -- get canonical form (no whitespace, hyphens, forward slashes)
--[[--------------------------< S T R I P _ A P O S T R O P H E _ M A R K U P >--------------------------------
local len = id:len(); -- get the length of the lccn


if 8 == len then
Strip wiki italic and bold markup from argument so that it doesn't contaminate COinS metadata.
if id:match("[^%d]") then -- if LCCN has anything but digits (nil if only digits)
This function strips common patterns of apostrophe markup. We presume that editors who have taken the time to
err_cat = ' ' .. set_error( 'bad_lccn' ); -- set an error message
markup a title have, as a result, provided valid markup. When they don't, some single apostrophes are left behind.
end
elseif 9 == len then -- LCCN should be adddddddd
if nil == id:match("%l%d%d%d%d%d%d%d%d") then -- does it match our pattern?
err_cat = ' ' .. set_error( 'bad_lccn' ); -- set an error message
end
elseif 10 == len then -- LCCN should be aadddddddd or dddddddddd
if id:match("[^%d]") then -- if LCCN has anything but digits (nil if only digits) ...
if nil == id:match("^%l%l%d%d%d%d%d%d%d%d") then -- ... see if it matches our pattern
err_cat = ' ' .. set_error( 'bad_lccn' ); -- no match, set an error message
end
end
elseif 11 == len then -- LCCN should be aaadddddddd or adddddddddd
if not (id:match("^%l%l%l%d%d%d%d%d%d%d%d") or id:match("^%l%d%d%d%d%d%d%d%d%d%d")) then -- see if it matches one of our patterns
err_cat = ' ' .. set_error( 'bad_lccn' ); -- no match, set an error message
end
elseif 12 == len then -- LCCN should be aadddddddddd
if not id:match("^%l%l%d%d%d%d%d%d%d%d%d%d") then -- see if it matches our pattern
err_cat = ' ' .. set_error( 'bad_lccn' ); -- no match, set an error message
end
else
err_cat = ' ' .. set_error( 'bad_lccn' ); -- wrong length, set an error message
end


if not is_set (err_cat) and nil ~= lccn:find ('%s') then
]]
err_cat = ' ' .. set_error( 'bad_lccn' ); -- lccn contains a space, set an error message
function strip_apostrophe_markup (argument)
end
if not is_set (argument) then return argument; end


return external_link_id({link = handler.link, label = handler.label,
while true do
prefix=handler.prefix,id=lccn,separator=handler.separator, encode=handler.encode}) .. err_cat;
if argument:match ("%'%'%'%'%'") then -- bold italic (5)
end
argument=argument:gsub("%'%'%'%'%'", ""); -- remove all instances of it
 
elseif argument:match ("%'%'%'%'") then -- italic start and end without content (4)
--[[
argument=argument:gsub("%'%'%'%'", "");
Format PMID and do simple error checking.  PMIDs are sequential numbers beginning at 1 and counting up.  This code checks the PMID to see that it
elseif argument:match ("%'%'%'") then -- bold (3)
contains only digits and is less than test_limit; the value in local variable test_limit will need to be updated periodically as more PMIDs are issued.
argument=argument:gsub("%'%'%'", "");
]]
elseif argument:match ("%'%'") then -- italic (2)
local function pmid(id)
argument=argument:gsub("%'%'", "");
local test_limit = 30000000; -- update this value as PMIDs approach
else
local handler = cfg.id_handlers['PMID'];
break;
local err_cat =  ''; -- presume that PMID is valid
if id:match("[^%d]") then -- if PMID has anything but digits
err_cat = ' ' .. set_error( 'bad_pmid' ); -- set an error message
else -- PMID is only digits
local id_num = tonumber(id); -- convert id to a number for range testing
if 1 > id_num or test_limit < id_num then -- if PMID is outside test limit boundaries
err_cat = ' ' .. set_error( 'bad_pmid' ); -- set an error message
end
end
end
end
return argument; -- done
return external_link_id({link = handler.link, label = handler.label,
prefix=handler.prefix,id=id,separator=handler.separator, encode=handler.encode}) .. err_cat;
end
end


--[[
--[[--------------------------< M A K E _ C O I N S _ T I T L E >----------------------------------------------
Determines if a PMC identifier's online version is embargoed. Compares the date in |embargo= against today's date. If embargo date is
 
in the future, returns true; otherwise, returns false because the embargo has expired or |embargo= not set in this cite.
Makes a title for COinS from Title and / or ScriptTitle (or any other name-script pairs)
 
Apostrophe markup (bold, italics) is stripped from each value so that the COinS metadata isn't correupted with strings
of %27%27...
]]
]]
local function is_embargoed(embargo)
 
if is_set(embargo) then
function make_coins_title (title, script)
local lang = mw.getContentLanguage();
if is_set (title) then
local good1, embargo_date, good2, todays_date;
title = strip_apostrophe_markup (title); -- strip any apostrophe markup
good1, embargo_date = pcall( lang.formatDate, lang, 'U', embargo );
else
good2, todays_date = pcall( lang.formatDate, lang, 'U' );
title=''; -- if not set, make sure title is an empty string
end
if good1 and good2 and tonumber( embargo_date ) >= tonumber( todays_date ) then --is embargo date is in the future?
if is_set (script) then
return true; -- still embargoed
script = script:gsub ('^%l%l%s*:%s*', ''); -- remove language prefix if present (script value may now be empty string)
end
script = strip_apostrophe_markup (script); -- strip any apostrophe markup
else
script=''; -- if not set, make sure script is an empty string
end
if is_set (title) and is_set (script) then
script = ' ' .. script; -- add a space before we concatenate
end
end
return false; -- embargo expired or |embargo= not set
return title .. script; -- return the concatenation
end
end


--[[
--[[--------------------------< G E T _ C O I N S _ P A G E S >------------------------------------------------
Format a PMC, do simple error checking, and check for embargoed articles.


The embargo parameter takes a date for a value. If the embargo date is in the future
Extract page numbers from external wikilinks in any of the |page=, |pages=, or |at= parameters for use in COinS.
the PMC identifier will not be linked to the article.  If the embargo specifies a date in the past, or if it is empty or omitted, then
the PMC identifier is linked to the article through the link at cfg.id_handlers['PMC'].prefix.


PMCs are sequential numbers beginning at 1 and counting up.  This code checks the PMC to see that it contains only digits and is less
than test_limit; the value in local variable test_limit will need to be updated periodically as more PMCs are issued.
]]
]]
local function pmc(id, embargo)
function get_coins_pages (pages)
local test_limit = 5000000; -- update this value as PMCs approach
local pattern;
local handler = cfg.id_handlers['PMC'];
if not is_set (pages) then return pages; end -- if no page numbers then we're done
local err_cat =  ''; -- presume that PMC is valid
local text;
while true do
 
pattern = pages:match("%[(%w*:?//[^ ]+%s+)[%w%d].*%]"); -- pattern is the opening bracket, the url and following space(s): "[url "
if id:match("[^%d]") then -- if PMC has anything but digits
if nil == pattern then break; end -- no more urls
err_cat = ' ' .. set_error( 'bad_pmc' ); -- set an error message
pattern = escape_lua_magic_chars (pattern); -- pattern is not a literal string; escape lua's magic pattern characters
else -- PMC is only digits
pages = pages:gsub(pattern, ""); -- remove as many instances of pattern as possible
local id_num = tonumber(id); -- convert id to a number for range testing
if 1 > id_num or test_limit < id_num then -- if PMC is outside test limit boundaries
err_cat = ' ' .. set_error( 'bad_pmc' ); -- set an error message
end
end
end
pages = pages:gsub("[%[%]]", ""); -- remove the brackets
if is_embargoed(embargo) then
pages = pages:gsub("–", "-" ); -- replace endashes with hyphens
text="[[" .. handler.link .. "|" .. handler.label .. "]]:" .. handler.separator .. id .. err_cat; --still embargoed so no external link
pages = pages:gsub("&%w+;", "-" ); -- and replace html entities (&ndash; etc.) with hyphens; do we need to replace numerical entities like &#32; and the like?
else
return pages;
text = external_link_id({link = handler.link, label = handler.label, --no embargo date, ok to link to article
prefix=handler.prefix,id=id,separator=handler.separator, encode=handler.encode}) .. err_cat;
end
return text;
end
end


-- Formats a DOI and checks for DOI errors.
--[[
 
ISBN-10 and ISSN validator code calculates checksum across all isbn/issn digits including the check digit. ISBN-13 is checked in checkisbn().
-- DOI names contain two parts: prefix and suffix separated by a forward slash.
If the number is valid the result will be 0. Before calling this function, issbn/issn must be checked for length and stripped of dashes,
--  Prefix: directory indicator '10.' followed by a registrant code
spaces and other non-isxn characters.
--  Suffix: character string of any length chosen by the registrant
]]
 
function is_valid_isxn (isxn_str, len)
-- This function checks a DOI name for: prefix/suffix. If the doi name contains spaces or endashes,
local temp = 0;
-- or, if it ends with a period or a comma, this function will emit a bad_doi error message.
isxn_str = { isxn_str:byte(1, len) }; -- make a table of bytes
 
len = len+1; -- adjust to be a loop counter
-- DOI names are case-insensitive and can incorporate any printable Unicode characters so the test for spaces, endash,
for i, v in ipairs( isxn_str ) do -- loop through all of the bytes and calculate the checksum
-- and terminal punctuation may not be technically correct but it appears, that in practice these characters are rarely if ever used in doi names.
if v == string.byte( "X" ) then -- if checkdigit is X
 
temp = temp + 10*( len - i ); -- it represents 10 decimal
local function doi(id, inactive)
local cat = ""
local handler = cfg.id_handlers['DOI'];
local text;
if is_set(inactive) then
local inactive_year = inactive:match("%d%d%d%d") or ''; -- try to get the year portion from the inactive date
text = "[[" .. handler.link .. "|" .. handler.label .. "]]:" .. id;
if is_set(inactive_year) then
table.insert( z.error_categories, "Pages with DOIs inactive since " .. inactive_year );
else
else
table.insert( z.error_categories, "Pages with inactive DOIs" ); -- when inactive doesn't contain a recognizable year
temp = temp + tonumber( string.char(v) )*(len-i);
end
end
inactive = " (" .. cfg.messages['inactive'] .. " " .. inactive .. ")"
else
text = external_link_id({link = handler.link, label = handler.label,
prefix=handler.prefix,id=id,separator=handler.separator, encode=handler.encode})
inactive = ""
end
end
return temp % 11 == 0; -- returns true if calculation result is zero
end


if nil == id:match("^10%.[^%s–]-/[^%s–]-[^%.,]$") then -- doi must begin with '10.', must contain a fwd slash, must not contain spaces or endashes, and must not end with period or comma
-- Determines whether an ISBN string is valid
cat = ' ' .. set_error( 'bad_doi' );
function checkisbn( isbn_str )
if nil ~= isbn_str:match("[^%s-0-9X]") then return false; end -- fail if isbn_str contains anything but digits, hyphens, or the uppercase X
isbn_str = isbn_str:gsub( "-", "" ):gsub( " ", "" ); -- remove hyphens and spaces
local len = isbn_str:len();
if len ~= 10 and len ~= 13 then
return false;
end
end
return text .. inactive .. cat
end


-- Formats an OpenLibrary link, and checks for associated errors.
if len == 10 then
local function openlibrary(id)
if isbn_str:match( "^%d*X?$" ) == nil then return false; end
local code = id:match("^%d+([AMW])$"); -- only digits followed by 'A', 'M', or 'W'
return is_valid_isxn(isbn_str, 10);
local handler = cfg.id_handlers['OL'];
 
if ( code == "A" ) then
return external_link_id({link=handler.link, label=handler.label,
prefix="http://openlibrary.org/authors/OL",id=id, separator=handler.separator,
encode = handler.encode})
elseif ( code == "M" ) then
return external_link_id({link=handler.link, label=handler.label,
prefix="http://openlibrary.org/books/OL",id=id, separator=handler.separator,
encode = handler.encode})
elseif ( code == "W" ) then
return external_link_id({link=handler.link, label=handler.label,
prefix= "http://openlibrary.org/works/OL",id=id, separator=handler.separator,
encode = handler.encode})
else
else
return external_link_id({link=handler.link, label=handler.label,
local temp = 0;
prefix= "http://openlibrary.org/OL",id=id, separator=handler.separator,
if isbn_str:match( "^97[89]%d*$" ) == nil then return false; end -- isbn13 begins with 978 or 979
encode = handler.encode}) ..
isbn_str = { isbn_str:byte(1, len) };
' ' .. set_error( 'bad_ol' );
for i, v in ipairs( isbn_str ) do
temp = temp + (3 - 2*(i % 2)) * tonumber( string.char(v) );
end
return temp % 10 == 0;
end
end
end
end


-- Gets the display text for a wikilink like [[A|B]] or [[B]] gives B
function removewikilink( str )
return (str:gsub( "%[%[([^%[%]]*)%]%]", function(l)
return l:gsub( "^[^|]*|(.*)$", "%1" ):gsub("^%s*(.-)%s*$", "%1");
end));
end


--[[--------------------------< M E S S A G E _ I D >----------------------------------------------------------
-- Escape sequences for content that will be used for URL descriptions
 
function safeforurl( str )
Validate and format a usenet message id.  Simple error checking, looks for 'id-left@id-right' not enclosed in
if str:match( "%[%[.-%]%]" ) ~= nil then  
'<' and/or '>' angle brackets.
table.insert( z.message_tail, { seterror( 'wikilink_in_url', {}, true ) } );
 
end
]]
 
local function message_id (id)
local handler = cfg.id_handlers['USENETID'];
 
text = external_link_id({link = handler.link, label = handler.label,
prefix=handler.prefix,id=id,separator=handler.separator, encode=handler.encode})
if not id:match('^.+@.+$') or not id:match('^[^<].*[^>]$')then -- doesn't have '@' or has one or first or last character is '< or '>'
text = text .. ' ' .. set_error( 'bad_message_id' ) -- add an error message if the message id is invalid
end  
return text
return str:gsub( '[%[%]\n]', {
['['] = '&#91;',
[']'] = '&#93;',
['\n'] = ' ' } );
end
end


-- Converts a hyphen to a dash
function hyphentodash( str )
if not is_set(str) or str:match( "[%[%]{}<>]" ) ~= nil then
return str;
end
return str:gsub( '-', '–' );
end


-- Protects a string that will be wrapped in wiki italic markup '' ... ''
function safeforitalics( str )
--[[ Note: We cannot use <i> for italics, as the expected behavior for
italics specified by ''...'' in the title is that they will be inverted
(i.e. unitalicized) in the resulting references.  In addition, <i> and ''
tend to interact poorly under Mediawiki's HTML tidy. ]]
if not is_set(str) then
return str;
else
if str:sub(1,1) == "'" then str = "<span></span>" .. str; end
if str:sub(-1,-1) == "'" then str = str .. "<span></span>"; end
-- Remove newlines as they break italics.
return str:gsub( '\n', ' ' );
end
end


--[[--------------------------< S E T _ T I T L E T Y P E >----------------------------------------------------
--[[
 
Joins a sequence of strings together while checking for duplicate separation characters.
This function sets default title types (equivalent to the citation including |type=<default value>) for those citations that have defaults.
Also handles the special case where it is desirable to omit the title type from the rendered citation (|type=none).


TODO: safejoin() has a flaw where it won't remove the duplicate character from a |title= / |url= combination.
This is because by the time we get here, |title=http://somesite.com and |title=Document Title. have been combined:
[http://somesite.com and ''Document Title.'']
so that now, the last character is not sepc but is ] (unless sepc == ']' which breaks the external link)
]]
]]
local function set_titletype(cite_class, title_type)
function safejoin( tbl, duplicate_char )
if is_set(title_type) then
--[[
if "none" == title_type then
Note: we use string functions here, rather than ustring functions.
title_type = ""; -- if |type=none then type parameter not displayed
end
This has considerably faster performance and should work correctly as
return title_type; -- if |type= has been set to any other value use that value
long as the duplicate_char is strict ASCII.  The strings
end
in tbl may be ASCII or UTF8.
 
]]
if "AV-media-notes" == cite_class or "DVD-notes" == cite_class then -- if this citation is cite AV media notes or cite DVD notes
return "Media notes"; -- display AV media notes / DVD media notes annotation
local str = '';
 
local comp = '';
elseif "mailinglist" == cite_class then -- if this citation is cite mailing list
local end_chr = '';
return "Mailing list"; -- display mailing list annotation
local trim;
for _, value in ipairs( tbl ) do
if value == nil then value = ''; end
if str == '' then
str = value;
elseif value ~= '' then
if value:sub(1,1) == '<' then
-- Special case of values enclosed in spans and other markup.
comp = value:gsub( "%b<>", "" );
else
comp = value;
end
if comp:sub(1,1) == duplicate_char then
trim = false;
end_chr = str:sub(-1,-1);
-- str = str .. "<HERE(enchr=" .. end_chr.. ")"
if end_chr == duplicate_char then
str = str:sub(1,-2);
elseif end_chr == "'" then
if str:sub(-3,-1) == duplicate_char .. "''" then
str = str:sub(1, -4) .. "''";
elseif str:sub(-5,-1) == duplicate_char .. "]]''" then
trim = true;
elseif str:sub(-4,-1) == duplicate_char .. "]''" then
trim = true;
end
elseif end_chr == "]" then
if str:sub(-3,-1) == duplicate_char .. "]]" then
trim = true;
elseif str:sub(-2,-1) == duplicate_char .. "]" then
trim = true;
end
elseif end_chr == " " then
if str:sub(-2,-1) == duplicate_char .. " " then
str = str:sub(1,-3);
end
end


elseif "map" == cite_class then -- if this citation is cite map
if trim then
return "Map"; -- display map annotation
if value ~= comp then
local dup2 = duplicate_char;
if dup2:match( "%A" ) then dup2 = "%" .. dup2; end
value = value:gsub( "(%b<>)" .. dup2, "%1", 1 )
else
value = value:sub( 2, -1 );
end
end
end
str = str .. value;
end
end
return str;
end 


elseif "podcast" == cite_class then -- if this citation is cite podcast
-- Attempts to convert names to initials.
return "Podcast"; -- display podcast annotation
function reducetoinitials(first)
local initials = {}
local i = 0; -- counter for number of initials
for word in string.gmatch(first, "%S+") do
table.insert(initials, string.sub(word,1,1)) -- Vancouver format does not include full stops.
i = i + 1; -- bump the counter
if 2 <= i then break; end -- only two initials allowed in Vancouver system; if 2, quit
end
return table.concat(initials) -- Vancouver format does not include spaces.
end


elseif "pressrelease" == cite_class then -- if this citation is cite press release
-- Formats a list of people (e.g. authors / editors)
return "Press release"; -- display press release annotation
function listpeople(control, people)
 
local sep = control.sep;
elseif "report" == cite_class then -- if this citation is cite report
local namesep = control.namesep
return "Report"; -- display report annotation
local format = control.format
local maximum = control.maximum
local lastauthoramp = control.lastauthoramp;
local text = {}
local etal = false;
elseif "techreport" == cite_class then -- if this citation is cite techreport
if sep:sub(-1,-1) ~= " " then sep = sep .. " " end
return "Technical report"; -- display techreport annotation
if maximum ~= nil and maximum < 1 then return "", 0; end
elseif "thesis" == cite_class then -- if this citation is cite thesis (degree option handled after this function returns)
for i,person in ipairs(people) do
return "Thesis"; -- display simple thesis annotation (without |degree= modification)
if is_set(person.last) then
end
local mask = person.mask
end
local one
 
local sep_one = sep;
-- Removes irrelevant text and dashes from ISBN number
if maximum ~= nil and i > maximum then
-- Similar to that used for Special:BookSources
etal = true;
local function clean_isbn( isbn_str )
break;
return isbn_str:gsub( "[^-0-9X]", "" );
elseif (mask ~= nil) then
end
local n = tonumber(mask)
 
if (n ~= nil) then
--[[--------------------------< E S C A P E _ L U A _ M A G I C _ C H A R S >----------------------------------
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 first = reducetoinitials(first) end
one = one .. namesep .. first
end
if is_set(person.link) and person.link ~= control.page_name then
one = "[[" .. person.link .. "|" .. one .. "]]" -- link author/editor if this page is not the author's/editor's page
end


Returns a string where all of lua's magic characters have been escaped.  This is important because functions like
if is_set(person.link) and nil ~= person.link:find("//") then one = one .. " " .. seterror( 'bad_authorlink' ) end -- check for url in author link;
string.gsub() treat their pattern and replace strings as patterns, not literal strings.
end
]]
table.insert( text, one )
local function escape_lua_magic_chars (argument)
table.insert( text, sep_one )
argument = argument:gsub("%%", "%%%%"); -- replace % with %%
end
argument = argument:gsub("([%^%$%(%)%.%[%]%*%+%-%?])", "%%%1"); -- replace all other lua magic pattern characters
end
return argument;
end


--[[--------------------------< S T R I P _ A P O S T R O P H E _ M A R K U P >--------------------------------
local count = #text / 2;
 
if count > 0 then  
Strip wiki italic and bold markup from argument so that it doesn't contaminate COinS metadata.
if count > 1 and is_set(lastauthoramp) and not etal then
This function strips common patterns of apostrophe markup.  We presume that editors who have taken the time to
text[#text-2] = " & ";
markup a title have, as a result, provided valid markup. When they don't, some single apostrophes are left behind.
 
]]
local function strip_apostrophe_markup (argument)
if not is_set (argument) then return argument; end
 
while true do
if argument:match ("%'%'%'%'%'") then -- bold italic (5)
argument=argument:gsub("%'%'%'%'%'", ""); -- remove all instances of it
elseif argument:match ("%'%'%'%'") then -- italic start and end without content (4)
argument=argument:gsub("%'%'%'%'", "");
elseif argument:match ("%'%'%'") then -- bold (3)
argument=argument:gsub("%'%'%'", "");
elseif argument:match ("%'%'") then -- italic (2)
argument=argument:gsub("%'%'", "");
else
break;
end
end
text[#text] = nil;
end
local result = table.concat(text) -- construct list
if etal then
local etal_text = cfg.messages['et al'];
result = result .. " " .. etal_text;
end
end
return argument; -- done
if ( "scap" == format ) then -- apply smallcaps formatting when authorformat or editorformat set to scap
result = substitute (cfg.presentation['smallcaps'], result);
end
return result, count
end
end


--[[--------------------------< M A K E _ C O I N S _ T I T L E >----------------------------------------------
-- Generates a CITEREF anchor ID.
function anchorid( options )
return "CITEREF" .. table.concat( options );
end
 
--[[
Gets name list from the input arguments


Makes a title for COinS from Title and / or ScriptTitle (or any other name-script pairs)
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.


Apostrophe markup (bold, italics) is stripped from each value so that the COinS metadata isn't correupted with strings
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=
of %27%27...
are present but |last2= is missing, an error message is emitted. |lastn= is not required to have a matching |firstn=.
]]
]]
function extractnames(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 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 = selectone( args, cfg.aliases[list_name .. '-Last'], 'redundant_parameters', i ); -- search through args for name components beginning at 1
first = selectone( args, cfg.aliases[list_name .. '-First'], 'redundant_parameters', i );
link = selectone( args, cfg.aliases[list_name .. '-Link'], 'redundant_parameters', i );
mask = selectone( args, cfg.aliases[list_name .. '-Mask'], 'redundant_parameters', i );


local function make_coins_title (title, script)
if first and not last then -- if there is a firstn without a matching lastn
if is_set (title) then
table.insert( z.message_tail, { seterror( 'first_missing_last', {err_msg_list_name, i}, true ) } ); -- add this error message
title = strip_apostrophe_markup (title); -- strip any apostrophe markup
elseif not first and not last then -- if both firstn and lastn aren't found, are we done?
else
count = count + 1; -- number of times we haven't found last and first
title=''; -- if not set, make sure title is an empty string
if 2 == count then -- two missing names and we give up
end
break; -- normal exit or there is a two-name hole in the list; can't tell which
if is_set (script) then
end
script = script:gsub ('^%l%l%s*:%s*', ''); -- remove language prefix if present (script value may now be empty string)
else -- we have last with or without a first
script = strip_apostrophe_markup (script); -- strip any apostrophe markup
names[n] = {last = last, first = first, link = link, mask = mask}; -- add this name to our names list
else
n = n + 1; -- point to next location in the names table
script=''; -- if not set, make sure script is an empty string
if 1 == count then -- if the previous name was missing
table.insert( z.message_tail, { seterror( '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
end
if is_set (title) and is_set (script) then
return names; -- all done, return our list of names
script = ' ' .. script; -- add a space before we concatenate
end
 
-- Populates ID table from arguments using configuration settings
function extractids( args )
local id_list = {};
for k, v in pairs( cfg.id_handlers ) do
v = selectone( args, v.parameters, 'redundant_parameters' );
if is_set(v) then id_list[k] = v; end
end
end
return title .. script; -- return the concatenation
return id_list;
end
end


--[[--------------------------< G E T _ C O I N S _ P A G E S >------------------------------------------------
--[[--------------------------< B U I L D I D L I S T >--------------------------------------------------------
Takes a table of IDs and turns it into a table of formatted ID outputs.


Extract page numbers from external wikilinks in any of the |page=, |pages=, or |at= parameters for use in COinS.
]]
function buildidlist( id_list, options )
local new_list, handler = {};


]]
function fallback(k) return { __index = function(t,i) return cfg.id_handlers[k][i] end } end;
local function get_coins_pages (pages)
local pattern;
if not is_set (pages) then return pages; end -- if no page numbers then we're done
while true do
for k, v in pairs( id_list ) do
pattern = pages:match("%[(%w*:?//[^ ]+%s+)[%w%d].*%]"); -- pattern is the opening bracket, the url and following space(s): "[url "
-- fallback to read-only cfg
if nil == pattern then break; end -- no more urls
handler = setmetatable( { ['id'] = v }, fallback(k) );
pattern = escape_lua_magic_chars (pattern); -- pattern is not a literal string; escape lua's magic pattern characters
pages = pages:gsub(pattern, ""); -- remove as many instances of pattern as possible
if handler.mode == 'external' then
end
table.insert( new_list, {handler.label, externallinkid( handler ) } );
pages = pages:gsub("[%[%]]", ""); -- remove the brackets
elseif handler.mode == 'internal' then
pages = pages:gsub("–", "-" ); -- replace endashes with hyphens
table.insert( new_list, {handler.label, internallinkid( handler ) } );
pages = pages:gsub("&%w+;", "-" ); -- and replace html entities (&ndash; etc.) with hyphens; do we need to replace numerical entities like &#32; and the like?
elseif handler.mode ~= 'manual' then
return pages;
error( cfg.messages['unknown_ID_mode'] );
end
elseif k == 'DOI' then
 
table.insert( new_list, {handler.label, doi( v, options.DoiBroken ) } );
-- Gets the display text for a wikilink like [[A|B]] or [[B]] gives B
elseif k == 'ARXIV' then
local function remove_wiki_link( str )
table.insert( new_list, {handler.label, arxiv( v ) } );  
return (str:gsub( "%[%[([^%[%]]*)%]%]", function(l)
elseif k == 'ASIN' then
return l:gsub( "^[^|]*|(.*)$", "%1" ):gsub("^%s*(.-)%s*$", "%1");
table.insert( new_list, {handler.label, amazon( v, options.ASINTLD ) } );  
end));
elseif k == 'LCCN' then
table.insert( new_list, {handler.label, lccn( v ) } );
elseif k == 'OL' then
table.insert( new_list, {handler.label, openlibrary( v ) } );
elseif k == 'PMC' then
table.insert( new_list, {handler.label, pmc( v, options.Embargo ) } );
elseif k == 'PMID' then
table.insert( new_list, {handler.label, pmid( v ) } );
elseif k == 'ISSN' then
table.insert( new_list, {handler.label, issn( v ) } );
elseif k == 'ISBN' then
local ISBN = internallinkid( handler );
if not checkisbn( v ) and not is_set(options.IgnoreISBN) then
ISBN = ISBN .. seterror( 'bad_isbn', {}, false, " ", "" );
end
table.insert( new_list, {handler.label, ISBN } );
elseif k == 'USENETID' then
table.insert( new_list, {handler.label, message_id( v ) } );
else
error( cfg.messages['unknown_manual_ID'] );
end
end
function comp( a, b ) -- used in following table.sort()
return a[1] < b[1];
end
table.sort( new_list, comp );
for k, v in ipairs( new_list ) do
new_list[k] = v[2];
end
return new_list;
end
end
 
 
-- Converts a hyphen to a dash
-- Chooses one matching parameter from a list of parameters to consider
local function hyphen_to_dash( str )
-- Generates an error if more than one match is present.
if not is_set(str) or str:match( "[%[%]{}<>]" ) ~= nil then
function selectone( args, possible, error_condition, index )
return str;
local value = nil;
end
local selected = '';
return str:gsub( '-', '–' );
local error_list = {};
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 )
--[[
Note: we use string functions here, rather than ustring functions.
This has considerably faster performance and should work correctly as
if index ~= nil then index = tostring(index); end
long as the duplicate_char is strict ASCII.  The strings
in tbl may be ASCII or UTF8.
]]
local str = ''; -- the output string
-- Handle special case of "#" replaced by empty string
local comp = ''; -- what does 'comp' mean?
if index == '1' then
local end_chr = '';
for _, v in ipairs( possible ) do
local trim;
v = v:gsub( "#", "" );
for _, value in ipairs( tbl ) do
if is_set(args[v]) then
if value == nil then value = ''; end
if value ~= nil and selected ~= v then
table.insert( error_list, v );
if str == '' then -- if output string is empty
else
str = value; -- assign value to it (first time through the loop)
value = args[v];
elseif value ~= '' then
selected = v;
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 comp:sub(1,1) == duplicate_char then -- is first charactier same as duplicate_char? why test first character?
--  Because individual string segments often (always?) begin with terminal punct for th
--  preceding segment: 'First element' .. 'sepc next element' .. etc?
trim = false;
end_chr = str:sub(-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 = str:sub(1,-2); -- remove it
elseif end_chr == "'" then -- if it might be wikimarkup
if str:sub(-3,-1) == duplicate_char .. "''" then -- if last three chars of str are sepc''
str = str:sub(1, -4) .. "''"; -- remove them and add back ''
elseif str:sub(-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 str:sub(-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 str:sub(-3,-1) == duplicate_char .. "]]" then -- if last three chars of str are sepc]] wikilink
trim = true;
elseif str:sub(-2,-1) == duplicate_char .. "]" then -- if last two chars of str are sepc] external link
trim = true;
elseif str:sub(-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 str:sub(-2,-1) == duplicate_char .. " " then -- if last two chars of str are <sepc><space>
str = str:sub(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 dup2:match( "%A" ) then dup2 = "%" .. dup2; end -- if duplicate_char not a letter then escape it
value = value:gsub( "(%b<>)" .. dup2, "%1", 1 ) -- remove duplicate_char if it follows html markup
else
value = value:sub( 2, -1 ); -- remove duplicate_char when it is first character
end
end
end
end
end
str = str .. value; --add it to the output string
end
end
end
end
return str;
end 
for _, v in ipairs( possible ) do
 
if index ~= nil then
 
v = v:gsub( "#", index );
--[[--------------------------< I S _ G O O D _ V A N C _ N A M E >--------------------------------------------
end
 
if is_set(args[v]) then
For Vancouver Style, author/editor names are supposed to be rendered in Latin (read ASCII) characters.  When a name
if value ~= nil and selected ~=  v then
uses characters that contain diacritical marks, those characters are to converted to the corresponding Latin character.
table.insert( error_list, v );
When a name is written using a non-Latin alphabet or logogram, that name is to be transliterated into Latin characters.
else
These things are not currently possible in this module so are left to the editor to do.  This module can, however, check
value = args[v];
the content of |lastn= and |firstn= to see if the names contain non-Latin (non-ASCII) characters and emit an error message
selected = v;
when such characters are located.
end
 
end
Allow |lastn= to contain ASCII characters, hyphens, spaces, and apostrophes. (http://www.ncbi.nlm.nih.gov/books/NBK7271/box/A35029/)
end
Allow |firstn= to contain ASCII characters, hyphens, spaces, apostrophes, and periods
]]
if #error_list > 0 then
 
local error_str = "";
local function is_good_vanc_name (last, first)
for _, k in ipairs( error_list ) do
if last:find ("[^%a%-%'%s]") or first:find ("[^%a%-%'%s%.]") then
if error_str ~= "" then error_str = error_str .. cfg.messages['parameter-separator'] end
if true ~= Page_in_vanc_error_cat then -- if we haven't been here before then set a sticky flag
error_str = error_str .. wrap_style ('parameter', k);
Page_in_vanc_error_cat=true; -- so that if there are more than one error the category is added only once
end
table.insert( z.message_tail, { set_error( 'vancouver', {}, true ) } );
if #error_list > 1 then
error_str = error_str .. cfg.messages['parameter-final-separator'];
else
error_str = error_str .. cfg.messages['parameter-pair-separator'];
end
end
return false; -- not a string of latin characters; Vancouver required Romanization
error_str = error_str .. wrap_style ('parameter', selected);
end;
table.insert( z.message_tail, { seterror( error_condition, {error_str}, true ) } );
return true;
end
return value, selected;
end
end


 
-- COinS metadata (see <http://ocoins.info/>) allows automated tools to parse
--[[--------------------------< R E D U C E _ T O _ I N I T I A L S >------------------------------------------
-- the citation information.
 
function COinS(data)
Attempts to convert names to initials in support of |name-list-format=vanc. 
if 'table' ~= type(data) or nil == next(data) then
 
return '';
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.  This form is not
currently supported by this code so correctly formed names like Smith JL 2nd are converted to Smith J2. See http://www.ncbi.nlm.nih.gov/books/NBK7271/box/A35085/.
 
]]
 
local function reduce_to_initials(first)
if first:match("^%u%u$") then return first end; -- when first contains just two upper-case letters, nothing to do
local initials = {}
local i = 0; -- counter for number of initials
for word in string.gmatch(first, "[^%s%.%-]+") do -- names separated by spaces, hyphens, or periods
table.insert(initials, string.sub(word,1,1)) -- Vancouver format does not include full stops.
i = i + 1; -- bump the counter
if 2 <= i then break; end -- only two initials allowed in Vancouver system; if 2, quit
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 = ','; -- name-list separator between authors is a comma
namesep = ' '; -- last/first separator is a space
else
sep = ';' -- name-list separator between authors is a semicolon
namesep = ', ' -- last/first separator is <comma><space>
end
end
if sep:sub(-1,-1) ~= " " then sep = sep .. " " end
local ctx_ver = "Z39.88-2004";
if maximum ~= nil and maximum < 1 then return "", 0; end
for i,person in ipairs(people) do
-- treat table strictly as an array with only set values.
if is_set(person.last) then
local OCinSoutput = setmetatable( {}, {
local mask = person.mask
__newindex = function(self, key, value)
local one
if is_set(value) then
local sep_one = sep;
rawset( self, #self+1, table.concat{ key, '=', mw.uri.encode( removewikilink( value ) ) } );
if maximum ~= nil and i > maximum then
end
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 is_good_vanc_name (one, first) then -- and name is all Latin characters
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 = "[[" .. person.link .. "|" .. one .. "]]" -- link author/editor if this page is not the author's/editor's page
end
 
if is_set(person.link) and ((nil ~= person.link:find("//")) or (nil ~= person.link:find("[%[%]]"))) then
one = one .. " " .. set_error( 'bad_authorlink' ) end -- url or wikilink in author link;
end
table.insert( text, one )
table.insert( text, sep_one )
end
end
end
});
 
local count = #text / 2;
if is_set(data.Chapter) then
if count > 0 then
OCinSoutput.rft_val_fmt = "info:ofi/fmt:kev:mtx:book";
if count > 1 and is_set(lastauthoramp) and not etal then
OCinSoutput["rft.genre"] = "bookitem";
text[#text-2] = " & ";
OCinSoutput["rft.atitle"] = data.Chapter;
end
OCinSoutput["rft.btitle"] = data.Title;
text[#text] = nil;  
elseif is_set(data.Periodical) then
OCinSoutput.rft_val_fmt = "info:ofi/fmt:kev:mtx:journal";
OCinSoutput["rft.genre"] = "article";
OCinSoutput["rft.jtitle"] = data.Periodical;
OCinSoutput["rft.atitle"] = data.Title;
else
OCinSoutput.rft_val_fmt = "info:ofi/fmt:kev:mtx:book";
OCinSoutput["rft.genre"] = "book"
OCinSoutput["rft.btitle"] = data.Title;
end
end
local result = table.concat(text) -- construct list
OCinSoutput["rft.place"] = data.PublicationPlace;
if etal then
OCinSoutput["rft.date"] = data.Date;
local etal_text = cfg.messages['et al'];
OCinSoutput["rft.series"] = data.Series;
result = result .. " " .. etal_text;
OCinSoutput["rft.volume"] = data.Volume;
end
OCinSoutput["rft.issue"] = data.Issue;
OCinSoutput["rft.pages"] = data.Pages;
OCinSoutput["rft.edition"] = data.Edition;
OCinSoutput["rft.pub"] = data.PublisherName;
return result, count
for k, v in pairs( data.ID_list ) do
end
local id, value = cfg.id_handlers[k].COinS;
 
if k == 'ISBN' then value = cleanisbn( v ); else value = v; end
--[[--------------------------< A N C H O R _ I D >------------------------------------------------------------
if string.sub( id or "", 1, 4 ) == 'info' then
Generates a CITEREF anchor ID if we have at least one name or a date.  Otherwise returns an empty string.
OCinSoutput["rft_id"] = table.concat{ id, "/", v };
 
else
]]
OCinSoutput[ id ] = value;
 
end
local function anchor_id( options )
local id = table.concat( options ); -- 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
end
 
local last, first;
--[[--------------------------< E X T R A C T _ N A M E S >----------------------------------------------------
for k, v in ipairs( data.Authors ) do
Gets name list from the input arguments
last, first = v.last, v.first;
 
if k == 1 then
Searches through args in sequential order to find |lastn= and |firstn= parameters (or their aliases), and their matching link and mask parameters.
if is_set(last) then
Stops searching when both |lastn= and |firstn= are not found in args after two sequential attempts: found |last1=, |last2=, and |last3= but doesn't
OCinSoutput["rft.aulast"] = last;
find |last4= and |last5= then the search is done.
end
 
if is_set(first) then
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=
OCinSoutput["rft.aufirst"] = first;
are present but |last2= is missing, an error message is emitted. |lastn= is not required to have a matching |firstn=.
end
end
if is_set(last) and is_set(first) then
OCinSoutput["rft.au"] = table.concat{ last, ", ", first };
elseif is_set(last) then
OCinSoutput["rft.au"] = last;
end
end
OCinSoutput.rft_id = data.URL;
OCinSoutput.rfr_id = table.concat{ "info:sid/", mw.site.server:match( "[^/]*$" ), ":", data.RawPage };
OCinSoutput = setmetatable( OCinSoutput, nil );
-- sort with version string always first, and combine.
table.sort( OCinSoutput );
table.insert( OCinSoutput, 1, "ctx_ver=" .. ctx_ver );  -- such as "Z39.88-2004"
return table.concat(OCinSoutput, "&");
end
 


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
--[[--------------------------< G E T _ I S O 6 3 9 _ C O D E >------------------------------------------------
that will cause list_people() to add the static 'et al.' text from Module:Citation/CS1/Configuration.  This keeps 'et al.' out of the
template's metadata.  When this occurs, the page is added to a maintenance category.


]]
Validates language names provided in |language= parameter if not an ISO639-1 code.  Handles the special case that is Norwegian where
ISO639-1 code 'no' is mapped to language name 'Norwegian Bokmål' by Extention:CLDR.


local function extract_names(args, list_name)
Returns the language name and associated ISO639-1 code.  Because case of the source may be incorrect or different from the case that Wikimedia
local names = {}; -- table of names
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
local last; -- individual name components
with the code. When there is no match, we return the original language name string.
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 pattern = ",? *'*[Ee][Tt] *[Aa][Ll][%.']*$" -- variations on the 'et al' theme
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
mw.language.fetchLanguageNames() will return a list of languages that aren't part of ISO639-1. Names that aren't ISO639-1 but that are included
last = select_one( args, cfg.aliases[list_name .. '-Last'], 'redundant_parameters', i ); -- search through args for name components beginning at 1
in the list will be found if that name is provided in the |language= parameter. For example, if |language=Samaritan Aramaic, that name will be
first = select_one( args, cfg.aliases[list_name .. '-First'], 'redundant_parameters', i );
found with the associated code 'sam', not an ISO639-1 code.  When names are found and the associated code is not two characters, this function
link = select_one( args, cfg.aliases[list_name .. '-Link'], 'redundant_parameters', i );
returns only the Wikimedia language name.
mask = select_one( args, cfg.aliases[list_name .. '-Mask'], 'redundant_parameters', i );


local name = tostring(last);
Adapted from code taken from Module:Check ISO 639-1.
if name:match (pattern) then -- varients on et al.
]]
last = name:gsub (pattern, ''); -- if found, remove
etal = true;
end
name = tostring(first);
if name:match (pattern) then -- varients on et al.
first = name:gsub (pattern, ''); -- if found, remove
etal = true;
end


if first and not last then -- if there is a firstn without a matching lastn
function get_iso639_code (lang)
table.insert( z.message_tail, { set_error( 'first_missing_last', {err_msg_list_name, i}, true ) } ); -- add this error message
if 'Norwegian' == lang then
elseif not first and not last then -- if both firstn and lastn aren't found, are we done?
return lang, 'no'; -- special case related to Wikimedia remap of code 'no' at Extension:CLDR
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
names[n] = {last = last, first = first, link = link, mask = mask}; -- add this name to our names list
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
end
if true == etal then
local languages = mw.language.fetchLanguageNames('en', 'all') -- get a list of language names known to Wikimedia
table.insert( z.maintenance_cats, 'CS1 maint: Explicit use of et al.'); -- add to maint category
-- ('all' is required for North Ndebele, South Ndebele, and Ojibwa)
end
local langlc = mw.ustring.lower(lang); -- lower case version for comparisons
return names, etal; -- all done, return our list of names
end
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
-- Populates ID table from arguments using configuration settings
if 2 ~= code:len() then -- ISO639-1 codes only
local function extract_ids( args )
return name; -- so return the name but not the code
local id_list = {};
end
for k, v in pairs( cfg.id_handlers ) do
return name, code; -- found it, return name to ensure proper capitalization and the ISO639-1 code
v = select_one( args, v.parameters, 'redundant_parameters' );
end
if is_set(v) then id_list[k] = v; end
end
end
return id_list;
return lang; -- not valid language; return language in original case and nil for ISO639-1 code
end
end


--[[--------------------------< B U I L D _ I D _ L I S T >--------------------------------------------------------
--[[--------------------------< L A N G U A G E _ P A R A M E T E R >------------------------------------------
Takes a table of IDs and turns it into a table of formatted ID outputs.
 
Get language name from ISO639-1 code value provided.  If a code is valid use the returned name; if not, then use the value that was provided with the language parameter.
 
There is an exception.  There are three ISO639-1 codes for Norewegian language variants.  There are two official variants: Norwegian Bokmål (code 'nb') and
Norwegian Nynorsk (code 'nn').  The third, code 'no',  is defined by ISO639-1 as 'Norwegian' though in Norway this is pretty much meaningless.  However, it appears
that on enwiki, editors are for the most part unaware of the nb and nn variants (compare page counts for these variants at Category:Articles with non-Hebrew-language external links.
 
Because Norwegian Bokmål is the most common language variant, Media wiki has been modified to return Norwegian Bokmål for ISO639-1 code 'no'. Here we undo that and
return 'Norwegian' when editors use |language=no.  We presume that editors don't know about the variants or can't descriminate between them.
 
See Help talk:Citation Style_1#An ISO 639-1 language name test
 
When |language= contains a valid ISO639-1 code, the page is assigned to the category for that code: Category:Norwegian-language sources (no) if
the page is a mainspace page and the ISO639-1 code is not 'en'.  Similarly, if the  parameter is |language=Norwegian, it will be categorized in the same way.


]]
]]
local function build_id_list( id_list, options )
local new_list, handler = {};


function fallback(k) return { __index = function(t,i) return cfg.id_handlers[k][i] end } end;
function language_parameter (lang, namespace)
local code; -- the ISO639-1 two character code
for k, v in pairs( id_list ) do
local name; -- the language name
-- fallback to read-only cfg
local test='';
handler = setmetatable( { ['id'] = v }, fallback(k) );
if handler.mode == 'external' then
-- if 0 == namespace and (('he' == lang:lower()) or ('hebrew' == lang:lower())) then
table.insert( new_list, {handler.label, external_link_id( handler ) } );
-- table.insert (z.maintenance_cats, 'תבנית ציטוט עם ציון עברית בתור שפה זרה'); -- add maintenance category if |language=Hebrew or |language=he in article space
elseif handler.mode == 'internal' then
-- end
table.insert( new_list, {handler.label, internal_link_id( handler ) } );
 
elseif handler.mode ~= 'manual' then
if 2 == lang:len() then -- ISO639-1 language code are 2 characters (fetchLanguageName also supports 3 character codes)
error( cfg.messages['unknown_ID_mode'] );
name = mw.language.fetchLanguageName( lang:lower(), "he" ); -- get ISO 639-1 language name if Language is a proper code
elseif k == 'DOI' then
end
table.insert( new_list, {handler.label, doi( v, options.DoiBroken ) } );
 
elseif k == 'ARXIV' then
-- our part
table.insert( new_list, {handler.label, arxiv( v ) } );
if not is_set (name) then
elseif k == 'ASIN' then
local langs = mw.language.fetchLanguageNames( "en" )
table.insert( new_list, {handler.label, amazon( v, options.ASINTLD ) } );
local lang1 = lang:lower()
elseif k == 'LCCN' then
lang1 = lang1:sub(1, 1):upper() .. lang1:sub(2)
table.insert( new_list, {handler.label, lccn( v ) } );
for k, v in pairs(langs) do
elseif k == 'OL' then
if lang1 == v
table.insert( new_list, {handler.label, openlibrary( v ) } );
then name = mw.language.fetchLanguageName( k, "he" )
elseif k == 'PMC' then
break
table.insert( new_list, {handler.label, pmc( v, options.Embargo ) } );
end
elseif k == 'PMID' then
end
table.insert( new_list, {handler.label, pmid( v ) } );
end
elseif k == 'ISSN' then
-- our part end
table.insert( new_list, {handler.label, issn( v ) } );
 
elseif k == 'ISBN' then
if is_set (name) then -- if Language specified a valid ISO639-1 code
local ISBN = internal_link_id( handler );
code = lang:lower(); -- save it
if not check_isbn( v ) and not is_set(options.IgnoreISBN) then
else
ISBN = ISBN .. set_error( 'bad_isbn', {}, false, " ", "" );
name, code = get_iso639_code (lang); -- attempt to get code from name (assign name here so that we are sure of proper capitalization)
end
end
table.insert( new_list, {handler.label, ISBN } );
 
elseif k == 'USENETID' then
-- our part
table.insert( new_list, {handler.label, message_id( v ) } );
if name == 'ויאטנמית'
else
  then name = 'וייטנאמית'
error( cfg.messages['unknown_manual_ID'] );
  end
-- our part end
if is_set (code) then
if 0 == namespace and 'he' ~= code then -- is this page main / article space and Hebrew not the language?
table.insert( z.properties_cats, 'ציטוט מקור בשפה זרה (' .. name .. ')'); -- in main space and not Hebrew: categorize
end
end
else
table.insert (z.maintenance_cats, 'תבנית ציטוט עם ציון שפה לא מזוהה'); -- add maintenance category when |language= does not appear to be ISO 639-1 language
end
end
return (" " .. wrap_msg ('language', name)); -- wrap with '(in ...)'
function comp( a, b ) -- used in following table.sort()
return a[1] < b[1];
end
table.sort( new_list, comp );
for k, v in ipairs( new_list ) do
new_list[k] = v[2];
end
return new_list;
end
end
 


-- COinS metadata (see <http://ocoins.info/>) allows automated tools to parse
function restoreDate(inputDate)
-- the citation information.
return inputDate
local function COinS(data)
-- Until the problem of Month-Year -> Fill Current day will be resolved
if 'table' ~= type(data) or nil == next(data) then
-- if inputDate == "" then
return '';
-- return ""
-- end
-- return mw.text.trim(globalframe:expandTemplate({title = "זמןמ", args = {'', inputDate, ["שגיאה"] = "ללא"}}));
end
 
function autoDir(str)
if str and str ~= '' then
return '<span dir="auto">' ..str .. '</span>'
end
return str
end
 
function translateEdition(str)
if str=='1st' then
return 'ראשונה'
elseif str=='2nd' then
return 'שנייה'
end
end
return str
end
--[[--------------------------< C I T A T I O N 0 >------------------------------------------------------------
This is the main function doing the majority of the citation
formatting.
]]
function citation0( config, args)
--[[
Load Input Parameters
The argument_wrapper facilitates the mapping of multiple
aliases to single internal variable.
]]
local A = argument_wrapper( args );
local i
local PPrefix = A['PPrefix']
local PPPrefix = A['PPPrefix']
if is_set( A['NoPP'] ) then PPPrefix = "" PPrefix = "" end
local ctx_ver = "Z39.88-2004";
-- Pick out the relevant fields from the arguments. Different citation templates
-- define different field names for the same underlying things.
-- treat table strictly as an array with only set values.
local Authors = A['Authors'];
local OCinSoutput = setmetatable( {}, {
local a = extractnames( args, 'AuthorList' );
__newindex = function(self, key, value)
 
if is_set(value) then
local Coauthors = A['Coauthors'];
rawset( self, #self+1, table.concat{ key, '=', mw.uri.encode( remove_wiki_link( value ) ) } );
local Others = A['Others'];
end
local Editors = A['Editors'];
end
local e = extractnames( args, 'EditorList' );
});
 
local Year = A['Year'];
if is_set(data.Chapter) then
local PublicationDate = restoreDate(A['PublicationDate']);
OCinSoutput.rft_val_fmt = "info:ofi/fmt:kev:mtx:book";
local OrigYear = A['OrigYear'];
OCinSoutput["rft.genre"] = "bookitem";
local Date = restoreDate(A['Date']);
OCinSoutput["rft.atitle"] = data.Chapter;
local LayDate = restoreDate(A['LayDate']);
OCinSoutput["rft.btitle"] = data.Title;
------------------------------------------------- Get title data
elseif is_set(data.Periodical) then
local Title = A['Title'];
OCinSoutput.rft_val_fmt = "info:ofi/fmt:kev:mtx:journal";
local ScriptTitle = A['ScriptTitle'];
OCinSoutput["rft.genre"] = "article";
local BookTitle = A['BookTitle'];
OCinSoutput["rft.jtitle"] = data.Periodical;
local Conference = A['Conference'];
OCinSoutput["rft.atitle"] = data.Title;
local TransTitle = A['TransTitle'];
else
local TitleNote = A['TitleNote'];
OCinSoutput.rft_val_fmt = "info:ofi/fmt:kev:mtx:book";
local TitleLink = A['TitleLink'];
OCinSoutput["rft.genre"] = "book"
local Chapter = autoDir(A['Chapter']);
OCinSoutput["rft.btitle"] = data.Title;
local ChapterLink = A['ChapterLink']; -- deprecated
end
local TransChapter = A['TransChapter'];
local TitleType = A['TitleType'];
local Degree = A['Degree'];
local Docket = A['Docket'];
local ArchiveURL = A['ArchiveURL'];
local URL = A['URL']
local URLorigin = A:ORIGIN('URL'); -- get name of parameter that holds URL
local ChapterURL = A['ChapterURL'];
local ChapterURLorigin = A:ORIGIN('ChapterURL'); -- get name of parameter that holds ChapterURL
local ConferenceURL = A['ConferenceURL'];
local ConferenceURLorigin = A:ORIGIN('ConferenceURL'); -- get name of parameter that holds ConferenceURL
local Periodical = A['Periodical'];
 
local Series = A['Series'];
local Volume = A['Volume'];
local Issue = A['Issue'];
local Position = '';
local Page = A['Page'];
local Pages = hyphentodash( A['Pages'] );
local At = A['At'];
 
local Edition = translateEdition(A['Edition']);
local PublicationPlace = autoDir(A['PublicationPlace'])
local Place = autoDir(A['Place']);
OCinSoutput["rft.place"] = data.PublicationPlace;
local PublisherName = autoDir(A['PublisherName']);
OCinSoutput["rft.date"] = data.Date;
local RegistrationRequired = A['RegistrationRequired'];
OCinSoutput["rft.series"] = data.Series;
local SubscriptionRequired = A['SubscriptionRequired'];
OCinSoutput["rft.volume"] = data.Volume;
local Via = A['Via'];
OCinSoutput["rft.issue"] = data.Issue;
local AccessDate = restoreDate(A['AccessDate']);
OCinSoutput["rft.pages"] = data.Pages;
local ArchiveDate = restoreDate(A['ArchiveDate']);
OCinSoutput["rft.edition"] = data.Edition;
local Agency = A['Agency'];
OCinSoutput["rft.pub"] = data.PublisherName;
local DeadURL = A['DeadURL']
local Language = A['Language'];
for k, v in pairs( data.ID_list ) do
local LangCode = A['Language'];
local id, value = cfg.id_handlers[k].COinS;
local Format = A['Format'];
if k == 'ISBN' then value = clean_isbn( v ); else value = v; end
local ChapterFormat = A['ChapterFormat'];
if string.sub( id or "", 1, 4 ) == 'info' then
local Ref = A['Ref'];
OCinSoutput["rft_id"] = table.concat{ id, "/", v };
local DoiBroken = A['DoiBroken'];
else
local ID = A['ID'];
OCinSoutput[ id ] = value;
local ASINTLD = A['ASINTLD'];
end
local IgnoreISBN = A['IgnoreISBN'];
end
local Embargo = A['Embargo'];
 
local last, first;
local ID_list = extractids( args );
for k, v in ipairs( data.Authors ) do
 
last, first = v.last, v.first;
local Quote = A['Quote'];
if k == 1 then
local PostScript = A['PostScript'];
if is_set(last) then
 
OCinSoutput["rft.aulast"] = last;
local LayURL = A['LayURL'];
end
local LaySource = A['LaySource'];
if is_set(first) then  
local Transcript = A['Transcript'];
OCinSoutput["rft.aufirst"] = first;
local TranscriptURL = A['TranscriptURL']
end
local TranscriptURLorigin = A:ORIGIN('TranscriptURL'); -- get name of parameter that holds TranscriptURL
local sepc = A['Separator'];
 
local LastAuthorAmp = A['LastAuthorAmp'];
local no_tracking_cats = A['NoTracking'];
-- our code start
local Month = A['Month'];
LangCode = mw.ustring.gsub( Language, '-.*', '' );
Language = LangCode;
-- our code end
 
--these are used by cite interview
local Callsign = A['Callsign'];
local City = A['City'];
local Program = A['Program'];
 
--local variables that are not cs1 parameters
local use_lowercase; -- controls capitalization of certain static text
local this_page = mw.title.getCurrentTitle(); -- also used for COinS and for language
local anchor_year; -- used in the CITEREF identifier
local COinS_date; -- used in the COinS metadata
 
local IsValidDate, LocalDate
local DateFormat = nil
-- Set postscript default.
if not is_set (PostScript) then -- if |postscript= has not been set (Postscript is nil which is the default for {{citation}}) and
if (config.CitationClass ~= "citation") then -- this template is not a citation template
PostScript = '.'; -- must be a cite xxx template so set postscript to default (period)
end
end
if is_set(last) and is_set(first) then
else
OCinSoutput["rft.au"] = table.concat{ last, ", ", first };
if PostScript:lower() == 'none' then -- if |postscript=none then
elseif is_set(last) then
PostScript = ''; -- no postscript
OCinSoutput["rft.au"] = last;
end
end
end
--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 inArray (this_page.nsText, cfg.uncategorized_namespaces) then
no_tracking_cats = "true"; -- set no_tracking_cats
end
end
-- check for extra |page=, |pages= or |at= parameters.
if is_set(Page) then
if is_set(Pages) or is_set(At) then
Page = Page .. " " .. seterror('extra_pages'); -- add error message
Pages = ''; -- unset the others
At = '';
end
elseif is_set(Pages) then
if is_set(At) then
Pages = Pages .. " " .. seterror('extra_pages'); -- add error messages
At = ''; -- unset
end
end
-- both |publication-place= and |place= (|location=) allowed if different
if not is_set(PublicationPlace) and is_set(Place) then
PublicationPlace = Place; -- promote |place= (|location=) to |publication-place
end
end
OCinSoutput.rft_id = data.URL;
if PublicationPlace == Place then Place = ''; end -- don't need both if they are the same
OCinSoutput.rfr_id = table.concat{ "info:sid/", mw.site.server:match( "[^/]*$" ), ":", data.RawPage };
OCinSoutput = setmetatable( OCinSoutput, nil );
-- sort with version string always first, and combine.
--[[
table.sort( OCinSoutput );
Parameter remapping for cite encyclopedia:
table.insert( OCinSoutput, 1, "ctx_ver=" .. ctx_ver );  -- such as "Z39.88-2004"
When the citation has these parameters:
return table.concat(OCinSoutput, "&");
|encyclopedia and |title then map |title to |article and |encyclopedia to |title
end
|encyclopedia and |article then map |encyclopedia to |title
 
|encyclopedia then map |encyclopedia to |title


--[[--------------------------< G E T _ I S O 6 3 9 _ C O D E >------------------------------------------------
|trans_title maps to |trans_chapter when |title is re-mapped
|url maps to |chapterurl when |title is remapped


Validates language names provided in |language= parameter if not an ISO639-1 code.  Handles the special case that is Norwegian where
All other combinations of |encyclopedia, |title, and |article are not modified
ISO639-1 code 'no' is mapped to language name 'Norwegian Bokmål' by Extention:CLDR.
 
Returns the language name and associated ISO639-1 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() will return a list of languages that aren't part of ISO639-1. Names that aren't ISO639-1 but that are included
in the list will be found if that name is provided in the |language= parameter.  For example, if |language=Samaritan Aramaic, that name will be
found with the associated code 'sam', not an ISO639-1 code.  When names are found and the associated code is not two characters, this function
returns only the Wikimedia language name.
 
Adapted from code taken from Module:Check ISO 639-1.
]]
]]
 
if ( config.CitationClass == "encyclopaedia" ) then
local function get_iso639_code (lang)
if is_set(Periodical) then -- Periodical is set when |encyclopedia is set
if 'norwegian' == lang:lower() then -- special case related to Wikimedia remap of code 'no' at Extension:CLDR
if is_set(Title) then
return 'Norwegian', 'no'; -- Make sure rendered version is properly capitalized
if not is_set(Chapter) then
end
Chapter = Title; -- |encyclopedia and |title are set so map |title to |article and |encyclopedia to |title
TransChapter = TransTitle;
local languages = mw.language.fetchLanguageNames('en', 'all') -- get a list of language names known to Wikimedia
ChapterURL = URL;
-- ('all' is required for North Ndebele, South Ndebele, and Ojibwa)
Title = Periodical;
local langlc = mw.ustring.lower(lang); -- lower case version for comparisons
Periodical = ''; -- redundant so unset
TransTitle = ''; -- redundant so unset
for code, name in pairs(languages) do -- scan the list to see if we can find our language
URL = ''; -- redundant so unset
if langlc == mw.ustring.lower(name) then
end
if 2 ~= code:len() then -- ISO639-1 codes only
else -- |title not set
return name; -- so return the name but not the code
Title = Periodical; -- |encyclopedia set and |article set or not set so map |encyclopedia to |title
Periodical = ''; -- redundant so unset
end
end
return name, code; -- found it, return name to ensure proper capitalization and the ISO639-1 code
end
end
end
end
return lang; -- not valid language; return language in original case and nil for ISO639-1 code
end


--[[--------------------------< L A N G U A G E _ P A R A M E T E R >------------------------------------------
--special cases for citation.
if (config.CitationClass == "citation") then -- for citation templates
if not is_set (Ref) then -- if |ref= is not set
Ref = "harv"; -- set default |ref=harv
end
if not is_set (sepc) then -- if |separator= is not set
sepc = ','; -- set citation separator to its default (comma)
end
else -- not a citation template
if not is_set (sepc) then -- if |separator= has not been set
sepc = '.'; -- set cite xxx separator to its default (period)
end
end
use_lowercase = ( sepc ~= '.' ); -- used to control capitalization for certain static text


Get language name from ISO639-1 code value provided.  If a code is valid use the returned name; if not, then use the value that was provided with the language parameter.
-- check for special case where |separator=none
if 'none' == sepc:lower() then -- if |separator=none
sepc = ''; -- then set it to an empty string
end


There is an exception.  There are three ISO639-1 codes for Norewegian language variants. There are two official variants: Norwegian Bokmål (code 'nb') and
-- Special case for cite techreport.
Norwegian Nynorsk (code 'nn').  The third, code 'no', is defined by ISO639-1 as 'Norwegian' though in Norway this is pretty much meaningless.  However, it appears
if (config.CitationClass == "techreport") then -- special case for cite techreport
that on enwiki, editors are for the most part unaware of the nb and nn variants (compare page counts for these variants at Category:Articles with non-English-language external links.
if is_set(Issue) then -- cite techreport uses 'number', which other citations aliase to 'issue'
 
if not is_set(ID) then -- can we use ID for the "number"?
Because Norwegian Bokmål is the most common language variant, Media wiki has been modified to return Norwegian Bokmål for ISO639-1 code 'no'. Here we undo that and
ID = Issue; -- yes, use it
return 'Norwegian' when editors use |language=no.  We presume that editors don't know about the variants or can't descriminate between them.
Issue = ""; -- unset Issue so that "number" isn't duplicated in the rendered citation or COinS metadata
 
else -- can't use ID so emit error message
See Help talk:Citation Style_1#An ISO 639-1 language name test
ID = ID .. " " .. seterror('redundant_parameters', '<code>&#124;id=</code> and <code>&#124;number=</code>');
 
end
When |language= contains a valid ISO639-1 code, the page is assigned to the category for that code: Category:Norwegian-language sources (no) if
end
the page is a mainspace page and the ISO639-1 code is not 'en'.  Similarly, if the  parameter is |language=Norwegian, it will be categorized in the same way.
 
]]
 
local function language_parameter (lang, namespace)
local code; -- the ISO639-1 two character code
local name; -- the language name
local test='';
if 0 == namespace and (('en' == lang:lower()) or ('english' == lang:lower())) then
table.insert (z.maintenance_cats, 'CS1 maint: English language specified'); -- add maintenance category if |language=English or |language=en in article space
end
end


if 2 == lang:len() then -- ISO639-1 language code are 2 characters (fetchLanguageName also supports 3 character codes)
-- special case for cite interview
name = mw.language.fetchLanguageName( lang:lower(), "en" ); -- get ISO 639-1 language name if Language is a proper code
if (config.CitationClass == "interview") then
end
if is_set(Program) then
 
ID = ' ' .. Program;
if is_set (name) then -- if Language specified a valid ISO639-1 code
end
code = lang:lower(); -- save it
if is_set(Callsign) then
else
if is_set(ID) then
name, code = get_iso639_code (lang); -- attempt to get code from name (assign name here so that we are sure of proper capitalization)
ID = ID .. sepc .. ' ' .. Callsign;
else
ID = ' ' .. Callsign;
end
end
if is_set(City) then
if is_set(ID) then
ID = ID .. sepc .. ' ' .. City;
else
ID = ' ' .. City;
end
end
 
if is_set(Others) then
if is_set(TitleType) then
Others = ' ' .. TitleType .. ' עם ' .. Others;
TitleType = '';
else
Others = ' ' .. 'ראיון עם ' .. Others;
end
else
Others = '(ראיון)';
end
end
end


if is_set (code) then
--Account for the oddity that is {{cite journal}} with |pmc= set and |url= not set
if 'no' == code then name = 'Norwegian' end; -- override wikimedia when code is 'no'
if config.CitationClass == "journal" and not is_set(URL) and is_set(ID_list['PMC']) then
if 0 == namespace and 'en' ~= code then -- is this page main / article space and English not the language?
if not is_embargoed(Embargo) then
table.insert( z.properties_cats, 'CS1 ' .. name .. '-language sources (' .. code .. ')'); -- in main space and not English: categorize
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=
end
end
else
table.insert (z.maintenance_cats, 'CS1 maint: Unrecognized language'); -- add maintenance category when |language= does not appear to be ISO 639-1 language
end
end
return (" " .. wrap_msg ('language', name)); -- wrap with '(in ...)'
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 >----------------------
-- Account for the oddity that is {{cite conference}}, before generation of COinS data.
When |mode= is not set or when its value is invalid, use config.CitationClass and parameter values to establish
--TODO: if this is only for {{cite conference}}, shouldn't we be checking? (if config.CitationClass=='conference' then ...)
rendered style.
if is_set(BookTitle) then
 
Chapter = Title;
]]
ChapterLink = TitleLink;
 
TransChapter = TransTitle;
local function get_settings_from_cite_class (ps, ref, cite_class)
Title = BookTitle;
local sep;
TitleLink = '';
if (cite_class == "citation") then -- for citation templates (CS2)
TransTitle = '';
sep = ','; -- set citation separator to its default (comma)
if not is_set (ps) then -- if |postscript= has not been set, set cs2 default
ps = ''; -- make sure it isn't nil
end
if not is_set (ref) then -- if |ref= is not set
ref = "harv"; -- set default |ref=harv
end
else -- not a citation template so CS1
sep = '.'; -- set cite xxx separator to its default (period)
if not is_set (ps) then -- if |postscript= has not been set
ps = '.'; -- set cs1 default
end
end
end


return sep, ps, ref -- return them all
-- Account for the oddity that is {{cite episode}}, before generation of COinS data.
end
--[[ -- {{cite episode}} is not currently supported by this module
 
if config.CitationClass == "episode" then
--[[--------------------------< S E T _ S T Y L E >------------------------------------------------------------
local AirDate = A['AirDate'];
 
local SeriesLink = A['SeriesLink'];
Establish basic style settings to be used when rendering the citation.  Uses |mode= if set and valid or uses
local Season = A['Season'];
config.CitationClass from the template's #invoke: to establish style.
local SeriesNumber = A['SeriesNumber'];
 
local Network = A['Network'];
]]
local Station = A['Station'];
 
local s, n = {}, {};
local function set_style (mode, ps, ref, cite_class)
local Sep = (first_set(A["SeriesSeparator"], A["Separator"]) or "") .. " ";
local sep;
if is_set (mode) then
if is_set(Issue) then table.insert(s, cfg.messages["episode"] .. " " .. Issue); Issue = ''; end
if 'cs2' == mode then -- if this template is to be rendered in CS2 (citation) style
if is_set(Season) then table.insert(s, cfg.messages["season"] .. " " .. Season); end
sep = ','; -- separate elements with a comma
if is_set(SeriesNumber) then table.insert(s, cfg.messages["series"] .. " " .. SeriesNumber); end
if not is_set (ps) then -- unless explicitely set to something
if is_set(Network) then table.insert(n, Network); end
ps = ''; -- make sure it isn't nil
if is_set(Station) then table.insert(n, Station); end
end
if not is_set (ref) then -- unless explicitely set to something
Date = Date or AirDate;
ref = 'harv'; -- set so this template renders with CITEREF anchor id
Chapter = Title;
end
ChapterLink = TitleLink;
elseif 'cs1' == mode then -- if this template is to be rendered in CS1 (cite xxx) style
TransChapter = TransTitle;
sep = '.'; -- separate elements with a period
Title = Series;
if not is_set (ps) then -- unless explicitely set to something
TitleLink = SeriesLink;
ps = '.'; -- terminate the rendered citation with a period
TransTitle = '';
end
else -- anything but cs1 or cs2
Series = table.concat(s, Sep);
table.insert( z.message_tail, { set_error( 'invalid_param_val', {'mode', mode}, true ) } ); -- add error message
ID = table.concat(n, Sep);
sep, ps, ref = get_settings_from_cite_class (ps, ref, cite_class); -- get settings based on the template's CitationClass
end
else -- when |mode= empty or omitted
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
end
-- end of {{cite episode}} stuff]]
return sep, ps, ref
end


-- legacy: promote concatenation of |month=, and |year= to Date if Date not set; or, promote PublicationDate to Date if neither Date nor Year are set.
if is_set(Date) then
if is_set (Year) then
table.insert( z.maintenance_cats, "תבניות ציטוט עם תאריך ושנה בו זמנית"); -- add to maint category
end
else
DateFormat = 'Y'
Date = Year; -- promote Year to Date
Year = nil; -- make nil so Year as empty string isn't used for CITEREF
if is_set(Date) then
if is_set(Month) then
DateFormat = 'M Y'
Date = Month .. " " .. Date;
end
elseif is_set(PublicationDate) then -- use PublicationDate when |date= and |year= are not set
Date = PublicationDate; -- promote PublicationDate to Date
PublicationDate = ''; -- unset, no longer needed
end
end
if PublicationDate == Date then PublicationDate = ''; end -- if PublicationDate is same as Date, don't display in rendered citation


--[[--------------------------< 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
The argument_wrapper facilitates the mapping of multiple
aliases to single internal variable.
]]
local A = argument_wrapper( args );
local i
local PPrefix = A['PPrefix']
local PPPrefix = A['PPPrefix']
if is_set( A['NoPP'] ) then PPPrefix = "" PPrefix = "" end
-- Pick out the relevant fields from the arguments.  Different citation templates
-- define different field names for the same underlying things.
local Authors = A['Authors'];
local author_etal;
local a, author_etal = extract_names( args, 'AuthorList' );


local Coauthors = A['Coauthors'];
--[[
local Others = A['Others'];
Go test all of the date-holding parameters for valid MOS:DATE format and make sure that dates are real dates. This must be done before we do COinS because here is where
local Editors = A['Editors'];
we get the date used in the metadata.
local editor_etal;
local e, editor_etal = extract_names( args, 'EditorList' );


local NameListFormat = A['NameListFormat']; -- replaces |author-format= and |editor-format=
Date validation supporting code is in Module:Citation/CS1/Date_validation
if is_set (NameListFormat) and ('vanc' ~= NameListFormat) then -- only accepted value for this parameter is 'vanc'
]]
table.insert( z.message_tail, { set_error( 'invalid_param_val', {'name-list-format', NameListFormat}, true ) } ); -- not vanc so add error message
anchor_year, COinS_date, error_message = dates({['accessdate']=AccessDate, ['airdate']=AirDate, ['archivedate']=ArchiveDate, ['date']=Date, ['doi_brokendate']=DoiBroken,
NameListFormat = ''; -- set to empty string
['embargo']=Embargo, ['laydate']=LayDate, ['publicationdate']=PublicationDate, ['year']=Year});
if is_set(error_message) then
table.insert( z.message_tail, { seterror( 'bad_date', {error_message}, true ) } ); -- add this error message
end
 
-- At this point fields may be nil if they weren't specified in the template use.  We can use that fact.
 
-- COinS metadata (see <http://ocoins.info/>) for
-- automated parsing of citation information.
-- this is the function call to COinS()
local OCinSoutput = COinS{
['Periodical'] = Periodical,
['Chapter'] = strip_apostrophe_markup (Chapter), -- Chapter stripped of bold / italic wikimarkup
['Title'] = make_coins_title (Title, ScriptTitle), -- Title and ScriptTitle stripped of bold / italic wikimarkup
['PublicationPlace'] = PublicationPlace,
['Date'] = first_set(COinS_date, Date), -- COinS_date has correctly formatted date if Date is valid; any reason to keep Date here?  Should we be including invalid dates in metadata?
['Series'] = Series,
['Volume'] = Volume,
['Issue'] = Issue,
['Pages'] = get_coins_pages (first_set(Page, Pages, At)), -- pages stripped of external links
['Edition'] = Edition,
['PublisherName'] = PublisherName,
['URL'] = first_set( URL, ChapterURL ),
['Authors'] = a,
['ID_list'] = ID_list,
['RawPage'] = this_page.prefixedText,
};
--[[Why is this here?  Why are we mapping Title to Chapter when Periodical is set?
if is_set(Periodical) and not is_set(Chapter) and is_set(Title) then
Chapter = Title;
ChapterLink = TitleLink;
TransChapter = TransTitle;
Title = '';
TitleLink = '';
TransTitle = '';
end
]]
 
-- special case for cite newsgroup.  Do this after COinS because we are modifying Publishername to include som static text
if 'newsgroup' == config.CitationClass then
if is_set (PublisherName) then
PublisherName = '[[Newsgroup]]:&nbsp;' ..  externallink( 'news:' .. PublisherName, PublisherName );
end
end
end


local Year = A['Year'];
local PublicationDate = A['PublicationDate'];
local OrigYear = A['OrigYear'];
local Date = A['Date'];
local LayDate = A['LayDate'];
------------------------------------------------- Get title data
local Title = A['Title'];
local ScriptTitle = A['ScriptTitle'];
local BookTitle = A['BookTitle'];
local Conference = A['Conference'];
local TransTitle = A['TransTitle'];
local TitleNote = A['TitleNote'];
local TitleLink = A['TitleLink'];
local Chapter = A['Chapter'];
local ChapterLink = A['ChapterLink']; -- deprecated
local TransChapter = A['TransChapter'];
local TitleType = A['TitleType'];
local Degree = A['Degree'];
local Docket = A['Docket'];
local ArchiveURL = A['ArchiveURL'];
local URL = A['URL']
local URLorigin = A:ORIGIN('URL'); -- get name of parameter that holds URL
local ChapterURL = A['ChapterURL'];
local ChapterURLorigin = A:ORIGIN('ChapterURL'); -- get name of parameter that holds ChapterURL
local ConferenceURL = A['ConferenceURL'];
local ConferenceURLorigin = A:ORIGIN('ConferenceURL'); -- get name of parameter that holds ConferenceURL
local Periodical = A['Periodical'];


local Series = A['Series'];
local Volume = A['Volume'];
local Issue = A['Issue'];
local Position = '';
local Page = A['Page'];
local Pages = hyphen_to_dash( A['Pages'] );
local At = A['At'];


local Edition = A['Edition'];
-- Now perform various field substitutions.
local PublicationPlace = A['PublicationPlace']
-- We also add leading spaces and surrounding markup and punctuation to the
local Place = A['Place'];
-- various parts of the citation, but only when they are non-nil.
if not is_set(Authors) then
local PublisherName = A['PublisherName'];
local Maximum = tonumber( A['DisplayAuthors'] );
local RegistrationRequired = A['RegistrationRequired'];
local SubscriptionRequired = A['SubscriptionRequired'];
local Via = A['Via'];
local AccessDate = A['AccessDate'];
local ArchiveDate = A['ArchiveDate'];
local Agency = A['Agency'];
local DeadURL = A['DeadURL']
local Language = A['Language'];
local Format = A['Format'];
local ChapterFormat = A['ChapterFormat'];
local DoiBroken = A['DoiBroken'];
local ID = A['ID'];
local ASINTLD = A['ASINTLD'];
local IgnoreISBN = A['IgnoreISBN'];
local Embargo = A['Embargo'];


local ID_list = extract_ids( args );
if is_set (Maximum) then
if Maximum >= #a then -- if display-authors value greater than or equal to number of authors
table.insert( z.maintenance_cats, "תבניות ציטוט עם פחות מחברים מהנדרש"); -- add maintenance category because display-authors parameter may be removed
end
else
Maximum = #a + 1; -- number of authors + 1
end


local Quote = A['Quote'];
local control = {
 
sep = A["AuthorSeparator"] .. " ",
local LayURL = A['LayURL'];
namesep = (first_set(A["AuthorNameSeparator"], A["NameSeparator"]) or "") .. " ",
local LaySource = A['LaySource'];
format = A["AuthorFormat"],
local Transcript = A['Transcript'];
maximum = Maximum,
local TranscriptURL = A['TranscriptURL']
lastauthoramp = LastAuthorAmp,
local TranscriptURLorigin = A:ORIGIN('TranscriptURL'); -- get name of parameter that holds TranscriptURL
page_name = this_page.text -- get current page name so that we don't wikilink to it via authorlinkn
};
-- If the coauthor field is also used, prevent ampersand and et al. formatting.
if is_set(Coauthors) then
control.lastauthoramp = nil;
control.maximum = #a + 1;
end
Authors = listpeople(control, a)
end


local LastAuthorAmp = A['LastAuthorAmp'];
-- our code start
local no_tracking_cats = A['NoTracking'];
if is_set(Month) then
table.insert( z.message_tail, { seterror('deprecated_month', {}, true) } );
end
if is_set(Coauthors) then
table.insert( z.message_tail, { seterror('deprecated_coauthors', {}, true) } );
end
if is_set(ChapterLink) then
table.insert( z.message_tail, { seterror('deprecated_chapterlink', {}, true) } );
end
-- our code end


--these are used by cite interview
if not is_set(Authors) and is_set(Coauthors) then -- coauthors aren't displayed if one of authors=, authorn=, or lastn= isn't specified
local Callsign = A['Callsign'];
table.insert( z.message_tail, { seterror('coauthors_missing_author', {}, true) } ); -- emit error message
local City = A['City'];
local Program = A['Program'];
 
--local variables that are not cs1 parameters
local use_lowercase; -- controls capitalization of certain static text
local this_page = mw.title.getCurrentTitle(); -- also used for COinS and for language
local anchor_year; -- used in the CITEREF identifier
local COinS_date; -- used in the COinS metadata
 
-- set default parameter values defined by |mode= parameter.  If |mode= is empty or omitted, use CitationClass to set these values
local sepc; -- separator between citation elements for CS1 a period, for CS2, a comma
local PostScript;
local Ref;
sepc, PostScript, Ref = set_style (A['Mode']:lower(), A['PostScript'], A['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.
if not 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
no_tracking_cats = "true"; -- set no_tracking_cats
end
end
end


-- check for extra |page=, |pages= or |at= parameters.
local EditorCount
if is_set(Page) then
if not is_set(Editors) then
if is_set(Pages) or is_set(At) then
local Maximum = tonumber( A['DisplayEditors'] );
Page = Page .. " " .. set_error('extra_pages'); -- add error message
-- Preserve old-style implicit et al.
Pages = ''; -- unset the others
if not is_set(Maximum) and #e == 4 then  
At = '';
Maximum = 3;
table.insert( z.message_tail, { seterror('implict_etal_editor', {}, true) } );
elseif not is_set(Maximum) then
Maximum = #e + 1;
end
end
elseif is_set(Pages) then
if is_set(At) then
Pages = Pages .. " " .. set_error('extra_pages'); -- add error messages
At = ''; -- unset
end
end


-- both |publication-place= and |place= (|location=) allowed if different
local control = {
if not is_set(PublicationPlace) and is_set(Place) then
sep = A["EditorSeparator"] .. " ",
PublicationPlace = Place; -- promote |place= (|location=) to |publication-place
namesep = (first_set(A["EditorNameSeparator"], A["NameSeparator"]) or "") .. " ",
format = A['EditorFormat'],
maximum = Maximum,
lastauthoramp = LastAuthorAmp,
page_name = this_page.text -- get current page name so that we don't wikilink to it via editorlinkn
};
 
Editors, EditorCount = listpeople(control, e);
else
EditorCount = 1;
end
end
if PublicationPlace == Place then Place = ''; end -- don't need both if they are the same
--[[
Parameter remapping for cite encyclopedia:
When the citation has these parameters:
|encyclopedia and |title then map |title to |article and |encyclopedia to |title
|encyclopedia and |article then map |encyclopedia to |title
|encyclopedia then map |encyclopedia to |title


|trans_title maps to |trans_chapter when |title is re-mapped
local Cartography = "";
|url maps to |chapterurl when |title is remapped
local Scale = "";
 
if config.CitationClass == "map" then
All other combinations of |encyclopedia, |title, and |article are not modified
if not is_set( Authors ) and is_set( PublisherName ) then
TODO: script-title to script-chapter if and when we support script-chapter
Authors = PublisherName;
]]
PublisherName = "";
 
end
local Encyclopedia = A['Encyclopedia'];
Cartography = A['Cartography'];
 
if is_set( Cartography ) then
if ( config.CitationClass == "encyclopaedia" ) or ( config.CitationClass == "citation" and is_set (Encyclopedia)) then -- test code for citation
Cartography = sepc .. " " .. wrap_msg ('cartography', Cartography, use_lowercase);
if is_set(Periodical) then -- Periodical is set when |encyclopedia is set
end
if is_set(Title) then
Scale = A['Scale'];
if not is_set(Chapter) then
if is_set( Scale ) then
Chapter = Title; -- |encyclopedia and |title are set so map |title to |article and |encyclopedia to |title
Scale = sepc .. " " .. Scale;
TransChapter = TransTitle;
end
ChapterURL = URL;
end
Title = Periodical;
ChapterFormat = Format;
Format = is_set(Format) and " (" .. Format .. ")" or "";
Periodical = ''; -- redundant so unset
 
TransTitle = ''; -- redundant so unset
if  not is_set(URL) and
URL = ''; -- redundant so unset
not is_set(ArchiveURL) and
Format = ''; -- redundant so unset
not is_set(ConferenceURL) and
end
not is_set(TranscriptURL) then
else -- |title not set
Title = Periodical; -- |encyclopedia set and |article set or not set so map |encyclopedia to |title
-- Test if cite web or cite podcast |url= is missing or empty
Periodical = ''; -- redundant so unset
if inArray(config.CitationClass, {"web","podcast"}) then
end
table.insert( z.message_tail, { seterror( 'cite_web_url', {}, true ) } );
end
-- Test if accessdate is given without giving a URL
if is_set(AccessDate) and not is_set(ChapterURL)then -- ChapterURL may be set when the others are not set; TODO: move this to a separate test?
table.insert( z.message_tail, { seterror( 'accessdate_missing_url', {}, true ) } );
AccessDate = '';
end
-- Test if format is given without giving a URL
if is_set(Format) then
Format = Format .. seterror( 'format_missing_url', {'format', 'url'} );
end
end
end
end


-- Special case for cite techreport.
-- Test if citation has no title
if (config.CitationClass == "techreport") then -- special case for cite techreport
if not is_set(Title) and
if is_set(Issue) then -- cite techreport uses 'number', which other citations aliase to 'issue'
not is_set(Periodical) and
if not is_set(ID) then -- can we use ID for the "number"?
not is_set(Conference) and
ID = Issue; -- yes, use it
not is_set(TransTitle) and
Issue = ""; -- unset Issue so that "number" isn't duplicated in the rendered citation or COinS metadata
not is_set(ScriptTitle) then
else -- can't use ID so emit error message
table.insert( z.message_tail, { seterror( 'citation_missing_title', {}, true ) } );
ID = ID .. " " .. set_error('redundant_parameters', '<code>&#124;id=</code> and <code>&#124;number=</code>');
end
 
local OriginalURL;
DeadURL = DeadURL:lower(); -- used later when assembling archived text
if is_set( ArchiveURL ) then
if is_set (URL) then
OriginalURL = URL; -- save copy of original source URL
if 'no' ~= DeadURL then -- if URL set then archive-url applies to it
URL = ArchiveURL -- swap-in the archive's url
URLorigin = A:ORIGIN('ArchiveURL') -- name of archive url parameter for error messages
end
elseif is_set (ChapterURL) then -- URL not set so if chapter-url is set apply archive url to it
OriginalURL = ChapterURL; -- save copy of source chapter's url for archive text
if 'no' ~= DeadURL then
ChapterURL = ArchiveURL -- swap-in the archive's url
URLorigin = A:ORIGIN('ArchiveURL') -- name of archive url parameter for error messages
end
end
end
end
end
end


-- special case for cite interview
if inArray(config.CitationClass, {"web","news","journal","pressrelease","conference","podcast", "newsgroup"}) or ('citation' == config.CitationClass and is_set (Periodical)) then
if (config.CitationClass == "interview") then
if is_set (Chapter) or is_set (TransChapter) or is_set (ChapterURL)then -- chapter parameters not supported for these citation types
if is_set(Program) then
table.insert( z.message_tail, { seterror( 'chapter_ignored', {}, true ) } ); -- add error message
ID = ' ' .. Program;
Chapter = ''; -- set to empty string to be safe with concatenation
TransChapter = '';
ChapterURL = '';
end
end
if is_set(Callsign) then
else -- otherwise, format chapter / article title
if is_set(ID) then
Chapter = format_chapter_title (Chapter, TransChapter, ChapterURL, ChapterURLorigin);
ID = ID .. sepc .. ' ' .. Callsign;
if is_set (Chapter) then
else
ChapterFormat = is_set(ChapterFormat) and " (" .. ChapterFormat .. ")" or "";
ID = ' ' .. Callsign;
if is_set(ChapterFormat) and not is_set (ChapterURL) then -- Test if |chapter-format= is given without giving a |chapter-url=
ChapterFormat = ChapterFormat .. seterror( 'format_missing_url', {'chapter-format', 'chapter-url'} );
end
end
end
Chapter = Chapter .. ChapterFormat .. sepc .. ' ';
if is_set(City) then
if is_set(ID) then
ID = ID .. sepc .. ' ' .. City;
else
ID = ' ' .. City;
end
end
 
if is_set(Others) then
if is_set(TitleType) then
Others = ' ' .. TitleType .. ' with ' .. Others;
TitleType = '';
else
Others = ' ' .. 'Interview with ' .. Others;
end
else
Others = '(Interview)';
end
end
end
end


-- special case for cite mailing list
-- Format main title.
if (config.CitationClass == "mailinglist") then
if is_set(TitleLink) and is_set(Title) then
Periodical = A ['MailingList'];
Title = "[[" .. TitleLink .. "|" .. Title .. "]]"
end
end


--Account for the oddity that is {{cite journal}} with |pmc= set and |url= not set
if inArray(config.CitationClass, {"web","news","journal","pressrelease","conference","podcast", "newsgroup"}) or ('citation' == config.CitationClass and is_set (Periodical)) then
if config.CitationClass == "journal" and not is_set(URL) and is_set(ID_list['PMC']) then
Title = kern_quotes (Title); -- if necessary, separate title's leading and trailing quote marks from Module provided quote marks
if not is_embargoed(Embargo) then
Title = wrap_style ('quoted-title', Title);
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=
end
end


-- Account for the oddity that is {{cite conference}}, before generation of COinS data.
Title = script_concatenate (Title, ScriptTitle); -- <bdi> tags, lang atribute, categorization, etc; must be done after title is wrapped
if 'conference' == config.CitationClass then
TransTitle= wrap_style ('trans-quoted-title', TransTitle );
if is_set(BookTitle) then
Chapter = Title;
-- ChapterLink = TitleLink; -- |chapterlink= is deprecated
ChapterURL = URL;
ChapterURLorigin = URLorigin;
URLorigin = '';
ChapterFormat = Format;
TransChapter = TransTitle;
Title = BookTitle;
Format = '';
-- TitleLink = '';
TransTitle = '';
URL = '';
end
else
else
Conference = ''; -- not cite conference so make sure this is empty string
Title = wrap_style ('italic-title', Title);
Title = script_concatenate (Title, ScriptTitle); -- <bdi> tags, lang atribute, categorization, etc; must be done after title is wrapped
TransTitle = wrap_style ('trans-italic-title', TransTitle);
end
end


-- Account for the oddity that is {{cite episode}}, before generation of COinS data.
TransError = "";
--[[ -- {{cite episode}} is not currently supported by this module
if is_set(TransTitle) then
if config.CitationClass == "episode" then
if is_set(Title) then
local AirDate = A['AirDate'];
TransTitle = ' <span class="mw-content-rtl">' .. TransTitle .. "</span>";
local SeriesLink = A['SeriesLink'];
else
local Season = A['Season'];
TransError = " " .. seterror( 'trans_missing_title' );
local SeriesNumber = A['SeriesNumber'];
end
local Network = A['Network'];
end
local Station = A['Station'];
local s, n = {}, {};
if is_set(Title) then
local Sep = (first_set(A["SeriesSeparator"], A["Separator"]) or "") .. " ";
-- bidi isolation. ideally we should use here bidi-isolate once browsers supports it properly.
Title = mw.ustring.format( '<span style="unicode-bidi:embed;">%s</span>', Title)
if is_set(Issue) then table.insert(s, cfg.messages["episode"] .. " " .. Issue); Issue = ''; end
end
if is_set(Season) then table.insert(s, cfg.messages["season"] .. " " .. Season); end
Title = Title .. TransTitle;
if is_set(SeriesNumber) then table.insert(s, cfg.messages["series"] .. " " .. SeriesNumber); end
if is_set(Network) then table.insert(n, Network); end
if is_set(Title) then
if is_set(Station) then table.insert(n, Station); end
if not is_set(TitleLink) and is_set(URL) then  
Title = externallink( URL, Title ) .. TransError .. Format  
Date = Date or AirDate;
URL = "";
Chapter = Title;
Format = "";
ChapterLink = TitleLink;
else
TransChapter = TransTitle;
Title = Title .. TransError;
Title = Series;
TitleLink = SeriesLink;
TransTitle = '';
Series = table.concat(s, Sep);
ID = table.concat(n, Sep);
end
-- end of {{cite episode}} stuff]]
 
-- legacy: promote concatenation of |month=, and |year= to Date if Date not set; or, promote PublicationDate to Date if neither Date nor Year are set.
if not is_set (Date) then
Date = Year; -- promote Year to Date
Year = nil; -- make nil so Year as empty string isn't used for CITEREF
if is_set(Date) then
local Month = A['Month'];
if is_set(Month) then
Date = Month .. " " .. Date;
end
elseif is_set(PublicationDate) then -- use PublicationDate when |date= and |year= are not set
Date = PublicationDate; -- promote PublicationDate to Date
PublicationDate = ''; -- unset, no longer needed
end
end
end
end


if PublicationDate == Date then PublicationDate = ''; end -- if PublicationDate is same as Date, don't display in rendered citation
if is_set(Place) then
 
Place = " " .. wrap_msg ('written', Place, use_lowercase) .. sepc .. " ";
--[[
Go test all of the date-holding parameters for valid MOS:DATE format and make sure that dates are real dates. This must be done before we do COinS because here is where
we get the date used in the metadata.
 
Date validation supporting code is in Module:Citation/CS1/Date_validation
]]
do -- create defined block to contain local variables error_message and mismatch
local error_message = '';
 
anchor_year, COinS_date, error_message = dates({['accessdate']=AccessDate, ['airdate']=AirDate, ['archivedate']=ArchiveDate, ['date']=Date, ['doi_brokendate']=DoiBroken,
['embargo']=Embargo, ['laydate']=LayDate, ['publicationdate']=PublicationDate, ['year']=Year});
 
if is_set (Year) and is_set (Date) then -- both |date= and |year= not normally needed;
local mismatch = year_date_check (Year, 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
error_message = error_message .. ', '; -- tack on this additional message
end
error_message = error_message .. '&#124;year= / &#124;date= mismatch';
elseif 1 == mismatch then -- |year= matches year-value in |date=
table.insert( z.maintenance_cats, 'CS1 maint: Date and year'); -- add to maint category
end
end
 
if is_set(error_message) then
table.insert( z.message_tail, { set_error( 'bad_date', {error_message}, true ) } ); -- add this error message
end
end -- end of do
 
-- 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
if not is_set(Title) and
not is_set(TransTitle) and
not is_set(ScriptTitle) then
table.insert( z.message_tail, { set_error( 'citation_missing_title', {}, true ) } );
end
end
if 'none' == Title and is_set(Periodical) and not (( config.CitationClass == "encyclopaedia" ) or ( config.CitationClass == "citation" and is_set (Encyclopedia))) then -- special case
if is_set(Conference) then
Title = ''; -- set title to empty string
if is_set(ConferenceURL) then
table.insert( z.maintenance_cats, 'CS1 maint: Untitled periodical'); -- add to maint category
Conference = externallink( ConferenceURL, Conference );
end
 
-- COinS metadata (see <http://ocoins.info/>) for automated parsing of citation information.
-- handle the oddity that is cite encyclopedia and {{citation |encyclopedia=something}}. Here we presume that
-- when Periodical, Title, and Chapter are all set, then Periodical is the book (encyclopedia) title, Title
-- is the article title, and Chapter is a section within the article.  So, we remap
local coins_chapter = Chapter; -- default assuming that remapping not required
local coins_title = Title; -- et tu
if 'encyclopaedia' == config.CitationClass or ('citation' == config.CitationClass and is_set (Encyclopedia)) then
if is_set (Chapter) and is_set (Title) and is_set (Periodical) then -- if all are used then
coins_chapter = Title; -- remap
coins_title = Periodical;
end
end
Conference = sepc .. " " .. Conference
elseif is_set(ConferenceURL) then
Conference = sepc .. " " .. externallink( ConferenceURL, nil, ConferenceURLorigin );
end
end
-- this is the function call to COinS()
if not is_set(Position) then
local OCinSoutput = COinS{
local Minutes = A['Minutes'];
['Periodical'] = Periodical,
if is_set(Minutes) then
['Chapter'] = strip_apostrophe_markup (coins_chapter), -- Chapter stripped of bold / italic wikimarkup
Position = " " .. Minutes .. " " .. cfg.messages['minutes'];
['Title'] = make_coins_title (coins_title, ScriptTitle), -- Title and ScriptTitle stripped of bold / italic wikimarkup
else
['PublicationPlace'] = PublicationPlace,
local Time = A['Time'];
['Date'] = first_set(COinS_date, Date), -- COinS_date has correctly formatted date if Date is valid; any reason to keep Date here?  Should we be including invalid dates in metadata?
if is_set(Time) then
['Series'] = Series,
local TimeCaption = A['TimeCaption']
['Volume'] = Volume,
if not is_set(TimeCaption) then
['Issue'] = Issue,
TimeCaption = cfg.messages['event'];
['Pages'] = get_coins_pages (first_set(Page, Pages, At)), -- pages stripped of external links
if sepc ~= '.' then
['Edition'] = Edition,
TimeCaption = TimeCaption:lower();
['PublisherName'] = PublisherName,
end
['URL'] = first_set( URL, ChapterURL ),
end
['Authors'] = a,
Position = " " .. TimeCaption .. Time;
['ID_list'] = ID_list,
end
['RawPage'] = this_page.prefixedText,
};
 
-- 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 is_set (PublisherName) then
PublisherName = '[[Newsgroup]]:&nbsp;' .. external_link( 'news:' .. PublisherName, PublisherName );
end
end
else
Position = " " .. Position;
At = '';
end
end
 
 
if not is_set(Page) then
 
if is_set(Pages) then
-- Now perform various field substitutions.
if is_set(Periodical) and
-- We also add leading spaces and surrounding markup and punctuation to the
not inArray(config.CitationClass, {"encyclopaedia","web","book","news","podcast"}) then
-- various parts of the citation, but only when they are non-nil.
Pages = ": " .. Pages;
if not is_set(Authors) then
elseif tonumber(Pages) ~= nil then
local Maximum = tonumber( A['DisplayAuthors'] );
Pages = sepc ..'<span dir="rtl"> ' .. PPrefix .. Pages .. '</span>';
 
else
if is_set (Maximum) then
Pages = sepc ..' <span dir="rtl">' .. PPPrefix .. Pages .. '</span>';
if Maximum >= #a then -- if display-authors value greater than or equal to number of authors
table.insert( z.maintenance_cats, 'CS1 maint: display-authors'); -- add maintenance category because display-authors parameter may be removed
end
end
end
else
if is_set(Periodical) and
not inArray(config.CitationClass, {"encyclopaedia","web","book","news","podcast"}) then
Page = ": " .. Page;
else
else
Maximum = #a + 1; -- number of authors + 1
Page = sepc ..' <span dir="rtl">' .. PPrefix .. Page ..'</span>';
end
end
local control = {
format = NameListFormat, -- empty string or 'vanc'
maximum = Maximum,
lastauthoramp = LastAuthorAmp,
page_name = this_page.text -- get current page name so that we don't wikilink to it via authorlinkn
};
-- If the coauthor field is also used, prevent ampersand and et al. formatting.
if is_set(Coauthors) then
control.lastauthoramp = nil;
control.maximum = #a + 1;
end
Authors = list_people(control, a, author_etal)
end
end
At = is_set(At) and (sepc .. " " .. At) or "";
Position = is_set(Position) and (sepc .. " " .. Position) or "";
if config.CitationClass == 'map' then
local Section = A['Section'];
local Inset = A['Inset'];
if first_set( Pages, Page, At ) ~= nil or sepc ~= '.' then
if is_set( Section ) then
Section = ", " .. wrap_msg ('section', Section, true);
end
if is_set( Inset ) then
Inset = ", " .. wrap_msg ('inset', Inset, true);
end
else
if is_set( Section ) then
Section = sepc .. " " .. wrap_msg ('section', Section, use_lowercase);
if is_set( Inset ) then
Inset = ", " .. wrap_msg ('inset', Inset, true);
end
elseif is_set( Inset ) then
Inset = sepc .. " " .. wrap_msg ('inset', Inset, use_lowercase);
end
end
At = At .. Section .. Inset;
end
if is_set (Language) then
Language = language_parameter (Language, this_page.namespace); -- format, categories (article namespace only), name from ISO639-1, etc
else
Language=""; -- language not specified so make sure this is an empty string;
end
Others = is_set(Others) and (sepc .. " " .. Others) or "";
-- handle type parameter for those CS1 citations that have default values


if not is_set(Authors) and is_set(Coauthors) then -- coauthors aren't displayed if one of authors=, authorn=, or lastn= isn't specified
if inArray(config.CitationClass, {"AV-media-notes", "DVD-notes", "podcast", "pressrelease", "techreport", "thesis"}) then
table.insert( z.message_tail, { set_error('coauthors_missing_author', {}, true) } ); -- emit error message
TitleType = set_titletype (config.CitationClass, TitleType);
if is_set(Degree) and "Thesis" == TitleType then -- special case for cite thesis
TitleType = Degree .. " thesis";
end
end
end


local EditorCount
if is_set(TitleType) then -- if type parameter is specified
if not is_set(Editors) then
TitleType = " (" .. TitleType .. ")"; -- display it in parentheses
local Maximum = tonumber( A['DisplayEditors'] );
end
-- Preserve old-style implicit et al.
if not is_set(Maximum) and #e == 4 then
Maximum = 3;
table.insert( z.message_tail, { set_error('implict_etal_editor', {}, true) } );
elseif not is_set(Maximum) then
Maximum = #e + 1;
end


local control = {
TitleNote = is_set(TitleNote) and (sepc .. " " .. TitleNote) or "";
format = NameListFormat, -- empty string or 'vanc'
Edition = is_set(Edition) and (" " .. wrap_msg ('edition', Edition)) or "";
maximum = Maximum,
Issue = is_set(Issue) and (" (" .. Issue .. ")") or "";
lastauthoramp = LastAuthorAmp,
Series = is_set(Series) and (sepc .. " " .. Series) or "";
page_name = this_page.text -- get current page name so that we don't wikilink to it via editorlinkn
OrigYear = is_set(OrigYear) and (" [" .. OrigYear .. "]") or "";
};
Agency = is_set(Agency) and (sepc .. " " .. Agency) or "";


Editors, EditorCount = list_people(control, e, editor_etal);
if is_set(Volume) then
else
if ( mw.ustring.len(Volume) > 4 )
EditorCount = 1;
  then Volume = sepc .." " .. Volume;
  else Volume = " <b>" .. hyphentodash(Volume) .. "</b>";
end
end
end


-- cite map oddities
------------------------------------ totally unrelated data
local Cartography = "";
if is_set(Via) then
local Scale = "";
Via = " " .. wrap_msg ('via', Via);
if config.CitationClass == "map" then
end
Chapter = A['Map'];
 
ChapterURL = A['MapURL'];
--[[
ChapterURLorigin = A:ORIGIN('MapURL');
Subscription implies paywall; Registration does not.  If both are used in a citation, the subscription required link
ChapterFormat = A['MapFormat'];
note is displayed. There are no error messages for this condition.
 
Cartography = A['Cartography'];
]]
if is_set( Cartography ) then
if is_set(SubscriptionRequired) then
Cartography = sepc .. " " .. wrap_msg ('cartography', Cartography, use_lowercase);
SubscriptionRequired = sepc .. " " .. cfg.messages['subscription']; -- subscription required message
end
elseif is_set(RegistrationRequired) then
Scale = A['Scale'];
SubscriptionRequired = sepc .. " " .. cfg.messages['registration']; -- registration required message
if is_set( Scale ) then
Scale = sepc .. " " .. Scale;
end
end
end
Format = is_set(Format) and " (" .. Format .. ")" or "";


if not is_set(URL) and
if is_set(AccessDate) then
not is_set(ArchiveURL) and
local retrv_text = " " .. cfg.messages['retrieved']
not is_set(ConferenceURL) and -- TODO: keep this here? conference as part of cite web or cite podcast?
is_accesssdate_ok, AccessDateParsed = pcall(local_date, AccessDate, 'j xg Y') -- local canonical format for dates
not is_set(TranscriptURL) then
if is_accesssdate_ok then
AccessDate= AccessDateParsed
-- Test if cite web or cite podcast |url= is missing or empty
end
if in_array(config.CitationClass, {"web","podcast", "mailinglist"}) then
AccessDate = nowrap_date (AccessDate); -- wrap in nowrap span if date in appropriate format
table.insert( z.message_tail, { set_error( 'cite_web_url', {}, true ) } );
if (sepc ~= ".") then retrv_text = retrv_text:lower() end -- if 'citation', lower case
end
AccessDate = substitute (retrv_text, AccessDate); -- add retrieved text
-- neither of these work; don't know why; it seems that substitute() isn't being called
-- Test if accessdate is given without giving a URL
AccessDate = substitute (cfg.presentation['accessdate'], {sepc, AccessDate}); -- allow editors to hide accessdates
if is_set(AccessDate) and not is_set(ChapterURL)then -- ChapterURL may be set when the others are not set; TODO: move this to a separate test?
end
table.insert( z.message_tail, { set_error( 'accessdate_missing_url', {}, true ) } );
AccessDate = '';
if is_set(ID) then ID = sepc .." ".. ID; end
end
  if "thesis" == config.CitationClass and is_set(Docket) then
ID = sepc .." Docket ".. Docket .. ID;
-- Test if format is given without giving a URL
end
if is_set(Format) then
 
Format = Format .. set_error( 'format_missing_url', {'format', 'url'} );
ID_list = buildidlist( ID_list, {DoiBroken = DoiBroken, ASINTLD = ASINTLD, IgnoreISBN = IgnoreISBN, Embargo=Embargo} );
end
 
if is_set(URL) then
URL = " " .. externallink( URL, nil, URLorigin );
end
end


local OriginalURL;
if is_set(Quote) then
DeadURL = DeadURL:lower(); -- used later when assembling archived text
if Quote:sub(1,1) == '"' and Quote:sub(-1,-1) == '"' then
if is_set( ArchiveURL ) then
Quote = Quote:sub(2,-2);
if is_set (URL) then
OriginalURL = URL; -- save copy of original source URL
if 'no' ~= DeadURL then -- if URL set then archive-url applies to it
URL = ArchiveURL -- swap-in the archive's url
URLorigin = A:ORIGIN('ArchiveURL') -- name of archive url parameter for error messages
end
elseif is_set (ChapterURL) then -- URL not set so if chapter-url is set apply archive url to it
OriginalURL = ChapterURL; -- save copy of source chapter's url for archive text
if 'no' ~= DeadURL then
ChapterURL = ArchiveURL -- swap-in the archive's url
URLorigin = A:ORIGIN('ArchiveURL') -- name of archive url parameter for error messages
end
end
end
Quote = sepc .." " .. wrap_style ('quoted-text', Quote ); -- wrap in <q>...</q> tags
PostScript = ""; -- CS1 does not supply terminal punctuation when |quote= is set
end
end
 
if in_array(config.CitationClass, {"web","news","journal","pressrelease","podcast", "newsgroup"}) or
local Archived
('citation' == config.CitationClass and is_set (Periodical) and not is_set (Encyclopedia)) then
if is_set(ArchiveURL) then
if is_set (Chapter) or is_set (TransChapter) or is_set (ChapterURL)then -- chapter parameters not supported for these citation types
if not is_set(ArchiveDate) then
table.insert( z.message_tail, { set_error( 'chapter_ignored', {}, true ) } ); -- add error message
ArchiveDate = seterror('archive_missing_date');
Chapter = ''; -- set to empty string to be safe with concatenation
end
TransChapter = '';
if "no" == DeadURL then
ChapterURL = '';
local arch_text = cfg.messages['archived'];
if sepc ~= "." then arch_text = arch_text:lower() end
Archived = sepc .. " " .. substitute( cfg.messages['archived-not-dead'],
{ externallink( ArchiveURL, arch_text ), ArchiveDate } );
if not is_set(OriginalURL) then
Archived = Archived .. " " .. seterror('archive_missing_url');  
end
end
else -- otherwise, format chapter / article title
elseif is_set(OriginalURL) then
Chapter = format_chapter_title (Chapter, TransChapter, ChapterURL, ChapterURLorigin);
local arch_text = cfg.messages['archived-dead'];
if is_set (Chapter) then
if sepc ~= "." then arch_text = arch_text:lower() end
ChapterFormat = is_set(ChapterFormat) and " (" .. ChapterFormat .. ")" or "";
Archived = sepc .. " " .. substitute( arch_text,
if is_set(ChapterFormat) and not is_set (ChapterURL) then -- Test if |chapter-format= is given without giving a |chapter-url=
{ externallink( OriginalURL, cfg.messages['original'] ), ArchiveDate } );
ChapterFormat = ChapterFormat .. set_error( 'format_missing_url', {'chapter-format', 'chapter-url'} );
end
if 'map' == config.CitationClass and is_set (TitleType) then
Chapter = Chapter .. ' (' .. TitleType .. ')';
end
Chapter = Chapter .. ChapterFormat .. sepc .. ' ';
end
end
 
-- Format main title.
if is_set(TitleLink) and is_set(Title) then
Title = "[[" .. TitleLink .. "|" .. Title .. "]]"
end
 
if in_array(config.CitationClass, {"web","news","journal","pressrelease","podcast", "newsgroup", "mailinglist"}) or
('citation' == config.CitationClass and is_set (Periodical) and not is_set (Encyclopedia)) or
('map' == config.CitationClass and is_set (Periodical)) 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 = wrap_style ('quoted-title', Title);
Title = script_concatenate (Title, ScriptTitle); -- <bdi> tags, lang atribute, categorization, etc; must be done after title is wrapped
TransTitle= wrap_style ('trans-quoted-title', TransTitle );
elseif 'report' == config.CitationClass then -- no styling for cite report
Title = script_concatenate (Title, ScriptTitle); -- <bdi> tags, lang atribute, 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
else
Title = wrap_style ('italic-title', Title);
Title = script_concatenate (Title, ScriptTitle); -- <bdi> tags, lang atribute, categorization, etc; must be done after title is wrapped
TransTitle = wrap_style ('trans-italic-title', TransTitle);
end
 
TransError = "";
if is_set(TransTitle) then
if is_set(Title) then
TransTitle = " " .. TransTitle;
else
else
TransError = " " .. set_error( 'trans_missing_title' );
local arch_text = cfg.messages['archived-missing'];
if sepc ~= "." then arch_text = arch_text:lower() end
Archived = sepc .. " " .. substitute( arch_text,
{ seterror('archive_missing_url'), ArchiveDate } );
end
end
else
Archived = ""
end
end
Title = Title .. TransTitle;
local Lay
if is_set(LayURL) then
if is_set(Title) then
if is_set(LayDate) then LayDate = " (" .. LayDate .. ")" end
if not is_set(TitleLink) and is_set(URL) then  
if is_set(LaySource) then  
Title = external_link( URL, Title ) .. TransError .. Format  
LaySource = " &ndash; ''" .. safeforitalics(LaySource) .. "''";
URL = "";
else
Format = "";
LaySource = "";
end
if sepc == '.' then
Lay = sepc .. " " .. externallink( LayURL, cfg.messages['lay summary'] ) .. LaySource .. LayDate
else
else
Title = Title .. TransError;
Lay = sepc .. " " .. externallink( LayURL, cfg.messages['lay summary']:lower() ) .. LaySource .. LayDate
end
end
end
else
 
Lay = "";
if is_set(Place) then
Place = " " .. wrap_msg ('written', Place, use_lowercase) .. sepc .. " ";
end
end
if is_set(Conference) then
if is_set(Transcript) then
if is_set(ConferenceURL) then
if is_set(TranscriptURL) then Transcript = externallink( TranscriptURL, Transcript ); end
Conference = external_link( ConferenceURL, Conference );
elseif is_set(TranscriptURL) then
end
Transcript = externallink( TranscriptURL, nil, TranscriptURLorigin );
Conference = sepc .. " " .. Conference
elseif is_set(ConferenceURL) then
Conference = sepc .. " " .. external_link( ConferenceURL, nil, ConferenceURLorigin );
end
end
if not is_set(Position) then
local Publisher;
local Minutes = A['Minutes'];
if is_set(Periodical) and
if is_set(Minutes) then
not inArray(config.CitationClass, {"encyclopaedia","web","pressrelease","podcast"}) then
Position = " " .. Minutes .. " " .. cfg.messages['minutes'];
if is_set(PublisherName) then
else
if is_set(PublicationPlace) then
local Time = A['Time'];
Publisher = PublicationPlace .. ": " .. PublisherName;
if is_set(Time) then
else
local TimeCaption = A['TimeCaption']
Publisher = PublisherName;
if not is_set(TimeCaption) then
TimeCaption = cfg.messages['event'];
if sepc ~= '.' then
TimeCaption = TimeCaption:lower();
end
end
Position = " " .. TimeCaption .. " " .. Time;
end
end
elseif is_set(PublicationPlace) then
Publisher= PublicationPlace;
else
Publisher = "";
end
end
else
if is_set(PublicationDate) then
Position = " " .. Position;
if is_set(Publisher) then
At = '';
Publisher = Publisher .. ", " .. wrap_msg ('published', PublicationDate);
end
if not is_set(Page) then
if is_set(Pages) then
if is_set(Periodical) and
not in_array(config.CitationClass, {"encyclopaedia","web","book","news","podcast"}) then
Pages = ": " .. Pages;
elseif tonumber(Pages) ~= nil then
Pages = sepc .." " .. PPrefix .. Pages;
else
else
Pages = sepc .." " .. PPPrefix .. Pages;
Publisher = PublicationDate;
end
end
end
if is_set(Publisher) then
Publisher = " (" .. Publisher .. ")";
end
end
else
else
if is_set(Periodical) and
if is_set(PublicationDate) then
not in_array(config.CitationClass, {"encyclopaedia","web","book","news","podcast"}) then
PublicationDate = " (" .. wrap_msg ('published', PublicationDate) .. ")";
Page = ": " .. Page;
end
else
if is_set(PublisherName) then
Page = sepc .." " .. PPrefix .. Page;
if is_set(PublicationPlace) then
Publisher = sepc .. " " .. PublicationPlace .. ": " .. PublisherName .. PublicationDate;
else
Publisher = sepc .. " " .. PublisherName .. PublicationDate;
end
elseif is_set(PublicationPlace) then
Publisher= sepc .. " " .. PublicationPlace .. PublicationDate;
else
Publisher = PublicationDate;
end
end
end
end
At = is_set(At) and (sepc .. " " .. At) or "";
-- Several of the above rely upon detecting this as nil, so do it last.
Position = is_set(Position) and (sepc .. " " .. Position) or "";
if is_set(Periodical) then
if config.CitationClass == 'map' then
if is_set(Title) or is_set(TitleNote) then  
local Section = A['Section'];
Periodical = sepc .. " " .. wrap_style ('italic-title', Periodical, LangCode)
local Sections = A['Sections'];
else
local Inset = A['Inset'];
Periodical = wrap_style ('italic-title', Periodical, LangCode)
if is_set( Inset ) then
Inset = sepc .. " " .. wrap_msg ('inset', Inset, use_lowercase);
end
 
if is_set( Sections ) then
Section = sepc .. " " .. wrap_msg ('sections', Sections, use_lowercase);
elseif is_set( Section ) then
Section = sepc .. " " .. wrap_msg ('section', Section, use_lowercase);
end
end
At = At .. Inset .. Section;
end
end


if is_set (Language) then
--[[
Language = language_parameter (Language, this_page.namespace); -- format, categories (article namespace only), name from ISO639-1, etc
Handle the oddity that is cite speech.  This code overrides whatever may be the value assigned to TitleNote (through |department=) and forces it to be " (Speech)" so that
else
the annotation directly follows the |title= parameter value in the citation rather than the |event= parameter value (if provided).
Language=""; -- language not specified so make sure this is an empty string;
]]
if "speech" == config.CitationClass then -- cite speech only
TitleNote = " (Speech)"; -- annotate the citation
if 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
Conference = Conference .. sepc .. " "; -- then add appropriate punctuation to the end of the Conference variable before rendering
end
end
end
end


Others = is_set(Others) and (sepc .. " " .. Others) or "";
-- Piece all bits together at last. Here, all should be non-nil.
-- We build things this way because it is more efficient in LUA
-- not to keep reassigning to the same string variable over and over.


-- handle type parameter for those CS1 citations that have default values
local tcommon
 
if inArray(config.CitationClass, {"journal","citation"}) and is_set(Periodical) then
if in_array(config.CitationClass, {"AV-media-notes", "DVD-notes", "mailinglist", "map", "podcast", "pressrelease", "report", "techreport", "thesis"}) then
if is_set(Others) then Others = Others .. sepc .. " " end
TitleType = set_titletype (config.CitationClass, TitleType);
tcommon = safejoin( {Others, Title, TitleNote, Conference, Periodical, Format, TitleType, Scale, Series,
if is_set(Degree) and "Thesis" == TitleType then -- special case for cite thesis
Language, Cartography, Edition, Publisher, Agency, Volume, Issue}, sepc );
TitleType = Degree .. " thesis";
else
end
tcommon = safejoin( {Title, TitleNote, Conference, Periodical, Format, TitleType, Scale, Series, Language,
end
Volume, Issue, Others, Cartography, Edition, Publisher, Agency}, sepc );
 
if is_set(TitleType) then -- if type parameter is specified
TitleType = " (" .. TitleType .. ")"; -- display it in parentheses
end
end
 
TitleNote = is_set(TitleNote) and (sepc .. " " .. TitleNote) or "";
if #ID_list > 0 then
Edition = is_set(Edition) and (" " .. wrap_msg ('edition', Edition)) or "";
ID_list = safejoin( { sepc .. " ",  table.concat( ID_list, sepc .. " " ), ID }, sepc );
Issue = is_set(Issue) and (" (" .. Issue .. ")") or "";
else
Series = is_set(Series) and (sepc .. " " .. Series) or "";
ID_list = ID;
OrigYear = is_set(OrigYear) and (" [" .. OrigYear .. "]") or "";
end
Agency = is_set(Agency) and (sepc .. " " .. Agency) or "";
 
local idcommon = safejoin( { ID_list, URL, Archived, AccessDate, Via, SubscriptionRequired, Lay, Quote }, sepc );
if is_set(Volume) then
local text;
if ( mw.ustring.len(Volume) > 4 )
local pgtext = Position .. Page .. Pages .. At;
  then Volume = sepc .." " .. Volume;
-- local canonical format for dates
  else Volume = " <b>" .. hyphen_to_dash(Volume) .. "</b>";
if is_set(Date) then
IsValidDate, LocalDate = pcall(local_date, Date, DateFormat)
if IsValidDate then
Date =  mw.ustring.format( '<span style="direction:rtl;unicode-bidi:embed;">%s</span>', LocalDate)
end
end
end
end
 
if is_set(Authors) then
------------------------------------ totally unrelated data
if is_set(Coauthors) then
if is_set(Via) then
Authors = Authors .. A['AuthorSeparator'] .. " " .. Coauthors
Via = " " .. wrap_msg ('via', Via);
end
end
if is_set(Date) then
 
Date = " ("..Date..")" .. OrigYear .. sepc .. " "
--[[
elseif string.sub(Authors,-1,-1) == sepc then
Subscription implies paywall; Registration does not. If both are used in a citation, the subscription required link
Authors = Authors .. " "
note is displayed. There are no error messages for this condition.
else
 
Authors = Authors .. sepc .. " "
]]
end
if in_array(SubscriptionRequired:lower(), {'yes', 'true', 'y'}) then
if is_set(Editors) then
SubscriptionRequired = sepc .. " " .. cfg.messages['subscription']; -- subscription required message
local in_text = " ";
elseif in_array(RegistrationRequired:lower(), {'yes', 'true', 'y'}) then
local post_text = "";
SubscriptionRequired = sepc .. " " .. cfg.messages['registration']; -- registration required message
if is_set(Chapter) then
else
in_text = in_text .. cfg.messages['in'] .. " "
SubscriptionRequired = ''; -- either or both might be set to something other than yes true y
else
end
if EditorCount <= 1 then
 
post_text = ", " .. cfg.messages['editor'];
if is_set(AccessDate) then
else
local retrv_text = " " .. cfg.messages['retrieved']
post_text = ", " .. cfg.messages['editors'];
 
end
AccessDate = nowrap_date (AccessDate); -- wrap in nowrap span if date in appropriate format
end
if (sepc ~= ".") then retrv_text = retrv_text:lower() end -- if 'citation', lower case
if (sepc ~= '.') then in_text = in_text:lower() end
AccessDate = substitute (retrv_text, AccessDate); -- add retrieved text
Editors = in_text .. Editors .. post_text;
-- neither of these work; don't know why; it seems that substitute() isn't being called
if (string.sub(Editors,-1,-1) == sepc)
AccessDate = substitute (cfg.presentation['accessdate'], {sepc, AccessDate}); -- allow editors to hide accessdates
then Editors = Editors .. " "
end
else Editors = Editors .. sepc .. " "
end
if is_set(ID) then ID = sepc .." ".. ID; end
  if "thesis" == config.CitationClass and is_set(Docket) then
ID = sepc .." Docket ".. Docket .. ID;
end
  if "report" == config.CitationClass and is_set(Docket) then -- for cite report when |docket= is set
ID = sepc .. ' ' .. Docket; -- overwrite ID even if |id= is set
end
 
ID_list = build_id_list( ID_list, {DoiBroken = DoiBroken, ASINTLD = ASINTLD, IgnoreISBN = IgnoreISBN, Embargo=Embargo} );
 
if is_set(URL) then
URL = " " .. external_link( URL, nil, URLorigin );
end
 
if is_set(Quote) then
if Quote:sub(1,1) == '"' and Quote:sub(-1,-1) == '"' then
Quote = Quote:sub(2,-2);
end
end
Quote = sepc .." " .. wrap_style ('quoted-text', Quote ); -- wrap in <q>...</q> tags
text = safejoin( {Authors, Date, Chapter, Place, Editors, tcommon }, sepc );
PostScript = ""; -- CS1 does not supply terminal punctuation when |quote= is set
text = safejoin( {text, pgtext, idcommon}, sepc );
end
elseif is_set(Editors) then
if is_set(Date) then
local Archived
if EditorCount <= 1 then
if is_set(ArchiveURL) then
Editors = Editors .. ", " .. cfg.messages['editor'];
if not is_set(ArchiveDate) then
else
ArchiveDate = set_error('archive_missing_date');
Editors = Editors .. ", " .. cfg.messages['editors'];
end
Date = " (" .. Date ..")" .. OrigYear .. sepc .. " "
else
if EditorCount <= 1 then
Editors = Editors .. " (" .. cfg.messages['editor'] .. ")" .. sepc .. " "
else
Editors = Editors .. " (" .. cfg.messages['editors'] .. ")" .. sepc .. " "
end
end
end
if "no" == DeadURL then
text = safejoin( {Editors, Date, Chapter, Place, tcommon}, sepc );
local arch_text = cfg.messages['archived'];
text = safejoin( {text, pgtext, idcommon}, sepc );
if sepc ~= "." then arch_text = arch_text:lower() end
else
Archived = sepc .. " " .. substitute( cfg.messages['archived-not-dead'],
if is_set(Date) then
{ external_link( ArchiveURL, arch_text ), ArchiveDate } );
if ( string.sub(tcommon,-1,-1) ~= sepc )
if not is_set(OriginalURL) then
  then Date = sepc .." " .. Date .. OrigYear
Archived = Archived .. " " .. set_error('archive_missing_url');  
  else Date = " " .. Date .. OrigYear
end
end
elseif is_set(OriginalURL) then
end
local arch_text = cfg.messages['archived-dead'];
if config.CitationClass=="journal" and is_set(Periodical) then
if sepc ~= "." then arch_text = arch_text:lower() end
text = safejoin( {Chapter, Place, tcommon}, sepc );
Archived = sepc .. " " .. substitute( arch_text,
text = safejoin( {text, pgtext, Date, idcommon}, sepc );
{ external_link( OriginalURL, cfg.messages['original'] ), ArchiveDate } );
else
else
local arch_text = cfg.messages['archived-missing'];
text = safejoin( {Chapter, Place, tcommon, Date}, sepc );
if sepc ~= "." then arch_text = arch_text:lower() end
text = safejoin( {text, pgtext, idcommon}, sepc );
Archived = sepc .. " " .. substitute( arch_text,  
{ set_error('archive_missing_url'), ArchiveDate } );
end
end
else
Archived = ""
end
end
local Lay
if is_set(PostScript) and PostScript ~= sepc then
if is_set(LayURL) then
text = safejoin( {text, sepc}, sepc );  --Deals with italics, spaces, etc.
if is_set(LayDate) then LayDate = " (" .. LayDate .. ")" end
text = text:sub(1,-sepc:len()-1);
if is_set(LaySource) then
-- text = text:sub(1,-2); --Remove final separator (assumes that sepc is only one character)
LaySource = " &ndash; ''" .. safe_for_italics(LaySource) .. "''";
end
else
LaySource = "";
text = safejoin( {text, PostScript}, sepc );
end
 
if sepc == '.' then
-- Now enclose the whole thing in a <span/> element
Lay = sepc .. " " .. external_link( LayURL, cfg.messages['lay summary'] ) .. LaySource .. LayDate
local options = {};
else
Lay = sepc .. " " .. external_link( LayURL, cfg.messages['lay summary']:lower() ) .. LaySource .. LayDate
if is_set(config.CitationClass) and config.CitationClass ~= "citation" then
end
options.class = "citation " .. config.CitationClass;
else
else
Lay = "";
options.class = "citation";
end
end
if is_set(Transcript) then
if is_set(Ref) and Ref:lower() ~= "none" then
if is_set(TranscriptURL) then Transcript = external_link( TranscriptURL, Transcript ); end
local id = Ref
elseif is_set(TranscriptURL) then
if ( "harv" == Ref ) then
Transcript = external_link( TranscriptURL, nil, TranscriptURLorigin );
local names = {} --table of last names & year
end
if #a > 0 then
for i,v in ipairs(a) do
local Publisher;
names[i] = v.last
if is_set(Periodical) and
if i == 4 then break end
not in_array(config.CitationClass, {"encyclopaedia","web","pressrelease","podcast"}) then
end
if is_set(PublisherName) then
elseif #e > 0 then
if is_set(PublicationPlace) then
for i,v in ipairs(e) do
Publisher = PublicationPlace .. ": " .. PublisherName;
names[i] = v.last
else
if i == 4 then break end
Publisher = PublisherName; 
end
end
end
elseif is_set(PublicationPlace) then
names[ #names + 1 ] = first_set(Year, anchor_year); -- Year first for legacy citations
Publisher= PublicationPlace;
id = anchorid(names)
else
Publisher = "";
end
if is_set(PublicationDate) then
if is_set(Publisher) then
Publisher = Publisher .. ", " .. wrap_msg ('published', PublicationDate);
else
Publisher = PublicationDate;
end
end
if is_set(Publisher) then
Publisher = " (" .. Publisher .. ")";
end
end
options.id = id;
end
if string.len(text:gsub("<span[^>/]*>.-</span>", ""):gsub("%b<>","")) <= 2 then
z.error_categories = {};
text = seterror('empty_citation');
z.message_tail = {};
end
if is_set(options.id) then
text = '<span id="' .. mw.uri.anchorEncode(options.id) ..'" class="' .. mw.text.nowiki(options.class) .. '">' .. text .. "</span>";
else
else
if is_set(PublicationDate) then
text = '<span class="' .. mw.text.nowiki(options.class) .. '">' .. text .. "</span>";
PublicationDate = " (" .. wrap_msg ('published', PublicationDate) .. ")";
end
 
local empty_span = '<span style="display:none;">&nbsp;</span>';
-- Note: Using display: none on then COinS span breaks some clients.
local OCinS = '<span title="' .. OCinSoutput .. '" class="Z3988">' .. empty_span .. '</span>';
text = text .. OCinS;
if #z.message_tail ~= 0 then
text = text .. " ";
for i,v in ipairs( z.message_tail ) do
if is_set(v[1]) then
if i == #z.message_tail then
text = text .. errorcomment( v[1], v[2] );
else
text = text .. errorcomment( v[1] .. "; ", v[2] );
end
end
end
end
if is_set(PublisherName) then
end
if is_set(PublicationPlace) then
Publisher = sepc .. " " .. PublicationPlace .. ": " .. PublisherName .. PublicationDate;
no_tracking_cats = no_tracking_cats:lower();
else
local iserror = false -- our code
Publisher = sepc .. " " .. PublisherName .. PublicationDate;
if inArray(no_tracking_cats, {"", "no", "false", "n"}) then
end
for _, v in ipairs( z.error_categories ) do
elseif is_set(PublicationPlace) then
text = text .. '[[Category:' .. v ..']]';
Publisher= sepc .. " " .. PublicationPlace .. PublicationDate;
iserror = true -- our code
else
end
Publisher = PublicationDate;
for _, v in ipairs( z.maintenance_cats ) do -- append maintenance categories
text = text .. '[[Category:' .. v ..']]';
iserror = true -- our code
end
for _, v in ipairs( z.properties_cats ) do -- append maintenance categories
text = text .. '[[Category:' .. v ..']]';
-- iserror = true -- our code
end
end
end
end
if iserror
then text = text .. "[[קטגוריה:שגיאות ציטוט]]" end -- our code
-- Several of the above rely upon detecting this as nil, so do it last.
return text
if is_set(Periodical) then
end
if is_set(Title) or is_set(TitleNote) then
Periodical = sepc .. " " .. wrap_style ('italic-title', Periodical)
else
Periodical = wrap_style ('italic-title', Periodical)
end
end


--[[
-- This is used by templates such as {{cite book}} to create the actual citation text.
Handle the oddity that is cite speech.  This code overrides whatever may be the value assigned to TitleNote (through |department=) and forces it to be " (Speech)" so that
function z.citation(frame)
the annotation directly follows the |title= parameter value in the citation rather than the |event= parameter value (if provided).
globalframe = frame
]]
local pframe = frame:getParent()
if "speech" == config.CitationClass then -- cite speech only
TitleNote = " (Speech)"; -- annotate the citation
if 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
Conference = Conference .. sepc .. " "; -- then add appropriate punctuation to the end of the Conference variable before rendering
end
end
end
 
-- Piece all bits together at last.  Here, all should be non-nil.
-- We build things this way because it is more efficient in LUA
-- not to keep reassigning to the same string variable over and over.
 
local tcommon
if in_array(config.CitationClass, {"journal","citation"}) and is_set(Periodical) then
if is_set(Others) then Others = Others .. sepc .. " " end
tcommon = safe_join( {Others, Title, TitleNote, Conference, Periodical, Format, TitleType, Series,
Language, Edition, Publisher, Agency, Volume, Issue}, sepc );
elseif 'map' == config.CitationClass then -- special cases for cite map
if 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 );
elseif is_set (Periodical) then -- map in a periodical
tcommon = safe_join( {Title, TitleType, Format, Periodical, Scale, Series, Language, Cartography, Others, Publisher, Volume, Issue}, sepc );
else -- a sheet or stand-alone map
tcommon = safe_join( {Title, TitleType, Format, Edition, Scale, Series, Language, Cartography, Others, Publisher}, sepc );
end
else -- all other CS1 templates
tcommon = safe_join( {Title, TitleNote, Conference, Periodical, Format, TitleType, Series, Language,
Volume, Issue, Others, Edition, Publisher, Agency}, sepc );
end
if #ID_list > 0 then
ID_list = safe_join( { sepc .. " ",  table.concat( ID_list, sepc .. " " ), ID }, sepc );
else
ID_list = ID;
end
local idcommon = safe_join( { ID_list, URL, Archived, AccessDate, Via, SubscriptionRequired, Lay, Quote }, sepc );
local text;
local pgtext = Position .. Page .. Pages .. At;
if is_set(Authors) then
if is_set(Coauthors) then
local sep = '; ';
if 'vanc' == NameListFormat then
sep = ', ';
end
Authors = Authors .. sep .. Coauthors;
end
if is_set(Date) then
Date = " ("..Date..")" .. OrigYear .. sepc .. " "
elseif string.sub(Authors,-1,-1) == sepc then
Authors = Authors .. " "
else
Authors = Authors .. sepc .. " "
end
if is_set(Editors) then
local in_text = " ";
local post_text = "";
if is_set(Chapter) then
in_text = in_text .. cfg.messages['in'] .. " "
else
if EditorCount <= 1 then
post_text = ", " .. cfg.messages['editor'];
else
post_text = ", " .. cfg.messages['editors'];
end
end
if (sepc ~= '.') then in_text = in_text:lower() end
Editors = in_text .. Editors .. post_text;
if (string.sub(Editors,-1,-1) == sepc)
then Editors = Editors .. " "
else Editors = Editors .. sepc .. " "
end
end
text = safe_join( {Authors, Date, Chapter, Place, Editors, tcommon }, sepc );
text = safe_join( {text, pgtext, idcommon}, sepc );
elseif is_set(Editors) then
if is_set(Date) then
if EditorCount <= 1 then
Editors = Editors .. ", " .. cfg.messages['editor'];
else
Editors = Editors .. ", " .. cfg.messages['editors'];
end
Date = " (" .. Date ..")" .. OrigYear .. sepc .. " "
else
if EditorCount <= 1 then
Editors = Editors .. " (" .. cfg.messages['editor'] .. ")" .. sepc .. " "
else
Editors = Editors .. " (" .. cfg.messages['editors'] .. ")" .. sepc .. " "
end
end
text = safe_join( {Editors, Date, Chapter, Place, tcommon}, sepc );
text = safe_join( {text, pgtext, idcommon}, sepc );
else
if is_set(Date) then
if ( string.sub(tcommon,-1,-1) ~= sepc )
  then Date = sepc .." " .. Date .. OrigYear
  else Date = " " .. Date .. OrigYear
end
end
if config.CitationClass=="journal" and is_set(Periodical) then
text = safe_join( {Chapter, Place, tcommon}, sepc );
text = safe_join( {text, pgtext, Date, idcommon}, sepc );
else
text = safe_join( {Chapter, Place, tcommon, Date}, sepc );
text = safe_join( {text, pgtext, idcommon}, sepc );
end
end
if is_set(PostScript) and PostScript ~= sepc then
text = safe_join( {text, sepc}, sepc );  --Deals with italics, spaces, etc.
text = text:sub(1,-sepc:len()-1);
end
text = safe_join( {text, PostScript}, sepc );
 
-- Now enclose the whole thing in a <span/> element
local options = {};
if is_set(config.CitationClass) and config.CitationClass ~= "citation" then
options.class = "citation " .. config.CitationClass;
else
options.class = "citation";
end
if is_set(Ref) and Ref:lower() ~= "none" then
local id = Ref
if ( "harv" == Ref ) then
local names = {} --table of last names & year
if #a > 0 then
for i,v in ipairs(a) do
names[i] = v.last
if i == 4 then break end
end
elseif #e > 0 then
for i,v in ipairs(e) do
names[i] = v.last
if i == 4 then break end
end
end
names[ #names + 1 ] = first_set(Year, anchor_year); -- Year first for legacy citations and for YMD dates that require disambiguation
id = anchor_id(names)
end
options.id = id;
end
if string.len(text:gsub("<span[^>/]*>.-</span>", ""):gsub("%b<>","")) <= 2 then
z.error_categories = {};
text = set_error('empty_citation');
z.message_tail = {};
end
if is_set(options.id) then
text = '<span id="' .. mw.uri.anchorEncode(options.id) ..'" class="' .. mw.text.nowiki(options.class) .. '">' .. text .. "</span>";
else
text = '<span class="' .. mw.text.nowiki(options.class) .. '">' .. text .. "</span>";
end
 
local empty_span = '<span style="display:none;">&nbsp;</span>';
-- Note: Using display: none on then COinS span breaks some clients.
local OCinS = '<span title="' .. OCinSoutput .. '" class="Z3988">' .. empty_span .. '</span>';
text = text .. OCinS;
if #z.message_tail ~= 0 then
text = text .. " ";
for i,v in ipairs( z.message_tail ) do
if is_set(v[1]) then
if i == #z.message_tail then
text = text .. error_comment( v[1], v[2] );
else
text = text .. error_comment( v[1] .. "; ", v[2] );
end
end
end
end
 
if #z.maintenance_cats ~= 0 then
text = text .. ' <span class="citation-comment" style="display:none; color:#33aa33">';
for _, v in ipairs( z.maintenance_cats ) do -- append maintenance categories
text = text .. v .. ' ([[:Category:' .. v ..'|link]])';
end
text = text .. '</span>'; -- maintenance mesages (realy just the names of the categories for now)
end
no_tracking_cats = no_tracking_cats:lower();
if nil ~= string.find( frame:getTitle(), 'sandbox', 1, true ) then -- did the {{#invoke:}} use sandbox version?
if in_array(no_tracking_cats, {"", "no", "false", "n"}) then
cfg = mw.loadData( 'Module:Citation/CS1/Configuration/sandbox' ); -- load sandbox versions of Configuration and Whitelist and ...
for _, v in ipairs( z.error_categories ) do
whitelist = mw.loadData( 'Module:Citation/CS1/Whitelist/sandbox' );
text = text .. '[[Category:' .. v ..']]';
dates = require('Module:Citation/CS1/Date_validation/sandbox').dates -- ... sandbox version of date validation code
end
else -- otherwise
for _, v in ipairs( z.maintenance_cats ) do -- append maintenance categories
cfg = mw.loadData( 'Module:Citation/CS1/Configuration' ); -- load live versions of Configuration and Whitelist and ...
text = text .. '[[Category:' .. v ..']]';
whitelist = mw.loadData( 'Module:Citation/CS1/Whitelist' );
end
dates = require('Module:Citation/CS1/Date_validation').dates -- ... live version of date validation code
for _, v in ipairs( z.properties_cats ) do -- append maintenance categories
text = text .. '[[Category:' .. v ..']]';
end
end
end
return text
end
-- This is used by templates such as {{cite book}} to create the actual citation text.
function z.citation(frame)
local pframe = frame:getParent()
local validation;
if nil ~= string.find (frame:getTitle(), 'sandbox', 1, true) then -- did the {{#invoke:}} use sandbox version?
cfg = mw.loadData ('Module:Citation/CS1/Configuration/sandbox'); -- load sandbox versions of Configuration and Whitelist and ...
whitelist = mw.loadData ('Module:Citation/CS1/Whitelist/sandbox');
validation = require ('Module:Citation/CS1/Date_validation/sandbox'); -- ... sandbox version of date validation code
else -- otherwise
cfg = mw.loadData ('Module:Citation/CS1/Configuration'); -- load live versions of Configuration and Whitelist and ...
whitelist = mw.loadData ('Module:Citation/CS1/Whitelist');
validation = require ('Module:Citation/CS1/Date_validation'); -- ... live version of date validation code
end
dates = validation.dates; -- imported functions
year_date_check = validation.year_date_check;
local args = {};
local args = {};
local suggestions = {};
local suggestions = {};
שורה 2,828: שורה 2,674:
-- 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 = seterror( 'text_ignored', {v}, true );
end
end
elseif validate( k:lower() ) then  
elseif validate( k:lower() ) then  
error_text, error_state = set_error( 'parameter_ignored_suggest', {k, k:lower()}, true );
error_text, error_state = seterror( 'parameter_ignored_suggest', {k, k:lower()}, true );
else
else
if #suggestions == 0 then
if #suggestions == 0 then
שורה 2,837: שורה 2,683:
end
end
if suggestions[ k:lower() ] ~= nil then
if suggestions[ k:lower() ] ~= nil then
error_text, error_state = set_error( 'parameter_ignored_suggest', {k, suggestions[ k:lower() ]}, true );
error_text, error_state = seterror( 'parameter_ignored_suggest', {k, suggestions[ k:lower() ]}, true );
else
else
error_text, error_state = set_error( 'parameter_ignored', {k}, true );
error_text, error_state = seterror( 'parameter_ignored', {k}, true );
end
end
end    
end    

גרסה אחרונה מ־11:45, 10 בנובמבר 2020

לעזרה ראו עזרה:שגיאות ציטוט.


-- Copied from English Wikipedia and changed for Hebrew Wikipedia --

local z = {
	error_categories = {};		-- for categorizing citations that contain errors
	error_ids = {};
	message_tail = {};
	maintenance_cats = {};		-- for categorizing citations that aren't erroneous per se, but could use a little work
	properties_cats = {};		-- for categorizing citations based on certain properties, language of source for instance
}


function local_date( date_string, format )
		if format==nil then
			if date_string:match("^%d%d%d%d%-%d%d%-%d%d$") then --year month day format
				format = 'j xg Y'
			elseif date_string:match("^%a+ +[1-9]%d?, +[1-9]%d%d%d%a?$") then -- month day, year
				format = 'j xg Y'
				
			elseif date_string:match("^[1-9]%d? +%a+ +[1-9]%d%d%d%a?$") then						-- day-initial: day month year
				format = 'j xg Y'
			elseif date_string:match("^%a+ +%d%d%d%d%a?$") then							-- month/season year
				format='F Y'
		--list of accepted formats derived from Citation/CS1/Date validation - in case we may want to localize them later
		--elseif date_string:match("^%a+ +[1-9]%d?–[1-9]%d?, +[1-9]%d%d%d%a?$") then				-- month-initial day range: month day–day, year; days are separated by endash
		--elseif date_string:match("^[1-9]%d?–[1-9]%d? +%a+ +[1-9]%d%d%d%a?$") then				-- day-range-initial: day–day month year; days are separated by endash
		--elseif date_string:match("^[1-9]%d? +%a+ – [1-9]%d? +%a+ +[1-9]%d%d%d%a?$") then		-- day initial month-day-range: day month - day month year; uses spaced endash
		--elseif date_string:match("^%a+ +[1-9]%d? – %a+ +[1-9]%d?, +[1-9]%d%d%d?%a?$") then		-- month initial month-day-range: month day – month day, year;  uses spaced endash
		--elseif date_string:match("^[1-9]%d? +%a+ +[1-9]%d%d%d – [1-9]%d? +%a+ +[1-9]%d%d%d%a?$") then		-- day initial month-day-year-range: day month year - day month year; uses spaced endash
		--elseif date_string:match("^%a+ +[1-9]%d?, +[1-9]%d%d%d – %a+ +[1-9]%d?, +[1-9]%d%d%d%a?$") then		-- month initial month-day-year-range: month day, year – month day, year;  uses spaced endash
		--elseif date_string:match("^%a+ +[1-9]%d%d%d–%d%d%a?$") then								-- special case Winter/Summer year-year (YYYY-YY); year separated with unspaced endash
		--elseif date_string:match("^%a+ +[1-9]%d%d%d–[1-9]%d%d%d%a?$") then						-- special case Winter/Summer year-year; year separated with unspaced endash
		--elseif date_string:match("^%a+ +[1-9]%d%d%d% – %a+ +[1-9]%d%d%d%a?$") then				-- month/season year - month/season year; separated by spaced endash
		--elseif date_string:match ("^%a+–%a+ +[1-9]%d%d%d%a?$") then								-- month/season range year; months separated by endash 
		--elseif date_string:match("^[1-9]%d%d%d?–[1-9]%d%d%d?%a?$") then				-- Year range: YYY-YYY or YYY-YYYY or YYYY–YYYY; separated by unspaced endash; 100-9999
		--elseif date_string:match("^[1-9]%d%d%d–%d%d%a?$") then						-- Year range: YYYY–YY; separated by unspaced endash
		--elseif date_string:match("^[1-9]%d%d%d?%a?$") then							-- year; here accept either YYY or YYYY			
			else
				--return date_string
				error('Unsupported format')
			end
		end
		return  mw.getContentLanguage():formatDate(format, date_string)
end

-- Whether variable is set or not
function is_set( var )
	return not (var == nil or var == '');
end

-- First set variable or nil if none
function first_set(...)
	local list = {...};
	for _, var in pairs(list) do
		if is_set( var ) then
			return var;
		end
	end
end

-- Whether needle is in haystack
function inArray( needle, haystack )
	if needle == nil then
		return false;
	end
	for n,v in ipairs( haystack ) do
		if v == needle then
			return n;
		end
	end
	return false;
end

--[[
Categorize and emit an error message when the citation contains one or more deprecated parameters.  Because deprecated parameters (currently |month=,
|coauthor=, and |coauthors=) aren't related to each other and because these parameters may be concatenated into the variables used by |date= and |author#= (and aliases)
details of which parameter caused the error message are not provided.  Only one error message is emitted regardless of the number of deprecated parameters in the citation.
]]
function deprecated_parameter()
	if true ~= Page_in_deprecated_cat then	-- if we haven't been here before then set a 
		Page_in_deprecated_cat=true;		-- sticky flag so that if there are more than one deprecated parameter the category is added only once
		table.insert( z.message_tail, { seterror( 'deprecated_params', {}, true ) } );		-- add error message
	end
end

-- Populates numbered arguments in a message string using an argument table.
function substitute( msg, args )
	return args and mw.message.newRawMessage( msg, args ):plain() or msg;
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.

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

]]

function kern_quotes (str)
	local cap='';
	local cap2='';
	
	cap, cap2 = str:match ("^([\"\'])([^\'].+)");								-- match leading double or single quote but not double single quotes
	if is_set (cap) then
		str = substitute (cfg.presentation['kern-left'], {cap, cap2});
	end

	cap, cap2 = str:match ("^(.+[^\'])([\"\'])$")
	if is_set (cap) then
		str = substitute (cfg.presentation['kern-right'], {cap, cap2});
	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.

At this writing, only |script-title= is supported.  It is anticipated that additional parameters will be created to use this function.

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

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 = mw.language.fetchLanguageName( lang, "he" );						-- 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 inArray (lang, {'ar', 'bs', 'dv', 'el', 'en', 'he', 'fa', 'hy', 'ja', 'ko', 'ku', 'ps', 'ru', 'sd', 'sr', 'th', 'uk', 'ug', 'yi', 'zh'}) then
				table.insert( z.properties_cats, 'ציטוט עם תסריט בשפה זרה ('..name..')');	-- categorize in language-specific categories
			else
				table.insert( z.properties_cats, 'ציטוט משתמש בתסריט בשפה זרה');	-- use this category as a catchall until language-specific category is available
			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.
]]

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 _ S T Y L E >----------------------------------------------------------

Applies styling to various parameters.  Supplied string is wrapped using a message_list configuration taking one
argument; protects italic styled parameters.  Additional text taken from citation_config.presentation - the reason
this function is similar to but separate from wrap_msg().

]]

function wrap_style (key, str, lang)
	if not is_set( str ) then
		return "";
	elseif inArray( key, { 'italic-title', 'trans-italic-title' } ) then
		-- avoid italics for hebrew script
		local isHebrew = mw.ustring.find( str, '[א-ת]' )
		if (is_set(lang) and lang == 'he') or (isHebrew~=nil) then
			return str
		else
			str = '<span dir="auto">'..safeforitalics( str )..'</span>';
		end
	end

	return substitute( cfg.presentation[key], {str} );
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().

]]

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 
		str = substitute( msg, {str} );											-- including template text
		return str;
	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 three chapter parameters: |chapter=, |trans-chapter=, and |chapter-url= into a single Chapter meta-
parameter (chapter_url_source used for error messages).

]]

function format_chapter_title (chapter, transchapter, chapterurl, chapter_url_source)
	local chapter_error = '';
-- our code
	if is_set (transchapter) then
		transchapter = '<span class="mw-content-rtl">' .. transchapter .. "</span>";
	end
-- our code end
	if not is_set (chapter) then
		chapter = '';															-- just to be safe for concatenation
		if is_set (transchapter) then
			chapter = wrap_style ('trans-quoted-title', transchapter);
			chapter_error = " " .. seterror ('trans_missing_chapter');
		end
		if is_set (chapterurl) then
			chapter = externallink (chapterurl, chapter, chapter_url_source);	-- adds bare_url_missing_title error if appropriate
		end
		return chapter .. chapter_error;
	else																		-- here when chapter is set
		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);
		if is_set (transchapter) then
			transchapter = wrap_style ('trans-quoted-title', transchapter);
			chapter = chapter .. ' ' .. transchapter;
		end
		if is_set (chapterurl) then
			chapter = externallink (chapterurl, chapter);						-- adds bare_url_missing_title error if appropriate
		end
	end
	return chapter;
end

--[[
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.
]]
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] = selectone( 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

--[[
Looks for a parameter's name in the whitelist.

Parameters in the whitelist can have three values:
	true - active, supported parameters
	false - deprecated, supported parameters
	nil - unsupported parameters
]]
function validate( name )
	local name = tostring( name );
	local state = whitelist.basic_arguments[ name ];
	
	-- Normal arguments
	if true == state then return true; end		-- valid actively supported parameter
	if false == state then
		deprecated_parameter ();				-- parameter is deprecated but still supported
		return true;
	end
	
	-- Arguments with numbers in them
	name = name:gsub( "%d+", "#" );				-- replace digit(s) with # (last25 becomes last#
	state = whitelist.numbered_arguments[ name ];
	if true == state then return true; end		-- valid actively supported parameter
	if false == state then
		deprecated_parameter ();				-- parameter is deprecated but still supported
		return true;
	end
	
	return false;								-- Not supported because not found or name is set to nil
end

--[[--------------------------< E R R O R C O M M E N T >------------------------------------------------------

Wraps error messages with css markup according to the state of hidden.

]]
function errorcomment( content, hidden )
	return substitute( hidden and cfg.presentation['hidden-error'] or cfg.presentation['visible-error'], content );
end

--[[
Sets an error condition and returns the appropriate error message.  The actual placement
of the error message in the output is the responsibility of the calling function.
]]
function seterror( error_id, arguments, raw, prefix, suffix )
	local error_state = cfg.error_conditions[ error_id ];
	
	prefix = prefix or "";
	suffix = suffix or "";
	
	if error_state == nil then
		error( cfg.messages['undefined_error'] );
	elseif is_set( error_state.category ) then
		table.insert( z.error_categories, error_state.category );
	end
	
	local message = substitute( error_state.message, arguments );
	
	message = "<span dir=ltr class=registered_only>" .. message .. " ([[" .. cfg.messages['help page link'] .. 
		"#" .. error_state.anchor .. "|" ..
		cfg.messages['help page label'] .. "]])" .. "</span>";
	
	z.error_ids[ error_id ] = true;
	if inArray( error_id, { 'bare_url_missing_title', 'trans_missing_title' } )
			and z.error_ids['citation_missing_title'] then
		return '', false;
	end
	
	message = table.concat({ prefix, message, suffix });
	
	if raw == true then
		return message, error_state.hidden;
	end		
		
	return errorcomment( message, error_state.hidden );
end

-- Formats a wiki style external link
function externallinkid(options)
	local url_string = options.id;
	if options.encode == true or options.encode == nil then
		url_string = mw.uri.encode( url_string );
	end
	return mw.ustring.format( '[[%s|%s]]%s[%s%s%s %s]',
		options.link, options.label, options.separator or "&nbsp;",
		options.prefix, url_string, options.suffix or "",
		mw.text.nowiki(options.id)
	);
end

-- Formats a wiki style internal link
function internallinkid(options)
	return mw.ustring.format( '[[%s|%s]]%s[[%s%s%s|%s]]',
		options.link, options.label, options.separator or "&nbsp;",
		options.prefix, options.id, options.suffix or "",
		mw.text.nowiki(options.id)
	);
end

-- Format an external link with error checking
function externallink( URL, label, source )
	local error_str = "";
	if not is_set( label ) then
		label = URL;
		if is_set( source ) then
			error_str = seterror( 'bare_url_missing_title', { wrap_style ('parameter', source) }, false, " " );
		else
			error( cfg.messages["bare_url_no_origin"] );
		end			
	end
	if not checkurl( URL ) then
		error_str = seterror( 'bad_url', {}, false, " " ) .. error_str;
	end
	return table.concat({ "[", URL, " ", safeforurl( label ), "]", error_str });
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.

]]

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

--[[--------------------------< A M A Z O N >------------------------------------------------------------------

Formats a link to Amazon.  Do simple error checking: asin must be mix of 10 numeric or uppercase alpha
characters.  If a mix, first character must be uppercase alpha; if all numeric, asins must be 10-digit
isbn. If 10-digit isbn, add a maintenance category so a bot or awb script can replace |asin= with |isbn=.
Error message if not 10 characters, if not isbn10, if mixed and first character is a digit.

]]

function amazon(id, domain)
	local err_cat = ""

	if not id:match("^[%d%u][%d%u][%d%u][%d%u][%d%u][%d%u][%d%u][%d%u][%d%u][%d%u]$") then
		err_cat =  ' ' .. seterror ('bad_asin');								-- asin is not a mix of 10 uppercase alpha and numeric characters
	else
		if id:match("^%d%d%d%d%d%d%d%d%d%d$") then								-- if 10-digit numeric
			if checkisbn( id ) then												-- see if asin value is isbn10
				table.insert( z.maintenance_cats, "תבנית ציטוט משתמשת בקוד ספר בתור ASIN");	-- add to maint category
			elseif not is_set (err_cat) then
				err_cat =  ' ' .. seterror ('bad_asin');						-- asin is not isbn10
			end
		elseif not id:match("^%u[%d%u]+$") then
			err_cat =  ' ' .. seterror ('bad_asin');							-- asin doesn't begin with uppercase alpha
		end
	end
	if not is_set(domain) then 
		domain = "com";
	elseif inArray (domain, {'jp', 'uk'}) then			-- Japan, United Kingdom
		domain = "co." .. domain;
	elseif inArray (domain, {'au', 'br', 'mx'}) then	-- Australia, Brazil, Mexico
		domain = "com." .. domain;
	end
	local handler = cfg.id_handlers['ASIN'];
	return externallinkid({link = handler.link,
		label=handler.label , prefix="//www.amazon."..domain.."/dp/",id=id,
		encode=handler.encode, separator = handler.separator}) .. err_cat;
end

--[[
format and error check arXiv identifier.  There are two valid forms of the identifier:
the first form, valid only between date codes 9108 and 0703 is:
	arXiv:<archive>.<class>/<date code><number><version>
where:
	<archive> is a string of alpha characters - may be hyphenated; no other punctuation
	<class> is a string of alpha characters - may be hyphenated; no other punctuation
	<date code> is four digits in the form YYMM where YY is the last two digits of the four-digit year and MM is the month number January = 01
		first digit of YY for this form can only 9 and 0
	<number> is a three-digit number
	<version> is a 1 or more digit number preceded with a lowercase v; no spaces (undocumented)
	
the second form, valid from April 2007 is:
	arXiv:<date code>.<number><version>
where:
	<date code> is four digits in the form YYMM where YY is the last two digits of the four-digit year and MM is the month number January = 01
	<number> is a four-digit number
	<version> is a 1 or more digit number preceded with a lowercase v; no spaces
]]

function arxiv (id)
	local handler = cfg.id_handlers['ARXIV'];
	local year, month, version;
	local err_cat = ""
	
	year, month, version = id:match("^%a[%a%.%-]+/([90]%d)([01]%d)%d%d%d([v%d]*)$");				-- test for the 9108-0703 format
	if not year then		-- arXiv id is not proper 9108-0703 form
		year, month, version = id:match("^(%d%d)([01]%d)%.%d%d%d%d([v%d]*)$");	-- test for the 0704- format
		if not year then	
			err_cat = ' ' .. seterror( 'bad_arxiv' );							-- arXiv id doesn't match either format
		else	-- id is the 0704- format
			year = tonumber(year);
			month = tonumber(month);
			if ((7 > year) or (1 > month and 12 < month)) or					-- is year invalid or is month invalid? (doesn't test for future years)
				((7 == year) and (4 > month)) or								-- when year is 07, is month invalid (before April)?
				is_set (version) and nil == version:match("v%d+") then			-- is version proper format of single 'v' followed by digits?
					err_cat = ' ' .. seterror( 'bad_arxiv' );					-- set error message
			end
		end
	else	-- id is the 9108-0703 format; are the date values ok
		year = tonumber(year);
		month = tonumber(month);
		if ((91 > year and 7 < year) or (1 > month and 12 < month)) or			-- if invalid year or invalid month
			((91 == year and 8 > month) or (7 == year and 3 < month)) or 		-- if years ok, are starting and ending months ok?
				is_set (version) and nil == version:match("v%d+") then			-- is version proper format of single 'v' followed by digits?
					err_cat = ' ' .. seterror( 'bad_arxiv' );					-- set error message
		end
	end

	return externallinkid({link = handler.link, label = handler.label,
			prefix=handler.prefix,id=id,separator=handler.separator, encode=handler.encode}) .. err_cat;
end

--[[
lccn normalization (http://www.loc.gov/marc/lccn-namespace.html#normalization)
1. Remove all blanks.
2. If there is a forward slash (/) in the string, remove it, and remove all characters to the right of the forward slash.
3. If there is a hyphen in the string:
	a. Remove it.
	b. Inspect the substring following (to the right of) the (removed) hyphen. Then (and assuming that steps 1 and 2 have been carried out):
		1. All these characters should be digits, and there should be six or less. (not done in this function)
		2. If the length of the substring is less than 6, left-fill the substring with zeroes until the length is six.

Returns a normalized lccn for lccn() to validate.  There is no error checking (step 3.b.1) performed in this function.
]]

function normalize_lccn (lccn)
	lccn = lccn:gsub ("%s", "");									-- 1. strip whitespace

	if nil ~= string.find (lccn,'/') then
		lccn = lccn:match ("(.-)/");								-- 2. remove forward slash and all character to the right of it
	end

	local prefix
	local suffix
	prefix, suffix = lccn:match ("(.+)%-(.+)");						-- 3.a remove hyphen by splitting the string into prefix and suffix

	if nil ~= suffix then											-- if there was a hyphen
		suffix=string.rep("0", 6-string.len (suffix)) .. suffix;	-- 3.b.2 left fill the suffix with 0s if suffix length less than 6
		lccn=prefix..suffix;										-- reassemble the lccn
	end
	
	return lccn;
	end

--[[
Format LCCN link and do simple error checking.  LCCN is a character string 8-12 characters long. The length of the LCCN dictates the character type of the first 1-3 characters; the
rightmost eight are always digits. http://info-uri.info/registry/OAIHandler?verb=GetRecord&metadataPrefix=reg&identifier=info:lccn/

length = 8 then all digits
length = 9 then lccn[1] is lower case alpha
length = 10 then lccn[1] and lccn[2] are both lower case alpha or both digits
length = 11 then lccn[1] is lower case alpha, lccn[2] and lccn[3] are both lower case alpha or both digits
length = 12 then lccn[1] and lccn[2] are both lower case alpha

]]
function lccn(lccn)
	local handler = cfg.id_handlers['LCCN'];
	local err_cat =  '';								-- presume that LCCN is valid
	local id = lccn;									-- local copy of the lccn

	id = normalize_lccn (id);							-- get canonical form (no whitespace, hyphens, forward slashes)
	local len = id:len();								-- get the length of the lccn

	if 8 == len then
		if id:match("[^%d]") then						-- if LCCN has anything but digits (nil if only digits)
			err_cat = ' ' .. seterror( 'bad_lccn' );	-- set an error message
		end
	elseif 9 == len then								-- LCCN should be adddddddd
		if nil == id:match("%l%d%d%d%d%d%d%d%d") then			-- does it match our pattern?
			err_cat = ' ' .. seterror( 'bad_lccn' );	-- set an error message
		end
	elseif 10 == len then								-- LCCN should be aadddddddd or dddddddddd
		if id:match("[^%d]") then							-- if LCCN has anything but digits (nil if only digits) ...
			if nil == id:match("^%l%l%d%d%d%d%d%d%d%d") then	-- ... see if it matches our pattern
				err_cat = ' ' .. seterror( 'bad_lccn' );	-- no match, set an error message
			end
		end
	elseif 11 == len then								-- LCCN should be aaadddddddd or adddddddddd
		if not (id:match("^%l%l%l%d%d%d%d%d%d%d%d") or id:match("^%l%d%d%d%d%d%d%d%d%d%d")) then	-- see if it matches one of our patterns
			err_cat = ' ' .. seterror( 'bad_lccn' );	-- no match, set an error message
		end
	elseif 12 == len then								-- LCCN should be aadddddddddd
		if not id:match("^%l%l%d%d%d%d%d%d%d%d%d%d") then	-- see if it matches our pattern
			err_cat = ' ' .. seterror( 'bad_lccn' );	-- no match, set an error message
		end
	else
		err_cat = ' ' .. seterror( 'bad_lccn' );		-- wrong length, set an error message
	end

	if not is_set (err_cat) and nil ~= lccn:find ('%s') then
		err_cat = ' ' .. seterror( 'bad_lccn' );		-- lccn contains a space, set an error message
	end

	return externallinkid({link = handler.link, label = handler.label,
			prefix=handler.prefix,id=lccn,separator=handler.separator, encode=handler.encode}) .. err_cat;
end

--[[
Format PMID and do simple error checking.  PMIDs are sequential numbers beginning at 1 and counting up.  This code checks the PMID to see that it
contains only digits and is less than test_limit; the value in local variable test_limit will need to be updated periodically as more PMIDs are issued.
]]
function pmid(id)
	local test_limit = 30000000;						-- update this value as PMIDs approach
	local handler = cfg.id_handlers['PMID'];
	local err_cat =  '';								-- presume that PMID is valid
	
	if id:match("[^%d]") then							-- if PMID has anything but digits
		err_cat = ' ' .. seterror( 'bad_pmid' );		-- set an error message
	else												-- PMID is only digits
		local id_num = tonumber(id);					-- convert id to a number for range testing
		if 1 > id_num or test_limit < id_num then		-- if PMID is outside test limit boundaries
			err_cat = ' ' .. seterror( 'bad_pmid' );	-- set an error message
		end
	end
	
	return externallinkid({link = handler.link, label = handler.label,
			prefix=handler.prefix,id=id,separator=handler.separator, encode=handler.encode}) .. err_cat;
end

--[[
Determines if a PMC identifier's online version is embargoed. Compares the date in |embargo= against today's date.  If embargo date is
in the future, returns true; otherwise, returns false because the embargo has expired or |embargo= not set in this cite.
]]
function is_embargoed(embargo)
	if is_set(embargo) then
		local lang = mw.getContentLanguage();
		local good1, embargo_date, good2, todays_date;
		good1, embargo_date = pcall( lang.formatDate, lang, 'U', embargo );
		good2, todays_date = pcall( lang.formatDate, lang, 'U' );
	
		if good1 and good2 and tonumber( embargo_date ) >= tonumber( todays_date ) then	--is embargo date is in the future?
			return true;	-- still embargoed
		end
	end
	return false;			-- embargo expired or |embargo= not set
end

--[[
Format a PMC, do simple error checking, and check for embargoed articles.

The embargo parameter takes a date for a value. If the embargo date is in the future
the PMC identifier will not be linked to the article.  If the embargo specifies a date in the past, or if it is empty or omitted, then
the PMC identifier is linked to the article through the link at cfg.id_handlers['PMC'].prefix.

PMCs are sequential numbers beginning at 1 and counting up.  This code checks the PMC to see that it contains only digits and is less
than test_limit; the value in local variable test_limit will need to be updated periodically as more PMCs are issued.
]]
function pmc(id, embargo)
	local test_limit = 6000000;							-- update this value as PMCs approach
	local handler = cfg.id_handlers['PMC'];
	local err_cat =  '';								-- presume that PMC is valid
	
	local text;

	if id:match("[^%d]") then							-- if PMC has anything but digits
		err_cat = ' ' .. seterror( 'bad_pmc' );			-- set an error message
	else												-- PMC is only digits
		local id_num = tonumber(id);					-- convert id to a number for range testing
		if 1 > id_num or test_limit < id_num then		-- if PMC is outside test limit boundaries
			err_cat = ' ' .. seterror( 'bad_pmc' );		-- set an error message
		end
	end
	
	if is_embargoed(embargo) then
		text="[[" .. handler.link .. "|" .. handler.label .. "]]:" .. handler.separator .. id .. err_cat;	--still embargoed so no external link
	else
		text = externallinkid({link = handler.link, label = handler.label,			--no embargo date, ok to link to article
			prefix=handler.prefix,id=id,separator=handler.separator, encode=handler.encode}) .. err_cat;
	end
	return text;
end

-- Formats a DOI and checks for DOI errors.

-- DOI names contain two parts: prefix and suffix separated by a forward slash.
--  Prefix: directory indicator '10.' followed by a registrant code
--  Suffix: character string of any length chosen by the registrant

-- This function checks a DOI name for: prefix/suffix.  If the doi name contains spaces or endashes,
-- or, if it ends with a period or a comma, this function will emit a bad_doi error message.

-- DOI names are case-insensitive and can incorporate any printable Unicode characters so the test for spaces, endash,
-- and terminal punctuation may not be technically correct but it appears, that in practice these characters are rarely if ever used in doi names.

function doi(id, inactive)
	local cat = ""
	local handler = cfg.id_handlers['DOI'];
	
	local text;
	if is_set(inactive) then
		local inactive_year = inactive:match("%d%d%d%d") or '';		-- try to get the year portion from the inactive date
		text = "[[" .. handler.link .. "|" .. handler.label .. "]]:" .. id;
		if is_set(inactive_year) then
			table.insert( z.error_categories, "פרמטר DOI לא בתוקף משנת " .. inactive_year );
		else
			table.insert( z.error_categories, "תבנית ציטוט עם בעיות בתוקף ה-DOI" );	-- when inactive doesn't contain a recognizable year
		end
		inactive = " (" .. cfg.messages['inactive'] .. " " .. inactive .. ")" 
	else 
		text = externallinkid({link = handler.link, label = handler.label,
			prefix=handler.prefix,id=id,separator=handler.separator, encode=handler.encode})
		inactive = "" 
	end

	if nil == id:match("^10%.[^%s–]-/[^%s–]-[^%.,]$") then	-- doi must begin with '10.', must contain a fwd slash, must not contain spaces or endashes, and must not end with period or comma
		cat = ' ' .. seterror( 'bad_doi' );
	end
	return text .. inactive .. cat 
end

-- Formats an OpenLibrary link, and checks for associated errors.
function openlibrary(id)
	local code = id:match("^%d+([AMW])$");					-- only digits followed by 'A', 'M', or 'W'
	local handler = cfg.id_handlers['OL'];

	if ( code == "A" ) then
		return externallinkid({link=handler.link, label=handler.label,
			prefix="http://openlibrary.org/authors/OL",id=id, separator=handler.separator,
			encode = handler.encode})
	elseif ( code == "M" ) then
		return externallinkid({link=handler.link, label=handler.label,
			prefix="http://openlibrary.org/books/OL",id=id, separator=handler.separator,
			encode = handler.encode})
	elseif ( code == "W" ) then
		return externallinkid({link=handler.link, label=handler.label,
			prefix= "http://openlibrary.org/works/OL",id=id, separator=handler.separator,
			encode = handler.encode})
	else
		return externallinkid({link=handler.link, label=handler.label,
			prefix= "http://openlibrary.org/OL",id=id, separator=handler.separator,
			encode = handler.encode}) .. 
			' ' .. seterror( 'bad_ol' );
	end
end

--[[
Validate and format an issn.  This code fixes the case where an editor has included an ISSN in the citation but has separated the two groups of four
digits with a space.  When that condition occurred, the resulting link looked like this:

	|issn=0819 4327 gives: [http://www.worldcat.org/issn/0819 4327 0819 4327]  -- can't have spaces in an external link
	
This code now prevents that by inserting a hyphen at the issn midpoint.  It also validates the issn for length and makes sure that the checkdigit agrees
with the calculated value.  Incorrect length (8 digits), characters other than 0-9 and X, or checkdigit / calculated value mismatch will all cause a check issn
error message.  The issn is always displayed with a hyphen, even if the issn was given as a single group of 8 digits.
]]
function issn(id)
	local issn_copy = id;		-- save a copy of unadulterated issn; use this version for display if issn does not validate
	local handler = cfg.id_handlers['ISSN'];
	local text;
	local valid_issn = true;

	id=id:gsub( "[%s-–]", "" );									-- strip spaces, hyphens, and endashes from the issn

	if 8 ~= id:len() or nil == id:match( "^%d*X?$" ) then		-- validate the issn: 8 digits long, containing only 0-9 or X in the last position
		valid_issn=false;										-- wrong length or improper character
	else
		valid_issn=is_valid_isxn(id, 8);						-- validate issn
	end

	if true == valid_issn then
		id = string.sub( id, 1, 4 ) .. "-" .. string.sub( id, 5 );	-- if valid, display correctly formatted version
	else
		id = issn_copy;											-- if not valid, use the show the invalid issn with error message
	end
	
	text = externallinkid({link = handler.link, label = handler.label,
		prefix=handler.prefix,id=id,separator=handler.separator, encode=handler.encode})
 
	if false == valid_issn then
		text = text .. ' ' .. seterror( 'bad_issn' )			-- add an error message if the issn is invalid
	end 
	
	return text
end

--[[--------------------------< M E S S A G E _ I D >----------------------------------------------------------

Validate and format a usenet message id.  Simple error checking, looks for 'id-left@id-right' not enclosed in
'<' and/or '>' angle brackets.

]]

function message_id (id)
	local handler = cfg.id_handlers['USENETID'];

	text = externallinkid({link = handler.link, label = handler.label,
		prefix=handler.prefix,id=id,separator=handler.separator, encode=handler.encode})
 
	if not id:match('^.+@.+$') or not id:match('^[^<].*[^>]$')then				-- doesn't have '@' or has one or first or last character is '< or '>'
		text = text .. ' ' .. seterror( 'bad_message_id' )						-- add an error message if the message id is invalid
	end 
	
	return text
end



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

	if "AV-media-notes" == cite_class or "DVD-notes" == cite_class then		-- if this citation is cite AV media notes or cite DVD notes
		return "Media notes";					-- display AV media notes / DVD media notes annotation

	elseif "podcast" == cite_class then			-- if this citation is cite podcast
		return "Podcast";						-- display podcast annotation

	elseif "pressrelease" == cite_class then	-- if this citation is cite press release
		return "Press release";					-- display press release annotation

	elseif "techreport" == cite_class then		-- if this citation is cite techreport
		return "Technical report";				-- display techreport annotation
	
	elseif "thesis" == cite_class then			-- if this citation is cite thesis (degree option handled after this function returns)
			return "Thesis";					-- display simple thesis annotation (without |degree= modification)
	end
end

--[[
Determines whether a URL string is valid

At present the only check is whether the string appears to 
be prefixed with a URI scheme.  It is not determined whether 
the URI scheme is valid or whether the URL is otherwise well 
formed.
]]
function checkurl( url_str )
	-- Protocol-relative or URL scheme
	return url_str:sub(1,2) == "//" or url_str:match( "^[^/]*:" ) ~= nil;
end

-- Removes irrelevant text and dashes from ISBN number
-- Similar to that used for Special:BookSources
function cleanisbn( isbn_str )
	return isbn_str:gsub( "[^-0-9X]", "" );
end

--[[--------------------------< E S C A P E _ L U A _ M A G I C _ C H A R S >----------------------------------

Returns a string where all of lua's magic characters have been escaped.  This is important because functions like
string.gsub() treat their pattern and replace strings as patterns, not literal strings.
]]
function escape_lua_magic_chars (argument)
	argument = argument:gsub("%%", "%%%%");										-- replace % with %%
	argument = argument:gsub("([%^%$%(%)%.%[%]%*%+%-%?])", "%%%1");				-- replace all other lua magic pattern characters
	return argument;
end

--[[--------------------------< S T R I P _ A P O S T R O P H E _ M A R K U P >--------------------------------

Strip wiki italic and bold markup from argument so that it doesn't contaminate COinS metadata.
This function strips common patterns of apostrophe markup.  We presume that editors who have taken the time to
markup a title have, as a result, provided valid markup. When they don't, some single apostrophes are left behind.

]]
function strip_apostrophe_markup (argument)
	if not is_set (argument) then return argument; end

	while true do
		if argument:match ("%'%'%'%'%'") then									-- bold italic (5)
			argument=argument:gsub("%'%'%'%'%'", "");							-- remove all instances of it
		elseif argument:match ("%'%'%'%'") then									-- italic start and end without content (4)
			argument=argument:gsub("%'%'%'%'", "");
		elseif argument:match ("%'%'%'") then									-- bold (3)
			argument=argument:gsub("%'%'%'", "");
		elseif argument:match ("%'%'") then										-- italic (2)
			argument=argument:gsub("%'%'", "");
		else
			break;
		end
	end
	return argument;															-- done
end

--[[--------------------------< M A K E _ C O I N S _ T I T L E >----------------------------------------------

Makes a title for COinS from Title and / or ScriptTitle (or any other name-script pairs)

Apostrophe markup (bold, italics) is stripped from each value so that the COinS metadata isn't correupted with strings
of %27%27...
]]

function make_coins_title (title, script)
	if is_set (title) then
		title = strip_apostrophe_markup (title);								-- strip any apostrophe markup
	else
		title='';																-- if not set, make sure title is an empty string
	end
	if is_set (script) then
		script = script:gsub ('^%l%l%s*:%s*', '');								-- remove language prefix if present (script value may now be empty string)
		script = strip_apostrophe_markup (script);								-- strip any apostrophe markup
	else
		script='';																-- if not set, make sure script is an empty string
	end
	if is_set (title) and is_set (script) then
		script = ' ' .. script;													-- add a space before we concatenate
	end
	return title .. script;														-- return the concatenation
end

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

Extract page numbers from external wikilinks in any of the |page=, |pages=, or |at= parameters for use in COinS.

]]
function get_coins_pages (pages)
	local pattern;
	if not is_set (pages) then return pages; end								-- if no page numbers then we're done
	
	while true do
		pattern = pages:match("%[(%w*:?//[^ ]+%s+)[%w%d].*%]");					-- pattern is the opening bracket, the url and following space(s): "[url "
		if nil == pattern then break; end										-- no more urls
		pattern = escape_lua_magic_chars (pattern);								-- pattern is not a literal string; escape lua's magic pattern characters
		pages = pages:gsub(pattern, "");										-- remove as many instances of pattern as possible
	end
	pages = pages:gsub("[%[%]]", "");											-- remove the brackets
	pages = pages:gsub("–", "-" );							-- replace endashes with hyphens
	pages = pages:gsub("&%w+;", "-" );						-- and replace html entities (&ndash; etc.) with hyphens; do we need to replace numerical entities like &#32; and the like?
	return pages;
end

--[[
ISBN-10 and ISSN validator code calculates checksum across all isbn/issn digits including the check digit. ISBN-13 is checked in checkisbn().
If the number is valid the result will be 0. Before calling this function, issbn/issn must be checked for length and stripped of dashes,
spaces and other non-isxn characters.
]]
function is_valid_isxn (isxn_str, len)
	local temp = 0;
	isxn_str = { isxn_str:byte(1, len) };	-- make a table of bytes
	len = len+1;							-- adjust to be a loop counter
	for i, v in ipairs( isxn_str ) do		-- loop through all of the bytes and calculate the checksum
		if v == string.byte( "X" ) then		-- if checkdigit is X
			temp = temp + 10*( len - i );	-- it represents 10 decimal
		else
			temp = temp + tonumber( string.char(v) )*(len-i);
		end
	end
	return temp % 11 == 0;					-- returns true if calculation result is zero
end

-- Determines whether an ISBN string is valid
function checkisbn( isbn_str )
	if nil ~= isbn_str:match("[^%s-0-9X]") then return false; end		-- fail if isbn_str contains anything but digits, hyphens, or the uppercase X
	isbn_str = isbn_str:gsub( "-", "" ):gsub( " ", "" );	-- remove hyphens and spaces
	local len = isbn_str:len();
 
	if len ~= 10 and len ~= 13 then
		return false;
	end

	if len == 10 then
		if isbn_str:match( "^%d*X?$" ) == nil then return false; end
		return is_valid_isxn(isbn_str, 10);
	else
		local temp = 0;
		if isbn_str:match( "^97[89]%d*$" ) == nil then return false; end	-- isbn13 begins with 978 or 979
		isbn_str = { isbn_str:byte(1, len) };
		for i, v in ipairs( isbn_str ) do
			temp = temp + (3 - 2*(i % 2)) * tonumber( string.char(v) );
		end
		return temp % 10 == 0;
	end
end

-- Gets the display text for a wikilink like [[A|B]] or [[B]] gives B
function removewikilink( str )
	return (str:gsub( "%[%[([^%[%]]*)%]%]", function(l)
		return l:gsub( "^[^|]*|(.*)$", "%1" ):gsub("^%s*(.-)%s*$", "%1");
	end));
end

-- Escape sequences for content that will be used for URL descriptions
function safeforurl( str )
	if str:match( "%[%[.-%]%]" ) ~= nil then 
		table.insert( z.message_tail, { seterror( 'wikilink_in_url', {}, true ) } );
	end
	
	return str:gsub( '[%[%]\n]', {	
		['['] = '&#91;',
		[']'] = '&#93;',
		['\n'] = ' ' } );
end

-- Converts a hyphen to a dash
function hyphentodash( str )
	if not is_set(str) or str:match( "[%[%]{}<>]" ) ~= nil then
		return str;
	end	
	return str:gsub( '-', '–' );
end

-- Protects a string that will be wrapped in wiki italic markup '' ... ''
function safeforitalics( str )
	--[[ Note: We cannot use <i> for italics, as the expected behavior for
	italics specified by ''...'' in the title is that they will be inverted
	(i.e. unitalicized) in the resulting references.  In addition, <i> and ''
	tend to interact poorly under Mediawiki's HTML tidy. ]]
	
	if not is_set(str) then
		return str;
	else
		if str:sub(1,1) == "'" then str = "<span></span>" .. str; end
		if str:sub(-1,-1) == "'" then str = str .. "<span></span>"; end
		
		-- Remove newlines as they break italics.
		return str:gsub( '\n', ' ' );
	end
end

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

TODO: safejoin() has a flaw where it won't remove the duplicate character from a |title= / |url= combination.
This is because by the time we get here, |title=http://somesite.com and |title=Document Title. have been combined:
	[http://somesite.com and ''Document Title.'']
so that now, the last character is not sepc but is ] (unless sepc == ']' which breaks the external link)
]]
function safejoin( tbl, duplicate_char )
	--[[
	Note: we use string functions here, rather than ustring functions.
	
	This has considerably faster performance and should work correctly as 
	long as the duplicate_char is strict ASCII.  The strings
	in tbl may be ASCII or UTF8.
	]]
	
	local str = '';
	local comp = '';
	local end_chr = '';
	local trim;
	for _, value in ipairs( tbl ) do
		if value == nil then value = ''; end
		if str == '' then
			str = value;
		elseif value ~= '' then
			if value:sub(1,1) == '<' then
				-- Special case of values enclosed in spans and other markup.
				comp = value:gsub( "%b<>", "" );
			else
				comp = value;
			end
			
			if comp:sub(1,1) == duplicate_char then
				trim = false;
				end_chr = str:sub(-1,-1);
				-- str = str .. "<HERE(enchr=" .. end_chr.. ")"
				if end_chr == duplicate_char then
					str = str:sub(1,-2);
				elseif end_chr == "'" then
					if str:sub(-3,-1) == duplicate_char .. "''" then
						str = str:sub(1, -4) .. "''";
					elseif str:sub(-5,-1) == duplicate_char .. "]]''" then
						trim = true;
					elseif str:sub(-4,-1) == duplicate_char .. "]''" then
						trim = true;
					end
				elseif end_chr == "]" then
					if str:sub(-3,-1) == duplicate_char .. "]]" then
						trim = true;
					elseif str:sub(-2,-1) == duplicate_char .. "]" then
						trim = true;
					end
				elseif end_chr == " " then
					if str:sub(-2,-1) == duplicate_char .. " " then
						str = str:sub(1,-3);
					end
				end

				if trim then
					if value ~= comp then 
						local dup2 = duplicate_char;
						if dup2:match( "%A" ) then dup2 = "%" .. dup2; end
						
						value = value:gsub( "(%b<>)" .. dup2, "%1", 1 )
					else
						value = value:sub( 2, -1 );
					end
				end
			end
			str = str .. value;
		end
	end
	return str;
end  

-- Attempts to convert names to initials.
function reducetoinitials(first)
	local initials = {}
	local i = 0;										-- counter for number of initials
	for word in string.gmatch(first, "%S+") do
		table.insert(initials, string.sub(word,1,1))	-- Vancouver format does not include full stops.
		i = i + 1;										-- bump the counter 
		if 2 <= i then break; end						-- only two initials allowed in Vancouver system; if 2, quit
	end
	return table.concat(initials)						-- Vancouver format does not include spaces.
end

-- Formats a list of people (e.g. authors / editors) 
function listpeople(control, people)
	local sep = control.sep;
	local namesep = control.namesep
	local format = control.format
	local maximum = control.maximum
	local lastauthoramp = control.lastauthoramp;
	local text = {}
	local etal = false;
	
	if sep:sub(-1,-1) ~= " " then sep = sep .. " " end
	if maximum ~= nil and maximum < 1 then return "", 0; end
	
	for i,person in ipairs(people) do
		if is_set(person.last) then
			local mask = person.mask
			local one
			local sep_one = sep;
			if maximum ~= nil 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 first = reducetoinitials(first) end
					one = one .. namesep .. first 
				end
				if is_set(person.link) and person.link ~= control.page_name then
					one = "[[" .. person.link .. "|" .. one .. "]]"		-- link author/editor if this page is not the author's/editor's page
				end

				if is_set(person.link) and nil ~= person.link:find("//") then one = one .. " " .. seterror( 'bad_authorlink' ) end	-- check for url in author link;
			end
			table.insert( text, one )
			table.insert( text, sep_one )
		end
	end

	local count = #text / 2;
	if count > 0 then 
		if count > 1 and is_set(lastauthoramp) and not etal then
			text[#text-2] = " & ";
		end
		text[#text] = nil; 
	end
	
	local result = table.concat(text) -- construct list
	if etal then 
		local etal_text = cfg.messages['et al'];
		result = result .. " " .. etal_text;
	end
	
	if ( "scap" == format ) then												-- apply smallcaps formatting when authorformat or editorformat set to scap
		result = substitute (cfg.presentation['smallcaps'], result);
	end 
	return result, count
end

-- Generates a CITEREF anchor ID.
function anchorid( options )
	return "CITEREF" .. table.concat( options );
end

--[[
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=.
]]
function extractnames(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 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 = selectone( args, cfg.aliases[list_name .. '-Last'], 'redundant_parameters', i );		-- search through args for name components beginning at 1
		first = selectone( args, cfg.aliases[list_name .. '-First'], 'redundant_parameters', i );
		link = selectone( args, cfg.aliases[list_name .. '-Link'], 'redundant_parameters', i );
		mask = selectone( args, cfg.aliases[list_name .. '-Mask'], 'redundant_parameters', i );

		if first and not last then												-- if there is a firstn without a matching lastn
			table.insert( z.message_tail, { seterror( '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
			names[n] = {last = last, first = first, link = link, mask = mask};	-- add this name to our names list
			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, { seterror( '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;																-- all done, return our list of names
end

-- Populates ID table from arguments using configuration settings
function extractids( args )
	local id_list = {};
	for k, v in pairs( cfg.id_handlers ) do	
		v = selectone( args, v.parameters, 'redundant_parameters' );
		if is_set(v) then id_list[k] = v; end
	end
	return id_list;
end

--[[--------------------------< B U I L D I D L I S T >--------------------------------------------------------
Takes a table of IDs and turns it into a table of formatted ID outputs.

]]
function buildidlist( id_list, options )
	local new_list, handler = {};

	function fallback(k) return { __index = function(t,i) return cfg.id_handlers[k][i] end } end;
	
	for k, v in pairs( id_list ) do
		-- fallback to read-only cfg
		handler = setmetatable( { ['id'] = v }, fallback(k) );
		
		if handler.mode == 'external' then
			table.insert( new_list, {handler.label, externallinkid( handler ) } );
		elseif handler.mode == 'internal' then
			table.insert( new_list, {handler.label, internallinkid( handler ) } );
		elseif handler.mode ~= 'manual' then
			error( cfg.messages['unknown_ID_mode'] );
		elseif k == 'DOI' then
			table.insert( new_list, {handler.label, doi( v, options.DoiBroken ) } );
		elseif k == 'ARXIV' then
			table.insert( new_list, {handler.label, arxiv( v ) } ); 
		elseif k == 'ASIN' then
			table.insert( new_list, {handler.label, amazon( v, options.ASINTLD ) } ); 
		elseif k == 'LCCN' then
			table.insert( new_list, {handler.label, lccn( v ) } );
		elseif k == 'OL' then
			table.insert( new_list, {handler.label, openlibrary( v ) } );
		elseif k == 'PMC' then
			table.insert( new_list, {handler.label, pmc( v, options.Embargo ) } );
		elseif k == 'PMID' then
			table.insert( new_list, {handler.label, pmid( v ) } );
		elseif k == 'ISSN' then
			table.insert( new_list, {handler.label, issn( v ) } );
		elseif k == 'ISBN' then
			local ISBN = internallinkid( handler );
			if not checkisbn( v ) and not is_set(options.IgnoreISBN) then
				ISBN = ISBN .. seterror( 'bad_isbn', {}, false, " ", "" );
			end
			table.insert( new_list, {handler.label, ISBN } );				
		elseif k == 'USENETID' then
			table.insert( new_list, {handler.label, message_id( v ) } );
		else
			error( cfg.messages['unknown_manual_ID'] );
		end
	end
	
	function comp( a, b )	-- used in following table.sort()
		return a[1] < b[1];
	end
	
	table.sort( new_list, comp );
	for k, v in ipairs( new_list ) do
		new_list[k] = v[2];
	end
	
	return new_list;
end
  
-- Chooses one matching parameter from a list of parameters to consider
-- Generates an error if more than one match is present.
function selectone( args, possible, error_condition, index )
	local value = nil;
	local selected = '';
	local error_list = {};
	
	if index ~= nil then index = tostring(index); end
	
	-- Handle special case of "#" replaced by empty string
	if index == '1' then
		for _, v in ipairs( possible ) do
			v = v:gsub( "#", "" );
			if is_set(args[v]) then
				if value ~= nil and selected ~= v then
					table.insert( error_list, v );
				else
					value = args[v];
					selected = v;
				end
			end
		end		
	end
	
	for _, v in ipairs( possible ) do
		if index ~= nil then
			v = v:gsub( "#", index );
		end
		if is_set(args[v]) then
			if value ~= nil and selected ~=  v then
				table.insert( error_list, v );
			else
				value = args[v];
				selected = v;
			end
		end
	end
	
	if #error_list > 0 then
		local error_str = "";
		for _, k in ipairs( error_list ) do
			if error_str ~= "" then error_str = error_str .. cfg.messages['parameter-separator'] end
			error_str = error_str .. wrap_style ('parameter', k);
		end
		if #error_list > 1 then
			error_str = error_str .. cfg.messages['parameter-final-separator'];
		else
			error_str = error_str .. cfg.messages['parameter-pair-separator'];
		end
		error_str = error_str .. wrap_style ('parameter', selected);
		table.insert( z.message_tail, { seterror( error_condition, {error_str}, true ) } );
	end
	
	return value, selected;
end

-- COinS metadata (see <http://ocoins.info/>) allows automated tools to parse
-- the citation information.
function COinS(data)
	if 'table' ~= type(data) or nil == next(data) then
		return '';
	end
	
	local ctx_ver = "Z39.88-2004";
	
	-- treat table strictly as an array with only set values.
	local OCinSoutput = setmetatable( {}, {
		__newindex = function(self, key, value)
			if is_set(value) then
				rawset( self, #self+1, table.concat{ key, '=', mw.uri.encode( removewikilink( value ) ) } );
			end
		end
	});
	
	if is_set(data.Chapter) then
		OCinSoutput.rft_val_fmt = "info:ofi/fmt:kev:mtx:book";
		OCinSoutput["rft.genre"] = "bookitem";
		OCinSoutput["rft.atitle"] = data.Chapter;
		OCinSoutput["rft.btitle"] = data.Title;
	elseif is_set(data.Periodical) then
		OCinSoutput.rft_val_fmt = "info:ofi/fmt:kev:mtx:journal";
		OCinSoutput["rft.genre"] = "article";
		OCinSoutput["rft.jtitle"] = data.Periodical;
		OCinSoutput["rft.atitle"] = data.Title;
	else
		OCinSoutput.rft_val_fmt = "info:ofi/fmt:kev:mtx:book";
		OCinSoutput["rft.genre"] = "book"
		OCinSoutput["rft.btitle"] = data.Title;
	end
	
	OCinSoutput["rft.place"] = data.PublicationPlace;
	OCinSoutput["rft.date"] = data.Date;
	OCinSoutput["rft.series"] = data.Series;
	OCinSoutput["rft.volume"] = data.Volume;
	OCinSoutput["rft.issue"] = data.Issue;
	OCinSoutput["rft.pages"] = data.Pages;
	OCinSoutput["rft.edition"] = data.Edition;
	OCinSoutput["rft.pub"] = data.PublisherName;
	
	for k, v in pairs( data.ID_list ) do
		local id, value = cfg.id_handlers[k].COinS;
		if k == 'ISBN' then value = cleanisbn( v ); else value = v; end
		if string.sub( id or "", 1, 4 ) == 'info' then
			OCinSoutput["rft_id"] = table.concat{ id, "/", v };
		else
			OCinSoutput[ id ] = value;
		end
	end
	
	local last, first;
	for k, v in ipairs( data.Authors ) do
		last, first = v.last, v.first;
		if k == 1 then
			if is_set(last) then
				OCinSoutput["rft.aulast"] = last;
			end
			if is_set(first) then 
				OCinSoutput["rft.aufirst"] = first;
			end
		end
		if is_set(last) and is_set(first) then
			OCinSoutput["rft.au"] = table.concat{ last, ", ", first };
		elseif is_set(last) then
			OCinSoutput["rft.au"] = last;
		end
	end
	
	OCinSoutput.rft_id = data.URL;
	OCinSoutput.rfr_id = table.concat{ "info:sid/", mw.site.server:match( "[^/]*$" ), ":", data.RawPage };
	OCinSoutput = setmetatable( OCinSoutput, nil );
	
	-- sort with version string always first, and combine.
	table.sort( OCinSoutput );
	table.insert( OCinSoutput, 1, "ctx_ver=" .. ctx_ver );  -- such as "Z39.88-2004"
	return table.concat(OCinSoutput, "&");
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 code.  Handles the special case that is Norwegian where
ISO639-1 code 'no' is mapped to language name 'Norwegian Bokmål' by Extention:CLDR.

Returns the language name and associated ISO639-1 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() will return a list of languages that aren't part of ISO639-1. Names that aren't ISO639-1 but that are included
in the list will be found if that name is provided in the |language= parameter.  For example, if |language=Samaritan Aramaic, that name will be
found with the associated code 'sam', not an ISO639-1 code.  When names are found and the associated code is not two characters, this function
returns only the Wikimedia language name.

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

function get_iso639_code (lang)
	if 'Norwegian' == lang then
		return lang, 'no';														-- special case related to Wikimedia remap of code 'no' at Extension:CLDR
	end
	
	local languages = mw.language.fetchLanguageNames('en', '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() then												-- ISO639-1 codes only
				return name;													-- so return the name but not the code
			end
			return name, code;													-- found it, return name to ensure proper capitalization and the ISO639-1 code
		end
	end
	return lang;																-- not valid language; return language in original case and nil for ISO639-1 code
end

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

Get language name from ISO639-1 code value provided.  If a code is valid use the returned name; if not, then use the value that was provided with the language parameter.

There is an exception.  There are three ISO639-1 codes for Norewegian language variants.  There are two official variants: Norwegian Bokmål (code 'nb') and
Norwegian Nynorsk (code 'nn').  The third, code 'no',  is defined by ISO639-1 as 'Norwegian' though in Norway this is pretty much meaningless.  However, it appears
that on enwiki, editors are for the most part unaware of the nb and nn variants (compare page counts for these variants at Category:Articles with non-Hebrew-language external links.

Because Norwegian Bokmål is the most common language variant, Media wiki has been modified to return Norwegian Bokmål for ISO639-1 code 'no'. Here we undo that and
return 'Norwegian' when editors use |language=no.  We presume that editors don't know about the variants or can't descriminate between them.

See Help talk:Citation Style_1#An ISO 639-1 language name test

When |language= contains a valid ISO639-1 code, the page is assigned to the category for that code: Category:Norwegian-language sources (no) if
the page is a mainspace page and the ISO639-1 code is not 'en'.  Similarly, if the  parameter is |language=Norwegian, it will be categorized in the same way.

]]

function language_parameter (lang, namespace)
	local code;			-- the ISO639-1 two character code
	local name;			-- the language name
	local test='';
		
--	if 0 == namespace and (('he' == lang:lower()) or ('hebrew' == lang:lower())) then
--		table.insert (z.maintenance_cats, 'תבנית ציטוט עם ציון עברית בתור שפה זרה');		-- add maintenance category if |language=Hebrew or |language=he in article space
--	end

	if 2 == lang:len() then														-- ISO639-1 language code are 2 characters (fetchLanguageName also supports 3 character codes)
		name = mw.language.fetchLanguageName( lang:lower(), "he" );				-- get ISO 639-1 language name if Language is a proper code
	end

-- our part
if not is_set (name) then
local langs = mw.language.fetchLanguageNames( "en" )
local lang1 = lang:lower()
lang1 = lang1:sub(1, 1):upper() .. lang1:sub(2)
	for k, v in pairs(langs) do
		if lang1 == v
			then name = mw.language.fetchLanguageName( k, "he" )
				 break
		end
	end
end
-- our part end

	if is_set (name) then														-- if Language specified a valid ISO639-1 code
		code = lang:lower();													-- save it
	else
		name, code = get_iso639_code (lang);									-- attempt to get code from name (assign name here so that we are sure of proper capitalization)
	end

-- our part
	if name == 'ויאטנמית'
   		then name = 'וייטנאמית'
   	end
-- our part end
	if is_set (code) then
		if 0 == namespace and 'he' ~= code then									-- is this page main / article space and Hebrew not the language?
			table.insert( z.properties_cats, 'ציטוט מקור בשפה זרה (' .. name .. ')');	-- in main space and not Hebrew: categorize
		end
	else
		table.insert (z.maintenance_cats, 'תבנית ציטוט עם ציון שפה לא מזוהה');	-- add maintenance category when |language= does not appear to be ISO 639-1 language
	end
	return (" " .. wrap_msg ('language', name));								-- wrap with '(in ...)'
end

function restoreDate(inputDate)
return inputDate
-- Until the problem of Month-Year -> Fill Current day will be resolved
--	if inputDate == "" then
--		return ""
--	end
--	return mw.text.trim(globalframe:expandTemplate({title = "זמןמ", args = {'', inputDate, ["שגיאה"] = "ללא"}}));
end

function autoDir(str)
	if str and str ~= '' then
		return '<span dir="auto">' ..str .. '</span>'
	end
	return str
end

function translateEdition(str)
	if str=='1st' then
		return 'ראשונה'
	elseif str=='2nd' then
		return 'שנייה'
	end
	return str
end
--[[--------------------------< C I T A T I O N 0 >------------------------------------------------------------
This is the main function doing the majority of the citation
formatting.
]]
function citation0( config, args)
	--[[ 
	Load Input Parameters
	The argument_wrapper facilitates the mapping of multiple
	aliases to single internal variable.
	]]
	local A = argument_wrapper( args );

	local i 
	local PPrefix = A['PPrefix']
	local PPPrefix = A['PPPrefix']
	if is_set( A['NoPP'] ) then PPPrefix = "" PPrefix = "" end
	
	-- Pick out the relevant fields from the arguments.  Different citation templates
	-- define different field names for the same underlying things.	
	local Authors = A['Authors'];
	local a = extractnames( args, 'AuthorList' );

	local Coauthors = A['Coauthors'];
	local Others = A['Others'];
	local Editors = A['Editors'];
	local e = extractnames( args, 'EditorList' );

	local Year = A['Year'];
	local PublicationDate = restoreDate(A['PublicationDate']);
	local OrigYear = A['OrigYear'];
	local Date = restoreDate(A['Date']);
	local LayDate = restoreDate(A['LayDate']);
	------------------------------------------------- Get title data
	local Title = A['Title'];
	local ScriptTitle = A['ScriptTitle'];
	local BookTitle = A['BookTitle'];
	local Conference = A['Conference'];
	local TransTitle = A['TransTitle'];
	local TitleNote = A['TitleNote'];
	local TitleLink = A['TitleLink'];
	local Chapter = autoDir(A['Chapter']);
	local ChapterLink = A['ChapterLink'];										-- deprecated
	local TransChapter = A['TransChapter'];
	local TitleType = A['TitleType'];
	local Degree = A['Degree'];
	local Docket = A['Docket'];
	local ArchiveURL = A['ArchiveURL'];
	local URL = A['URL']
	local URLorigin = A:ORIGIN('URL');											-- get name of parameter that holds URL
	local ChapterURL = A['ChapterURL'];
	local ChapterURLorigin = A:ORIGIN('ChapterURL');							-- get name of parameter that holds ChapterURL
	local ConferenceURL = A['ConferenceURL'];
	local ConferenceURLorigin = A:ORIGIN('ConferenceURL');						-- get name of parameter that holds ConferenceURL
	local Periodical = A['Periodical'];

	local Series = A['Series'];
	local Volume = A['Volume'];
	local Issue = A['Issue'];
	local Position = '';
	local Page = A['Page'];
	local Pages = hyphentodash( A['Pages'] );	
	local At = A['At'];

	local Edition = translateEdition(A['Edition']);
	local PublicationPlace = autoDir(A['PublicationPlace'])
	local Place = autoDir(A['Place']);
	
	local PublisherName = autoDir(A['PublisherName']);
	local RegistrationRequired = A['RegistrationRequired'];
	local SubscriptionRequired = A['SubscriptionRequired'];
	local Via = A['Via'];
	local AccessDate = restoreDate(A['AccessDate']);
	local ArchiveDate = restoreDate(A['ArchiveDate']);
	local Agency = A['Agency'];
	local DeadURL = A['DeadURL']
	local Language = A['Language'];
	local LangCode = A['Language'];
	local Format = A['Format'];
	local ChapterFormat = A['ChapterFormat'];
	local Ref = A['Ref'];
	local DoiBroken = A['DoiBroken'];
	local ID = A['ID'];
	local ASINTLD = A['ASINTLD'];
	local IgnoreISBN = A['IgnoreISBN'];
	local Embargo = A['Embargo'];

	local ID_list = extractids( args );

	local Quote = A['Quote'];
	local PostScript = A['PostScript'];

	local LayURL = A['LayURL'];
	local LaySource = A['LaySource'];
	local Transcript = A['Transcript'];
	local TranscriptURL = A['TranscriptURL'] 
	local TranscriptURLorigin = A:ORIGIN('TranscriptURL');						-- get name of parameter that holds TranscriptURL
	local sepc = A['Separator'];

	local LastAuthorAmp = A['LastAuthorAmp'];
	local no_tracking_cats = A['NoTracking'];
-- our code start
	local Month = A['Month'];
	LangCode = mw.ustring.gsub( Language, '-.*', '' );
	Language = LangCode;
-- our code end

--these are used by cite interview
	local Callsign = A['Callsign'];
	local City = A['City'];
	local Program = A['Program'];

--local variables that are not cs1 parameters
	local use_lowercase;								-- controls capitalization of certain static text
	local this_page = mw.title.getCurrentTitle();		-- also used for COinS and for language
	local anchor_year;									-- used in the CITEREF identifier
	local COinS_date;									-- used in the COinS metadata

	local IsValidDate, LocalDate
	local DateFormat = nil
-- Set postscript default.
	if not is_set (PostScript) then						-- if |postscript= has not been set (Postscript is nil which is the default for {{citation}}) and
		if (config.CitationClass ~= "citation") then	-- this template is not a citation template
			PostScript = '.';							-- must be a cite xxx template so set postscript to default (period)
		end
	else
		if PostScript:lower() == 'none' then			-- if |postscript=none then
			PostScript = '';							-- no postscript
		end
	end

--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 inArray (this_page.nsText, cfg.uncategorized_namespaces) then
			no_tracking_cats = "true";					-- set no_tracking_cats
		end
	end

-- check for extra |page=, |pages= or |at= parameters. 
	if is_set(Page) then
		if is_set(Pages) or is_set(At) then
			Page = Page .. " " .. seterror('extra_pages');	-- add error message
			Pages = '';										-- unset the others
			At = '';
		end
	elseif is_set(Pages) then
		if is_set(At) then
			Pages = Pages .. " " .. seterror('extra_pages');	-- add error messages
			At = '';											-- unset
		end
	end	

-- both |publication-place= and |place= (|location=) allowed if different
	if not is_set(PublicationPlace) and is_set(Place) then
		PublicationPlace = Place;							-- promote |place= (|location=) to |publication-place
	end
	
	if PublicationPlace == Place then Place = ''; end		-- don't need both if they are the same
	
--[[
Parameter remapping for cite encyclopedia:
When the citation has these parameters:
	|encyclopedia and |title then map |title to |article and |encyclopedia to |title
	|encyclopedia and |article then map |encyclopedia to |title
	|encyclopedia then map |encyclopedia to |title

	|trans_title maps to |trans_chapter when |title is re-mapped
	|url maps to |chapterurl when |title is remapped

All other combinations of |encyclopedia, |title, and |article are not modified
]]
	if ( config.CitationClass == "encyclopaedia" ) then
		if is_set(Periodical) then					-- Periodical is set when |encyclopedia is set
			if is_set(Title) then
				if not is_set(Chapter) then
					Chapter = Title;				-- |encyclopedia and |title are set so map |title to |article and |encyclopedia to |title
					TransChapter = TransTitle;
					ChapterURL = URL;
					Title = Periodical;
					Periodical = '';				-- redundant so unset
					TransTitle = '';				-- redundant so unset
					URL = '';						-- redundant so unset
				end
			else									-- |title not set
				Title = Periodical;					-- |encyclopedia set and |article set or not set so map |encyclopedia to |title
				Periodical = '';					-- redundant so unset
			end
		end
	end

--special cases for citation.
	if (config.CitationClass == "citation") then		-- for citation templates
		if not is_set (Ref) then						-- if |ref= is not set
			Ref = "harv";								-- set default |ref=harv
		end
		if not is_set (sepc) then						-- if |separator= is not set
			sepc = ',';									-- set citation separator to its default (comma)
		end
	else												-- not a citation template
		if not is_set (sepc) then						-- if |separator= has not been set
			sepc = '.';									-- set cite xxx separator to its default (period)
		end
	end
	use_lowercase = ( sepc ~= '.' );					-- used to control capitalization for certain static text

-- check for special case where |separator=none
	if 'none' == sepc:lower() then						-- if |separator=none
		sepc = '';										-- then set it to an empty string
	end

-- Special case for cite techreport.
	if (config.CitationClass == "techreport") then	-- special case for cite techreport
		if is_set(Issue) then						-- cite techreport uses 'number', which other citations aliase to 'issue'
			if not is_set(ID) then					-- can we use ID for the "number"?
				ID = Issue;							-- yes, use it
				Issue = "";							-- unset Issue so that "number" isn't duplicated in the rendered citation or COinS metadata
			else									-- can't use ID so emit error message
				ID = ID .. " " .. seterror('redundant_parameters', '<code>&#124;id=</code> and <code>&#124;number=</code>');
			end
		end	
	end

-- special case for cite interview
	if (config.CitationClass == "interview") then
		if is_set(Program) then
			ID = ' ' .. Program;
		end
		if is_set(Callsign) then
			if is_set(ID) then
				ID = ID .. sepc .. ' ' .. Callsign;
			else
				ID = ' ' .. Callsign;
			end
		end
		if is_set(City) then
			if is_set(ID) then
				ID = ID .. sepc .. ' ' .. City;
			else
				ID = ' ' .. City;
			end
		end

		if is_set(Others) then
			if is_set(TitleType) then
				Others = ' ' .. TitleType .. ' עם ' .. Others;
				TitleType = '';
			else
				Others = ' ' .. 'ראיון עם ' .. Others;
			end
		else
			Others = '(ראיון)';
		end
	end

--Account for the oddity that is {{cite journal}} with |pmc= set and |url= not set
	if config.CitationClass == "journal" and not is_set(URL) and is_set(ID_list['PMC']) then
		if not is_embargoed(Embargo) then
			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=
		end
	end

-- Account for the oddity that is {{cite conference}}, before generation of COinS data.
--TODO: if this is only for {{cite conference}}, shouldn't we be checking? (if config.CitationClass=='conference' then ...)
	if is_set(BookTitle) then
		Chapter = Title;
		ChapterLink = TitleLink;
		TransChapter = TransTitle;
		Title = BookTitle;
		TitleLink = '';
		TransTitle = '';
	end

-- Account for the oddity that is {{cite episode}}, before generation of COinS data.
--[[	-- {{cite episode}} is not currently supported by this module
	if config.CitationClass == "episode" then
		local AirDate = A['AirDate'];
		local SeriesLink = A['SeriesLink'];
		local Season = A['Season'];
		local SeriesNumber = A['SeriesNumber'];
		local Network = A['Network'];
		local Station = A['Station'];
		local s, n = {}, {};
		local Sep = (first_set(A["SeriesSeparator"], A["Separator"]) or "") .. " ";
		
		if is_set(Issue) then table.insert(s, cfg.messages["episode"] .. " " .. Issue); Issue = ''; end
		if is_set(Season) then table.insert(s, cfg.messages["season"] .. " " .. Season); end
		if is_set(SeriesNumber) then table.insert(s, cfg.messages["series"] .. " " .. SeriesNumber); end
		if is_set(Network) then table.insert(n, Network); end
		if is_set(Station) then table.insert(n, Station); end
		
		Date = Date or AirDate;
		Chapter = Title;
		ChapterLink = TitleLink;
		TransChapter = TransTitle;
		Title = Series;
		TitleLink = SeriesLink;
		TransTitle = '';
		
		Series = table.concat(s, Sep);
		ID = table.concat(n, Sep);
	end
-- end of {{cite episode}} stuff]]

-- legacy: promote concatenation of |month=, and |year= to Date if Date not set; or, promote PublicationDate to Date if neither Date nor Year are set.
	if is_set(Date) then
		if is_set (Year) then
			table.insert( z.maintenance_cats, "תבניות ציטוט עם תאריך ושנה בו זמנית");		-- add to maint category
		end
	else
		DateFormat = 'Y'
		Date = Year;						-- promote Year to Date
		Year = nil;							-- make nil so Year as empty string isn't used for CITEREF
		if is_set(Date) then
			if is_set(Month) then
				DateFormat = 'M Y'
				Date = Month .. " " .. Date;
			end
		elseif is_set(PublicationDate) then	-- use PublicationDate when |date= and |year= are not set
			Date = PublicationDate;			-- promote PublicationDate to Date
			PublicationDate = '';			-- unset, no longer needed
		end
	end

	if PublicationDate == Date then PublicationDate = ''; end	-- if PublicationDate is same as Date, don't display in rendered citation


--[[
Go test all of the date-holding parameters for valid MOS:DATE format and make sure that dates are real dates. This must be done before we do COinS because here is where
we get the date used in the metadata.

Date validation supporting code is in Module:Citation/CS1/Date_validation
]]
	anchor_year, COinS_date, error_message = dates({['accessdate']=AccessDate, ['airdate']=AirDate, ['archivedate']=ArchiveDate, ['date']=Date, ['doi_brokendate']=DoiBroken,
		['embargo']=Embargo, ['laydate']=LayDate, ['publicationdate']=PublicationDate, ['year']=Year});
	if is_set(error_message) then
		table.insert( z.message_tail, { seterror( 'bad_date', {error_message}, true ) } );	-- add this error message
	end

-- At this point fields may be nil if they weren't specified in the template use.  We can use that fact.

	-- COinS metadata (see <http://ocoins.info/>) for
	-- automated parsing of citation information.
	-- this is the function call to COinS()
	local OCinSoutput = COinS{
		['Periodical'] = Periodical,
		['Chapter'] = strip_apostrophe_markup (Chapter),						-- Chapter stripped of bold / italic wikimarkup
		['Title'] = make_coins_title (Title, ScriptTitle),						-- Title and ScriptTitle stripped of bold / italic wikimarkup
		['PublicationPlace'] = PublicationPlace,
		['Date'] = first_set(COinS_date, Date),		-- COinS_date has correctly formatted date if Date is valid; any reason to keep Date here?  Should we be including invalid dates in metadata?
		['Series'] = Series,
		['Volume'] = Volume,
		['Issue'] = Issue,
		['Pages'] = get_coins_pages (first_set(Page, Pages, At)),				-- pages stripped of external links
		['Edition'] = Edition,
		['PublisherName'] = PublisherName,
		['URL'] = first_set( URL, ChapterURL ),
		['Authors'] = a,
		['ID_list'] = ID_list,
		['RawPage'] = this_page.prefixedText,
	};
--[[Why is this here?  Why are we mapping Title to Chapter when Periodical is set?
	if is_set(Periodical) and not is_set(Chapter) and is_set(Title) then
		Chapter = Title;
		ChapterLink = TitleLink;
		TransChapter = TransTitle;
		Title = '';
		TitleLink = '';
		TransTitle = '';
	end
]]

-- special case for cite newsgroup.  Do this after COinS because we are modifying Publishername to include som static text
	if 'newsgroup' == config.CitationClass then
		if is_set (PublisherName) then
			PublisherName = '[[Newsgroup]]:&nbsp;' ..  externallink( 'news:' .. PublisherName, PublisherName );
		end
	end



	-- Now perform various field substitutions.
	-- We also add leading spaces and surrounding markup and punctuation to the
	-- various parts of the citation, but only when they are non-nil.
	if not is_set(Authors) then
		local Maximum = tonumber( A['DisplayAuthors'] );

		if is_set (Maximum) then
			if Maximum >= #a then												-- if display-authors value greater than or equal to number of authors
				table.insert( z.maintenance_cats, "תבניות ציטוט עם פחות מחברים מהנדרש");	-- add maintenance category because display-authors parameter may be removed
			end
		else
			Maximum = #a + 1;													-- number of authors + 1
		end

		local control = { 
			sep = A["AuthorSeparator"] .. " ",
			namesep = (first_set(A["AuthorNameSeparator"], A["NameSeparator"]) or "") .. " ",
			format = A["AuthorFormat"],
			maximum = Maximum,
			lastauthoramp = LastAuthorAmp,
			page_name = this_page.text				-- get current page name so that we don't wikilink to it via authorlinkn
		};
		
		-- If the coauthor field is also used, prevent ampersand and et al. formatting.
		if is_set(Coauthors) then
			control.lastauthoramp = nil;
			control.maximum = #a + 1;
		end
		
		Authors = listpeople(control, a) 
	end

-- our code start
if is_set(Month) then
table.insert( z.message_tail, { seterror('deprecated_month', {}, true) } );
end
if is_set(Coauthors) then
table.insert( z.message_tail, { seterror('deprecated_coauthors', {}, true) } );
end
if is_set(ChapterLink) then
table.insert( z.message_tail, { seterror('deprecated_chapterlink', {}, true) } );
end
-- our code end

	if not is_set(Authors) and is_set(Coauthors) then	-- coauthors aren't displayed if one of authors=, authorn=, or lastn= isn't specified
		table.insert( z.message_tail, { seterror('coauthors_missing_author', {}, true) } );	-- emit error message
	end

	local EditorCount
	if not is_set(Editors) then
		local Maximum = tonumber( A['DisplayEditors'] );
		-- Preserve old-style implicit et al.
		if not is_set(Maximum) and #e == 4 then 
			Maximum = 3;
			table.insert( z.message_tail, { seterror('implict_etal_editor', {}, true) } );
		elseif not is_set(Maximum) then
			Maximum = #e + 1;
		end

		local control = { 
			sep = A["EditorSeparator"] .. " ",
			namesep = (first_set(A["EditorNameSeparator"], A["NameSeparator"]) or "") .. " ",
			format = A['EditorFormat'],
			maximum = Maximum,
			lastauthoramp = LastAuthorAmp,
			page_name = this_page.text				-- get current page name so that we don't wikilink to it via editorlinkn
		};

		Editors, EditorCount = listpeople(control, e);
	else
		EditorCount = 1;
	end

	local Cartography = "";
	local Scale = "";
	if config.CitationClass == "map" then
		if not is_set( Authors ) and is_set( PublisherName ) then
			Authors = PublisherName;
			PublisherName = "";
		end
		Cartography = A['Cartography'];
		if is_set( Cartography ) then
			Cartography = sepc .. " " .. wrap_msg ('cartography', Cartography, use_lowercase);
		end		
		Scale = A['Scale'];
		if is_set( Scale ) then
			Scale = sepc .. " " .. Scale;
		end		
	end
	
	Format = is_set(Format) and " (" .. Format .. ")" or "";

	if  not is_set(URL) and
		not is_set(ArchiveURL) and
		not is_set(ConferenceURL) and
		not is_set(TranscriptURL) then
		
		-- Test if cite web or cite podcast |url= is missing or empty 
		if inArray(config.CitationClass, {"web","podcast"}) then	
			table.insert( z.message_tail, { seterror( 'cite_web_url', {}, true ) } );
		end
		
		-- Test if accessdate is given without giving a URL
		if is_set(AccessDate) and not is_set(ChapterURL)then					-- ChapterURL may be set when the others are not set; TODO: move this to a separate test?
			table.insert( z.message_tail, { seterror( 'accessdate_missing_url', {}, true ) } );
			AccessDate = '';
		end
		
		-- Test if format is given without giving a URL
		if is_set(Format) then
			Format = Format .. seterror( 'format_missing_url', {'format', 'url'} );
		end
	end

	-- Test if citation has no title
	if	not is_set(Title) and
		not is_set(Periodical) and
		not is_set(Conference) and
		not is_set(TransTitle) and
		not is_set(ScriptTitle) then
		table.insert( z.message_tail, { seterror( 'citation_missing_title', {}, true ) } );
	end
	

	local OriginalURL;
	DeadURL = DeadURL:lower();													-- used later when assembling archived text
	if is_set( ArchiveURL ) then
		if is_set (URL) then
			OriginalURL = URL;													-- save copy of original source URL
			if 'no' ~= DeadURL then												-- if URL set then archive-url applies to it
				URL = ArchiveURL												-- swap-in the archive's url
				URLorigin = A:ORIGIN('ArchiveURL')								-- name of archive url parameter for error messages
			end
		elseif is_set (ChapterURL) then 										-- URL not set so if chapter-url is set apply archive url to it
			OriginalURL = ChapterURL;											-- save copy of source chapter's url for archive text
			if 'no' ~= DeadURL then
				ChapterURL = ArchiveURL											-- swap-in the archive's url
				URLorigin = A:ORIGIN('ArchiveURL')								-- name of archive url parameter for error messages
			end
		end
	end

	if inArray(config.CitationClass, {"web","news","journal","pressrelease","conference","podcast", "newsgroup"}) or ('citation' == config.CitationClass and is_set (Periodical)) then
		if is_set (Chapter) or is_set (TransChapter) or is_set (ChapterURL)then	-- chapter parameters not supported for these citation types
			table.insert( z.message_tail, { seterror( 'chapter_ignored', {}, true ) } );		-- add error message
			Chapter = '';														-- set to empty string to be safe with concatenation
			TransChapter = '';
			ChapterURL = '';
		end
	else																		-- otherwise, format chapter / article title
		Chapter = format_chapter_title (Chapter, TransChapter, ChapterURL, ChapterURLorigin);
		if is_set (Chapter) then
			ChapterFormat = is_set(ChapterFormat) and " (" .. ChapterFormat .. ")" or "";
			if is_set(ChapterFormat) and not is_set (ChapterURL) then			-- Test if |chapter-format= is given without giving a |chapter-url=
				ChapterFormat = ChapterFormat .. seterror( 'format_missing_url', {'chapter-format', 'chapter-url'} );
			end
			Chapter = Chapter .. ChapterFormat .. sepc .. ' ';
		end
	end

	-- Format main title.
	if is_set(TitleLink) and is_set(Title) then
		Title = "[[" .. TitleLink .. "|" .. Title .. "]]"
	end

	if inArray(config.CitationClass, {"web","news","journal","pressrelease","conference","podcast", "newsgroup"}) or ('citation' == config.CitationClass and is_set (Periodical)) then
		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 = script_concatenate (Title, ScriptTitle);						-- <bdi> tags, lang atribute, categorization, etc; must be done after title is wrapped
		TransTitle= wrap_style ('trans-quoted-title', TransTitle );
	else
		Title = wrap_style ('italic-title', Title);
		Title = script_concatenate (Title, ScriptTitle);						-- <bdi> tags, lang atribute, categorization, etc; must be done after title is wrapped
		TransTitle = wrap_style ('trans-italic-title', TransTitle);
	end

	TransError = "";
	if is_set(TransTitle) then
		if is_set(Title) then
			TransTitle = ' <span class="mw-content-rtl">' .. TransTitle .. "</span>";
		else
			TransError = " " .. seterror( 'trans_missing_title' );
		end
	end
	
	if is_set(Title) then
		-- bidi isolation. ideally we should use here bidi-isolate once browsers supports it properly. 
		Title = mw.ustring.format( '<span style="unicode-bidi:embed;">%s</span>', Title)
	end
	Title = Title .. TransTitle;
	
	if is_set(Title) then
		if not is_set(TitleLink) and is_set(URL) then 
			Title = externallink( URL, Title ) .. TransError .. Format	   
			URL = "";
			Format = "";
		else
			Title = Title .. TransError;
		end
	end

	if is_set(Place) then
		Place = " " .. wrap_msg ('written', Place, use_lowercase) .. sepc .. " ";
	end
	
	if is_set(Conference) then
		if is_set(ConferenceURL) then
			Conference = externallink( ConferenceURL, Conference );
		end
		Conference = sepc .. " " .. Conference
	elseif is_set(ConferenceURL) then
		Conference = sepc .. " " .. externallink( ConferenceURL, nil, ConferenceURLorigin );
	end
	
	if not is_set(Position) then
		local Minutes = A['Minutes'];
		if is_set(Minutes) then
			Position = " " .. Minutes .. " " .. cfg.messages['minutes'];
		else
			local Time = A['Time'];
			if is_set(Time) then
				local TimeCaption = A['TimeCaption']
				if not is_set(TimeCaption) then
					TimeCaption = cfg.messages['event'];
					if sepc ~= '.' then
						TimeCaption = TimeCaption:lower();
					end
				end
				Position = " " .. TimeCaption .. Time;
			end
		end
	else
		Position = " " .. Position;
		At = '';
	end
	
	if not is_set(Page) then
		if is_set(Pages) then
			if is_set(Periodical) and
				not inArray(config.CitationClass, {"encyclopaedia","web","book","news","podcast"}) then
				Pages = ": " .. Pages;
			elseif tonumber(Pages) ~= nil then
				Pages = sepc ..'<span dir="rtl"> ' .. PPrefix .. Pages .. '</span>';
			else
				Pages = sepc ..' <span dir="rtl">' .. PPPrefix .. Pages .. '</span>';
			end
		end
	else
		if is_set(Periodical) and
			not inArray(config.CitationClass, {"encyclopaedia","web","book","news","podcast"}) then
			Page = ": " .. Page;
		else
			Page = sepc ..' <span dir="rtl">' .. PPrefix .. Page ..'</span>';
		end
	end
	
	At = is_set(At) and (sepc .. " " .. At) or "";
	Position = is_set(Position) and (sepc .. " " .. Position) or "";
	if config.CitationClass == 'map' then
		local Section = A['Section'];
		local Inset = A['Inset'];
		if first_set( Pages, Page, At ) ~= nil or sepc ~= '.' then
			if is_set( Section ) then
				Section = ", " .. wrap_msg ('section', Section, true);
			end
			if is_set( Inset ) then
				Inset = ", " .. wrap_msg ('inset', Inset, true);
			end
		else
			if is_set( Section ) then
				Section = sepc .. " " .. wrap_msg ('section', Section, use_lowercase);
				if is_set( Inset ) then
					Inset = ", " .. wrap_msg ('inset', Inset, true);
				end
			elseif is_set( Inset ) then
				Inset = sepc .. " " .. wrap_msg ('inset', Inset, use_lowercase);
			end			
		end			
		At = At .. Section .. Inset;		
	end	

	if is_set (Language) then
		Language = language_parameter (Language, this_page.namespace);			-- format, categories (article namespace only), name from ISO639-1, etc
	else
		Language="";															-- language not specified so make sure this is an empty string;
	end

	Others = is_set(Others) and (sepc .. " " .. Others) or "";

-- handle type parameter for those CS1 citations that have default values

	if inArray(config.CitationClass, {"AV-media-notes", "DVD-notes", "podcast", "pressrelease", "techreport", "thesis"}) then
		TitleType = set_titletype (config.CitationClass, TitleType);
		if is_set(Degree) and "Thesis" == TitleType then	-- special case for cite thesis
			TitleType = Degree .. " thesis";
		end
	end

	if is_set(TitleType) then					-- if type parameter is specified
		TitleType = " (" .. TitleType .. ")";	-- display it in parentheses
	end

	TitleNote = is_set(TitleNote) and (sepc .. " " .. TitleNote) or "";
	Edition = is_set(Edition) and (" " .. wrap_msg ('edition', Edition)) or "";
	Issue = is_set(Issue) and (" (" .. Issue .. ")") or "";
	Series = is_set(Series) and (sepc .. " " .. Series) or "";
	OrigYear = is_set(OrigYear) and (" [" .. OrigYear .. "]") or "";
	Agency = is_set(Agency) and (sepc .. " " .. Agency) or "";

	if is_set(Volume) then
		if ( mw.ustring.len(Volume) > 4 )
		  then Volume = sepc .." " .. Volume;
		  else Volume = " <b>" .. hyphentodash(Volume) .. "</b>";
		end
	end

	------------------------------------ totally unrelated data
	if is_set(Via) then
		Via = " " .. wrap_msg ('via', Via);
	end

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

	if is_set(AccessDate) then
		local retrv_text = " " .. cfg.messages['retrieved']
		is_accesssdate_ok, AccessDateParsed = pcall(local_date, AccessDate, 'j xg Y') -- local canonical format for dates
if is_accesssdate_ok then
AccessDate= AccessDateParsed
end
		AccessDate = nowrap_date (AccessDate);									-- wrap in nowrap span if date in appropriate format
		if (sepc ~= ".") then retrv_text = retrv_text:lower() end				-- if 'citation', lower case
		AccessDate = substitute (retrv_text, AccessDate);						-- add retrieved text
																				-- neither of these work; don't know why; it seems that substitute() isn't being called	
		AccessDate = substitute (cfg.presentation['accessdate'], {sepc, AccessDate});	-- allow editors to hide accessdates
	end
	
	if is_set(ID) then ID = sepc .." ".. ID; end
   	if "thesis" == config.CitationClass and is_set(Docket) then
		ID = sepc .." Docket ".. Docket .. ID;
	end

	ID_list = buildidlist( ID_list, {DoiBroken = DoiBroken, ASINTLD = ASINTLD, IgnoreISBN = IgnoreISBN, Embargo=Embargo} );

	if is_set(URL) then
		URL = " " .. externallink( URL, nil, URLorigin );
	end

	if is_set(Quote) then
		if Quote:sub(1,1) == '"' and Quote:sub(-1,-1) == '"' then
			Quote = Quote:sub(2,-2);
		end
		Quote = sepc .." " .. wrap_style ('quoted-text', Quote ); 				-- wrap in <q>...</q> tags
		PostScript = "";														-- CS1 does not supply terminal punctuation when |quote= is set
	end
	
	local Archived
	if is_set(ArchiveURL) then
		if not is_set(ArchiveDate) then
			ArchiveDate = seterror('archive_missing_date');
		end
		if "no" == DeadURL then
			local arch_text = cfg.messages['archived'];
			if sepc ~= "." then arch_text = arch_text:lower() end
			Archived = sepc .. " " .. substitute( cfg.messages['archived-not-dead'],
				{ externallink( ArchiveURL, arch_text ), ArchiveDate } );
			if not is_set(OriginalURL) then
				Archived = Archived .. " " .. seterror('archive_missing_url');							   
			end
		elseif is_set(OriginalURL) then
			local arch_text = cfg.messages['archived-dead'];
			if sepc ~= "." then arch_text = arch_text:lower() end
			Archived = sepc .. " " .. substitute( arch_text,
				{ externallink( OriginalURL, cfg.messages['original'] ), ArchiveDate } );
		else
			local arch_text = cfg.messages['archived-missing'];
			if sepc ~= "." then arch_text = arch_text:lower() end
			Archived = sepc .. " " .. substitute( arch_text, 
				{ seterror('archive_missing_url'), ArchiveDate } );
		end
	else
		Archived = ""
	end
	
	local Lay
	if is_set(LayURL) then
		if is_set(LayDate) then LayDate = " (" .. LayDate .. ")" end
		if is_set(LaySource) then 
			LaySource = " &ndash; ''" .. safeforitalics(LaySource) .. "''";
		else
			LaySource = "";
		end
		if sepc == '.' then
			Lay = sepc .. " " .. externallink( LayURL, cfg.messages['lay summary'] ) .. LaySource .. LayDate
		else
			Lay = sepc .. " " .. externallink( LayURL, cfg.messages['lay summary']:lower() ) .. LaySource .. LayDate
		end			
	else
		Lay = "";
	end
	
	if is_set(Transcript) then
		if is_set(TranscriptURL) then Transcript = externallink( TranscriptURL, Transcript ); end
	elseif is_set(TranscriptURL) then
		Transcript = externallink( TranscriptURL, nil, TranscriptURLorigin );
	end
	
	local Publisher;
	if is_set(Periodical) and
		not inArray(config.CitationClass, {"encyclopaedia","web","pressrelease","podcast"}) then
		if is_set(PublisherName) then
			if is_set(PublicationPlace) then
				Publisher = PublicationPlace .. ": " .. PublisherName;
			else
				Publisher = PublisherName;  
			end
		elseif is_set(PublicationPlace) then
			Publisher= PublicationPlace;
		else 
			Publisher = "";
		end
		if is_set(PublicationDate) then
			if is_set(Publisher) then
				Publisher = Publisher .. ", " .. wrap_msg ('published', PublicationDate);
			else
				Publisher = PublicationDate;
			end
		end
		if is_set(Publisher) then
			Publisher = " (" .. Publisher .. ")";
		end
	else
		if is_set(PublicationDate) then
			PublicationDate = " (" .. wrap_msg ('published', PublicationDate) .. ")";
		end
		if is_set(PublisherName) then
			if is_set(PublicationPlace) then
				Publisher = sepc .. " " .. PublicationPlace .. ": " .. PublisherName .. PublicationDate;
			else
				Publisher = sepc .. " " .. PublisherName .. PublicationDate;  
			end			
		elseif is_set(PublicationPlace) then 
			Publisher= sepc .. " " .. PublicationPlace .. PublicationDate;
		else 
			Publisher = PublicationDate;
		end
	end
	
	-- Several of the above rely upon detecting this as nil, so do it last.
	if is_set(Periodical) then
		if is_set(Title) or is_set(TitleNote) then 
			Periodical = sepc .. " " .. wrap_style ('italic-title', Periodical, LangCode)
		else 
			Periodical = wrap_style ('italic-title', Periodical, LangCode)
		end
	end

--[[
Handle the oddity that is cite speech.  This code overrides whatever may be the value assigned to TitleNote (through |department=) and forces it to be " (Speech)" so that
the annotation directly follows the |title= parameter value in the citation rather than the |event= parameter value (if provided).
]]
	if "speech" == config.CitationClass then				-- cite speech only
		TitleNote = " (Speech)";							-- annotate the citation
		if 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
				Conference = Conference .. sepc .. " ";		-- then add appropriate punctuation to the end of the Conference variable before rendering
			end
		end
	end

	-- Piece all bits together at last.  Here, all should be non-nil.
	-- We build things this way because it is more efficient in LUA
	-- not to keep reassigning to the same string variable over and over.

	local tcommon
	if inArray(config.CitationClass, {"journal","citation"}) and is_set(Periodical) then
		if is_set(Others) then Others = Others .. sepc .. " " end
		tcommon = safejoin( {Others, Title, TitleNote, Conference, Periodical, Format, TitleType, Scale, Series, 
			Language, Cartography, Edition, Publisher, Agency, Volume, Issue}, sepc );
	else 
		tcommon = safejoin( {Title, TitleNote, Conference, Periodical, Format, TitleType, Scale, Series, Language, 
			Volume, Issue, Others, Cartography, Edition, Publisher, Agency}, sepc );
	end
	
	if #ID_list > 0 then
		ID_list = safejoin( { sepc .. " ",  table.concat( ID_list, sepc .. " " ), ID }, sepc );
	else
		ID_list = ID;
	end
	
	local idcommon = safejoin( { ID_list, URL, Archived, AccessDate, Via, SubscriptionRequired, Lay, Quote }, sepc );
	local text;
	local pgtext = Position .. Page .. Pages .. At;
	-- local canonical format for dates
	if is_set(Date) then
		IsValidDate, LocalDate = pcall(local_date, Date, DateFormat)
		if IsValidDate then
			Date =  mw.ustring.format( '<span style="direction:rtl;unicode-bidi:embed;">%s</span>', LocalDate)
		end
	end
	if is_set(Authors) then
		if is_set(Coauthors) then
			Authors = Authors .. A['AuthorSeparator'] .. " " .. Coauthors
		end
		if is_set(Date) then
			Date = " ("..Date..")" .. OrigYear .. sepc .. " "
		elseif string.sub(Authors,-1,-1) == sepc then
			Authors = Authors .. " "
		else
			Authors = Authors .. sepc .. " "
		end
		if is_set(Editors) then
			local in_text = " ";
			local post_text = "";
			if is_set(Chapter) then
				in_text = in_text .. cfg.messages['in'] .. " "
			else
				if EditorCount <= 1 then
					post_text = ", " .. cfg.messages['editor'];
				else
					post_text = ", " .. cfg.messages['editors'];
				end
			end 
			if (sepc ~= '.') then in_text = in_text:lower() end
			Editors = in_text .. Editors .. post_text;
			if (string.sub(Editors,-1,-1) == sepc)
				then Editors = Editors .. " "
				else Editors = Editors .. sepc .. " "
			end
		end
		text = safejoin( {Authors, Date, Chapter, Place, Editors, tcommon }, sepc );
		text = safejoin( {text, pgtext, idcommon}, sepc );
	elseif is_set(Editors) then
		if is_set(Date) then
			if EditorCount <= 1 then
				Editors = Editors .. ", " .. cfg.messages['editor'];
			else
				Editors = Editors .. ", " .. cfg.messages['editors'];
			end
			Date = " (" .. Date ..")" .. OrigYear .. sepc .. " "
		else
			if EditorCount <= 1 then
				Editors = Editors .. " (" .. cfg.messages['editor'] .. ")" .. sepc .. " "
			else
				Editors = Editors .. " (" .. cfg.messages['editors'] .. ")" .. sepc .. " "
			end
		end
		text = safejoin( {Editors, Date, Chapter, Place, tcommon}, sepc );
		text = safejoin( {text, pgtext, idcommon}, sepc );
	else
		if is_set(Date) then
			if ( string.sub(tcommon,-1,-1) ~= sepc )
			  then Date = sepc .." " .. Date .. OrigYear
			  else Date = " " .. Date .. OrigYear
			end
		end
		if config.CitationClass=="journal" and is_set(Periodical) then
			text = safejoin( {Chapter, Place, tcommon}, sepc );
			text = safejoin( {text, pgtext, Date, idcommon}, sepc );
		else
			text = safejoin( {Chapter, Place, tcommon, Date}, sepc );
			text = safejoin( {text, pgtext, idcommon}, sepc );
		end
	end
	
	if is_set(PostScript) and PostScript ~= sepc then
		text = safejoin( {text, sepc}, sepc );  --Deals with italics, spaces, etc.
		text = text:sub(1,-sepc:len()-1);
--		text = text:sub(1,-2);	--Remove final separator (assumes that sepc is only one character)
	end	
	
	text = safejoin( {text, PostScript}, sepc );

	-- Now enclose the whole thing in a <span/> element
	local options = {};
	
	if is_set(config.CitationClass) and config.CitationClass ~= "citation" then
		options.class = "citation " .. config.CitationClass;
	else
		options.class = "citation";
	end
	
	if is_set(Ref) and Ref:lower() ~= "none" then
		local id = Ref
		if ( "harv" == Ref ) then
			local names = {} --table of last names & year
			if #a > 0 then
				for i,v in ipairs(a) do 
					names[i] = v.last 
					if i == 4 then break end
				end
			elseif #e > 0 then
				for i,v in ipairs(e) do 
					names[i] = v.last 
					if i == 4 then break end				
				end
			end
			names[ #names + 1 ] = first_set(Year, anchor_year);	-- Year first for legacy citations
			id = anchorid(names)
		end
		options.id = id;
	end
	
	if string.len(text:gsub("<span[^>/]*>.-</span>", ""):gsub("%b<>","")) <= 2 then
		z.error_categories = {};
		text = seterror('empty_citation');
		z.message_tail = {};
	end
	
	if is_set(options.id) then 
		text = '<span id="' .. mw.uri.anchorEncode(options.id) ..'" class="' .. mw.text.nowiki(options.class) .. '">' .. text .. "</span>";
	else
		text = '<span class="' .. mw.text.nowiki(options.class) .. '">' .. text .. "</span>";
	end		

	local empty_span = '<span style="display:none;">&nbsp;</span>';
	
	-- Note: Using display: none on then COinS span breaks some clients.
	local OCinS = '<span title="' .. OCinSoutput .. '" class="Z3988">' .. empty_span .. '</span>';
	text = text .. OCinS;
	
	if #z.message_tail ~= 0 then
		text = text .. " ";
		for i,v in ipairs( z.message_tail ) do
			if is_set(v[1]) then
				if i == #z.message_tail then
					text = text .. errorcomment( v[1], v[2] );
				else
					text = text .. errorcomment( v[1] .. "; ", v[2] );
				end
			end
		end
	end
	
	no_tracking_cats = no_tracking_cats:lower();
	local iserror = false -- our code
	if inArray(no_tracking_cats, {"", "no", "false", "n"}) then
		for _, v in ipairs( z.error_categories ) do
			text = text .. '[[Category:' .. v ..']]';
			iserror = true -- our code
		end
		for _, v in ipairs( z.maintenance_cats ) do								-- append maintenance categories
			text = text .. '[[Category:' .. v ..']]';
			iserror = true -- our code
		end
		for _, v in ipairs( z.properties_cats ) do								-- append maintenance categories
			text = text .. '[[Category:' .. v ..']]';
			-- iserror = true -- our code
		end
	end
	if iserror
		then text = text .. "[[קטגוריה:שגיאות ציטוט]]" end -- our code
	
	return text
end

-- This is used by templates such as {{cite book}} to create the actual citation text.
function z.citation(frame)
	globalframe = frame
	local pframe = frame:getParent()
	
	if nil ~= string.find( frame:getTitle(), 'sandbox', 1, true ) then				-- did the {{#invoke:}} use sandbox version?
		cfg = mw.loadData( 'Module:Citation/CS1/Configuration/sandbox' );	-- load sandbox versions of Configuration and Whitelist and ...
		whitelist = mw.loadData( 'Module:Citation/CS1/Whitelist/sandbox' );
		dates = require('Module:Citation/CS1/Date_validation/sandbox').dates	-- ... sandbox version of date validation code
	else																	-- otherwise
		cfg = mw.loadData( 'Module:Citation/CS1/Configuration' );			-- load live versions of Configuration and Whitelist and ...
		whitelist = mw.loadData( 'Module:Citation/CS1/Whitelist' );
		dates = require('Module:Citation/CS1/Date_validation').dates		-- ... live version of date validation code
	end
	
	local args = {};
	local suggestions = {};
	local error_text, error_state;

	local config = {};
	for k, v in pairs( frame.args ) do
		config[k] = v;
		args[k] = v;	   
	end	

	for k, v in pairs( pframe.args ) do
		if v ~= '' then
			if not validate( k ) then			
				error_text = "";
				if type( k ) ~= 'string' then
					-- Exclude empty numbered parameters
					if v:match("%S+") ~= nil then
						error_text, error_state = seterror( 'text_ignored', {v}, true );
					end
				elseif validate( k:lower() ) then 
					error_text, error_state = seterror( 'parameter_ignored_suggest', {k, k:lower()}, true );
				else
					if #suggestions == 0 then
						suggestions = mw.loadData( 'Module:Citation/CS1/Suggestions' );
					end
					if suggestions[ k:lower() ] ~= nil then
						error_text, error_state = seterror( 'parameter_ignored_suggest', {k, suggestions[ k:lower() ]}, true );
					else
						error_text, error_state = seterror( 'parameter_ignored', {k}, true );
					end
				end				  
				if error_text ~= '' then
					table.insert( z.message_tail, {error_text, error_state} );
				end				
			end
			args[k] = v;
		elseif args[k] ~= nil or (k == 'postscript') then
			args[k] = v;
		end		
	end	
	
	return citation0( config, args)
end

return z