Module:Citation/CS1: Difference between revisions

]]

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

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

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.

added_prop_cats is a table declared in page scope variables above

if not added_prop_cats [key] then

added_prop_cats [key] = true; -- note that we've added this category

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

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

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

i and q SL domains in the .net TLD

elseif domain:match ('%f[%a%d][%a%d][%a%d%-]+[%a%d]%.xn%-%-[%a%d]+$') then -- internationalized domain name with ACE prefix

return true;

return true;

elseif domain:match ('%f[%a][qxz]%.com$') then -- assigned one character .com hostname (x.com times out 2015-12-10)

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

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

end

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

if is_set (access) then -- access level (subscription, registration, limited)

{

URL, -- the url

' ', -- the required space

'<span style="padding-left:0.15em">', -- signal spacing css

cfg.presentation[access], -- the appropriate icon

});

else

end

This function will positive kern either single or double quotes:

"'Unkerned title with leading and trailing single quote marks'"

Double single quotes (italic or bold wikimarkup) are not kerned.

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

local function kern_quotes (str)

local cap='';

local cap2='';

end

return str;

end

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

return script_value;

end

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

]]

local chapter_error = '';

else

if false == no_quotes then

chapter = wrap_style ('quoted-title', chapter);

end

if is_set (chapterurl) then

end

return chapter .. chapter_error;

end

--[[--------------------------< H A S _ I N V I S I B L E _ C H A R S >----------------------------------------

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 then

});

end

--[[--------------------------< V A L I D A T E >--------------------------------------------------------------

]]

local function validate( name, cite_class )

local name = tostring( name );

local state;

state = whitelist.limited_basic_arguments[ name ];

if true == state then return true; end -- valid actively supported parameter

return date;

end

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

elseif end_chr == "]" then -- if it might be wikimarkup

if str:sub(-3,-1) == duplicate_char .. "]]" then -- if last three chars of str are sepc]] wikilink  

trim = true;

elseif str:sub(-2,-1) == duplicate_char .. "]" then -- if last two chars of str are sepc] external link

return false;

end

--[[--------------------------< I S _ G O O D _ V A N C _ N A M E >--------------------------------------------

return true;

end

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

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

end

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

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

local first = person.first

if is_set(first) then

end

end

if is_set(person.link) and person.link ~= control.page_name then

end

end

if count > 0 then  

if count > 1 and is_set(lastauthoramp) and not etal then

end

text[#text] = nil; -- erase the last separator

return result, count

end

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

'^[%(%[]?%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

}

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

end

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

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

else -- or is a recognized language (but has a three-character code)

end

end

]]

end

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

return '.', ps; -- separator is a full stop

end

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

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

return sep, ps, ref -- return them all

end

--[[--------------------------< S E T _ S T Y L E >------------------------------------------------------------

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

return sep, ps, ref

end

--[=[-------------------------< I S _ P D F >------------------------------------------------------------------

applying the pdf icon to external links.

]=]

local function is_pdf (url)

end

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

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

if is_set (format) then

if not is_set (url) then

format = format .. set_error( 'format_missing_url', {fmt_param, url_param} ); -- add an error message

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

return max, etal;

end

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

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

add_maint_cat ('extra_text');

end

end

parentheses to also have commas; in the old version of the code, the doubled parnetheses were included in the

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

local i = 1;

end

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

else

end

i = i+1;

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

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

end

end

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

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

true; else, emits an error message and returns false.

]]

if not is_set (value) then

return true; -- an empty parameter is ok

]]

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

end

]]

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

if is_set (sheet) then

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

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

local Mode = A['Mode'];

Mode = '';

end

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

local At;

if in_array (config.CitationClass, cfg.templates_using_volume) then

Volume = A['Volume'];

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

end

local Via = A['Via'];

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

end

local use_lowercase; -- controls capitalization of certain static text

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

use_lowercase = ( sepc == ',' ); -- used to control capitalization for certain static text

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

end

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

end

if not is_set(PublicationPlace) and is_set(Place) then

PublicationPlace = Place; -- promote |place= (|location=) to |publication-place

if PublicationPlace == Place then Place = ''; end -- don't need both if they are the same

local Encyclopedia = A['Encyclopedia'];

TransChapter = TransTitle;

ChapterURL = URL;

if not is_set (ChapterURL) and is_set (TitleLink) then

end

Title = Periodical;

end

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'

end

if (config.CitationClass == "mailinglist") then

Periodical = A ['MailingList'];

end

if 'conference' == config.CitationClass then

if is_set(BookTitle) then

-- ChapterLink = TitleLink; -- |chapterlink= is deprecated

ChapterURL = URL;

ChapterURLorigin = URLorigin;

URLorigin = '';

end

local Cartography = "";

local Scale = "";

Chapter = A['Map'];

ChapterURL = A['MapURL'];

TransChapter = A['TransMap'];

ChapterURLorigin = A:ORIGIN('MapURL');

end

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

local AirDate = A['AirDate'];

TransChapter = TransTitle;

ChapterURL = URL;

ChapterURLorigin = A:ORIGIN('URL');

if is_set (ChapterLink) and not is_set (ChapterURL) then -- link but not URL

