Module:Citation/CS1: Difference between revisions

]]

local dates, year_date_check -- functions in Module:Citation/CS1/Date_validation

--[[--------------------------< I S _ S E T >------------------------------------------------------------------

return error_comment( message, error_state.hidden );

end

-- is prefix one of these language codes?

if in_array (lang, {'ar', 'bg', 'bs', 'dv', 'el', 'fa', 'hy', 'ja', 'ka', 'ko', 'ku', 'he', 'ps', 'ru', 'sd', 'sr', 'th', 'uk', 'ug', 'yi', 'zh'}) then

else

end

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

end

end

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

can be transparently aliased to single internal variable.

]]

local function argument_wrapper( args )

local origin = {};

nil - unsupported parameters

]]

local function validate( name )

local name = tostring( name );

local function is_valid_isxn (isxn_str, len)

local temp = 0;

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

temp = temp + 10*( len - i ); -- it represents 10 decimal

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 check_isbn( id ) then -- see if asin value is isbn10

elseif not is_set (err_cat) then

err_cat =  ' ' .. set_error ('bad_asin'); -- asin is not isbn10

]]

local handler = cfg.id_handlers['ARXIV'];

local year, month, version;

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

end

prefix=handler.prefix,id=id,separator=handler.separator, encode=handler.encode}) .. err_cat;

end

--[[

]]

local function lccn(lccn)

local handler = cfg.id_handlers['LCCN'];

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 = 30000000; -- update this value as PMIDs approach

end

Determines if a PMC identifier's online version is embargoed. Compares the date in |embargo= against today's date.  If embargo date is

]]

local lang = mw.getContentLanguage();

local good1, embargo_date, good2, todays_date;

good2, todays_date = pcall( lang.formatDate, lang, 'U' );

end

end

end

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

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 = 5000000; -- update this value as PMCs approach

end

else

prefix=handler.prefix,id=id,separator=handler.separator, encode=handler.encode}) .. err_cat;

end

return text

end

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

Also handles the special case where it is desirable to omit the title type from the rendered citation (|type=none).

]]

if is_set(title_type) then

if "none" == title_type then

end

end

local function clean_isbn( isbn_str )

return isbn_str:gsub( "[^-0-9X]", "" );

]]

local function strip_apostrophe_markup (argument)

if not is_set (argument) then return argument; end

]]

local function get_coins_pages (pages)

local pattern;

]]

local function safe_join( tbl, duplicate_char )

--[[

return str;

end   

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

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.

]]

local function is_good_vanc_name (last, first)

if true ~= Page_in_vanc_error_cat then -- if we haven't been here before then set a sticky flag

Page_in_vanc_error_cat=true; -- so that if there are more than one error the category is added only once

return true;

end

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

Vancouver style requires family rank designations (Jr, II, III, etc) to be rendered as Jr, 2nd, 3rd, etc.  This form is not

currently supported by this code so correctly formed names like Smith JL 2nd are converted to Smith J2. See http://www.ncbi.nlm.nih.gov/books/NBK7271/box/A35085/.

]]

local function reduce_to_initials(first)

local initials = {}

local i = 0; -- counter for number of initials

i = i + 1; -- bump the counter  

if 2 <= i then break; end -- only two initials allowed in Vancouver system; if 2, quit

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

if sep:sub(-1,-1) ~= " " then sep = sep .. " " end

for i,person in ipairs(people) do

local one

local sep_one = sep;

etal = true;

break;

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

if true == etal then

end

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

--[[--------------------------< B U I L D _ I D _ L I S T >--------------------------------------------------------

Takes a table of IDs and turns it into a table of formatted ID outputs.

]]

local function build_id_list( id_list, options )

local new_list, handler = {};

table.insert( new_list, {handler.label, doi( v, options.DoiBroken ) } );

elseif k == 'ARXIV' then

elseif k == 'ASIN' then

table.insert( new_list, {handler.label, amazon( v, options.ASINTLD ) } );  

-- COinS metadata (see <http://ocoins.info/>) allows automated tools to parse

-- the citation information.

if 'table' ~= type(data) or nil == next(data) then

return '';

elseif is_set(data.Periodical) then

OCinSoutput.rft_val_fmt = "info:ofi/fmt:kev:mtx:journal";

OCinSoutput["rft.jtitle"] = data.Periodical;

OCinSoutput["rft.atitle"] = data.Title;

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

]]

When |language= contains a valid ISO639-1 code, the page is assigned to the category for that code: Category:Norwegian-language sources (no) if

the page is a mainspace page and the ISO639-1 code is not 'en'.  Similarly, if the  parameter is |language=Norwegian, it will be categorized in the same way.

]]

local function language_parameter (lang, namespace)

end

end

end

end

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)

if (cite_class == "citation") then -- for citation templates (CS2)

else -- not a citation template so CS1

end

local function set_style (mode, ps, ref, cite_class)

table.insert( z.message_tail, { set_error( 'invalid_param_val', {'mode', mode}, true ) } ); -- add error message

end

sep, ps, ref = get_settings_from_cite_class (ps, ref, cite_class); -- get settings based on the template's CitationClass

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)

