Module:Citation/CS1: Difference between revisions

 

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

 

 

 

 

 

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

local whitelist = {}; -- table of tables listing valid template parameter names; defined in Module:Citation/CS1/Whitelist

 

 

 

 

]]

 

local Frame; -- holds the module's frame table

 

 

local i = 1;

while i <= count do -- loop through all items in list

return list[i]; -- return the first set list member

end

end

 

 

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

To prevent duplication, added_vanc_errs is nil until an error message is emitted.

 

 

]]

 

end

 

--[[--------------------------< I S _ S C H E M E >------------------------------------------------------------

 

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

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

 

the first and last characters the name may use letters, digits, and the hyphen.

 

Also allowed are IPv4 addresses. IPv6 not supported

 

 

There are several tests:

the first character of the whole domain name including subdomains must be a letter or a digit

q, x, and z SL domains in the .com TLD

i and q SL domains in the .net TLD

IPv4 dot-decimal address format; TLD not allowed

 

 

]=]

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

return false;

end

return false;

end

end

 

--[[--------------------------< I S _ U R L >------------------------------------------------------------------

 

 

This function is the last step in the validation process. This function is separate because there are cases that

 

local function is_url (scheme, domain)

return is_scheme (scheme) and is_domain_name (domain);

else

end

end

--[[--------------------------< S P L I T _ U R L >------------------------------------------------------------

 

 

 

 

or more '/' characters immediately following the scheme's colon), make sure that there are only 2.

 

Strip off any port and path;

url_str = url_str:gsub ('([%a%d])%.?[/%?#].*$', '%1'); -- strip FQDN terminator and path(/), query(?), fragment (#) (the capture prevents false replacement of '//')

 

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

end

domain = domain:gsub ('(%a):%d+', '%1'); -- strip port number if present

--[[--------------------------< L I N K _ P A R A M _ O K >---------------------------------------------------

 

 

# < > [ ] | { } _

 

returns false when the value contains any of these characters.

 

 

]]

end

 

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.

 

that condition exists

 

]]

 

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

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

 

end

end

 

Determines whether a URL string appears to be valid.

 

 

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 )

return false;

end

local scheme, domain;

 

if 'news:' == scheme then -- special case for newsgroups

end

end

 

 

Return true if a parameter value has a string that begins and ends with square brackets [ and ] and the first

 

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 scheme, domain;

 

scheme, domain = split_url (value:match ('%f[%[]%[(%a%S*:%S+).*%]'));

scheme, domain = split_url (value:match ('%f[%[]%[(//%S+).*%]'));

scheme, domain = split_url (value:match ('(%a%S*:%S+)'));

scheme, domain = split_url (value:match ('(//%S+)')); -- what is left should be the domain

else

end

 

end

 

]]

 

for k, v in pairs (parameter_list) do -- for each parameter in the list

end

end

end

local function safe_for_url( str )

if str:match( "%[%[.-%]%]" ) ~= nil then

end

['\n'] = ' ' } );

end

 

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

]]

 

local domain;

local path;

local base_url;

label = URL;

else

end

end

end

if path then -- if there is a path portion

end

 

 

end

end

 

parameters in the citation.

 

 

]]

if not added_deprecated_cat then

added_deprecated_cat = true; -- note that we've added this category

end

end

 

 

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)

 

 

 

 

local function kern_quotes (str)

 

end

return str;

end

 

--[[--------------------------< F O R M A T _ S C R I P T _ V A L U E >----------------------------------------

 

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.

 

 

|script-title=ja:*** *** (where * represents a Japanese character)

Spaces between the two-character code and the colon and the colon and the first script character are allowed:

Spaces preceding the prefix are allowed: |script-title = ja:*** ***

 

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.

 

 

]]

 

local lang=''; -- initialize to empty string

local name;

return ''; -- script_value was just the prefix so return empty string

end

-- if we get this far we have prefix and script

-- is prefix one of these language codes?

else

end

lang = ' lang="' .. lang .. '" '; -- convert prefix into a lang attribute

else

lang = ''; -- invalid so set lang to empty string

end

end

 

return script_value;

end

 

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

 

]]

 

title = title .. ' ' .. script; -- concatenate title and script title

end

 

local function wrap_msg (key, str, lower)

return "";

end

local msg;

msg = cfg.messages[key]:lower(); -- set the message to lower case before

else

end

end

 

 

 

 

]]

 

chapter = ''; -- to be safe for concatenation

else

if false == no_quotes then