elseif is_set (ChapterLink) and is_set (ChapterURL) then -- if both are set, URL links episode;

end

URL = ''; -- unset

Chapter = A['Episode']; -- TODO: make |episode= available to cite episode someday?

if is_set (Series) and is_set (SeriesLink) then

end

Series = wrap_style ('italic-title', Series); -- series is italicized

end

end

do

if in_array (config.CitationClass, {'arxiv', 'biorxiv', 'citeseerx'}) 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

if in_array(config.CitationClass, {"AV-media-notes", "interview", "mailinglist", "map", "podcast", "pressrelease", "report", "techreport", "thesis"}) then

TitleType = set_titletype (config.CitationClass, TitleType);

end

if not is_set (Date) then

Date = Year; -- promote Year to Date

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 = '';

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

modified = true;

add_maint_cat ('date_format'); -- hyphens were converted so add maint category

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

end -- end of do

if config.CitationClass == "journal" and not is_set(URL) and is_set(ID_list['PMC']) then

end

-- Test if citation has no title

if not is_set(Title) and

}, config.CitationClass);

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

if 'newsgroup' == config.CitationClass then

if is_set (PublisherName) then

end

ArchiveFormat = style_format (ArchiveFormat, ArchiveURL, 'archive-format', 'archive-url');

ConferenceFormat = style_format (ConferenceFormat, ConferenceURL, 'conference-format', 'conference-url');

TranscriptFormat = style_format (TranscriptFormat, TranscriptURL, 'transcript-format', 'transcripturl');

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

end

if is_set (Chapter) then

Chapter = Chapter .. ChapterFormat ;

-- Format main title.

if is_set(TitleLink) and is_set(Title) then

end

Title = external_link( URL, Title, URLorigin, UrlAccess ) .. TransTitle .. TransError .. Format;

URL = ''; -- unset these because no longer needed

Format = "";

Title = Title .. TransTitle .. TransError;

end

end

end

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

if is_set (Translators) then

end

if is_set (Interviewers) then

add_maint_cat ('extra_text', 'edition');

end

else

Edition = '';

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

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

------------------------------------ totally unrelated data

end

if is_set (SubscriptionRequired) then

SubscriptionRequired = sepc .. " " .. cfg.messages['subscription']; -- subscription required message

AccessDate = nowrap_date (AccessDate); -- wrap in nowrap span if date in appropriate format

AccessDate = substitute (cfg.presentation['accessdate'], {sepc, AccessDate}); -- allow editors to hide accessdates

end

end

if "speech" == config.CitationClass then -- cite speech only

TitleNote = " (Speech)"; -- annotate the citation

if in_array(config.CitationClass, {"journal","citation"}) and is_set(Periodical) then

if is_set(Others) then Others = Others .. sepc .. " " end

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

else

tcommon = safe_join( {Title, TitleNote, Conference, Periodical, Format, TitleType, Series, Language, Volume, Others, Edition, Publisher, Agency}, sepc );

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

if is_set(Date) then

Date = " (" .. Date ..")" .. OrigYear .. sepc .. " "; -- in paranetheses

else -- neither of authors and editors set

end

if is_set(Authors) then

Authors = terminate_name_list (Authors, sepc); -- when no date, terminate with 0 or 1 sepc and a space

end

local in_text = " ";

local post_text = "";

in_text = in_text .. cfg.messages['in'] .. " "

else

if EditorCount <= 1 then

if (sepc ~= '.') then by_text = by_text:lower() end -- lowercase for cs2

Authors = by_text .. Authors; -- author follows title so tweak it here

Authors = terminate_name_list (Authors, sepc); -- terminate with 0 or 1 sepc and a space

end

Contributors = terminate_name_list (Contributors, sepc); -- terminate with 0 or 1 sepc and a space

end

else

text = safe_join( {Authors, Date, Chapter, Place, Editors, tcommon, pgtext, idcommon }, sepc );

end

end

else

if in_array(config.CitationClass, {"journal","citation"}) and is_set(Periodical) then

end

if is_set(options.id) then -- here we wrap the rendered citation in <cite ...>...</cite> tags

else

end

if #z.message_tail ~= 0 then

for i,v in ipairs( z.message_tail ) do

if is_set(v[1]) then

if i == #z.message_tail then

else

end

end

if #z.maintenance_cats ~= 0 then

for _, v in ipairs( z.maintenance_cats ) do -- append maintenance categories

end

end

if in_array(no_tracking_cats, {"", "no", "false", "n"}) then

for _, v in ipairs( z.error_categories ) do

end

for _, v in ipairs( z.maintenance_cats ) do -- append maintenance categories

end

end

end

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

metadata.set_selected_modules (cfg, utilities); -- so that functions in COinS can see the selected cfg tables and selected Utilities module

reformat_dates = validation.reformat_dates;

date_hyphen_to_dash = validation.date_hyphen_to_dash;

is_set = utilities.is_set; -- imported functions from Module:Citation/CS1/Utilities

in_array = utilities.in_array;

wrap_style = utilities.wrap_style;

safe_for_italics = utilities.safe_for_italics;

z = utilities.z; -- table of error and category tables in Module:Citation/CS1/Utilities