--[[  

local Degree = A['Degree'];

local Docket = A['Docket'];

local ArchiveURL = A['ArchiveURL'];

local URL = A['URL']

local ChapterURL = A['ChapterURL'];

local ChapterURLorigin = A:ORIGIN('ChapterURL'); -- get name of parameter that holds ChapterURL

local ConferenceURL = A['ConferenceURL'];

local ConferenceURLorigin = A:ORIGIN('ConferenceURL'); -- get name of parameter that holds ConferenceURL

local IgnoreISBN = A['IgnoreISBN'];

local Embargo = A['Embargo'];

local ID_list = extract_ids( args );

local Quote = A['Quote'];

local LayURL = A['LayURL'];

local LaySource = A['LaySource'];

local Transcript = A['Transcript'];

local TranscriptURL = A['TranscriptURL']  

local TranscriptURLorigin = A:ORIGIN('TranscriptURL'); -- get name of parameter that holds TranscriptURL

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

if in_array (this_page.nsText, cfg.uncategorized_namespaces) then

end

end

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

Periodical = A ['MailingList'];

end

URL = '';

end

end

local AirDate = A['AirDate'];

local SeriesLink = A['SeriesLink'];

local Network = A['Network'];

local Station = A['Station'];

local s, n = {}, {};

if is_set(Network) then table.insert(n, Network); end

if is_set(Station) then table.insert(n, Station); end

if not is_set (Date) then

Date = Year; -- promote Year to Date

do -- create defined block to contain local variables error_message and mismatch

local error_message = '';

['embargo']=Embargo, ['laydate']=LayDate, ['publicationdate']=PublicationDate, ['year']=Year});

error_message = error_message .. '&#124;year= / &#124;date= mismatch';

elseif 1 == mismatch then -- |year= matches year-value in |date=

end

end

end

end -- end of do

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

if 'none' == Title and is_set(Periodical) and not (( config.CitationClass == "encyclopaedia" ) or ( config.CitationClass == "citation" and is_set (Encyclopedia))) then -- special case

Title = ''; -- set title to empty string

end

-- this is the function call to COinS()

['Periodical'] = Periodical,

['Chapter'] = strip_apostrophe_markup (coins_chapter), -- Chapter stripped of bold / italic wikimarkup

['Volume'] = Volume,

['Issue'] = Issue,

['Edition'] = Edition,

['PublisherName'] = PublisherName,

['ID_list'] = ID_list,

['RawPage'] = this_page.prefixedText,

-- special case for cite newsgroup.  Do this after COinS because we are modifying Publishername to include some static text

-- 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 control = {  

end

if not is_set(Authors) and is_set(Coauthors) then -- coauthors aren't displayed if one of authors=, authorn=, or lastn= isn't specified

end

if not is_set(Editors) then

-- Preserve old-style implicit et al.

if not is_set(Maximum) and #e == 4 then  

Maximum = 3;

table.insert( z.message_tail, { set_error('implict_etal_editor', {}, true) } );

end

Editors, EditorCount = list_people(control, e, editor_etal);

else

EditorCount = 1;

end

-- Test if cite web or cite podcast |url= is missing or empty  

table.insert( z.message_tail, { set_error( 'accessdate_missing_url', {}, true ) } );

AccessDate = '';

end

end

DeadURL = DeadURL:lower(); -- used later when assembling archived text

if is_set( ArchiveURL ) then

if is_set (URL) then

OriginalURL = URL; -- save copy of original source URL

if 'no' ~= DeadURL then -- if URL set then archive-url applies to it

URL = ArchiveURL -- swap-in the archive's url

URLorigin = A:ORIGIN('ArchiveURL') -- name of archive url parameter for error messages

end

elseif is_set (ChapterURL) then -- URL not set so if chapter-url is set apply archive url to it

OriginalURL = ChapterURL; -- save copy of source chapter's url for archive text

if 'no' ~= DeadURL then

ChapterURL = ArchiveURL -- swap-in the archive's url

URLorigin = A:ORIGIN('ArchiveURL') -- name of archive url parameter for error messages

end

end

end

('citation' == config.CitationClass and is_set (Periodical) and not is_set (Encyclopedia)) then

if is_set (Chapter) or is_set (TransChapter) or is_set (ChapterURL)then -- chapter parameters not supported for these citation types

Chapter = format_chapter_title (Chapter, TransChapter, ChapterURL, ChapterURLorigin);

if is_set (Chapter) then

if 'map' == config.CitationClass and is_set (TitleType) then

end

Chapter = Chapter .. ChapterFormat .. sepc .. ' ';

end

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

if is_set(Title) then

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

URL = "";

Format = "";

Place = " " .. wrap_msg ('written', Place, use_lowercase) .. sepc .. " ";

end

Conference = external_link( ConferenceURL, Conference );

end

elseif is_set(ConferenceURL) then

Conference = sepc .. " " .. external_link( ConferenceURL, nil, ConferenceURLorigin );

end

if not is_set(Position) then

local Minutes = A['Minutes'];

end

end

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

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

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

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

end

if is_set(URL) then

if sepc ~= "." then arch_text = arch_text:lower() end

Archived = sepc .. " " .. substitute( cfg.messages['archived-not-dead'],

if not is_set(OriginalURL) then

Archived = Archived .. " " .. set_error('archive_missing_url');    

if sepc ~= "." then arch_text = arch_text:lower() end

Archived = sepc .. " " .. substitute( arch_text,

else

local arch_text = cfg.messages['archived-missing'];

{ set_error('archive_missing_url'), ArchiveDate } );

end

else

Archived = ""

end

if is_set(LayURL) then

if is_set(LayDate) then LayDate = " (" .. LayDate .. ")" end

end

if sepc == '.' then

else

end

end

if is_set(Transcript) then

elseif is_set(TranscriptURL) then

Transcript = external_link( TranscriptURL, nil, TranscriptURLorigin );

end

local Publisher;

if is_set(Periodical) and

end

else -- all other CS1 templates

tcommon = safe_join( {Title, TitleNote, Conference, Periodical, Format, TitleType, Series, Language,  

local idcommon = safe_join( { ID_list, URL, Archived, AccessDate, Via, SubscriptionRequired, Lay, Quote }, sepc );

local text;

if is_set(Authors) then

if (sepc ~= '.') then in_text = in_text:lower() end

Editors = in_text .. Editors .. post_text;

end

end