end

end

 

 

end

 

end

 

end

 

 

 

 

 

 

 

]]

local function has_invisible_chars (param, v)

local position = ''; -- position of invisible char or starting position of stripmarker

local capture; -- used by stripmarker detection to hold name of the stripmarker

return;

end

 

if position then

position = nil; -- unset

else

local err_msg;

else

end

 

return; -- and done with this parameter

end

end

end

end

 

 

 

 

]]

 

local origin = {};

return setmetatable({

return origin[k];

end

if type( list ) == 'table' then

if origin[k] == nil then

end

elseif list ~= nil then

-- maybe let through instead of raising an error?

-- v, origin[k] = args[k], k;

end

-- Empty strings, not nil;

if v == nil then

origin[k] = '';

end

end

 

 

 

 

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

 

local function nowrap_date (date)

 

if date:match("^%d%d%d%d%-%d%d%-%d%d$") then

elseif date:match("^%a+%s*%d%d?,%s+%d%d%d%d$") or date:match ("^%d%d?%s*%a+%s+%d%d%d%d$") then

cap, cap2 = string.match (date, "^(.*)%s+(%d%d%d%d)$");

end

end

 

 

 

]]

 

local function set_titletype (cite_class, title_type)

end

return title_type; -- if |type= has been set to any other value use that value

 

 

 

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

 

local function safe_join( tbl, duplicate_char )

local str = ''; -- the output string

local comp = ''; -- what does 'comp' mean?

str = value; -- assign value to it (first time through the loop)

elseif value ~= '' then

else

comp = value;

end

-- typically duplicate_char is sepc

trim = false;

if end_chr == duplicate_char then -- if same as separator

trim = true; -- why? why do this and next differently from previous?

trim = true; -- same question

end

trim = true;

trim = true;

trim = true;

end

elseif end_chr == " " then -- if last char of output string is a space

end

end

 

if trim then

local dup2 = duplicate_char;

else

end

end

end

end

end

return str;

 

 

 

 

]]

 

local function is_suffix (suffix)

return true;

end

end

 

 

 

[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/U0180.pdf Latin Extended-B] 0180–01BF, 01C4–024F

 

|firstn= also allowed to contain hyphens, spaces, apostrophes, and periods

 

This original test:

 

\195\128-\195\150 – À-Ö (U+00C0–U+00D6 – C0 controls)

]]

 

if not is_suffix (suffix) then

return false; -- not a name with an appropriate suffix

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

end;

return true;

end

 

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

 

 

 

 

 

]]

 

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

 

if not name then -- if not initials and a suffix

end

 

return first; -- one or two initials and a valid suffix so nothing to do

else

return first; -- and return first unmolested

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

end

if 3 > i then

end

end

end

 

 

 

]]

 

local sep;

local namesep;

 

else

end

local sep_one = sep;

etal = true;

break;

else

end

else

end

end

end

end

end

end

end

 

end

end

end

end

end

 

 

 

 

]]

end

else

end

end

 

 

 

 

 

]]

 

 

end

end

end

end

 

 

 

 

]]

 

 

}

 

end

end

end

end

 

 

 

 

]]

 

end

end

 

 

--[[--------------------------< N A M E _ C H E C K S >--------------------------------------------------------

 

]]

 

end

end

end

end

return last, first; -- done

 

 

Gets name list from the input arguments

 

 

 

 

]]

 

local function extract_names(args, list_name)

local first;

local link;

local mask;

 

while true do

if first and not last then -- if there is a firstn without a matching lastn

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

end

else -- we have last with or without a first

 

n = n + 1; -- point to next location in the names table

if 1 == count then -- if the previous name was missing

end

count = 0; -- reset the counter, we're looking for two consecutive missing names

end

end

 

 

 

 

 

 

]]

 

end

 

end

end

end

 

 

 

 

 

 

 

]]

 

local function language_parameter (lang)

local name; -- the language name

local language_list = {}; -- table of language names to be rendered

 

 

 

 

end

end

else

end

name = ''; -- so we can reuse it

end

return ''; -- if one language and that language is this wiki's return an empty string (no annotation)

end

end

 

 

 

]]

 

end

end

 

 

 

 

]]

 

local sep;

end

 

end

end

 

 

 

 

]=]

 

local function is_pdf (url)

end

 

 

the appropriate styling.

 

 

local function style_format (format, url, fmt_param, url_param)

end

else

format = ''; -- empty string for concatenation

