Oddworld Library - User contributions [en]

Template:The Oddworld Library:About

2018-10-03T22:05:10Z

Max: Why are underscores being added to the visible text?

The Oddworld Library is a comprehensive source of all things Oddworld. Run by [[Xavier_De_Coster|Xavier De Coster]] and [[Wil_Bunce-Edwards|Wil Bunce-Edwards]], it hosts all kinds of media like images, websites, videos, developer diaries and interviews and also a number of articles about the games, their developers, the fandom and the lore. Despite it's name, it also covers other topics, mostly non-Oddworld projects by [[Oddworld Inhabitants]] and [[Lorne Lanning]], such as [[Citizen Siege]] or [[Xmobb]].

More about the website can be read in it's respective [[Oddworld_Library|article]].

== Sister sites of The Oddworld Library ==
;Oddblog ([https://oddworldlibrary.net/oddblog/ Old]/[https://oddworldlibrary.net/blog/ New])
:OddBlog covered Oddworld news from 2003 to 2014. It is divided between two systems: an archive, that holds all stories made before November 2010, and the newer OddBlog, that holds all stories made since.

;[http://oddworldlibrary.net/toe/Contents?title=index.php The Oddworld Encyclopedia]
:Or ‘'''TOE'''’, hosted articles on Oddworld lore written by Wil. '''All content has been migrated to the wiki.'''

;[https://oddworldlibrary.net/archives/ The Oddworld Archives]
:Or ‘'''TOA'''’, archived many different types of media relating to Oddworld. It was divided into many different subsections, each catering to its own type of media.

;[http://oddworldlibrary.net/archives/togg/ The Oddworld Graphics Gallery]
:Or ‘'''TOGG'''’, originally archived images only, maintained by Xavier. Since 2010 it has also started hosting videos.

;[https://oddworldlibrary.net/archives/cinema/ The Oddworld Cinema]
:Or ‘'''TOC'''’, archived videos only, maintained by Xavier. Since 2010 its content was migrated to TOGG.

;<s>The Oddworld Scriptures</s>
:<s>Or ‘'''TOS'''’, archived texts only, maintained by Wil. These included press interviews, developer diaries, and texts taken from the [[INsOMNIOUS]] version of [[Oddworld.com]]. This content is in the process of being migrated to the wiki.</s> Superseded by [https://magogonthemarch.com/ Magog On The March].

;[https://oddworldlibrary.net/archives/web/ Odd Wide Web]
:Archives a number of different official company and product websites, maintained by Xavier.

;OddTunes
:Archives a number of different official soundtrack releases and music rips from Oddworld games. Does not have its own web pages.

Template:The Oddworld Library:About

2018-10-03T22:02:32Z

Max: This is how we get ants!

The Oddworld Library is a comprehensive source of all things Oddworld. Run by [[Xavier_De_Coster|Xavier De Coster]] and [[Wil_Bunce-Edwards]], it hosts all kinds of media like images, websites, videos, developer diaries and interviews and also a number of articles about the games, their developers, the fandom and the lore. Despite it's name, it also covers other topics, mostly non-Oddworld projects by [[Oddworld Inhabitants]] and [[Lorne Lanning]], such as [[Citizen Siege]] or [[Xmobb]].

More about the website can be read in it's respective [[Oddworld_Library|article]].

== Sister sites of The Oddworld Library ==
;Oddblog ([https://oddworldlibrary.net/oddblog/ Old]/[https://oddworldlibrary.net/blog/ New])
:OddBlog covered Oddworld news from 2003 to 2014. It is divided between two systems: an archive, that holds all stories made before November 2010, and the newer OddBlog, that holds all stories made since.

;[http://oddworldlibrary.net/toe/Contents?title=index.php The Oddworld Encyclopedia]
:Or ‘'''TOE'''’, hosted articles on Oddworld lore written by Wil. '''All content has been migrated to the wiki.'''

;[https://oddworldlibrary.net/archives/ The Oddworld Archives]
:Or ‘'''TOA'''’, archived many different types of media relating to Oddworld. It was divided into many different subsections, each catering to its own type of media.

;[http://oddworldlibrary.net/archives/togg/ The Oddworld Graphics Gallery]
:Or ‘'''TOGG'''’, originally archived images only, maintained by Xavier. Since 2010 it has also started hosting videos.

;[https://oddworldlibrary.net/archives/cinema/ The Oddworld Cinema]
:Or ‘'''TOC'''’, archived videos only, maintained by Xavier. Since 2010 its content was migrated to TOGG.

;<s>The Oddworld Scriptures</s>
:<s>Or ‘'''TOS'''’, archived texts only, maintained by Wil. These included press interviews, developer diaries, and texts taken from the [[INsOMNIOUS]] version of [[Oddworld.com]]. This content is in the process of being migrated to the wiki.</s> Superseded by [https://magogonthemarch.com/ Magog On The March].

;[https://oddworldlibrary.net/archives/web/ Odd Wide Web]
:Archives a number of different official company and product websites, maintained by Xavier.

;OddTunes
:Archives a number of different official soundtrack releases and music rips from Oddworld games. Does not have its own web pages.

Oddworld Library

2018-04-16T19:19:28Z

Max:

'''Oddworld Library''' is an Oddworld [[List of Oddworld fansites|fansite]] created and maintained by [[Wil Bunce-Edwards]] and [[Xavier De Coster]]. It provides an up-to-date archive of media—including images, videos, websites, developer diaries and press interviews—and a number of articles on [[Oddworld]] lore, [[List of Oddworld products|products]] and [[Oddworld fandom|fandom]]. It also covered Oddworld news between 2004 and 2014, including a number of exclusive interviews and media premiers.

Despite its name, Oddworld Library also covers other topics, mostly [[Non-Oddworld projects covered by Oddworld Library|non-Oddworld projects]] by [[Oddworld Inhabitants]] and [[Lorne Lanning]], such as [[Citizen Siege]], and [[Xmobb]].

== History ==
=== Structure ===
Oddworld Library has traditionally been divided into three sections
;OddBlog
:OddBlog covered Oddworld news from 2003 to 2014. It is divided between two systems: the [/oddlog/ archived OddBlog] holds all stories made before November 2010, and the [/blog/ newer OddBlog] holds all stories made since.

;The Oddworld Encyclopedia
:Or ‘'''TOE'''’, hosted articles on Oddworld lore written by Wil. All content has been migrated to the wiki.

;The Oddworld Archives
:Or ‘'''TOA'''’, archived many different types of media relating to Oddworld. It was divided into many different subsections, each catering to its own type of media.

;The Oddworld Graphics Gallery
:Or ‘'''TOGG'''’, originally archived images only, maintained by Xavier. Since 2010 it has also started hosting videos.

;The Oddworld Cinema
:Or ‘'''TOC'''’, archived videos only, maintained by Xavier. Since 2010 its content was migrated to TOGG.

;The Oddworld Scriptures
:Or ‘'''TOS'''’, archived texts only, maintained by Wil. These included press interviews, developer diaries, and texts taken from the [[INsOMNIOUS]] version of [[Oddworld.com]]. This content is in the process of being migrated to the wiki.

;Odd Wide Web
:Archives a number of different official company and product websites, maintained by Xavier.

;OddTunes
:Archives a number of different official soundtrack releases and music rips from Oddworld games. Does not have its own web pages.

== History ==
=== Conception ===
Oddworld Library originated as four separate projects: OddBlog, The Oddworld Encyclopedia, OddBlog, The Oddworld Graphics Gallery and The Oddworld Archives. The first two were created by [[Wil Bunce-Edwards]], and the second two by [[Xavier De Coster]].

Wil first began working on an Oddworld fansite in 2000. His first attempt was a webpage on the early webhosting service Xoom, which he called ‘'''The Kennels'''’. This early incarnation presented visitors with a guided tour of the eponymous Kennels (essentially a zoo of [[List of Oddworld species|Oddworld creatures]] known at the time) led by a conjoined-twin Glukkon named Glasp.<ref name="namedKennels"/> By 2001, the project changed to one more encyclopedic in tone called ‘'''The Scrabacombs'''’,<ref name="namedScrabacombs"/> but by 2002 this was again renamed to ‘The Oddworld Encyclopedia’ to reflect Wil’s nickname on the Oddworld Forums.<ref name="renamedEncyclopedia"/>

Wil created OddBlog on uJournal on 7th August 2003, originally as a personal blog where he would post personal thoughts and updates to the Oddworld Encyclopedia project, leaving actual Oddworld news for an un-yet-unreleased part of the Encyclopedia named the ‘'''News Station'''’.<ref name="oddblogFirstPost"/> However, under the advice of Xavier, he began posting Oddworld development and community news on OddBlog. On 6th December, Xavier began posting on OddBlog, originally on a temporary basis while Wil was absent,<ref name="oddblogXavTemporary"/> but on 16th Dec, Wil announced that Xavier was now a permanent reporter.<ref name="oddblogXavPermanent"/> Xavier had previously been a reporter of Oddworld news on [[Oddworld Maniac]], [[Oddworld News]] and [[Oddworld-Web]]. OddBlog migrated from uJournal to Blogger in January 2004.<ref name="oddblogBlogger"/>

Wil, Xav, and a third member of the Oddworld Forums, Oddsville, who had previously owned the fansite [[Oddville]], began making plans to unite their fansites into one, calling themselves the ‘'''Shaman Network'''’: All three would share OddBlog, Wil would be in charge of The Oddworld Encyclopedia, and Xavier would create an Oddworld image gallery to take over his management of the [[Picture Request Thread]] on the [[Oddworld Forums]]; Oddsville would take responsibility for the fourth part of the Network, a collection of Oddworld press interviews that at the time was named ‘The Oddworld Archives’. However, Oddsville’s involvement in the group diminished and Xavier took over the Archives. Nevertheless, Wil and Xavier persisted in their plan to combine sites, and they eventually settled on the name ‘The Oddworld Library’.

=== Launch ===
Although OddBlog had always been publicly accessible, it was formally launched in February 2004 with the slogan <q>bringing you true bijoux of Oddworld news</q> when it was first announced on the Oddworld Forums and the link was publicly shared.<ref name="oddblogLaunch"/>. Xavier created his image gallery, called ‘'''The Oddworld Graphics Gallery'''’ (or '''TOGG'''), and launched it in February 2005,<ref name="toggLaunch"/> which was followed in September by The Oddworld Archives.<ref name="toaLaunch"/> Despite officially being part of The Oddworld Library, both of Xavier's sites were originally hosted on [[Alcar]]’s fansite, [[Oddworld Universe]], but after that went down in February 2006,<ref name="universeDown"/> TOGG and the Archives moved to the Library’s server within the month.<ref name="toggReturn"/><ref name="toaReturn"/>

The Oddworld Library was officially launched on 1st April 2006 with the opening of The Oddworld Encyclopedia.<ref name="libraryLaunch"/> The first articles on the Encyclopedia were actually a number of [[April Fool's Day|joke articles]] written for April Fool’s Day. These were replaced the following day with 18 genuine articles, collectively branded as ‘[[Wave One]]’, with a ‘[[Wave Two]]’ of 15 additional articles being uploaded on 13th April.

=== First Two Years ===
In October 2006, The Oddworld Archives were taken down and the name reused as an umbrella for TOGG and the Library's newest section, an archive of Oddworld videos called ‘'''The Oddworld Cinema'''’. At the same time, the site was also added to with ‘OddBlog Specials’ where exclusive stories and interviews could be highlighted, the Bulletin Board where site updates would be posted, and syndication feeds for both OddBlog and the Bulletin Board. These simultaneous updates were branded as The Oddworld Library’s first relaunch.<ref name="libraryRelaunch"/>

The Oddworld Forums became a sponsor of the Oddworld Library in January 2008 by adding a link to the fansite at the top of every page, alongside links to the fansites of its owners, [[Abe Babe]]’s [[Oddworld-Web]] and [[Alcar]]’s [[Oddworld Universe]].<ref name="librarySponsor"/>

=== Second Anniversary ===
The Oddworld Library celebrated its second anniversary since its official launch on 1st April 2008. To mark the occasion, its archive of press interviews returned in a new section of The Oddworld Archives, called ‘'''The Oddworld Scriptures'''’, developed by Wil. In addition, although only 1 new article had been published on The Oddworld Encyclopedia since its first month, TOE was updated with 8 new article, 3 navigational pages and 1 updated article. This updated article on [[Fleeches]] was the first to use a reference list of cited sources, and came with a button to hide the inline citations if visitors found them annoying. Wil referred to these updates as <q>the start of a period of increased attention</q> on TOE.<ref name="library2ndAnniversary"/>

=== Third Year ===
In July 2008, two social network accounts were opened for The Oddworld Library: an [https://www.youtube.com/user/TheOddworldCinema Oddworld Cinema YouTube channel] and an [https://twitter.com/OddworldLibrary Oddworld Library Twitter account].<ref name="cinemaYouTubeOWF"/><ref name="cinemaYouTubeOB"/><ref name="libraryTwitter"/>

== References ==
<references>
<ref name="namedKennels">'''Bunce-Edwards, Wil''' <nowiki>[billy_squeek]</nowiki> '''(2 July 2000)'''. ‘[http://games.groups.yahoo.com/group/exoddusclub/message/2451 My Webpage]’. Exoddus Club. Yahoo! Groups.</ref>
<ref name="namedScrabacombs">'''Bunce-Edwards, Wil (22 April 2001)'''. ‘[http://www.oddworldforums.net/showthread.php?t=2722 Coming Soon - The Scrabacombs]’. Oddworld Discussion. Oddworld Forums.</ref>
<ref name="renamedEncyclopedia">'''Bunce-Edwards, Wil (7 April 2002)'''. [http://www.oddworldforums.net/showthread.php?p=58789#post58789 Post 10] in ‘There's more than one Shrink!?’. Oddworld Discussion. Oddworld Forums.</ref>
<ref name="oddblogFirstPost">'''Bunce-Edwards, Wil (17 August 2003)'''. ‘[http://oddworldlibrary.net/oddblog/2003/08/OddBlog_created OddBlog created]’. OddBlog. Oddworld Library.</ref>
<ref name="oddblogXavTemporary"/>'''Bunce-Edwards, Wil (6 December 2003)'''. ‘[http://oddworldlibrary.net/oddblog/2003/12/Xav_joins_OddBlog Xav joins OddBlog]’. OddBlog. Oddworld Library.</ref>
<ref name="oddblogXavPermanent"/>'''Bunce-Edwards, Wil (16 December 2003)'''. ‘[http://oddworldlibrary.net/oddblog/2003/12/Avatars_added Avatars added]’. OddBlog. Oddworld Library.</ref>
<ref name="oddblogBlogger">'''Bunce-Edwards, Wil (22 January 2004)'''. ‘[http://oddworldlibrary.net/oddblog/2004/01/OddBlog_2 OddBlog 2·0]’. OddBlog. Oddworld Library.</ref>

<ref name="oddblogLaunch">'''Bunce-Edwards, Wil (1 February 2004)'''. ‘[http://www.oddworldforums.net/showthread.php?t=9598 OddBlog]’. Oddworld Discussion. Oddworld Forums.</ref>
<ref name="toggLaunch">'''De Coster, Xavier (28 February 2005)'''. ‘[http://www.oddworldforums.net/showthread.php?t=11577 TOGG - Grand opening!]’. Oddworld Discussion. Oddworld Forums.</ref>
<ref name="toaLaunch">'''atusiya@ (2 September 2005)'''. ‘[http://www.oddworldforums.net/showthread.php?t=12699 Xavier 's The Oddworld Archives !!]’. Oddworld Discussion. Oddworld Forums.</ref>
<ref name="universeDown">'''Oddworld Forums members (20–22 February 2006)'''. ‘[http://www.oddworldforums.net/showthread.php?t=13436 What happened????]’. Oddworld Discussion. Oddworld Forums.</ref>
<ref name="toggReturn">'''Bunce-Edwards, Wil (12 March 2006)'''. ‘[http://www.oddworldforums.net/showthread.php?t=13533 The Oddworld Graphics Galliry Returns!]’. Oddworld Discussion. Oddworld Forums.</ref>
<ref name="toaReturn">'''De Coster, Xavier (5 March 2006)'''. ‘[http://www.oddworldforums.net/showthread.php?t=13500 The Oddworld Archives are back]’. Oddworld Discussion. Oddworld Forums.</ref>
<ref name="libraryLaunch">'''Bunce-Edwards, Wil (1 April 2006)'''. ‘[http://www.oddworldforums.net/showthread.php?t=13663 The Oddworld Library - grand opening]’. Oddworld Discussion. Oddworld Forums.</ref>
<ref name="libraryRelaunch">'''Bunce-Edwards, Wil (26 October 2006)'''. ‘[http://www.oddworldforums.net/showthread.php?t=14578 The Oddworld Library Relaunched]’. Oddworld Discussion. Oddworld Forums.</ref>
<ref name="librarySponsor">'''Alcar (15 January 2008)'''. ‘[http://www.oddworldforums.net/showthread.php?t=16485 TOL Sponsorship & Staff Changes]’. Forums Suggestions & Help. Oddworld Forums.</ref>
<ref name="library2ndAnniversary">'''Bunce-Edwards, Wil (1 April 2008)'''. ‘[http://www.oddworldforums.net/showthread.php?t=16809 The TOL Thread]’. Oddworld Discussion. Oddworld Forums.</ref>

<ref name="cinemaYouTubeOWF">'''De Coster, Xavier (1 July 2008)'''. [http://www.oddworldforums.net/showthread.php?p=354850#post354850 Post 16] in ‘The TOL Thread’. Oddworld Discussion. Oddworld Forums.</ref>
<ref name="cinemaYouTubeOB">'''Bunce-Edwards, Wil (2 July 2008)'''. ‘[http://oddworldlibrary.net/oddblog/2008/07/The_Oddworld_Cinema_on_YouTube The Oddworld Cinema on YouTube]’. OddBlog. Oddworld Library.</ref>
<ref name="libraryTwitter">'''Bunce-Edwards, Wil (16 July 2008)'''. [http://www.oddworldforums.net/showthread.php?p=354850#post354850 Post 22] in ‘The TOL Thread’. Oddworld Discussion. Oddworld Forums.</ref>
</references>
[[Category:Oddworld Library]]
[[Category:Oddworld fansites]]

Module:Str endswith

2018-04-08T13:35:38Z

Max: 1 revision imported

-- This module implements {{str endswith}}.

local TRUE_STRING = 'yes'
local FALSE_STRING = ''

local p = {}

local function trim(s)
return s:match('^%s*(.-)%s*$')
end

function p.main(frame)
local args = frame:getParent().args
local s = args[1]
local pattern = args[2]
if not s or not pattern then
-- TRUE_STRING is not the natural choice here, but is needed for
-- backwards compatibility.
return TRUE_STRING
end
s = trim(s)
pattern = trim(pattern)
if pattern == '' then
-- All strings end with the empty string.
return TRUE_STRING
end
if mw.ustring.sub(s, 0 - mw.ustring.len(pattern), -1) == pattern then
return TRUE_STRING
else
return FALSE_STRING
end
end

return p

Module:Math

2018-04-08T13:35:37Z

Max: 1 revision imported

--[[

This module provides a number of basic mathematical operations.

]]

local yesno, getArgs -- lazily initialized

local p = {} -- Holds functions to be returned from #invoke, and functions to make available to other Lua modules.
local wrap = {} -- Holds wrapper functions that process arguments from #invoke. These act as intemediary between functions meant for #invoke and functions meant for Lua.

--[[
Helper functions used to avoid redundant code.
]]

local function err(msg)
-- Generates wikitext error messages.
return mw.ustring.format('Formatting error: %s', msg)
end

local function unpackNumberArgs(args)
-- Returns an unpacked list of arguments specified with numerical keys.
local ret = {}
for k, v in pairs(args) do
if type(k) == 'number' then
table.insert(ret, v)
end
end
return unpack(ret)
end

local function makeArgArray(...)
-- Makes an array of arguments from a list of arguments that might include nils.
local args = {...} -- Table of arguments. It might contain nils or non-number values, so we can't use ipairs.
local nums = {} -- Stores the numbers of valid numerical arguments.
local ret = {}
for k, v in pairs(args) do
v = p._cleanNumber(v)
if v then
nums[#nums + 1] = k
args[k] = v
end
end
table.sort(nums)
for i, num in ipairs(nums) do
ret[#ret + 1] = args[num]
end
return ret
end

local function fold(func, ...)
-- Use a function on all supplied arguments, and return the result. The function must accept two numbers as parameters,
-- and must return a number as an output. This number is then supplied as input to the next function call.
local vals = makeArgArray(...)
local count = #vals -- The number of valid arguments
if count == 0 then return
-- Exit if we have no valid args, otherwise removing the first arg would cause an error.
nil, 0
end
local ret = table.remove(vals, 1)
for _, val in ipairs(vals) do
ret = func(ret, val)
end
return ret, count
end

--[[
Fold arguments by selectively choosing values (func should return when to choose the current "dominant" value).
]]
local function binary_fold(func, ...)
local value = fold((function(a, b) if func(a, b) then return a else return b end end), ...)
return value
end

--[[
random

Generate a random number

Usage:
{{#invoke: Math | random }}
{{#invoke: Math | random | maximum value }}
{{#invoke: Math | random | minimum value | maximum value }}
]]

function wrap.random(args)
local first = p._cleanNumber(args[1])
local second = p._cleanNumber(args[2])
return p._random(first, second)
end

function p._random(first, second)
math.randomseed(mw.site.stats.edits + mw.site.stats.pages + os.time() + math.floor(os.clock() * 1000000000))
-- math.random will throw an error if given an explicit nil parameter, so we need to use if statements to check the params.
if first and second then
if first <= second then -- math.random doesn't allow the first number to be greater than the second.
return math.random(first, second)
end
elseif first then
return math.random(first)
else
return math.random()
end
end

--[[
order

Determine order of magnitude of a number

Usage:
{{#invoke: Math | order | value }}
]]

function wrap.order(args)
local input_string = (args[1] or args.x or '0');
local input_number = p._cleanNumber(input_string);
if input_number == nil then
return err('order of magnitude input appears non-numeric')
else
return p._order(input_number)
end
end

function p._order(x)
if x == 0 then return 0 end
return math.floor(math.log10(math.abs(x)))
end

--[[
precision

Detemines the precision of a number using the string representation

Usage:
{{ #invoke: Math | precision | value }}
]]

function wrap.precision(args)
local input_string = (args[1] or args.x or '0');
local trap_fraction = args.check_fraction;
local input_number;

if not yesno then
yesno = require('Module:Yesno')
end
if yesno(trap_fraction, true) then -- Returns true for all input except nil, false, "no", "n", "0" and a few others. See [[Module:Yesno]].
local pos = string.find(input_string, '/', 1, true);
if pos ~= nil then
if string.find(input_string, '/', pos + 1, true) == nil then
local denominator = string.sub(input_string, pos+1, -1);
local denom_value = tonumber(denominator);
if denom_value ~= nil then
return math.log10(denom_value);
end
end
end
end

input_number, input_string = p._cleanNumber(input_string);
if input_string == nil then
return err('precision input appears non-numeric')
else
return p._precision(input_string)
end
end

function p._precision(x)
if type(x) == 'number' then
x = tostring(x)
end
x = string.upper(x)

local decimal = x:find('%.')
local exponent_pos = x:find('E')
local result = 0;

if exponent_pos ~= nil then
local exponent = string.sub(x, exponent_pos + 1)
x = string.sub(x, 1, exponent_pos - 1)
result = result - tonumber(exponent)
end

if decimal ~= nil then
result = result + string.len(x) - decimal
return result
end

local pos = string.len(x);
while x:byte(pos) == string.byte('0') do
pos = pos - 1
result = result - 1
if pos <= 0 then
return 0
end
end

return result
end

--[[
max

Finds the maximum argument

Usage:
{{#invoke:Math| max | value1 | value2 | ... }}

Note, any values that do not evaluate to numbers are ignored.
]]

function wrap.max(args)
return p._max(unpackNumberArgs(args))
end

function p._max(...)
local max_value = binary_fold((function(a, b) return a > b end), ...)
if max_value then
return max_value
end
end

--[[
min

Finds the minimum argument

Usage:
{{#invoke:Math| min | value1 | value2 | ... }}
OR
{{#invoke:Math| min }}

When used with no arguments, it takes its input from the parent
frame. Note, any values that do not evaluate to numbers are ignored.
]]

function wrap.min(args)
return p._min(unpackNumberArgs(args))
end

function p._min(...)
local min_value = binary_fold((function(a, b) return a < b end), ...)
if min_value then
return min_value
end
end

--[[
average

Finds the average

Usage:
{{#invoke:Math| average | value1 | value2 | ... }}
OR
{{#invoke:Math| average }}

Note, any values that do not evaluate to numbers are ignored.
]]

function wrap.average(args)
return p._average(unpackNumberArgs(args))
end

function p._average(...)
local sum, count = fold((function(a, b) return a + b end), ...)
if not sum then
return 0
else
return sum / count
end
end

--[[
round

Rounds a number to specified precision

Usage:
{{#invoke:Math | round | value | precision }}

--]]

function wrap.round(args)
local value = p._cleanNumber(args[1] or args.value or 0)
local precision = p._cleanNumber(args[2] or args.precision or 0)
if value == nil or precision == nil then
return err('round input appears non-numeric')
else
return p._round(value, precision)
end
end

function p._round(value, precision)
local rescale = math.pow(10, precision or 0);
return math.floor(value * rescale + 0.5) / rescale;
end

--[[
mod

Implements the modulo operator

Usage:
{{#invoke:Math | mod | x | y }}

--]]

function wrap.mod(args)
local x = p._cleanNumber(args[1])
local y = p._cleanNumber(args[2])
if not x then
return err('first argument to mod appears non-numeric')
elseif not y then
return err('second argument to mod appears non-numeric')
else
return p._mod(x, y)
end
end

function p._mod(x, y)
local ret = x % y
if not (0 <= ret and ret < y) then
ret = 0
end
return ret
end

--[[
gcd

Calculates the greatest common divisor of multiple numbers

Usage:
{{#invoke:Math | gcd | value 1 | value 2 | value 3 | ... }}
--]]

function wrap.gcd(args)
return p._gcd(unpackNumberArgs(args))
end

function p._gcd(...)
local function findGcd(a, b)
local r = b
local oldr = a
while r ~= 0 do
local quotient = math.floor(oldr / r)
oldr, r = r, oldr - quotient * r
end
if oldr < 0 then
oldr = oldr * -1
end
return oldr
end
local result, count = fold(findGcd, ...)
return result
end

--[[
precision_format

Rounds a number to the specified precision and formats according to rules
originally used for {{template:Rnd}}. Output is a string.

Usage:
{{#invoke: Math | precision_format | number | precision }}
]]

function wrap.precision_format(args)
local value_string = args[1] or 0
local precision = args[2] or 0
return p._precision_format(value_string, precision)
end

function p._precision_format(value_string, precision)
-- For access to Mediawiki built-in formatter.
local lang = mw.getContentLanguage();

local value
value, value_string = p._cleanNumber(value_string)
precision = p._cleanNumber(precision)

-- Check for non-numeric input
if value == nil or precision == nil then
return err('invalid input when rounding')
end

local current_precision = p._precision(value)
local order = p._order(value)

-- Due to round-off effects it is neccesary to limit the returned precision under
-- some circumstances because the terminal digits will be inaccurately reported.
if order + precision >= 14 then
orig_precision = p._precision(value_string)
if order + orig_precision >= 14 then
precision = 13 - order;
end
end

-- If rounding off, truncate extra digits
if precision < current_precision then
value = p._round(value, precision)
current_precision = p._precision(value)
end

local formatted_num = lang:formatNum(math.abs(value))
local sign

-- Use proper unary minus sign rather than ASCII default
if value < 0 then
sign = '−'
else
sign = ''
end

-- Handle cases requiring scientific notation
if string.find(formatted_num, 'E', 1, true) ~= nil or math.abs(order) >= 9 then
value = value * math.pow(10, -order)
current_precision = current_precision + order
precision = precision + order
formatted_num = lang:formatNum(math.abs(value))
else
order = 0;
end
formatted_num = sign .. formatted_num

-- Pad with zeros, if needed
if current_precision < precision then
local padding
if current_precision <= 0 then
if precision > 0 then
local zero_sep = lang:formatNum(1.1)
formatted_num = formatted_num .. zero_sep:sub(2,2)

padding = precision
if padding > 20 then
padding = 20
end

formatted_num = formatted_num .. string.rep('0', padding)
end
else
padding = precision - current_precision
if padding > 20 then
padding = 20
end
formatted_num = formatted_num .. string.rep('0', padding)
end
end

-- Add exponential notation, if necessary.
if order ~= 0 then
-- Use proper unary minus sign rather than ASCII default
if order < 0 then
order = '−' .. lang:formatNum(math.abs(order))
else
order = lang:formatNum(order)
end

formatted_num = formatted_num .. '×10' .. order .. ''
end

return formatted_num
end

--[[
Helper function that interprets the input numerically. If the
input does not appear to be a number, attempts evaluating it as
a parser functions expression.
]]

function p._cleanNumber(number_string)
if type(number_string) == 'number' then
-- We were passed a number, so we don't need to do any processing.
return number_string, tostring(number_string)
elseif type(number_string) ~= 'string' or not number_string:find('%S') then
-- We were passed a non-string or a blank string, so exit.
return nil, nil;
end

-- Attempt basic conversion
local number = tonumber(number_string)

-- If failed, attempt to evaluate input as an expression
if number == nil then
local success, result = pcall(mw.ext.ParserFunctions.expr, number_string)
if success then
number = tonumber(result)
number_string = tostring(number)
else
number = nil
number_string = nil
end
else
number_string = number_string:match("^%s*(.-)%s*$") -- String is valid but may contain padding, clean it.
number_string = number_string:match("^%+(.*)$") or number_string -- Trim any leading + signs.
if number_string:find('^%-?0[xX]') then
-- Number is using 0xnnn notation to indicate base 16; use the number that Lua detected instead.
number_string = tostring(number)
end
end

return number, number_string
end

--[[
Wrapper function that does basic argument processing. This ensures that all functions from #invoke can use either the current
frame or the parent frame, and it also trims whitespace for all arguments and removes blank arguments.
]]

local mt = { __index = function(t, k)
return function(frame)
if not getArgs then
getArgs = require('Module:Arguments').getArgs
end
return wrap[k](getArgs(frame)) -- Argument processing is left to Module:Arguments. Whitespace is trimmed and blank arguments are removed.
end
end }

return setmetatable(p, mt)

Module:Infobox

2018-04-08T13:35:37Z

Max: 1 revision imported

--
-- This module implements {{Infobox}}
--

local p = {}

local navbar = require('Module:Navbar')._navbar

local args = {}
local origArgs
local root

local function notempty( s ) return s and s:match( '%S' ) end

local function fixChildBoxes(sval, tt)
if notempty(sval) then
local marker = ''
local s = sval
s = mw.ustring.gsub(s, '(<%s*[Tt][Rr])', marker .. '%1')
s = mw.ustring.gsub(s, '(</[Tt][Rr]%s*>)', '%1' .. marker)
if s:match(marker) then
s = mw.ustring.gsub(s, marker .. '%s*' .. marker, '')
s = mw.ustring.gsub(s, '([\r\n]|-[^\r\n]*[\r\n])%s*' .. marker, '%1')
s = mw.ustring.gsub(s, marker .. '%s*([\r\n]|-)', '%1')
s = mw.ustring.gsub(s, '(</[Cc][Aa][Pp][Tt][Ii][Oo][Nn]%s*>%s*)' .. marker, '%1')
s = mw.ustring.gsub(s, '(<%s*[Tt][Aa][Bb][Ll][Ee][^<>]*>%s*)' .. marker, '%1')
s = mw.ustring.gsub(s, '^(%{|[^\r\n]*[\r\n]%s*)' .. marker, '%1')
s = mw.ustring.gsub(s, '([\r\n]%{|[^\r\n]*[\r\n]%s*)' .. marker, '%1')
s = mw.ustring.gsub(s, marker .. '(%s*</[Tt][Aa][Bb][Ll][Ee]%s*>)', '%1')
s = mw.ustring.gsub(s, marker .. '(%s*\n|%})', '%1')
end
if s:match(marker) then
local subcells = mw.text.split(s, marker)
s = ''
for k = 1, #subcells do
if k == 1 then
s = s .. subcells[k] .. '</' .. tt .. '></tr>'
elseif k == #subcells then
local rowstyle = ' style="display:none"'
if notempty(subcells[k]) then rowstyle = '' end
s = s .. '<tr' .. rowstyle ..'><' .. tt .. ' colspan=2>\n' .. subcells[k]
elseif notempty(subcells[k]) then
if (k % 2) == 0 then
s = s .. subcells[k]
else
s = s .. '<tr><' .. tt .. ' colspan=2>\n' .. subcells[k] .. '</' .. tt .. '></tr>'
end
end
end
end
return s
else
return sval
end
end

local function union(t1, t2)
-- Returns the union of the values of two tables, as a sequence.
local vals = {}
for k, v in pairs(t1) do
vals[v] = true
end
for k, v in pairs(t2) do
vals[v] = true
end
local ret = {}
for k, v in pairs(vals) do
table.insert(ret, k)
end
return ret
end

local function getArgNums(prefix)
-- Returns a table containing the numbers of the arguments that exist
-- for the specified prefix. For example, if the prefix was 'data', and
-- 'data1', 'data2', and 'data5' exist, it would return {1, 2, 5}.
local nums = {}
for k, v in pairs(args) do
local num = tostring(k):match('^' .. prefix .. '([1-9]%d*)$')
if num then table.insert(nums, tonumber(num)) end
end
table.sort(nums)
return nums
end

local function addRow(rowArgs)
-- Adds a row to the infobox, with either a header cell
-- or a label/data cell combination.
if rowArgs.header then
root
:tag('tr')
:addClass(rowArgs.rowclass)
:cssText(rowArgs.rowstyle)
:attr('id', rowArgs.rowid)
:tag('th')
:attr('colspan', 2)
:attr('id', rowArgs.headerid)
:addClass(rowArgs.class)
:addClass(args.headerclass)
:css('text-align', 'center')
:cssText(args.headerstyle)
:cssText(rowArgs.rowcellstyle)
:wikitext(fixChildBoxes(rowArgs.header, 'th'))
elseif rowArgs.data then
local row = root:tag('tr')
row:addClass(rowArgs.rowclass)
row:cssText(rowArgs.rowstyle)
row:attr('id', rowArgs.rowid)
if rowArgs.label then
row
:tag('th')
:attr('scope', 'row')
:attr('id', rowArgs.labelid)
:cssText(args.labelstyle)
:cssText(rowArgs.rowcellstyle)
:wikitext(rowArgs.label)
:done()
end

local dataCell = row:tag('td')
if not rowArgs.label then
dataCell
:attr('colspan', 2)
:css('text-align', 'center')
end
dataCell
:attr('id', rowArgs.dataid)
:addClass(rowArgs.class)
:cssText(rowArgs.datastyle)
:cssText(rowArgs.rowcellstyle)
:newline()
:wikitext(fixChildBoxes(rowArgs.data, 'td'))
end
end

local function renderTitle()
if not args.title then return end

root
:tag('caption')
:addClass(args.titleclass)
:cssText(args.titlestyle)
:wikitext(args.title)
end

local function renderAboveRow()
if not args.above then return end

root
:tag('tr')
:tag('th')
:attr('colspan', 2)
:addClass(args.aboveclass)
:css('text-align', 'center')
:css('font-size', '125%')
:css('font-weight', 'bold')
:cssText(args.abovestyle)
:wikitext(fixChildBoxes(args.above,'th'))
end

local function renderBelowRow()
if not args.below then return end

root
:tag('tr')
:tag('td')
:attr('colspan', '2')
:addClass(args.belowclass)
:css('text-align', 'center')
:cssText(args.belowstyle)
:newline()
:wikitext(fixChildBoxes(args.below,'td'))
end

local function renderSubheaders()
if args.subheader then
args.subheader1 = args.subheader
end
if args.subheaderrowclass then
args.subheaderrowclass1 = args.subheaderrowclass
end
local subheadernums = getArgNums('subheader')
for k, num in ipairs(subheadernums) do
addRow({
data = args['subheader' .. tostring(num)],
datastyle = args.subheaderstyle or args['subheaderstyle' .. tostring(num)],
class = args.subheaderclass,
rowclass = args['subheaderrowclass' .. tostring(num)]
})
end
end

local function renderImages()
if args.image then
args.image1 = args.image
end
if args.caption then
args.caption1 = args.caption
end
local imagenums = getArgNums('image')
for k, num in ipairs(imagenums) do
local caption = args['caption' .. tostring(num)]
local data = mw.html.create():wikitext(args['image' .. tostring(num)])
if caption then
data
:tag('div')
:cssText(args.captionstyle)
:wikitext(caption)
end
addRow({
data = tostring(data),
datastyle = args.imagestyle,
class = args.imageclass,
rowclass = args['imagerowclass' .. tostring(num)]
})
end
end

local function renderRows()
-- Gets the union of the header and data argument numbers,
-- and renders them all in order using addRow.
local rownums = union(getArgNums('header'), getArgNums('data'))
table.sort(rownums)
for k, num in ipairs(rownums) do
addRow({
header = args['header' .. tostring(num)],
label = args['label' .. tostring(num)],
data = args['data' .. tostring(num)],
datastyle = args.datastyle,
class = args['class' .. tostring(num)],
rowclass = args['rowclass' .. tostring(num)],
rowstyle = args['rowstyle' .. tostring(num)],
rowcellstyle = args['rowcellstyle' .. tostring(num)],
dataid = args['dataid' .. tostring(num)],
labelid = args['labelid' .. tostring(num)],
headerid = args['headerid' .. tostring(num)],
rowid = args['rowid' .. tostring(num)]
})
end
end

local function renderNavBar()
if not args.name then return end

root
:tag('tr')
:tag('td')
:attr('colspan', '2')
:css('text-align', 'right')
:wikitext(navbar{
args.name,
mini = 1,
})
end

local function renderItalicTitle()
local italicTitle = args['italic title'] and mw.ustring.lower(args['italic title'])
if italicTitle == '' or italicTitle == 'force' or italicTitle == 'yes' then
root:wikitext(mw.getCurrentFrame():expandTemplate({title = 'italic title'}))
end
end

local function renderTrackingCategories()
if args.decat ~= 'yes' then
if #(getArgNums('data')) == 0 and mw.title.getCurrentTitle().namespace == 0 then
root:wikitext('[[Category:Articles which use infobox templates with no data rows]]')
end
if args.child == 'yes' and args.title then
root:wikitext('[[Category:Pages which use embedded infobox templates with the title parameter]]')
end
end
end

local function _infobox()
-- Specify the overall layout of the infobox, with special settings
-- if the infobox is used as a 'child' inside another infobox.
if args.child ~= 'yes' then
root = mw.html.create('table')

root
:addClass((args.subbox ~= 'yes') and 'infobox' or nil)
:addClass(args.bodyclass)

if args.subbox == 'yes' then
root
:css('padding', '0')
:css('border', 'none')
:css('margin', '-3px')
:css('width', 'auto')
:css('min-width', '100%')
:css('font-size', '100%')
:css('clear', 'none')
:css('float', 'none')
:css('background-color', 'transparent')
else
root
:css('width', '22em')
end
root
:cssText(args.bodystyle)

renderTitle()
renderAboveRow()
else
root = mw.html.create()

root
:wikitext(args.title)
end

renderSubheaders()
renderImages()
renderRows()
renderBelowRow()
renderNavBar()
renderItalicTitle()
renderTrackingCategories()

return tostring(root)
end

local function preprocessSingleArg(argName)
-- If the argument exists and isn't blank, add it to the argument table.
-- Blank arguments are treated as nil to match the behaviour of ParserFunctions.
if origArgs[argName] and origArgs[argName] ~= '' then
args[argName] = origArgs[argName]
end
end

local function preprocessArgs(prefixTable, step)
-- Assign the parameters with the given prefixes to the args table, in order, in batches
-- of the step size specified. This is to prevent references etc. from appearing in the
-- wrong order. The prefixTable should be an array containing tables, each of which has
-- two possible fields, a "prefix" string and a "depend" table. The function always parses
-- parameters containing the "prefix" string, but only parses parameters in the "depend"
-- table if the prefix parameter is present and non-blank.
if type(prefixTable) ~= 'table' then
error("Non-table value detected for the prefix table", 2)
end
if type(step) ~= 'number' then
error("Invalid step value detected", 2)
end

-- Get arguments without a number suffix, and check for bad input.
for i,v in ipairs(prefixTable) do
if type(v) ~= 'table' or type(v.prefix) ~= "string" or (v.depend and type(v.depend) ~= 'table') then
error('Invalid input detected to preprocessArgs prefix table', 2)
end
preprocessSingleArg(v.prefix)
-- Only parse the depend parameter if the prefix parameter is present and not blank.
if args[v.prefix] and v.depend then
for j, dependValue in ipairs(v.depend) do
if type(dependValue) ~= 'string' then
error('Invalid "depend" parameter value detected in preprocessArgs')
end
preprocessSingleArg(dependValue)
end
end
end

-- Get arguments with number suffixes.
local a = 1 -- Counter variable.
local moreArgumentsExist = true
while moreArgumentsExist == true do
moreArgumentsExist = false
for i = a, a + step - 1 do
for j,v in ipairs(prefixTable) do
local prefixArgName = v.prefix .. tostring(i)
if origArgs[prefixArgName] then
moreArgumentsExist = true -- Do another loop if any arguments are found, even blank ones.
preprocessSingleArg(prefixArgName)
end
-- Process the depend table if the prefix argument is present and not blank, or
-- we are processing "prefix1" and "prefix" is present and not blank, and
-- if the depend table is present.
if v.depend and (args[prefixArgName] or (i == 1 and args[v.prefix])) then
for j,dependValue in ipairs(v.depend) do
local dependArgName = dependValue .. tostring(i)
preprocessSingleArg(dependArgName)
end
end
end
end
a = a + step
end
end

function p.infobox(frame)
-- If called via #invoke, use the args passed into the invoking template.
-- Otherwise, for testing purposes, assume args are being passed directly in.
if frame == mw.getCurrentFrame() then
origArgs = frame:getParent().args
else
origArgs = frame
end

-- Parse the data parameters in the same order that the old {{infobox}} did, so that
-- references etc. will display in the expected places. Parameters that depend on
-- another parameter are only processed if that parameter is present, to avoid
-- phantom references appearing in article reference lists.
preprocessSingleArg('child')
preprocessSingleArg('bodyclass')
preprocessSingleArg('subbox')
preprocessSingleArg('bodystyle')
preprocessSingleArg('title')
preprocessSingleArg('titleclass')
preprocessSingleArg('titlestyle')
preprocessSingleArg('above')
preprocessSingleArg('aboveclass')
preprocessSingleArg('abovestyle')
preprocessArgs({
{prefix = 'subheader', depend = {'subheaderstyle', 'subheaderrowclass'}}
}, 10)
preprocessSingleArg('subheaderstyle')
preprocessSingleArg('subheaderclass')
preprocessArgs({
{prefix = 'image', depend = {'caption', 'imagerowclass'}}
}, 10)
preprocessSingleArg('captionstyle')
preprocessSingleArg('imagestyle')
preprocessSingleArg('imageclass')
preprocessArgs({
{prefix = 'header'},
{prefix = 'data', depend = {'label'}},
{prefix = 'rowclass'},
{prefix = 'rowstyle'},
{prefix = 'rowcellstyle'},
{prefix = 'class'},
{prefix = 'dataid'},
{prefix = 'labelid'},
{prefix = 'headerid'},
{prefix = 'rowid'}
}, 50)
preprocessSingleArg('headerclass')
preprocessSingleArg('headerstyle')
preprocessSingleArg('labelstyle')
preprocessSingleArg('datastyle')
preprocessSingleArg('below')
preprocessSingleArg('belowclass')
preprocessSingleArg('belowstyle')
preprocessSingleArg('name')
args['italic title'] = origArgs['italic title'] -- different behaviour if blank or absent
preprocessSingleArg('decat')

return _infobox()
end

return p

Template:Tlsp

2018-04-08T13:35:35Z

Max: 1 revision imported

{{[[Wikipedia:Substitution|subst]]:[[{{ns:Template}}:{{{1|Tlsp}}}|{{{1|Tlsp}}}]]{{#if:{{{2|}}}||{{{2}}}}}{{#if:{{{3|}}}||{{{3}}}}}{{#if:{{{4|}}}||{{{4}}}}}{{#if:{{{5|}}}||{{{5}}}}}{{#if:{{{6|}}}||{{{6}}}}}{{#if:{{{subst|}}}||subst={{{subst}}}}}}}{{#if:{{{7|}}}|{{error|{{tl|tlsp}} only supports up to 5 template parameters}}}}<noinclude>
{{documentation}}
</noinclude>

Template:TemplateDataHeader

2018-04-08T13:35:34Z

Max: 1 revision imported

#REDIRECT [[Template:TemplateData header]]
{{R from move}}

Template:Str left

2018-04-08T13:35:34Z

Max: 1 revision imported

<includeonly>{{safesubst:padleft:|{{{2|1}}}|{{{1}}}}}</includeonly><noinclude>
{{documentation}}

</noinclude>

Template:Str endswith

2018-04-08T13:35:34Z

Max: 1 revision imported

{{#invoke:Str endswith|main}}<noinclude>
{{documentation}}
</noinclude>

Template:Str crop

2018-04-08T13:35:34Z

Max: 1 revision imported

<includeonly>{{safesubst:#invoke:String | sub | s={{{1|}}} | 1 | {{safesubst:#expr: -{{{2|1}}} - 1}} | ignore_errors=true }}</includeonly><noinclude>
{{documentation}}</noinclude>

Template:Significant figures/rnd

2018-04-08T13:35:33Z

Max: 1 revision imported

<includeonly>{{rnd|{{{1}}}|{{{2}}}-{{{3}}}-1}}</includeonly><noinclude>
{{doc|content=
A rounding subtemplate, it calls {{tl|rnd}}.

Examples:
*{{xpd5op3p3p3c|d=||||||sigfig/rnd|123.456|||7|||2}}
*{{xpd5op3p3p3c|d=||||||sigfig/rnd|123.456|||6|||2}}
*{{xpd5op3p3p3c|d=||||||sigfig/rnd|123.456|||5|||2}}
*{{xpd5op3p3p3c|d=||||||sigfig/rnd|123.456|||4|||2}}
*{{xpd5op3p3p3c|d=||||||sigfig/rnd|123.456|||3|||2}}
*{{xpd5op3p3p3c|d=||||||sigfig/rnd|123.456|||2|||2}}
*{{xpd5op3p3p3c|d=||||||sigfig/rnd|123.456|||1|||2}}
*{{xpd5op3p3p3c|d=||||||sigfig/rnd|123.456|||0|||2}}

[[Category:Subtemplates of template sigfig|rnd]]
}}
</noinclude>

Template:Significant figures

2018-04-08T13:35:33Z

Max: 1 revision imported

{{#ifeq:{{{1<noinclude>|0</noinclude>}}}|0
|0
|{{significant figures/{{#if:{{{2|}}}
|rnd
|sum
}}
|1={{formatnum:{{{1}}}|R}}
|2={{{2}}}
|3={{Order of magnitude|{{formatnum:{{{1}}}|R}}}}
}}
}}<noinclude>
{{documentation}}
</noinclude>

Template:Sigfig

2018-04-08T13:35:33Z

Max: 1 revision imported

#REDIRECT [[Template:Significant figures]]

{{Redirect category shell|
{{R from move}}
{{R from template shortcut}}
}}

Template:Rnd

2018-04-08T13:35:33Z

Max: 1 revision imported

<includeonly>{{#iferror:{{#expr:{{{2|0}}}}} |
[[Category:Pages with bad rounding precision]]{{hid|Bad rounding here}}{{#invoke:Math|precision_format| {{{1}}} | 1-{{order of magnitude|{{{1}}}}} }}|
{{#invoke:Math|precision_format| {{{1}}} | {{{2|0}}}}}}}</includeonly><noinclude>
{{documentation}}
</noinclude>

Template:Para

2018-04-08T13:35:33Z

Max: 1 revision imported

<code class="nowrap" {{#if:{{{plain|}}}|style="border:none;background-color:inherit;color:inherit;"}}>|{{#if:{{{1|}}}|{{{1}}}=}}{{{2|}}}</code><noinclude>
{{Documentation}}

</noinclude>

Template:Order of magnitude

2018-04-08T13:35:32Z

Max: 1 revision imported

<includeonly>{{{{{|safesubst:}}}#ifexpr:{{{1|0}}}=0
|{{{{{|safesubst:}}}#ifexpr:abs{{{1|0}}}1=1
|0
|{{{{{|safesubst:}}}#expr:floor((ln(abs{{{1}}}1)/ln10)+1)}}
}}
|{{#expr:floor((ln(abs({{{1|0}}}) )/ln 10)+1E((abs{{{1|0}}}>1E100 or abs{{{1|0}}}<1E-100)-14))}}
}}</includeonly><noinclude>
{{documentation}}
</noinclude>

Template:Lorem ipsum

2018-04-08T13:35:32Z

Max: 1 revision imported

{{{{{|safesubst:}}}#ifexpr:{{{1|1}}}>0|{{{2|}}}{{{{{|safesubst:}}}#ifeq:{{{link|{{{4}}}}}}|yes|[[Lorem ipsum]]|Lorem ipsum}} dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.{{{3|}}}{{{{{|safesubst:}}}#ifexpr:{{{1|1}}}>1|{{{{{|safesubst:}}}#ifeq:x{{{3|}}}x|x x||{{{{{|safesubst:}}}#if:{{{2|}}}||<nowiki></nowiki>}}}}

{{{2|}}}Curabitur pretium tincidunt lacus. Nulla gravida orci a odio. Nullam varius, turpis et commodo pharetra, est eros bibendum elit, nec luctus magna felis sollicitudin mauris. Integer in mauris eu nibh euismod gravida. Duis ac tellus et risus vulputate vehicula. Donec lobortis risus a elit. Etiam tempor. Ut ullamcorper, ligula eu tempor congue, eros est euismod turpis, id tincidunt sapien risus a quam. Maecenas fermentum consequat mi. Donec fermentum. Pellentesque malesuada nulla a mi. Duis sapien sem, aliquet nec, commodo eget, consequat quis, neque. Aliquam faucibus, elit ut dictum aliquet, felis nisl adipiscing sapien, sed malesuada diam lacus eget erat. Cras mollis scelerisque nunc. Nullam arcu. Aliquam consequat. Curabitur augue lorem, dapibus quis, laoreet et, pretium ac, nisi. Aenean magna nisl, mollis quis, molestie eu, feugiat in, orci. In hac habitasse platea dictumst.{{{3|}}}{{{{{|safesubst:}}}#ifexpr:{{{1|1}}}>2|{{{{{|safesubst:}}}#ifeq:x{{{3|}}}x|x x||{{{{{|safesubst:}}}#if:{{{2|}}}||<nowiki></nowiki>}}}}

{{{2|}}}Fusce convallis, mauris imperdiet gravida bibendum, nisl turpis suscipit mauris, sed placerat ipsum urna sed risus. In convallis tellus a mauris. Curabitur non elit ut libero tristique sodales. Mauris a lacus. Donec mattis semper leo. In hac habitasse platea dictumst. Vivamus facilisis diam at odio. Mauris dictum, nisi eget consequat elementum, lacus ligula molestie metus, non feugiat orci magna ac sem. Donec turpis. Donec vitae metus. Morbi tristique neque eu mauris. Quisque gravida ipsum non sapien. Proin turpis lacus, scelerisque vitae, elementum at, lobortis ac, quam. Aliquam dictum eleifend risus. In hac habitasse platea dictumst. Etiam sit amet diam. Suspendisse odio. Suspendisse nunc. In semper bibendum libero.{{{3|}}}{{{{{|safesubst:}}}#ifexpr:{{{1|1}}}>3|{{{{{|safesubst:}}}#ifeq:x{{{3|}}}x|x x||{{{{{|safesubst:}}}#if:{{{2|}}}||<nowiki></nowiki>}}}}

{{{2|}}}Proin nonummy, lacus eget pulvinar lacinia, pede felis dignissim leo, vitae tristique magna lacus sit amet eros. Nullam ornare. Praesent odio ligula, dapibus sed, tincidunt eget, dictum ac, nibh. Nam quis lacus. Nunc eleifend molestie velit. Morbi lobortis quam eu velit. Donec euismod vestibulum massa. Donec non lectus. Aliquam commodo lacus sit amet nulla. Cras dignissim elit et augue. Nullam non diam. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. In hac habitasse platea dictumst. Aenean vestibulum. Sed lobortis elit quis lectus. Nunc sed lacus at augue bibendum dapibus.{{{3|}}}{{{{{|safesubst:}}}#ifexpr:{{{1|1}}}>4|{{{{{|safesubst:}}}#ifeq:x{{{3|}}}x|x x||{{{{{|safesubst:}}}#if:{{{2|}}}||<nowiki></nowiki>}}}}

{{{2|}}}Aliquam vehicula sem ut pede. Cras purus lectus, egestas eu, vehicula at, imperdiet sed, nibh. Morbi consectetuer luctus felis. Donec vitae nisi. Aliquam tincidunt feugiat elit. Duis sed elit ut turpis ullamcorper feugiat. Praesent pretium, mauris sed fermentum hendrerit, nulla lorem iaculis magna, pulvinar scelerisque urna tellus a justo. Suspendisse pulvinar massa in metus. Duis quis quam. Proin justo. Curabitur ac sapien. Nam erat. Praesent ut quam.{{{3|}}}{{{{{|safesubst:}}}#ifexpr:{{{1|1}}}>5|{{{{{|safesubst:}}}#ifeq:x{{{3|}}}x|x x||{{{{{|safesubst:}}}#if:{{{2|}}}||<nowiki></nowiki>}}}}

{{{2|}}}Vivamus commodo, augue et laoreet euismod, sem sapien tempor dolor, ac egestas sem ligula quis lacus. Donec vestibulum tortor ac lacus. Sed posuere vestibulum nisl. Curabitur eleifend fermentum justo. Nullam imperdiet. Integer sit amet mauris imperdiet risus sollicitudin rutrum. Ut vitae turpis. Nulla facilisi. Quisque tortor velit, scelerisque et, facilisis vel, tempor sed, urna. Vivamus nulla elit, vestibulum eget, semper et, scelerisque eget, lacus. Pellentesque viverra purus. Quisque elit. Donec ut dolor.{{{3|}}}{{{{{|safesubst:}}}#ifexpr:{{{1|1}}}>6|{{{{{|safesubst:}}}#ifeq:x{{{3|}}}x|x x||{{{{{|safesubst:}}}#if:{{{2|}}}||<nowiki></nowiki>}}}}

{{{2|}}}Duis volutpat elit et erat. In at nulla at nisl condimentum aliquet. Quisque elementum pharetra lacus. Nunc gravida arcu eget nunc. Nulla iaculis egestas magna. Aliquam erat volutpat. Sed pellentesque orci. Etiam lacus lorem, iaculis sit amet, pharetra quis, imperdiet sit amet, lectus. Integer quis elit ac mi aliquam pretium. Nullam mauris orci, porttitor eget, sollicitudin non, vulputate id, risus. Donec varius enim nec sem. Nam aliquam lacinia enim. Quisque eget lorem eu purus dignissim ultricies. Fusce porttitor hendrerit ante. Mauris urna diam, cursus id, mattis eget, tempus sit amet, risus. Curabitur eu felis. Sed eu mi. Nullam lectus mauris, luctus a, mattis ac, tempus non, leo. Cras mi nulla, rhoncus id, laoreet ut, ultricies id, odio.{{{3|}}}{{{{{|safesubst:}}}#ifexpr:{{{1|1}}}>7|{{{{{|safesubst:}}}#ifeq:x{{{3|}}}x|x x||{{{{{|safesubst:}}}#if:{{{2|}}}||<nowiki></nowiki>}}}}

{{{2|}}}Donec imperdiet. Vestibulum auctor tortor at orci. Integer semper, nisi eget suscipit eleifend, erat nisl hendrerit justo, eget vestibulum lorem justo ac leo. Integer sem velit, pharetra in, fringilla eu, fermentum id, felis. Vestibulum sed felis. In elit. Praesent et pede vel ante dapibus condimentum. Donec magna. Quisque id risus. Mauris vulputate pellentesque leo. Duis vulputate, ligula at venenatis tincidunt, orci nunc interdum leo, ac egestas elit sem ut lacus. Etiam non diam quis arcu egestas commodo. Curabitur nec massa ac massa gravida condimentum. Aenean id libero. Pellentesque vitae tellus. Fusce lectus est, accumsan ac, bibendum sed, porta eget, augue. Etiam faucibus. Quisque tempus purus eu ante.{{{3|}}}{{{{{|safesubst:}}}#ifexpr:{{{1|1}}}>8|{{{{{|safesubst:}}}#ifeq:x{{{3|}}}x|x x||{{{{{|safesubst:}}}#if:{{{2|}}}||<nowiki></nowiki>}}}}

{{{2|}}}Vestibulum sapien nisl, ornare auctor, consectetuer quis, posuere tristique, odio. Fusce ultrices ullamcorper odio. Ut augue nulla, interdum at, adipiscing non, tristique eget, neque. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Ut pede est, condimentum id, scelerisque ac, malesuada non, quam. Proin eu ligula ac sapien suscipit blandit. Suspendisse euismod. Ut accumsan, neque id gravida luctus, arcu pede sodales felis, vel blandit massa arcu eget ligula. Aenean sed turpis. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Donec sem eros, ornare ut, commodo eu, tempor nec, risus. Donec laoreet dapibus ligula. Praesent orci leo, bibendum nec, ornare et, nonummy in, elit. Donec interdum feugiat leo. Vestibulum ante ipsum primis in faucibus orci luctus et ultrices posuere cubilia Curae; Pellentesque feugiat ullamcorper ipsum. Donec convallis tincidunt urna.{{{3|}}}{{{{{|safesubst:}}}#ifexpr:{{{1|1}}}>9|{{{{{|safesubst:}}}#ifeq:x{{{3|}}}x|x x||{{{{{|safesubst:}}}#if:{{{2|}}}||<nowiki></nowiki>}}}}

{{{2|}}}Suspendisse et orci et arcu porttitor pellentesque. Sed lacus nunc, fermentum vel, vehicula in, imperdiet eget, urna. Nam consectetuer euismod nunc. Nulla dignissim posuere nulla. Integer iaculis lacinia massa. Nullam sapien augue, condimentum vel, venenatis id, rhoncus pellentesque, sapien. Donec sed ipsum ultrices turpis consectetuer imperdiet. Duis et ipsum ac nisl laoreet commodo. Mauris eu est. Suspendisse id turpis quis orci euismod consequat. Donec tellus mi, luctus sit amet, ultrices a, convallis eu, lorem. Proin faucibus convallis elit. Maecenas rhoncus arcu at arcu. Proin libero. Proin adipiscing. In quis lorem vitae elit consectetuer pretium. Nullam ligula urna, adipiscing nec, iaculis ut, elementum non, turpis. Fusce pulvinar.{{{3|}}}}}}}}}}}}}}}}}}}}}{{{{{|safesubst:}}}#ifexpr:{{{1|1}}}>10|{{{{{|safesubst:}}}#ifeq:x{{{3|}}}x|x x||{{{{{|safesubst:}}}#if:{{{2|}}}||<nowiki></nowiki>}}}}

{{{{{|safesubst:}}}Lorem ipsum/more|{{{{{|safesubst:}}}#expr:{{{1|1}}}-10}}|{{{2|}}}|{{{3|}}}}}}}{{{{{|safesubst:}}}#ifeq:{{{cat|}}}|no||{{Template:Main other|[[Category:Wikipedia articles containing placeholders]]}}}}}}<noinclude>
{{Documentation}}

</noinclude>

Template:Infobox

2018-04-08T13:35:31Z

Max: 1 revision imported

{{#invoke:Infobox|infobox}}<includeonly>{{#ifeq:{{NAMESPACE}}|Template|{{#ifeq:{{str left|{{SUBPAGENAME}}|7}}|Infobox|[[Category:Infobox templates|{{remove first word|{{SUBPAGENAME}}}}]]}}}}</includeonly><noinclude>
{{documentation}}

</noinclude>

Template:High-use/num

2018-04-08T13:35:31Z

Max: 1 revision imported

{{#iferror:{{#expr:0+{{{1}}}*1}}|many|approximately {{sigfig|{{{1}}}|2}}}}

Template:High-use

2018-04-08T13:35:31Z

Max: 1 revision imported

{{Ombox
| type = style
| image = [[File:Ambox warning yellow.svg|40px|alt=Warning|link=]]
| text =
'''This {{#switch:{{NAMESPACE}}|Module=Lua module|#default=template}} is used on [https://tools.wmflabs.org/templatecount/index.php?lang=en&namespace={{NAMESPACENUMBER:{{FULLPAGENAME}}}}&name={{urlencode:{{
#switch: {{SUBPAGENAME}}
| doc | sandbox = {{BASEPAGENAME}}
| #default = {{PAGENAME}}
}}}} {{High-use/num|1={{formatnum:{{#ifeq:{{str endswith|{{{1}}}|+}}|yes|{{str crop|{{{1}}}|1}}|{{{1}}}}}|R}}}} pages]''', so changes to it will be widely noticed. Please test any changes in the {{#switch:{{NAMESPACE}}|Module=module's|#default=template's}} [[{{#switch: {{SUBPAGENAME}}
| doc | sandbox = {{SUBJECTSPACE}}:{{BASEPAGENAME}}
| #default = {{SUBJECTPAGENAME}}
}}/sandbox|/sandbox]] or [[{{#switch: {{SUBPAGENAME}}
| doc | sandbox = {{SUBJECTSPACE}}:{{BASEPAGENAME}}
| #default = {{SUBJECTPAGENAME}}
}}/testcases|/testcases]] subpages{{#switch:{{NAMESPACE}}|Module=.|#default=, or in your own [[Wikipedia:Subpages#How to create user subpages|user subpage]].}} Please consider discussing changes {{#if:{{{2|}}}|at [[{{{2}}}]]|on the [[{{#switch: {{SUBPAGENAME}}
| doc | sandbox = {{TALKSPACE}}:{{BASEPAGENAME}}
| #default = {{TALKPAGENAME}}
}}|talk page]]}} before implementing them.
}}<noinclude>
{{Documentation}}

</noinclude>

Template:Collapse Templates

2018-04-08T13:35:30Z

Max: 1 revision imported

{{Infobox
| bodyclass = nowrap
| bodystyle = width:auto;padding-bottom:0.6em;line-height:1.25em;
| abovestyle = font-size:inherit;
| above = Collapse Templates 
| labelstyle = margin:0;padding:0 0.3em 0;text-align:center;font-weight:normal;
| datastyle = margin:0;padding:0 0.5em 0 0;

|header1 = Basic Collapse
| label2 = {{tl|Collapse top}}
| data2 = Top
|header3 =
| label3 = {{tl|Collapse bottom}}
| data3 = Bottom
|header4 =
| label4 = {{tl|Collapse}}
| data4 = Both
|header5 = Discussion Collapse
| label6 = {{tl|Discussion top}}
| data6 = Top
|header6 =
| label7 = {{tl|Discussion bottom}}
| data7 = Bottom
|header8 =
| label8 = {{tl|Hidden archive top}}
| data8 = Top
|header9 =
| label9 = {{tl|Hidden archive bottom}}
| data9 = Bottom
|header10 = Hidden Collapse
| label11 = {{tl|Hidden begin}}
| data11 = Top
|header12 =
| label12 = {{tl|Hidden end}}
| data12 = Bottom
|header13 =
| label13 = {{tl|Hidden}}
| data13 = Both
|header14 = Collapsible List
| label15 = {{tl|Collapsible list}}
| data15 = Both
|header16 =
| label16 = {{tl|Drop down list}}
| data16 = Both
}}
<noinclude>{{documentation|content=
Used by all collapse templates to show a navbox.}}
</noinclude>

Template:Collapse/doc

2018-04-08T13:35:30Z

Max: 1 revision imported

{{Documentation subpage}}
{{High-use|2,900+}}

{{Template:Collapse Templates}}

The {{tlx|collapse|<nowiki>folding text</nowiki>}} template is used for placing collapse boxes around ''short'' discussions and bits of discussions. To fold ''long'' discussion threads, use {{tlx|Collapse top}}<code>... lots of text ...</code>{{tlx|Collapse bottom}}.

This template should only be used in accordance with the [[Wikipedia:refactoring]] guideline; it should never be used to end a discussion over the objections of other editors, except in cases of unambiguous disruptive editing.

Do not hide content in articles. This violates the [[WP:Manual of Style#Scrolling lists and collapsible content]] and [[WP:Accessibility]] guidelines.

== Usage ==

'''''Note: {{Tl|Collapse}} needs to be [[Wikipedia:Substitution|substed]] in order for the time stamp functionality to work properly.'''''

{{Tlx|Collapse|1=<var>Discussion text to be put into box.</var>|2=<var>Optional custom heading</var>}}

It is definitely safest to use the named {{para|1}} and {{para|2}} parameters, because otherwise any "=" character will break the template.

=== The <code>bg</code> parameter ===

The <code>bg</code> parameter is optional. It changes the background color. Use [[Web color]] values (e.g. <code>#F0F2F5</code>).

;Example:

<code>{<nowiki />{Collapse|1=<var>Discussion text to be put into box.</var>|bg=#F0F2F5}<nowiki />}</code> creates:

{{Collapse|1=Discussion text to be put into box.|bg=#F0F2F5}}

=== The <code>padding</code> parameter ===
The <code>padding</code> parameter adjusts the amount of cell padding (defaults to <code>8px</code>):

<code>{<nowiki />{Collapse|1=<var>Discussion text to be put into box.</var>|padding=20px}<nowiki />}</code> creates the following (expand the box to see the border padding effect):

{{Collapse|1=Discussion text to be put into box.|padding=20px}}

=== The <code>float</code> parameter ===
The <code>float</code> parameter allows the collapsed content to float to the left, right, or center of the page (defaults to <code>none</code> with <code>width = 100%</code>):

<code><nowiki>{{</nowiki>Collapse|1=<var>Discussion text to be put into box.</var>|float=center<nowiki>}}</nowiki></code> creates the following:

{{Collapse|1=Discussion text to be put into box.|float=center}}

<code><nowiki>{{</nowiki>Collapse|1=<var>Discussion text to be put into box.</var>|float=center|width=30em<nowiki>}}</nowiki></code> creates the following:

{{Collapse|1=Discussion text to be put into box.|float=center|width=30em}}

<code><nowiki>{{</nowiki>Collapse|1=<var>Discussion text to be put into box.</var>|float=left|width=30em<nowiki>}}</nowiki></code> creates the following:

{{Collapse|1=Discussion text to be put into box.|float=left|width=30em}}
{{clear}}
<code><nowiki>{{</nowiki>Collapse|1=<var>Discussion text to be put into box.</var>|float=right|width=30em<nowiki>}}</nowiki></code> creates the following:

{{Collapse|1=Discussion text to be put into box.|float=right|width=30em}}
{{clear}}
<code><nowiki>{{</nowiki>Collapse|1=<var>Discussion text to be put into box.</var>|float=none|width=30em<nowiki>}}</nowiki></code> creates the following:

{{Collapse|1=Discussion text to be put into box.|float=none|width=30em}}

=== Around header text ===

When used with a section of text, include the section header in the collapsed portion of text. For example, given:

{| style="background-color: lavender"
| Example text|== [[Help:Section|Heading]] == {{Lorem ipsum}}
|}

Replace with:

<code>{{Tlsp|Collapse|1={{Lorem ipsum}}|2=[[Help:Section|Heading]]}}</code>

===The <code>expand</code> parameter===
Simply add {{para|expand|yes}} to have the box show up in expanded form with a "hide" link, instead of collapsed form with a "show" link. Other options: {{para|expand|}} <code>yes, y, expand, expanded, uncollapse, uncollapsed</code>. Note: {{para|expand|no}} will fold the box (default).

===The <code>clear</code> parameter===
In some situations you may not want the default <code>clear: both;</code> CSS to apply, which puts the collapse box below any left- or right-floated content within the same HTML block. In this case, you can use {{para|clear|none}}, {{para|clear|right}}, or {{para|clear|left}}, as needed.

===When content includes tables===
This template frequently breaks when used around content that consists of or includes [[Help:Table|wikitables]]. Such content can be made collapsible by using the {{tlx|collapse top}} and {{tlx|collapse bottom}} templates instead of {{tlx|collapse}}.

If you want to collapse only the table and not other content, you can do this using wikitable parameters. See the [[Help:Collapsing#Collapsing tables by default|Collapsing tables]] guide for help.

==TemplateData==
{{TemplateDataHeader}}
<templatedata>
{
"description": "Creates a collapsible box that allows its content to be hidden or revealed on user's command. It is used to reduce clutter.",
"params": {
"1": {
"label": "Contents",
"description": "Contents of the box",
"type": "content",
"required": true
},
"2": {
"label": "Title",
"description": "Text of title bar. Defaults to \"Extended contents\".",
"type": "string",
"suggested": true,
"aliases": [
"title",
"heading",
"header"
],
"default": "Extended content"
},
"expand": {
"label": "Expanded by default?",
"description": "Setting to \"yes, y, expand, uncollapse\") will cause the box to show its contents by default. Any other value (and omitting this parameter) causes the box to be collapsed by default (its contents hidden).",
"type": "string",
"default": "yes"
},
"border": {
"label": "Border width",
"description": "Width of the outermost border. Accepts a number (e.g. 2) followed immediately with a CSS-compatible unit of measurement. (e.g. \"px\") Example: 2px.",
"type": "string",
"default": "1px"
},
"bg": {
"label": "Title bar's color",
"description": "Color of the title bar. Can be set any valid CSS color value but please take care that text would remain black.",
"type": "string",
"aliases": [
"background"
],
"default": "#CFC"
},
"padding": {
"label": "Padding",
"description": "Width of the padding, the empty space between border and the contents. Accepts a number (e.g. 2) followed immediately with a CSS-compatible unit of measurement. (e.g. \"px\") Example: 2px.",
"default": "8px"
},
"bg1": {
"label": "Outer background",
"description": "Color of the space between the inner and outer border. Can be set to any valid CSS color.",
"type": "string",
"default": "transparent"
},
"b-color": {
"label": "Outer border color",
"description": "Color of the outer border. Can be any valid CSS color.",
"type": "string",
"default": "silver"
},
"width": {
"label": "Collapse box width.",
"description": "The width of the entire collapsed box.",
"type": "string",
"default": "100%"
},
"center": {
"label": "Center-align title",
"description": "If set to any value, the title will be centered.",
"type": "string"
},
"fc": {
"label": "Font color",
"description": "Font color for the title. Also sets the color of the [show]/[hide] link. Can be any valid CSS color",
"type": "string"
}
}
}
</templatedata>

== Re-using at other wikis ==
This template depends upon having rules for the three classes (collapsible, uncollapsed, and collapsed) in the appropriate CSS files, and some related JavaScript installed. This template transcludes {{tl|main other}} and {{tl|lorem ipsum}}, which should also be imported at the same time.

For MediaWiki versions ≥ 1.18, this template can simply be exported and then imported into another MediaWiki installation. Changes to the source code that will need to be made are:
:* <code>class="collapsible</code> needs to be changed to <code>class="mw-collapsible</code> (probably because the class had apparently been deprecated since ''MediaWiki v1.20'').
:* <code>|#default=collapsed}}</code> changed to <code>|#default=mw-collapsed}}</code>.
:* Some additional changes to the source code will need to be made in order for this template to become usable on the Main/Article (ns:0) [[mw:Help:Namespaces|namespace]].

The toggle text can be edited at external Wiki's [[MediaWiki:Collapsible-expand]] and [[MediaWiki:Collapsible-collapse]] pages. Further information at [[mw:ResourceLoader/Modules#jquery.makeCollapsible|jquery.makeCollapsible module]].

== See also ==
* {{Tl|collapse top}}
* {{Tl|collapse bottom}}
* {{tl|discussion top}}
* {{tl|archive top}}
* {{tl|hidden archive top}}

<includeonly>

[[Category:Archival templates|{{PAGENAME}}]]
[[Category:Collapse templates|{{PAGENAME}}]]

</includeonly>

Template:Collapse

2018-04-08T13:35:29Z

Max: 1 revision imported

{|  class="mw-collapsible {{#switch:{{lc:{{{expand|no}}}}}|uncollapse|uncollapsed|expand|expanded|yes|y=mw-uncollapsed|#default=mw-collapsed}}" style="{{{{{|safesubst:}}}#ifeq:{{NAMESPACEE}}|{{ns:0}}|display: none;}}background-color: {{{bg1|transparent}}}; text-align: left; border: {{{border|1px}}} solid {{{b-color|silver}}}; {{{{{|safesubst:}}}#switch:{{{float|}}}
| left = margin:0.2em 0.5em 0.2em 0; width:{{{{{|safesubst:}}}#if:{{{width|}}}|{{{width}}}|auto}}; float: left; clear: {{{clear|left}}}
| right = margin:0.2em 0 0.2em 0.5em; width:{{{{{|safesubst:}}}#if:{{{width|}}}|{{{width}}}|auto}}; float: right; clear: {{{clear|right}}}
| none = margin:0.2em 0; width:{{{{{|safesubst:}}}#if:{{{width|}}}|{{{width}}}|auto}}; clear: {{{clear|none}}}
| center | centre = margin:0.2em auto; width:{{{{{|safesubst:}}}#if:{{{width|}}}|{{{width}}}|auto}}; clear: {{{clear|both}}}
| #default = margin: 0.2em auto auto; width:{{{{{|safesubst:}}}#if:{{{width|}}}|{{{width}}}|100%}}; clear: {{{clear|both}}}
}}; padding: 1px;"
|-
! style="background-color: {{{background|{{{bg|#F0F2F5}}}}}}; font-size:87%; padding:0.2em 0.3em; text-align: {{{{{|safesubst:}}}#if:{{{left|}}}|left|{{{{{|safesubst:}}}#if:{{{center|}}}|center|left}}}}; {{{{{|safesubst:}}}#if:{{{fc|}}}|color: {{{fc}}};|}}" | {{{2|{{{title|{{{heading|{{{header|Extended content}}}}}}}}}}}}
|-
| style="border: solid {{{border2|1px silver}}}; padding: {{{padding|8px}}}; background-color: {{{bg2|white}}};" |
<div>{{{1<noinclude>|{{lorem ipsum|3}}</noinclude>}}}</div>
|}{{{{{|safesubst:}}}#ifeq:{{NAMESPACEE}}|{{ns:0}}|[[Template:collapse]] is not available for use in articles (see [[MOS:COLLAPSE]]).}}<noinclude>
{{Documentation}}
</noinclude>

List of Oddworld characters

2018-04-07T17:32:54Z

Max: Added Fong Foo

{| class="wikitable sortable" border="1"
|-
! scope="col" | Character
! scope="col" | Species
! scope="col" class="unsortable" | Description
|-
| [[Abraham Lure]] || [[Mudokon]] ||
|-
| [[Alf]] || [[Mudokon]] ||
|-
| [[Buddy]] || [[Mudokon]] ||
|-
| [[Toby]] || [[Mudokon]] ||
|-
| [[Soots]] || [[Mudokon]] ||
|-
| [[Stumpy]] || [[Mudokon]] ||
|-
| [[Weirdos]] || [[Mudokon]] ||
|-
| [[Sam]] || [[Mudokon]] ||
|-
| [[Big Face]] || [[Mudokon]] ||
|-
| [[Shaman]] || [[Mudokon]] ||
|-
| [[Ed]] || [[Mudokon]] ||
|-
| [[Asset 98]] || [[Mudokon]] ||
|-
| [[Molluck]] || [[Glukkon]] ||
|-
| [[Aslik]] || [[Glukkon]] ||
|-
| [[Dripik]] || [[Glukkon]] ||
|-
| [[Phleg]] || [[Glukkon]] ||
|-
| [[Brewmaster]] || [[Glukkon]] ||
|-
| [[Margaret]] || [[Glukkon]] ||
|-
| [[Lulu]] || [[Glukkon]] ||
|-
| [[Sask]] || [[Glukkon]] ||
|-
| [[Chester Payne]] || [[Glukkon]] ||
|-
| [[Tex]] || [[Glukkon]] ||
|-
| [[Skillya]] || [[Slig]] ||
|-
| [[Crig]] || [[Slig]] ||
|-
| [[Wildum]] || [[Slig]] ||
|-
| [[Albino Slig]] || [[Slig]] ||
|-
| [[Newscaster]] || [[Slig]] ||
|-
| [[Valet Slig]] || [[Slig]] ||
|-
| [[Fong Foo]] || [[Slig]] ||
|-
| [[Latamire Munch]] || [[Gabbit]] ||
|-
| [[Raisin]] || [[Elderling]] ||
|-
| [[Stranger]] || [[Steef]] ||
|-
| [[Sekto]] || [[Oktigi]] ||
|-
| [[Shrykull]] || Deity ||
|-
| [[Fangus Klot]] || [[Fangustanian]] ||
|-
| [[Squeek]] || Unknown ||
|-
| [[Nod]] || Unknown ||
|-
| [[Humphrey]] || [[Vykkers]] ||
|-
| [[Irwin]] || [[Vykkers]] ||
|-
| [[Headley]] || [[Vykkers]] ||
|-
| [[Doc]] || [[Vykkers]] ||
|-
| [[Blisterz Booty]] || [[Outlaw]] ||
|-
| [[Boilz Booty]] || [[Outlaw]] ||
|-
| [[Filthy Hands Floyd]] || [[Outlaw]] ||
|-
| [[Looten Duke]] || [[Outlaw]] ||
|-
| [[Jo' Mamma]] || [[Outlaw]] ||
|-
| [[Meagley McGraw]] || [[Outlaw]] ||
|-
| [[Tiny]] || [[Outlaw]] ||
|-
| [[Scuz]] || [[Outlaw]] ||
|-
| [[Packrat Palooka]] || [[Outlaw]] ||
|-
| [[X'Plosives McGee]] || [[Outlaw]] ||
|-
| [[Elboze Freely]] || [[Outlaw]] ||
|-
| [[Lefty Lugnutz]] || [[Outlaw]] ||
|-
| [[Fatty McBoomBoom]] || [[Outlaw]] ||
|-
| [[D. Caste Raider]] || [[Outlaw]] ||
|-
| [[Cleever McMince]] || [[Outlaw]] ||
|-
| [[Nilsworth ‘Pokey’ O’Shafster]] || [[Outlaw]] ||
|-
| [[Mortimar Bang]] || [[Outlaw]] ||
|-
| [[Shorty]] || [[Outlaw]] ||
|-
| [[Snapps Manic]] || [[Outlaw]] ||
|-
| [[Gunter ‘Sparky’ VonFahrenheiten]] || [[Outlaw]] ||
|-
| [[Larry Flinger]] || Unknown ||
|-
| [[Fats Fuggler]] || Unknown ||
|-
| [[Uncle Turkey Toes]] || [[Clakker]] ||
|-
| [[Billyboy]] || [[Clakker]] ||
|-
| [[Eugene Ius]] || [[Clakker]] ||
|-
| [[Professor Dimple]] || [[Clakker]] ||
|-
| [[Farmer Beeks]] || [[Clakker]] ||
|-
| [[Martha May Beeks]] || [[Clakker]] ||
|-
| [[Suzy Ray Beeks]] || [[Clakker]] ||
|-
| [[Billy Bob Warthog]] || [[Clakker]] ||
|-
| [[Bawhnee Sue McUgly]] || [[Clakker]] ||
|-
| [[Cornjaws]] || [[Clakker]] ||
|-
| [[Skycart Joe]] || [[Clakker]] ||
|}

List of Oddworld species

2018-04-07T17:31:26Z

Max: Added Devil Vine, Unidentified creatures, and Unnamed wildlife; turned species names into singular

{| class="wikitable sortable" border="1"
|-
! scope="col" | Species
! scope="col" | Faction
! scope="col" | Type
! scope="col" class="unsortable" | Description
|-
| [[1%er]] || Civilized || Race || Bikers, unused
|-
| [[Bat]] || Wildlife || Wild ||
|-
| [[Bee]] || Wildlife || Wild ||
|-
| [[Bird]] || Wildlife || Wild ||
|-
| [[Bolamite]] || Wildlife || Wild || Live Ammo
|-
| [[Boombat]] || Wildlife || Wild || Live Ammo
|-
| [[Chippunk]] || Wildlife || Wild || Live Ammo
|-
| [[Chronicler]] || Civilized || Race || Accountants, lawyers, stock brokers, unused
|-
| [[Clakker]] || Civilized || Race || Townsfolk
|-
| [[Devil Vine]] || Plant || Wild || Live Ammo, unused
|-
| [[Elderling]] || Native || Race || Prophets, advisors
|-
| [[Elums]] || Native || Domesticated || Steeds, meat
|-
| [[Fangustanian]] || Native || Race || Unused
|-
| [[Fleech]] || Wildlife || Wild || Pets
|-
| [[Frogger]] || Wildlife || Wild || Sacred, unused
|-
| [[Frogger|Frogger symbiote]] || Wildlife || Wild || Unused
|-
| [[Fuzzle]] || Wildlife || Wild || Lab animals, pets, meat, Live Ammo
|-
| [[Gabbit]] || Native || Race || Replacement lungs, various consumer products
|-
| [[Garbage truck creature]] || Wildlife || Domesticated || Garbage truck, unused
|-
| [[Gloktigi]] || Civilized || Race || Elite security
|-
| [[Glukkon]] || Civilized || Race || Business executives
|-
| [[Grubb]] || Native || Race ||
|-
| [[Guardian]] || Native || Wild || Defence, sacred, extinct
|-
| [[Heyhey]] || Civilized || Race || Unused
|-
| [[Hint Fly]] || Wildlife || Wild ||
|-
| [[Intern]] || Civilized || Race || Lab assistants, security
|-
| [[Khanzumer]] || Civilized || Race || Consumers, unused
|-
| [[Kinto]] || Wildlife || Wild || Slaves, unused
|-
| [[Kinto|Kinto slaver]] || Civilized || Race || Slavers, unused
|-
| [[Lusk]] || Unknown || Race || Marauders, unused
|-
| [[Meech]] || Wildlife || Wild || Meat, sacred, unused
|-
| [[Meep]] || Native || Domesticated || Meat
|-
| [[Meetle]]/Mug || Wildlife || Domesticated || Transport, tanks, unused
|-
| [[Mudflub]] || Wildlife || Wild || Blubber, unused
|-
| [[Mudokon]] || Native || Race || Slave labour
|-
| [[Musklum]] || Unknown || Race || Unused
|-
| [[Oktigi]] || Civilized || Race || Business executives
|-
| [[Opinionite]] || Civilized || Race || Unused
|-
| [[Outlaw]] || Outlaws || Race || Outlaws
|-
| [[Paramite]] || Wildlife || Wild || Meat, sacred
|-
| [[Pokeypine]] || Wildlife || Wild || Live Ammo, unused
|-
| [[Priest]] || Civilized || Race || Priests, unused
|-
| [[Rat]] || Wildlife || Wild || Avatars
|-
| [[Scoot]]/Worry Fish || Wildlife || Wild ||
|-
| [[Scrab]] || Wildlife || Wild || Meat, sacred
|-
| [[Scuba Toad]] || Native || Race || Unused
|-
| [[Sea Rex]] || Wildlife || Wild || Unused
|-
| [[Skeeter]] || Wildlife || Wild || Unused
|-
| [[Sleg]] || Wildlife || Wild || Pets, security
|-
| [[Slig]] || Civilized || Race || Security, personal assistants
|-
| [[Slog]] || Civilized || Domesticated || Security
|-
| [[Slurg]] || Wildlife || Wild ||
|-
| [[Sniper Wasp]] || Wildlife || Wild || Live Ammo
|-
| [[Spider]] || Wildlife || Wild || Unused
|-
| [[SpooceShrub]] || Plant || Wild || Spooce
|-
| [[Stang]] || Wildlife || Wild || Unused
|-
| [[Steef]] || Native || Race ||
|-
| [[Stingbee]] || Wildlife || Wild || Live Ammo
|-
| [[Stunk]] || Wildlife || Wild || Live Ammo
|-
| [[Thudslug]] || Wildlife || Wild || Live Ammo
|-
| [[Unidentified creatures]] || Wildlife || Wild ||
|-
| [[Unnamed wilflife]] || Wildlife || Wild || Unused
|-
| [[Vamp]] || Civilized || Race || Unused
|-
| [[Vykker]] || Civilized || Race || Doctors, researchers
|-
| [[Wolvark]] || Civilized || Race || Security
|-
| [[Zappfly]] || Wildlife || Wild || Live Ammo
|}

Devil Vine

2018-04-07T17:18:37Z

Max: Created page with "A '''Devil Vine''' is a plant that was designed for ''Stranger’s Wrath'' as a type of Live Ammo. According to concept art, Stranger wou..."

A '''Devil Vine''' is a [[List of Oddworld species|plant]] that was designed for ''[[Stranger’s Wrath]]'' as a type of [[Live Ammo]].

According to concept art, Stranger would have fired an animated seed that would grow into a sentient plant. This plant would then reach towards nearby enemies and restrain them in cocoons.

== Appearances ==
Concept art for the Devil Vine appears in one of the unlockable images in ''[[Stranger’s Wrath HD]]'' for [[PlayStation]] 4 and PlayStation Vita.

== References ==
# '''Just Add Water (21/12/2011)'''. ‘Extras’, ''Oddworld: Stranger’s Wrath HD'', PlayStation 4. Oddworld Inhabitants.
# '''Just Add Water (19/12/2012)'''. ‘Extras’, ''Oddworld: Stranger’s Wrath HD'', PlayStation Vita. Oddworld Inhabitants.
[[Category:Unused species]]
[[Category:Live Ammo]]
[[Category:Plants]]

Pokeypine

2018-04-07T15:50:44Z

Max: Created page with "A '''Pokeypine''' is a creature that was designed for ''Stranger’s Wrath'' as a type of Live Ammo. According to Wil Bunce-Edwards,..."

A '''Pokeypine''' is a [[List of Oddworld species|creature]] that was designed for ''[[Stranger’s Wrath]]'' as a type of [[Live Ammo]].

According to [[Wil Bunce-Edwards]], the Pokeypine was dropped early in development and was usually refered to as ‘porcupine’ in filenames.

== Appearances ==
A concept sketch, render of a 3D model, and a cartoon icon of a Pokeypine appear in one of the unlockable images in ''[[Stranger’s Wrath HD]]'' for [[PlayStation]] 4 and PlayStation Vita. The cartoon icon was used as Wil’s avatar on the [[Oddworld Forums]] for a while.<ref name="wilAvatar"/>

== References ==
<references>
<ref name="wilAvatar">'''Bunce-Edwards, Wil (14/05/2012)'''. [http://www.oddworldforums.net/showthread.php?p=540795#post540795 Post #755] in ‘Oddworld Questions & Answers VIII’. Oddworld Discussion. Oddworld Forums.</ref>
</references>
[[Category:Unused species]]
[[Category:Live Ammo]]

Max the Mug

2018-04-07T15:40:58Z

Max: Max moved page Max the Mug to Wil Bunce-Edwards: No longer using the screen name Max

#REDIRECT [[Wil Bunce-Edwards]]

Wil Bunce-Edwards

2018-04-07T15:40:57Z

Max: Max moved page Max the Mug to Wil Bunce-Edwards: No longer using the screen name Max

[[File:Maxoddtour4.jpg|thumb|Max the Mug at [[OddTour#OddTour_4 | OddTour 4b]]]]
'''William Bunce-Edwards''' (born 7 October 1987), also known by his screen name '''Max the Mug''', is the Studio Coordinator of [[Just Add Water]] and long-term [[Oddworld fan]]. Along with [[Xavier De Coster]] he co-owns [[Oddworld Library]] and along with [[Nathan Rose]] he co-administrates the [[Oddworld Forums]].

== Oddworld fan ==
Bunce-Edwards got an original PlayStation on Christmas Day 1997, and on Boxing Day 1997 played the ''[[Oddworld: Abe’s Oddysee]]'' demo on the demo disc that came with it; he got the full game in the summer of 1998.<ref name="fom"/><ref name="elderberries"/> It wasn’t until he recognized [[Mudokons]] in a magazine he was flicking through that he realized he was a true fan.<ref name="fom"/> He joined the GT Interactive Software message boards in 1998 with the username '''skELUMton''' to ask what a [[Greeter]] looked like (getting ''[[Abe’s Exoddus]]'' on Easter Sunday 1999), but along with the other regular posters moved to the [[Exoddus Club]] when activity on the GTIS boards died down, joining as '''billy_squeek''' on 12 February 2000.<ref name="toexoddusclub"/><ref name="ecmemlist"/>

Bunce-Edwards first came to the attention of [[Oddworld Inhabitants]] when he emailed [[Alf]] with a collated list of errors regarding the [[Oddworld Map]] and was in return made [[Fan of the Month]] February–March 2003 on the official Oddworld website.<ref name="fom"/><ref name="firstmail"/><ref name="beforefom"/><ref name="heresfom"/><ref name="aboutfom"/><ref name="afterfom"/>

Bunce-Edwards has attended several [[OddTours]]: OddTour 2 in Amsterdam, 2004;<ref name="oddtour2"/> OddTours 3a and 3b in London, 2008;<ref name="oddtour3"/> and OddTours 4a and 4b in London, 2010.<ref name="oddtour4"/>

=== Oddworld Forums ===
Bunce-Edwards joined the [[Oddworld Forums]] as '''Max the Meetle''' on 4 June 2000<ref name="ezboardprofile"/>, changing his screen name to '''Max the Mug''' when the Forums moved to Ultimate Bulletin Board.<ref name="newname"/>

Bunce-Edwards began being called ‘The Oddworld Dictionary’ and ‘The Oddworld Encyclopedia’ at least as far back as April 2001<ref name="dannyDictionary"/><ref name="maxEnc"/>, although because the original ezboard Oddworld Forums are not well preserved the terms could pre-date this. The latter nickname became the more popular and longer lasting, being made Bunce-Edwards’s custom title around September 2002<ref name="khanzStatus"/> and remaining in use until June 2004,<ref name="xavSekEnc"/> after which the term was used in discussions exclusively referring to his [[Oddworld Encyclopædia|fansite]]. However, his custom status remained ‘Oddworld Encyclopædia’ until at least May 2006,<ref name="pedstatus"/> and ‘The Oddworld Encyclopædist’ until at least May 2008.<ref name="paedist"/>

Key Oddworld Forums features to which Bunce-Edwards has contributed include the current ''[[Stranger’s Wrath]]''-themed titles<ref name="swtitles"/>, the current Oddworld-themed reputation levels<ref name="replevels"/> and the current Forum rules.<ref name="rules"/>

==== Member of staff ====
Bunce-Edwards stopped posting on the Oddworld Forums in August 2002 in favour of [[The Glass Asylum]],<ref name="farewell"/> but returned the following month<ref name="owfreturn"/> having missed the Forums-wide moderator elections that saw [[Xavier De Coster]] join the moderation team;<ref name="start2002elecs"/><ref name="end2002elecs"/> he was elected moderator of [[General Oddworld Discussion]] (and by extension the [[Spoiler Forum]]) by public election the following year.<ref name="start2003elecs"/><ref name="end2003elecs"/> He retired from moderatorship in July 2005<ref name="endofmod"/> only to return as a Super Moderator of Zulag One in February 2007<ref name="smod"/> and be promoted to administrator in January 2008 to complement the Oddworld Library’s new sponsorship by the Oddworld Forums.<ref name="admin"/>

{| class="wikitable" border="1"
|+ Sortable table
|-
! scope="col" | Role
! scope="col" | Forum(s)
! scope="col" | Appointment
! scope="col" | Retirement
|-
| [[Moderator]] || [[General Oddworld Discussion]] || 16 September 2003 || 15 July 2005
|-
| [[Moderator]] || [[Spoiler Forum]] || 19 June 2004? || 15 July 2005
|-
| [[Super Moderator]] || [[Zulag One]] || 1 February 2007 || ''Still active''
|-
| [[Oddworld Administrator]] || N/A || 15 January 2008 || ''Still active''
|}

==== Annual Oddworld Forums Poster Awards ====
Bunce-Edwards has won the following Poster Awards in the following years:

; [[Member With The Best Oddworld Knowledge]]
: [[1st Annual Oddworld Forums Poster Awards|2003]]–[[8th Annual Oddworld Forums Poster Awards|2010]]
; [[Best Advice Giver]]
: [[2nd Annual Oddworld Forums Poster Awards|2004]], [[4th Annual Oddworld Forums Poster Awards|2006]]
; [[Best Veteran|Best Old Dude]]
: [[2nd Annual Oddworld Forums Poster Awards|2004]]
; [[Most Meaningful Poster]]
: [[2nd Annual Oddworld Forums Poster Awards|2004]]–[[4th Annual Oddworld Forums Poster Awards|2006]]
; [[Most Dedicated Member]]
: [[5th Annual Oddworld Forums Poster Awards|2007]]
; [[Most Valuably Poster (MVP)]]
: [[5th Annual Oddworld Forums Poster Awards|2007]], [[8th Annual Oddworld Forums Poster Awards|2010]]
; [[Most Liked]]
: [[7th Annual Oddworld Forums Poster Awards|2009]]
; [[Oddworld Forums Unofficial Mascot]]
: [[7th Annual Oddworld Forums Poster Awards|2009]]

=== Oddworld Library ===
Bunce-Edwards’s first attempt at a fansite was a 2000 webpage on Xoom called ‘The Kennels’. It took the form of a conjoined twin [[Glukkon]] called Glasp taking the reader on a tour around the Kennels, which hosted one of each [[Oddworld species|Oddworld creature]] known at the time.<ref name="kennels"/> By 2001, the project changed to one more formally encyclopædic in nature called ‘The Scrabacombs’,<ref name="scrabacombs"/> but by 2002 this was renamed to ‘The Oddworld Encyclopedia’ to reflect his Oddworld Forums nickname.<ref name="websiteEnc"/> Despite numerous promises that the site was coming, only an FAQ appeared (in 2003)<ref name="firstfaq"/> before [[The Oddworld Encyclopædia]] finally launched in April 2006—although the April Fools’ Day joke articles were little appreciated by members of the Oddworld Forums given the site’s long-awaited appearance.<ref name="TOLlaunch"/>

By this time Bunce-Edwards had already created [[OddBlog]]<ref name="oddblog"/>—originally a personal blog but quickly evolving into an Oddworld news blog—and had made plans to have it join with [[Xavier De Coster]]’s [[TOGG]] and Oddsville’s [[Oddworld Archives]] to form ‘The Shaman Network’. Although De Coster eventually assumed Oddsville’s role of creating the Archives and most component subsites were already public, the project—incorporating The Oddworld Encyclopædia and renamed ‘[[The Oddworld Library]]’—was formally launched simultaneously with the Encyclopædia.<ref name="TOLlaunch"/> The Oddworld Forums became a sponsor of the Oddworld Library in January 2008 by adding a link to the fansite to the top of its banner alongside links to [[Oddworld-Web]] and [[Oddworld Universe]].<ref name="admin"/>

== Just Add Water ==
Bunce-Edwards and De Coster visited the office of [[Just Add Water]] in August 2010, between [[OddTours]] 3a and 3b, meeting [[Stewart Gilray]] for the first time. Bunce-Edwards was invited back to the office in November that year where he was offered the task of looking after the [[official Oddworld Inhabitants website]] and [[Oddworld Inhabitants Facebook Page|Facebook Page]] in his spare time.<ref name="JAW"/>

At the start of August 2011, Bunce-Edwards began working in the office full-time with the job title of Studio Coordinator. His usual tasks include monitoring of Oddworld fan communities, filing, watering plants and communicating with fans, job applicants, the gaming press and potential merchandise partners. During the production of ''[[Oddworld: Stranger’s Wrath HD]]'' he put together the unlockable extras, contributed to the [[Achievements in Oddworld: Stranger’s Wrath|achievements]] and decided where to place the [[RuptureFarms barrels in ''Oddworld: Stranger’s Wrath HD''|easter eggs]]. Although he had updated his Twitter and Facebook profiles to accurately identify his job with JAW, Bunce-Edwards did not declare his employment on the Oddworld Forums until 23 December 2011.<ref name="JAW"/>

== References ==
<references>
<ref name="fom">Odd Wide Web, Oddworld Archives, Oddworld Library (15 August 2010). Archive of Max the Mug (19 February 2003). [http://oddworldlibrary.net/archives/web/oddworld.com/firsttenyears/alf/ow_fan2_03.shtml Fan of the Month February–March 2003]. Alf’s Fan Odds N Ends. Alf’s Rehab & Tea. Official Oddworld website.</ref>

<ref name="elderberries">Max the Mug (22 June 2004). [http://www.oddworldforums.net/showthread.php?p=158224&highlight=demo#post158224 Post 14] in ‘What made YOU buy your first OW game?’. Oddworld Discussion. Oddworld Forums.</ref>

<ref name="toexoddusclub">Max the Mug (24 August 2001). [http://www.oddworldforums.net/showthread.php?p=30920#post30920 Post 13] in ‘How did you find Oddworld Forums?’. Oddworld Discussion. Oddworld Forums.</ref>

<ref name="ecmemlist">[http://games.groups.yahoo.com/group/exoddusclub/members Exoddus Club member list]. Exoddus Club. Yahoo! Groups. (accessed 26 November 2010)</ref>

<ref name="ezboardprofile">Wayback Machine (1 September 2001). Archive of [http://web.archive.org/web/20010901052759/pub10.ezboard.com/boddworldian.showLocalUserPublicProfile?login=maxthemeetle Profile for Max the Meetle]. Oddworld Forums. ezboard.</ref>

<ref name="newname">Max the Mug (14 April 2001). [http://www.oddworldforums.net/showthread.php?p=6480#post6480 Post 20] in ‘Welcome to Oddworld General Discussion’. Oddworld Discussion. Oddworld Forums.</ref>

<ref name="dannyDictionary">Danny (19 April 2001). [http://www.oddworldforums.net/showthread.php?p=7360&#post7360 Post 15] in ‘rumours’. Oddworld Discussion. Oddworld Forums.</ref>

<ref name="maxEnc">Max the Mug (17 April 2001). [http://www.oddworldforums.net/showthread.php?p=6884&#post6884 Post 19] in ‘hey! vital info on munch to be noted!’. Oddworld Discussion. Oddworld Forums.</ref>

<ref name="khanzStatus">TheKhanzumer (23 September 2002). [http://www.oddworldforums.net/showthread.php?p=87573&#post87573 Post 11] in ‘Look at this pic.’. Oddworld Discussion. Oddworld Forums.</ref>

<ref name="xavSekEnc">Xavier & Sekto Springs (21 June 2004). [http://www.oddworldforums.net/showthread.php?p=158090&#post158090 Posts 34] & 35 in ‘Centered around the poor side of Oddworld!’. Oddworld Discussion. Oddworld Forums.</ref>

<ref name="pedstatus">Wayback Machine (4 May 2006). Archive of Max the Mug (6 May 2004). ‘[http://web.archive.org/web/20060504005357/www.oddworldforums.net/showthread.php?t=10017 Oddworld Questions and Answers III]’. Oddworld Discussion. Oddworld Forums.</ref>

<ref name="paedist">Wayback Machine (5 May 2008). Archive of ‘[http://web.archive.org/web/20080505011113/http://www.oddworldforums.net/member.php?u=20 View Profile: Max the Mug]’. Oddworld Forums.</ref>

<ref name="replevels">Alcar (20 March 2008). ‘[http://www.oddworldforums.net/showthread.php?t=16758 Revamped Reputation Levels]’. Forum Suggestions & Help. Oddworld Forums.</ref>

<ref name="swtitles">Oddworld Forums members (2–26 April 2006). ‘[http://www.oddworldforums.net/showthread.php?t=13668 New Titles System]’. Employee Lounge. Oddworld Forums.</ref>

<ref name="rules">Oddworld Forums members (13 July – 23 September 2010). ‘[http://www.oddworldforums.net/showthread.php?t=19363 Forum Rules]’. Employee Lounge. Oddworld Forums.</ref>

<ref name="firstmail">Oddworld Forums members (19 June – 25 August 2002). ‘[http://www.oddworldforums.net/showthread.php?t=5391 first Oddworld mail!]’. Oddworld Discussion. Oddworld Forums.</ref>

<ref name="beforefom">Oddworld Forums members (29 September – 3 October 2002). ‘[http://www.oddworldforums.net/showthread.php?t=6522 Map Of Oddworld]’. Oddworld Discussion. Oddworld Forums.</ref>

<ref name="heresfom">Wayback Machine (22 March 2003). Archive of Oddworld Inhabitants (19 February 2003). [http://web.archive.org/web/20030322165823/http://oddworld.com/ ‘What’s New’ February–March 2003]. Official Oddworld website.</ref>

<ref name="aboutfom">Oddworld Forums members (19 February – 8 March 2003). ‘[http://www.oddworldforums.net/showthread.php?t=7486 Oddworld site updated...HAHA, I beat the fans...!!]’. Oddworld Discussion. Oddworld Forums.</ref>

<ref name="afterfom">Oddworld Forums members (1 – 3 March 2003). ‘[http://www.oddworldforums.net/showthread.php?t=7533 Map of Oddworld]’. Oddworld Discussion. Oddworld Forums.</ref>

<ref name="oddtour2">Oddworld Forums members (12 July – 9 August 2004). ‘[http://www.oddworldforums.net/showthread.php?t=10384 Amsterdam Oddworld Meeting (The Report) -56K Unfriendly-]’. Off-Topic Discussion. Oddworld Forums.</ref>

<ref name="oddtour3">Oddworld Forums members (2–5 May 2008). ‘[http://www.oddworldforums.net/showthread.php?t=16933 OddTour 3]’. Off-Topic Discussion. Oddworld Forums.</ref>

<ref name="oddtour4">Oddworld Forums members (13 September – 8 November 2010). ‘[http://www.oddworldforums.net/showthread.php?t=19651 OddTour 4]’. Off-Topic Discussion. Oddworld Forums.</ref>

<ref name="farewell">Max the Mug (19 August 2002). [http://www.oddworldforums.net/showthread.php?p=82224#post82224 Post 44] in ‘Farewell’. Off-Topic Discussion. Oddworld Forums.</ref>

<ref name="owfreturn">Max the Mug (14 September 2002). [http://www.oddworldforums.net/showthread.php?p=86136#post86136 Post 9] in ‘The slogan game’. Oddworld Discussion. Oddworld Forums.</ref>

<ref name="start2002elecs">Oddworld Forums members (20–26 August 2002). ‘[http://www.oddworldforums.net/showthread.php?t=6120 Moderator Applications now Open!]’. Forum Suggestions & Help. Oddworld Forums.</ref>

<ref name="end2002elecs">Oddworld Forums members (26 August – 8 September 2002). ‘[http://www.oddworldforums.net/showthread.php?t=6202 Voting has begun!]’. Forum Suggestions & Help. Oddworld Forums.</ref>

<ref name="start2003elecs">Oddworld Forums members (24 August – 17 September 2003). ‘[http://www.oddworldforums.net/showthread.php?t=8825 New Moderator Nominations]’. Forum Suggestions & Help. Oddworld Forums.</ref>

<ref name="end2003elecs">Oddworld Forums members (16–23 September 2003). ‘[http://www.oddworldforums.net/showthread.php?t=8936 New Moderators]’. Forum Suggestions & Help. Oddworld Forums.</ref>

<ref name="endofmod">Alcar (15 July 2005). ‘[http://www.oddworldforums.net/showthread.php?t=12480 Staff Shifting and New Positions]’. Forum Suggestions & Help. Oddworld Forums.</ref>

<ref name="smod">Alcar (1 February 2007). ‘[http://www.oddworldforums.net/showthread.php?t=14947 New Off-Topic Mod & Zulag 1 SMod]’. Forum Suggestions & Help. Oddworld Forums.</ref>

<ref name="admin">Alcar (15 January 2008). ‘[http://www.oddworldforums.net/showthread.php?t=16485 TOL Sponsorship & Staff Changes]’. Forums Suggestions & Help. Oddworld Forums.</ref>

<ref name="kennels">billy_squeek (2 July 2000). ‘[http://games.groups.yahoo.com/group/exoddusclub/message/2451 My Webpage]’. Exoddus Club. Yahoo! Groups.</ref>

<ref name="scrabacombs">Max the Mug (22 April 2001). ‘[http://www.oddworldforums.net/showthread.php?t=2722 Coming Soon - The Scrabacombs]’. Oddworld Discussion. Oddworld Forums.</ref>

<ref name="websiteEnc">Max the Mug (7 April 2002). [http://www.oddworldforums.net/showthread.php?p=58789#post58789 Post 10] in ‘There's more than one Shrink!?’. Oddworld Discussion. Oddworld Forums.</ref>

<ref name="firstfaq">Cloverfield (24 June 2003). ‘[http://www.oddworldforums.net/showthread.php?t=8382 Oddworld FAQs: READ]’. Oddworld Discussion. Oddworld Forums.</ref>

<ref name="TOLlaunch">Max the Mug (1 April 2006). ‘[http://www.oddworldforums.net/showthread.php?t=13663 The Oddworld Library - grand opening]’. Oddworld Discussion. Oddworld Forums.</ref>

<ref name="oddblog">Max the Mug (17 August 2003). ‘[http://oddworldlibrary.net/oddblog/2003/08/OddBlog_created OddBlog created]’. OddBlog. Oddworld Library.</ref>

<ref name="JAW">Bunce-Edwards, William (23 December 2011). ‘[http://www.oddworldforums.net/blog.php?b=3424 Job]’. Post on ‘A Max to Grind’. Blogs. Oddworld Forums.</ref>

</references>
[[Category:Fans of the Month]]
[[Category:Oddworld Forums staff]]
[[Category:Oddworld Library staff]]
[[Category:Annual Oddworld Forums Poster Awards winners]]
[[Category:Just Add Water employees]]

Pokeypines

2018-04-07T14:50:27Z

Max: Redirected page to Pokeypine

#REDIRECT [[Pokeypine]]

Greeter

2018-04-07T14:44:01Z

Max:

A '''Greeter''' is an [[Oddworld appliances|appliance]] used by [[Glukkons]] as a combined vending machine, advertiser, security guard, and company greeter. Greeters often patrol [[Magog Cartel]] factories and facilities, commonly for the purpose of distributing [[SoulStorm Brew]] to [[Mudokon]]s. They appear in ''[[Oddworld: Abe’s Exoddus|Abe’s Exoddus]]'' gameplay.

== History ==
[[Vykkers]] originally designed Greeters for the Magog Cartel to be aggressive, self-promoting vending machines that would follow Mudokons, delivering a sales pitch and selling them [[Oddworld comodditites|comoddities]]. They were meant to double as automated greeters, welcoming business associates to Glukkon workplaces, while attacking intruders.<ref name="AOWI128"/>

To fulfil these multiple roles, Greeters were equipped with motion detectors and identity recognition intended to distinguish authorized employees and visitors from trespassers. Unfortunately, a programming error caused Greeters to attack Mudokons indiscriminately.<ref name="AEManual"/> Unable to fix the software, the Glukkons decided that Greeters would be retrofitted and used as security devices. Mudokon workers are informed that they can avoid electrocution by remaining motionless in the Greeters’ infrared beam.<ref name="StoneGreeters"/>

== Construction ==
The main body of a Greeter resembles a four-foot-tall (1·2 m)<ref name="OcInsInh"/> cylinder constructed from sheets of scrap metal,<ref name="AOWI128"/> with a control box, exhaust pipe, and steam whistle (or ‘horn’)<ref name="OcGreeters"/> attached to the rear. The front of a Greeter is fitted with a large grin, intended to appeal to consumers,<ref name="AOWI128"/> which lip syncs to the speech produced by the appliance’s voicebox; the Greeter originally delivered comoddity sales pitches, but after being repurposed as a security device, now immitates [[Slig]] phrases.

The base of the main body holds a ring of sensors and lightning dispensers,<ref name="Farzad"/> which joins to a bracket that supports the Greeter on a single wheel. Including this (but excluding the horn), a Greeter’s height is 5 feet 8 inches (1·7 m).<ref name="Farzad"/><ref name="OcInsInhAbe"/>

Greeters maintain excellent balance on their single wheel.<ref name="Alf6"/>

== Appearances ==
=== ''Abe’s Exoddus'' ===
{{Main|Greeters in Abe's Exoddus|List of Greeters in Abe's Exoddus}}
Greeters are an unusual hazard in ''[[Oddworld: Abe’s Exoddus|Abe’s Exoddus]]'', appearing in the levels ‘FeeCo Depot’, ‘Slig Barracks’ and ‘SoulStorm Brewery’. They will chase and attempt to electrocute any Mudokons, including Abe, that they detect, resulting in instant death.

Although Greeters behave like other enemy characters in that they follow patrols, chase Abe and have [[GameSpeak]], they will not detect Abe by sight, sound or (usually) proximity. Greeters only become aggressive if Abe or other Mudokons move while inside the Greeter's motion detector beam. The movement of this beam is difficult to predict because of how it encircles Greeters that are moving across the screen.

=== Merchandise and marketing ===
Greeter concept art by [[Farzad Varahramyan]] appears on page 128 of ''[[The Art of Oddworld Inhabitants]]'' and Image 0006 of [[Oddworld: The Lost Archives]].<ref name="AOWI128"/><ref name="LostArc06"/>

== Behind the scenes ==
Early designs by Farzad explored different shapes for Greeters, but always with a height equal to Abe’s.<ref name="Farzad"/> According to text in his concept sketches, Greeters should <q>behave like a drunk unicyclist and move & sound like an old tinkertoy.</q> The Greeters’ steam horn resembles a scaled down replica Greeter, but with a downturned mouth.

== References ==
<references>
<ref name="OcInsInh">'''Oddworld Inhabitants (~02/1999)'''. ‘[http://oddworldlibrary.net/wiki/Abe's_Exoddus_-_Inhabitants Name: Greeters]’, ‘Inhabitants’. Oddworld.com. Archived by [[Oddworld Library#Oddworld Scriptures|Oddworld Scriptures]] on 08/05/2012.</ref>
<ref name="AEManual">'''O’Connor, Paul (17/11/1998)'''. ‘Greeters’, ‘The Cast’, p. 27. Game manual for ''Oddworld: Abe’s Exoddus''. GT Interactive. <q>Glukkons were aghast when these marketing and P.R. machines began attacking the customers.</q></ref>
<ref name="StoneGreeters">'''Aslik (17/11/1998)'''. ‘Uncle Aslik’s Tourist Tip #9: Greeters Welcome You!’. FeeCo Depot. StoryDwelling Theater. StoryStone (FDP02C16), ‘FeeCo Depot’ (FDP02C10). ''Oddworld: Abe’s Exoddus''. GT Interactive. <q>Remember: If you don’t move, they can’t see you!</q></ref>
<ref name="OcGreeters">'''Oddworld Inhabitants (17/08/2000)'''. ‘[http://oddworldlibrary.net/archives/web/oddworld.com/firsttenyears/universe/industrial/characters/ow_greeter.html Greeters]’. ‘Oddworld Universe’. Oddworld.com. Archived by [[Oddworld Library#Odd_Wide_Web|Odd Wide Web]] on 05/01/2011.</ref>
<ref name="Farzad">'''Varahramyan, Farzad (24/03/1998)'''. ‘Abe II: Greeters’ concept sketches.<ref name="AOWI128"/><ref name="LostArc06"/></ref>
<ref name="AOWI128">'''Johnson, Cathy; Wade, Johnson (15/09/2004)'''. ‘Greeters’, ‘''Oddworld: Abe’s Exoddus''’, p. 128. ''[[The Art of Oddworld Inhabitants|The Art of Oddworld Inhabitants: The First Ten Years 1994–2004]]''. Adelaide, South Australia: Ballistic Publishing.</ref>
<ref name="LostArc06">'''Oddworld Inhabitants (11/12/2017 16:47 UTC)'''. ‘[https://www.instagram.com/p/BckbYBoDf8M/ The Greeter]’. [[Oddworld: The Lost Archives]]. Post on Instagram.</ref>
<ref name="Alf6">'''Alf (01/03/2001)'''. ‘[http://oddworldlibrary.net/archives/web/oddworld.com/firsttenyears/alf/ow_dearalf06.shtml Dear Alf 06]’, q. 31. ‘Alf’s Rehab & Tea’. Oddworld.com. Archived by Odd Wide Web on 05/01/2011.</ref>
<ref name="OcInsInhAbe">'''Oddworld Inhabitants (~02/1999)'''. ‘[http://oddworldlibrary.net/wiki/Abe's_Exoddus_-_Inhabitants Name: Abe]’, ‘Inhabitants’. Oddworld.com. Archived by Oddworld Scriptures on 08/05/2012.</ref>
</references>
[[Category:Appliances]]
[[Category:Abe's Exoddus gameplay]]

Greeter

2018-04-07T14:22:44Z

Max: Created page with "A '''Greeter''' is an appliance used by Glukkons as a combined vending machine, advertiser, security guard, and company greeter. Greeters often pat..."

A '''Greeter''' is an [[Oddworld appliances|appliance]] used by [[Glukkons]] as a combined vending machine, advertiser, security guard, and company greeter. Greeters often patrol [[Magog Cartel]] factories and facilities, commonly for the purpose of distributing [[SoulStorm Brew]] to [[Mudokon]]s. They appear in ''[[Oddworld: Abe’s Exoddus|Abe’s Exoddus]]'' gameplay.

== History ==
[[Vykkers]] originally designed Greeters for the Magog Cartel to be aggressive, self-promoting vending machines that would follow Mudokons, delivering a sales pitch and selling them [[Oddworld comodditites|comoddities]]. They were meant to double as automated greeters, welcoming business associates to Glukkon workplaces, while attacking intruders.<ref name="AOWI128"/>

To fulfil these multiple roles, Greeters were equipped with motion detectors and identity recognition intended to distinguish authorized employees and visitors from trespassers. Unfortunately, a programming error caused Greeters to attack Mudokons indiscriminately.<ref name="AEManual"/> Unable to fix the software, the Glukkons decided that Greeters would be retrofitted and used as security devices. Mudokon workers are informed that they can avoid electrocution by remaining motionless in the Greeters’ infrared beam.<ref name="StoneGreeters"/>

== Construction ==
The main body of a Greeter resembles a four-foot-tall (1·2 m)<ref name="OcInsInh"/> cylinder constructed from sheets of scrap metal,<ref name="AOWI128"/> with a control box, exhaust pipe, and steam whistle (or ‘horn’)<ref name="OcGreeters"/> attached to the rear. The front of a Greeter is fitted with a large grin, intended to appeal to consumers,<ref name="AOWI128"/> which lip syncs to the speech produced by the appliance’s voicebox; the Greeter originally delivered comoddity sales pitches, but after being repurposed as a security device, now immitates [[Slig]] phrases.

The base of the main body holds a ring of sensors and lightning dispensers,<ref name="Farzad"/> which joins to a bracket that supports the Greeter on a single wheel. Including this (but excluding the horn), a Greeter’s height is 5 feet 8 inches (1·7 m).<ref name="Farzad"/><ref name="OcInsInhAbe"/>

Greeters maintain excellent balance on their single wheel.<ref name="Alf6"/>

== Appearances ==
=== ''Abe’s Exoddus'' ===
{{Main|Greeters in Abe's Exoddus|List of Greeters in Abe's Exoddus}}
Greeters are an unusual hazard in ''[[Oddworld: Abe’s Exoddus|Abe’s Exoddus]]'', appearing in the levels ‘FeeCo Depot’, ‘Slig Barracks’ and ‘SoulStorm Brewery’. They will chase and attempt to electrocute any Mudokons, including Abe, that they detect, resulting in instant death.

Although Greeters behave like other enemy characters in that they follow patrols, chase Abe and have [[GameSpeak]], they will not detect Abe by sight, sound or (usually) proximity. Greeters only become aggressive if Abe or other Mudokons move while inside the Greeter's motion detector beam. The movement of this beam is difficult to predict because of how it encircles Greeters that are moving across the screen.

=== Merchandise and marketing ===
Greeter concept art by [[Farzad Varahramyan]] appears on page 128 of ''[[The Art of Oddworld Inhabitants]]'' and Image 0006 of [[Oddworld: The Lost Archives]].<ref name="AOWI128"/><ref name="LostArc06"/>

== Behind the scenes ==
Early designs by Farzad explored different shapes for Greeters, but always with a height equal to Abe’s.<ref name="Farzad"/> According to text in his concept sketches, Greeters should <q>behave like a drunk unicyclist and move & sound like an old tinkertoy.</q> The Greeters’ steam horn resembles a scaled down replica Greeter, but with a downturned mouth.

== References ==
<references>
<ref name="OcInsInh">'''Oddworld Inhabitants (~02/1999)'''. ‘[toswi:Inhabitants.php#Greeters Name: Greeters]’, ‘Inhabitants’. Oddworld.com.</ref>
<ref name="AEManual">'''O’Connor, Paul (17/11/1998)'''. ‘Greeters’, ‘The Cast’, p. 27. Game manual for ''Oddworld: Abe’s Exoddus''. GT Interactive. <q>Glukkons were aghast when these marketing and P.R. machines began attacking the customers.</q></ref>
<ref name="StoneGreeters">'''Aslik (17/11/1998)'''. ‘Uncle Aslik’s Tourist Tip #9: Greeters Welcome You!’. FeeCo Depot. StoryDwelling Theater. StoryStone (FDP02C16), ‘FeeCo Depot’ (FDP02C10). ''Oddworld: Abe’s Exoddus''. GT Interactive. <q>Remember: If you don’t move, they can’t see you!</q></ref>
<ref name="OcGreeters">'''Oddworld Inhabitants (17/08/2000)'''. ‘[http://oddworldlibrary.net/archives/web/oddworld.com/firsttenyears/universe/industrial/characters/ow_greeter.html Greeters]’. ‘Oddworld Universe’. Oddworld.com. Archived by [[Oddworld Library#Odd_Wide_Web|Odd Wide Web]] on 05/01/2011.</ref>
<ref name="Farzad">'''Varahramyan, Farzad (24/03/1998)'''. ‘Abe II: Greeters’ concept sketches.<ref name="AOWI128"/><ref name="LostArc06"/></ref>
<ref name="AOWI128">'''Johnson, Cathy; Wade, Johnson (15/09/2004)'''. ‘Greeters’, ‘''Oddworld: Abe’s Exoddus''’, p. 128. ''[[The Art of Oddworld Inhabitants|The Art of Oddworld Inhabitants: The First Ten Years 1994–2004]]''. Adelaide, South Australia: Ballistic Publishing.</ref>
<ref name="LostArc06">'''Oddworld Inhabitants (11/12/2017 16:47 UTC)'''. ‘[https://www.instagram.com/p/BckbYBoDf8M/ The Greeter]’. [[Oddworld: The Lost Archives]]. Post on Instagram.</ref>
<ref name="Alf6">'''Alf (01/03/2001)'''. ‘[http://oddworldlibrary.net/archives/web/oddworld.com/firsttenyears/alf/ow_dearalf06.shtml Dear Alf 06]’, q. 31. ‘Alf’s Rehab & Tea’. Oddworld.com. Archived by Odd Wide Web on 05/01/2011.</ref>
<ref name="OcInsInhAbe">'''Oddworld Inhabitants (~02/1999)'''. ‘[http://oddworldlibrary.net/wiki/Abe's_Exoddus_-_Inhabitants Name: Abe]’, ‘Inhabitants’. Oddworld.com. Archived by [[Oddworld Library#Oddworld Scriptures Oddworld Scriptures] on 08/05/2012.</ref>
</references>

Oddworld: The Lost Archives

2018-04-07T12:47:41Z

Max: Created page with "'''Oddworld: The Lost Archives''' is a social media series posted by Oddworld Inhabitants on Instagram. It comprises daily posts of Oddworld concept art drawn from..."

'''Oddworld: The Lost Archives''' is a social media series posted by [[Oddworld Inhabitants]] on [[Instagram]]. It comprises daily posts of [[Oddworld]] concept art drawn from a recently recovered archive, much of it previously unreleased.

The first image was posted on 4th December 2017 with new ones being posted every weekday since, with the exception of 19th and 22nd March, both during the same week Oddworld Inhabitants attended [[Game_Developers_Conference#GDC_2018|GDC 2018]] and the launch of the ''[[Oddworld: Abe’s Origins]]'' crowdfunding campaign.

Starting on 22nd January 2018, the first image of each week is deliberately chosen for being in colour.

The series is scheduled to continue with posts every weekday until the release of ''[[Oddworld: Soulstorm]]''.

== References ==
=== Instagram ===
# '''Oddworld Inhabitants (01/12/2017 16:30 UTC)'''. [https://www.instagram.com/p/BcKph5IjQtk/ Post] on Instagram.
# '''Oddworld Inhabitants (01/12/2017 16:58 UTC)'''. [https://www.instagram.com/p/BcKsr81DmYE/ Post] on Instagram.
# '''Oddworld Inhabitants (04/12/2017 17:33 UTC)'''. ‘[https://www.instagram.com/p/BcSfHtZDUac/ Character Concept Sketches]’. Oddworld: The Lost Archives. Post on Instagram.
# '''Oddworld Inhabitants (05/12/2017 13:01 UTC)'''. ‘[https://www.instagram.com/p/BcUkybpDFCx/ Munch Concept Sketch]’. Oddworld: The Lost Archives. Post on Instagram.
# '''Oddworld Inhabitants (06/12/2017 19:23 UTC)'''. ‘[https://www.instagram.com/p/BcX1SbajWQU/ Mudokon Queen Concept]’. Oddworld: The Lost Archives. Post on Instagram.
# '''Oddworld Inhabitants (07/12/2017 13:30 UTC)'''. ‘[https://www.instagram.com/p/BcZxqEqjS8V/ Magog Cartel Lawyers]’. Oddworld: The Lost Archives. Post on Instagram.
# '''Oddworld Inhabitants (08/12/2017 16:13 UTC)'''. ‘[https://www.instagram.com/p/BccpK2UD-8k/ Munch]’. Oddworld: The Lost Archives. Post on Instagram.
# '''Oddworld Inhabitants (11/12/2017 16:47 UTC)'''. ‘[https://www.instagram.com/p/BckbYBoDf8M/ The Greeter]’. Oddworld: The Lost Archives. Post on Instagram.
# '''Oddworld Inhabitants (12/12/2017 17:00 UTC)'''. ‘[https://www.instagram.com/p/BcnBpm0DBPf/ Munch]’. Oddworld: The Lost Archives. Post on Instagram.
# '''Oddworld Inhabitants (13/12/2017 18:00 UTC)'''. ‘[https://www.instagram.com/p/BcptYqqjMs5/ Fleech Eating Chart]’. Oddworld: The Lost Archives. Post on Instagram.
# '''Oddworld Inhabitants (14/12/2017 17:20 UTC)'''. ‘[https://www.instagram.com/p/BcsNj2PjYH6/ The Ociti]’. Oddworld: The Lost Archives. Post on Instagram.
# '''Oddworld Inhabitants (15/12/2017 12:58 UTC)'''. ‘[https://www.instagram.com/p/BcuUXGUDYz7/ The Meech]’. Oddworld: The Lost Archives. Post on Instagram.
# '''Oddworld Inhabitants (18/12/2017 12:04 UTC)'''. ‘[https://www.instagram.com/p/Bc18mm3jlHr/ Sekto]’. Oddworld: The Lost Archives. Post on Instagram.
# '''Oddworld Inhabitants (19/12/2017 17:27 UTC)'''. ‘[https://www.instagram.com/p/Bc5GVB4jjCW/ Fleech]’. Oddworld: The Lost Archives. Post on Instagram.
# '''Oddworld Inhabitants (20/12/2017 16:58 UTC)'''. ‘[https://www.instagram.com/p/Bc7n2gJjc0D/ Glukkons]’. Oddworld: The Lost Archives. Post on Instagram.
# '''Oddworld Inhabitants (21/12/2017 19:00 UTC)'''. ‘[https://www.instagram.com/p/Bc-al_ADlgQ/ Spiders]’. Oddworld: The Lost Archives. Post on Instagram.
# '''Oddworld Inhabitants (22/12/2017 14:00 UTC)'''. ‘[https://www.instagram.com/p/BdAdF6ZDNMP/ New Munch]’. Oddworld: The Lost Archives. Post on Instagram.
# '''Oddworld Inhabitants (25/12/2017 12:34 UTC)'''. ‘[https://www.instagram.com/p/BdIBmeWDkvR/ Christmas Card Designs]’. Oddworld: The Lost Archives. Post on Instagram.
# '''Oddworld Inhabitants (26/12/2017 16:11 UTC)'''. ‘[https://www.instagram.com/p/BdK_QogDON1/ Munch]’. Oddworld: The Lost Archives. Post on Instagram.
# '''Oddworld Inhabitants (27/12/2017 16:43 UTC)'''. ‘[https://www.instagram.com/p/BdNnqlmDk2t/ Priests]’. Oddworld: The Lost Archives. Post on Instagram.
# '''Oddworld Inhabitants (28/12/2017 16:32 UTC)'''. ‘[https://www.instagram.com/p/BdQLLzfjpI1/ Elum]’. Oddworld: The Lost Archives. Post on Instagram.
# '''Oddworld Inhabitants (29/12/2017 15:59 UTC)'''. ‘[https://www.instagram.com/p/BdSsOtIjdYg/ Munch]’. Oddworld: The Lost Archives. Post on Instagram.
# '''Oddworld Inhabitants (01/01/2018 16:45 UTC)'''. ‘[https://www.instagram.com/p/Bdaf2-FjVvs/ Abe]’. Oddworld: The Lost Archives. Post on Instagram.
# '''Oddworld Inhabitants (02/01/2018 14:47 UTC)'''. ‘[https://www.instagram.com/p/Bdc3KBTj7wm/ Munch]’. Oddworld: The Lost Archives. Post on Instagram.
# '''Oddworld Inhabitants (03/01/2018 16:57 UTC)'''. ‘[https://www.instagram.com/p/Bdfq2eJjv33/ Abe Chest Tattoo]’. Oddworld: The Lost Archives. Post on Instagram.
# '''Oddworld Inhabitants (04/01/2018 17:53 UTC)'''. ‘[https://www.instagram.com/p/BdiWAg0jTI3/ Munch]’. Oddworld: The Lost Archives. Post on Instagram.
# '''Oddworld Inhabitants (05/01/2018 18:12 UTC)'''. ‘[https://www.instagram.com/p/Bdk9A1XjFOq/ Munch Skeleton Detail]’. Oddworld: The Lost Archives. Post on Instagram.
# '''Oddworld Inhabitants (08/01/2018 17:01 UTC)'''. ‘[https://www.instagram.com/p/BdsjRvOjhTh/ Character Tongues]’. Oddworld: The Lost Archives. Post on Instagram.
# '''Oddworld Inhabitants (09/01/2018 18:03 UTC)'''. ‘[https://www.instagram.com/p/BdvPMHdjk92/ Munch]’. Oddworld: The Lost Archives. Post on Instagram.
# '''Oddworld Inhabitants (10/01/2018 18:50 UTC)'''. ‘[https://www.instagram.com/p/Bdx5UuNjK47/ Facial Expressions]’. Oddworld: The Lost Archives. Post on Instagram.
# '''Oddworld Inhabitants (11/01/2018 18:01 UTC)'''. ‘[https://www.instagram.com/p/Bd0YjAmDWLd/ Abe]’. Oddworld: The Lost Archives. Post on Instagram.
# '''Oddworld Inhabitants (12/01/2018 17:32 UTC)'''. ‘[https://www.instagram.com/p/Bd26BgaDaMa/ Munch]’. Oddworld: The Lost Archives. Post on Instagram.
# '''Oddworld Inhabitants (15/01/2018 19:27 UTC)'''. ‘[https://www.instagram.com/p/Bd-1lQij6gg/ Munch]’. Oddworld: The Lost Archives. Post on Instagram.
# '''Oddworld Inhabitants (16/01/2018 17:39 UTC)'''. ‘[https://www.instagram.com/p/BeBN8psDe13/ Abe]’. Oddworld: The Lost Archives. Post on Instagram.
# '''Oddworld Inhabitants (17/01/2018 18:42 UTC)'''. ‘[https://www.instagram.com/p/BeD59uNDRwo/ Mudokon Skulls]’. Oddworld: The Lost Archives. Post on Instagram.
# '''Oddworld Inhabitants (18/01/2018 18:31 UTC)'''. ‘[https://www.instagram.com/p/BeGdfVCjfFw/ Mudokon Queen Concept]’. Oddworld: The Lost Archives. Post on Instagram.
# '''Oddworld Inhabitants (19/01/2018 18:05 UTC)'''. ‘[https://www.instagram.com/p/BeI_W1WDYH0/ Munch]’. Oddworld: The Lost Archives. Post on Instagram.
# '''Oddworld Inhabitants (22/01/2018 16:03 UTC)'''. ‘[https://www.instagram.com/p/BeQfzwBjs2h/ E3 Booth]’. Oddworld: The Lost Archives. Post on Instagram.
# '''Oddworld Inhabitants (23/01/2018 15:58 UTC)'''. ‘[https://www.instagram.com/p/BeTD8aDjxd0/ Munch]’. Oddworld: The Lost Archives. Post on Instagram.
# '''Oddworld Inhabitants (24/01/2018 16:54 UTC)'''. ‘[https://www.instagram.com/p/BeVvPIEjeMb/ Munch]’. Oddworld: The Lost Archives. Post on Instagram.
# '''Oddworld Inhabitants (25/01/2018 16:49 UTC)'''. ‘[https://www.instagram.com/p/BeYTbYfD1K2/ Munch]’. Oddworld: The Lost Archives. Post on Instagram.
# '''Oddworld Inhabitants (26/01/2018 16:27 UTC)'''. ‘[https://www.instagram.com/p/Bea1v3GD6DE/ Fleech]’. Oddworld: The Lost Archives. Post on Instagram.
# '''Oddworld Inhabitants (29/01/2018 16:05 UTC)'''. ‘[https://www.instagram.com/p/BeihhefH3_Z/ Lightning Strike]’. Oddworld: The Lost Archives. Post on Instagram.
# '''Oddworld Inhabitants (30/01/2018 16:42 UTC)'''. ‘[https://www.instagram.com/p/BelKoSQnIn0/ Mudokon Hand]’. Oddworld: The Lost Archives. Post on Instagram.
# '''Oddworld Inhabitants (31/01/2018 15:45 UTC)'''. ‘[https://www.instagram.com/p/Beno6N4D5Yu/ Fleech Animation]’. Oddworld: The Lost Archives. Post on Instagram.
# '''Oddworld Inhabitants (01/02/2018 16:18 UTC)'''. ‘[https://www.instagram.com/p/BeqRaa3Ae_s/ Fleech Redesign]’. Oddworld: The Lost Archives. Post on Instagram.
# '''Oddworld Inhabitants (02/02/2018 16:39 UTC)'''. ‘[https://www.instagram.com/p/Bes4rhZA5uM/ Abe’s Bones]’. Oddworld: The Lost Archives. Post on Instagram.
# '''Oddworld Inhabitants (05/02/2018 17:33 UTC)'''. ‘[https://www.instagram.com/p/Be0tKmnggUG/ Abe on Elum]’. Oddworld: The Lost Archives. Post on Instagram.
# '''Oddworld Inhabitants (06/02/2018 14:52 UTC)'''. ‘[https://www.instagram.com/p/Be2_moXDG1T/ Munch]’. Oddworld: The Lost Archives. Post on Instagram.
# '''Oddworld Inhabitants (07/02/2018 19:07 UTC)'''. ‘[https://www.instagram.com/p/Be6BfP0BebC/ Munch]’. Oddworld: The Lost Archives. Post on Instagram.
# '''Oddworld Inhabitants (08/02/2018 18:02 UTC)'''. ‘[https://www.instagram.com/p/Be8e8BzhvTP/ Munch Camouflage]’. Oddworld: The Lost Archives. Post on Instagram.
# '''Oddworld Inhabitants (09/02/2018 17:21 UTC)'''. ‘[https://www.instagram.com/p/Be-_CBAj2Op/ Rodent Munch]’. Oddworld: The Lost Archives. Post on Instagram.
# '''Oddworld Inhabitants (12/02/2018 17:22 UTC)'''. ‘[https://www.instagram.com/p/BfGtdm4gs_H/ Paramonian Temple]’. Oddworld: The Lost Archives. Post on Instagram.
# '''Oddworld Inhabitants (13/02/2018 18:48 UTC)'''. ‘[https://www.instagram.com/p/BfJcHxHFwKQ/ Floating Munch]’. Oddworld: The Lost Archives. Post on Instagram.
# '''Oddworld Inhabitants (14/02/2018 23:03 UTC)'''. ‘[https://www.instagram.com/p/BfMeHFRAs3f/ Munch]’. Oddworld: The Lost Archives. Post on Instagram.
# '''Oddworld Inhabitants (15/02/2018 18:18 UTC)'''. ‘[https://www.instagram.com/p/BfOiTN6gQkQ/ Swimming]’. Oddworld: The Lost Archives. Post on Instagram.
# '''Oddworld Inhabitants (16/02/2018 17:08 UTC)'''. ‘[https://www.instagram.com/p/BfQ_H7ChCHV/ Friends]’. Oddworld: The Lost Archives. Post on Instagram.
# '''Oddworld Inhabitants (19/02/2018 18:18 UTC)'''. ‘[https://www.instagram.com/p/BfY1gVYn25n/ Rupture Farms]’. Oddworld: The Lost Archives. Post on Instagram.
# '''Oddworld Inhabitants (20/02/2018 20:00 UTC)'''. ‘[https://www.instagram.com/p/Bfbl7DKAnrg/ Munch Head]’. Oddworld: The Lost Archives. Post on Instagram.
# '''Oddworld Inhabitants (21/02/2018 20:48 UTC)'''. ‘[https://www.instagram.com/p/BfeQNaZhTv1/ Tall Munch]’. Oddworld: The Lost Archives. Post on Instagram.
# '''Oddworld Inhabitants (22/02/2018 22:34 UTC)'''. ‘[https://www.instagram.com/p/BfhBMt8g3i7/ Abe and Munch]’. Oddworld: The Lost Archives. Post on Instagram.
# '''Oddworld Inhabitants (23/02/2018 22:24 UTC)'''. ‘[https://www.instagram.com/p/Bfjkx_fgI2h/ Munch]’. Oddworld: The Lost Archives. Post on Instagram.
# '''Oddworld Inhabitants (26/02/2018 18:58 UTC)'''. ‘[https://www.instagram.com/p/Bfq7nvwheUy/ Help Wanted]’. Oddworld: The Lost Archives. Post on Instagram.
# '''Oddworld Inhabitants (27/02/2018 18:26 UTC)'''. ‘[https://www.instagram.com/p/Bftcuwwl3JT/ Headley]’. Oddworld: The Lost Archives. Post on Instagram.
# '''Oddworld Inhabitants (28/02/2018 16:56 UTC)'''. ‘[https://www.instagram.com/p/Bfv3PzoFHx-/ Baby Mudokon]’. Oddworld: The Lost Archives. Post on Instagram.
# '''Oddworld Inhabitants (01/03/2018 19:51 UTC)'''. ‘[https://www.instagram.com/p/BfywHRBAQ12/ The Pit]’. Oddworld: The Lost Archives. Post on Instagram.
# '''Oddworld Inhabitants (02/03/2018 17:35 UTC)'''. ‘[https://www.instagram.com/p/Bf1FTcdBVy0/ Intern (Naked)]’. Oddworld: The Lost Archives. Post on Instagram.
# '''Oddworld Inhabitants (05/03/2018 17:31 UTC)'''. ‘[https://www.instagram.com/p/Bf8zQmAgXDn/ Slig Painting]’. Oddworld: The Lost Archives. Post on Instagram.
# '''Oddworld Inhabitants (06/03/2018 15:09 UTC)'''. ‘[https://www.instagram.com/p/Bf_HvK0H-Yu/ Young Vykker]’. Oddworld: The Lost Archives. Post on Instagram.
# '''Oddworld Inhabitants (07/03/2018 18:11 UTC)'''. ‘[https://www.instagram.com/p/BgCBcSOBC-V/ Octigi]’. Oddworld: The Lost Archives. Post on Instagram.
# '''Oddworld Inhabitants (08/03/2018 19:09 UTC)'''. ‘[https://www.instagram.com/p/BgEsxDHg_9i/ Octigi (Suited)]’. Oddworld: The Lost Archives. Post on Instagram.
# '''Oddworld Inhabitants (09/03/2018 18:55 UTC)'''. ‘[https://www.instagram.com/p/BgHQEPGl22l/ Opinionites]’. Oddworld: The Lost Archives. Post on Instagram.
# '''Oddworld Inhabitants (12/03/2018 18:41 UTC)'''. ‘[https://www.instagram.com/p/BgO82vGH7ga/ Characters]’. Oddworld: The Lost Archives. Post on Instagram.
# '''Oddworld Inhabitants (13/03/2018 18:38 UTC)'''. ‘[https://www.instagram.com/p/BgRhMrQBRxo/ Fuzzles]’. Oddworld: The Lost Archives. Post on Instagram.
# '''Oddworld Inhabitants (14/03/2018 18:12 UTC)'''. ‘[https://www.instagram.com/p/BgUDBH3hrXk/ Vykker Poses]’. Oddworld: The Lost Archives. Post on Instagram.
# '''Oddworld Inhabitants (15/03/2018 21:21 UTC)'''. ‘[https://www.instagram.com/p/BgW9divnLfu/ Frogger and Friends]’. Oddworld: The Lost Archives. Post on Instagram.
# '''Oddworld Inhabitants (16/03/2018 22:47 UTC)'''. ‘[https://www.instagram.com/p/BgZsIXtgjjY/ Creatures]’. Oddworld: The Lost Archives. Post on Instagram.
# '''Oddworld Inhabitants (20/03/2018 03:15 UTC)'''. ‘[https://www.instagram.com/p/Bgh5MV5lgMF/ Munch]’. Oddworld: The Lost Archives. Post on Instagram.
# '''Oddworld Inhabitants (21/03/2018 20:05 UTC)'''. ‘[https://www.instagram.com/p/BgmRkIuAsWL/ A Meeting]’. Oddworld: The Lost Archives. Post on Instagram.
# '''Oddworld Inhabitants (23/03/2018 18:03 UTC)'''. ‘[https://www.instagram.com/p/BgrNIytBQY0/ Molluck]’. Oddworld: The Lost Archives. Post on Instagram.
# '''Oddworld Inhabitants (27/03/2018 02:57 UTC)'''. ‘[https://www.instagram.com/p/Bgz4syvAebW/ Ratz]’. Oddworld: The Lost Archives. Post on Instagram.
# '''Oddworld Inhabitants (28/03/2018 18:39 UTC)'''. ‘[https://www.instagram.com/p/Bg1kijRgHdt/ Vykker Doctor]’. Oddworld: The Lost Archives. Post on Instagram.
# '''Oddworld Inhabitants (29/03/2018 00:08 UTC)'''. ‘[https://www.instagram.com/p/Bg4u-H7g7Cs/ Sting Ring]’. Oddworld: The Lost Archives. Post on Instagram.
# '''Oddworld Inhabitants (29/03/2018 21:04 UTC)'''. ‘[https://www.instagram.com/p/Bg6-r3pjYp_/ Poison Darts]’. Oddworld: The Lost Archives. Post on Instagram.
# '''Oddworld Inhabitants (30/03/2018 23:47 UTC)'''. ‘[https://www.instagram.com/p/Bg92EiKgwmX/ Large Land Predator]’. Oddworld: The Lost Archives. Post on Instagram.
# '''Oddworld Inhabitants (03/04/2018 01:50 UTC)'''. ‘[https://www.instagram.com/p/BhFyjS-gtIW/ Almighty Raisin]’. Oddworld: The Lost Archives. Post on Instagram.
# '''Oddworld Inhabitants (04/04/2018 02:47 UTC)'''. ‘[https://www.instagram.com/p/BhId8d3A-eF/ Vykkers Labs]’. Oddworld: The Lost Archives. Post on Instagram.
# '''Oddworld Inhabitants (04/04/2018 18:05 UTC)'''. ‘[https://www.instagram.com/p/BhKG_sLB2Tb/ Munch]’. Oddworld: The Lost Archives. Post on Instagram.
# '''Oddworld Inhabitants (05/04/2018 18:02 UTC)'''. ‘[https://www.instagram.com/p/BhMrdUDjGx-/ Vykker Arm]’. Oddworld: The Lost Archives. Post on Instagram.
# '''Oddworld Inhabitants (06/04/2018 19:08 UTC)'''. ‘[https://www.instagram.com/p/BhPXztvgeci/ Unnamed Creature]’. Oddworld: The Lost Archives. Post on Instagram.

=== Twitter ===
{{Ordered list |start=91
|'''Oddworld Inhabitants (01/12/2017 16:32 UTC)'''. ‘<q>[https://twitter.com/OddworldInc/status/936634013296549888 Dec 4th, 2017... http://ow.ly/Le3b30gX0b9]</q>’. Tweet on Twitter.
|'''Oddworld Inhabitants (01/12/2017 16:59 UTC)'''. ‘<q>[https://twitter.com/OddworldInc/status/936640829195681792 Dec 4th, 2017... http://ow.ly/l14H30gX3my]</q>’. Tweet on Twitter.
|'''Oddworld Inhabitants (04/12/2017 17:03 UTC)'''. ‘<q>[https://twitter.com/OddworldInc/status/937728985550729216 Today's announcement is here: The lost Oddworld archives have been found!]</q>’. Tweet on Twitter.
|'''Oddworld Inhabitants (04/12/2017 17:37 UTC)'''. ‘<q>[https://twitter.com/OddworldInc/status/937737713125593090 Here's our first image! It's pretty gruesome, but enjoy! Here's a sneak preview for anyone who didn't read our post! http://ow.ly/A1sP30h0djb ]</q>’. Tweet on Twitter.
|'''Oddworld Inhabitants (05/12/2017 13:13 UTC)'''. ‘<q>[https://twitter.com/OddworldInc/status/938033529157545984 Today's lost archive image is 'An early exploration for Munch' Here's a sneak peek, you can see the full image on our Instagram right here http://ow.ly/H3x130h1sYX]</q>’. Tweet on Twitter.
|'''Oddworld Inhabitants (05/12/2017 16:02 UTC)'''. ‘<q>[https://twitter.com/OddworldInc/status/938076024000208898 In case you missed it yesterday, along with the discovery of boxes and boxes of brand new never before seen art, we've also uncovered the source code to Abe's Oddysee. More news on that soon.]</q>’. Tweet on Twitter.
|'''Oddworld Inhabitants (05/12/2017 21:47 UTC)'''. ‘<q>[https://twitter.com/OddworldInc/status/938162828946624513 For today's image you can take a look at what Munch might have looked like! http://ow.ly/wBLw30h2leb]</q>’. Tweet on Twitter.
|'''Oddworld Inhabitants (06/12/2017 19:27 UTC)'''. ‘<q>[https://twitter.com/OddworldInc/status/938490176359288832 Today's lost archive image is Sam. Ever wondered about Abe's Mom? You can see an early exploration here: http://ow.ly/O6V130h3FSz]</q>’. Tweet on Twitter.
|'''Oddworld Inhabitants (07/12/2017 13:32 UTC)'''. ‘<q>[https://twitter.com/OddworldInc/status/938763185150185473 Today's lost archive image: Lawyers! You can find the full image here: http://ow.ly/W87X30h4DCR]</q>’. Tweet on Twitter.
|'''Oddworld Inhabitants (08/12/2017 16:16 UTC)'''. ‘<q>[https://twitter.com/OddworldInc/status/939166845675991040 Today's lost archive image: A little too grim? http://ow.ly/bieZ30h6jx1]</q>’. Tweet on Twitter.
|'''Oddworld Inhabitants (11/12/2017 16:48 UTC)'''. ‘<q>[https://twitter.com/OddworldInc/status/940262063888363520 Today's lost archive image: A familiar grin! http://ow.ly/kE3l30h9rPq]</q>’. Tweet on Twitter.
|'''Oddworld Inhabitants (12/12/2017 13:03 UTC)'''. ‘<q>[https://twitter.com/OddworldInc/status/940628079134887937 Today's lost archive image: Munch is looking fierce! http://ow.ly/cxmu30hbcXv ]</q>’. Tweet on Twitter.
|'''Oddworld Inhabitants (13/12/2017 18:03 UTC)'''. ‘<q>[https://twitter.com/OddworldInc/status/941005755347603458 Today's lost archive post- Hungry Fleech! http://ow.ly/5sKm30hcO6R ]</q>’. Tweet on Twitter.
|'''Oddworld Inhabitants (14/12/2017 17:23 UTC)'''. ‘<q>[https://twitter.com/OddworldInc/status/941357984512430081 Today's lost archive image. A priest! <nowiki>https://www.instagram.com/p/BcsNj2PjYH6/?hl=en</nowiki> …]</q>’. Tweet on Twitter.
|'''Oddworld Inhabitants (15/12/2017 12:59 UTC)'''. ‘<q>[https://twitter.com/OddworldInc/status/941654046116667392 Today's lost archive: an original concept from '95! <nowiki>https://www.instagram.com/p/BcuUXGUDYz7/?hl=en</nowiki> …]</q>’. Tweet on Twitter.
|'''Oddworld Inhabitants (18/12/2017 12:06 UTC)'''. ‘<q>[https://twitter.com/OddworldInc/status/942727684429373440 Today's lost archive image- an early design of a familiar face https://www.instagram.com/p/Bc18mm3jlHr/]</q>’. Tweet on Twitter.
|'''Oddworld Inhabitants (19/12/2017 17:29 UTC)'''. ‘<q>[https://twitter.com/OddworldInc/status/943171479897804802 Today's lost archive image- Fleech close-up! https://www.instagram.com/p/Bc5GVB4jjCW/]</q>’. Tweet on Twitter.
|'''Oddworld Inhabitants (20/12/2017 17:00 UTC)'''. ‘<q>[https://twitter.com/OddworldInc/status/943526442268229632 Today's lost archive image- experimenting with posing and lighting https://www.instagram.com/p/Bc7n2gJjc0D/]</q>’. Tweet on Twitter.
|'''Oddworld Inhabitants (21/12/2017 19:01 UTC)'''. ‘<q>[https://twitter.com/OddworldInc/status/943919471340802049 Today's lost archive image- look away now if you're afraid of spiders! https://www.instagram.com/p/Bc-al_ADlgQ/]</q>’. Tweet on Twitter.
|'''Oddworld Inhabitants (22/12/2017 14:02 UTC)'''. ‘<q>[https://twitter.com/OddworldInc/status/944206414591004672 Today's lost archive image. If there's such a thing as too cute this is it https://www.instagram.com/p/BdAdF6ZDNMP/]</q>’. Tweet on Twitter.
|'''Oddworld Inhabitants (25/12/2017 12:36 UTC)'''. ‘<q>[https://twitter.com/OddworldInc/status/945271940243214336 Happy holidays from everyone here at Oddworld Inhabitants! https://www.instagram.com/p/BdIBmeWDkvR/]</q>’. Tweet on Twitter.
|'''Oddworld Inhabitants (26/12/2017 16:13 UTC)'''. ‘<q>[https://twitter.com/OddworldInc/status/945689100446773248 Today's lost archive image is a creepy Munch. We really like this one! https://www.instagram.com/p/BdK_QogDON1/]</q>’. Tweet on Twitter.
|'''Oddworld Inhabitants (27/12/2017 16:45 UTC)'''. ‘<q>[https://twitter.com/OddworldInc/status/946059388908916736 Today's lost archive image- corrupt priests https://www.instagram.com/p/BdNnqlmDk2t/]</q>’. Tweet on Twitter.
|'''Oddworld Inhabitants (28/12/2017 16:34 UTC)'''. ‘<q>[https://twitter.com/OddworldInc/status/946419064943054854 Today's lost archive image- drooling Elum! As always here's a preview... https://www.instagram.com/p/BdQLLzfjpI1/]</q>’. Tweet on Twitter.
|'''Oddworld Inhabitants (29/12/2017 16:02 UTC)'''. ‘<q>[https://twitter.com/OddworldInc/status/946773367838953473 Today's lost archive image- An unusual design for Munch. https://www.instagram.com/p/BdSsOtIjdYg/]</q>’. Tweet on Twitter.
|'''Oddworld Inhabitants (01/01/2018 16:46 UTC)'''. ‘<q>[https://twitter.com/OddworldInc/status/947871727765348352 Today's lost archive image- Abe's in party mode! https://www.instagram.com/p/Bdaf2-FjVvs/]</q>’. Tweet on Twitter.
|'''Oddworld Inhabitants (02/01/2018 14:48 UTC)'''. ‘<q>[https://twitter.com/OddworldInc/status/948204292082675712 Today's lost archive image- Munch expressions! https://www.instagram.com/p/Bdc3KBTj7wm/]</q>’. Tweet on Twitter.
|'''Oddworld Inhabitants (03/01/2018 16:58 UTC)'''. ‘<q>[https://twitter.com/OddworldInc/status/948599483012657152 Today's lost archive image- choosing a new tattoo can be tricky! https://www.instagram.com/p/Bdfq2eJjv33/]</q>’. Tweet on Twitter.
|'''Oddworld Inhabitants (04/01/2018 17:55 UTC)'''. ‘<q>[https://twitter.com/OddworldInc/status/948976130748551168 Today's lost archive image- Munch was almost musical? https://www.instagram.com/p/BdiWAg0jTI3/ ]</q>’. Tweet on Twitter.
|'''Oddworld Inhabitants (05/01/2018 18:13 UTC)'''. ‘<q>[https://twitter.com/OddworldInc/status/949343206105321472 Today's lost archive- skeletal Munch! https://www.instagram.com/p/Bdk9A1XjFOq/]</q>’. Tweet on Twitter.
|'''Oddworld Inhabitants (08/01/2018 17:02 UTC)'''. ‘<q>[https://twitter.com/OddworldInc/status/950412443972440064 Today's lost archive image- attention to detail! https://www.instagram.com/p/BdsjRvOjhTh/]</q>’. Tweet on Twitter.
|'''Oddworld Inhabitants (09/01/2018 18:05 UTC)'''. ‘<q>[https://twitter.com/OddworldInc/status/950790623329771520 Today's lost archive image. Some ideas for swimming Munch. https://www.instagram.com/p/BdvPMHdjk92/]</q>’. Tweet on Twitter.
|'''Oddworld Inhabitants (10/01/2018 18:51 UTC)'''. ‘<q>[https://twitter.com/OddworldInc/status/951164654423826432 Today's lost archive image- Mudokons pulling faces! https://www.instagram.com/p/Bdx5UuNjK47/]</q>’. Tweet on Twitter.
|'''Oddworld Inhabitants (11/01/2018 18:03 UTC)'''. ‘<q>[https://twitter.com/OddworldInc/status/951514913905758208 Today's lost archive image- An early Abe! https://www.instagram.com/p/Bd0YjAmDWLd/]</q>’. Tweet on Twitter.
|'''Oddworld Inhabitants (12/01/2018 17:34 UTC)'''. ‘<q>[https://twitter.com/OddworldInc/status/951869895414812673 Today's lost archive image- Expressions for Munch. Look at that face! https://www.instagram.com/p/Bd26BgaDaMa/]</q>’. Tweet on Twitter.
|'''Oddworld Inhabitants (15/01/2018 19:28 UTC)'''. ‘<q>[https://twitter.com/OddworldInc/status/952985980902010881 Today's lost archive image- Munch the Catfish! https://www.instagram.com/p/Bd-1lQij6gg/]</q>’. Tweet on Twitter.
|'''Oddworld Inhabitants (16/01/2018 17:41 UTC)'''. ‘<q>[https://twitter.com/OddworldInc/status/953321232597946369 Today's lost archive image- an idea for a t-shirt design https://www.instagram.com/p/BeBN8psDe13/]</q>’. Tweet on Twitter.
|'''Oddworld Inhabitants (17/01/2018 18:44 UTC)'''. ‘<q>[https://twitter.com/OddworldInc/status/953699517177696256 Today's lost archive image- Creepy, creepy Mudokon skulls https://www.instagram.com/p/BeD59uNDRwo/]</q>’. Tweet on Twitter.
|'''Oddworld Inhabitants (18/01/2018 18:32 UTC)'''. ‘<q>[https://twitter.com/OddworldInc/status/954058871282241536 Today's lost archive image- Abe's Mom https://www.instagram.com/p/BeGdfVCjfFw/ ]</q>’. Tweet on Twitter.
|'''Oddworld Inhabitants (19/01/2018 18:07 UTC)'''. ‘<q>[https://twitter.com/OddworldInc/status/954414971378597889 Today's lost archive image- dangerous friends https://www.instagram.com/p/BeI_W1WDYH0/]</q>’. Tweet on Twitter.
|'''Oddworld Inhabitants (22/01/2018 16:06 UTC)'''. ‘<q>[https://twitter.com/OddworldInc/status/955471747511398400 We're brightening up the beginning of the week by adding a splash of color to our Instagram every Monday. Today's lost archive image- Oddysee E3 booth https://www.instagram.com/p/BeQfzwBjs2h/]</q>’. Tweet on Twitter.
|'''Oddworld Inhabitants (23/01/2018 16:02 UTC)'''. ‘<q>[https://twitter.com/OddworldInc/status/955833033415946241 Today's lost archive image- making Munch expressive https://www.instagram.com/p/BeTD8aDjxd0/]</q>’. Tweet on Twitter.
|'''Oddworld Inhabitants (24/01/2018 16:56 UTC)'''. ‘<q>[https://twitter.com/OddworldInc/status/956209055118356481 Today's lost archive image- Munch could use a little help... https://www.instagram.com/p/BeVvPIEjeMb/]</q>’. Tweet on Twitter.
|'''Oddworld Inhabitants (25/01/2018 16:50 UTC)'''. ‘<q>[https://twitter.com/OddworldInc/status/956570006913015809 Today's lost archive image- Munch the rodent. https://www.instagram.com/p/BeYTbYfD1K2/]</q>’. Tweet on Twitter.
|'''Oddworld Inhabitants (26/01/2018 16:28 UTC)'''. ‘<q>[https://twitter.com/OddworldInc/status/956926928820297731 Today's lost archive image- Fleech animation https://www.instagram.com/p/Bea1v3GD6DE/]</q>’. Tweet on Twitter.
|'''Oddworld Inhabitants (29/01/2018 16:06 UTC)'''. ‘<q>[https://twitter.com/OddworldInc/status/958008439438966787 Today's lost archive image- Watch out for that lightning! https://www.instagram.com/p/BeihhefH3_Z/]</q>’. Tweet on Twitter.
|'''Oddworld Inhabitants (30/01/2018 16:43 UTC)'''. ‘<q>[https://twitter.com/OddworldInc/status/958380222189010945 Today's lost archive image- Mudokon hands https://www.instagram.com/p/BelKoSQnIn0/]</q>’. Tweet on Twitter.
|'''Oddworld Inhabitants (31/01/2018 15:47 UTC)'''. ‘<q>[https://twitter.com/OddworldInc/status/958728329649061893 Today's lost archive image- Fleech eating animation https://www.instagram.com/p/Beno6N4D5Yu/]</q>’. Tweet on Twitter.
|'''Oddworld Inhabitants (01/02/2018 16:20 UTC)'''. ‘<q>[https://twitter.com/OddworldInc/status/959099033498382336 Today's lost archive image- a Fleech redesign <nowiki>http://www.instagram.com/p/BeqRaa3Ae_s/?taken-by=oddworldinc</nowiki> …]</q>’. Tweet on Twitter.
|'''Oddworld Inhabitants (02/02/2018 16:43 UTC)'''. ‘<q>[https://twitter.com/OddworldInc/status/959467241153671168 Today's lost archive image- Mudokon bones. <nowiki>https://www.instagram.com/p/Bes4rhZA5uM/?taken-by=oddworldinc</nowiki> …]</q>’. Tweet on Twitter.
|'''Oddworld Inhabitants (05/02/2018 18:27 UTC)'''. ‘<q>[https://twitter.com/OddworldInc/status/960580660250464256 Don't forget that every day we post a new image from the Lost Archives to our Instagram. On Mondays it's in color to brighten up the start of the week. Here's today's image. You can see comments right here. <nowiki>http://www.instagram.com/p/Be0tKmnggUG/?taken-by=oddworldinc</nowiki> …]</q>’. Tweet on Twitter.
|'''Oddworld Inhabitants (08/02/2018 18:04 UTC)'''. ‘<q>[https://twitter.com/OddworldInc/status/961662132365549568 We're celebrating Munch right now, here's something from the archives. If they can't spot you they can't catch you! <nowiki>http://www.instagram.com/p/Be8e8BzhvTP/?taken-by=oddworldinc</nowiki> …]</q>’. Tweet on Twitter.
|'''Oddworld Inhabitants (09/02/2018 17:23 UTC)'''. ‘<q>[https://twitter.com/OddworldInc/status/962014034814840832 Today's lost archive image is here! As always you can follow the Instagram link to see what people are saying https://www.instagram.com/p/Be-_CBAj2Op/]</q>’. Tweet on Twitter.
|'''Oddworld Inhabitants (15/02/2018 21:05 UTC)'''. ‘<q>[https://twitter.com/OddworldInc/status/964244271552434176 Today's lost archive image shows how Munch swims. We share a lost archive image every weekday on our Instagram :) http://ow.ly/il9k30iqIKW]</q>’. Tweet on Twitter.
|'''Oddworld Inhabitants (19/02/2018 18:20 UTC)'''. ‘<q>[https://twitter.com/OddworldInc/status/965652294221139968 Today's lost archive image is in color to brighten up your Monday. This week's is a creepy early concept for Rupture Farms. http://ow.ly/gCJc30iurCH]</q>’. Tweet on Twitter.
|'''Oddworld Inhabitants (27/02/2018 18:28 UTC)'''. ‘<q>[https://twitter.com/OddworldInc/status/968553352152911874 Today's lost archive image- Headley might not be easy to look at, but he sure is well dressed. (If you ignore the fact that he doesn't wear pants) http://ow.ly/hBr730iEgYC]</q>’. Tweet on Twitter.
|'''Oddworld Inhabitants (28/02/2018 17:01 UTC)'''. ‘<q>[https://twitter.com/OddworldInc/status/968894059472408576 Today's lost archive is a baby Mudokon- he might just be the cutest thing we've ever seen. As always if you want to check out the other images on our Instagram the link is right here http://ow.ly/a91I30iFLBQ]</q>’. Tweet on Twitter.
|'''Oddworld Inhabitants (28/02/2018 17:01 UTC)'''. ‘<q>[https://twitter.com/OddworldInc/status/969634323015053313 Look how happy this Intern is. Maybe they just get grumpy when they're made to wear clothes? You can find more Lost Archive images over on our Instagram https://www.instagram.com/oddworldinc/]</q>’. Tweet on Twitter.
|'''Oddworld Inhabitants (06/03/2018 15:14 UTC)'''. ‘<q>[https://twitter.com/OddworldInc/status/971041370264735746 Today’s lost archive image is a young Vykker. He got his hands on some serious weapons but he doesn’t look as menacing as he thinks he does https://www.instagram.com/p/Bf_HvK0H-Yu/]</q>’. Tweet on Twitter.
|'''Oddworld Inhabitants (12/03/2018 18:42 UTC)'''. ‘<q>[https://twitter.com/OddworldInc/status/973268022042529792 Today's lost archive image- Abe and Elum are looking outnumbered right now.]</q>’. Tweet on Twitter.
|'''Oddworld Inhabitants (27/03/2018 19:45 UTC)'''. ‘<q>[https://twitter.com/OddworldInc/status/978704550109564928 Here's a look at today's Lost Archive image- you might want to reschedule your appointment if it's with this particular doctor... You can catch more lost archives and some other really cool stuff on our Instagram! http://ow.ly/nZk430jbCXn]</q>’. Tweet on Twitter.
}}

=== Facebook ===
{{Ordered list |start=152
|'''Oddworld Inhabitants (01/12/2017 16:32)'''. [https://www.facebook.com/OfficialOddworld/posts/1462613543775646 Post] on Facebook.
|'''Oddworld Inhabitants (01/12/2017 16:59)'''. [https://www.facebook.com/OfficialOddworld/posts/1462635550440112 Post] on Facebook.
|'''Oddworld Inhabitants (04/12/2017 17:03)'''. [https://www.facebook.com/OfficialOddworld/posts/1465594720144195 Post] on Facebook.
|'''Oddworld Inhabitants (04/12/2017 17:38)'''. [https://www.facebook.com/OfficialOddworld/posts/1465620336808300 Post] on Facebook.
|'''Oddworld Inhabitants (05/12/2017 13:13)'''. [https://www.facebook.com/OfficialOddworld/photos/a.176207019082978.28797.165852613451752/1466341146736219/?type{{=}}3&theater Post] on Facebook.
|'''Oddworld Inhabitants (05/12/2017 16:02)'''. [https://www.facebook.com/OfficialOddworld/posts/1466475330056134 Post] on Facebook.
|'''Oddworld Inhabitants (06/12/2017 19:27)'''. [https://www.facebook.com/OfficialOddworld/posts/1467625663274434 Post] on Facebook.
|'''Oddworld Inhabitants (07/12/2017 13:32)'''. [https://www.facebook.com/OfficialOddworld/photos/a.176207019082978.28797.165852613451752/1468338509869816/?type{{=}}3&theater Post] on Facebook.
|'''Oddworld Inhabitants (08/12/2017 16:16)'''. [https://www.facebook.com/OfficialOddworld/photos/a.176207019082978.28797.165852613451752/1469526079751059/?type{{=}}3&theater Post] on Facebook.
|'''Oddworld Inhabitants (11/12/2017 16:48)'''. [https://www.facebook.com/OfficialOddworld/photos/a.176207019082978.28797.165852613451752/1472344659469201/?type{{=}}3&theater Post] on Facebook.
|'''Oddworld Inhabitants (12/12/2017 17:03)'''. [https://www.facebook.com/OfficialOddworld/photos/a.176207019082978.28797.165852613451752/1473276859375981/?type{{=}}3&theater Post] on Facebook.
|'''Oddworld Inhabitants (13/12/2017 18:03)'''. [https://www.facebook.com/OfficialOddworld/photos/a.176207019082978.28797.165852613451752/1474273665942967/?type{{=}}3&theater Post] on Facebook.
|'''Oddworld Inhabitants (14/12/2017 17:23)'''. [https://www.facebook.com/OfficialOddworld/posts/1475174075852926 Post] on Facebook.
|'''Oddworld Inhabitants (15/12/2017 12:59)'''. [https://www.facebook.com/OfficialOddworld/photos/a.176207019082978.28797.165852613451752/1475880552448945/?type{{=}}3 Post] on Facebook.
|'''Oddworld Inhabitants (18/12/2017 12:06)'''. [https://www.facebook.com/OfficialOddworld/photos/a.176207019082978.28797.165852613451752/1478772995493034/?type{{=}}3&theater Post] on Facebook.
|'''Oddworld Inhabitants (19/12/2017 17:29)'''. [https://www.facebook.com/OfficialOddworld/photos/a.176207019082978.28797.165852613451752/1479945068709160/?type{{=}}3&theater Post] on Facebook.
|'''Oddworld Inhabitants (20/12/2017 17:00)'''. [https://www.facebook.com/OfficialOddworld/photos/a.176207019082978.28797.165852613451752/1480775681959432/?type{{=}}3&theater Post] on Facebook.
|'''Oddworld Inhabitants (21/12/2017 19:01)'''. [https://www.facebook.com/OfficialOddworld/photos/a.176207019082978.28797.165852613451752/1481706391866361/?type{{=}}3&theater Post] on Facebook.
|'''Oddworld Inhabitants (22/12/2017 14:02)'''. [https://www.facebook.com/OfficialOddworld/photos/a.176207019082978.28797.165852613451752/1482337148469952/?type{{=}}3&theater Post] on Facebook.
|'''Oddworld Inhabitants (25/12/2017 12:36)'''. [https://www.facebook.com/OfficialOddworld/photos/a.176207019082978.28797.165852613451752/1484910068212660/?type{{=}}3&theater Post] on Facebook.
|'''Oddworld Inhabitants (26/12/2017 16:13)'''. [https://www.facebook.com/OfficialOddworld/photos/a.176207019082978.28797.165852613451752/1485915684778765/?type{{=}}3&theater Post] on Facebook.
|'''Oddworld Inhabitants (27/12/2017 16:45)'''. [https://www.facebook.com/OfficialOddworld/photos/a.176207019082978.28797.165852613451752/1486740431362957/?type{{=}}3&theater Post] on Facebook.
|'''Oddworld Inhabitants (28/12/2017 16:34)'''. [https://www.facebook.com/OfficialOddworld/photos/a.176207019082978.28797.165852613451752/1487587294611604/?type{{=}}3&theater Post] on Facebook.
|'''Oddworld Inhabitants (29/12/2017 16:02)'''. [https://www.facebook.com/OfficialOddworld/photos/a.176207019082978.28797.165852613451752/1488414421195558/?type{{=}}3&theater Post] on Facebook.
|'''Oddworld Inhabitants (01/01/2018 16:46)'''. [https://www.facebook.com/OfficialOddworld/photos/a.176207019082978.28797.165852613451752/1491344150902585/?type{{=}}3&theater Post] on Facebook.
|'''Oddworld Inhabitants (02/01/2018 14:48)'''. [https://www.facebook.com/OfficialOddworld/photos/a.176207019082978.28797.165852613451752/1492122240824776/?type{{=}}3&theater Post] on Facebook.
|'''Oddworld Inhabitants (03/01/2018 16:58)'''. [https://www.facebook.com/OfficialOddworld/photos/a.176207019082978.28797.165852613451752/1493205800716420/?type{{=}}3&theater Post] on Facebook.
|'''Oddworld Inhabitants (04/01/2018 17:55)'''. [https://www.facebook.com/OfficialOddworld/photos/a.176207019082978.28797.165852613451752/1494322470604753/?type{{=}}3&theater Post] on Facebook.
|'''Oddworld Inhabitants (05/01/2018 18:13)'''. [https://www.facebook.com/OfficialOddworld/photos/a.176207019082978.28797.165852613451752/1495375127166154/?type{{=}}3&theater Post] on Facebook.
|'''Oddworld Inhabitants (08/01/2018 17:02)'''. [https://www.facebook.com/OfficialOddworld/photos/a.176207019082978.28797.165852613451752/1498381340198866/?type{{=}}3&theater Post] on Facebook.
|'''Oddworld Inhabitants (09/01/2018 18:05)'''. [https://www.facebook.com/OfficialOddworld/photos/a.176207019082978.28797.165852613451752/1499412223429111/?type{{=}}3&theater Post] on Facebook.
|'''Oddworld Inhabitants (10/01/2018 18:51)'''. [https://www.facebook.com/OfficialOddworld/photos/a.176207019082978.28797.165852613451752/1500368063333527/?type{{=}}3&theater Post] on Facebook.
|'''Oddworld Inhabitants (11/01/2018 18:03)'''. [https://www.facebook.com/OfficialOddworld/photos/a.176207019082978.28797.165852613451752/1501189633251370/?type{{=}}3&theater Post] on Facebook.
|'''Oddworld Inhabitants (12/01/2018 17:34)'''. [https://www.facebook.com/OfficialOddworld/photos/a.176207019082978.28797.165852613451752/1502026013167732/?type{{=}}3&theater Post] on Facebook.
|'''Oddworld Inhabitants (15/01/2018 19:28)'''. [https://www.facebook.com/OfficialOddworld/photos/a.176207019082978.28797.165852613451752/1504696522900681/?type{{=}}3&theater Post] on Facebook.
|'''Oddworld Inhabitants (16/01/2018 17:41)'''. [https://www.facebook.com/OfficialOddworld/photos/a.176207019082978.28797.165852613451752/1505488146154852/?type{{=}}3&theater Post] on Facebook.
|'''Oddworld Inhabitants (17/01/2018 18:44)'''. [https://www.facebook.com/OfficialOddworld/photos/a.176207019082978.28797.165852613451752/1506461586057508/?type{{=}}3&theater Post] on Facebook.
|'''Oddworld Inhabitants (18/01/2018 18:32)'''. [https://www.facebook.com/OfficialOddworld/photos/a.176207019082978.28797.165852613451752/1507372075966459/?type{{=}}3&theater Post] on Facebook.
|'''Oddworld Inhabitants (19/01/2018 18:07)'''. [https://www.facebook.com/OfficialOddworld/photos/a.176207019082978.28797.165852613451752/1508267645876902/?type{{=}}3&theater Post] on Facebook.
|'''Oddworld Inhabitants (22/01/2018 16:06)'''. [https://www.facebook.com/OfficialOddworld/photos/a.176207019082978.28797.165852613451752/1511071152263218/?type{{=}}3&theater Post] on Facebook.
|'''Oddworld Inhabitants (23/01/2018 16:02)'''. [https://www.facebook.com/OfficialOddworld/photos/a.176207019082978.28797.165852613451752/1512052595498407/?type{{=}}3&theater Post] on Facebook.
|'''Oddworld Inhabitants (24/01/2018 16:56)'''. [https://www.facebook.com/OfficialOddworld/photos/a.176207019082978.28797.165852613451752/1513077712062562/?type{{=}}3&theater Post] on Facebook.
|'''Oddworld Inhabitants (25/01/2018 16:50)'''. [https://www.facebook.com/OfficialOddworld/photos/a.176207019082978.28797.165852613451752/1514042498632750/?type{{=}}3&theater Post] on Facebook.
|'''Oddworld Inhabitants (26/01/2018 16:28)'''. [https://www.facebook.com/OfficialOddworld/photos/a.176207019082978.28797.165852613451752/1514957861874547/?type{{=}}3&theater Post] on Facebook.
|'''Oddworld Inhabitants (29/01/2018 16:06)'''. [https://www.facebook.com/OfficialOddworld/photos/a.176207019082978.28797.165852613451752/1517796804923986/?type{{=}}3&theater Post] on Facebook.
|'''Oddworld Inhabitants (30/01/2018 16:43)'''. [https://www.facebook.com/OfficialOddworld/photos/a.176207019082978.28797.165852613451752/1518741071496226/?type{{=}}3&theater Post] on Facebook.
|'''Oddworld Inhabitants (31/01/2018 15:47)'''. [https://www.facebook.com/OfficialOddworld/photos/a.176207019082978.28797.165852613451752/1519647484738918/?type{{=}}3&theater Post] on Facebook.
|'''Oddworld Inhabitants (01/02/2018 16:20)'''. [https://www.facebook.com/OfficialOddworld/photos/a.176207019082978.28797.165852613451752/1520516167985383/?type{{=}}3&theater link] on Facebook.
|'''Oddworld Inhabitants (02/02/2018 16:43)'''. [https://www.facebook.com/OfficialOddworld/photos/a.176207019082978.28797.165852613451752/1521464631223870/?type{{=}}3&theater link] on Facebook.
|'''Oddworld Inhabitants (05/02/2018 18:27)'''. [https://www.facebook.com/OfficialOddworld/photos/a.176207019082978.28797.165852613451752/1524324544271212/?type{{=}}3&theater link] on Facebook.
|'''Oddworld Inhabitants (08/02/2018 18:04)'''. [https://www.facebook.com/OfficialOddworld/photos/a.176207019082978.28797.165852613451752/1526994310670902/?type{{=}}3&theater link] on Facebook.
|'''Oddworld Inhabitants (09/02/2018 17:23)'''. [https://www.facebook.com/OfficialOddworld/photos/a.176207019082978.28797.165852613451752/1527921753911491/?type{{=}}3&theater link] on Facebook.
|'''Oddworld Inhabitants (15/02/2018 21:05)'''. [https://www.facebook.com/OfficialOddworld/photos/a.176207019082978.28797.165852613451752/1534156963287970/?type{{=}}3&theater link] on Facebook.
|'''Oddworld Inhabitants (19/02/2018 18:20)'''. [https://www.facebook.com/OfficialOddworld/photos/a.176207019082978.28797.165852613451752/1538158459554487/?type{{=}}3&theater link] on Facebook.
|'''Oddworld Inhabitants (27/02/2018 18:28)'''. [https://www.facebook.com/OfficialOddworld/photos/a.176207019082978.28797.165852613451752/1546279558742377/?type{{=}}3&theater link] on Facebook.
|'''Oddworld Inhabitants (28/02/2018 17:02)'''. [https://www.facebook.com/OfficialOddworld/photos/a.176207019082978.28797.165852613451752/1547194268650906/?type{{=}}3&theater link] on Facebook.
|'''Oddworld Inhabitants (02/03/2018 18:03)'''. [https://www.facebook.com/OfficialOddworld/photos/a.176207019082978.28797.165852613451752/1549385328431800/?type{{=}}3&theater link] on Facebook.
|'''Oddworld Inhabitants (06/03/2018 15:14)'''. [https://www.facebook.com/OfficialOddworld/photos/a.176207019082978.28797.165852613451752/1553312171372449/?type{{=}}3&theater link] on Facebook.
|'''Oddworld Inhabitants (29/03/2018 01:17)'''. [https://www.facebook.com/OfficialOddworld/photos/a.176207019082978.28797.165852613451752/1576480365722296/?type{{=}}3&theater link] on Facebook.
}}

=== Other official coverage ===
{{Ordered list |start=500
|'''Oddworld Inhabitants (04/12/2017)'''. ‘[http://www.oddworld.com/2017/12/announcing-oddworld-the-lost-archives/ Announcing Oddworld: The Lost Archives]’. Oddworld News.
|'''Oddworld Inhabitants (07/03/2018 18:42 UTC)'''. [https://oddworldinc.tumblr.com/post/171633602001/its-been-a-while-since-weve-posted-on-tumblr Post] on Tumblr.
}}

Module:String

2018-04-07T11:49:53Z

Max: 1 revision imported

--[[

This module is intended to provide access to basic string functions.

Most of the functions provided here can be invoked with named parameters,
unnamed parameters, or a mixture. If named parameters are used, Mediawiki will
automatically remove any leading or trailing whitespace from the parameter.
Depending on the intended use, it may be advantageous to either preserve or
remove such whitespace.

Global options
ignore_errors: If set to 'true' or 1, any error condition will result in
an empty string being returned rather than an error message.

error_category: If an error occurs, specifies the name of a category to
include with the error message. The default category is
[Category:Errors reported by Module String].

no_category: If set to 'true' or 1, no category will be added if an error
is generated.

Unit tests for this module are available at Module:String/tests.
]]

local str = {}

--[[
len

This function returns the length of the target string.

Usage:
{{#invoke:String|len|target_string|}}
OR
{{#invoke:String|len|s=target_string}}

Parameters
s: The string whose length to report

If invoked using named parameters, Mediawiki will automatically remove any leading or
trailing whitespace from the target string.
]]
function str.len( frame )
local new_args = str._getParameters( frame.args, {'s'} );
local s = new_args['s'] or '';
return mw.ustring.len( s )
end

--[[
sub

This function returns a substring of the target string at specified indices.

Usage:
{{#invoke:String|sub|target_string|start_index|end_index}}
OR
{{#invoke:String|sub|s=target_string|i=start_index|j=end_index}}

Parameters
s: The string to return a subset of
i: The fist index of the substring to return, defaults to 1.
j: The last index of the string to return, defaults to the last character.

The first character of the string is assigned an index of 1. If either i or j
is a negative value, it is interpreted the same as selecting a character by
counting from the end of the string. Hence, a value of -1 is the same as
selecting the last character of the string.

If the requested indices are out of range for the given string, an error is
reported.
]]
function str.sub( frame )
local new_args = str._getParameters( frame.args, { 's', 'i', 'j' } );
local s = new_args['s'] or '';
local i = tonumber( new_args['i'] ) or 1;
local j = tonumber( new_args['j'] ) or -1;

local len = mw.ustring.len( s );

-- Convert negatives for range checking
if i < 0 then
i = len + i + 1;
end
if j < 0 then
j = len + j + 1;
end

if i > len or j > len or i < 1 or j < 1 then
return str._error( 'String subset index out of range' );
end
if j < i then
return str._error( 'String subset indices out of order' );
end

return mw.ustring.sub( s, i, j )
end

--[[
This function implements that features of {{str sub old}} and is kept in order
to maintain these older templates.
]]
function str.sublength( frame )
local i = tonumber( frame.args.i ) or 0
local len = tonumber( frame.args.len )
return mw.ustring.sub( frame.args.s, i + 1, len and ( i + len ) )
end

--[[
match

This function returns a substring from the source string that matches a
specified pattern.

Usage:
{{#invoke:String|match|source_string|pattern_string|start_index|match_number|plain_flag|nomatch_output}}
OR
{{#invoke:String|pos|s=source_string|pattern=pattern_string|start=start_index
|match=match_number|plain=plain_flag|nomatch=nomatch_output}}

Parameters
s: The string to search
pattern: The pattern or string to find within the string
start: The index within the source string to start the search. The first
character of the string has index 1. Defaults to 1.
match: In some cases it may be possible to make multiple matches on a single
string. This specifies which match to return, where the first match is
match= 1. If a negative number is specified then a match is returned
counting from the last match. Hence match = -1 is the same as requesting
the last match. Defaults to 1.
plain: A flag indicating that the pattern should be understood as plain
text. Defaults to false.
nomatch: If no match is found, output the "nomatch" value rather than an error.

If invoked using named parameters, Mediawiki will automatically remove any leading or
trailing whitespace from each string. In some circumstances this is desirable, in
other cases one may want to preserve the whitespace.

If the match_number or start_index are out of range for the string being queried, then
this function generates an error. An error is also generated if no match is found.
If one adds the parameter ignore_errors=true, then the error will be suppressed and
an empty string will be returned on any failure.

For information on constructing Lua patterns, a form of [regular expression], see:

* http://www.lua.org/manual/5.1/manual.html#5.4.1
* http://www.mediawiki.org/wiki/Extension:Scribunto/Lua_reference_manual#Patterns
* http://www.mediawiki.org/wiki/Extension:Scribunto/Lua_reference_manual#Ustring_patterns

]]
function str.match( frame )
local new_args = str._getParameters( frame.args, {'s', 'pattern', 'start', 'match', 'plain', 'nomatch'} );
local s = new_args['s'] or '';
local start = tonumber( new_args['start'] ) or 1;
local plain_flag = str._getBoolean( new_args['plain'] or false );
local pattern = new_args['pattern'] or '';
local match_index = math.floor( tonumber(new_args['match']) or 1 );
local nomatch = new_args['nomatch'];

if s == '' then
return str._error( 'Target string is empty' );
end
if pattern == '' then
return str._error( 'Pattern string is empty' );
end
if math.abs(start) < 1 or math.abs(start) > mw.ustring.len( s ) then
return str._error( 'Requested start is out of range' );
end
if match_index == 0 then
return str._error( 'Match index is out of range' );
end
if plain_flag then
pattern = str._escapePattern( pattern );
end

local result
if match_index == 1 then
-- Find first match is simple case
result = mw.ustring.match( s, pattern, start )
else
if start > 1 then
s = mw.ustring.sub( s, start );
end

local iterator = mw.ustring.gmatch(s, pattern);
if match_index > 0 then
-- Forward search
for w in iterator do
match_index = match_index - 1;
if match_index == 0 then
result = w;
break;
end
end
else
-- Reverse search
local result_table = {};
local count = 1;
for w in iterator do
result_table[count] = w;
count = count + 1;
end

result = result_table[ count + match_index ];
end
end

if result == nil then
if nomatch == nil then
return str._error( 'Match not found' );
else
return nomatch;
end
else
return result;
end
end

--[[
pos

This function returns a single character from the target string at position pos.

Usage:
{{#invoke:String|pos|target_string|index_value}}
OR
{{#invoke:String|pos|target=target_string|pos=index_value}}

Parameters
target: The string to search
pos: The index for the character to return

If invoked using named parameters, Mediawiki will automatically remove any leading or
trailing whitespace from the target string. In some circumstances this is desirable, in
other cases one may want to preserve the whitespace.

The first character has an index value of 1.

If one requests a negative value, this function will select a character by counting backwards
from the end of the string. In other words pos = -1 is the same as asking for the last character.

A requested value of zero, or a value greater than the length of the string returns an error.
]]
function str.pos( frame )
local new_args = str._getParameters( frame.args, {'target', 'pos'} );
local target_str = new_args['target'] or '';
local pos = tonumber( new_args['pos'] ) or 0;

if pos == 0 or math.abs(pos) > mw.ustring.len( target_str ) then
return str._error( 'String index out of range' );
end

return mw.ustring.sub( target_str, pos, pos );
end

--[[
str_find

This function duplicates the behavior of {{str_find}}, including all of its quirks.
This is provided in order to support existing templates, but is NOT RECOMMENDED for
new code and templates. New code is recommended to use the "find" function instead.

Returns the first index in "source" that is a match to "target". Indexing is 1-based,
and the function returns -1 if the "target" string is not present in "source".

Important Note: If the "target" string is empty / missing, this function returns a
value of "1", which is generally unexpected behavior, and must be accounted for
separatetly.
]]
function str.str_find( frame )
local new_args = str._getParameters( frame.args, {'source', 'target'} );
local source_str = new_args['source'] or '';
local target_str = new_args['target'] or '';

if target_str == '' then
return 1;
end

local start = mw.ustring.find( source_str, target_str, 1, true )
if start == nil then
start = -1
end

return start
end

--[[
find

This function allows one to search for a target string or pattern within another
string.

Usage:
{{#invoke:String|find|source_str|target_string|start_index|plain_flag}}
OR
{{#invoke:String|find|source=source_str|target=target_str|start=start_index|plain=plain_flag}}

Parameters
source: The string to search
target: The string or pattern to find within source
start: The index within the source string to start the search, defaults to 1
plain: Boolean flag indicating that target should be understood as plain
text and not as a Lua style regular expression, defaults to true

If invoked using named parameters, Mediawiki will automatically remove any leading or
trailing whitespace from the parameter. In some circumstances this is desirable, in
other cases one may want to preserve the whitespace.

This function returns the first index >= "start" where "target" can be found
within "source". Indices are 1-based. If "target" is not found, then this
function returns 0. If either "source" or "target" are missing / empty, this
function also returns 0.

This function should be safe for UTF-8 strings.
]]
function str.find( frame )
local new_args = str._getParameters( frame.args, {'source', 'target', 'start', 'plain' } );
local source_str = new_args['source'] or '';
local pattern = new_args['target'] or '';
local start_pos = tonumber(new_args['start']) or 1;
local plain = new_args['plain'] or true;

if source_str == '' or pattern == '' then
return 0;
end

plain = str._getBoolean( plain );

local start = mw.ustring.find( source_str, pattern, start_pos, plain )
if start == nil then
start = 0
end

return start
end

--[[
replace

This function allows one to replace a target string or pattern within another
string.

Usage:
{{#invoke:String|replace|source_str|pattern_string|replace_string|replacement_count|plain_flag}}
OR
{{#invoke:String|replace|source=source_string|pattern=pattern_string|replace=replace_string|
count=replacement_count|plain=plain_flag}}

Parameters
source: The string to search
pattern: The string or pattern to find within source
replace: The replacement text
count: The number of occurences to replace, defaults to all.
plain: Boolean flag indicating that pattern should be understood as plain
text and not as a Lua style regular expression, defaults to true
]]
function str.replace( frame )
local new_args = str._getParameters( frame.args, {'source', 'pattern', 'replace', 'count', 'plain' } );
local source_str = new_args['source'] or '';
local pattern = new_args['pattern'] or '';
local replace = new_args['replace'] or '';
local count = tonumber( new_args['count'] );
local plain = new_args['plain'] or true;

if source_str == '' or pattern == '' then
return source_str;
end
plain = str._getBoolean( plain );

if plain then
pattern = str._escapePattern( pattern );
replace = mw.ustring.gsub( replace, "%%", "%%%%" ); --Only need to escape replacement sequences.
end

local result;

if count ~= nil then
result = mw.ustring.gsub( source_str, pattern, replace, count );
else
result = mw.ustring.gsub( source_str, pattern, replace );
end

return result;
end

--[[
simple function to pipe string.rep to templates.
]]

function str.rep( frame )
local repetitions = tonumber( frame.args[2] )
if not repetitions then
return str._error( 'function rep expects a number as second parameter, received "' .. ( frame.args[2] or '' ) .. '"' )
end
return string.rep( frame.args[1] or '', repetitions )
end

--[[
Helper function that populates the argument list given that user may need to use a mix of
named and unnamed parameters. This is relevant because named parameters are not
identical to unnamed parameters due to string trimming, and when dealing with strings
we sometimes want to either preserve or remove that whitespace depending on the application.
]]
function str._getParameters( frame_args, arg_list )
local new_args = {};
local index = 1;
local value;

for i,arg in ipairs( arg_list ) do
value = frame_args[arg]
if value == nil then
value = frame_args[index];
index = index + 1;
end
new_args[arg] = value;
end

return new_args;
end

--[[
Helper function to handle error messages.
]]
function str._error( error_str )
local frame = mw.getCurrentFrame();
local error_category = frame.args.error_category or 'Errors reported by Module String';
local ignore_errors = frame.args.ignore_errors or false;
local no_category = frame.args.no_category or false;

if str._getBoolean(ignore_errors) then
return '';
end

local error_str = 'String Module Error: ' .. error_str .. '';
if error_category ~= '' and not str._getBoolean( no_category ) then
error_str = '[[Category:' .. error_category .. ']]' .. error_str;
end

return error_str;
end

--[[
Helper Function to interpret boolean strings
]]
function str._getBoolean( boolean_str )
local boolean_value;

if type( boolean_str ) == 'string' then
boolean_str = boolean_str:lower();
if boolean_str == 'false' or boolean_str == 'no' or boolean_str == '0'
or boolean_str == '' then
boolean_value = false;
else
boolean_value = true;
end
elseif type( boolean_str ) == 'boolean' then
boolean_value = boolean_str;
else
error( 'No boolean value found' );
end
return boolean_value
end

--[[
Helper function that escapes all pattern characters so that they will be treated
as plain text.
]]
function str._escapePattern( pattern_str )
return mw.ustring.gsub( pattern_str, "([%(%)%.%%%+%-%*%?%[%^%$%]])", "%%%1" );
end

return str

Module:Section link

2018-04-07T11:49:53Z

Max: 1 revision imported

-- This module implements {{section link}}.

local checkType = require('libraryUtil').checkType

local p = {}

local function makeSectionLink(page, section, display)
display = display or section
page = page or ''
return string.format('[[%s#%s|%s]]', page, section, display)
end

local function normalizeTitle(title)
title = mw.ustring.gsub(mw.ustring.gsub(title,"'",""),'"','')
return mw.title.new(mw.ustring.gsub(title,"%b<>","")).prefixedText
end

function p._main(page, sections, options, title)
-- Validate input.
checkType('_main', 1, page, 'string', true)
checkType('_main', 3, options, 'table', true)
if sections == nil then
sections = {}
elseif type(sections) == 'string' then
sections = {sections}
elseif type(sections) ~= 'table' then
error(string.format(
"type error in argument #2 to '_main' " ..
"(string, table or nil expected, got %s)",
type(sections)
), 2)
end
options = options or {}
title = title or mw.title.getCurrentTitle()

-- Deal with blank page names elegantly
if page and not page:find('%S') then
page = nil
options.nopage = true
end

-- Make the link(s).
local isShowingPage = not options.nopage
if #sections <= 1 then
local linkPage = page or ''
local section = sections[1] or 'Notes'
local display = '§ ' .. section
if isShowingPage then
page = page or title.prefixedText
if options.display and options.display ~= '' then
if normalizeTitle(options.display) == normalizeTitle(page) then
display = options.display .. ' ' .. display
else
error(string.format(
'Display title "%s" was ignored since it is ' ..
"not equivalent to the page's actual title",
options.display
), 0)
end
else
display = page .. ' ' .. display
end
end
return makeSectionLink(linkPage, section, display)
else
-- Multiple sections. First, make a list of the links to display.
local ret = {}
for i, section in ipairs(sections) do
ret[i] = makeSectionLink(page, section)
end

-- Assemble the list of links into a string with mw.text.listToText.
-- We use the default separator for mw.text.listToText, but a custom
-- conjunction. There is also a special case conjunction if we only
-- have two links.
local conjunction
if #sections == 2 then
conjunction = ' and '
else
conjunction = ', and '
end
ret = mw.text.listToText(ret, nil, conjunction)

-- Add the intro text.
local intro = '§§ '
if isShowingPage then
intro = (page or title.prefixedText) .. ' ' .. intro
end
ret = intro .. ret

return ret
end
end

function p.main(frame)
local args = require('Module:Arguments').getArgs(frame, {
wrappers = 'Template:Section link',
valueFunc = function (key, value)
value = value:match('^%s*(.-)%s*$') -- Trim whitespace
-- Allow blank first parameters, as the wikitext template does this.
if value ~= '' or key == 1 then
return value
end
end
})

-- Sort the arguments.
local page
local sections, options = {}, {}
for k, v in pairs(args) do
if k == 1 then
-- Doing this in the loop because of a bug in [[Module:Arguments]]
-- when using pairs with deleted arguments.
page = v
elseif type(k) == 'number' then
sections[k] = v
else
options[k] = v
end
end

-- Extract section from page, if present
if page then
local p, s = page:match('^(.-)#(.*)$')
if p then page, sections[1] = p, s end
end

-- Compress the sections array.
local function compressArray(t)
local nums, ret = {}, {}
for num in pairs(t) do
nums[#nums + 1] = num
end
table.sort(nums)
for i, num in ipairs(nums) do
ret[i] = t[num]
end
return ret
end
sections = compressArray(sections)

return p._main(page, sections, options)
end

return p

Module:Effective protection level

2018-04-07T11:49:52Z

Max: 1 revision imported

local p = {}

-- Returns the permission required to perform a given action on a given title.
-- If no title is specified, the title of the page being displayed is used.
function p._main(action, pagename)
local title
if type(pagename) == 'table' and pagename.prefixedText then
title = pagename
elseif pagename then
title = mw.title.new(pagename)
else
title = mw.title.getCurrentTitle()
end
pagename = title.prefixedText
if action == 'autoreview' then
local level = mw.ext.FlaggedRevs.getStabilitySettings(title)
level = level and level.autoreview
if level == 'review' then
return 'reviewer'
elseif level ~= '' then
return level
else
return nil -- not '*'. a page not being PC-protected is distinct from it being PC-protected with anyone able to review. also not '', as that would mean PC-protected but nobody can review
end
elseif action ~= 'edit' and action ~= 'move' and action ~= 'create' and action ~= 'upload' then
error( 'First parameter must be one of edit, move, create, upload, autoreview', 2 )
end
if title.namespace == 8 then -- MediaWiki namespace
return 'sysop'
elseif title.namespace == 2 and title.isSubpage and ( title.contentModel == 'javascript' or title.contentModel == 'css' or title.contentModel == 'json' ) then -- user JS, CSS or JSON page
return 'sysop'
end
local level = title.protectionLevels[action] and title.protectionLevels[action][1]
if level == 'sysop' or level == 'editprotected' then
return 'sysop'
elseif title.cascadingProtection.restrictions[action] and title.cascadingProtection.restrictions[action][1] then -- used by a cascading-protected page
return 'sysop'
elseif level == 'templateeditor' then
return 'templateeditor'
elseif action == 'move' then
local blacklistentry = mw.ext.TitleBlacklist.test('edit', pagename) -- Testing action edit is correct, since this is for the source page. The target page name gets tested with action move.
if blacklistentry and not blacklistentry.params.autoconfirmed then
return 'templateeditor'
elseif title.namespace == 6 then
return 'filemover'
elseif level == 'extendedconfirmed' then
return 'extendedconfirmed'
else
return 'autoconfirmed'
end
end
local blacklistentry = mw.ext.TitleBlacklist.test(action, pagename)
if blacklistentry then
if not blacklistentry.params.autoconfirmed then
return 'templateeditor'
elseif level == 'extendedconfirmed' then
return 'extendedconfirmed'
else
return 'autoconfirmed'
end
elseif level == 'editsemiprotected' then -- create-semiprotected pages return this for some reason
return 'autoconfirmed'
elseif level then
return level
elseif action == 'upload' then
return 'autoconfirmed'
elseif action == 'create' and title.namespace % 2 == 0 and title.namespace ~= 118 then -- You need to be registered, but not autoconfirmed, to create non-talk pages other than drafts
return 'user'
else
return '*'
end
end

setmetatable(p, { __index = function(t, k)
return function(frame)
return t._main(k, frame.args[1])
end
end })

return p

Module:Delink

2018-04-07T11:49:52Z

Max: 1 revision imported

-- This module de-links most wikitext.

require('Module:No globals')

local p = {}

local getArgs

local function delinkReversePipeTrick(s)
if s:match("^%[%[|.*[|\n]") then -- Check for newlines or multiple pipes.
return s
else
return s:match("%[%[|(.*)%]%]")
end
end

local function delinkPipeTrick(s)
local linkarea, display = "", ""
-- We need to deal with colons, brackets, and commas, per [[Help:Pipe trick]].

-- First, remove the text before the first colon, if any.
if s:match(":") then
s = s:match("%[%[.-:(.*)|%]%]")
-- If there are no colons, grab all of the text apart from the square brackets and the pipe.
else
s = s:match("%[%[(.*)|%]%]")
end

-- Next up, brackets and commas.
if s:match("%(.-%)$") then -- Brackets trump commas.
s = s:match("(.-) ?%(.-%)$")
elseif s:match(",") then -- If there are no brackets, display only the text before the first comma.
s = s:match("(.-),.*$")
end
return s
end

local function delinkWikilink(s)
local result = s
-- Deal with the reverse pipe trick.
if result:match("%[%[|") then
return delinkReversePipeTrick(result)
end

result = mw.uri.decode(result, "PATH") -- decode percent-encoded entities. Leave underscores and plus signs.
result = mw.text.decode(result, true) -- decode HTML entities.

-- Check for bad titles. To do this we need to find the
-- title area of the link, i.e. the part before any pipes.
local titlearea
if result:match("|") then -- Find if we're dealing with a piped link.
titlearea = result:match("^%[%[(.-)|.*%]%]")
else
titlearea = result:match("^%[%[(.-)%]%]")
end
-- Check for bad characters.
if mw.ustring.match(titlearea, "[%[%]<>{}%%%c\n]") then
return s
end

-- Check for categories, interwikis, and files.
local colonprefix = result:match("%[%[(.-):.*%]%]") or "" -- Get the text before the first colon.
local ns = mw.site.namespaces[colonprefix] -- see if this is a known namespace
if mw.language.isKnownLanguageTag(colonprefix)
or ( ns and ( ns.canonicalName == "File" or ns.canonicalName == "Category" ) ) then
return ""
end

-- Remove the colon if the link is using the [[Help:Colon trick]].
if result:match("%[%[:") then
result = "[[" .. result:match("%[%[:(.*%]%])")
end

-- Deal with links using the [[Help:Pipe trick]].
if mw.ustring.match(result, "^%[%[[^|]*|%]%]") then
return delinkPipeTrick(result)
end

-- Find the display area of the wikilink
if result:match("|") then -- Find if we're dealing with a piped link.
result = result:match("^%[%[.-|(.+)%]%]")
-- Remove new lines from the display of multiline piped links,
-- where the pipe is before the first new line.
result = result:gsub("\n", "")
else
result = result:match("^%[%[(.-)%]%]")
end

return result
end

local function delinkURL(s)
-- Assume we have already delinked internal wikilinks, and that
-- we have been passed some text between two square brackets [foo].

-- If the text contains a line break it is not formatted as a URL, regardless of other content.
if s:match("\n") then
return s
end

-- Check if the text has a valid URL prefix and at least one valid URL character.
local valid_url_prefixes = {"//", "http://", "https://", "ftp://", "gopher://", "mailto:", "news:", "irc://"}
local url_prefix
for i,v in ipairs(valid_url_prefixes) do
if mw.ustring.match(s, '^%[' .. v ..'[^"%s].*%]' ) then
url_prefix = v
break
end
end

-- Get display text
if not url_prefix then
return s
end
s = s:match("^%[" .. url_prefix .. "(.*)%]") -- Grab all of the text after the URL prefix and before the final square bracket.
s = s:match('^.-(["<> ].*)') or "" -- Grab all of the text after the first URL separator character ("<> ).
s = mw.ustring.match(s, "^%s*(%S.*)$") or "" -- If the separating character was a space, trim it off.

local s_decoded = mw.text.decode(s, true)
if mw.ustring.match(s_decoded, "%c") then
return s
else
return s_decoded
end
end

local function delinkLinkClass(s, pattern, delinkFunction)
if not type(s) == "string" then
error("Attempt to de-link non-string input.", 2)
end
if not ( type(pattern) == "string" and mw.ustring.sub(pattern, 1, 1) == "^" ) then
error('Invalid pattern detected. Patterns must begin with "^".', 2)
end
-- Iterate over the text string, and replace any matched text. using the
-- delink function. We need to iterate character by character rather
-- than just use gsub, otherwise nested links aren't detected properly.
local result = ""
while s ~= '' do
-- Replace text using one iteration of gsub.
s = mw.ustring.gsub(s, pattern, delinkFunction, 1)
-- Append the left-most character to the result string.
result = result .. mw.ustring.sub(s, 1, 1)
s = mw.ustring.sub(s, 2, -1)
end
return result
end

function p._delink(args)
local text = args[1] or ""
if args.refs == "yes" then
-- Remove any [[Help:Strip markers]] representing ref tags. In most situations
-- this is not a good idea - only use it if you know what you are doing!
text = mw.ustring.gsub(text, "UNIQ%w*%-ref%-%d*%-QINU", "")
end
if not (args.comments == "no") then
text = text:gsub("<!%-%-.-%-%->", "") -- Remove html comments.
end
if not (args.wikilinks == "no") then
text = delinkLinkClass(text, "^%[%[.-%]%]", delinkWikilink) -- De-link wikilinks.
end
if not (args.urls == "no") then
text = delinkLinkClass(text, "^%[.-%]", delinkURL) -- De-link URLs.
end
if not (args.whitespace == "no") then
-- Replace single new lines with a single space, but leave double new lines
-- and new lines only containing spaces or tabs before a second new line.
text = mw.ustring.gsub(text, "([^\n \t][ \t]*)\n([ \t]*[^\n \t])", "%1 %2")
text = text:gsub("[ \t]+", " ") -- Remove extra tabs and spaces.
end
return text
end

function p.delink(frame)
if not getArgs then
getArgs = require('Module:Arguments').getArgs
end
return p._delink(getArgs(frame, {wrappers = 'Template:Delink'}))
end

return p

Module:Citation/CS1/Whitelist

2018-04-07T11:49:51Z

Max: 1 revision imported

--[[--------------------------------------------------------

This is a list of parameters that once were but now are no longer supported:

['albumlink'] = nil, -- unique alias of titlelink used by old cite AV media notes
['albumtype'] = nil, -- controled inappropriate functionality in the old cite AV media notes
['artist'] = nil, -- unique alias of others used by old cite AV media notes
['ARXIV'] = nil, -- not an initialization
['Author'] = nil, -- non-standard capitalization
['authorformat'] = nil, -- primarily used to support Vancouver format which functionality now part of name-list-format
['author-format'] = nil, -- primarily used to support Vancouver format which functionality now part of name-list-format
['author-name-separator'] = nil,-- primarily used to support Vancouver format which functionality now part of name-list-format
['author-separator'] = nil, -- primarily used to support Vancouver format which functionality now part of name-list-format
['began'] = nil, -- module handles date ranges; cite episode and cite series
['BIBCODE'] = nil, -- not an initialization
['callsign'] = nil, -- cite interview removed
['call-sign'] = nil, -- cite interview removed
['chapterlink'] = nil, -- if ever necessary to link to a chapter article, |chapter= can be wikilinked
['chapter-link'] = nil, --
['city'] = nil, -- cite interview removed
['coauthor'] = nil, -- redundant to |authorn=; not made part of metadata
['coauthors'] = nil, -- redundant to |authorn=; not made part of metadata
['cointerviewers'] = nil, -- unique alias of others used by old cite interview
['day'] = nil, -- deprecated in {{citation/core}} and somehow undeprecated in Module:Citation/CS1 and now finally removed
['director'] = nil, -- unique alias of author used by old cite DVD-notes
['doi_brokendate'] = nil, -- alias of doi-broken-date
['doi_inactivedate'] = nil, -- alias of doi-inactive-date
['DoiBroken'] = nil, -- not used, non-standard captialization
['Editor'] = nil, -- non-standard capitalization
['editorformat'] = nil, -- primarily used to support Vancouver format which functionality now part of name-list-format
['EditorSurname'] = nil, -- non-standard capitalization
['editor-format'] = nil, -- primarily used to support Vancouver format which functionality now part of name-list-format
['EditorGiven'] = nil, -- non-standard capitalization
['editor-name-separator'] = nil,-- primarily used to support Vancouver format which functionality now part of name-list-format
['editor-separator'] = nil, -- primarily used to support Vancouver format which functionality now part of name-list-format
['Embargo'] = nil, -- not used, non-standard capitalization
['ended'] = nil, -- module handles date ranges; cite episode and cite series
['month'] = nil, -- functionality supported by |date=
['name-separator'] = nil, -- primarily used to support Vancouver format which functionality now part of name-list-format
['notestitle'] = nil, -- unique alias of chapter used by old cite AV media notes
['PPrefix'] = nil, -- non-standard capitalization
['PPPrefix'] = nil, -- not used, non-standard capitalization
['pp-prefix'] = nil, -- not used, not documented
['p-prefix'] = nil, -- not used, not documented
['program'] = nil, -- cite interview removed
['publisherid'] = nil, -- unique alias of id used by old cite AV media notes and old cite DVD-notes
['Ref'] = nil, -- non-standard capitalization
['separator'] = nil, -- this functionality now provided by |mode=
['template doc demo'] = nil, -- alias of template doc demo
['titleyear'] = nil, -- unique alias of origyear used by old cite DVD-notes
['trans_chapter'] = nil, -- alias of trans-chapter
['trans_title'] = nil, -- alias of trans-title

['Author#'] = nil, -- non-standard capitalization
['authors#'] = nil, -- no need for multiple lists of author names
['Editor#'] = nil, -- non-standard capitalization
['editors#'] = nil, -- no need for multiple lists of editor names
['EditorGiven#'] = nil, -- non-standard capitalization
['EditorSurname#'] = nil, -- non-standard capitalization

]]

--[[--------------------------< S U P P O R T E D P A R A M E T E R S >--------------------------------------

Because a steady-state signal conveys no useful information, whitelist.basic_arguments[] list items can have three values:
true - these parameters are valid and supported parameters
false - these parameters are deprecated but still supported
nil - these parameters are no longer supported (when setting a parameter to nil, leave a comment stating the reasons for invalidating the parameter)

]]

local whitelist = {}

local basic_arguments = {
['accessdate'] = true,
['access-date'] = true,
['agency'] = true,
['airdate'] = true,
['air-date'] = true,
['archivedate'] = true,
['archive-date'] = true,
['archive-format'] = true,
['archiveurl'] = true,
['archive-url'] = true,
['article'] = true,
['arxiv'] = true,
['asin'] = true,
['ASIN'] = true,
['asin-tld'] = true,
['ASIN-TLD'] = true,
['at'] = true,
['author'] = true,
['author-first'] = true,
['author-last'] = true,
['authorlink'] = true,
['author-link'] = true,
['authormask'] = true,
['author-mask'] = true,
['authors'] = true,
['bibcode'] = true,
['bibcode-access'] = true,
['biorxiv'] = true,
['booktitle'] = true,
['book-title'] = true,
['cartography'] = true,
['chapter'] = true,
['chapter-format'] = true,
['chapterurl'] = true,
['chapter-url'] = true,
['chapter-url-access'] = true,
['citeseerx'] = true,
['class'] = true, -- cite arxiv and arxiv identifiers
['collaboration'] = true,
['conference'] = true,
['conference-format'] = true,
['conferenceurl'] = true,
['conference-url'] = true,
['contribution'] = true,
['contribution-format'] = true,
['contributionurl'] = true,
['contribution-url'] = true,
['contributor'] = true,
['contributor-first'] = true,
['contributor-last'] = true,
['contributor-given'] = true,
['contributor-surname'] = true,
['contributor-link'] = true,
['contributor-mask'] = true,
['credits'] = true, -- cite episode, cite serial
['date'] = true,
['deadurl'] = true,
['dead-url'] = true,
['degree'] = true,
['department'] = true,
['df'] = true,
['dictionary'] = true,
['displayauthors'] = true,
['display-authors'] = true,
['displayeditors'] = true,
['display-editors'] = true,
['docket'] = true,
['doi'] = true,
['DOI'] = true,
['doi-access'] = true,
['doi-broken'] = true,
['doi-broken-date'] = true,
['doi-inactive-date'] = true,
['edition'] = true,
['editor'] = true,
['editor-first'] = true,
['editor-given'] = true,
['editor-last'] = true,
['editorlink'] = true,
['editor-link'] = true,
['editormask'] = true,
['editor-mask'] = true,
['editors'] = true,
['editor-surname'] = true,
['eissn'] = true,
['EISSN'] = true,
['embargo'] = true,
['encyclopaedia'] = true,
['encyclopedia'] = true,
['entry'] = true,
['episode'] = true, -- cite serial only TODO: make available to cite episode?
['episodelink'] = true, -- cite episode and cite serial
['episode-link'] = true, -- cite episode and cite serial
['eprint'] = true, -- cite arxiv and arxiv identifiers
['event'] = true,
['event-format'] = true,
['eventurl'] = true,
['event-url'] = true,
['first'] = true,
['format'] = true,
['given'] = true,
['hdl'] = true,
['HDL'] = true,
['hdl-access'] = true,
['host'] = true,
['id'] = true,
['ID'] = true,
['ignoreisbnerror'] = true,
['ignore-isbn-error'] = true,
['in'] = true,
['inset'] = true,
['institution'] = true,
['interviewer'] = true,
['interviewer-first'] = true,
['interviewer-last'] = true,
['interviewerlink'] = true,
['interviewer-link'] = true,
['interviewermask'] = true,
['interviewer-mask'] = true,
['interviewers'] = true,
['isbn'] = true,
['ISBN'] = true,
['isbn13'] = true,
['ISBN13'] = true,
['ismn'] = true,
['ISMN'] = true,
['issn'] = true,
['ISSN'] = true,
['issue'] = true,
['jfm'] = true,
['JFM'] = true,
['journal'] = true,
['jstor'] = true,
['JSTOR'] = true,
['jstor-access'] = true,
['language'] = true,
['last'] = true,
['lastauthoramp'] = true,
['last-author-amp'] = true,
['laydate'] = true,
['lay-date'] = true,
['laysource'] = true,
['lay-source'] = true,
['laysummary'] = true,
['lay-summary'] = true,
['lay-format'] = true,
['layurl'] = true,
['lay-url'] = true,
['lccn'] = true,
['LCCN'] = true,
['location'] = true,
['magazine'] = true,
['mailinglist'] = true, -- cite mailing list only
['mailing-list'] = true, -- cite mailing list only
['map'] = true, -- cite map only
['map-format'] = true, -- cite map only
['mapurl'] = true, -- cite map only
['map-url'] = true, -- cite map only
['medium'] = true,
['message-id'] = true, -- cite newsgroup
['minutes'] = true,
['mode'] = true,
['mr'] = true,
['MR'] = true,
['name-list-format'] = true,
['network'] = true,
['newsgroup'] = true,
['newspaper'] = true,
['nocat'] = true,
['no-cat'] = true,
['nopp'] = true,
['no-pp'] = true,
['notracking'] = true,
['no-tracking'] = true,
['number'] = true,
['oclc'] = true,
['OCLC'] = true,
['ol'] = true,
['OL'] = true,
['ol-access'] = true,
['origyear'] = true,
['orig-year'] = true,
['osti'] = true,
['OSTI'] = true,
['osti-access'] = true,
['others'] = true,
['p'] = true,
['page'] = true,
['pages'] = true,
['people'] = true,
['periodical'] = true,
['place'] = true,
['pmc'] = true,
['PMC'] = true,
['pmid'] = true,
['PMID'] = true,
['postscript'] = true,
['pp'] = true,
['publicationdate'] = true,
['publication-date'] = true,
['publicationplace'] = true,
['publication-place'] = true,
['publisher'] = true,
['quotation'] = true,
['quote'] = true,
['ref'] = true,
['registration'] = true,
['rfc'] = true,
['RFC'] = true,
['scale'] = true,
['script-chapter'] = true,
['script-title'] = true,
['season'] = true,
['section'] = true,
['section-format'] = true,
['sections'] = true, -- cite map only
['sectionurl'] = true,
['section-url'] = true,
['series'] = true,
['serieslink'] = true,
['series-link'] = true,
['seriesno'] = true,
['series-no'] = true,
['seriesnumber'] = true,
['series-number'] = true,
['series-separator'] = true,
['sheet'] = true, -- cite map only
['sheets'] = true, -- cite map only
['ssrn'] = true,
['SSRN'] = true,
['station'] = true,
['subject'] = true,
['subjectlink'] = true,
['subject-link'] = true,
['subscription'] = true,
['surname'] = true,
['template-doc-demo'] = true,
['time'] = true,
['timecaption'] = true,
['time-caption'] = true,
['title'] = true,
['titlelink'] = true,
['title-link'] = true,
['trans-chapter'] = true,
['trans-map'] = true,
['transcript'] = true,
['transcript-format'] = true,
['transcripturl'] = true,
['transcript-url'] = true,
['trans-title'] = true,
['translator'] = true,
['translator-first'] = true,
['translator-last'] = true,
['translator-given'] = true,
['translator-surname'] = true,
['translator-link'] = true,
['translator-mask'] = true,
['type'] = true,
['url'] = true,
['URL'] = true,
['url-access'] = true,
['vauthors'] = true,
['veditors'] = true,
['version'] = true,
['via'] = true,
['volume'] = true,
['website'] = true,
['work'] = true,
['year'] = true,
['zbl'] = true,
['ZBL'] = true,
}

local numbered_arguments = {
['author#'] = true,
['author-first#'] = true,
['author#-first'] = true,
['author-last#'] = true,
['author#-last'] = true,
['author-link#'] = true,
['author#link'] = true,
['author#-link'] = true,
['authorlink#'] = true,
['author-mask#'] = true,
['author#mask'] = true,
['author#-mask'] = true,
['authormask#'] = true,
['contributor#'] = true,
['contributor-first#'] = true,
['contributor#-first'] = true,
['contributor-last#'] = true,
['contributor#-last'] = true,
['contributor-given#'] = true,
['contributor#-given'] = true,
['contributor-surname#'] = true,
['contributor#-surname'] = true,
['contributor-link#'] = true,
['contributor#-link'] = true,
['contributor-mask#'] = true,
['contributor#-mask'] = true,
['editor#'] = true,
['editor-first#'] = true,
['editor#-first'] = true,
['editor#-given'] = true,
['editor-given#'] = true,
['editor-last#'] = true,
['editor#-last'] = true,
['editor-link#'] = true,
['editor#link'] = true,
['editor#-link'] = true,
['editorlink#'] = true,
['editor-mask#'] = true,
['editor#mask'] = true,
['editor#-mask'] = true,
['editormask#'] = true,
['editor#-surname'] = true,
['editor-surname#'] = true,
['first#'] = true,
['given#'] = true,
['interviewer#'] = true,
['interviewer-first#'] = true,
['interviewer#-first'] = true,
['interviewer-last#'] = true,
['interviewer#-last'] = true,
['interviewer-link#'] = true,
['interviewer#-link'] = true,
['interviewer-mask#'] = true,
['interviewer#-mask'] = true,
['last#'] = true,
['subject#'] = true,
['subject-link#'] = true,
['subject#link'] = true,
['subject#-link'] = true,
['subjectlink#'] = true,
['surname#'] = true,
['translator#'] = true,
['translator-first#'] = true,
['translator#-first'] = true,
['translator-last#'] = true,
['translator#-last'] = true,
['translator-given#'] = true,
['translator#-given'] = true,
['translator-surname#'] = true,
['translator#-surname'] = true,
['translator-link#'] = true,
['translator#-link'] = true,
['translator-mask#'] = true,
['translator#-mask'] = true,
}

--[[--------------------------< C I T E A R X I V S U P P O R T E D P A R A M E T E R S >----------------

This is an experiment that attempts to use validate() and a limited list of valid parameters to validate the
parameters provided in a cite arxiv template. This method might be expanded to other templates being considered.

Because a steady-state signal conveys no useful information, whitelist.basic_arguments[] list items can have three values:
true - these parameters are valid and supported parameters
false - these parameters are deprecated but still supported
nil - these parameters are no longer supported (when setting a parameter to nil, leave a comment stating the reasons for invalidating the parameter)

]]

--[[
This is a list of parameters that once were but now are no longer supported:
['ARXIV'] = nil, -- not an initialization
['version'] = nil, -- this is the cite arxiv parameter; |version= still supported by other cs1|2 templates

]]

local arxiv_basic_arguments = {
['arxiv'] = true,
['class'] = true, -- cite arxiv and arxiv identifiers
['eprint'] = true, -- cite arxiv and arxiv identifiers
}

--[[--------------------------< C I T E B I O R X I V S U P P O R T E D P A R A M E T E R S >------------

This is an experiment that attempts to use validate() and a limited list of valid parameters to validate the
parameters provided in a cite biorxiv template. This method might be expanded to other templates being considered.

Because a steady-state signal conveys no useful information, whitelist.basic_arguments[] list items can have three values:
true - these parameters are valid and supported parameters
false - these parameters are deprecated but still supported
nil - these parameters are no longer supported (when setting a parameter to nil, leave a comment stating the reasons for invalidating the parameter)

]]

local biorxiv_basic_arguments = {
['biorxiv'] = true,
}

--[[--------------------------< C I T E C I T E S E E R X S U P P O R T E D P A R A M E T E R S >--------

This is an experiment that attempts to use validate() and a limited list of valid parameters to validate the
parameters provided in a cite citeseerx template. This method might be expanded to other templates being considered.

Because a steady-state signal conveys no useful information, whitelist.basic_arguments[] list items can have three values:
true - these parameters are valid and supported parameters
false - these parameters are deprecated but still supported
nil - these parameters are no longer supported (when setting a parameter to nil, leave a comment stating the reasons for invalidating the parameter)

]]

local citeseerx_basic_arguments = {
['citeseerx'] = true,
}

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

This is an experiment that attempts to use validate() and a limited list of valid parameters to validate the
parameters provided in a cite arxiv, cite biorxiv, or cite citeseerx templates. These parameters are common to
all three templates

Because a steady-state signal conveys no useful information, whitelist.basic_arguments[] list items can have three values:
true - these parameters are valid and supported parameters
false - these parameters are deprecated but still supported
nil - these parameters are no longer supported (when setting a parameter to nil, leave a comment stating the reasons for invalidating the parameter)

]]

local limited_basic_arguments = {
['at'] = true,
['author'] = true,
['author-first'] = true,
['author-last'] = true,
['authorlink'] = true,
['author-link'] = true,
['authormask'] = true,
['author-mask'] = true,
['authors'] = true,
['collaboration'] = true,
['date'] = true,
['df'] = true,
['display-authors'] = true,
['first'] = true,
['given'] = true,
['language'] = true,
['last'] = true,
['lastauthoramp'] = true,
['last-author-amp'] = true,
['mode'] = true,
['name-list-format'] = true,
['nocat'] = true,
['no-cat'] = true,
['notracking'] = true,
['no-tracking'] = true,
['p'] = true,
['page'] = true,
['pages'] = true,
['postscript'] = true,
['pp'] = true,
['quotation'] = true,
['quote'] = true,
['ref'] = true,
['surname'] = true,
['template-doc-demo'] = true,
['title'] = true,
['url'] = true,
['URL'] = true,
['vauthors'] = true,
['year'] = true,
}
local limited_numbered_arguments = {
['author#'] = true,
['author-first#'] = true,
['author#-first'] = true,
['author-last#'] = true,
['author#-last'] = true,
['author-link#'] = true,
['author#link'] = true,
['author#-link'] = true,
['authorlink#'] = true,
['author-mask#'] = true,
['author#mask'] = true,
['author#-mask'] = true,
['authormask#'] = true,
['first#'] = true,
['given#'] = true,
['last#'] = true,
['surname#'] = true,
}

return {
basic_arguments = basic_arguments,
numbered_arguments = numbered_arguments,
limited_basic_arguments = limited_basic_arguments,
limited_numbered_arguments = limited_numbered_arguments,
arxiv_basic_arguments = arxiv_basic_arguments,
biorxiv_basic_arguments = biorxiv_basic_arguments,
citeseerx_basic_arguments = citeseerx_basic_arguments
};

Module:Citation/CS1/Utilities

2018-04-07T11:49:51Z

Max: 1 revision imported

local u = {}

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
};

--[[--------------------------< F O R W A R D D E C L A R A T I O N S >--------------------------------------
]]

local cfg; -- table of tables imported from selected Module:Citation/CS1/Configuration

--[[--------------------------------------------------------------------------------------------

Returns true if argument is set; false otherwise. Argument is 'set' when it exists (not nil) or when it is not an empty string.

]]

local function is_set( var )
return not (var == nil or var == '');
end

--[[----------------------------------------------------------------------------------------

Whether needle is in haystack

]]

local function in_array( 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

--[[--------------------------< S U B S T I T U T E >----------------------------------------------------------

Populates numbered arguments in a message string using an argument table.

]]

local function substitute( msg, args )
return args and mw.message.newRawMessage( msg, args ):plain() or msg;
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.

]]

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

--[=[-------------------------< M A K E _ W I K I L I N K >----------------------------------------------------

Makes a wikilink; when bot link and display text is provided, returns a wikilink in the form [[L|D]]; if only
link is provided, returns a wikilink in the form [[L]]; if neither are provided or link is omitted, returns an
empty string.

]=]

local function make_wikilink (link, display)
if is_set (link) then
if is_set (display) then
return table.concat ({'[[', link, '|', display, ']]'});
else
return table.concat ({'[[', link, ']]'});
end
else
return '';
end
end

--[[--------------------------< S E T _ E R R O R >--------------------------------------------------------------

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.

]]

local function set_error( 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'] ); -- because missing error handler in Module:Citation/CS1/Configuration
elseif is_set( error_state.category ) then
table.insert( z.error_categories, error_state.category );
end

local message = substitute( error_state.message, arguments );

message = table.concat (
{
message,
' (',
make_wikilink (
table.concat (
{
cfg.messages['help page link'],
'#',
error_state.anchor
}),
cfg.messages['help page label']),
')'
});

-- message = table.concat ({message, ' (', substitute (cfg.presentation['wikilink'],
-- {cfg.messages['help page link'] .. '#' .. error_state.anchor, cfg.messages['help page label']}), ')'});
-- 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

--[[------------------------------------------------------------------------------

This function is used by select_one() to determine if one of a list of alias parameters is in the argument list
provided by the template.

Input:
args – pointer to the arguments table from calling template
alias – one of the list of possible aliases in the aliases lists from Module:Citation/CS1/Configuration
index – for enumerated parameters, identifies which one
enumerated – true/false flag used choose how enumerated aliases are examined
value – value associated with an alias that has previously been selected; nil if not yet selected
selected – the alias that has previously been selected; nil if not yet selected
error_list – list of aliases that are duplicates of the alias already selected

Returns:
value – value associated with alias we selected or that was previously selected or nil if an alias not yet selected
selected – the alias we selected or the alias that was previously selected or nil if an alias not yet selected

]]

local function is_alias_used (args, alias, index, enumerated, value, selected, error_list)
if enumerated then -- is this a test for an enumerated parameters?
alias = alias:gsub ('#', index); -- replace '#' with the value in index
else
alias = alias:gsub ('#', ''); -- remove '#' if it exists
end

if is_set(args[alias]) then -- alias is in the template's argument list
if value ~= nil and selected ~= alias then -- if we have already selected one of the aliases
local skip;
for _, v in ipairs(error_list) do -- spin through the error list to see if we've added this alias
if v == alias then
skip = true;
break; -- has been added so stop looking
end
end
if not skip then -- has not been added so
table.insert( error_list, alias ); -- add error alias to the error list
end
else
value = args[alias]; -- not yet selected an alias, so select this one
selected = alias;
end
end
return value, selected; -- return newly selected alias, or previously selected alias
end

--[[--------------------------< A D D _ M A I N T _ C A T >------------------------------------------------------

Adds a category to z.maintenance_cats using names from the configuration file with additional text if any.
To prevent duplication, the added_maint_cats table lists the categories by key that have been added to z.maintenance_cats.

]]

local added_maint_cats = {} -- list of maintenance categories that have been added to z.maintenance_cats
local function add_maint_cat (key, arguments)
if not added_maint_cats [key] then
added_maint_cats [key] = true; -- note that we've added this category
table.insert( z.maintenance_cats, substitute (cfg.maint_cats [key], arguments)); -- make name then add to table
end
end

--[[--------------------------< S A F E _ F O R _ I T A L I C S >----------------------------------------------

Protects a string that will be wrapped in wiki italic markup '' ... ''

Note: We cannot use 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, and '' tend to interact
poorly under Mediawiki's HTML tidy.

]]

local function safe_for_italics( str )
if not is_set(str) then
return str;
else
if str:sub(1,1) == "'" then str = "" .. str; end
if str:sub(-1,-1) == "'" then str = str .. ""; end

-- Remove newlines as they break italics.
return str:gsub( '\n', ' ' );
end
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().

]]

local function wrap_style (key, str)
if not is_set( str ) then
return "";
elseif in_array( key, { 'italic-title', 'trans-italic-title' } ) then
str = safe_for_italics( str );
end

return substitute( cfg.presentation[key], {str} );
end

--[[--------------------------< S E L E C T _ O N E >----------------------------------------------------------

Chooses one matching parameter from a list of parameters to consider. The list of parameters to consider is just
names. For parameters that may be enumerated, the position of the numerator in the parameter name is identified
by the '#' so |author-last1= and |author1-last= are represented as 'author-last#' and 'author#-last'.

Because enumerated parameter |<param>1= is an alias of |<param>= we must test for both possibilities.

Generates an error if more than one match is present.

]]

local function select_one( args, aliases_list, error_condition, index )
local value = nil; -- the value assigned to the selected parameter
local selected = ''; -- the name of the parameter we have chosen
local error_list = {};

if index ~= nil then index = tostring(index); end

for _, alias in ipairs( aliases_list ) do -- for each alias in the aliases list
if alias:match ('#') then -- if this alias can be enumerated
if '1' == index then -- when index is 1 test for enumerated and non-enumerated aliases
value, selected = is_alias_used (args, alias, index, false, value, selected, error_list); -- first test for non-enumerated alias
end
value, selected = is_alias_used (args, alias, index, true, value, selected, error_list); -- test for enumerated alias
else
value, selected = is_alias_used (args, alias, index, false, value, selected, error_list); --test for non-enumerated alias
end
end

if #error_list > 0 and 'none' ~= error_condition then -- for cases where this code is used outside of extract_names()
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

--[=[-------------------------< R E M O V E _ W I K I _ L I N K >----------------------------------------------

Gets the display text from a wikilink like [[A|B]] or [[B]] gives B

The str:gsub() returns either A|B froma [[A|B]] or B from [[B]] or B from B (no wikilink markup).

In l(), l:gsub() removes the link and pipe (if they exist); the second :gsub() trims white space from the label
if str was wrapped in wikilink markup. Presumably, this is because without wikimarkup in str, there is no match
in the initial gsub, the replacement function l() doesn't get called.

]=]

local function remove_wiki_link (str)
return (str:gsub( "%[%[([^%[%]]*)%]%]", function(l)
return l:gsub( "^[^|]*|(.*)$", "%1" ):gsub("^%s*(.-)%s*$", "%1");
end));
end

--[=[---------------------------------------------------------------------------------

Determines if str is a wikilink, extracts, and returns the the wikilink type, link text, and display text parts.
If str is a complex wikilink ([[L|D]]):
returns wl_type 2 and D and L from [[L|D]];
if str is a simple wikilink ([[D]])
returns wl_type 1 and D from [[D]] and L as empty string;
if not a wikilink:
returns wl_type 0, str as D, and L as empty string.

trims leading and trailing white space and pipes from L and D ([[L|]] and [[|D]] are accepted by MediaWiki and
treated like [[D]]; while [[|D|]] is not accepted by MediaWiki, here, we accept it and return D without the pipes).

]=]

local function is_wikilink (str)
local D, L
local wl_type = 2; -- assume that str is a complex wikilink [[L|D]]

L, D = str:match ('%[%[([^|]+)|([^%]]+)%]%]'); -- get L and D from [[L|D]]

if not is_set (D) then -- if no separate link
D = str:match ('%[%[([^%]]*)|*%]%]'); -- get D from [[D]]
wl_type = 1;
end

if not is_set (D) then -- no wikilink markup
D = str; -- return the string as D
wl_type = 0; -- but say that it is not a wikilink
end

D = mw.text.trim (D, '%s|'); -- trim white space and pipe characters
L = L and mw.text.trim (L, '%s|');

return wl_type, D, L or '';
end

--[[--------------------------< S E T _ S E L E C T E D _ M O D U L E S >--------------------------------------

Sets local cfg table to same (live or sandbox) as that used by the other modules.

]]

local function set_selected_modules (cfg_table_ptr)
cfg = cfg_table_ptr;

end

return { -- return exported functions and tables
is_set = is_set,
in_array = in_array,
substitute = substitute,
error_comment = error_comment,
set_error = set_error,
select_one = select_one,
add_maint_cat = add_maint_cat,
wrap_style = wrap_style,
safe_for_italics = safe_for_italics,
remove_wiki_link = remove_wiki_link,
is_wikilink = is_wikilink,
make_wikilink = make_wikilink,
set_selected_modules = set_selected_modules,
z = z,
}

Module:Citation/CS1/Identifiers

2018-04-07T11:49:51Z

Max: 1 revision imported

local identifiers = {};

--[[--------------------------< F O R W A R D D E C L A R A T I O N S >--------------------------------------
]]

local is_set, in_array, set_error, select_one, add_maint_cat, substitute, make_wikilink; -- functions in Module:Citation/CS1/Utilities

local z; -- table of tables defined in Module:Citation/CS1/Utilities

local cfg; -- table of configuration tables that are defined in Module:Citation/CS1/Configuration

--============================<< H E L P E R F U N C T I O N S >>============================================

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

Formats a wiki style external link

]]

local function external_link_id(options)
local url_string = options.id;
local ext_link;

if options.encode == true or options.encode == nil then
url_string = mw.uri.encode( url_string );
end

ext_link = mw.ustring.format ('[%s%s%s %s]', options.prefix, url_string, options.suffix or "", mw.text.nowiki(options.id));
if is_set(options.access) then
ext_link = substitute (cfg.presentation['access-signal'], {ext_link, cfg.presentation[options.access]}); -- add the free-to-read / paywall lock
end

return table.concat ({
make_wikilink (options.link, options.label),
options.separator or ' ',
ext_link
});
end

--[[------------------------------------------------------------------------

Formats a wiki style internal link

]]

local function internal_link_id(options)

return table.concat (
{
make_wikilink (options.link, options.label),
options.separator or ' ',
make_wikilink (
table.concat (
{
options.prefix,
options.id,
options.suffix or ''
}),
mw.text.nowiki (options.id)
);
});
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 the content of |embargo=; otherwise, returns and empty string because the embargo has expired or because
|embargo= was not set in this cite.

]]

local 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 then -- if embargo date and today's date are good dates
if tonumber( embargo_date ) >= tonumber( todays_date ) then -- is embargo date is in the future?
return embargo; -- still embargoed
else
add_maint_cat ('embargo')
return ''; -- unset because embargo has expired
end
end
end
return ''; -- |embargo= not set return empty string
end

--[[--------------------------< IS _ V A L I D _ I S X N >-----------------------------------------------------

ISBN-10 and ISSN validator code calculates checksum across all isbn/issn digits including the check digit.
ISBN-13 is checked in isbn().

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.

]]

local function is_valid_isxn (isxn_str, len)
local temp = 0;
isxn_str = { isxn_str:byte(1, len) }; -- make a table of byte values '0' → 0x30 .. '9' → 0x39, 'X' → 0x58
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 (compares the byte value of 'X' which is 0x58)
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

--[[--------------------------< IS _ V A L I D _ I S X N _ 1 3 >-----------------------------------------------

ISBN-13 and ISMN validator code calculates checksum across all 13 isbn/ismn digits including the check digit.
If the number is valid, the result will be 0. Before calling this function, isbn-13/ismn must be checked for length
and stripped of dashes, spaces and other non-isxn-13 characters.

]]

local function is_valid_isxn_13 (isxn_str)
local temp=0;

isxn_str = { isxn_str:byte(1, 13) }; -- make a table of byte values '0' → 0x30 .. '9' → 0x39
for i, v in ipairs( isxn_str ) do
temp = temp + (3 - 2*(i % 2)) * tonumber( string.char(v) ); -- multiply odd index digits by 1, even index digits by 3 and sum; includes check digit
end
return temp % 10 == 0; -- sum modulo 10 is zero when isbn-13/ismn is correct
end

--[[--------------------------< N O R M A L I Z E _ L C C N >--------------------------------------------------

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

local 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

--============================<>====================================

--[[--------------------------< A R X I V >--------------------------------------------------------------------

See: http://arxiv.org/help/arxiv_identifier

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:
arXiv:<date code>.<number><version>
where:
<date code> and <version> are as defined for 0704-1412
<number> is a five-digit number
]]

local function arxiv (id, class)
local handler = cfg.id_handlers['ARXIV'];
local year, month, version;
local err_cat = '';
local text;

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
year, month = id:match("^%a[%a%.%-]+/([90]%d)([01]%d)%d%d%d[v%d]*$");
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

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

if is_set (class) then
class = ' [[' .. '//arxiv.org/archive/' .. class .. ' ' .. class .. ']]'; -- external link within square brackets, not wikilink
else
class = ''; -- empty string for concatenation
end

return text .. class;
end

--[[----------------------------------------------------------------------------------------------

Validates (sort of) and formats a bibcode id.

Format for bibcodes is specified here: http://adsabs.harvard.edu/abs_doc/help_pages/data.html#bibcodes

But, this: 2015arXiv151206696F is apparently valid so apparently, the only things that really matter are length, 19 characters
and first four digits must be a year. This function makes these tests:
length must be 19 characters
characters in position
1–4 must be digits and must represent a year in the range of 1000 – next year
5 must be a letter
6 must be letter, ampersand, or dot (ampersand cannot directly precede a dot; &. )
7–8 must be letter, digit, ampersand, or dot (ampersand cannot directly precede a dot; &. )
9–18 must be letter, digit, or dot
19 must be a letter or dot

]]

local function bibcode (id, access)
local handler = cfg.id_handlers['BIBCODE'];
local err_type;
local year;

local text = external_link_id({link=handler.link, label=handler.label,
prefix=handler.prefix, id=id, separator=handler.separator, encode=handler.encode,
access=access});

if 19 ~= id:len() then
err_type = 'length';
else
year = id:match ("^(%d%d%d%d)[%a][%a&%.][%a&%.%d][%a&%.%d][%a%d%.]+[%a%.]$") --
if not year then -- if nil then no pattern match
err_type = 'value'; -- so value error
else
local next_year = tonumber(os.date ('%Y'))+1; -- get the current year as a number and add one for next year
year = tonumber (year); -- convert year portion of bibcode to a number
if (1000 > year) or (year > next_year) then
err_type = 'year'; -- year out of bounds
end
if id:find('&%.') then
err_type = 'journal'; -- journal abbreviation must not have '&.' (if it does its missing a letter)
end
end
end

if is_set (err_type) then -- if there was an error detected
text = text .. ' ' .. set_error( 'bad_bibcode', {err_type});
end
return text;
end

--[[-------------------------------------------------------------------------------------------

Format bioRxiv id and do simple error checking. BiorXiv ids are exactly 6 digits.
The bioRxiv id is the number following the last slash in the bioRxiv-issued DOI:
https://doi.org/10.1101/078733 -> 078733

]]

local function biorxiv(id)
local handler = cfg.id_handlers['BIORXIV'];
local err_cat = ''; -- presume that bioRxiv id is valid

if nil == id:match("^%d%d%d%d%d%d$") then -- if bioRxiv id has anything but six digits
err_cat = ' ' .. set_error( 'bad_biorxiv'); -- set an error message
end

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

--[[--------------------------< C I T E S E E R X >------------------------------------------------------------

CiteSeerX use their own notion of "doi" (not to be confused with the identifiers resolved via doi.org).

The description of the structure of this identifier can be found at Help_talk:Citation_Style_1/Archive_26#CiteSeerX_id_structure
]]

local function citeseerx (id)
local handler = cfg.id_handlers['CITESEERX'];
local matched;

local text = external_link_id({link=handler.link, label=handler.label,
prefix=handler.prefix, id=id, separator=handler.separator, encode=handler.encode,
access=handler.access});

matched = id:match ("^10%.1%.1%.[1-9]%d?%d?%d?%.[1-9]%d?%d?%d?$");
if not matched then
text = text .. ' ' .. set_error( 'bad_citeseerx' );
end
return text;
end

--[[--------------------------< D O I >------------------------------------------------------------------------

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.

]]

local function doi(id, inactive, access)
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
if is_set(inactive_year) then
table.insert( z.error_categories, "Pages with DOIs inactive since " .. inactive_year );
else
table.insert( z.error_categories, "Pages with inactive DOIs" ); -- when inactive doesn't contain a recognizable year
end
inactive = " (" .. cfg.messages['inactive'] .. " " .. inactive .. ")"
end
text = external_link_id({link = handler.link, label = handler.label,
prefix=handler.prefix,id=id,separator=handler.separator, encode=handler.encode, access=access}) .. (inactive or '')

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 = ' ' .. set_error( 'bad_doi' );
end

return text .. cat
end

--[[--------------------------< H D L >------------------------------------------------------------------------

Formats an HDL with minor error checking.

HDL names contain two parts: prefix and suffix separated by a forward slash.
Prefix: character string using any character in the UCS-2 character set except '/'
Suffix: character string of any length using any character in the UCS-2 character set chosen by the registrant

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

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

]]

local function hdl(id, access)
local handler = cfg.id_handlers['HDL'];

local text = external_link_id({link = handler.link, label = handler.label,
prefix=handler.prefix,id=id,separator=handler.separator, encode=handler.encode, access=access})

if nil == id:match("^[^%s–]-/[^%s–]-[^%.,]$") then -- hdl must contain a fwd slash, must not contain spaces, endashes, and must not end with period or comma
text = text .. ' ' .. set_error( 'bad_hdl' );
end
return text;
end

--[[------------------------------------------------------------------------------------------------

Determines whether an ISBN string is valid

]]

local function isbn( isbn_str )
if nil ~= isbn_str:match("[^%s-0-9X]") then
return false, 'invalid character'; -- fail if isbn_str contains anything but digits, hyphens, or the uppercase X
end
isbn_str = isbn_str:gsub( "-", "" ):gsub( " ", "" ); -- remove hyphens and spaces
local len = isbn_str:len();

if len ~= 10 and len ~= 13 then
return false, 'length'; -- fail if incorrect length
end

if len == 10 then
if isbn_str:match( "^%d*X?$" ) == nil then -- fail if isbn_str has 'X' anywhere but last position
return false, 'invalid form';
end
return is_valid_isxn(isbn_str, 10), 'checksum';
else
if isbn_str:match( "^%d+$" ) == nil then
return false, 'invalid character'; -- fail if isbn13 is not all digits
end
if isbn_str:match( "^97[89]%d*$" ) == nil then
return false, 'invalid prefix'; -- fail when isbn13 does not begin with 978 or 979
end
return is_valid_isxn_13 (isbn_str), 'checksum';
end
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.

This function is positioned here because it calls isbn()

]]

local function asin(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 = ' ' .. set_error ('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[%dX]$") then -- if 10-digit numeric (or 9 digits with terminal X)
if isbn( id ) then -- see if asin value is isbn10
add_maint_cat ('ASIN');
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
if not is_set(domain) then
domain = "com";
elseif in_array (domain, {'jp', 'uk'}) then -- Japan, United Kingdom
domain = "co." .. domain;
elseif in_array (domain, {'au', 'br', 'mx'}) then -- Australia, Brazil, Mexico
domain = "com." .. domain;
end
local handler = cfg.id_handlers['ASIN'];
return external_link_id({link=handler.link,
label=handler.label, prefix=handler.prefix .. domain .. "/dp/",
id=id, encode=handler.encode, separator = handler.separator}) .. err_cat;
end

--[[------------------------------------------------------------------------------------------------

Determines whether an ISMN string is valid. Similar to isbn-13, ismn is 13 digits begining 979-0-... and uses the
same check digit calculations. See http://www.ismn-international.org/download/Web_ISMN_Users_Manual_2008-6.pdf
section 2, pages 9–12.

]]

local function ismn (id)
local handler = cfg.id_handlers['ISMN'];
local text;
local valid_ismn = true;
local id_copy;

id_copy = id; -- save a copy because this testing is destructive
id=id:gsub( "[%s-–]", "" ); -- strip spaces, hyphens, and endashes from the ismn

if 13 ~= id:len() or id:match( "^9790%d*$" ) == nil then -- ismn must be 13 digits and begin 9790
valid_ismn = false;
else
valid_ismn=is_valid_isxn_13 (id); -- validate ismn
end

-- text = internal_link_id({link = handler.link, label = handler.label, -- use this (or external version) when there is some place to link to
-- prefix=handler.prefix,id=id,separator=handler.separator, encode=handler.encode})

text = table.concat (
{
make_wikilink (handler.link, handler.label),
handler.separator,
id_copy
}); -- because no place to link to yet

if false == valid_ismn then
text = text .. ' ' .. set_error( 'bad_ismn' ) -- add an error message if the ismn is invalid
end

return text;
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.

]]

local function issn(id, e)
local issn_copy = id; -- save a copy of unadulterated issn; use this version for display if issn does not validate
local handler;
local text;
local valid_issn = true;

if e then
handler = cfg.id_handlers['EISSN'];
else
handler = cfg.id_handlers['ISSN'];
end

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 = 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', e and 'e' or '' ) -- add an error message if the issn is invalid
end

return text
end

--[[--------------------------< J F M >-----------------------------------------------------------------------

A numerical identifier in the form nn.nnnn.nn

]]

local function jfm (id)
local handler = cfg.id_handlers['JFM'];
local id_num;
local err_cat = '';

id_num = id:match ('^[Jj][Ff][Mm](.*)$'); -- identifier with jfm prefix; extract identifier

if is_set (id_num) then
add_maint_cat ('jfm_format');
else -- plain number without mr prefix
id_num = id; -- if here id does not have prefix
end

if id_num and id_num:match('^%d%d%.%d%d%d%d%.%d%d$') then
id = id_num; -- jfm matches pattern
else
err_cat = ' ' .. set_error( 'bad_jfm' ); -- set an error message
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

--[[--------------------------< L C C N >----------------------------------------------------------------------

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

]]

local 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 = ' ' .. set_error( '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 = ' ' .. 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
end

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

--[[--------------------------< M R >--------------------------------------------------------------------------

A seven digit number; if not seven digits, zero-fill leading digits to make seven digits.

]]

local function mr (id)
local handler = cfg.id_handlers['MR'];
local id_num;
local id_len;
local err_cat = '';

id_num = id:match ('^[Mm][Rr](%d+)$'); -- identifier with mr prefix

if is_set (id_num) then
add_maint_cat ('mr_format');
else -- plain number without mr prefix
id_num = id:match ('^%d+$'); -- if here id is all digits
end

id_len = id_num and id_num:len() or 0;
if (7 >= id_len) and (0 ~= id_len) then
id = string.rep ('0', 7-id_len ) .. id_num; -- zero-fill leading digits
else
err_cat = ' ' .. set_error( 'bad_mr' ); -- set an error message
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

--[[--------------------------< O C L C >----------------------------------------------------------------------

Validate and format an oclc id. https://www.oclc.org/batchload/controlnumber.en.html

]]

local function oclc (id)
local handler = cfg.id_handlers['OCLC'];
local number;
local err_msg = ''; -- empty string for concatenation

if id:match('^ocm%d%d%d%d%d%d%d%d$') then -- ocm prefix and 8 digits; 001 field (12 characters)
number = id:match('ocm(%d+)'); -- get the number
elseif id:match('^ocn%d%d%d%d%d%d%d%d%d$') then -- ocn prefix and 9 digits; 001 field (12 characters)
number = id:match('ocn(%d+)'); -- get the number
elseif id:match('^on%d%d%d%d%d%d%d%d%d%d+$') then -- on prefix and 10 or more digits; 001 field (12 characters)
number = id:match('^on(%d%d%d%d%d%d%d%d%d%d+)$'); -- get the number
elseif id:match('^%(OCoLC%)[1-9]%d*$') then -- (OCoLC) prefix and variable number digits; no leading zeros; 035 field
number = id:match('%(OCoLC%)([1-9]%d*)'); -- get the number
if 9 < number:len() then
number = nil; -- contrain to 1 to 9 digits; change this when oclc issues 10-digit numbers
end
elseif id:match('^%d+$') then -- no prefix
number = id; -- get the number
if 10 < number:len() then
number = nil; -- contrain to 1 to 10 digits; change this when oclc issues 11-digit numbers
end
end

if number then -- proper format
id = number; -- exclude prefix, if any, from external link
else
err_msg = ' ' .. set_error( 'bad_oclc' ) -- add an error message if the id is malformed
end

local text = external_link_id({link=handler.link, label=handler.label,
prefix=handler.prefix, id=id, separator=handler.separator, encode=handler.encode}) .. err_msg;

return text;
end

--[[--------------------------< O P E N L I B R A R Y >--------------------------------------------------------

Formats an OpenLibrary link, and checks for associated errors.

]]

local function openlibrary(id, access)
local code;
local handler = cfg.id_handlers['OL'];
local ident;

ident, code = id:gsub('^OL', ''):match("^(%d+([AMW]))$"); -- optional OL prefix followed immediately by digits followed by 'A', 'M', or 'W'; remove OL prefix

if not is_set (ident) then -- if malformed return an error
return external_link_id({link=handler.link, label=handler.label,
prefix=handler.prefix .. 'OL',
id=id, separator=handler.separator, encode = handler.encode,
access = access}) .. ' ' .. set_error( 'bad_ol' );
end

id = ident; -- use ident without the optional OL prefix (it has been removed)

if ( code == "A" ) then
return external_link_id({link=handler.link, label=handler.label,
prefix=handler.prefix .. 'authors/OL',
id=id, separator=handler.separator, encode = handler.encode,
access = access})
end

if ( code == "M" ) then
return external_link_id({link=handler.link, label=handler.label,
prefix=handler.prefix .. 'books/OL',
id=id, separator=handler.separator, encode = handler.encode,
access = access})
end

if ( code == "W" ) then
return external_link_id({link=handler.link, label=handler.label,
prefix=handler.prefix .. 'works/OL',
id=id, separator=handler.separator, encode = handler.encode,
access = access})
end
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 date is today or 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.

PMC embargo date testing is done in function is_embargoed () which is called earlier because when the citation
has |pmc=<value> but does not have a |url= then |title= is linked with the PMC link. Function is_embargoed ()
returns the embargo date if the PMC article is still embargoed, otherwise it returns an empty string.

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)
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 id_num;
local text;

id_num = id:match ('^[Pp][Mm][Cc](%d+)$'); -- identifier with pmc prefix

if is_set (id_num) then
add_maint_cat ('pmc_format');
else -- plain number without pmc prefix
id_num = id:match ('^%d+$'); -- if here id is all digits
end

if is_set (id_num) then -- id_num has a value so test it
id_num = tonumber(id_num); -- convert id_num 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
else
id = tostring (id_num); -- make sure id is a string
end
else -- when id format incorrect
err_cat = ' ' .. set_error( 'bad_pmc' ); -- set an error message
end

if is_set (embargo) then -- is PMC is still embargoed?
text = table.concat ( -- still embargoed so no external link
{
make_wikilink (handler.link, handler.label),
handler.separator,
id,
err_cat
});
else
text = external_link_id({link = handler.link, label = handler.label, -- no embargo date or embargo has expired, ok to link to article
prefix=handler.prefix,id=id,separator=handler.separator, encode=handler.encode, access=handler.access}) .. err_cat;
end
return text;
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.

]]

local function pmid(id)
local test_limit = 32000000; -- 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 = ' ' .. 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

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

--[[--------------------------< S S R N >----------------------------------------------------------------------

Format an ssrn, do simple error checking

SSRNs are sequential numbers beginning at 100? and counting up. This code checks the ssrn to see that it is
only digits and is greater than 99 and less than test_limit; the value in local variable test_limit will need
to be updated periodically as more SSRNs are issued.

]]

local function ssrn (id)
local test_limit = 3500000; -- update this value as SSRNs approach
local handler = cfg.id_handlers['SSRN'];
local err_cat = ''; -- presume that SSRN is valid
local id_num;
local text;

id_num = id:match ('^%d+$'); -- id must be all digits

if is_set (id_num) then -- id_num has a value so test it
id_num = tonumber(id_num); -- convert id_num to a number for range testing
if 100 > id_num or test_limit < id_num then -- if SSRN is outside test limit boundaries
err_cat = ' ' .. set_error( 'bad_ssrn' ); -- set an error message
end
else -- when id format incorrect
err_cat = ' ' .. set_error( 'bad_ssrn' ); -- set an error message
end

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

return text;
end

--[[--------------------------------------------------------------------------------------

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

]]

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

local 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_usenet_id' ) -- add an error message if the message id is invalid
end

return text
end

--[[--------------------------< Z B L >-----------------------------------------------------------------------

A numerical identifier in the form nnnn.nnnnn - leading zeros in the first quartet optional

]]

local function zbl (id)
local handler = cfg.id_handlers['ZBL'];
local id_num;
local err_cat = '';

id_num = id:match ('^[Zz][Bb][Ll](.*)$'); -- identifier with zbl prefix; extract identifier

if is_set (id_num) then
add_maint_cat ('zbl_format');
else -- plain number without zbl prefix
id_num = id; -- if here id does not have prefix
end

if id_num:match('^%d?%d?%d?%d%.%d%d%d%d%d$') then
id = id_num; -- id matches pattern
else
err_cat = ' ' .. set_error( 'bad_zbl' ); -- set an error message
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

--============================<>==========================================

--[[----------------------------------------------------------------------------------

Takes a table of IDs created by extract_ids() and turns it into a table of formatted ID outputs.

inputs:
id_list – table of identifiers built by extract_ids()
options – table of various template parameter values used to modify some manually handled identifiers

]]

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

local function fallback(k) return { __index = function(t,i) return cfg.id_handlers[k][i] end } end;

for k, v in pairs( id_list ) do -- k is uc identifier name as index to cfg.id_handlers; e.g. cfg.id_handlers['ISBN'], v is a table
-- fallback to read-only cfg
handler = setmetatable( { ['id'] = v, ['access'] = options.IdAccessLevels[k] }, fallback(k) );

if handler.mode == 'external' then
table.insert( new_list, {handler.label, external_link_id( handler ) } );
elseif handler.mode == 'internal' then
table.insert( new_list, {handler.label, internal_link_id( handler ) } );
elseif handler.mode ~= 'manual' then
error( cfg.messages['unknown_ID_mode'] );
elseif k == 'ARXIV' then
table.insert( new_list, {handler.label, arxiv( v, options.Class ) } );
elseif k == 'ASIN' then
table.insert( new_list, {handler.label, asin( v, options.ASINTLD ) } );
elseif k == 'BIBCODE' then
table.insert( new_list, {handler.label, bibcode( v, handler.access ) } );
elseif k == 'BIORXIV' then
table.insert( new_list, {handler.label, biorxiv( v ) } );
elseif k == 'CITESEERX' then
table.insert( new_list, {handler.label, citeseerx( v ) } );
elseif k == 'DOI' then
table.insert( new_list, {handler.label, doi( v, options.DoiBroken, handler.access ) } );
elseif k == 'EISSN' then
table.insert( new_list, {handler.label, issn( v, true ) } ); -- true distinguishes eissn from issn
elseif k == 'HDL' then
table.insert( new_list, {handler.label, hdl( v, handler.access ) } );
elseif k == 'ISBN' then
local ISBN = internal_link_id( handler );
local check;
local err_type = '';
check, err_type = isbn( v );
if not check then
if is_set(options.IgnoreISBN) then -- ISBN is invalid; if |ignore-isbn-error= set
add_maint_cat ('ignore_isbn_err'); -- ad a maint category
else
ISBN = ISBN .. set_error( 'bad_isbn', {err_type}, false, " ", "" ); -- else display an error message
end
elseif is_set(options.IgnoreISBN) then -- ISBN is OK; if |ignore-isbn-error= set
add_maint_cat ('ignore_isbn_err'); -- because |ignore-isbn-error= unnecessary
end
table.insert( new_list, {handler.label, ISBN } );
elseif k == 'ISMN' then
table.insert( new_list, {handler.label, ismn( v ) } );
elseif k == 'ISSN' then
table.insert( new_list, {handler.label, issn( v ) } );
elseif k == 'JFM' then
table.insert( new_list, {handler.label, jfm( v ) } );
elseif k == 'LCCN' then
table.insert( new_list, {handler.label, lccn( v ) } );
elseif k == 'MR' then
table.insert( new_list, {handler.label, mr( v ) } );
elseif k == 'OCLC' then
table.insert( new_list, {handler.label, oclc( v ) } );
elseif k == 'OL' or k == 'OLA' then
table.insert( new_list, {handler.label, openlibrary( v, handler.access ) } );
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 == 'SSRN' then
table.insert( new_list, {handler.label, ssrn( v ) } );
elseif k == 'USENETID' then
table.insert( new_list, {handler.label, usenet_id( v ) } );
elseif k == 'ZBL' then
table.insert( new_list, {handler.label, zbl( v ) } );
else
error( cfg.messages['unknown_manual_ID'] );
end
end

local function comp( a, b ) -- used in following table.sort()
return a[1]:lower() < b[1]:lower();
end

table.sort( new_list, comp );
for k, v in ipairs( new_list ) do
new_list[k] = v[2];
end

return new_list;
end

--[[--------------------------< E X T R A C T _ I D S >------------------------------------------------------------

Populates ID table from arguments using configuration settings. Loops through cfg.id_handlers and searches args for
any of the parameters listed in each cfg.id_handlers['...'].parameters. If found, adds the parameter and value to
the identifier list. Emits redundant error message is more than one alias exists in args

]]

local function extract_ids( args )
local id_list = {}; -- list of identifiers found in args
for k, v in pairs( cfg.id_handlers ) do -- k is uc identifier name as index to cfg.id_handlers; e.g. cfg.id_handlers['ISBN'], v is a table
v = select_one( args, v.parameters, 'redundant_parameters' ); -- v.parameters is a table of aliases for k; here we pick one from args if present
if is_set(v) then id_list[k] = v; end -- if found in args, add identifier to our list
end
return id_list;
end

--[[--------------------------< E X T R A C T _ I D _ A C C E S S _ L E V E L S >--------------------------------------

Fetches custom id access levels from arguments using configuration settings.
Parameters which have a predefined access level (e.g. arxiv) do not use this
function as they are directly rendered as free without using an additional parameter.

]]

local function extract_id_access_levels( args, id_list )
local id_accesses_list = {};
for k, v in pairs( cfg.id_handlers ) do
local access_param = v.custom_access;
local k_lower = string.lower(k);
if is_set(access_param) then
local access_level = args[access_param];
if is_set(access_level) then
if not in_array (access_level:lower(), cfg.keywords['id-access']) then
table.insert( z.message_tail, { set_error( 'invalid_param_val', {access_param, access_level}, true ) } );
access_level = nil;
end
if not is_set(id_list[k]) then
table.insert( z.message_tail, { set_error( 'param_access_requires_param', {k_lower}, true ) } );
end
if is_set(access_level) then
access_level = access_level:lower();
end
id_accesses_list[k] = access_level;
end
end
end
return id_accesses_list;
end

--[[--------------------------< S E T _ S E L E C T E D _ M O D U L E S >--------------------------------------

Sets local cfg table and imported functions table to same (live or sandbox) as that used by the other modules.

]]

local function set_selected_modules (cfg_table_ptr, utilities_page_ptr)
cfg = cfg_table_ptr;

is_set = utilities_page_ptr.is_set; -- import functions from select Module:Citation/CS1/Utilities module
in_array = utilities_page_ptr.in_array;
set_error = utilities_page_ptr.set_error;
select_one = utilities_page_ptr.select_one;
add_maint_cat = utilities_page_ptr.add_maint_cat;
substitute = utilities_page_ptr.substitute;
make_wikilink = utilities_page_ptr.make_wikilink;

z = utilities_page_ptr.z; -- table of tables in Module:Citation/CS1/Utilities
end

return {
build_id_list = build_id_list,
extract_ids = extract_ids,
extract_id_access_levels = extract_id_access_levels,
is_embargoed = is_embargoed;
set_selected_modules = set_selected_modules;
}

Module:Citation/CS1/Date validation

2018-04-07T11:49:51Z

Max: 1 revision imported

local p = {}

--[[--------------------------< F O R W A R D D E C L A R A T I O N S >--------------------------------------
]]

local is_set, in_array; -- imported functions from selected Module:Citation/CS1/Utilities
local cfg; -- table of tables imported from slected Module:Citation/CS1/Configuration

--[=[-----------------------------------------------------------------

returns true if:
Wikipedia start date <= accessdate < today + 2 days

Wikipedia start date is 2001-01-15T00:00:00 UTC which is 979516800 seconds after 1970-01-01T00:00:00 UTC (the start of Unix time)
accessdate is the date provided in |accessdate= at time 00:00:00 UTC
today is the current date at time 00:00:00 UTC plus 48 hours
if today is 2015-01-01T00:00:00 then
adding 24 hours gives 2015-01-02T00:00:00 – one second more than today
adding 24 hours gives 2015-01-03T00:00:00 – one second more than tomorrow

This function does not work if it is fed month names for languages other than English. Wikimedia #time: parser
apparently doesn't understand non-Engish date month names. This function will always return false when the date
contains a non-English month name because good1 is false after the call to lang.formatDate(). To get around that
call this function with YYYY-MM-DD format dates.

]=]

local function is_valid_accessdate (accessdate)
local lang = mw.getContentLanguage();
local good1, good2;
local access_ts, tomorrow_ts; -- to hold unix time stamps representing the dates

good1, access_ts = pcall( lang.formatDate, lang, 'U', accessdate ); -- convert accessdate value to unix timesatmp
good2, tomorrow_ts = pcall( lang.formatDate, lang, 'U', 'today + 2 days' ); -- today midnight + 2 days is one second more than all day tomorrow

if good1 and good2 then -- lang.formatDate() returns a timestamp in the local script which which tonumber() may not understand
access_ts = tonumber (access_ts) or lang:parseFormattedNumber (access_ts); -- convert to numbers for the comparison;
tomorrow_ts = tonumber (tomorrow_ts) or lang:parseFormattedNumber (tomorrow_ts);
else
return false; -- one or both failed to convert to unix time stamp
end

if 979516800 <= access_ts and access_ts < tomorrow_ts then -- Wikipedia start date <= accessdate < tomorrow's date
return true;
else
return false; -- accessdate out of range
end
end

--[[--------------------------< G E T _ M O N T H _ N U M B E R >----------------------------------------------

returns a number according to the month in a date: 1 for January, etc. Capitalization and spelling must be correct. If not a valid month, returns 0

]]

local function get_month_number (month)
return cfg.date_names['local'].long[month] or cfg.date_names['local'].short[month] or -- look for local names first
cfg.date_names['en'].long[month] or cfg.date_names['en'].short[month] or -- failing that, look for English names
0; -- not a recognized month name
end

--[[--------------------------------------------------------------

returns true and date value if that value has proper dmy, mdy, ymd format.

returns false and 9999 (embargoed forever) when date value is not proper format; assumes that when |embargo= is
set, the editor intended to embargo a pmc but |embargo= does not hold a single date.

]]

local function is_valid_embargo_date (v)
if v:match ('^%d%d%d%d%-%d%d%-%d%d$') or -- ymd
v:match ('^%d%d?%s+%a+%s+%d%d%d%d$') or -- dmy
v:match ('^%a+%s+%d%d?%s*,%s*%d%d%d%d$') then -- mdy
return true, v;
end
return false, '9999'; -- if here not good date so return false and set embargo date to long time in future
end

--[[--------------------------< G E T _ S E A S O N _ N U M B E R >--------------------------------------------

returns a number according to the sequence of seasons in a year: 1 for Winter, etc. Capitalization and spelling must be correct. If not a valid season, returns 0

Uses ISO DIS 8601 2016 part 2 §4.7 Divisions of a year for hemishpere-independent seasons:
21-24 = Spring, Summer, Autumn, Winter, independent of “Hemisphere”

These additional divisions not currently supported:
25-28 = Spring - Northern Hemisphere, Summer- Northern Hemisphere, Autumn - Northern Hemisphere, Winter - Northern Hemisphere
29-32 = Spring – Southern Hemisphere, Summer– Southern Hemisphere, Autumn – Southern Hemisphere, Winter - Southern Hemisphere
33-36 = Quarter 1, Quarter 2, Quarter 3, Quarter 4 (3 months each)
37-39 = Quadrimester 1, Quadrimester 2, Quadrimester 3 (4 months each)
40-41 = Semestral 1, Semestral-2 (6 months each)

]]

local function get_season_number (season)
return cfg.date_names['local'].season[season] or -- look for local names first
cfg.date_names['en'].season[season] or -- failing that, look for English names
0; -- not a recognized season name
end

--[[----------------------------------------------------------------------------

returns a non-zero number if date contains a recognized proper name. Capitalization and spelling must be correct.

]]

local function is_proper_name (name)
return cfg.date_names['local'].named[name] or -- look for local names dates first
cfg.date_names['en'].named[name] or -- failing that, look for English names
0; -- not a recognized named date
end

--[[--------------------------------------------------------

--returns true if month or season is valid (properly spelled, capitalized, abbreviated)

]]

local function is_valid_month_or_season (month_season)
if 0 == get_month_number (month_season) then -- if month text isn't one of the twelve months, might be a season
if 0 == get_season_number (month_season) then -- not a month, is it a season?
return false; -- return false not a month or one of the five seasons
end
end
return true;
end

--[[------------------------------------------------------------------------------

Function gets current year from the server and compares it to year from a citation parameter. Years more than one year in the future are not acceptable.

]]
local year_limit;
local function is_valid_year(year)
if not is_set(year_limit) then
year_limit = tonumber(os.date("%Y"))+1; -- global variable so we only have to fetch it once
end
return tonumber(year) <= year_limit; -- false if year is in the future more than one year
end

--[[------------------------------------------------------------------------------
Returns true if day is less than or equal to the number of days in month and year is no farther into the future
than next year; else returns false.

Assumes Julian calendar prior to year 1582 and Gregorian calendar thereafter. Accounts for Julian calendar leap
years before 1582 and Gregorian leap years after 1582. Where the two calendars overlap (1582 to approximately
1923) dates are assumed to be Gregorian.

]]

local function is_valid_date (year, month, day)
local days_in_month = {31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31};
local month_length;
if not is_valid_year(year) then -- no farther into the future than next year
return false;
end

month = tonumber(month); -- required for YYYY-MM-DD dates

if (2==month) then -- if February
month_length = 28; -- then 28 days unless
if 1582 > tonumber(year) then -- Julian calendar
if 0==(year%4) then
month_length = 29;
end
else -- Gregorian calendar
if (0==(year%4) and (0~=(year%100) or 0==(year%400))) then -- is a leap year?
month_length = 29; -- if leap year then 29 days in February
end
end
else
month_length=days_in_month[month];
end

if tonumber (day) > month_length then
return false;
end
return true;
end

--[[----------------------------------------------------

Months in a range are expected to have the same style: Jan–Mar or October–December but not February–Mar or Jul–August.
There is a special test for May because it can be either short or long form.

Returns true when style for both months is the same

]]

local function is_valid_month_range_style (month1, month2)
local len1 = month1:len();
local len2 = month2:len();
if len1 == len2 then
return true; -- both months are short form so return true
elseif 'May' == month1 or 'May'== month2 then
return true; -- both months are long form so return true
elseif 3 == len1 or 3 == len2 then
return false; -- months are mixed form so return false
else
return true; -- both months are long form so return true
end
end

--[[--------------------------------------------------

Check a pair of months or seasons to see if both are valid members of a month or season pair.

Month pairs are expected to be left to right, earliest to latest in time.

All season ranges are accepted as valid because there are publishers out there who have published a Summer–Spring YYYY issue so ... ok

]]

local function is_valid_month_season_range(range_start, range_end)
local range_start_number = get_month_number (range_start);
local range_end_number;

if 0 == range_start_number then -- is this a month range?
range_start_number = get_season_number (range_start); -- not a month; is it a season? get start season number
range_end_number = get_season_number (range_end); -- get end season number

if (0 ~= range_start_number) and (0 ~= range_end_number) then
return true; -- any season pairing is accepted
end
return false; -- range_start and/or range_end is not a season
end
-- here when range_start is a month
range_end_number = get_month_number (range_end); -- get end month number
if range_start_number < range_end_number then -- range_start is a month; does range_start precede range_end?
if is_valid_month_range_style (range_start, range_end) then -- do months have the same style?
return true; -- proper order and same style
end
end
return false; -- range_start month number is greater than or equal to range end number; or range end isn't a month
end

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

This function receives a table of date parts for one or two dates and an empty table reference declared in
Module:Citation/CS1. The function is called only for |date= parameters and only if the |date=<value> is
determined to be a valid date format. The question of what to do with invalid date formats is not answered here.

The date parts in the input table are converted to an ISO 8601 conforming date string:
single whole dates: yyyy-mm-dd
month and year dates: yyyy-mm
year dates: yyyy
ranges: yyyy-mm-dd/yyyy-mm-dd
yyyy-mm/yyyy-mm
yyyy/yyyy

Dates in the Julian calendar are reduced to year or year/year so that we don't have to do calendar conversion from
Julian to Proleptic Gregorian.

The input table has:
year, year2 – always present; if before 1582, ignore months and days if present
month, month2 – 0 if not provided, 1-12 for months, 21-24 for seasons; 99 Christmas
day, day2 – 0 if not provided, 1-31 for days

the output table receives:
rftdate: an IS8601 formatted date
rftchron: a free-form version of the date, usually without year which is in rftdate (season ranges and propername dates)
rftssn: one of four season keywords: winter, spring, summer, fall (lowercase)

]]

local function make_COinS_date (input, tCOinS_date)
local date; -- one date or first date in a range
local date2 = ''; -- end of range date
-- start temporary Julian / Gregorian calendar uncertainty detection
local year = tonumber(input.year); -- this temporary code to determine the extent of sources dated to the Julian/Gregorian
local month = tonumber(input.month); -- interstice 1 October 1582 – 1 January 1926
local day = tonumber (input.day);
if (0 ~= day) and -- day must have a value for this to be a whole date
(((1582 == year) and (10 <= month) and (12 >= month)) or -- any whole 1582 date from 1 october to 31 December or
((1926 == year) and (1 == month) and (1 == input.day)) or -- 1 January 1926 or
((1582 < year) and (1925 >= year))) then -- any date 1 January 1583 – 31 December 1925
tCOinS_date.inter_cal_cat = true; -- set category flag true
end
-- end temporary Julian / Gergorian calendar uncertainty detection

if 1582 > tonumber(input.year) or 20 < tonumber(input.month) then -- Julian calendar or season so &rft.date gets year only
date = input.year;
if 0 ~= input.year2 and input.year ~= input.year2 then -- if a range, only the second year portion when not the same as range start year
date = string.format ('%.4d/%.4d', tonumber(input.year), tonumber(input.year2)) -- assemble the date range
end
if 20 < tonumber(input.month) then -- if season or propername date
local season = {[24]='winter', [21]='spring', [22]='summer', [23]='fall', [99]='Christmas'}; -- seasons lowercase, no autumn; proper names use title case
if 0 == input.month2 then -- single season date
if 30 <tonumber(input.month) then
tCOinS_date.rftchron = season[input.month]; -- proper name dates
else
tCOinS_date.rftssn = season[input.month]; -- seasons
end
else -- season range with a second season specified
if input.year ~= input.year2 then -- season year – season year range or season year–year
tCOinS_date.rftssn = season[input.month]; -- start of range season; keep this?
if 0~= input.month2 then
tCOinS_date.rftchron = string.format ('%s %s – %s %s', season[input.month], input.year, season[input.month2], input.year2);
end
else -- season–season year range
tCOinS_date.rftssn = season[input.month]; -- start of range season; keep this?
tCOinS_date.rftchron = season[input.month] .. '–' .. season[input.month2]; -- season–season year range
end
end
end
tCOinS_date.rftdate = date;
return; -- done
end

if 0 ~= input.day then
date = string.format ('%s-%.2d-%.2d', input.year, tonumber(input.month), tonumber(input.day)); -- whole date
elseif 0 ~= input.month then
date = string.format ('%s-%.2d', input.year, tonumber(input.month)); -- year and month
else
date = string.format ('%s', input.year); -- just year
end

if 0 ~= input.year2 then
if 0 ~= input.day2 then
date2 = string.format ('/%s-%.2d-%.2d', input.year2, tonumber(input.month2), tonumber(input.day2)); -- whole date
elseif 0 ~= input.month2 then
date2 = string.format ('/%s-%.2d', input.year2, tonumber(input.month2)); -- year and month
else
date2 = string.format ('/%s', input.year2); -- just year
end
end

tCOinS_date.rftdate = date .. date2; -- date2 has the '/' separator
return;
end

--[[--------------------------< C H E C K _ D A T E >----------------------------------------------------------

Check date format to see that it is one of the formats approved by WP:DATESNO or WP:DATERANGE. Exception: only
allowed range separator is endash. Additionally, check the date to see that it is a real date: no 31 in 30-day
months; no 29 February when not a leap year. Months, both long-form and three character abbreviations, and seasons
must be spelled correctly. Future years beyond next year are not allowed.

If the date fails the format tests, this function returns false and does not return values for anchor_year and
COinS_date. When this happens, the date parameter is used in the COinS metadata and the CITEREF identifier gets
its year from the year parameter if present otherwise CITEREF does not get a date value.

Inputs:
date_string - date string from date-holding parameters (date, year, accessdate, embargo, archivedate, etc.)

Returns:
false if date string is not a real date; else
true, anchor_year, COinS_date
anchor_year can be used in CITEREF anchors
COinS_date is ISO 8601 format date; see make_COInS_date()

]]

local function check_date (date_string, tCOinS_date, test_accessdate)
local year; -- assume that year2, months, and days are not used;
local year2=0; -- second year in a year range
local month=0;
local month2=0; -- second month in a month range
local day=0;
local day2=0; -- second day in a day range
local anchor_year;
local coins_date;

if date_string:match("^%d%d%d%d%-%d%d%-%d%d$") then -- year-initial numerical year month day format
year, month, day=string.match(date_string, "(%d%d%d%d)%-(%d%d)%-(%d%d)");
if 12 < tonumber(month) or 1 > tonumber(month) or 1582 > tonumber(year) or 0 == tonumber(day) then return false; end -- month or day number not valid or not Gregorian calendar
anchor_year = year;
elseif mw.ustring.match(date_string, "^%D- +[1-9]%d?, +[1-9]%d%d%d%a?$") then -- month-initial: month day, year
month, day, anchor_year, year=mw.ustring.match(date_string, "(%D-) +(%d%d?),%s*((%d%d%d%d?)%a?)");
month = get_month_number (month);
if 0 == month then return false; end -- return false if month text isn't one of the twelve months

elseif mw.ustring.match(date_string, "^%D- +[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
month, day, day2, anchor_year, year=mw.ustring.match(date_string, "(%D-) +(%d%d?)[%-–](%d%d?), +((%d%d%d%d)%a?)");
if tonumber(day) >= tonumber(day2) then return false; end -- date range order is left to right: earlier to later; dates may not be the same;
month = get_month_number (month);
if 0 == month then return false; end -- return false if month text isn't one of the twelve months
month2=month; -- for metadata
year2=year;

elseif mw.ustring.match(date_string, "^[1-9]%d? +%D- +[1-9]%d%d%d%a?$") then -- day-initial: day month year
day, month, anchor_year, year=mw.ustring.match(date_string, "(%d%d*)%s*(%D-) +((%d%d%d%d?)%a?)");
month = get_month_number (month);
if 0 == month then return false; end -- return false if month text isn't one of the twelve months

elseif mw.ustring.match(date_string, "^[1-9]%d?[%-–][1-9]%d? +%D- +[1-9]%d%d%d%a?$") then -- day-range-initial: day–day month year; days are separated by endash
day, day2, month, anchor_year, year=mw.ustring.match(date_string, "(%d%d?)[%-–](%d%d?) +(%D-) +((%d%d%d%d)%a?)");
if tonumber(day) >= tonumber(day2) then return false; end -- date range order is left to right: earlier to later; dates may not be the same;
month = get_month_number (month);
if 0 == month then return false; end -- return false if month text isn't one of the twelve months
month2=month; -- for metadata
year2=year;

elseif mw.ustring.match(date_string, "^[1-9]%d? +%D- +[%-–] +[1-9]%d? +%D- +[1-9]%d%d%d%a?$") then -- day initial month-day-range: day month - day month year; uses spaced endash
day, month, day2, month2, anchor_year, year=mw.ustring.match(date_string, "(%d%d?) +(%D-) +[%-–] +(%d%d?) +(%D-) +((%d%d%d%d)%a?)");
if (not is_valid_month_season_range(month, month2)) or not is_valid_year(year) then return false; end -- date range order is left to right: earlier to later;
month = get_month_number (month); -- for metadata
month2 = get_month_number (month2);
year2=year;

elseif mw.ustring.match(date_string, "^%D- +[1-9]%d? +[%-–] +%D- +[1-9]%d?, +[1-9]%d%d%d%a?$") then -- month initial month-day-range: month day – month day, year; uses spaced endash
month, day, month2, day2, anchor_year, year=mw.ustring.match(date_string, "(%D-) +(%d%d?) +[%-–] +(%D-) +(%d%d?), +((%d%d%d%d)%a?)");
if (not is_valid_month_season_range(month, month2)) or not is_valid_year(year) then return false; end
month = get_month_number (month); -- for metadata
month2 = get_month_number (month2);
year2=year;

elseif mw.ustring.match(date_string, "^[1-9]%d? +%D- +[1-9]%d%d%d +[%-–] +[1-9]%d? +%D- +[1-9]%d%d%d%a?$") then -- day initial month-day-year-range: day month year - day month year; uses spaced endash
day, month, year, day2, month2, anchor_year, year2=mw.ustring.match(date_string, "(%d%d?) +(%D-) +(%d%d%d%d) +[%-–] +(%d%d?) +(%D-) +((%d%d%d%d)%a?)");
if tonumber(year2) <= tonumber(year) then return false; end -- must be sequential years, left to right, earlier to later
if not is_valid_year(year2) or not is_valid_month_range_style(month, month2) then return false; end -- year2 no more than one year in the future; months same style
month = get_month_number (month); -- for metadata
month2 = get_month_number (month2);

elseif mw.ustring.match(date_string, "^%D- +[1-9]%d?, +[1-9]%d%d%d +[%-–] +%D- +[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
month, day, year, month2, day2, anchor_year, year2=mw.ustring.match(date_string, "(%D-) +(%d%d?), +(%d%d%d%d) +[%-–] +(%D-) +(%d%d?), +((%d%d%d%d)%a?)");
if tonumber(year2) <= tonumber(year) then return false; end -- must be sequential years, left to right, earlier to later
if not is_valid_year(year2) or not is_valid_month_range_style(month, month2) then return false; end -- year2 no more than one year in the future; months same style
month = get_month_number (month); -- for metadata
month2 = get_month_number (month2);

elseif mw.ustring.match(date_string, "^%D- +[1-9]%d%d%d[%-–]%d%d%a?$") then -- special case Winter/Summer year-year (YYYY-YY); year separated with unspaced endash
local century;
month, year, century, anchor_year, year2=mw.ustring.match(date_string, "(%D-) +((%d%d)%d%d)[%-–]((%d%d)%a?)");
if 'Winter' ~= month and 'Summer' ~= month then return false end; -- 'month' can only be Winter or Summer
anchor_year=year..'–'..anchor_year; -- assemble anchor_year from both years
year2 = century..year2; -- add the century to year2 for comparisons
if 1 ~= tonumber(year2) - tonumber(year) then return false; end -- must be sequential years, left to right, earlier to later
if not is_valid_year(year2) then return false; end -- no year farther in the future than next year
month = get_season_number (month);

elseif mw.ustring.match(date_string, "^%D- +[1-9]%d%d%d[%-–][1-9]%d%d%d%a?$") then -- special case Winter/Summer year-year; year separated with unspaced endash
month, year, anchor_year, year2=mw.ustring.match(date_string, "(%D-) +(%d%d%d%d)[%-–]((%d%d%d%d)%a?)");
if 'Winter' ~= month and 'Summer' ~= month then return false end; -- 'month' can only be Winter or Summer
anchor_year=year..'–'..anchor_year; -- assemble anchor_year from both years
if 1 ~= tonumber(year2) - tonumber(year) then return false; end -- must be sequential years, left to right, earlier to later
if not is_valid_year(year2) then return false; end -- no year farther in the future than next year
month = get_season_number (month); -- for metadata

elseif mw.ustring.match(date_string, "^%D- +[1-9]%d%d%d +[%-–] +%D- +[1-9]%d%d%d%a?$") then -- month/season year - month/season year; separated by spaced endash
month, year, month2, anchor_year, year2=mw.ustring.match(date_string, "(%D-) +(%d%d%d%d) +[%-–] +(%D-) +((%d%d%d%d)%a?)");
anchor_year=year..'–'..anchor_year; -- assemble anchor_year from both years
if tonumber(year) >= tonumber(year2) then return false; end -- left to right, earlier to later, not the same
if not is_valid_year(year2) then return false; end -- no year farther in the future than next year
if 0 ~= get_month_number(month) and 0 ~= get_month_number(month2) and is_valid_month_range_style(month, month2) then -- both must be month year, same month style
month = get_month_number(month);
month2 = get_month_number(month2);
elseif 0 ~= get_season_number(month) and 0 ~= get_season_number(month2) then -- both must be or season year, not mixed
month = get_season_number(month);
month2 = get_season_number(month2);
else
return false;
end

elseif mw.ustring.match(date_string, "^%D-[%-–]%D- +[1-9]%d%d%d%a?$") then -- month/season range year; months separated by endash
month, month2, anchor_year, year=mw.ustring.match(date_string, "(%D-)[%-–](%D-)%s*((%d%d%d%d)%a?)");
if (not is_valid_month_season_range(month, month2)) or (not is_valid_year(year)) then return false; end
if 0 ~= get_month_number(month) then -- determined to be a valid range so just check this one to know if month or season
month = get_month_number(month);
month2 = get_month_number(month2);
else
month = get_season_number(month);
month2 = get_season_number(month2);
end
year2=year;

elseif mw.ustring.match(date_string, "^%D- +%d%d%d%d%a?$") then -- month/season year or proper-name year
month, anchor_year, year=mw.ustring.match(date_string, "(%D-)%s*((%d%d%d%d)%a?)");
if not is_valid_year(year) then return false; end
if not is_valid_month_or_season (month) and 0 == is_proper_name (month) then return false; end
if 0 ~= get_month_number(month) then -- determined to be a valid range so just check this one to know if month or season
month = get_month_number(month);
elseif 0 ~= get_season_number(month) then
month = get_season_number(month);
else
month = is_proper_name (month); -- must be proper name; not supported in COinS
end

elseif mw.ustring.match(date_string, "^[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
year, anchor_year, year2=mw.ustring.match(date_string, "(%d%d%d%d?)[%-–]((%d%d%d%d?)%a?)");
anchor_year=year..'–'..anchor_year; -- assemble anchor year from both years
if tonumber(year) >= tonumber(year2) then return false; end -- left to right, earlier to later, not the same
if not is_valid_year(year2) then return false; end -- no year farther in the future than next year

elseif mw.ustring.match(date_string, "^[1-9]%d%d%d[%-–]%d%d%a?$") then -- Year range: YYYY–YY; separated by unspaced endash
local century;
year, century, anchor_year, year2=mw.ustring.match(date_string, "((%d%d)%d%d)[%-–]((%d%d)%a?)");
anchor_year=year..'–'..anchor_year; -- assemble anchor year from both years
if 13 > tonumber(year2) then return false; end -- don't allow 2003-05 which might be May 2003
year2 = century..year2; -- add the century to year2 for comparisons
if tonumber(year) >= tonumber(year2) then return false; end -- left to right, earlier to later, not the same
if not is_valid_year(year2) then return false; end -- no year farther in the future than next year

elseif date_string:match("^[1-9]%d%d%d?%a?$") then -- year; here accept either YYY or YYYY
anchor_year, year=date_string:match("((%d%d%d%d?)%a?)");
if false == is_valid_year(year) then
return false;
end

else
return false; -- date format not one of the MOS:DATE approved formats
end

if test_accessdate then -- test accessdate here because we have numerical date parts
if 0 ~= year and 0 ~= month and 0 ~= day and -- all parts of a single date required
0 == year2 and 0 == month2 and 0 == day2 then -- none of these; accessdate must not be a range
if not is_valid_accessdate (year..'-'..month..'-'..day) then
return false; -- return false when accessdate out of bounds
end
else
return false; -- return false when accessdate is a range of two dates
end
end

local result=true; -- check whole dates for validity; assume true because not all dates will go through this test
if 0 ~= year and 0 ~= month and 0 ~= day and 0 == year2 and 0 == month2 and 0 == day2 then -- YMD (simple whole date)
result=is_valid_date(year,month,day);

elseif 0 ~= year and 0 ~= month and 0 ~= day and 0 == year2 and 0 == month2 and 0 ~= day2 then -- YMD-d (day range)
result=is_valid_date(year,month,day);
result=result and is_valid_date(year,month,day2);

elseif 0 ~= year and 0 ~= month and 0 ~= day and 0 == year2 and 0 ~= month2 and 0 ~= day2 then -- YMD-md (day month range)
result=is_valid_date(year,month,day);
result=result and is_valid_date(year,month2,day2);

elseif 0 ~= year and 0 ~= month and 0 ~= day and 0 ~= year2 and 0 ~= month2 and 0 ~= day2 then -- YMD-ymd (day month year range)
result=is_valid_date(year,month,day);
result=result and is_valid_date(year2,month2,day2);
end

if false == result then return false; end

if nil ~= tCOinS_date then -- this table only passed into this function when testing |date= parameter values
make_COinS_date ({year=year, month=month, day=day, year2=year2, month2=month2, day2=day2}, tCOinS_date); -- make an ISO 8601 date string for COinS
end

return true, anchor_year; -- format is good and date string represents a real date
end

--[[--------------------------< D A T E S >--------------------------------------------------------------------

Cycle the date-holding parameters in passed table date_parameters_list through check_date() to check compliance with MOS:DATE. For all valid dates, check_date() returns
true. The |date= parameter test is unique, it is the only date holding parameter from which values for anchor_year (used in CITEREF identifiers) and COinS_date (used in
the COinS metadata) are derived. The |date= parameter is the only date-holding parameter that is allowed to contain the no-date keywords "n.d." or "nd" (without quotes).

Unlike most error messages created in this module, only one error message is created by this function. Because all of the date holding parameters are processed serially,
a single error message is created as the dates are tested.

]]

local function dates(date_parameters_list, tCOinS_date)
local anchor_year; -- will return as nil if the date being tested is not |date=
local COinS_date; -- will return as nil if the date being tested is not |date=
local embargo_date; -- if embargo date is a good dmy, mdy, ymd date then holds original value else reset to 9999
local error_message = "";
local good_date = false;

for k, v in pairs(date_parameters_list) do -- for each date-holding parameter in the list
if is_set(v) then -- if the parameter has a value
if v:match("^c%. [1-9]%d%d%d?%a?$") then -- special case for c. year or with or without CITEREF disambiguator - only |date= and |year=
v = mw.ustring.gsub (v, '%d', cfg.date_names.local_digits);
local year = v:match("c%. ([1-9]%d%d%d?)%a?"); -- get the year portion so it can be tested
if 'date'==k then
anchor_year, COinS_date = v:match("((c%. [1-9]%d%d%d?)%a?)"); -- anchor year and COinS_date only from |date= parameter
good_date = is_valid_year(year);
elseif 'year'==k then
good_date = is_valid_year(year);
end
elseif 'date'==k then -- if the parameter is |date=
if v:match("^n%.d%.%a?$") then -- if |date=n.d. with or without a CITEREF disambiguator
good_date, anchor_year, COinS_date = true, v:match("((n%.d%.)%a?)"); --"n.d."; no error when date parameter is set to no date
elseif v:match("^nd%a?$") then -- if |date=nd with or without a CITEREF disambiguator
good_date, anchor_year, COinS_date = true, v:match("((nd)%a?)"); --"nd"; no error when date parameter is set to no date
else
good_date, anchor_year, COinS_date = check_date (v, tCOinS_date); -- go test the date
end
elseif 'year'==k then -- if the parameter is |year= it should hold only a year value
if v:match("^[1-9]%d%d%d?%a?$") then -- if |year= 3 or 4 digits only with or without a CITEREF disambiguator
good_date, anchor_year, COinS_date = true, v:match("((%d+)%a?)");
end
elseif 'access-date'==k then -- if the parameter is |date=
good_date = check_date (v, nil, true); -- go test the date; nil is a placeholder; true is the test_accessdate flag
elseif 'embargo'==k then -- if the parameter is |embargo=
good_date = check_date (v); -- go test the date
if true == good_date then -- if the date is a valid date
good_date, embargo_date = is_valid_embargo_date (v); -- is |embargo= date a single dmy, mdy, or ymd formatted date? yes:returns embargo; no: returns 9999
end
else -- any other date-holding parameter
good_date = check_date (v); -- go test the date
end
if false==good_date then -- assemble one error message so we don't add the tracking category multiple times
if is_set(error_message) then -- once we've added the first portion of the error message ...
error_message=error_message .. ", "; -- ... add a comma space separator
end
error_message=error_message .. "|" .. k .. "="; -- add the failed parameter
end
end
end
return anchor_year, embargo_date, error_message; -- and done
end

--[[--------------------------< Y E A R _ D A T E _ C H E C K >------------------------------------------------

Compare the value provided in |year= with the year value(s) provided in |date=. This function returns a numeric value:
0 - year value does not match the year value in date
1 - (default) year value matches the year value in date or one of the year values when date contains two years
2 - year value matches the year value in date when date is in the form YYYY-MM-DD and year is disambiguated (|year=YYYYx)

]]

local function year_date_check (year_string, date_string)
local year;
local date1;
local date2;
local result = 1; -- result of the test; assume that the test passes

year = year_string:match ('(%d%d%d%d?)');

if date_string:match ('%d%d%d%d%-%d%d%-%d%d') and year_string:match ('%d%d%d%d%a') then --special case where both date and year are required YYYY-MM-DD and YYYYx
date1 = date_string:match ('(%d%d%d%d)');
year = year_string:match ('(%d%d%d%d)');
if year ~= date1 then
result = 0; -- years don't match
else
result = 2; -- years match; but because disambiguated, don't add to maint cat
end

elseif date_string:match ("%d%d%d%d?.-%d%d%d%d?") then -- any of the standard range formats of date with two three- or four-digit years
date1, date2 = date_string:match ("(%d%d%d%d?).-(%d%d%d%d?)");
if year ~= date1 and year ~= date2 then
result = 0;
end

elseif mw.ustring.match(date_string, "%d%d%d%d[%-–]%d%d") then -- YYYY-YY date ranges
local century;
date1, century, date2 = mw.ustring.match(date_string, "((%d%d)%d%d)[%-–]+(%d%d)");
date2 = century..date2; -- convert YY to YYYY
if year ~= date1 and year ~= date2 then
result = 0;
end

elseif date_string:match ("%d%d%d%d?") then -- any of the standard formats of date with one year
date1 = date_string:match ("(%d%d%d%d?)");
if year ~= date1 then
result = 0;
end
else
result = 0; -- no recognizable year in date
end
return result;
end

--[[-------------------------< R E F O R M A T T A B L E S >------------------------------------------------

These table are used exclusively for reformatting dates

]]

local source_patterns = { -- this table holds patterns that match allowed date formats used to extract date components
['dmy'] = '^(%d%d?)%s+(%a+)%s+(%d%d%d%d)$',
['mdy'] = '^(%a+)%s+(%d%d?),%s+(%d%d%d%d)$',
['ymd'] = '^(%d%d%d%d)%-(%d%d)-(%d%d)$',
}

local short_formats = { -- this table holds format strings used by os.date() for short month names
['dmy'] = '%e %b %Y',
['mdy'] = '%b %e, %Y',
['ymd'] = '%F',
}

local long_formats = { -- this table holds format strings used by os.date() for long month names
['dmy'] = '%e %B %Y',
['mdy'] = '%B %e, %Y',
['ymd'] = '%F',
}

--[[-------------------------< G E T _ D M Y _ D A T E _ P A R T S >------------------------------------------

extracts year, month and day from DMY formatted date, places them in the source_date table, and returns.

]]

local function get_dmy_date_parts (date, source_date)
source_date.day, source_date.month, source_date.year = date:match (source_patterns['dmy']); -- get date components as strings
source_date.month = get_month_number (source_date.month); -- get month number
end

--[[-------------------------< G E T _ M D Y _ D A T E _ P A R T S >------------------------------------------

extracts year, month and day from MDY formatted date, places them in the source_date table, and returns.

]]

local function get_mdy_date_parts (date, source_date)
source_date.month, source_date.day, source_date.year = date:match (source_patterns['mdy']); -- get date components as strings
source_date.month = get_month_number (source_date.month); -- get month number
end

--[[-------------------------< G E T _ Y M D _ D A T E _ P A R T S >------------------------------------------

extracts year, month and day from YMD formatted date, places them in the source_date table, and returns.

]]

local function get_ymd_date_parts (date, source_date)
source_date.year, source_date.month, source_date.day = date:match (source_patterns['ymd']); -- get date components as strings
end

--[[-------------------------< R E F O R M A T _ D A T E S >--------------------------------------------------

Reformats existing dates into the format specified by format and short.

format is one of several keywords: dmy, dmy-all, mdy, mdy-all, ymd, ymd-all. The all version includes access- and
archive-dates; otherwise these dates are not reformatted

Date ranges, season dates, proper name dates are not currently supported.

For i18n: This code works only at en.wiki because os.date() doesn't support any languages other than English.
mw.getContentLanguage():formatDate() will work at non-English wikis only when the date format is yyyy-mm-dd. This is
the same issue that plagues is_valid_accessdate()

It is possible that a solution like that written for ht:Module:Citation/CS1/Date_validation date_name_xlate() could be applied to this problem

]]

local function reformat_dates (date_parameters_list, format, short)
local all = false; -- set to false to skip access- and archive-dates
local format_str;
local source_date = {};

if format:match('%a+%-all') then
format = format:match('(%a+)%-all'); -- extract the format
all = true; -- set to true to format access- and archive-dates
end

for param_name, param_val in pairs (date_parameters_list) do -- for each date-holding parameter in the list
if is_set (param_val) then -- if the parameter has a value
if not all and in_array (param_name, {'access-date', 'archive-date'}) then -- if access- or archive-date and format not xxx-all
param_val = ''; -- set to empty string so we don't process this date
end
for source, pattern in pairs (source_patterns) do
if param_val:match (pattern) then
if 'ymd' == source then
get_ymd_date_parts (param_val, source_date); -- get the date parts into the source_date table
elseif 'dmy' == source then
get_dmy_date_parts (param_val, source_date); -- get the date parts into the source_date table
elseif 'mdy' == source then
get_mdy_date_parts (param_val, source_date); -- get the date parts into the source_date table
end

if 'ymd' == format and 1582 > tonumber(source_date.year) then -- ymd format dates not allowed before 1582
return false; -- abandon reformatting
end

if short then
format_str = short_formats[format];
else
format_str = long_formats[format];
end
-- convert date and save;
date_parameters_list[param_name] = mw.text.trim (os.date (format_str, os.time(source_date))); -- strip leading space when single digit day and %e is first format
end
end
end
end
return true; -- declare success and done
end

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

Loops through the list of date-holding parameters and converts any hyphen to an ndash. Not called if the cs1|2
template has any date errors.

Modifies the date_parameters_list and returns true if hyphens are replaced, else returns false.

]]

local function date_hyphen_to_dash (date_parameters_list)
local result = false;
local n;
for param_name, param_val in pairs(date_parameters_list) do -- for each date-holding parameter in the list
if not param_val:match ('%d%d%d%d%-%d%d%-%d%d') then -- for those that are not ymd dates
param_val, n = param_val:gsub ('%-', '–'); -- replace any hyphen with ndash
if 0 ~= n then
date_parameters_list[param_name] = param_val; -- update the list
result = true;
end
end
end
return result; -- so we know if any hyphens were replaced
end

--[[-------------------------< D A T E _ N A M E _ X L A T E >------------------------------------------------

Attempts to translate English month names to local-language month names using names supplied by MediaWiki's
date parser function. This is simple name-for-name replacement and may not work for all languages.

]]

local function date_name_xlate (date_parameters_list)
local xlate;
local mode; -- long or short month names
local modified = false;
local date;

for param_name, param_val in pairs(date_parameters_list) do -- for each date-holding parameter in the list
if is_set(param_val) then -- if the parameter has a value
date = param_val;
for month in mw.ustring.gmatch (date, '%a+') do -- iterate through all dates in the date (single date or date range)
if cfg.date_names.en.long[month] then
mode = 'F'; -- English name is long so use long local name
elseif cfg.date_names.en.short[month] then
mode = 'M'; -- English name is short so use short local name
else
mode = nil; -- not an English month name; could be local language month name or an English season name
end

if mode then -- might be a season
xlate = mw.getContentLanguage():formatDate(mode, '1' .. month); -- translate the month name to this local language
date = mw.ustring.gsub (date, month, xlate); -- replace the English with the translation
date_parameters_list[param_name] = date; -- save the translated date
modified = true;
end
end

end
end

return modified;
end

--[[--------------------------< S E T _ S E L E C T E D _ M O D U L E S >--------------------------------------

Sets local imported functions table to same (live or sandbox) as that used by the other modules.

]]

local function set_selected_modules (cfg_table_ptr, utilities_page_ptr)
is_set = utilities_page_ptr.is_set; -- import functions from selected Module:Citation/CS1/Utilities module
in_array = utilities_page_ptr.in_array; -- import functions from selected Module:Citation/CS1/Utilities module
cfg = cfg_table_ptr; -- import tables from selected Module:Citation/CS1/Configuration
end

return { -- return exported functions
dates = dates,
year_date_check = year_date_check,
reformat_dates = reformat_dates,
date_hyphen_to_dash = date_hyphen_to_dash,
date_name_xlate = date_name_xlate,
set_selected_modules = set_selected_modules
}

Module:Citation/CS1/Configuration

2018-04-07T11:49:51Z

Max: 1 revision imported

local citation_config = {};

-- override <code>...</code> styling to remove color, border, and padding. <code> css is specified here:
-- https://git.wikimedia.org/blob/mediawiki%2Fcore.git/69cd73811f7aadd093050dbf20ed70ef0b42a713/skins%2Fcommon%2FcommonElements.css#L199
local code_style="color:inherit; border:inherit; padding:inherit;";

--[[--------------------------------------------------------

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

Note: Namespace names should use underscores instead of spaces.

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

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

--[[--------------------------< M E S S A G E S >--------------------------------------------------------------

Translation table

The following contains fixed text that may be output as part of a citation.
This is separated from the main body to aid in future translations of this
module.

]]

local messages = {
['archived-dead'] = 'Archived from $1 on $2',
['archived-not-dead'] = '$1 from the original on $2',
['archived-missing'] = 'Archived from the original$1 on $2',
['archived'] = 'Archived',
['by'] = 'By', -- contributions to authored works: introduction, foreword, afterword
['cartography'] = 'Cartography by $1',
['editor'] = 'ed.',
['editors'] = 'eds.',
['edition'] = '($1 ed.)',
['episode'] = 'Episode $1',
['et al'] = 'et al.',
['in'] = 'In', -- edited works
['inactive'] = 'inactive',
['inset'] = '$1 inset',
['interview'] = 'Interview with $1',
['lay summary'] = 'Lay summary',
['newsgroup'] = '[[Usenet newsgroup|Newsgroup]]: $1',
['original'] = 'the original',
['published'] = ' (published $1)',
['retrieved'] = 'Retrieved $1',
['season'] = 'Season $1',
['section'] = '§ $1',
['sections'] = '§§ $1',
['series'] = 'Series $1',
['translated'] = 'Translated by $1',
['type'] = ' ($1)', -- for titletype
['written'] = 'Written at $1',

['vol'] = '$1 Vol. $2', -- $1 is sepc; bold journal style volume is in presentation{}
['vol-no'] = '$1 Vol. $2 no. $3', -- sepc, volume, issue
['issue'] = '$1 No. $2', -- $1 is sepc

['j-vol'] = '$1 $2', -- sepc, volume; bold journal volume is in presentation{}
['j-issue'] = ' ($1)',

['nopp'] = '$1 $2'; -- page(s) without prefix; $1 is sepc

['p-prefix'] = "$1 p. $2", -- $1 is sepc
['pp-prefix'] = "$1 pp. $2", -- $1 is sepc
['j-page(s)'] = ': $1', -- same for page and pages

['sheet'] = '$1 Sheet $2', -- $1 is sepc
['sheets'] = '$1 Sheets $2', -- $1 is sepc
['j-sheet'] = ': Sheet $1',
['j-sheets'] = ': Sheets $1',

['subscription'] = '(Subscription required (help))' ..
'[[Category:Pages containing links to subscription-only content]]',

['registration']='(Registration required (help))' ..
'[[Category:Pages with login required references or sources]]',

['language'] = '(in $1)',
['via'] = " – via $1",
['event'] = 'Event occurs at',
['minutes'] = 'minutes in',

['parameter-separator'] = ', ',
['parameter-final-separator'] = ', and ',
['parameter-pair-separator'] = ' and ',

-- Determines the location of the help page
['help page link'] = 'Help:CS1 errors',
['help page label'] = 'help',

-- Internal errors (should only occur if configuration is bad)
['undefined_error'] = 'Called with an undefined error condition',
['unknown_manual_ID'] = 'Unrecognized manual ID mode',
['unknown_ID_mode'] = 'Unrecognized ID mode',
['unknown_argument_map'] = 'Argument map not defined for this variable',
['bare_url_no_origin'] = 'Bare url found but origin indicator is nil or empty',
}

--[[--------------------------------------------------------------------------------

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

]]

local presentation =
{
-- Error output
-- .error class is specified at https://git.wikimedia.org/blob/mediawiki%2Fcore.git/9553bd02a5595da05c184f7521721fb1b79b3935/skins%2Fcommon%2Fshared.css#L538
-- .citation-comment class is specified at Help:CS1_errors#Controlling_error_message_display
['hidden-error'] = '$1',
['visible-error'] = '$1',

['accessdate'] = '$1$2', -- to allow editors to hide accessdate using personal css

['bdi'] = '<bdi$1>$2</bdi>', -- bidirectional isolation used with |script-title= and the like

['cite'] = '<cite class="$1">$2</cite>'; -- |ref= not set so no id="..." attribute
['cite-id'] = '<cite id="$1" class="$2">$3</cite>'; -- for use when |ref= is set

['format'] = ' ($1)', -- for |format=, |chapter-format=, etc

-- various access levels, for |access=, |doi-access=, |arxiv=, ...
-- narrow no-break space   may work better than nowrap css. Or not? browser support?

['access-signal'] = '$1 $2', -- external link with appropriate lock icon
['free'] = '[[File:Lock-green.svg|9px|link=|alt=Freely accessible|Freely accessible]]',
['registration'] = '[[File:Lock-blue-alt-2.svg|9px|link=|alt=Free registration required|Free registration required]]',
['limited'] = '[[File:Lock-blue-alt-2.svg|9px|link=|alt=Free access subject to limited trial, subscription normally required|Free access subject to limited trial, subscription normally required]]',
['subscription'] = '[[File:Lock-red-alt.svg|9px|link=|alt=Paid subscription required|Paid subscription required]]',

['italic-title'] = "''$1''",

['kern-left'] = '$1$2', -- spacing to use when title contains leading single or double quote mark
['kern-right'] = '$1$2', -- spacing to use when title contains trailing single or double quote mark

-- these for simple wikilinked titles [["text]], [[text"]] and [["text"]]
-- span wraps entire wikilink
['kern-wl-left'] = '$1', -- when title contains leading single or double quote mark
['kern-wl-right'] = '$1', -- when title contains trailing single or double quote mark
['kern-wl-both'] = '$1', -- when title contains leading and trailing single or double quote marks

['nowrap1'] = '$1', -- for nowrapping an item: yyyy-mm-dd
['nowrap2'] = '$1 $2', -- for nowrapping portions of an item: dd mmmm yyyy (note white space)

['ocins'] = ' ', -- Note: Using display: none on the COinS span breaks some clients

['parameter'] = '<code style="'..code_style..'">|$1=</code>',

['quoted-text'] = '<q>$1</q>', -- for wrapping |quote= content
['quoted-title'] = '"$1"',

['trans-italic-title'] = "[''$1'']",
['trans-quoted-title'] = "[$1]",
['vol-bold'] = '$1 $2', -- sepc, volume; for bold journal cites; for other cites ['vol'] in messages{}
}

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

Aliases table for commonly passed parameters

]]

local aliases = {
['AccessDate'] = {'access-date', 'accessdate'},
['Agency'] = 'agency',
['AirDate'] = {'air-date', 'airdate'},
['ArchiveDate'] = {'archive-date', 'archivedate'},
['ArchiveFormat'] = 'archive-format',
['ArchiveURL'] = {'archive-url', 'archiveurl'},
['ASINTLD'] = {'ASIN-TLD', 'asin-tld'},
['At'] = 'at',
['Authors'] = {'authors', 'people', 'host', 'credits'},
['BookTitle'] = {'book-title', 'booktitle'},
['Cartography'] = 'cartography',
['Chapter'] = {'chapter', 'contribution', 'entry', 'article', 'section'},
['ChapterFormat'] = {'chapter-format', 'contribution-format', 'section-format'};
['ChapterURL'] = {'chapter-url', 'chapterurl', 'contribution-url', 'contributionurl', 'section-url', 'sectionurl'},
['ChapterUrlAccess'] = 'chapter-url-access',
['Class'] = 'class', -- cite arxiv and arxiv identifiers
['Collaboration'] = 'collaboration',
['Conference'] = {'conference', 'event'},
['ConferenceFormat'] = {'conference-format', 'event-format'},
['ConferenceURL'] = {'conference-url', 'conferenceurl', 'event-url', 'eventurl'},
['Contribution'] = 'contribution', -- introduction, foreword, afterword, etc; required when |contributor= set
['Date'] = 'date',
['DeadURL'] = {'dead-url', 'deadurl'},
['Degree'] = 'degree',
['DF'] = 'df',
['DisplayAuthors'] = {'display-authors', 'displayauthors'},
['DisplayEditors'] = {'display-editors', 'displayeditors'},
['Docket'] = 'docket',
['DoiBroken'] = {'doi-broken', 'doi-broken-date', 'doi-inactive-date'},
['Edition'] = 'edition',
['Editors'] = 'editors',
['Embargo'] = 'embargo',
['Encyclopedia'] = {'encyclopedia', 'encyclopaedia'}, -- this one only used by citation
['Episode'] = 'episode', -- cite serial only TODO: make available to cite episode?
['Format'] = 'format',
['ID'] = {'id', 'ID'},
['IgnoreISBN'] = {'ignore-isbn-error', 'ignoreisbnerror'},
['Inset'] = 'inset',
['Issue'] = {'issue', 'number'},
['Interviewers'] = 'interviewers',
['Language'] = {'language', 'in'},
['LastAuthorAmp'] = {'last-author-amp', 'lastauthoramp'},
['LayDate'] = {'lay-date', 'laydate'},
['LayFormat'] = 'lay-format',
['LaySource'] = {'lay-source', 'laysource'},
['LayURL'] = {'lay-url', 'lay-summary', 'layurl', 'laysummary'},
['MailingList'] = {'mailinglist', 'mailing-list'}, -- cite mailing list only
['Map'] = 'map', -- cite map only
['MapFormat'] = 'map-format', -- cite map only
['MapURL'] = {'mapurl', 'map-url'}, -- cite map only
['MessageID'] = 'message-id',
['Minutes'] = 'minutes',
['Mode'] = 'mode',
['NameListFormat'] = 'name-list-format',
['Network'] = 'network',
['NoPP'] = {'no-pp', 'nopp'},
['NoTracking'] = {'template-doc-demo', 'no-cat', 'nocat',
'no-tracking', 'notracking'},
['Number'] = 'number', -- this case only for cite techreport
['OrigYear'] = {'orig-year', 'origyear'},
['Others'] = 'others',
['Page'] = {'p', 'page'},
['Pages'] = {'pp', 'pages'},
['Periodical'] = {'journal', 'newspaper', 'magazine', 'work',
'website', 'periodical', 'encyclopedia', 'encyclopaedia', 'dictionary', 'mailinglist'},
['Place'] = {'place', 'location'},
['PostScript'] = 'postscript',
['PublicationDate'] = {'publicationdate', 'publication-date'},
['PublicationPlace'] = {'publication-place', 'publicationplace'},
['PublisherName'] = {'publisher', 'distributor', 'institution', 'newsgroup'},
['Quote'] = {'quote', 'quotation'},
['Ref'] = 'ref',
['RegistrationRequired'] = 'registration',
['Scale'] = 'scale',
['ScriptChapter'] = 'script-chapter',
['ScriptTitle'] = 'script-title',
['Section'] = 'section',
['Season'] = 'season',
['Sections'] = 'sections', -- cite map only
['Series'] = {'series', 'version'},
['SeriesSeparator'] = 'series-separator',
['SeriesLink'] = {'series-link', 'serieslink'},
['SeriesNumber'] = {'series-number', 'series-no', 'seriesnumber', 'seriesno'},
['Sheet'] = 'sheet', -- cite map only
['Sheets'] = 'sheets', -- cite map only
['Station'] = 'station',
['SubscriptionRequired'] = 'subscription',
['Time'] = 'time',
['TimeCaption'] = {'time-caption', 'timecaption'},
['Title'] = 'title',
['TitleLink'] = {'title-link', 'episode-link', 'titlelink', 'episodelink'},
['TitleNote'] = 'department',
['TitleType'] = {'type', 'medium'},
['TransChapter'] = 'trans-chapter',
['TransMap'] = 'trans-map', -- cite map only
['Transcript'] = 'transcript',
['TranscriptFormat'] = 'transcript-format',
['TranscriptURL'] = {'transcript-url', 'transcripturl'},
['TransTitle'] = 'trans-title',
['URL'] = {'url', 'URL'},
['UrlAccess'] = {'url-access'},
['Vauthors'] = 'vauthors',
['Veditors'] = 'veditors',
['Via'] = 'via',
['Volume'] = 'volume',
['Year'] = 'year',

['AuthorList-First'] = {"first#", "given#", "author-first#", "author#-first"},
['AuthorList-Last'] = {"last#", "author#", "surname#", "author-last#", "author#-last", "subject#"},
['AuthorList-Link'] = {"authorlink#", "author-link#", "author#-link", "subjectlink#", "author#link", "subject-link#", "subject#-link", "subject#link"},
['AuthorList-Mask'] = {"author-mask#", "authormask#", "author#mask", "author#-mask"},

['ContributorList-First'] = {'contributor-first#', 'contributor#-first', 'contributor-given#', 'contributor#-given'},
['ContributorList-Last'] = {'contributor#', 'contributor-last#', 'contributor#-last', 'contributor-surname#', 'contributor#-surname'},
['ContributorList-Link'] = {'contributor-link#', 'contributor#-link'},
['ContributorList-Mask'] = {'contributor-mask#', 'contributor#-mask'},

['EditorList-First'] = {"editor-first#", "editor#-first", "editor-given#", "editor#-given"},
['EditorList-Last'] = {"editor#", "editor-last#", "editor#-last", "editor-surname#", "editor#-surname"},
['EditorList-Link'] = {"editor-link#", "editor#-link", "editorlink#", "editor#link"},
['EditorList-Mask'] = {"editor-mask#", "editor#-mask", "editormask#", "editor#mask"},

['InterviewerList-First'] = {'interviewer-first#', 'interviewer#-first'},
['InterviewerList-Last'] = {'interviewer#', 'interviewer-last#', 'interviewer#-last'},
['InterviewerList-Link'] = {'interviewer-link#', 'interviewer#-link'},
['InterviewerList-Mask'] = {'interviewer-mask#', 'interviewer#-mask'},

['TranslatorList-First'] = {'translator-first#', 'translator#-first', 'translator-given#', 'translator#-given'},
['TranslatorList-Last'] = {'translator#', 'translator-last#', 'translator#-last', 'translator-surname#', 'translator#-surname'},
['TranslatorList-Link'] = {'translator-link#', 'translator#-link'},
['TranslatorList-Mask'] = {'translator-mask#', 'translator#-mask'},
}

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

This table is primarily here to support internationalization. Translations in this table are used, for example,
when an error message, category name, etc is extracted from the English alias key. There may be other cases where
this translation table may be useful.

]]

local special_case_translation = {
['AuthorList'] = "authors list", -- these for multiple names maint categories
['ContributorList'] = "contributors list",
['EditorList'] = "editors list",
['InterviewerList'] = "interviewers list",
['TranslatorList'] = "translators list",

['authors'] = "authors", -- used in get_display_authors_editors()
['editors'] = "editors",
}

--[[--------------------------< D E F A U L T S >--------------------------------------------------------------

Default parameter values

TODO: keep this? Only one default?
]]

local defaults = {
['DeadURL'] = 'yes',
}

--[[--------------------------< D A T E _ N A M E S >----------------------------------------------------------

This table of tables lists local language date names and fallback English date names. The code in Date_validation
will look first in the local table for valid date names. If date names are not found in the local table, the code
will look in the English table.

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

In these tables, season numbering is defined by ISO DIS 8601:2016 part 2 §4.7 'Divisions of a year'. The standard
defines various divisions using numbers 21-41. cs1|2 only supports generic seasons. ISO DIS 8601:2016 does support
the distinction between north and south hemispere seasons but cs1|2 has no way to make that distinction.

The standard does not address 'named' dates so, for the purposes of cs1|2, Christmas is defined here as 99, which
should be out of the ISO DIS 8601:2016 range of uses for a while.

]]

local date_names = {
['en'] = { -- English
['long'] = {['January']=1, ['February']=2, ['March']=3, ['April']=4, ['May']=5, ['June']=6, ['July']=7, ['August']=8, ['September']=9, ['October']=10, ['November']=11, ['December']=12};
['short'] = {['Jan']=1, ['Feb']=2, ['Mar']=3, ['Apr']=4, ['May']=5, ['Jun']=6, ['Jul']=7, ['Aug']=8, ['Sep']=9, ['Oct']=10, ['Nov']=11, ['Dec']=12};
['season'] = {['Winter']=24, ['Spring']=21, ['Summer']=22, ['Fall']=23, ['Autumn']=23};
['named'] = {['Christmas']=99};
},
['local'] = { -- replace these English date names with the local language equivalents
['long'] = {['January']=1, ['February']=2, ['March']=3, ['April']=4, ['May']=5, ['June']=6, ['July']=7, ['August']=8, ['September']=9, ['October']=10, ['November']=11, ['December']=12};
['short'] = {['Jan']=1, ['Feb']=2, ['Mar']=3, ['Apr']=4, ['May']=5, ['Jun']=6, ['Jul']=7, ['Aug']=8, ['Sep']=9, ['Oct']=10, ['Nov']=11, ['Dec']=12};
['season'] = {['Winter']=24, ['Spring']=21, ['Summer']=22, ['Fall']=23, ['Autumn']=23};
['named'] = {['Christmas']=99};
},
['local_digits'] = {['0'] = '0', ['1'] = '1', ['2'] = '2', ['3'] = '3', ['4'] = '4', ['5'] = '5', ['6'] = '6', ['7'] = '7', ['8'] = '8', ['9'] = '9'}; -- used to convert local language digits to Western 0-9
}

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

These tables hold cite class values (from the template invocation) and identify those templates that support
|volume=, |issue=, and |page(s)= parameters. Cite conference and cite map require further qualification which
is handled in the main module.

]]

local templates_using_volume = {'citation', 'audio-visual', 'book', 'conference', 'encyclopaedia', 'interview', 'journal', 'magazine', 'map', 'news', 'report', 'techreport', 'thesis'}
local templates_using_issue = {'citation', 'conference', 'episode', 'interview', 'journal', 'magazine', 'map', 'news'}
local templates_not_using_page = {'audio-visual', 'episode', 'mailinglist', 'newsgroup', 'podcast', 'serial', 'sign', 'speech'}

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

This table holds keywords for those parameters that have defined sets of acceptible keywords.

]]

local keywords = {
['yes_true_y'] = {'yes', 'true', 'y'}, -- ignore-isbn-error, last-author-amp, no-tracking, nopp, registration, subscription
-- ['deadurl'] = {'yes', 'true', 'y', 'no', 'unfit', 'usurped', 'unfit no archive', 'usurped no archive'}, -- hidden 2016-04-10; see Help_talk:Citation_Style_1#Recycled_urls
['deadurl'] = {'yes', 'true', 'y', 'no', 'unfit', 'usurped', 'bot: unknown'},
['mode'] = {'cs1', 'cs2', 'mla'},
['name-list-format'] = {'vanc'},
['contribution'] = {'afterword', 'foreword', 'introduction', 'preface'}, -- generic contribution titles that are rendered unquoted in the 'chapter' position
['date-format'] = {'dmy', 'dmy-all', 'mdy', 'mdy-all', 'ymd', 'ymd-all'},
['url-access'] = {'subscription', 'limited', 'registration'}, -- access level of a URL (subscription required, limited access, free registration required), free to read by default
['id-access'] = {'free'}, -- access level of an identifier (free to read), subscription required (or no full text) by default
}

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

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

]]

local stripmarkers = {
['any'] = '\127[^\127]*UNIQ%-%-(%a+)%-[%a%d]+%-QINU[^\127]*\127', -- capture returns name of stripmarker
['math'] = '\127[^\127]*UNIQ%-%-math%-[%a%d]+%-QINU[^\127]*\127' -- math stripmarkers used in coins_cleanup() and coins_replace_math_stripmarker()
}

--[[----------------------------------------------------------------

This table holds non-printing or invisible characters indexed either by name or by Unicode group. Values are decimal
representations of UTF-8 codes. The table is organized as a table of tables because the lua pairs keyword returns
table data in an arbitrary order. Here, we want to process the table from top to bottom because the entries at
the top of the table are also found in the ranges specified by the entries at the bottom of the table.

This list contains patterns for templates like {{'}} which isn't an error but transcludes characters that are
invisible. These kinds of patterns must be recognized by the functions that use this list.

Also here is a pattern that recognizes stripmarkers that begin and end with the delete characters. The nowiki
stripmarker is not an error but some others are because the parameter values that include them become part of the
template's metadata before stripmarker replacement.

]]

local invisible_chars = {
{'replacement', '\239\191\189'}, -- U+FFFD, EF BF BD
{'zero width joiner', '\226\128\141'}, -- U+200D, E2 80 8D
{'zero width space', '\226\128\139'}, -- U+200B, E2 80 8B
{'hair space', '\226\128\138'}, -- U+200A, E2 80 8A
{'soft hyphen', '\194\173'}, -- U+00AD, C2 AD
{'horizontal tab', '\009'}, -- U+0009 (HT), 09
{'line feed', '\010'}, -- U+000A (LF), 0A
{'carriage return', '\013'}, -- U+000D (CR), 0D
{'stripmarker', stripmarkers.any}, -- stripmarker; may or may not be an error; capture returns the stripmaker type
{'delete', '\127'}, -- U+007F (DEL), 7F; must be done after stripmarker test
{'C0 control', '[\000-\008\011\012\014-\031]'}, -- U+0000–U+001F (NULL–US), 00–1F (except HT, LF, CR (09, 0A, 0D))
{'C1 control', '[\194\128-\194\159]'}, -- U+0080–U+009F (XXX–APC), C2 80 – C2 9F
-- {'Specials', '[\239\191\185-\239\191\191]'}, -- U+FFF9-U+FFFF, EF BF B9 – EF BF BF
-- {'Private use area', '[\238\128\128-\239\163\191]'}, -- U+E000–U+F8FF, EE 80 80 – EF A3 BF
-- {'Supplementary Private Use Area-A', '[\243\176\128\128-\243\191\191\189]'}, -- U+F0000–U+FFFFD, F3 B0 80 80 – F3 BF BF BD
-- {'Supplementary Private Use Area-B', '[\244\128\128\128-\244\143\191\189]'}, -- U+100000–U+10FFFD, F4 80 80 80 – F4 8F BF BD
}

-- Indic script makes use of zero width joiner as a character modifier so zwj characters must be left in. This
-- pattern covers all of the unicode characters for these languages:
-- Devanagari 0900–097F – https://unicode.org/charts/PDF/U0900.pdf
-- Devanagari extended A8E0–A8FF – https://unicode.org/charts/PDF/UA8E0.pdf
-- Bengali 0980–09FF – https://unicode.org/charts/PDF/U0980.pdf
-- Gurmukhi 0A00–0A7F – https://unicode.org/charts/PDF/U0A00.pdf
-- Gujarati 0A80–0AFF – https://unicode.org/charts/PDF/U0A80.pdf
-- Oriya 0B00–0B7F – https://unicode.org/charts/PDF/U0B00.pdf
-- Tamil 0B80–0BFF – https://unicode.org/charts/PDF/U0B80.pdf
-- Telugu 0C00–0C7F – https://unicode.org/charts/PDF/U0C00.pdf
-- Kannada 0C80–0CFF – https://unicode.org/charts/PDF/U0C80.pdf
-- Malayalam 0D00–0D7F – https://unicode.org/charts/PDF/U0D00.pdf
-- plus the not-necessarily Indic scripts for Sinhala and Burmese:
-- Sinhala 0D80-0DFF - https://unicode.org/charts/PDF/U0D80.pdf
-- Myanmar 1000-109F - https://unicode.org/charts/PDF/U1000.pdf
-- Myanmar extended A AA60-AA7F - https://unicode.org/charts/PDF/UAA60.pdf
-- Myanmar extended B A9E0-A9FF - https://unicode.org/charts/PDF/UA9E0.pdf
-- the pattern is used by has_invisible_chars() and coins_cleanup()
-- TODO: find a better place for this?

local indic_script = '[\224\164\128-\224\181\191\224\163\160-\224\183\191\225\128\128-\225\130\159\234\167\160-\234\167\191\234\169\160-\234\169\191]';

--[[--------------------------< L A N G U A G E S >------------------------------------------------------------

This table is used to hold ISO 639-1 two-character language codes that apply only to |script-title= and |script-chapter=

]]

local script_lang_codes = {
'am', 'ar', 'be', 'bg', 'bn', 'bs', 'dv', 'el', 'fa', -- ISO 639-1 codes only for |script-title= and |script-chapter=
'gu', 'he', 'hy', 'ja', 'ka', 'kn', 'ko', 'ku',
'mk', 'ml', 'mn', 'mr', 'my', 'ps', 'ru', 'sd',
'sr', 'tg', 'th', 'uk', 'ug', 'ur', 'yi', 'zh'
};

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

Here we name maintenance categories to be used in maintenance messages.

]]

local maint_cats = {
['ASIN'] = 'CS1 maint: ASIN uses ISBN',
['authors'] = 'CS1 maint: Uses authors parameter',
['bot:_unknown'] = 'CS1 maint: BOT: original-url status unknown',
['date_format'] = 'CS1 maint: Date format',
['date_year'] = 'CS1 maint: Date and year',
['disp_auth_ed'] = 'CS1 maint: display-$1', -- $1 is authors or editors; gets value from special_case_translation table
['editors'] = 'CS1 maint: Uses editors parameter',
['embargo'] = 'CS1 maint: PMC embargo expired',
['english'] = 'CS1 maint: English language specified',
['etal'] = 'CS1 maint: Explicit use of et al.',
['extra_text'] = 'CS1 maint: Extra text',
['extra_text_names'] = 'CS1 maint: Extra text: $1', -- $1 is <name>s list; gets value from special_case_translation table
['ignore_isbn_err'] = 'CS1 maint: Ignored ISBN errors',
['interviewers'] = 'CS1 maint: Uses interviewers parameter',
['missing_pipe'] = 'CS1 maint: Missing pipe',
['mult_names'] = 'CS1 maint: Multiple names: $1', -- $1 is <name>s list; gets value from special_case_translation table
['pmc_format'] = 'CS1 maint: PMC format',
['unfit'] = 'CS1 maint: Unfit url',
['unknown_lang'] = 'CS1 maint: Unrecognized language',
['untitled'] = 'CS1 maint: Untitled periodical',
}

--[[--------------------------------------------------------------

Here we name properties categories

]]

local prop_cats = {
['foreign_lang_source'] = 'CS1 $1-language sources ($2)', -- |language= categories; $1 is language name, $2 is ISO639-1 code
['foreign_lang_source_2'] = 'CS1 foreign language sources (ISO 639-2)|$1', -- |language= category; a cat for ISO639-2 languages; $1 is the ISO 639-2 code
['script'] = 'CS1 uses foreign language script', -- when language specified by |script-title=xx: doesn't have its own category
['script_with_name'] = 'CS1 uses $1-language script ($2)', -- |script-title=xx: has matching category; $1 is language name, $2 is ISO639-1 code
['jul_greg_uncertainty'] = 'CS1: Julian–Gregorian uncertainty', -- probably temporary cat to identify scope of template with dates 1 October 1582 – 1 January 1926
}

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

Here we map a template's CitationClass to TitleType (default values for |type= parameter)

]]

local title_types = {
['AV-media-notes'] = 'Media notes',
['interview'] = 'Interview',
['mailinglist'] = 'Mailing list',
['map'] = 'Map',
['podcast'] = 'Podcast',
['pressrelease'] = 'Press release',
['report'] = 'Report',
['techreport'] = 'Technical report',
['thesis'] = 'Thesis',
}

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

Error condition table

The following contains a list of IDs for various error conditions defined in the code. For each ID, we specify a
text message to display, an error category to include, and whether the error message should be wrapped as a hidden comment.

Anchor changes require identical changes to matching anchor in Help:CS1 errors

]]

local error_conditions = {
accessdate_missing_url = {
message = '<code style="'..code_style..'">|access-date=</code> requires <code style="'..code_style..'">|url=</code>',
anchor = 'accessdate_missing_url',
category = 'Pages using citations with accessdate and no URL',
hidden = true },
archive_missing_date = {
message = '<code style="'..code_style..'">|archive-url=</code> requires <code style="'..code_style..'">|archive-date=</code>',
anchor = 'archive_missing_date',
category = 'Pages with archiveurl citation errors',
hidden = false },
archive_missing_url = {
message = '<code style="'..code_style..'">|archive-url=</code> requires <code style="'..code_style..'">|url=</code>',
anchor = 'archive_missing_url',
category = 'Pages with archiveurl citation errors',
hidden = false },
archive_url = {
message = '<code style="'..code_style..'">|archive-url=</code> is malformed: $1',
anchor = 'archive_url',
category = 'Pages with archiveurl citation errors',
hidden = false },
arxiv_missing = {
message = '<code style="'..code_style..'">|arxiv=</code> required',
anchor = 'arxiv_missing',
category = 'CS1 errors: arXiv', -- same as bad arxiv
hidden = false },
arxiv_params_not_supported = {
message = 'Unsupported parameter(s) in cite arXiv',
anchor = 'arxiv_params_not_supported',
category = 'CS1 errors: arXiv', -- same as bad arxiv
hidden = false },
bad_arxiv = {
message = 'Check <code style="'..code_style..'">|arxiv=</code> value',
anchor = 'bad_arxiv',
category = 'CS1 errors: arXiv',
hidden = false },
bad_asin = {
message = 'Check <code style="'..code_style..'">|asin=</code> value',
anchor = 'bad_asin',
category ='CS1 errors: ASIN',
hidden = false },
bad_bibcode = {
message = 'Check <code style="'..code_style..'">|bibcode=</code> $1',
anchor = 'bad_bibcode',
category = 'CS1 errors: bibcode',
hidden = false },
bad_biorxiv = {
message = 'Check <code style="'..code_style..'">|biorxiv=</code> value',
anchor = 'bad_biorxiv',
category = 'CS1 errors: bioRxiv',
hidden = false },
bad_citeseerx = {
message = 'Check <code style="'..code_style..'">|citeseerx=</code> value',
anchor = 'bad_citeseerx',
category = 'CS1 errors: citeseerx',
hidden = false },
bad_date = {
message = 'Check date values in: <code style="'..code_style..'">$1</code>',
anchor = 'bad_date',
category = 'CS1 errors: dates',
hidden = false },
bad_doi = {
message = 'Check <code style="'..code_style..'">|doi=</code> value',
anchor = 'bad_doi',
category = 'CS1 errors: DOI',
hidden = false },
bad_hdl = {
message = 'Check <code style="'..code_style..'">|hdl=</code> value',
anchor = 'bad_hdl',
category = 'CS1 errors: HDL',
hidden = false },
bad_isbn = {
message = 'Check <code style="'..code_style..'">|isbn=</code> value: $1',
anchor = 'bad_isbn',
category = 'CS1 errors: ISBN',
hidden = false },
bad_ismn = {
message = 'Check <code style="'..code_style..'">|ismn=</code> value',
anchor = 'bad_ismn',
category = 'CS1 errors: ISMN',
hidden = false },
bad_issn = {
message = 'Check <code style="'..code_style..'">|$1issn=</code> value',
anchor = 'bad_issn',
category = 'CS1 errors: ISSN',
hidden = false },
bad_jfm = {
message = 'Check <code style="'..code_style..'">|jfm=</code> value',
anchor = 'bad_jfm',
category = 'CS1 errors: JFM',
hidden = false },
bad_lccn = {
message = 'Check <code style="'..code_style..'">|lccn=</code> value',
anchor = 'bad_lccn',
category = 'CS1 errors: LCCN',
hidden = false },
bad_usenet_id = {
message = 'Check <code style="'..code_style..'">|message-id=</code> value',
anchor = 'bad_message_id',
category = 'CS1 errors: message-id',
hidden = false },
bad_mr = {
message = 'Check <code style="'..code_style..'">|mr=</code> value',
anchor = 'bad_mr',
category = 'CS1 errors: MR',
hidden = false },
bad_ol = {
message = 'Check <code style="'..code_style..'">|ol=</code> value',
anchor = 'bad_ol',
category = 'CS1 errors: OL',
hidden = false },
bad_paramlink = { -- for |title-link=, |author/editor/translator-link=, |series-link=, |episode-link=
message = 'Check <code style="'..code_style..'">|$1=</code> value',
anchor = 'bad_paramlink',
category = 'CS1 errors: parameter link',
hidden = false },
bad_pmc = {
message = 'Check <code style="'..code_style..'">|pmc=</code> value',
anchor = 'bad_pmc',
category = 'CS1 errors: PMC',
hidden = false },
bad_pmid = {
message = 'Check <code style="'..code_style..'">|pmid=</code> value',
anchor = 'bad_pmid',
category = 'CS1 errors: PMID',
hidden = false },
bad_oclc = {
message = 'Check <code style="'..code_style..'">|oclc=</code> value',
anchor = 'bad_oclc',
category = 'CS1 errors: OCLC',
hidden = false },
bad_ssrn = {
message = 'Check <code style="'..code_style..'">|ssrn=</code> value',
anchor = 'bad_ssrn',
category = 'CS1 errors: SSRN',
hidden = false },
bad_url = {
message = 'Check $1 value',
anchor = 'bad_url',
category = 'Pages with URL errors',
hidden = false },
bad_zbl = {
message = 'Check <code style="'..code_style..'">|zbl=</code> value',
anchor = 'bad_zbl',
category = 'CS1 errors: ZBL',
hidden = false },
bare_url_missing_title = {
message = '$1 missing title',
anchor = 'bare_url_missing_title',
category = 'Pages with citations having bare URLs',
hidden = false },
biorxiv_missing = {
message = '<code style="'..code_style..'">|biorxiv=</code> required',
anchor = 'biorxiv_missing',
category = 'CS1 errors: bioRxiv', -- same as bad bioRxiv
hidden = false },
chapter_ignored = {
message = '<code style="'..code_style..'">|$1=</code> ignored',
anchor = 'chapter_ignored',
category = 'CS1 errors: chapter ignored',
hidden = false },
citation_missing_title = {
message = 'Missing or empty <code style="'..code_style..'">|$1=</code>',
anchor = 'citation_missing_title',
category = 'Pages with citations lacking titles',
hidden = false },
citeseerx_missing = {
message = '<code style="'..code_style..'">|citeseerx=</code> required',
anchor = 'citeseerx_missing',
category = 'CS1 errors: citeseerx', -- same as bad citeseerx
hidden = false },
cite_web_url = { -- this error applies to cite web and to cite podcast
message = 'Missing or empty <code style="'..code_style..'">|url=</code>',
anchor = 'cite_web_url',
category = 'Pages using web citations with no URL',
hidden = true },
contributor_ignored = {
message = '<code style="'..code_style..'">|contributor=</code> ignored</code>',
anchor = 'contributor_ignored',
category = 'CS1 errors: contributor',
hidden = false },
contributor_missing_required_param = {
message = '<code style="'..code_style..'">|contributor=</code> requires <code style="'..code_style..'">|$1=</code>',
anchor = 'contributor_missing_required_param',
category = 'CS1 errors: contributor',
hidden = false },
deprecated_params = {
message = 'Cite uses deprecated parameter <code style="'..code_style..'">|$1=</code>',
anchor = 'deprecated_params',
category = 'CS1 errors: deprecated parameters',
hidden = false },
empty_citation = {
message = 'Empty citation',
anchor = 'empty_citation',
category = 'Pages with empty citations',
hidden = false },
first_missing_last = {
message = '<code style="'..code_style..'">|first$2=</code> missing <code style="'..code_style..'">|last$2=</code> in $1',
anchor = 'first_missing_last',
category = 'CS1 errors: missing author or editor',
hidden = false },
format_missing_url = {
message = '<code style="'..code_style..'">|$1=</code> requires <code style="'..code_style..'">|$2=</code>',
anchor = 'format_missing_url',
category = 'Pages using citations with format and no URL',
hidden = true },
invalid_param_val = {
message = 'Invalid <code style="'..code_style..'">|$1=$2</code>',
anchor = 'invalid_param_val',
category = 'CS1 errors: invalid parameter value',
hidden = false },
invisible_char = {
message = '$1 in $2 at position $3',
anchor = 'invisible_char',
category = 'CS1 errors: invisible characters',
hidden = false },
missing_name = {
message = 'Missing <code style="'..code_style..'">|last$2=</code> in $1',
anchor = 'missing_name',
category = 'CS1 errors: missing author or editor',
hidden = false },
param_access_requires_param = {
message = '<code style="'..code_style..'">|$1-access=</code> requires <code style="'..code_style..'">|$1=</code>',
anchor = 'param_access_requires_param',
category = 'CS1 errors: param-access',
hidden = false },
param_has_ext_link = {
message = 'External link in <code style="'..code_style..'">$1</code>',
anchor = 'param_has_ext_link',
category = 'CS1 errors: external links',
hidden = false },
parameter_ignored = {
message = 'Unknown parameter <code style="'..code_style..'">|$1=</code> ignored',
anchor = 'parameter_ignored',
category = 'Pages with citations using unsupported parameters',
hidden = false },
parameter_ignored_suggest = {
message = 'Unknown parameter <code style="'..code_style..'">|$1=</code> ignored (<code style="'..code_style..'">|$2=</code> suggested)',
anchor = 'parameter_ignored_suggest',
category = 'Pages with citations using unsupported parameters',
hidden = false },
redundant_parameters = {
message = 'More than one of $1 specified',
anchor = 'redundant_parameters',
category = 'Pages with citations having redundant parameters',
hidden = false },
text_ignored = {
message = 'Text "$1" ignored',
anchor = 'text_ignored',
category = 'Pages with citations using unnamed parameters',
hidden = false },
trans_missing_title = {
message = '<code style="'..code_style..'">|trans-$1=</code> requires <code style="'..code_style..'">|$1=</code>',
anchor = 'trans_missing_title',
category = 'CS1 errors: translated title',
hidden = false },
vancouver = {
message = 'Vancouver style error: $1',
anchor = 'vancouver',
category = 'CS1 errors: Vancouver style',
hidden = false },
wikilink_in_url = {
message = 'URL–wikilink conflict', -- uses ndash
anchor = 'wikilink_in_url',
category = 'CS1 errors: URL–wikilink conflict', -- uses ndash
hidden = false },
}

--[[----------------------------------------------------------------------------------

The following contains a list of values for various defined identifiers. For each identifier we specify a
variety of information necessary to properly render the identifier in the citation.

parameters: a list of parameter aliases for this identifier
link: Wikipedia article name
label: the alternate name to apply to link
mode: 'manual' when there is a specific function in the code to handle the identifier;
'external' for identifiers that link outside of Wikipedia;
prefix: the first part of a url that will be concatenated with a second part which usually contains the identifier
encode: true if uri should be percent encoded; otherwise false
COinS: identifier link or keyword for use in COinS:
for identifiers registered at info-uri.info use: info:....
for identifiers that have COinS keywords, use the keyword: rft.isbn, rft.issn, rft.eissn
for others make a url using the value in prefix, use the keyword: pre (not checked; any text other than 'info' or 'rft' works here)
set to nil to leave the identifier out of the COinS
separator: character or text between label and the identifier in the rendered citation
access: use this parameter to set the access level for all instances of this identifier.
the value must be a valid access level for an identifier (see ['id-access'] in this file).
custom_access: to enable custom access level for an identifier, set this parameter
to the parameter that should control it (normally 'id-access')
]]

local id_handlers = {
['ARXIV'] = {
parameters = {'arxiv', 'eprint'},
link = 'arXiv',
label = 'arXiv',
mode = 'manual',
prefix = '//arxiv.org/abs/', -- protocol relative tested 2013-09-04
encode = false,
COinS = 'info:arxiv',
separator = ':',
access = 'free', -- free to read
},
['ASIN'] = {
parameters = { 'asin', 'ASIN' },
link = 'Amazon Standard Identification Number',
label = 'ASIN',
mode = 'manual',
prefix = '//www.amazon.',
COinS = nil, -- no COinS for this id (needs thinking on implementation because |asin-tld=)
separator = ' ',
encode = false;
},
['BIBCODE'] = {
parameters = {'bibcode'},
link = 'Bibcode',
label = 'Bibcode',
mode = 'manual',
prefix = 'http://adsabs.harvard.edu/abs/',
encode = false,
COinS = 'info:bibcode',
separator = ':',
custom_access = 'bibcode-access',
},
['BIORXIV'] = {
parameters = {'biorxiv'},
link = 'bioRxiv',
label = 'bioRxiv',
mode = 'manual',
prefix = '//doi.org/10.1101/',
COinS = 'pre', -- use prefix value
access = 'free', -- free to read
encode = true,
separator = ' ',
},
['CITESEERX'] = {
parameters = {'citeseerx'},
link = 'CiteSeerX',
label = 'CiteSeerX',
mode = 'manual', -- manual for custom validation of the "doi"
prefix = '//citeseerx.ist.psu.edu/viewdoc/summary?doi=',
COinS = 'pre', -- use prefix value
access = 'free', -- free to read
encode = true,
separator = ' ',
},
['DOI'] = {
parameters = { 'doi', 'DOI' },
link = 'Digital object identifier',
label = 'doi',
mode = 'manual',
prefix = '//doi.org/',
COinS = 'info:doi',
separator = ':',
encode = true,
custom_access = 'doi-access',
},
['EISSN'] = {
parameters = {'eissn', 'EISSN'},
link = 'International_Standard_Serial_Number#Electronic_ISSN',
label = 'eISSN',
mode = 'manual',
prefix = '//www.worldcat.org/issn/',
COinS = 'rft.eissn',
encode = false,
separator = ' ',
},
['HDL'] = {
parameters = { 'hdl', 'HDL' },
link = 'Handle System',
label = 'hdl',
mode = 'manual',
prefix = '//hdl.handle.net/',
COinS = 'info:hdl',
separator = ':',
encode = true,
custom_access = 'hdl-access',
},
['ISBN'] = {
parameters = {'isbn', 'ISBN', 'isbn13', 'ISBN13'},
link = 'International Standard Book Number',
label = 'ISBN',
mode = 'manual',
prefix = 'Special:BookSources/',
COinS = 'rft.isbn',
separator = ' ',
},
['ISMN'] = {
parameters = {'ismn', 'ISMN'},
link = 'International Standard Music Number',
label = 'ISMN',
mode = 'manual',
prefix = '', -- not currently used;
COinS = 'nil', -- nil because we can't use pre or rft or info:
separator = ' ',
},
['ISSN'] = {
parameters = {'issn', 'ISSN'},
link = 'International Standard Serial Number',
label = 'ISSN',
mode = 'manual',
prefix = '//www.worldcat.org/issn/',
COinS = 'rft.issn',
encode = false,
separator = ' ',
},
['JFM'] = {
parameters = {'jfm', 'JFM'},
link = 'Jahrbuch über die Fortschritte der Mathematik',
label = 'JFM',
mode = 'manual',
prefix = '//zbmath.org/?format=complete&q=an:',
COinS = 'pre', -- use prefix value
encode = true,
separator = ' ',
},
['JSTOR'] = {
parameters = {'jstor', 'JSTOR'},
link = 'JSTOR',
label = 'JSTOR',
mode = 'external',
prefix = '//www.jstor.org/stable/', -- protocol relative tested 2013-09-04
COinS = 'pre', -- use prefix value
encode = false,
separator = ' ',
custom_access = 'jstor-access',
},
['LCCN'] = {
parameters = {'LCCN', 'lccn'},
link = 'Library of Congress Control Number',
label = 'LCCN',
mode = 'manual',
prefix = '//lccn.loc.gov/', -- protocol relative tested 2015-12-28
COinS = 'info:lccn', -- use prefix value
encode = false,
separator = ' ',
},
['MR'] = {
parameters = {'MR', 'mr'},
link = 'Mathematical Reviews',
label = 'MR',
mode = 'manual',
prefix = '//www.ams.org/mathscinet-getitem?mr=', -- protocol relative tested 2013-09-04
COinS = 'pre', -- use prefix value
encode = true,
separator = ' ',
},
['OCLC'] = {
parameters = {'OCLC', 'oclc'},
link = 'OCLC',
label = 'OCLC',
mode = 'manual',
prefix = '//www.worldcat.org/oclc/',
COinS = 'info:oclcnum',
encode = true,
separator = ' ',
},
['OL'] = {
parameters = { 'ol', 'OL' },
link = 'Open Library',
label = 'OL',
mode = 'manual',
prefix = '//openlibrary.org/',
COinS = nil, -- no COinS for this id (needs thinking on implementation because /authors/books/works/OL)
separator = ' ',
encode = true,
custom_access = 'ol-access',
},
['OSTI'] = {
parameters = {'OSTI', 'osti'},
link = 'Office of Scientific and Technical Information',
label = 'OSTI',
mode = 'external',
prefix = '//www.osti.gov/energycitations/product.biblio.jsp?osti_id=', -- protocol relative tested 2013-09-04
COinS = 'pre', -- use prefix value
encode = true,
separator = ' ',
custom_access = 'osti-access',
},
['PMC'] = {
parameters = {'PMC', 'pmc'},
link = 'PubMed Central',
label = 'PMC',
mode = 'manual',
prefix = '//www.ncbi.nlm.nih.gov/pmc/articles/PMC',
suffix = " ",
COinS = 'pre', -- use prefix value
encode = true,
separator = ' ',
access = 'free', -- free to read
},
['PMID'] = {
parameters = {'PMID', 'pmid'},
link = 'PubMed Identifier',
label = 'PMID',
mode = 'manual',
prefix = '//www.ncbi.nlm.nih.gov/pubmed/',
COinS = 'info:pmid',
encode = false,
separator = ' ',
},
['RFC'] = {
parameters = {'RFC', 'rfc'},
link = 'Request for Comments',
label = 'RFC',
mode = 'external',
prefix = '//tools.ietf.org/html/rfc',
COinS = 'pre', -- use prefix value
encode = false,
separator = ' ',
access = 'free', -- free to read
},
['SSRN'] = {
parameters = {'SSRN', 'ssrn'},
link = 'Social Science Research Network',
label = 'SSRN',
mode = 'manual',
prefix = '//ssrn.com/abstract=', -- protocol relative tested 2013-09-04
COinS = 'pre', -- use prefix value
encode = true,
separator = ' ',
access = 'free', -- always free to read
},
['USENETID'] = {
parameters = {'message-id'},
link = 'Usenet',
label = 'Usenet:',
mode = 'manual',
prefix = 'news:',
encode = false,
COinS = 'pre', -- use prefix value
separator = ' ',
},
['ZBL'] = {
parameters = {'ZBL', 'zbl'},
link = 'Zentralblatt MATH',
label = 'Zbl',
mode = 'manual',
prefix = '//zbmath.org/?format=complete&q=an:',
COinS = 'pre', -- use prefix value
encode = true,
separator = ' ',
},
}

return {
aliases = aliases,
special_case_translation = special_case_translation,
defaults = defaults,
date_names = date_names,
error_conditions = error_conditions,
id_handlers = id_handlers,
keywords = keywords,
stripmarkers=stripmarkers,
invisible_chars = invisible_chars,
indic_script = indic_script,
maint_cats = maint_cats,
messages = messages,
presentation = presentation,
prop_cats = prop_cats,
script_lang_codes = script_lang_codes,
title_types = title_types,
uncategorized_namespaces = uncategorized_namespaces,
uncategorized_subpages = uncategorized_subpages,
templates_using_volume = templates_using_volume,
templates_using_issue = templates_using_issue,
templates_not_using_page = templates_not_using_page,
}

Module:Citation/CS1/COinS

2018-04-07T11:49:50Z

Max: 1 revision imported

local coins = {};

--[[--------------------------< F O R W A R D D E C L A R A T I O N S >--------------------------------------
]]
local is_set, in_array, remove_wiki_link; -- functions in Module:Citation/CS1/Utilities

local cfg; -- table of configuration tables that are defined in Module:Citation/CS1/Configuration

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

]]

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

if argument:find ( "''", 1, true ) == nil then -- Is there at least one double apostrophe? If not, exit.
return argument;
end

while true do
if argument:find ( "'''''", 1, true ) then -- bold italic (5)
argument=argument:gsub("%'%'%'%'%'", ""); -- remove all instances of it
elseif argument:find ( "''''", 1, true ) then -- italic start and end without content (4)
argument=argument:gsub("%'%'%'%'", "");
elseif argument:find ( "'''", 1, true ) then -- bold (3)
argument=argument:gsub("%'%'%'", "");
elseif argument:find ( "''", 1, true ) 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 corrupted with strings
of %27%27...

]]

local 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

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

local 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

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

]]

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
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 (– etc.) with hyphens; do we need to replace numerical entities like and the like?
return pages;
end

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

There are three options for math markup rendering that depend on the editor's math preference settings. These
settings are at [[Special:Preferences#mw-prefsection-rendering]] and are
PNG images
TeX source
MathML with SVG or PNG fallback

All three are heavy with html and css which doesn't belong in the metadata.

Without this function, the metadata saved in the raw wikitext contained the rendering determined by the settings
of the last editor to save the page.

This function gets the rendered form of an equation according to the editor's preference before the page is saved. It
then searches the rendering for the text equivalent of the rendered equation and replaces the rendering with that so
that the page is saved without extraneous html/css markup and with a reasonably readable text form of the equation.

When a replacement is made, this function returns true and the value with replacement; otherwise false and the intital
value. To replace multipe equations it is necesary to call this function from within a loop.

]=]

local function coins_replace_math_stripmarker (value)
local stripmarker = cfg.stripmarkers['math'];
local rendering = value:match (stripmarker); -- is there a math stripmarker

if not rendering then -- when value doesn't have a math stripmarker, abandon this test
return false, value;
end

rendering = mw.text.unstripNoWiki (rendering); -- convert stripmarker into rendered value (or nil? ''? when math render error)

if rendering:match ('alt="[^"]+"') then -- if PNG math option
rendering = rendering:match ('alt="([^"]+)"'); -- extract just the math text
elseif rendering:match ('$%s+.+%s+%$') then -- if TeX math option; $ is legit character that is escapes as \$
rendering = rendering:match ('$%s+(.+)%s+%$') -- extract just the math text
elseif rendering:match ('<annotation[^>]+>.+</annotation>') then -- if MathML math option
rendering = rendering:match ('<annotation[^>]+>(.+)</annotation>') -- extract just the math text
else
return false, value; -- had math stripmarker but not one of the three defined forms
end

return true, value:gsub (stripmarker, rendering, 1);
end

--[[--------------------------< C O I N S _ C L E A N U P >----------------------------------------------------

Cleanup parameter values for the metadata by removing or replacing invisible characters and certain html entities.

2015-12-10: there is a bug in mw.text.unstripNoWiki (). It replaces math stripmarkers with the appropriate content
when it shouldn't. See https://phabricator.wikimedia.org/T121085 and Wikipedia_talk:Lua#stripmarkers_and_mw.text.unstripNoWiki.28.29

TODO: move the replacement patterns and replacement values into a table in /Configuration similar to the invisible
characters table?

]]

local function coins_cleanup (value)
local replaced = true; -- default state to get the do loop running

while replaced do -- loop until all math stripmarkers replaced
replaced, value = coins_replace_math_stripmarker (value); -- replace math stripmarker with text representation of the equation
end

value = value:gsub (cfg.stripmarkers['math'], "MATH RENDER ERROR"); -- one or more couldn't be replaced; insert vague error message

value = mw.text.unstripNoWiki (value); -- replace nowiki stripmarkers with their content
value = value:gsub (''(s?)', "'%1"); -- replace {{'}} or {{'s}} with simple apostrophe or apostrophe-s
value = value:gsub (' ', ' '); -- replace   entity with plain space
value = value:gsub ('\226\128\138', ' '); -- replace hair space with plain space
if not mw.ustring.find (value, cfg.indic_script) then -- don't remove zero width joiner characters from indic script
value = value:gsub ('&zwj;', ''); -- remove &zwj; entities
value = mw.ustring.gsub (value, '[\226\128\141\226\128\139\194\173]', ''); -- remove zero-width joiner, zero-width space, soft hyphen
end
value = value:gsub ('[\009\010\013]', ' '); -- replace horizontal tab, line feed, carriage return with plain space
return value;
end

--[[--------------------------< C O I N S >--------------------------------------------------------------------

COinS metadata (see <http://ocoins.info/>) allows automated tools to parse the citation information.

]]

local function COinS(data, class)
if 'table' ~= type(data) or nil == next(data) then
return '';
end

for k, v in pairs (data) do -- spin through all of the metadata parameter values
if 'ID_list' ~= k and 'Authors' ~= k then -- except the ID_list and Author tables (author nowiki stripmarker done when Author table processed)
data[k] = coins_cleanup (v);
end
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( remove_wiki_link( value ) ) } );
end
end
});

if in_array (class, {'arxiv', 'biorxiv', 'citeseerx', 'journal', 'news'}) or (in_array (class, {'conference', 'interview', 'map', 'press release', 'web'}) and is_set(data.Periodical)) or
('citation' == class and is_set(data.Periodical) and not is_set (data.Encyclopedia)) then
OCinSoutput.rft_val_fmt = "info:ofi/fmt:kev:mtx:journal"; -- journal metadata identifier
if in_array (class, {'arxiv', 'biorxiv', 'citeseerx'}) then -- set genre according to the type of citation template we are rendering
OCinSoutput["rft.genre"] = "preprint"; -- cite arxiv, cite biorxiv, cite citeseerx
elseif 'conference' == class then
OCinSoutput["rft.genre"] = "conference"; -- cite conference (when Periodical set)
elseif 'web' == class then
OCinSoutput["rft.genre"] = "unknown"; -- cite web (when Periodical set)
else
OCinSoutput["rft.genre"] = "article"; -- journal and other 'periodical' articles
end
OCinSoutput["rft.jtitle"] = data.Periodical; -- journal only
OCinSoutput["rft.atitle"] = data.Title; -- 'periodical' article titles

-- these used only for periodicals
OCinSoutput["rft.ssn"] = data.Season; -- keywords: winter, spring, summer, fall
OCinSoutput["rft.chron"] = data.Chron; -- free-form date components
OCinSoutput["rft.volume"] = data.Volume; -- does not apply to books
OCinSoutput["rft.issue"] = data.Issue;
OCinSoutput["rft.pages"] = data.Pages; -- also used in book metadata

elseif 'thesis' ~= class then -- all others except cite thesis are treated as 'book' metadata; genre distinguishes
OCinSoutput.rft_val_fmt = "info:ofi/fmt:kev:mtx:book"; -- book metadata identifier
if 'report' == class or 'techreport' == class then -- cite report and cite techreport
OCinSoutput["rft.genre"] = "report";
elseif 'conference' == class then -- cite conference when Periodical not set
OCinSoutput["rft.genre"] = "conference";
OCinSoutput["rft.atitle"] = data.Chapter; -- conference paper as chapter in proceedings (book)
elseif in_array (class, {'book', 'citation', 'encyclopaedia', 'interview', 'map'}) then
if is_set (data.Chapter) then
OCinSoutput["rft.genre"] = "bookitem";
OCinSoutput["rft.atitle"] = data.Chapter; -- book chapter, encyclopedia article, interview in a book, or map title
else
if 'map' == class or 'interview' == class then
OCinSoutput["rft.genre"] = 'unknown'; -- standalone map or interview
else
OCinSoutput["rft.genre"] = 'book'; -- book and encyclopedia
end
end
else --{'audio-visual', 'AV-media-notes', 'DVD-notes', 'episode', 'interview', 'mailinglist', 'map', 'newsgroup', 'podcast', 'press release', 'serial', 'sign', 'speech', 'web'}
OCinSoutput["rft.genre"] = "unknown";
end
OCinSoutput["rft.btitle"] = data.Title; -- book only
OCinSoutput["rft.place"] = data.PublicationPlace; -- book only
OCinSoutput["rft.series"] = data.Series; -- book only
OCinSoutput["rft.pages"] = data.Pages; -- book, journal
OCinSoutput["rft.edition"] = data.Edition; -- book only
OCinSoutput["rft.pub"] = data.PublisherName; -- book and dissertation

else -- cite thesis
OCinSoutput.rft_val_fmt = "info:ofi/fmt:kev:mtx:dissertation"; -- dissertation metadata identifier
OCinSoutput["rft.title"] = data.Title; -- dissertation (also patent but that is not yet supported)
OCinSoutput["rft.degree"] = data.Degree; -- dissertation only
OCinSoutput['rft.inst'] = data.PublisherName; -- book and dissertation
end
-- and now common parameters (as much as possible)
OCinSoutput["rft.date"] = data.Date; -- book, journal, dissertation

for k, v in pairs( data.ID_list ) do -- what to do about these? For now assume that they are common to all?
-- if k == 'ISBN' then v = clean_isbn( v ) end
if k == 'ISBN' then v = v:gsub( "[^-0-9X]", "" ); end
local id = cfg.id_handlers[k].COinS;
if string.sub( id or "", 1, 4 ) == 'info' then -- for ids that are in the info:registry
OCinSoutput["rft_id"] = table.concat{ id, "/", v };
elseif string.sub (id or "", 1, 3 ) == 'rft' then -- for isbn, issn, eissn, etc that have defined COinS keywords
OCinSoutput[ id ] = v;
elseif id then -- when cfg.id_handlers[k].COinS is not nil
OCinSoutput["rft_id"] = table.concat{ cfg.id_handlers[k].prefix, v }; -- others; provide a url
end
end

--[[
for k, v in pairs( data.ID_list ) do -- what to do about these? For now assume that they are common to all?
local id, value = cfg.id_handlers[k].COinS;
if k == 'ISBN' then value = clean_isbn( 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 = coins_cleanup (v.last), coins_cleanup (v.first or ''); -- replace any nowiki strip markers, non-printing or invisible characers
if k == 1 then -- for the first author name only
if is_set(last) and is_set(first) then -- set these COinS values if |first= and |last= specify the first author name
OCinSoutput["rft.aulast"] = last; -- book, journal, dissertation
OCinSoutput["rft.aufirst"] = first; -- book, journal, dissertation
elseif is_set(last) then
OCinSoutput["rft.au"] = last; -- book, journal, dissertation -- otherwise use this form for the first name
end
else -- for all other authors
if is_set(last) and is_set(first) then
OCinSoutput["rft.au"] = table.concat{ last, ", ", first }; -- book, journal, dissertation
elseif is_set(last) then
OCinSoutput["rft.au"] = last; -- book, journal, dissertation
end
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

--[[--------------------------< S E T _ S E L E C T E D _ M O D U L E S >--------------------------------------

Sets local cfg table and imported functions table to same (live or sandbox) as that used by the other modules.

]]

local function set_selected_modules (cfg_table_ptr, utilities_page_ptr)
cfg = cfg_table_ptr;

is_set = utilities_page_ptr.is_set; -- import functions from select Module:Citation/CS1/Utilities module
in_array = utilities_page_ptr.in_array;
remove_wiki_link = utilities_page_ptr.remove_wiki_link;
end

return {
make_coins_title = make_coins_title,
get_coins_pages = get_coins_pages,
COinS = COinS,
set_selected_modules = set_selected_modules,
}

Module:Citation/CS1

2018-04-07T11:49:50Z

Max: 1 revision imported

local cs1 ={};

--[[--------------------------< F O R W A R D D E C L A R A T I O N S >--------------------------------------
]]

local dates, year_date_check, reformat_dates, date_hyphen_to_dash, -- functions in Module:Citation/CS1/Date_validation
date_name_xlate

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

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

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

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

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

--[[----------------------------------------------------------------

delare variables here that have page-wide scope that are not brought in from other modules; thatare created here
and used here

]]

local added_deprecated_cat; -- boolean flag so that the category is added only once
local added_prop_cats = {}; -- list of property categories that have been added to z.properties_cats
local added_vanc_errs; -- boolean flag so we only emit one Vancouver error / category

local Frame; -- holds the module's frame table

--[[--------------------------< F I R S T _ S E T >------------------------------------------------------------

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

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

]]

local function first_set (list, count)
local i = 1;
while i <= count do -- loop through all items in list
if is_set( list[i] ) then
return list[i]; -- return the first set list member
end
i = i + 1; -- point to next
end
end

--[[--------------------------< A D D _ P R O P _ C A T >--------------------------------------------------------

Adds a category to z.properties_cats using names from the configuration file with additional text if any.

foreign_lang_source and foreign_lang_source_2 keys have a language code appended to them so that multiple languages
may be categorized but multiples of the same language are not categorized.

added_prop_cats is a table declared in page scope variables above

]]

local function add_prop_cat (key, arguments)
if not added_prop_cats [key] then
added_prop_cats [key] = true; -- note that we've added this category
key = key:gsub ('(foreign_lang_source_?2?)%a%a%a?', '%1'); -- strip lang code from keyname
table.insert( z.properties_cats, substitute (cfg.prop_cats [key], arguments)); -- make name then add to table
end
end

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

Adds a single Vancouver system error message to the template's output regardless of how many error actually exist.
To prevent duplication, added_vanc_errs is nil until an error message is emitted.

added_vanc_errs is a boolean declared in page scope variables above

]]

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

--[[--------------------------------------------------------------------------------------

does this thing that purports to be a uri scheme seem to be a valid scheme? The scheme is checked to see if it
is in agreement with http://tools.ietf.org/html/std66#section-3.1 which says:
Scheme names consist of a sequence of characters beginning with a
letter and followed by any combination of letters, digits, plus
("+"), period ("."), or hyphen ("-").

returns true if it does, else false

]]

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

--[=[---------------------------------------------------------------------------

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

Syntax defined here: http://tools.ietf.org/html/rfc1034#section-3.5
BNF defined here: https://tools.ietf.org/html/rfc4234
Single character names are generally reserved; see https://tools.ietf.org/html/draft-ietf-dnsind-iana-dns-01#page-15;
see also [[Single-letter second-level domain]]
list of tlds: https://www.iana.org/domains/root/db

rfc952 (modified by rfc 1123) requires the first and last character of a hostname to be a letter or a digit. Between
the first and last characters the name may use letters, digits, and the hyphen.

Also allowed are IPv4 addresses. IPv6 not supported

domain is expected to be stripped of any path so that the last character in the last character of the tld. tld
is two or more alpha characters. Any preceding '//' (from splitting a url with a scheme) will be stripped
here. Perhaps not necessary but retained incase it is necessary for IPv4 dot decimal.

There are several tests:
the first character of the whole domain name including subdomains must be a letter or a digit
internationalized domain name (ascii characters with .xn-- ASCII Compatible Encoding (ACE) prefix xn-- in the tld) see https://tools.ietf.org/html/rfc3490
single-letter/digit second-level domains in the .org and .cash TLDs
q, x, and z SL domains in the .com TLD
i and q SL domains in the .net TLD
single-letter SL domains in the ccTLDs (where the ccTLD is two letters)
two-character SL domains in gTLDs (where the gTLD is two or more letters)
three-plus-character SL domains in gTLDs (where the gTLD is two or more letters)
IPv4 dot-decimal address format; TLD not allowed

returns true if domain appears to be a proper name and tld or IPv4 address, else false

]=]

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

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

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

--[[--------------------------------------------------------------------------------------------

returns true if the scheme and domain parts of a url appear to be a valid url; else false.

This function is the last step in the validation process. This function is separate because there are cases that
are not covered by split_url(), for example is_parameter_ext_wikilink() which is looking for bracketted external
wikilinks.

]]

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

--[[--------------------------< S P L I T _ U R L >------------------------------------------------------------

Split a url into a scheme, authority indicator, and domain.

First remove Fully Qualified Domain Name terminator (a dot following tld) (if any) and any path(/), query(?) or fragment(#).

If protocol relative url, return nil scheme and domain else return nil for both scheme and domain.

When not protocol relative, get scheme, authority indicator, and domain. If there is an authority indicator (one
or more '/' characters immediately following the scheme's colon), make sure that there are only 2.

Strip off any port and path;

]]

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

url_str = url_str:gsub ('([%a%d])%.?[/%?#].*$', '%1'); -- strip FQDN terminator and path(/), query(?), fragment (#) (the capture prevents false replacement of '//')

if url_str:match ('^//%S*') then -- if there is what appears to be a protocol relative url
domain = url_str:match ('^//(%S*)')
elseif url_str:match ('%S-:/*%S+') then -- if there is what appears to be a scheme, optional authority indicator, and domain name
scheme, authority, domain = url_str:match ('(%S-:)(/*)(%S+)'); -- extract the scheme, authority indicator, and domain portions
authority = authority:gsub ('//', '', 1); -- replace place 1 pair of '/' with nothing;
if is_set(authority) then -- if anything left (1 or 3+ '/' where authority should be) then
return scheme; -- return scheme only making domain nil which will cause an error message
end
domain = domain:gsub ('(%a):%d+', '%1'); -- strip port number if present
end

return scheme, domain;
end

--[[--------------------------< L I N K _ P A R A M _ O K >---------------------------------------------------

checks the content of |title-link=, |series-link=, |author-link= etc for properly formatted content: no wikilinks, no urls

Link parameters are to hold the title of a wikipedia article so none of the WP:TITLESPECIALCHARACTERS are allowed:
# < > [ ] | { } _
except the underscore which is used as a space in wiki urls and # which is used for section links

returns false when the value contains any of these characters.

When there are no illegal characters, this function returns TRUE if value DOES NOT appear to be a valid url (the
|<param>-link= parameter is ok); else false when value appears to be a valid url (the |<param>-link= parameter is NOT ok).

]]

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

scheme, domain = split_url (value); -- get scheme or nil and domain or nil from url;
return not is_url (scheme, domain); -- return true if value DOES NOT appear to be a valid url
end

--[[--------------------------< L I N K _ T I T L E _ O K >---------------------------------------------------

Use link_param_ok() to validate |<param>-link= value and its matching |<title>= value.

|<title>= may be wikilinked but not when |<param>-link= has a value. This function emits an error message when
that condition exists

]]

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

if is_set (link) then -- don't bother if <param>-link doesn't have a value
if not link_param_ok (link) then -- check |<param>-link= markup
orig = lorig; -- identify the failing link parameter
elseif title:find ('%[%[') then -- check |title= for wikilink markup
orig = torig; -- identify the failing |title= parameter
end
end

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

--[[--------------------------< C H E C K _ U R L >------------------------------------------------------------

Determines whether a URL string appears to be valid.

First we test for space characters. If any are found, return false. Then split the url into scheme and domain
portions, or for protocol relative (//example.com) urls, just the domain. Use is_url() to validate the two
portions of the url. If both are valid, or for protocol relative if domain is valid, return true, else false.

Because it is different from a standard url, and because this module used external_link() to make external links
that work for standard and news: links, we validate newsgroup names here. The specification for a newsgroup name
is at https://tools.ietf.org/html/rfc5536#section-3.1.4

]]

local function check_url( url_str )
if nil == url_str:match ("^%S+$") then -- if there are any spaces in |url=value it can't be a proper url
return false;
end
local scheme, domain;

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

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

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

--[=[-----------------------------------------------------

Return true if a parameter value has a string that begins and ends with square brackets [ and ] and the first
non-space characters following the opening bracket appear to be a url. The test will also find external wikilinks
that use protocol relative urls. Also finds bare urls.

The frontier pattern prevents a match on interwiki links which are similar to scheme:path urls. The tests that
find bracketed urls are required because the parameters that call this test (currently |title=, |chapter=, |work=,
and |publisher=) may have wikilinks and there are articles or redirects like '//Hus' so, while uncommon, |title=[[//Hus]]
is possible as might be [[en://Hus]].

]=]

local function is_parameter_ext_wikilink (value)
local scheme, domain;

if value:match ('%f[%[]%[%a%S*:%S+.*%]') then -- if ext wikilink with scheme and domain: [xxxx://yyyyy.zzz]
scheme, domain = split_url (value:match ('%f[%[]%[(%a%S*:%S+).*%]'));
elseif value:match ('%f[%[]%[//%S+.*%]') then -- if protocol relative ext wikilink: [//yyyyy.zzz]
scheme, domain = split_url (value:match ('%f[%[]%[(//%S+).*%]'));
elseif value:match ('%a%S*:%S+') then -- if bare url with scheme; may have leading or trailing plain text
scheme, domain = split_url (value:match ('(%a%S*:%S+)'));
elseif value:match ('//%S+') then -- if protocol relative bare url: //yyyyy.zzz; may have leading or trailing plain text
scheme, domain = split_url (value:match ('(//%S+)')); -- what is left should be the domain
else
return false; -- didn't find anything that is obviously a url
end

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

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

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

]]

local function check_for_url (parameter_list)
local error_message = '';
for k, v in pairs (parameter_list) do -- for each parameter in the list
if is_parameter_ext_wikilink (v) then -- look at the value; if there is a url add an error message
if is_set(error_message) then -- once we've added the first portion of the error message ...
error_message=error_message .. ", "; -- ... add a comma space separator
end
error_message=error_message .. "|" .. k .. "="; -- add the failed parameter
end
end
if is_set (error_message) then -- done looping, if there is an error message, display it
table.insert( z.message_tail, { set_error( 'param_has_ext_link', {error_message}, true ) } );
end
end

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

Escape sequences for content that will be used for URL descriptions

]]

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

return str:gsub( '[%[%]\n]', {
['['] = '[',
[']'] = ']',
['\n'] = ' ' } );
end

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

Format an external link with error checking

]]

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

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

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

if is_set (access) then -- access level (subscription, registration, limited)
label = safe_for_url (label); -- replace square brackets and newlines

base_url = table.concat ( -- assemble external link with access signal
{
'[', -- opening css and url markup
URL, -- the url
' ', -- the required space
label,
'', -- signal spacing css
cfg.presentation[access], -- the appropriate icon
'', -- close signal spacing span
']' -- close url markup and plain links span
});
else
base_url = table.concat({ "[", URL, " ", safe_for_url( label ), "]" }); -- no signal markup
end

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

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

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

added_deprecated_cat is a boolean declared in page scope variables above

]]

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

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

Apply kerning to open the space between the quote mark provided by the Module and a leading or trailing quote
mark contained in a |title= or |chapter= parameter's value.

This function will positive kern either single or double quotes:
"'Unkerned title with leading and trailing single quote marks'"
" 'Kerned title with leading and trailing single quote marks' " (in real life the kerning isn't as wide as this example)
Double single quotes (italic or bold wikimarkup) are not kerned.

Replaces unicode quotemarks in plain text or in the label portion of a [[L|D]] style wikilink with typewriter
quote marks regardless of the need for kerning. Unicode quote marks are not replaced in simple [[D]] wikilinks.

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

]=]

local function kern_quotes (str)
local cap='';
local cap2='';
local wl_type, label, link;

wl_type, label, link = is_wikilink (str); -- wl_type is: 0, no wl (text in label variable); 1, [[D]]; 2, [[L|D]]

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

else -- plain text or [[L|D]]; text in label variable
label= mw.ustring.gsub (label, '[“”]', '\"'); -- replace “” (U+201C & U+201D) with " (typewriter double quote mark)
label= mw.ustring.gsub (label, '[‘’]', '\''); -- replace ‘’ (U+2018 & U+2019) with ' (typewriter single quote mark)

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

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

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

--[[--------------------------< F O R M A T _ S C R I P T _ V A L U E >----------------------------------------

|script-title= holds title parameters that are not written in Latin based scripts: Chinese, Japanese, Arabic, Hebrew, etc. These scripts should
not be italicized and may be written right-to-left. The value supplied by |script-title= is concatenated onto Title after Title has been wrapped
in italic markup.

Regardless of language, all values provided by |script-title= are wrapped in <bdi>...</bdi> tags to isolate rtl languages from the English left to right.

|script-title= provides a unique feature. The value in |script-title= may be prefixed with a two-character ISO639-1 language code and a colon:
|script-title=ja:*** *** (where * represents a Japanese character)
Spaces between the two-character code and the colon and the colon and the first script character are allowed:
|script-title=ja : *** ***
|script-title=ja: *** ***
|script-title=ja :*** ***
Spaces preceding the prefix are allowed: |script-title = ja:*** ***

The prefix is checked for validity. If it is a valid ISO639-1 language code, the lang attribute (lang="ja") is added to the <bdi> tag so that browsers can
know the language the tag contains. This may help the browser render the script more correctly. If the prefix is invalid, the lang attribute
is not added. At this time there is no error message for this condition.

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

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

local function format_script_value (script_value)
local lang=''; -- initialize to empty string
local name;
if script_value:match('^%l%l%s*:') then -- if first 3 non-space characters are script language prefix
lang = script_value:match('^(%l%l)%s*:%s*%S.*'); -- get the language prefix or nil if there is no script
if not is_set (lang) then
return ''; -- script_value was just the prefix so return empty string
end
-- if we get this far we have prefix and script
name = mw.language.fetchLanguageName( lang, "en" ); -- get language name so that we can use it to categorize
if is_set (name) then -- is prefix a proper ISO 639-1 language code?
script_value = script_value:gsub ('^%l%l%s*:%s*', ''); -- strip prefix from script
-- is prefix one of these language codes?
if in_array (lang, cfg.script_lang_codes) then
add_prop_cat ('script_with_name', {name, lang})
else
add_prop_cat ('script')
end
lang = ' lang="' .. lang .. '" '; -- convert prefix into a lang attribute
else
lang = ''; -- invalid so set lang to empty string
end
end
script_value = substitute (cfg.presentation['bdi'], {lang, script_value}); -- isolate in case script is rtl

return script_value;
end

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

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

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

--[[--------------------------< W R A P _ M S G >--------------------------------------------------------------

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

]]

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

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

Format the four chapter parameters: |script-chapter=, |chapter=, |trans-chapter=, and |chapter-url= into a single Chapter meta-
parameter (chapter_url_source used for error messages).

]]

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

if not is_set (chapter) then
chapter = ''; -- to be safe for concatenation
else
if false == no_quotes then
chapter = kern_quotes (chapter); -- if necessary, separate chapter title's leading and trailing quote marks from Module provided quote marks
chapter = wrap_style ('quoted-title', chapter);
end
end

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

if is_set (transchapter) then
transchapter = wrap_style ('trans-quoted-title', transchapter);
if is_set (chapter) then
chapter = chapter .. ' ' .. transchapter;
else -- here when transchapter without chapter or script-chapter
chapter = transchapter; --
chapter_error = ' ' .. set_error ('trans_missing_title', {'chapter'});
end
end

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

return chapter .. chapter_error;
end

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

This function searches a parameter's value for nonprintable or invisible characters. The search stops at the
first match.

This function will detect the visible replacement character when it is part of the wikisource.

Detects but ignores nowiki and math stripmarkers. Also detects other named stripmarkers (gallery, math, pre, ref)
and identifies them with a slightly different error message. See also coins_cleanup().

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

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

]]

local function has_invisible_chars (param, v)
local position = ''; -- position of invisible char or starting position of stripmarker
local dummy; -- end of matching string; not used but required to hold end position when a capture is returned
local capture; -- used by stripmarker detection to hold name of the stripmarker
local i=1;
local stripmarker, apostrophe;

capture = string.match (v, '[%w%p ]*'); -- Test for values that are simple ASCII text and bypass other tests if true
if capture == v then -- if same there are no unicode characters
return;
end

while cfg.invisible_chars[i] do
local char=cfg.invisible_chars[i][1] -- the character or group name
local pattern=cfg.invisible_chars[i][2] -- the pattern used to find it
position, dummy, capture = mw.ustring.find (v, pattern) -- see if the parameter value contains characters that match the pattern

if position and (char == 'zero width joiner') then -- if we found a zero width joiner character
if mw.ustring.find (v, cfg.indic_script) then -- its ok if one of the indic scripts
position = nil; -- unset position
end
end

if position then
if 'nowiki' == capture or 'math' == capture then -- nowiki, math stripmarker (not an error condition)
stripmarker = true; -- set a flag
elseif true == stripmarker and 'delete' == char then -- because stripmakers begin and end with the delete char, assume that we've found one end of a stripmarker
position = nil; -- unset
else
local err_msg;
if capture then
err_msg = capture .. ' ' .. char;
else
err_msg = char .. ' ' .. 'character';
end

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

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

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

]]

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

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

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

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

-- Empty strings, not nil;
if v == nil then
v = cfg.defaults[k] or '';
origin[k] = '';
end

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

--[[--------------------------< V A L I D A T E >--------------------------------------------------------------

Looks for a parameter's name in one of several whitelists.

Parameters in the whitelist can have three values:
true - active, supported parameters
false - deprecated, supported parameters
nil - unsupported parameters

]]

local function validate( name, cite_class )
local name = tostring( name );
local state;

if in_array (cite_class, {'arxiv', 'biorxiv', 'citeseerx'}) then -- limited parameter sets allowed for these templates
state = whitelist.limited_basic_arguments[ name ];
if true == state then return true; end -- valid actively supported parameter
if false == state then
deprecated_parameter (name); -- parameter is deprecated but still supported
return true;
end

if 'arxiv' == cite_class then -- basic parameters unique to these templates
state = whitelist.arxiv_basic_arguments[name];
end
if 'biorxiv' == cite_class then
state = whitelist.biorxiv_basic_arguments[name];
end
if 'citeseerx' == cite_class then
state = whitelist.citeseerx_basic_arguments[name];
end

if true == state then return true; end -- valid actively supported parameter
if false == state then
deprecated_parameter (name); -- parameter is deprecated but still supported
return true;
end
-- limited enumerated parameters list
name = name:gsub( "%d+", "#" ); -- replace digit(s) with # (last25 becomes last#)
state = whitelist.limited_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 -- end limited parameter-set templates

state = whitelist.basic_arguments[ name ]; -- all other templates; all normal parameters allowed

if true == state then return true; end -- valid actively supported parameter
if false == state then
deprecated_parameter (name); -- parameter is deprecated but still supported
return true;
end
-- all enumerated parameters allowed
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

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

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

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

]]

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

if date:match("^%d%d%d%d%-%d%d%-%d%d$") then
date = substitute (cfg.presentation['nowrap1'], date);

elseif date:match("^%a+%s*%d%d?,%s+%d%d%d%d$") or date:match ("^%d%d?%s*%a+%s+%d%d%d%d$") then
cap, cap2 = string.match (date, "^(.*)%s+(%d%d%d%d)$");
date = substitute (cfg.presentation['nowrap2'], {cap, cap2});
end

return date;
end

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

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

]]

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

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

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

Converts a hyphen to a dash

]]

local function hyphen_to_dash( str )
if not is_set(str) or str:match( "[%[%]{}<>]" ) ~= nil then
return str;
end
return str:gsub( '-', '–' );
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
long as the duplicate_char is strict ASCII. The strings
in tbl may be ASCII or UTF8.
]]

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

if str == '' then -- if output string is empty
str = value; -- assign value to it (first time through the loop)
elseif value ~= '' then
if value:sub(1,1) == '<' then -- Special case of values enclosed in spans and other markup.
comp = value:gsub( "%b<>", "" ); -- remove html markup (string -> 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(-3,-1) == duplicate_char .. '"]' then -- if last three chars of str are sepc"] quoted external link
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
str = str .. value; --add it to the output string
end
end
return str;
end

--[[--------------------------------------------------------------------------------------

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

]]

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

--[[----------------------------------------------------------------------

For Vancouver Style, author/editor names are supposed to be rendered in Latin (read ASCII) characters. When a name
uses characters that contain diacritical marks, those characters are to converted to the corresponding Latin character.
When a name is written using a non-Latin alphabet or logogram, that name is to be transliterated into Latin characters.
These things are not currently possible in this module so are left to the editor to do.

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

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

This original test:
if nil == mw.ustring.find (last, "^[A-Za-zÀ-ÖØ-öø-ƿǄ-ɏ%-%s%']*$") or nil == mw.ustring.find (first, "^[A-Za-zÀ-ÖØ-öø-ƿǄ-ɏ%-%s%'%.]+[2-6%a]*$") then
was written ouside of the code editor and pasted here because the code editor gets confused between character insertion point and cursor position.
The test has been rewritten to use decimal character escape sequence for the individual bytes of the unicode characters so that it is not necessary
to use an external editor to maintain this code.

\195\128-\195\150 – À-Ö (U+00C0–U+00D6 – C0 controls)
\195\152-\195\182 – Ø-ö (U+00D8-U+00F6 – C0 controls)
\195\184-\198\191 – ø-ƿ (U+00F8-U+01BF – C0 controls, Latin extended A & B)
\199\132-\201\143 – Ǆ-ɏ (U+01C4-U+024F – Latin extended B)

]]

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

if is_set (suffix) then
if not is_suffix (suffix) then
add_vanc_error ('suffix');
return false; -- not a name with an appropriate suffix
end
end
if nil == mw.ustring.find (last, "^[A-Za-z\195\128-\195\150\195\152-\195\182\195\184-\198\191\199\132-\201\143%-%s%']*$") or
nil == mw.ustring.find (first, "^[A-Za-z\195\128-\195\150\195\152-\195\182\195\184-\198\191\199\132-\201\143%-%s%'%.]*$") then
add_vanc_error ('non-Latin character');
return false; -- not a string of latin characters; Vancouver requires Romanization
end;
return true;
end

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

Attempts to convert names to initials in support of |name-list-format=vanc.

Names in |firstn= may be separated by spaces or hyphens, or for initials, a period. See http://www.ncbi.nlm.nih.gov/books/NBK7271/box/A35062/.

Vancouver style requires family rank designations (Jr, II, III, etc) to be rendered as Jr, 2nd, 3rd, etc. See http://www.ncbi.nlm.nih.gov/books/NBK7271/box/A35085/.
This code only accepts and understands generational suffix in the Vancouver format because Roman numerals look like, and can be mistaken for, initials.

This function uses ustring functions because firstname initials may be any of the unicode Latin characters accepted by is_good_vanc_name ().

]]

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

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

if name then -- if first is initials with or without suffix
if 3 > mw.ustring.len (name) then -- if one or two initials
if suffix then -- if there is a suffix
if is_suffix (suffix) then -- is it legitimate?
return first; -- one or two initials and a valid suffix so nothing to do
else
add_vanc_error ('suffix'); -- one or two initials with invalid suffix so error message
return first; -- and return first unmolested
end
else
return first; -- one or two initials without suffix; nothing to do
end
end
end -- if here then name has 3 or more uppercase letters so treat them as a word

local initials, names = {}, {}; -- tables to hold name parts and initials
local i = 1; -- counter for number of initials

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

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

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

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

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

]]

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

if 'vanc' == format then -- Vancouver-like author/editor name styling?
sep = ','; -- 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

if sep:sub(-1,-1) ~= " " then sep = sep .. " " end
if is_set (maximum) and maximum < 1 then return "", 0; end -- returned 0 is for EditorCount; not used for authors

for i,person in ipairs(people) do
if is_set(person.last) then
local mask = person.mask
local one
local sep_one = sep;
if is_set (maximum) and i > maximum then
etal = true;
break;
elseif (mask ~= nil) then
local n = tonumber(mask)
if (n ~= nil) then
one = string.rep("—",n)
else
one = mask;
sep_one = " ";
end
else
one = person.last
local first = person.first
if is_set(first) then
if ( "vanc" == format ) then -- if vancouver format
one = one:gsub ('%.', ''); -- remove periods from surnames (http://www.ncbi.nlm.nih.gov/books/NBK7271/box/A35029/)
if not person.corporate and is_good_vanc_name (one, first) then -- and name is all Latin characters; corporate authors not tested
first = reduce_to_initials(first) -- attempt to convert first name(s) to initials
end
end
one = one .. namesep .. first;
end
if is_set(person.link) and person.link ~= control.page_name then
one = make_wikilink (person.link, one); -- link author/editor if this page is not the author's/editor's page
end
end
table.insert( text, one )
table.insert( text, sep_one )
end
end

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

local result = table.concat(text) -- construct list
if etal and is_set (result) then -- etal may be set by |display-authors=etal but we might not have a last-first list
result = result .. sep .. ' ' .. cfg.messages['et al']; -- we've go a last-first list and etal so add et al.
end

return result, count
end

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

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

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

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

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

Evaluates the content of author and editor name parameters for variations on the theme of et al. If found,
the et al. is removed, a flag is set to true and the function returns the modified name and the flag.

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

]]

local function name_has_etal (name, etal, nocat)

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

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

--[[--------------------------< N A M E _ H A S _ E D _ M A R K U P >------------------------------------------

Evaluates the content of author and editor parameters for extranious editor annotations: ed, ed., eds, (Ed.), etc.
These annotation do not belong in author parameters and are redundant in editor parameters. If found, the function
adds the editor markup maintenance category.

]]

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

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

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

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

Evaluates the content of author and editor (surnames only) parameters for multiple names. Multiple names are
indicated if there is more than one comma and or semicolon. If found, the function adds the multiple name
(author or editor) maintenance category.

]]

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

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

--[[--------------------------< N A M E _ C H E C K S >--------------------------------------------------------
This function calls various name checking functions used to validate the content of the various name-holding
parameters.

]]

local function name_checks (last, first, list_name)
if is_set (last) then
if last:match ('^%(%(.*%)%)$') then -- if wrapped in doubled parentheses, accept as written
last = last:match ('^%(%((.*)%)%)$'); -- strip parens
else
last = name_has_mult_names (last, list_name); -- check for multiple names in the parameter (last only)
last = name_has_ed_markup (last, list_name); -- check for extraneous 'editor' annotation
end
end
if is_set (first) then
if first:match ('^%(%(.*%)%)$') then -- if wrapped in doubled parentheses, accept as written
first = first:match ('^%(%((.*)%)%)$'); -- strip parens
else
first = name_has_ed_markup (first, list_name); -- check for extraneous 'editor' annotation
end
end
return last, first; -- done
end

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

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

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

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

]]

local function extract_names(args, list_name)
local names = {}; -- table of names
local last; -- individual name components
local first;
local link;
local mask;
local i = 1; -- loop counter/indexer
local n = 1; -- output table indexer
local count = 0; -- used to count the number of times we haven't found a |last= (or alias for authors, |editor-last or alias for editors)
local etal=false; -- return value set to true when we find some form of et al. in an author parameter

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

last, etal = name_has_etal (last, etal, false); -- find and remove variations on et al.
first, etal = name_has_etal (first, etal, false); -- find and remove variations on et al.
last, first= name_checks (last, first, list_name); -- multiple names, extraneous annotation, etc checks

if first and not last then -- if there is a firstn without a matching lastn
table.insert( z.message_tail, { set_error( 'first_missing_last', {err_msg_list_name, i}, true ) } ); -- add this error message
elseif not first and not last then -- if both firstn and lastn aren't found, are we done?
count = count + 1; -- number of times we haven't found last and first
if 2 <= count then -- two missing names and we give up
break; -- normal exit or there is a two-name hole in the list; can't tell which
end
else -- we have last with or without a first
link_title_ok (link, list_name:match ("(%w+)List"):lower() .. '-link' .. i, last, list_name:match ("(%w+)List"):lower() .. '-last' .. i); -- check for improper wikimarkup

names[n] = {last = last, first = first, link = link, mask = mask, corporate=false}; -- add this name to our names list (corporate for |vauthors= only)
n = n + 1; -- point to next location in the names table
if 1 == count then -- if the previous name was missing
table.insert( z.message_tail, { set_error( 'missing_name', {err_msg_list_name, i-1}, true ) } ); -- add this error message
end
count = 0; -- reset the counter, we're looking for two consecutive missing names
end
i = i + 1; -- point to next args location
end

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

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

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

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

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

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

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

]]

local function get_iso639_code (lang, this_wiki_code)
local remap = {
['bangla'] = {'Bengali', 'bn'}, -- MediaWiki returns Bangla (the endonym) but we want Bengali (the exonym); here we remap
['bengali'] = {'Bengali', 'bn'}, -- MediaWiki doesn't use exonym so here we provide correct language name and 639-1 code
['bihari'] = {'Bihari', 'bh'}, -- MediaWiki replace 'Bihari' with 'Bhojpuri' so 'Bihari' cannot be found
['bhojpuri'] = {'Bhojpuri', 'bho'}, -- MediaWiki uses 'bh' as a subdomain name for Bhojpuri wWikipedia: bh.wikipedia.org
}

if remap[lang:lower()] then
return remap[lang:lower()][1], remap[lang:lower()][2]; -- for this language 'name', return a possibly new name and appropriate code
end

local languages = mw.language.fetchLanguageNames(this_wiki_code, 'all') -- get a list of language names known to Wikimedia
-- ('all' is required for North Ndebele, South Ndebele, and Ojibwa)
local langlc = mw.ustring.lower(lang); -- lower case version for comparisons

for code, name in pairs(languages) do -- scan the list to see if we can find our language
if langlc == mw.ustring.lower(name) then
if 2 ~= code:len() and 3 ~= code:len() then -- two- or three-character codes only; extensions not supported
return name; -- so return the name but not the code
end
return name, code; -- found it, return name to ensure proper capitalization and the the code
end
end
return lang; -- not valid language; return language in original case and nil for the code
end

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

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

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

Languages that are the same as the local wiki are not categorized. MediaWiki does not recognize three-character
equivalents of two-character codes: code 'ar' is recognized bit code 'ara' is not.

This function supports multiple languages in the form |language=nb, French, th where the language names or codes are
separated from each other by commas.

]]

local function language_parameter (lang)
local code; -- the two- or three-character language code
local name; -- the language name
local language_list = {}; -- table of language names to be rendered
local names_table = {}; -- table made from the value assigned to |language=

local this_wiki = mw.getContentLanguage(); -- get a language object for this wiki
local this_wiki_code = this_wiki:getCode() -- get this wiki's language code
local this_wiki_name = mw.language.fetchLanguageName(this_wiki_code, this_wiki_code); -- get this wiki's language name

local remap = {
['bh'] = 'Bihari', -- MediaWiki uses 'bh' as a subdomain name for Bhojpuri wWikipedia: bh.wikipedia.org
['bn'] = 'Bengali', -- MediaWiki returns Bangla
}

names_table = mw.text.split (lang, '%s*,%s*'); -- names should be a comma separated list

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

if lang:match ('^%a%a%-') then -- strip ietf language tags from code; TODO: is there a need to support 3-char with tag?
lang = lang:match ('(%a%a)%-') -- keep only 639-1 code portion to lang; TODO: do something with 3166 alpha 2 country code?
end
if 2 == lang:len() or 3 == lang:len() then -- if two-or three-character code
name = mw.language.fetchLanguageName( lang:lower(), this_wiki_code); -- get language name if |language= is a proper code
end

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

if is_set (code) then -- only 2- or 3-character codes
name = remap[code] or name; -- override wikimedia when they misuse language codes/names

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

table.insert (language_list, name);
name = ''; -- so we can reuse it
end

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

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

Set style settings for CS1 citation templates. Returns separator and postscript settings

]]

local function set_cs1_style (ps)
if not is_set (ps) then -- unless explicitely set to something
ps = '.'; -- terminate the rendered citation with a period
end
return '.', ps; -- separator is a full stop
end

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

Set style settings for CS2 citation templates. Returns separator, postscript, ref settings

]]

local function set_cs2_style (ps, ref)
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
return ',', ps, ref; -- separator is a comma
end

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

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

]]

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

return sep, ps, ref -- return them all
end

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

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

]]

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

return sep, ps, ref
end

--[=[-------------------------------------------------------------------------------------------

Determines if a url has the file extension that is one of the pdf file extensions used by [[MediaWiki:Common.css]] when
applying the pdf icon to external links.

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

]=]

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

--[[--------------------------< S T Y L E _ F O R M A T >------------------------------------------------------

Applies css style to |format=, |chapter-format=, etc. Also emits an error message if the format parameter does
not have a matching url parameter. If the format parameter is not set and the url contains a file extension that
is recognized as a pdf document by MediaWiki's commons.css, this code will set the format parameter to (PDF) with
the appropriate styling.

]]

local function style_format (format, url, fmt_param, url_param)
if is_set (format) then
format = wrap_style ('format', format); -- add leading space, parentheses, resize
if not is_set (url) then
format = format .. set_error( 'format_missing_url', {fmt_param, url_param} ); -- add an error message
end
elseif is_pdf (url) then -- format is not set so if url is a pdf file then
format = wrap_style ('format', 'PDF'); -- set format to pdf
else
format = ''; -- empty string for concatenation
end
return format;
end

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

Returns a number that defines the number of names displayed for author and editor name lists and a boolean flag
to indicate when et al. should be appended to the name list.

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

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

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

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

]]

local function get_display_authors_editors (max, count, list_name, etal)
if is_set (max) then
if 'etal' == max:lower():gsub("[ '%.]", '') then -- the :gsub() portion makes 'etal' from a variety of 'et al.' spellings and stylings
max = count + 1; -- number of authors + 1 so display all author name plus et al.
etal = true; -- overrides value set by extract_names()
elseif max:match ('^%d+$') then -- if is a string of numbers
max = tonumber (max); -- make it a number
if max >= count then -- if |display-xxxxors= value greater than or equal to number of authors/editors
add_maint_cat ('disp_auth_ed', cfg.special_case_translation [list_name]);
end
else -- not a valid keyword or number
table.insert( z.message_tail, { set_error( 'invalid_param_val', {'display-' .. list_name, max}, true ) } ); -- add error message
max = nil; -- unset; as if |display-xxxxors= had not been set
end
end

return max, etal;
end

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

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

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

]]

local function extra_text_in_page_check (page)
local good_pattern = '^P[^%.Pp]'; -- ok to begin with uppercase P: P7 (pg 7 of section P) but not p123 (page 123) TODO: add Gg for PG or Pg?
local bad_pattern = '^[Pp]?[Pp]%.?[ %d]';

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

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

split apart a |vauthors= or |veditors= parameter. This function allows for corporate names, wrapped in doubled
parentheses to also have commas; in the old version of the code, the doubled parnetheses were included in the
rendered citation and in the metadata. Individual author names may be wikilinked

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

]=]

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

local i = 1;

while name_table[i] do
if name_table[i]:match ('^%(%(.*[^%)][^%)]$') then -- first segment of corporate with one or more commas; this segment has the opening doubled parens
local name = name_table[i];
i=i+1; -- bump indexer to next segment
while name_table[i] do
name = name .. ', ' .. name_table[i]; -- concatenate with previous segments
if name_table[i]:match ('^.*%)%)$') then -- if this table member has the closing doubled parens
break; -- and done reassembling so
end
i=i+1; -- bump indexer
end
table.insert (output_table, name); -- and add corporate name to the output table
table.insert (output_link_table, ''); -- no wikilink
else
wl_type, label, link = is_wikilink (name_table[i]); -- wl_type is: 0, no wl (text in label variable); 1, [[D]]; 2, [[L|D]]
table.insert (output_table, label); -- add this name
if 1 == wl_type then
table.insert (output_link_table, label); -- simple wikilink [[D]]
else
table.insert (output_link_table, link); -- no wikilink or [[L|D]]; add this link if there is one, else empty string
end
end
i = i+1;
end
return output_table;
end

--[[----------------------------------------------------------

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

Author / editor names in |vauthors= or |veditors= must be in Vancouver system style. Corporate or institutional names
may sometimes be required and because such names will often fail the is_good_vanc_name() and other format compliance
tests, are wrapped in doubled paranethese ((corporate name)) to suppress the format tests.

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

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

]]

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

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

for i, v_name in ipairs(v_name_table) do
if v_name:match ('^%(%(.+%)%)$') then -- corporate authors are wrapped in doubled parentheses to supress vanc formatting and error detection
first = ''; -- set to empty string for concatenation and because it may have been set for previous author/editor
last = v_name:match ('^%(%((.+)%)%)$') -- remove doubled parntheses
corporate = true; -- flag used in list_people()
elseif string.find(v_name, "%s") then
if v_name:find('[;%.]') then -- look for commonly occurring punctuation characters;
add_vanc_error ('punctuation');
end
local lastfirstTable = {}
lastfirstTable = mw.text.split(v_name, "%s")
first = table.remove(lastfirstTable); -- removes and returns value of last element in table which should be author intials
if is_suffix (first) then -- if a valid suffix
suffix = first -- save it as a suffix and
first = table.remove(lastfirstTable); -- get what should be the initials from the table
end -- no suffix error message here because letter combination may be result of Romanization; check for digits?
last = table.concat(lastfirstTable, " ") -- returns a string that is the concatenation of all other names that are not initials
if mw.ustring.match (last, '%a+%s+%u+%s+%a+') then
add_vanc_error ('missing comma'); -- matches last II last; the case when a comma is missing
end
if mw.ustring.match (v_name, ' %u %u$') then -- this test is in the wrong place TODO: move or replace with a more appropriate test
add_vanc_error ('name'); -- matches a space between two intiials
end
else
first = ''; -- set to empty string for concatenation and because it may have been set for previous author/editor
last = v_name; -- last name or single corporate name? Doesn't support multiword corporate names? do we need this?
end

if is_set (first) then
if not mw.ustring.match (first, "^%u?%u$") then -- first shall contain one or two upper-case letters, nothing else
add_vanc_error ('initials'); -- too many initials; mixed case initials (which may be ok Romanization); hyphenated initials
end
is_good_vanc_name (last, first); -- check first and last before restoring the suffix which may have a non-Latin digit
if is_set (suffix) then
first = first .. ' ' .. suffix; -- if there was a suffix concatenate with the initials
suffix = ''; -- unset so we don't add this suffix to all subsequent names
end
else
if not corporate then
is_good_vanc_name (last, '');
end
end

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

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

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

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

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

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

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

]]

local function select_author_editor_source (vxxxxors, xxxxors, args, list_name)
local lastfirst = false;
if select_one( args, cfg.aliases[list_name .. '-Last'], 'none', 1 ) or -- do this twice incase we have a |first1= without a |last1=; this ...
select_one( args, cfg.aliases[list_name .. '-First'], 'none', 1 ) or -- ... also catches the case where |first= is used with |vauthors=
select_one( args, cfg.aliases[list_name .. '-Last'], 'none', 2 ) or
select_one( args, cfg.aliases[list_name .. '-First'], 'none', 2 ) then
lastfirst=true;
end

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

if true == lastfirst then return 1 end; -- return a number indicating which author name source to use
if is_set (vxxxxors) then return 2 end;
if is_set (xxxxors) then return 3 end;
return 1; -- no authors so return 1; this allows missing author name test to run in case there is a first without last
end

--[[--------------------------------------------------------

This function is used to validate a parameter's assigned value for those parameters that have only a limited number
of allowable values (yes, y, true, no, etc). When the parameter value has not been assigned a value (missing or empty
in the source template) the function returns true. If the parameter value is one of the list of allowed values returns
true; else, emits an error message and returns false.

]]

local function is_valid_parameter_value (value, name, possible)
if not is_set (value) then
return true; -- an empty parameter is ok
elseif in_array(value:lower(), possible) then
return true;
else
table.insert( z.message_tail, { set_error( 'invalid_param_val', {name, value}, true ) } ); -- not an allowed value so add error message
return false
end
end

--[[--------------------------< T E R M I N A T E _ N A M E _ L I S T >----------------------------------------

This function terminates a name list (author, contributor, editor) with a separator character (sepc) and a space
when the last character is not a sepc character or when the last three characters are not sepc followed by two
closing square brackets (close of a wikilink). When either of these is true, the name_list is terminated with a
single space character.

]]

local function terminate_name_list (name_list, sepc)
if (string.sub (name_list,-3,-1) == sepc .. '. ') then -- if already properly terminated
return name_list; -- just return the name list
elseif (string.sub (name_list,-1,-1) == sepc) or (string.sub (name_list,-3,-1) == sepc .. ']]') then -- if last name in list ends with sepc char
return name_list .. " "; -- don't add another
else
return name_list .. sepc .. ' '; -- otherwise terninate the name list
end
end

--[[-------------------------< F O R M A T _ V O L U M E _ I S S U E >----------------------------------------

returns the concatenation of the formatted volume and issue parameters as a single string; or formatted volume
or formatted issue, or an empty string if neither are set.

]]

local function format_volume_issue (volume, issue, cite_class, origin, sepc, lower)
if not is_set (volume) and not is_set (issue) then
return '';
end

if 'magazine' == cite_class or (in_array (cite_class, {'citation', 'map'}) and 'magazine' == origin) then
if is_set (volume) and is_set (issue) then
return wrap_msg ('vol-no', {sepc, volume, issue}, lower);
elseif is_set (volume) then
return wrap_msg ('vol', {sepc, volume}, lower);
else
return wrap_msg ('issue', {sepc, issue}, lower);
end
end

local vol = '';

if is_set (volume) then
if (4 < mw.ustring.len(volume)) then
vol = substitute (cfg.messages['j-vol'], {sepc, volume});
else
vol = substitute (cfg.presentation['vol-bold'], {sepc, hyphen_to_dash(volume)});
end
end
if is_set (issue) then
return vol .. substitute (cfg.messages['j-issue'], issue);
end
return vol;
end

--[[-------------------------< F O R M A T _ P A G E S _ S H E E T S >-----------------------------------------

adds static text to one of |page(s)= or |sheet(s)= values and returns it with all of the others set to empty strings.
The return order is:
page, pages, sheet, sheets

Singular has priority over plural when both are provided.

]]

local function format_pages_sheets (page, pages, sheet, sheets, cite_class, origin, sepc, nopp, lower)
if 'map' == cite_class then -- only cite map supports sheet(s) as in-source locators
if is_set (sheet) then
if 'journal' == origin then
return '', '', wrap_msg ('j-sheet', sheet, lower), '';
else
return '', '', wrap_msg ('sheet', {sepc, sheet}, lower), '';
end
elseif is_set (sheets) then
if 'journal' == origin then
return '', '', '', wrap_msg ('j-sheets', sheets, lower);
else
return '', '', '', wrap_msg ('sheets', {sepc, sheets}, lower);
end
end
end

local is_journal = 'journal' == cite_class or (in_array (cite_class, {'citation', 'map'}) and 'journal' == origin);

if is_set (page) then
if is_journal then
return substitute (cfg.messages['j-page(s)'], page), '', '', '';
elseif not nopp then
return substitute (cfg.messages['p-prefix'], {sepc, page}), '', '', '';
else
return substitute (cfg.messages['nopp'], {sepc, page}), '', '', '';
end
elseif is_set(pages) then
if is_journal then
return substitute (cfg.messages['j-page(s)'], pages), '', '', '';
elseif tonumber(pages) ~= nil and not nopp then -- if pages is only digits, assume a single page number
return '', substitute (cfg.messages['p-prefix'], {sepc, pages}), '', '';
elseif not nopp then
return '', substitute (cfg.messages['pp-prefix'], {sepc, pages}), '', '';
else
return '', substitute (cfg.messages['nopp'], {sepc, pages}), '', '';
end
end

return '', '', '', ''; -- return empty strings
end

--[=[-------------------------< A R C H I V E _ U R L _ C H E C K >--------------------------------------------

Check archive.org urls to make sure they at least look like they are pointing at valid archives and not to the
save snapshot url or to calendar pages. When the archive url is 'https://web.archive.org/save/' (or http://...)
archive.org saves a snapshot of the target page in the url. That is something that Wikipedia should not allow
unwitting readers to do.

When the archive.org url does not have a complete timestamp, archive.org chooses a snapshot according to its own
algorithm or provides a calendar 'search' result. [[WP:ELNO]] discourages links to search results.

This function looks at the value assigned to |archive-url= and returns empty strings for |archive-url= and
|archive-date= and an error message when:
|archive-url= holds an archive.org save command url
|archive-url= is an archive.org url that does not have a complete timestamp (YYYYMMDDhhmmss 14 digits) in the
correct place
otherwise returns |archive-url= and |archive-date=

There are two mostly compatible archive.org urls:
//web.archive.org/<timestamp>... -- the old form
//web.archive.org/web/<timestamp>... -- the new form

The old form does not support or map to the new form when it contains a display flag. There are four identified flags
('id_', 'js_', 'cs_', 'im_') but since archive.org ignores others following the same form (two letters and an underscore)
we don't check for these specific flags but we do check the form.

This function supports a preview mode. When the article is rendered in preview mode, this funct may return a modified
archive url:
for save command errors, return undated wildcard (/*/)
for timestamp errors when the timestamp has a wildcard, return the url unmodified
for timestamp errors when the timestamp does not have a wildcard, return with timestamp limited to six digits plus wildcard (/yyyymm*/)

]=]

local function archive_url_check (url, date)
local err_msg = ''; -- start with the error message empty
local path, timestamp, flag; -- portions of the archive.or url

if (not url:match('//web%.archive%.org/')) and (not url:match('//liveweb%.archive%.org/')) then -- also deprecated liveweb Wayback machine url
return url, date; -- not an archive.org archive, return ArchiveURL and ArchiveDate
end

if url:match('//web%.archive%.org/save/') then -- if a save command url, we don't want to allow saving of the target page
err_msg = 'save command';
url = url:gsub ('(//web%.archive%.org)/save/', '%1/*/', 1); -- for preview mode: modify ArchiveURL
elseif url:match('//liveweb%.archive%.org/') then
err_msg = 'liveweb';
else
path, timestamp, flag = url:match('//web%.archive%.org/([^%d]*)(%d+)([^/]*)/'); -- split out some of the url parts for evaluation

if not is_set(timestamp) or 14 ~= timestamp:len() then -- path and flag optional, must have 14-digit timestamp here
err_msg = 'timestamp';
if '*' ~= flag then
url=url:gsub ('(//web%.archive%.org/[^%d]*%d?%d?%d?%d?%d?%d?)[^/]*', '%1*', 1) -- for preview, modify ts to be yearmo* max (0-6 digits plus splat)
end
elseif is_set(path) and 'web/' ~= path then -- older archive urls do not have the extra 'web/' path element
err_msg = 'path';
elseif is_set (flag) and not is_set (path) then -- flag not allowed with the old form url (without the 'web/' path element)
err_msg = 'flag';
elseif is_set (flag) and not flag:match ('%a%a_') then -- flag if present must be two alpha characters and underscore (requires 'web/' path element)
err_msg = 'flag';
else
return url, date; -- return archiveURL and ArchiveDate
end
end
-- if here, something not right so
table.insert( z.message_tail, { set_error( 'archive_url', {err_msg}, true ) } ); -- add error message and
if is_set (Frame:preprocess('{{REVISIONID}}')) then
return '', ''; -- return empty strings for archiveURL and ArchiveDate
else
return url, date; -- preview mode so return archiveURL and ArchiveDate
end
end

--[[--------------------------< M I S S I N G _ P I P E _ C H E C K >------------------------------------------

Look at the contents of a parameter. If the content has a string of characters and digits followed by an equal
sign, compare the alphanumeric string to the list of cs1|2 parameters. If found, then the string is possibly a
parameter that is missing its pipe:
{{cite ... |title=Title access-date=2016-03-17}}

cs1|2 shares some parameter names with xml/html atributes: class=, title=, etc. To prevent false positives xml/html
tags are removed before the search.

If a missing pipe is detected, this function adds the missing pipe maintenance category.

]]

local function missing_pipe_check (value)
local capture;
value = value:gsub ('%b<>', ''); -- remove xml/html tags because attributes: class=, title=, etc

capture = value:match ('%s+(%a[%a%d]+)%s*=') or value:match ('^(%a[%a%d]+)%s*='); -- find and categorize parameters with possible missing pipes
if capture and validate (capture) then -- if the capture is a valid parameter name
add_maint_cat ('missing_pipe');
end
end

--[[--------------------------< C I T A T I O N 0 >------------------------------------------------------------

This is the main function doing the majority of the citation formatting.

]]

local function citation0( config, args)
--[[
Load Input Parameters
The argument_wrapper facilitates the mapping of multiple aliases to single internal variable.
]]
local A = argument_wrapper( args );
local i

-- Pick out the relevant fields from the arguments. Different citation templates
-- define different field names for the same underlying things.

-- set default parameter values defined by |mode= parameter.
local Mode = A['Mode'];
if not is_valid_parameter_value (Mode, 'mode', cfg.keywords['mode']) then
Mode = '';
end

local author_etal;
local a = {}; -- authors list from |lastn= / |firstn= pairs or |vauthors=
local Authors;
local NameListFormat = A['NameListFormat'];
local Collaboration = A['Collaboration'];

do -- to limit scope of selected
local selected = select_author_editor_source (A['Vauthors'], A['Authors'], args, 'AuthorList');
if 1 == selected then
a, author_etal = extract_names (args, 'AuthorList'); -- fetch author list from |authorn= / |lastn= / |firstn=, |author-linkn=, and |author-maskn=
elseif 2 == selected then
NameListFormat = 'vanc'; -- override whatever |name-list-format= might be
a, author_etal = parse_vauthors_veditors (args, args.vauthors, 'AuthorList'); -- fetch author list from |vauthors=, |author-linkn=, and |author-maskn=
elseif 3 == selected then
Authors = A['Authors']; -- use content of |authors=
if 'authors' == A:ORIGIN('Authors') then -- but add a maint cat if the parameter is |authors=
add_maint_cat ('authors'); -- because use of this parameter is discouraged; what to do about the aliases is a TODO:
end
end
if is_set (Collaboration) then
author_etal = true; -- so that |display-authors=etal not required
end
end

local Others = A['Others'];

local editor_etal;
local e = {}; -- editors list from |editor-lastn= / |editor-firstn= pairs or |veditors=
local Editors;

do -- to limit scope of selected
local selected = select_author_editor_source (A['Veditors'], A['Editors'], args, 'EditorList');
if 1 == selected then
e, editor_etal = extract_names (args, 'EditorList'); -- fetch editor list from |editorn= / |editor-lastn= / |editor-firstn=, |editor-linkn=, and |editor-maskn=
elseif 2 == selected then
NameListFormat = 'vanc'; -- override whatever |name-list-format= might be
e, editor_etal = parse_vauthors_veditors (args, args.veditors, 'EditorList'); -- fetch editor list from |veditors=, |editor-linkn=, and |editor-maskn=
elseif 3 == selected then
Editors = A['Editors']; -- use content of |editors=
add_maint_cat ('editors'); -- but add a maint cat because use of this parameter is discouraged
end
end

local t = {}; -- translators list from |translator-lastn= / translator-firstn= pairs
local Translators; -- assembled translators name list
t = extract_names (args, 'TranslatorList'); -- fetch translator list from |translatorn= / |translator-lastn=, -firstn=, -linkn=, -maskn=

local interviewers_list = {};
local Interviewers = A['Interviewers']
if is_set (Interviewers) then -- add a maint cat if the |interviewers= is used
add_maint_cat ('interviewers'); -- because use of this parameter is discouraged
else
interviewers_list = extract_names (args, 'InterviewerList'); -- else, process preferred interviewers parameters
end

local c = {}; -- contributors list from |contributor-lastn= / contributor-firstn= pairs
local Contributors; -- assembled contributors name list
local Contribution = A['Contribution'];
if in_array(config.CitationClass, {"book","citation"}) and not is_set(A['Periodical']) then -- |contributor= and |contribution= only supported in book cites
c = extract_names (args, 'ContributorList'); -- fetch contributor list from |contributorn= / |contributor-lastn=, -firstn=, -linkn=, -maskn=

if 0 < #c then
if not is_set (Contribution) then -- |contributor= requires |contribution=
table.insert( z.message_tail, { set_error( 'contributor_missing_required_param', 'contribution')}); -- add missing contribution error message
c = {}; -- blank the contributors' table; it is used as a flag later
end
if 0 == #a then -- |contributor= requires |author=
table.insert( z.message_tail, { set_error( 'contributor_missing_required_param', 'author')}); -- add missing author error message
c = {}; -- blank the contributors' table; it is used as a flag later
end
end
else -- if not a book cite
if select_one (args, cfg.aliases['ContributorList-Last'], 'redundant_parameters', 1 ) then -- are there contributor name list parameters?
table.insert( z.message_tail, { set_error( 'contributor_ignored')}); -- add contributor ignored error message
end
Contribution = nil; -- unset
end

if not is_valid_parameter_value (NameListFormat, 'name-list-format', cfg.keywords['name-list-format']) then -- only accepted value for this parameter is 'vanc'
NameListFormat = ''; -- anything else, set to empty string
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'];
link_title_ok (TitleLink, A:ORIGIN ('TitleLink'), Title, 'title'); -- check for wikimarkup in |title-link= or wikimarkup in |title= when |title-link= is set

local Chapter = A['Chapter'];
local ScriptChapter = A['ScriptChapter'];
local ChapterLink -- = A['ChapterLink']; -- deprecated as a parameter but still used internally by cite episode
local TransChapter = A['TransChapter'];
local TitleType = A['TitleType'];
local Degree = A['Degree'];
local Docket = A['Docket'];
local ArchiveFormat = A['ArchiveFormat'];

local ArchiveDate;
local ArchiveURL;

ArchiveURL, ArchiveDate = archive_url_check (A['ArchiveURL'], A['ArchiveDate'])

local DeadURL = A['DeadURL']
if not is_valid_parameter_value (DeadURL, 'dead-url', cfg.keywords ['deadurl']) then -- set in config.defaults to 'yes'
DeadURL = ''; -- anything else, set to empty string
end

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 ConferenceFormat = A['ConferenceFormat'];
local ConferenceURL = A['ConferenceURL'];
local ConferenceURLorigin = A:ORIGIN('ConferenceURL'); -- get name of parameter that holds ConferenceURL
local Periodical = A['Periodical'];
local Periodical_origin = A:ORIGIN('Periodical'); -- get the name of the periodical parameter

local Series = A['Series'];

local Volume;
local Issue;
local Page;
local Pages;
local At;

if in_array (config.CitationClass, cfg.templates_using_volume) then
Volume = A['Volume'];
end
-- conference & map books do not support issue
if in_array (config.CitationClass, cfg.templates_using_issue) and not (in_array (config.CitationClass, {'conference', 'map'}) and not is_set (Periodical))then
Issue = A['Issue'];
end
local Position = '';
if not in_array (config.CitationClass, cfg.templates_not_using_page) then
Page = A['Page'];
Pages = hyphen_to_dash( A['Pages'] );
At = A['At'];
end

local Edition = A['Edition'];
local PublicationPlace = A['PublicationPlace']
local Place = A['Place'];

local PublisherName = A['PublisherName'];
local RegistrationRequired = A['RegistrationRequired'];
if not is_valid_parameter_value (RegistrationRequired, 'registration', cfg.keywords ['yes_true_y']) then
RegistrationRequired=nil;
end

local SubscriptionRequired = A['SubscriptionRequired'];
if not is_valid_parameter_value (SubscriptionRequired, 'subscription', cfg.keywords ['yes_true_y']) then
SubscriptionRequired=nil;
end

local UrlAccess = A['UrlAccess'];
if not is_valid_parameter_value (UrlAccess, 'url-access', cfg.keywords ['url-access']) then
UrlAccess = nil;
end
if not is_set(URL) and is_set(UrlAccess) then
UrlAccess = nil;
table.insert( z.message_tail, { set_error( 'param_access_requires_param', {'url'}, true ) } );
end

if is_set (UrlAccess) and is_set (SubscriptionRequired) then -- while not aliases, these are much the same so if both are set
table.insert( z.message_tail, { set_error( 'redundant_parameters', {wrap_style ('parameter', 'url-access') .. ' and ' .. wrap_style ('parameter', 'subscription')}, true ) } ); -- add error message
SubscriptionRequired = nil; -- unset; prefer |access= over |subscription=
end
if is_set (UrlAccess) and is_set (RegistrationRequired) then -- these are not the same but contradictory so if both are set
table.insert( z.message_tail, { set_error( 'redundant_parameters', {wrap_style ('parameter', 'url-access') .. ' and ' .. wrap_style ('parameter', 'registration')}, true ) } ); -- add error message
RegistrationRequired = nil; -- unset; prefer |access= over |registration=
end

local ChapterUrlAccess = A['ChapterUrlAccess'];
if not is_valid_parameter_value (ChapterUrlAccess, 'chapter-url-access', cfg.keywords ['url-access']) then -- same as url-access
ChapterUrlAccess = nil;
end
if not is_set(ChapterURL) and is_set(ChapterUrlAccess) then
ChapterUrlAccess = nil;
table.insert( z.message_tail, { set_error( 'param_access_requires_param', {'chapter-url'}, true ) } );
end

local Via = A['Via'];
local AccessDate = A['AccessDate'];
local Agency = A['Agency'];

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'];
if not is_valid_parameter_value (IgnoreISBN, 'ignore-isbn-error', cfg.keywords ['yes_true_y']) then
IgnoreISBN = nil; -- anything else, set to empty string
end
local Embargo = A['Embargo'];
local Class = A['Class']; -- arxiv class identifier

local ID_list = extract_ids( args );
local ID_access_levels = extract_id_access_levels( args, ID_list );

local Quote = A['Quote'];

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

local LastAuthorAmp = A['LastAuthorAmp'];
if not is_valid_parameter_value (LastAuthorAmp, 'last-author-amp', cfg.keywords ['yes_true_y']) then
LastAuthorAmp = nil; -- set to empty string
end

local no_tracking_cats = A['NoTracking'];
if not is_valid_parameter_value (no_tracking_cats, 'no-tracking', cfg.keywords ['yes_true_y']) then
no_tracking_cats = nil; -- set to empty string
end

--local 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 = {}; -- holds date info extracted from |date= for the COinS metadata by Module:Date verification

local DF = A['DF']; -- date format set in cs1|2 template
if not is_valid_parameter_value (DF, 'df', cfg.keywords['date-format']) then -- validate reformatting keyword
DF = ''; -- not valid, set to empty string
end

local sepc; -- separator between citation elements for CS1 a period, for CS2, a comma
local PostScript;
local Ref;
sepc, PostScript, Ref = set_style (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
for _,v in ipairs (cfg.uncategorized_subpages) do -- cycle through page name patterns
if this_page.text:match (v) then -- test page name against each pattern
no_tracking_cats = "true"; -- set no_tracking_cats
break; -- bail out if one is found
end
end
end

-- check for extra |page=, |pages= or |at= parameters. (also sheet and sheets while we're at it)
select_one( args, {'page', 'p', 'pp', 'pages', 'at', 'sheet', 'sheets'}, 'redundant_parameters' ); -- this is a dummy call simply to get the error message and category

local NoPP = A['NoPP']
if is_set (NoPP) and is_valid_parameter_value (NoPP, 'nopp', cfg.keywords ['yes_true_y']) then
NoPP = true;
else
NoPP = nil; -- unset, used as a flag later
end

if is_set(Page) then
if is_set(Pages) or is_set(At) then
Pages = ''; -- unset the others
At = '';
end
extra_text_in_page_check (Page); -- add this page to maint cat if |page= value begins with what looks like p. or pp.
elseif is_set(Pages) then
if is_set(At) then
At = ''; -- unset
end
extra_text_in_page_check (Pages); -- add this page to maint cat if |pages= value begins with what looks like p. or pp.
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

]]

local Encyclopedia = A['Encyclopedia'];

if ( config.CitationClass == "encyclopaedia" ) or ( config.CitationClass == "citation" and is_set (Encyclopedia)) then -- test code for citation
if is_set(Periodical) then -- Periodical is set when |encyclopedia is set
if is_set(Title) or is_set (ScriptTitle) then
if not is_set(Chapter) then
Chapter = Title; -- |encyclopedia and |title are set so map |title to |article and |encyclopedia to |title
ScriptChapter = ScriptTitle;
TransChapter = TransTitle;
ChapterURL = URL;
ChapterUrlAccess = UrlAccess;

if not is_set (ChapterURL) and is_set (TitleLink) then
Chapter = make_wikilink (TitleLink, Chapter);
end
Title = Periodical;
ChapterFormat = Format;
Periodical = ''; -- redundant so unset
TransTitle = '';
URL = '';
Format = '';
TitleLink = '';
ScriptTitle = '';
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 case for cite techreport.
if (config.CitationClass == "techreport") then -- special case for cite techreport
if is_set(A['Number']) then -- cite techreport uses 'number', which other citations alias to 'issue'
if not is_set(ID) then -- can we use ID for the "number"?
ID = A['Number']; -- yes, use it
else -- ID has a value so emit error message
table.insert( z.message_tail, { set_error('redundant_parameters', {wrap_style ('parameter', 'id') .. ' and ' .. wrap_style ('parameter', 'number')}, true )});
end
end
end

-- special case for cite mailing list
if (config.CitationClass == "mailinglist") then
Periodical = A ['MailingList'];
elseif 'mailinglist' == A:ORIGIN('Periodical') then
Periodical = ''; -- unset because mailing list is only used for cite mailing list
end

-- Account for the oddity that is {{cite conference}}, before generation of COinS data.
if 'conference' == config.CitationClass then
if is_set(BookTitle) then
Chapter = Title;
-- ChapterLink = TitleLink; -- |chapterlink= is deprecated
ChapterURL = URL;
ChapterUrlAccess = UrlAccess;
ChapterURLorigin = URLorigin;
URLorigin = '';
ChapterFormat = Format;
TransChapter = TransTitle;
Title = BookTitle;
Format = '';
-- TitleLink = '';
TransTitle = '';
URL = '';
end
elseif 'speech' ~= config.CitationClass then
Conference = ''; -- not cite conference or cite speech so make sure this is empty string
end

-- cite map oddities
local Cartography = "";
local Scale = "";
local Sheet = A['Sheet'] or '';
local Sheets = A['Sheets'] or '';
if config.CitationClass == "map" then
Chapter = A['Map'];
ChapterURL = A['MapURL'];
ChapterUrlAccess = UrlAccess;
TransChapter = A['TransMap'];
ChapterURLorigin = A:ORIGIN('MapURL');
ChapterFormat = A['MapFormat'];

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

-- Account for the oddities that are {{cite episode}} and {{cite serial}}, before generation of COinS data.
if 'episode' == config.CitationClass or 'serial' == config.CitationClass then
local AirDate = A['AirDate'];
local SeriesLink = A['SeriesLink'];

link_title_ok (SeriesLink, A:ORIGIN ('SeriesLink'), Series, 'series'); -- check for wikimarkup in |series-link= or wikimarkup in |series= when |series-link= is set

local Network = A['Network'];
local Station = A['Station'];
local s, n = {}, {};
-- do common parameters first
if is_set(Network) then table.insert(n, Network); end
if is_set(Station) then table.insert(n, Station); end
ID = table.concat(n, sepc .. ' ');

if not is_set (Date) and is_set (AirDate) then -- promote airdate to date
Date = AirDate;
end

if 'episode' == config.CitationClass then -- handle the oddities that are strictly {{cite episode}}
local Season = A['Season'];
local SeriesNumber = A['SeriesNumber'];

if is_set (Season) and is_set (SeriesNumber) then -- these are mutually exclusive so if both are set
table.insert( z.message_tail, { set_error( 'redundant_parameters', {wrap_style ('parameter', 'season') .. ' and ' .. wrap_style ('parameter', 'seriesno')}, true ) } ); -- add error message
SeriesNumber = ''; -- unset; prefer |season= over |seriesno=
end
-- assemble a table of parts concatenated later into Series
if is_set(Season) then table.insert(s, wrap_msg ('season', Season, use_lowercase)); end
if is_set(SeriesNumber) then table.insert(s, wrap_msg ('series', SeriesNumber, use_lowercase)); end
if is_set(Issue) then table.insert(s, wrap_msg ('episode', Issue, use_lowercase)); end
Issue = ''; -- unset because this is not a unique parameter

Chapter = Title; -- promote title parameters to chapter
ScriptChapter = ScriptTitle;
ChapterLink = TitleLink; -- alias episodelink
TransChapter = TransTitle;
ChapterURL = URL;
ChapterUrlAccess = UrlAccess;
ChapterURLorigin = A:ORIGIN('URL');

Title = Series; -- promote series to title
TitleLink = SeriesLink;
Series = table.concat(s, sepc .. ' '); -- this is concatenation of season, seriesno, episode number

if is_set (ChapterLink) and not is_set (ChapterURL) then -- link but not URL
Chapter = make_wikilink (ChapterLink, Chapter);
elseif is_set (ChapterLink) and is_set (ChapterURL) then -- if both are set, URL links episode;
Series = make_wikilink (ChapterLink, Series);
end
URL = ''; -- unset
TransTitle = '';
ScriptTitle = '';

else -- now oddities that are cite serial
Issue = ''; -- unset because this parameter no longer supported by the citation/core version of cite serial
Chapter = A['Episode']; -- TODO: make |episode= available to cite episode someday?
if is_set (Series) and is_set (SeriesLink) then
Series = make_wikilink (SeriesLink, Series);
end
Series = wrap_style ('italic-title', Series); -- series is italicized
end
end
-- end of {{cite episode}} stuff

-- Account for the oddities that are {{cite arxiv}}, {{cite biorxiv}}, {{cite citeseerx}}, before generation of COinS data.
do
if in_array (config.CitationClass, {'arxiv', 'biorxiv', 'citeseerx'}) then
if not is_set (ID_list[config.CitationClass:upper()]) then -- |arxiv= or |eprint= required for cite arxiv; |biorxiv= & |citeseerx= required for their templates
table.insert( z.message_tail, { set_error( config.CitationClass .. '_missing', {}, true ) } ); -- add error message
end

if 'arxiv' == config.CitationClass then
Periodical = 'arXiv'; -- set to arXiv for COinS; after that, must be set to empty string
end

if 'biorxiv' == config.CitationClass then
Periodical = 'bioRxiv'; -- set to bioRxiv for COinS; after that, must be set to empty string
end

if 'citeseerx' == config.CitationClass then
Periodical = 'CiteSeerX'; -- set to CiteSeerX for COinS; after that, must be set to empty string
end
end
end

-- handle type parameter for those CS1 citations that have default values
if in_array(config.CitationClass, {"AV-media-notes", "interview", "mailinglist", "map", "podcast", "pressrelease", "report", "techreport", "thesis"}) then
TitleType = set_titletype (config.CitationClass, TitleType);
if is_set(Degree) and "Thesis" == TitleType then -- special case for cite thesis
TitleType = Degree .. ' ' .. cfg.title_types ['thesis']:lower();
end
end

if is_set(TitleType) then -- if type parameter is specified
TitleType = substitute( cfg.messages['type'], TitleType); -- display it in parentheses
-- TODO: Hack on TitleType to fix bunched parentheses problem
end

-- legacy: 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 not is_set (Date) and 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
]]
do -- create defined block to contain local variables error_message, date_parameters_list, mismatch
local error_message = '';
-- AirDate has been promoted to Date so not necessary to check it
local date_parameters_list = {['access-date']=AccessDate, ['archive-date']=ArchiveDate, ['date']=Date, ['doi-broken-date']=DoiBroken,
['embargo']=Embargo, ['lay-date']=LayDate, ['publication-date']=PublicationDate, ['year']=Year};

anchor_year, Embargo, error_message = dates(date_parameters_list, COinS_date);
-- start temporary Julian / Gregorian calendar uncertainty categorization
if COinS_date.inter_cal_cat then
add_prop_cat ('jul_greg_uncertainty');
end
-- end temporary Julian / Gregorian calendar uncertainty categorization

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 .. '|year= / |date= mismatch';
elseif 1 == mismatch then -- |year= matches year-value in |date=
add_maint_cat ('date_year');
end
end

if not is_set(error_message) then -- error free dates only
local modified = false; -- flag

if is_set (DF) then -- if we need to reformat dates
modified = reformat_dates (date_parameters_list, DF, false); -- reformat to DF format, use long month names if appropriate
end

if true == date_hyphen_to_dash (date_parameters_list) then -- convert hyphens to dashes where appropriate
modified = true;
add_maint_cat ('date_format'); -- hyphens were converted so add maint category
end

-- for those wikis that can and want to have English date names translated to the local language,
-- uncomment these three lines. Not supported by en.wiki (for obvious reasons)
-- if date_name_xlate (date_parameters_list) then
-- modified = true;
-- end

if modified then -- if the date_parameters_list values were modified
AccessDate = date_parameters_list['access-date']; -- overwrite date holding parameters with modified values
ArchiveDate = date_parameters_list['archive-date'];
Date = date_parameters_list['date'];
DoiBroken = date_parameters_list['doi-broken-date'];
LayDate = date_parameters_list['lay-date'];
PublicationDate = date_parameters_list['publication-date'];
end
else
table.insert( z.message_tail, { set_error( 'bad_date', {error_message}, true ) } ); -- add this error message
end
end -- end of do

-- Account for the oddity that is {{cite journal}} with |pmc= set and |url= not set. Do this after date check but before COInS.
-- Here we unset Embargo if PMC not embargoed (|embargo= not set in the citation) or if the embargo time has expired. Otherwise, holds embargo date
Embargo = is_embargoed (Embargo);

if config.CitationClass == "journal" and not is_set(URL) and is_set(ID_list['PMC']) then
if not is_set (Embargo) then -- if not embargoed or embargo has expired
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=
if is_set(AccessDate) then -- access date requires |url=; pmc created url is not |url=
table.insert( z.message_tail, { set_error( 'accessdate_missing_url', {}, true ) } );
AccessDate = ''; -- unset
end

end
end

-- 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
if 'episode' == config.CitationClass then -- special case for cite episode; TODO: is there a better way to do this?
table.insert( z.message_tail, { set_error( 'citation_missing_title', {'series'}, true ) } );
else
table.insert( z.message_tail, { set_error( 'citation_missing_title', {'title'}, true ) } );
end
end

if 'none' == Title and in_array (config.CitationClass, {'journal', 'citation'}) and is_set (Periodical) and 'journal' == A:ORIGIN('Periodical') then -- special case for journal cites
Title = ''; -- set title to empty string
add_maint_cat ('untitled');
end

check_for_url ({ -- add error message when any of these parameters contains a URL
['title']=Title,
[A:ORIGIN('Chapter')]=Chapter,
[A:ORIGIN('Periodical')]=Periodical,
[A:ORIGIN('PublisherName')] = PublisherName
});

-- 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
local coins_author = a; -- default for coins rft.au
if 0 < #c then -- but if contributor list
coins_author = c; -- use that instead
end

-- this is the function call to COinS()
local OCinSoutput = COinS({
['Periodical'] = Periodical,
['Encyclopedia'] = Encyclopedia,
['Chapter'] = make_coins_title (coins_chapter, ScriptChapter), -- Chapter and ScriptChapter stripped of bold / italic wikimarkup
['Degree'] = Degree; -- cite thesis only
['Title'] = make_coins_title (coins_title, ScriptTitle), -- Title and ScriptTitle stripped of bold / italic wikimarkup
['PublicationPlace'] = PublicationPlace,
['Date'] = COinS_date.rftdate, -- COinS_date has correctly formatted date if Date is valid;
['Season'] = COinS_date.rftssn,
['Chron'] = COinS_date.rftchron or (not COinS_date.rftdate and Date) or '', -- chron but if not set and invalid date format use Date; keep this last bit?
['Series'] = Series,
['Volume'] = Volume,
['Issue'] = Issue,
['Pages'] = get_coins_pages (first_set ({Sheet, Sheets, Page, Pages, At}, 5)), -- pages stripped of external links
['Edition'] = Edition,
['PublisherName'] = PublisherName,
['URL'] = first_set ({ChapterURL, URL}, 2),
['Authors'] = coins_author,
['ID_list'] = ID_list,
['RawPage'] = this_page.prefixedText,
}, config.CitationClass);

-- Account for the oddities that are {{cite arxiv}}, {{cite biorxiv}}, and {{cite citeseerx}} AFTER generation of COinS data.
if in_array (config.CitationClass, {'arxiv', 'biorxiv', 'citeseerx'}) then -- we have set rft.jtitle in COinS to arXiv, bioRxiv, or CiteSeerX now unset so it isn't displayed
Periodical = ''; -- periodical not allowed in these templates; if article has been published, use cite journal
end

-- 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 = substitute (cfg.messages['newsgroup'], external_link( 'news:' .. PublisherName, PublisherName, A:ORIGIN('PublisherName'), nil ));
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.
local EditorCount; -- used only for choosing {ed.) or (eds.) annotation at end of editor name-list
do
local last_first_list;
local control = {
format = NameListFormat, -- empty string or 'vanc'
maximum = nil, -- as if display-authors or display-editors not set
lastauthoramp = LastAuthorAmp,
page_name = this_page.text, -- get current page name so that we don't wikilink to it via editorlinkn
mode = Mode
};

do -- do editor name list first because the now unsupported coauthors used to modify control table
control.maximum , editor_etal = get_display_authors_editors (A['DisplayEditors'], #e, 'editors', editor_etal);
last_first_list, EditorCount = list_people(control, e, editor_etal);

if is_set (Editors) then
if editor_etal then
Editors = Editors .. ' ' .. cfg.messages['et al']; -- add et al. to editors parameter beause |display-editors=etal
EditorCount = 2; -- with et al., |editors= is multiple names; spoof to display (eds.) annotation
else
EditorCount = 2; -- we don't know but assume |editors= is multiple names; spoof to display (eds.) annotation
end
else
Editors = last_first_list; -- either an author name list or an empty string
end

if 1 == EditorCount and (true == editor_etal or 1 < #e) then -- only one editor displayed but includes etal then
EditorCount = 2; -- spoof to display (eds.) annotation
end
end
do -- now do interviewers
control.maximum = #interviewers_list; -- number of interviewerss
Interviewers = list_people(control, interviewers_list, false); -- et al not currently supported
end
do -- now do translators
control.maximum = #t; -- number of translators
Translators = list_people(control, t, false); -- et al not currently supported
end
do -- now do contributors
control.maximum = #c; -- number of contributors
Contributors = list_people(control, c, false); -- et al not currently supported
end
do -- now do authors
control.maximum , author_etal = get_display_authors_editors (A['DisplayAuthors'], #a, 'authors', author_etal);

last_first_list = list_people(control, a, author_etal);

if is_set (Authors) then
Authors, author_etal = name_has_etal (Authors, author_etal, false); -- find and remove variations on et al.
if author_etal then
Authors = Authors .. ' ' .. cfg.messages['et al']; -- add et al. to authors parameter
end
else
Authors = last_first_list; -- either an author name list or an empty string
end
end -- end of do

if is_set (Authors) and is_set (Collaboration) then
Authors = Authors .. ' (' .. Collaboration .. ')'; -- add collaboration after et al.
end

end

-- apply |[xx-]format= styling; at the end, these parameters hold correctly styled format annotation,
-- an error message if the associated url is not set, or an empty string for concatenation
ArchiveFormat = style_format (ArchiveFormat, ArchiveURL, 'archive-format', 'archive-url');
ConferenceFormat = style_format (ConferenceFormat, ConferenceURL, 'conference-format', 'conference-url');
Format = style_format (Format, URL, 'format', 'url');
LayFormat = style_format (LayFormat, LayURL, 'lay-format', 'lay-url');
TranscriptFormat = style_format (TranscriptFormat, TranscriptURL, 'transcript-format', 'transcripturl');

-- special case for chapter format so no error message or cat when chapter not supported
if not (in_array(config.CitationClass, {'web', 'news', 'journal', 'magazine', 'pressrelease', 'podcast', 'newsgroup', 'arxiv', 'biorxiv', 'citeseerx'}) or
('citation' == config.CitationClass and is_set (Periodical) and not is_set (Encyclopedia))) then
ChapterFormat = style_format (ChapterFormat, ChapterURL, 'chapter-format', 'chapter-url');
end

if not is_set(URL) then
if in_array(config.CitationClass, {"web","podcast", "mailinglist"}) then -- |url= required for cite web, cite podcast, and cite mailinglist
table.insert( z.message_tail, { set_error( 'cite_web_url', {}, true ) } );
end

-- do we have |accessdate= without either |url= or |chapter-url=?
if is_set(AccessDate) and not is_set(ChapterURL)then -- ChapterURL may be set when URL is not set;
table.insert( z.message_tail, { set_error( 'accessdate_missing_url', {}, true ) } );
AccessDate = '';
end
end

local OriginalURL, OriginalURLorigin, OriginalFormat, OriginalAccess;
DeadURL = DeadURL:lower(); -- used later when assembling archived text
if is_set( ArchiveURL ) then
if 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
OriginalURLorigin = ChapterURLorigin; -- name of chapter-url parameter for error messages
OriginalFormat = ChapterFormat; -- and original |format=
if 'no' ~= DeadURL then
ChapterURL = ArchiveURL -- swap-in the archive's url
ChapterURLorigin = A:ORIGIN('ArchiveURL') -- name of archive-url parameter for error messages
ChapterFormat = ArchiveFormat or ''; -- swap in archive's format
end
elseif is_set (URL) then
OriginalURL = URL; -- save copy of original source URL
OriginalURLorigin = URLorigin; -- name of url parameter for error messages
OriginalFormat = Format; -- and original |format=
OriginalAccess = UrlAccess;
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
Format = ArchiveFormat or ''; -- swap in archive's format
UrlAccess = nil; -- restricted access levels do not make sense for archived urls
end
end
end

if in_array(config.CitationClass, {'web','news','journal', 'magazine', 'pressrelease', 'podcast', 'newsgroup', 'arxiv', 'biorxiv', 'citeseerx'}) or -- if any of the 'periodical' cites except encyclopedia
('citation' == config.CitationClass and is_set (Periodical) and not is_set (Encyclopedia)) then
local chap_param;
if is_set (Chapter) then -- get a parameter name from one of these chapter related meta-parameters
chap_param = A:ORIGIN ('Chapter')
elseif is_set (TransChapter) then
chap_param = A:ORIGIN ('TransChapter')
elseif is_set (ChapterURL) then
chap_param = A:ORIGIN ('ChapterURL')
elseif is_set (ScriptChapter) then
chap_param = A:ORIGIN ('ScriptChapter')
else is_set (ChapterFormat)
chap_param = A:ORIGIN ('ChapterFormat')
end

if is_set (chap_param) then -- if we found one
table.insert( z.message_tail, { set_error( 'chapter_ignored', {chap_param}, true ) } ); -- add error message
Chapter = ''; -- and set them to empty string to be safe with concatenation
TransChapter = '';
ChapterURL = '';
ScriptChapter = '';
ChapterFormat = '';
end
else -- otherwise, format chapter / article title
local no_quotes = false; -- default assume that we will be quoting the chapter parameter value
if is_set (Contribution) and 0 < #c then -- if this is a contribution with contributor(s)
if in_array (Contribution:lower(), cfg.keywords.contribution) then -- and a generic contribution title
no_quotes = true; -- then render it unquoted
end
end

Chapter = format_chapter_title (ScriptChapter, Chapter, TransChapter, ChapterURL, ChapterURLorigin, no_quotes, ChapterUrlAccess); -- Contribution is also in Chapter
if is_set (Chapter) then
Chapter = Chapter .. ChapterFormat ;
if 'map' == config.CitationClass and is_set (TitleType) then
Chapter = Chapter .. ' ' .. TitleType; -- map annotation here; not after title
end
Chapter = Chapter.. sepc .. ' ';
elseif is_set (ChapterFormat) then -- |chapter= not set but |chapter-format= is so ...
Chapter = ChapterFormat .. sepc .. ' '; -- ... ChapterFormat has error message, we want to see it
end
end

-- Format main title.
if '...' == Title:sub (-3) then -- if elipsis is the last three characters of |title=
Title = mw.ustring.gsub (Title, '(%.%.%.)%.+$', '%1'); -- limit the number of dots to three
elseif not mw.ustring.find (Title, '%.%s*%a%.') then -- end of title is not a 'dot-(optional space-)letter-dot' initialism
Title = mw.ustring.gsub(Title, '%'..sepc..'$', ''); -- remove any trailing separator character
end
if is_set(TitleLink) and is_set(Title) then
Title = make_wikilink (TitleLink, Title);
end

if in_array(config.CitationClass, {'web', 'news', 'journal', 'magazine', 'pressrelease', 'podcast', 'newsgroup', 'mailinglist', 'interview', 'arxiv', 'biorxiv', 'citeseerx'}) 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

local TransError = "";
if is_set(TransTitle) then
if is_set(Title) then
TransTitle = " " .. TransTitle;
else
TransError = " " .. set_error( 'trans_missing_title', {'title'} );
end
end

if is_set(Title) then
if not is_set(TitleLink) and is_set(URL) then

Title = external_link( URL, Title, URLorigin, UrlAccess ) .. TransTitle .. TransError .. Format;
URL = ''; -- unset these because no longer needed
Format = "";
else
Title = Title .. TransTitle .. TransError;
end
else
Title = TransTitle .. TransError;
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 = external_link( ConferenceURL, Conference, ConferenceURLorigin, nil );
end
Conference = sepc .. " " .. Conference .. ConferenceFormat;
elseif is_set(ConferenceURL) then
Conference = sepc .. " " .. external_link( ConferenceURL, nil, ConferenceURLorigin, nil );
end

if not is_set(Position) then
local Minutes = A['Minutes'];
local Time = A['Time'];

if is_set(Minutes) then
if is_set (Time) then
table.insert( z.message_tail, { set_error( 'redundant_parameters', {wrap_style ('parameter', 'minutes') .. ' and ' .. wrap_style ('parameter', 'time')}, true ) } );
end
Position = " " .. Minutes .. " " .. cfg.messages['minutes'];
else
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

Page, Pages, Sheet, Sheets = format_pages_sheets (Page, Pages, Sheet, Sheets, config.CitationClass, Periodical_origin, sepc, NoPP, use_lowercase);

At = is_set(At) and (sepc .. " " .. At) or "";
Position = is_set(Position) and (sepc .. " " .. Position) or "";
if config.CitationClass == 'map' then
local Section = A['Section'];
local Sections = A['Sections'];
local Inset = A['Inset'];

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
At = At .. Inset .. Section;
end

if is_set (Language) then
Language = language_parameter (Language); -- format, categories, name from ISO639-1, etc
else
Language=""; -- language not specified so make sure this is an empty string;
--[[ TODO: need to extract the wrap_msg from language_parameter
so that we can solve parentheses bunching problem with Format/Language/TitleType
]]
end

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

if is_set (Translators) then
Others = sepc .. ' ' .. wrap_msg ('translated', Translators, use_lowercase) .. Others;
end
if is_set (Interviewers) then
Others = sepc .. ' ' .. wrap_msg ('interview', Interviewers, use_lowercase) .. Others;
end

TitleNote = is_set(TitleNote) and (sepc .. " " .. TitleNote) or "";
if is_set (Edition) then
if Edition:match ('%f[%a][Ee]d%.?$') or Edition:match ('%f[%a][Ee]dition$') then
add_maint_cat ('extra_text', 'edition');
end
Edition = " " .. wrap_msg ('edition', Edition);
else
Edition = '';
end

Series = is_set(Series) and (sepc .. " " .. Series) or "";
OrigYear = is_set(OrigYear) and (" [" .. OrigYear .. "]") or ""; -- TODO: presentation

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

Volume = format_volume_issue (Volume, Issue, config.CitationClass, Periodical_origin, sepc, use_lowercase);

------------------------------------ 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
else
SubscriptionRequired = ''; -- either or both might be set to something other than yes true y
end

if is_set(AccessDate) then
local retrv_text = " " .. cfg.messages['retrieved']

AccessDate = nowrap_date (AccessDate); -- wrap in nowrap span if date in appropriate format
if (sepc ~= ".") then retrv_text = retrv_text:lower() end -- if mode is cs2, lower case
AccessDate = substitute (retrv_text, AccessDate); -- add retrieved text

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
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, {IdAccessLevels=ID_access_levels, DoiBroken = DoiBroken, ASINTLD = ASINTLD, IgnoreISBN = IgnoreISBN, Embargo=Embargo, Class = Class} );

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

if is_set(Quote) then
if Quote:sub(1,1) == '"' and Quote:sub(-1,-1) == '"' then -- if first and last characters of quote are quote marks
Quote = Quote:sub(2,-2); -- strip them off
end
Quote = sepc .." " .. wrap_style ('quoted-text', Quote ); -- wrap in <q>...</q> tags
PostScript = ""; -- cs1|2 does not supply terminal punctuation when |quote= is set
end

local Archived
if is_set(ArchiveURL) then
if not is_set(ArchiveDate) then
ArchiveDate = set_error('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'],
{ external_link( ArchiveURL, arch_text, A:ORIGIN('ArchiveURL'), nil ) .. ArchiveFormat, ArchiveDate } );
if not is_set(OriginalURL) then
Archived = Archived .. " " .. set_error('archive_missing_url');
end
elseif is_set(OriginalURL) then -- DeadURL is empty, 'yes', 'true', 'y', 'unfit', 'usurped'
local arch_text = cfg.messages['archived-dead'];
if sepc ~= "." then arch_text = arch_text:lower() end
if in_array (DeadURL, {'unfit', 'usurped', 'bot: unknown'}) then
Archived = sepc .. " " .. 'Archived from the original on ' .. ArchiveDate; -- format already styled
if 'bot: unknown' == DeadURL then
add_maint_cat ('bot:_unknown'); -- and add a category if not already added
else
add_maint_cat ('unfit'); -- and add a category if not already added
end
else -- DeadURL is empty, 'yes', 'true', or 'y'
Archived = sepc .. " " .. substitute( arch_text,
{ external_link( OriginalURL, cfg.messages['original'], OriginalURLorigin, OriginalAccess ) .. OriginalFormat, ArchiveDate } ); -- format already styled
end
else
local arch_text = cfg.messages['archived-missing'];
if sepc ~= "." then arch_text = arch_text:lower() end
Archived = sepc .. " " .. substitute( arch_text,
{ set_error('archive_missing_url'), ArchiveDate } );
end
elseif is_set (ArchiveFormat) then
Archived = ArchiveFormat; -- if set and ArchiveURL not set ArchiveFormat has error message
else
Archived = ""
end

local Lay = '';
if is_set(LayURL) then
if is_set(LayDate) then LayDate = " (" .. LayDate .. ")" end
if is_set(LaySource) then
LaySource = " – ''" .. safe_for_italics(LaySource) .. "''";
else
LaySource = "";
end
if sepc == '.' then
Lay = sepc .. " " .. external_link( LayURL, cfg.messages['lay summary'], A:ORIGIN('LayURL'), nil ) .. LayFormat .. LaySource .. LayDate
else
Lay = sepc .. " " .. external_link( LayURL, cfg.messages['lay summary']:lower(), A:ORIGIN('LayURL'), nil ) .. LayFormat .. LaySource .. LayDate
end
elseif is_set (LayFormat) then -- Test if |lay-format= is given without giving a |lay-url=
Lay = sepc .. LayFormat; -- if set and LayURL not set, then LayFormat has error message
end

if is_set(Transcript) then
if is_set(TranscriptURL) then
Transcript = external_link( TranscriptURL, Transcript, TranscriptURLorigin, nil );
end
Transcript = sepc .. ' ' .. Transcript .. TranscriptFormat;
elseif is_set(TranscriptURL) then
Transcript = external_link( TranscriptURL, nil, TranscriptURLorigin, nil );
end

local Publisher;
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

-- 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)
else
Periodical = wrap_style ('italic-title', Periodical)
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;
local tcommon2; -- used for book cite when |contributor= is set

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}, sepc );
elseif in_array(config.CitationClass, {"book","citation"}) and not is_set(Periodical) then -- special cases for book cites
if is_set (Contributors) then -- when we are citing foreword, preface, introduction, etc
tcommon = safe_join( {Title, TitleNote}, sepc ); -- author and other stuff will come after this and before tcommon2
tcommon2 = safe_join( {Conference, Periodical, Format, TitleType, Series, Language, Volume, Others, Edition, Publisher, Agency}, sepc );
else
tcommon = safe_join( {Title, TitleNote, Conference, Periodical, Format, TitleType, Series, Language, Volume, Others, Edition, Publisher, Agency}, sepc );
end

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}, sepc );
else -- a sheet or stand-alone map
tcommon = safe_join( {Title, TitleType, Format, Edition, Scale, Series, Language, Cartography, Others, Publisher}, sepc );
end

elseif 'episode' == config.CitationClass then -- special case for cite episode
tcommon = safe_join( {Title, TitleNote, TitleType, Series, Transcript, Language, Edition, Publisher}, sepc );

else -- all other CS1 templates
tcommon = safe_join( {Title, TitleNote, Conference, Periodical, Format, TitleType, Series, Language,
Volume, 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 .. Sheet .. Sheets .. Page .. Pages .. At;

if is_set(Date) then
if is_set (Authors) or is_set (Editors) then -- date follows authors or editors when authors not set
Date = " (" .. Date ..")" .. OrigYear .. sepc .. " "; -- in paranetheses
else -- neither of authors and editors set
if (string.sub(tcommon,-1,-1) == sepc) then -- if the last character of tcommon is sepc
Date = " " .. Date .. OrigYear; -- Date does not begin with sepc
else
Date = sepc .. " " .. Date .. OrigYear; -- Date begins with sepc
end
end
end
if is_set(Authors) then
if (not is_set (Date)) then -- when date is set it's in parentheses; no Authors termination
Authors = terminate_name_list (Authors, sepc); -- when no date, terminate with 0 or 1 sepc and a space
end
if is_set(Editors) then
local in_text = " ";
local post_text = "";
if is_set(Chapter) and 0 == #c then
in_text = in_text .. cfg.messages['in'] .. " "
if (sepc ~= '.') then
in_text = in_text:lower() -- lowercase for cs2
end
else
if EditorCount <= 1 then
post_text = ", " .. cfg.messages['editor'];
else
post_text = ", " .. cfg.messages['editors'];
end
end
Editors = terminate_name_list (in_text .. Editors .. post_text, sepc); -- terminate with 0 or 1 sepc and a space
end
if is_set (Contributors) then -- book cite and we're citing the intro, preface, etc
local by_text = sepc .. ' ' .. cfg.messages['by'] .. ' ';
if (sepc ~= '.') then by_text = by_text:lower() end -- lowercase for cs2
Authors = by_text .. Authors; -- author follows title so tweak it here
if is_set (Editors) and is_set (Date) then -- when Editors make sure that Authors gets terminated
Authors = terminate_name_list (Authors, sepc); -- terminate with 0 or 1 sepc and a space
end
if (not is_set (Date)) then -- when date is set it's in parentheses; no Contributors termination
Contributors = terminate_name_list (Contributors, sepc); -- terminate with 0 or 1 sepc and a space
end
text = safe_join( {Contributors, Date, Chapter, tcommon, Authors, Place, Editors, tcommon2, pgtext, idcommon }, sepc );
else
text = safe_join( {Authors, Date, Chapter, Place, Editors, tcommon, pgtext, idcommon }, sepc );
end
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
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, pgtext, idcommon}, sepc );
else
if in_array(config.CitationClass, {"journal","citation"}) and is_set(Periodical) then
text = safe_join( {Chapter, Place, tcommon, pgtext, Date, idcommon}, sepc );
else
text = safe_join( {Chapter, Place, tcommon, Date, 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 <cite/> element
local options = {};

if is_set(config.CitationClass) and config.CitationClass ~= "citation" then
options.class = config.CitationClass;
options.class = "citation " .. config.CitationClass; -- class=citation required for blue highlight when used with |ref=
else
options.class = "citation";
end

if is_set(Ref) and Ref:lower() ~= "none" then -- set reference anchor if appropriate
local id = Ref
if ('harv' == Ref ) then
local namelist = {}; -- holds selected contributor, author, editor name list
local year = first_set ({Year, anchor_year}, 2); -- Year first for legacy citations and for YMD dates that require disambiguation

if #c > 0 then -- if there is a contributor list
namelist = c; -- select it
elseif #a > 0 then -- or an author list
namelist = a;
elseif #e > 0 then -- or an editor list
namelist = e;
end
if #namelist > 0 then -- if there are names in namelist
id = anchor_id (namelist, year); -- go make the CITEREF anchor
else
id = ''; -- unset
end
end
options.id = id;
end

if string.len(text:gsub("<span[^>/]*>(.-)", "%1"):gsub("%b<>","")) <= 2 then -- remove tags and other html-like markup; then get length of what remains
z.error_categories = {};
text = set_error('empty_citation');
z.message_tail = {};
end

local render = {}; -- here we collect the final bits for concatenation into the rendered citation

if is_set(options.id) then -- here we wrap the rendered citation in <cite ...>...</cite> tags
table.insert (render, substitute (cfg.presentation['cite-id'], {mw.uri.anchorEncode(options.id), mw.text.nowiki(options.class), text})); -- when |ref= is set
else
table.insert (render, substitute (cfg.presentation['cite'], {mw.text.nowiki(options.class), text})); -- all other cases
end

table.insert (render, substitute (cfg.presentation['ocins'], {OCinSoutput})); -- append metadata to the citation

if #z.message_tail ~= 0 then
table.insert (render, ' ');
for i,v in ipairs( z.message_tail ) do
if is_set(v[1]) then
if i == #z.message_tail then
table.insert (render, error_comment( v[1], v[2] ));
else
table.insert (render, error_comment( v[1] .. "; ", v[2] ));
end
end
end
end

if #z.maintenance_cats ~= 0 then
table.insert (render, '');
for _, v in ipairs( z.maintenance_cats ) do -- append maintenance categories
table.insert (render, v);
table.insert (render, ' (');
table.insert (render, make_wikilink (':Category:' .. v, 'link'));
table.insert (render, ') ');
end
table.insert (render, '');
end

no_tracking_cats = no_tracking_cats:lower();
if in_array(no_tracking_cats, {"", "no", "false", "n"}) then
for _, v in ipairs( z.error_categories ) do
table.insert (render, make_wikilink ('Category:' .. v));
end
for _, v in ipairs( z.maintenance_cats ) do -- append maintenance categories
table.insert (render, make_wikilink ('Category:' .. v));
end
for _, v in ipairs( z.properties_cats ) do -- append properties categories
table.insert (render, make_wikilink ('Category:' .. v));
end
end

return table.concat (render);
end

--[[--------------------------< C S 1 . C I T A T I O N >------------------------------------------------------

This is used by templates such as {{cite book}} to create the actual citation text.

]]

function cs1.citation(frame)
Frame = frame; -- save a copy incase we need to display an error message in preview mode
local pframe = frame:getParent()
local validation, utilities, identifiers, metadata;

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 support modules
whitelist = mw.loadData ('Module:Citation/CS1/Whitelist/sandbox');
utilities = require ('Module:Citation/CS1/Utilities/sandbox');
validation = require ('Module:Citation/CS1/Date_validation/sandbox');
identifiers = require ('Module:Citation/CS1/Identifiers/sandbox');
metadata = require ('Module:Citation/CS1/COinS/sandbox');

else -- otherwise
cfg = mw.loadData ('Module:Citation/CS1/Configuration'); -- load live versions of support modules
whitelist = mw.loadData ('Module:Citation/CS1/Whitelist');
utilities = require ('Module:Citation/CS1/Utilities');
validation = require ('Module:Citation/CS1/Date_validation');
identifiers = require ('Module:Citation/CS1/Identifiers');
metadata = require ('Module:Citation/CS1/COinS');
end

utilities.set_selected_modules (cfg); -- so that functions in Utilities can see the cfg tables
identifiers.set_selected_modules (cfg, utilities); -- so that functions in Identifiers can see the selected cfg tables and selected Utilities module
validation.set_selected_modules (cfg, utilities); -- so that functions in Date validataion can see selected cfg tables and the selected Utilities module
metadata.set_selected_modules (cfg, utilities); -- so that functions in COinS can see the selected cfg tables and selected Utilities module

dates = validation.dates; -- imported functions from Module:Citation/CS1/Date validation
year_date_check = validation.year_date_check;
reformat_dates = validation.reformat_dates;
date_hyphen_to_dash = validation.date_hyphen_to_dash;
date_name_xlate = validation.date_name_xlate;

is_set = utilities.is_set; -- imported functions from Module:Citation/CS1/Utilities
in_array = utilities.in_array;
substitute = utilities.substitute;
error_comment = utilities.error_comment;
set_error = utilities.set_error;
select_one = utilities.select_one;
add_maint_cat = utilities.add_maint_cat;
wrap_style = utilities.wrap_style;
safe_for_italics = utilities.safe_for_italics;
is_wikilink = utilities.is_wikilink;
make_wikilink = utilities.make_wikilink;

z = utilities.z; -- table of error and category tables in Module:Citation/CS1/Utilities

extract_ids = identifiers.extract_ids; -- imported functions from Module:Citation/CS1/Identifiers
build_id_list = identifiers.build_id_list;
is_embargoed = identifiers.is_embargoed;
extract_id_access_levels = identifiers.extract_id_access_levels;

make_coins_title = metadata.make_coins_title; -- imported functions from Module:Citation/CS1/COinS
get_coins_pages = metadata.get_coins_pages;
COinS = metadata.COinS;

local args = {}; -- table where we store all of the template's arguments
local suggestions = {}; -- table where we store suggestions if we need to loadData them
local error_text, error_state;

local config = {}; -- table to store parameters from the module {{#invoke:}}
for k, v in pairs( frame.args ) do
config[k] = v;
-- args[k] = v; -- debug tool that allows us to render a citation from module {{#invoke:}}
end

local capture; -- the single supported capture when matching unknown parameters using patterns
for k, v in pairs( pframe.args ) do
if v ~= '' then
if not validate( k, config.CitationClass ) then
error_text = "";
if type( k ) ~= 'string' then
-- Exclude empty numbered parameters
if v:match("%S+") ~= nil then
error_text, error_state = set_error( 'text_ignored', {v}, true );
end
elseif validate( k:lower(), config.CitationClass ) then
error_text, error_state = set_error( 'parameter_ignored_suggest', {k, k:lower()}, true );
else
if nil == suggestions.suggestions then -- if this table is nil then we need to load it
if nil ~= string.find (frame:getTitle(), 'sandbox', 1, true) then -- did the {{#invoke:}} use sandbox version?
suggestions = mw.loadData( 'Module:Citation/CS1/Suggestions/sandbox' ); -- use the sandbox version
else
suggestions = mw.loadData( 'Module:Citation/CS1/Suggestions' ); -- use the live version
end
end
for pattern, param in pairs (suggestions.patterns) do -- loop through the patterns to see if we can suggest a proper parameter
capture = k:match (pattern); -- the whole match if no caputre in pattern else the capture if a match
if capture then -- if the pattern matches
param = substitute( param, capture ); -- add the capture to the suggested parameter (typically the enumerator)
error_text, error_state = set_error( 'parameter_ignored_suggest', {k, param}, true ); -- set the error message
end
end
if not is_set (error_text) then -- couldn't match with a pattern, is there an expicit suggestion?
if suggestions.suggestions[ k:lower() ] ~= nil then
error_text, error_state = set_error( 'parameter_ignored_suggest', {k, suggestions.suggestions[ k:lower() ]}, true );
else
error_text, error_state = set_error( 'parameter_ignored', {k}, true );
v = ''; -- unset value assigned to unrecognized parameters (this for the limited parameter lists)
end
end
end
if error_text ~= '' then
table.insert( z.message_tail, {error_text, error_state} );
end
end
missing_pipe_check (v); -- do we think that there is a parameter that is missing a pipe?

args[k] = v;
elseif args[k] ~= nil or (k == 'postscript') then
args[k] = v;
end
end

for k, v in pairs( args ) do
if 'string' == type (k) then -- don't evaluate positional parameters
has_invisible_chars (k, v);
end
end
return citation0( config, args)
end

return cs1;

Module:Check for unknown parameters

2018-04-07T11:49:50Z

Max: 1 revision imported

-- This module may be used to compare the arguments passed to the parent
-- with a list of arguments, returning a specified result if an argument is
-- not on the list
local p = {}

local function trim(s)
return s:match('^%s*(.-)%s*$')
end

local function isnotempty(s)
return s and trim(s) ~= ''
end

function p.check (frame)
local args = frame.args
local pargs = frame:getParent().args
local ignoreblank = isnotempty(frame.args['ignoreblank'])
local showblankpos = isnotempty(frame.args['showblankpositional'])
local knownargs = {}
local unknown = frame.args['unknown'] or 'Found _VALUE_, '
local preview = frame.args['preview']

local values = {}
local res = {}
local regexps = {}

-- create the list of known args, regular expressions, and the return string
for k, v in pairs(args) do
if type(k) == 'number' then
v = trim(v)
knownargs[v] = 1
elseif k:find('^regexp[1-9][0-9]*$') then
table.insert(regexps, '^' .. v .. '$')
end
end
if isnotempty(preview) then
preview = '<div class="hatnote" style="color:red">Warning: ' .. preview .. ' (this message is shown only in preview).</div>'
elseif preview == nil then
preview = unknown
end

-- loop over the parent args, and make sure they are on the list
for k, v in pairs(pargs) do
if type(k) == 'string' and knownargs[k] == nil then
local knownflag = false
for i, regexp in ipairs(regexps) do
if mw.ustring.match(k, regexp) then
knownflag = true
break
end
end
if not knownflag and ( not ignoreblank or isnotempty(v) ) then
k = mw.ustring.gsub(k, '[^%w\-_ ]', '?')
table.insert(values, k)
end
elseif type(k) == 'number' and
knownargs[tostring(k)] == nil and
( showblankpos or isnotempty(v) )
then
local vlen = mw.ustring.len(v)
v = mw.ustring.sub(v, 1, (vlen < 25) and vlen or 25)
v = mw.ustring.gsub(v, '[^%w\-_ ]', '?')
table.insert(values, k .. ' = ' .. v .. ((vlen >= 25) and ' ...' or ''))
end
end

-- add resuls to the output tables
if #values > 0 then
if frame:preprocess( "{{REVISIONID}}" ) == "" then
unknown = preview
end
for k, v in pairs(values) do
if v == '' then
-- Fix odd bug for | = which gets stripped to the empty string and
-- breaks category links
v = ' '
end
local r = unknown:gsub('_VALUE_', v)
table.insert(res, r)
end
end

return table.concat(res)
end

return p

Module:Anchor

2018-04-07T11:49:49Z

Max: 1 revision imported

-- This module implements {{anchor}}.

local getArgs = require('Module:Arguments').getArgs
local tableTools = require('Module:TableTools')

local p = {}

function p.main(frame)
-- Get the positional arguments from #invoke, remove any nil values,
-- and pass them to p._main.
local args = getArgs(frame)
local argArray = tableTools.compressSparseArray(args)
return p._main(unpack(argArray))
end

function p._main(...)
-- Generate the list of anchors.
local anchors = {...}
local ret = {}
for _, anchor in ipairs(anchors) do
ret[#ret + 1] = ''
end
return table.concat(ret)
end

return p

Template:Yes

2018-04-07T11:49:49Z

Max: 1 revision imported

<noinclude>{{Tfm/dated|page=Yes|otherpage=Available|link=Wikipedia:Templates for discussion/Log/2018 April 5#Template:Yes|bigbox={{#invoke:Noinclude|noinclude|text=yes}}}}</noinclude><noinclude>
{| class="wikitable"
|-
|</noinclude>style="background:#9F9;vertical-align:middle;text-align:{{{align|center}}};{{{style|}}}" class="table-yes"|{{{1|Yes}}}<noinclude>
|}
{{documentation}}
</noinclude>

Template:Unbulleted list

2018-04-07T11:49:49Z

Max: 1 revision imported

{{<includeonly>safesubst:</includeonly>#invoke:list|unbulleted}}<noinclude>
{{documentation}}

</noinclude>

Template:Tnull

2018-04-07T11:49:48Z

Max: 1 revision imported

<code>{{{{#if:{{{1|}}}|{{{1}}}| tnull|...}}{{#if:{{{2|}}}||{{{2}}}|}}{{#if:{{{3|}}}||{{{3}}}|}}{{#if:{{{4|}}}||{{{4}}}|}}{{#if:{{{5|}}}||{{{5}}}|}}{{#if:{{{6|}}}||{{{6}}}|}}{{#if:{{{7|}}}||{{{7}}}|}}{{#if:{{{8|}}}||{{{8}}}|}}{{#if:{{{9|}}}||{{{9}}}|}}{{#if:{{{10|}}}||{{{10}}}|}}{{#if:{{{11|}}}||{{{11}}}|}}}}</code><noinclude>
{{documentation}}</noinclude>