end

 

 

 

 

 

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

]]

 

if 'etal' == max:lower():gsub("[ '%.]", '') then -- the :gsub() portion makes 'etal' from a variety of 'et al.' spellings and stylings

max = count + 1; -- number of authors + 1 so display all author name plus et al.

max = tonumber (max); -- make it a number

if max >= count then -- if |display-xxxxors= value greater than or equal to number of authors/editors

end

else -- not a valid keyword or number

max = nil; -- unset; as if |display-xxxxors= had not been set

end

end

 

 

 

 

]]

 

 

end

end

 

 

 

 

 

local name_table = mw.text.split(vparam, "%s*,%s*"); -- names are separated by commas

local i = 1;

while name_table[i] do

local name = name_table[i];

while name_table[i] do

name = name .. ', ' .. name_table[i]; -- concatenate with previous segments

break; -- and done reassembling so

end

end

table.insert (output_table, name); -- and add corporate name to the output table

else

end

end

return output_table;

end

 

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

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

 

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

 

 

]]

local names = {}; -- table of names assembled from |vauthors=, |author-maskn=, |author-linkn=

local v_name_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;

 

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)

 

for i, v_name in ipairs(v_name_table) do

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;

end

local lastfirstTable = {}

first = table.remove(lastfirstTable); -- get what should be the initials from the table

if mw.ustring.match (last, '%a+%s+%u+%s+%a+') then

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

end

else

last = v_name; -- last name or single corporate name? Doesn't support multiword corporate names? do we need this?

end

if not mw.ustring.match (first, "^%u?%u$") then -- first shall contain one or two upper-case letters, nothing else

end

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

else

if not corporate then

end

end

end

return names, etal; -- all done, return our list of names

 

Select one of |authors=, |authorn= / |lastn / firstn=, or |vauthors= as the source of the author name list or

 

 

When looking for |authorn= / |editorn= parameters, test |xxxxor1= and |xxxxor2= (and all of their aliases); stops after the second

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

 

 

]]

 

local function select_author_editor_source (vxxxxors, xxxxors, args, list_name)

end

 

local err_name;

if 'AuthorList' == list_name then -- figure out which name should be used in error message

err_name = 'editor';

end

end

 

if true == lastfirst then return 1 end; -- return a number indicating which author name source to use

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

 

]]

 

end

 

else

end

end

 

local function terminate_name_list (name_list, sepc)

return name_list; -- just return the name list

return name_list .. " "; -- don't add another

else

end

end

 

 

 

 

]]

return '';

end

end

 

end

end

end

end

end

end

 

 

]]

 

if 'map' == cite_class then -- only cite map supports sheet(s) as in-source locators

if 'journal' == origin then

return '', '', wrap_msg ('j-sheet', sheet, lower), '';

return '', '', wrap_msg ('sheet', {sepc, sheet}, lower), '';

end

if 'journal' == origin then

return '', '', '', wrap_msg ('j-sheets', sheets, lower);

end

 

if is_journal then

elseif not nopp then

else

end

if is_journal then

elseif not nopp then

else

end

end

return '', '', '', ''; -- return empty strings

end

 

--[=[-------------------------< A R C H I V E _ U R L _ C H E C K >--------------------------------------------

 

unwitting readers to do.

 

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:

correct place

otherwise returns |archive-url= and |archive-date=

 

//web.archive.org/<timestamp>... -- the old form

//web.archive.org/web/<timestamp>... -- the new form

we don't check for these specific flags but we do check the form.

 

for save command errors, return undated wildcard (/*/)

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

return url, date; -- not an archive.org archive, return ArchiveURL and ArchiveDate

end

 

url = url:gsub ('(//web%.archive%.org)/save/', '%1/*/', 1); -- for preview mode: modify ArchiveURL

elseif url:match('//liveweb%.archive%.org/') then

else

if '*' ~= flag then

end

else

end

end

-- if here, something not right so

else

end

end

 

 

 

 

 

]]

 

 

end

end

]]

 

--[[

Load Input Parameters

The argument_wrapper facilitates the mapping of multiple aliases to single internal variable.

]]

local i

 

-- Pick out the relevant fields from the arguments. Different citation templates

-- define different field names for the same underlying things.

 

local author_etal;

local a = {}; -- authors list from |lastn= / |firstn= pairs or |vauthors=

local Authors;

local Collaboration = A['Collaboration'];

 

a, author_etal = extract_names (args, 'AuthorList'); -- fetch author list from |authorn= / |lastn= / |firstn=, |author-linkn=, and |author-maskn=

elseif 2 == selected then

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=

end

end

author_etal = true; -- so that |display-authors=etal not required

end

end

 

local editor_etal;

local e = {}; -- editors list from |editor-lastn= / |editor-firstn= pairs or |veditors=

 

do -- to limit scope of selected

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

e, editor_etal = parse_vauthors_veditors (args, args.veditors, 'EditorList'); -- fetch editor list from |veditors=, |editor-linkn=, and |editor-maskn=

end

end

c = extract_names (args, 'ContributorList'); -- fetch contributor list from |contributorn= / |contributor-lastn=, -firstn=, -linkn=, -maskn=

if 0 < #c then

c = {}; -- blank the contributors' table; it is used as a flag later

end

if 0 == #a then -- |contributor= requires |author=

c = {}; -- blank the contributors' table; it is used as a flag later

end

end

else -- if not a book cite

end

Contribution = nil; -- unset

end

 

local Title = A['Title'];

local TitleLink = A['TitleLink'];

 

 

 

 

local Periodical = A['Periodical'];

 

local Volume;

local Issue;

local Page;

local Pages;

local At;

Page = A['Page'];

At = A['At'];

end

 

local Edition = A['Edition'];

local PublisherName = A['PublisherName'];

end

 

 

end

 

 

 

 

local this_page = mw.title.getCurrentTitle(); -- also used for COinS and for language

 

no_tracking_cats = "true"; -- set no_tracking_cats

end

if this_page.text:match (v) then -- test page name against each pattern

no_tracking_cats = "true"; -- set no_tracking_cats

end

end

 

 

 

end

end

 

 

 

 

 

ScriptChapter = ScriptTitle;

TransChapter = TransTitle;

ChapterURL = URL;

end

Title = Periodical;

ScriptTitle = '';

end

Periodical = ''; -- redundant so unset

end

end

 

if (config.CitationClass == "techreport") then -- special case for cite techreport

ID = A['Number']; -- yes, use it

else -- ID has a value so emit error message

end

end

end

 

if 'conference' == config.CitationClass then

Chapter = Title;

ChapterURL = URL;

ChapterFormat = Format;

TransChapter = TransTitle;

Title = BookTitle;

Format = '';

TransTitle = '';

URL = '';

Conference = ''; -- not cite conference or cite speech so make sure this is empty string

end

local Cartography = "";

local Scale = "";

local Sheets = A['Sheets'] or '';

if config.CitationClass == "map" then

Chapter = A['Map'];

ChapterURL = A['MapURL'];

TransChapter = A['TransMap'];

ChapterFormat = A['MapFormat'];

Cartography = A['Cartography'];

Cartography = sepc .. " " .. wrap_msg ('cartography', Cartography, use_lowercase);

end

Scale = A['Scale'];

Scale = sepc .. " " .. Scale;

end

end

 

if 'episode' == config.CitationClass or 'serial' == config.CitationClass then

local SeriesLink = A['SeriesLink'];

 

 

local Network = A['Network'];

local s, n = {}, {};

-- do common parameters first

ID = table.concat(n, sepc .. ' ');

if 'episode' == config.CitationClass then -- handle the oddities that are strictly {{cite episode}}

local Season = A['Season'];

local SeriesNumber = A['SeriesNumber'];

 

SeriesNumber = ''; -- unset; prefer |season= over |seriesno=

end

-- assemble a table of parts concatenated later into Series

Issue = ''; -- unset because this is not a unique parameter

Chapter = Title; -- promote title parameters to chapter

ScriptChapter = ScriptTitle;

TransChapter = TransTitle;

ChapterURL = URL;

Title = Series; -- promote series to title

TitleLink = SeriesLink;

Series = table.concat(s, sepc .. ' '); -- this is concatenation of season, seriesno, episode number

 

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?

end

end

end

 

TitleType = set_titletype (config.CitationClass, TitleType);

TitleType = Degree .. ' ' .. cfg.title_types ['thesis']:lower();

end

end

 

-- TODO: Hack on TitleType to fix bunched parentheses problem

end

 

Date = Year; -- promote Year to Date

Year = nil; -- make nil so Year as empty string isn't used for CITEREF

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

 

 

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

 

 

end

local modified = false; -- flag

end

 

modified = true;

end

if modified then -- if the date_parameters_list values were modified

end

else

end

end -- end of do

 

 

AccessDate = ''; -- unset

end