Module:Citation/CS1/COinS - Revision history

Trappist the monk: sync from sandbox;

2025-04-12T13:48:47Z

sync from sandbox;

← Previous revision		Revision as of 13:48, 12 April 2025
Line 65:		Line 65:
	pages = pages:gsub(pattern, ""); -- remove as many instances of pattern as possible		pages = pages:gsub(pattern, ""); -- remove as many instances of pattern as possible
	end		end

	pages = pages:gsub("[%[%]]", ""); -- remove the brackets		pages = pages:gsub("[%[%]]", ""); -- remove the brackets
	pages = pages:gsub("–", "-" ); -- replace endashes with hyphens		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?		pages = pages:gsub("&%w+;", "-" ); -- and replace HTML entities (– etc.) with hyphens; do we need to replace numerical entities like and the like?
			pages = pages:gsub ('%b<>', ''); -- remove html-like tags; spans are added to <Pages> by utilities.hyphen_to_dash() which should not appear in COinS metadata
	return pages;		return pages;
	end		end

Trappist the monk: sync from sandbox;

2023-08-12T19:19:02Z

sync from sandbox;

← Previous revision		Revision as of 19:19, 12 August 2023
Line 180:		Line 180:
	});		});

	if in_array (class, {'arxiv', 'biorxiv', 'citeseerx', 'ssrn', 'journal', 'news', 'magazine'}) or		if in_array (class, {'arxiv', 'biorxiv', 'citeseerx', 'medrxiv', 'ssrn', 'journal', 'news', 'magazine'}) or
	(in_array (class, {'conference', 'interview', 'map', 'press release', 'web'}) and is_set(data.Periodical)) 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		('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		OCinSoutput.rft_val_fmt = "info:ofi/fmt:kev:mtx:journal"; -- journal metadata identifier
	if in_array (class, {'arxiv', 'biorxiv', 'citeseerx', 'ssrn'}) then -- set genre according to the type of citation template we are rendering		if in_array (class, {'arxiv', 'biorxiv', 'citeseerx', 'medrxiv', 'ssrn'}) then -- set genre according to the type of citation template we are rendering
	OCinSoutput["rft.genre"] = "preprint"; -- cite arxiv, cite biorxiv, cite citeseerx, cite ssrn		OCinSoutput["rft.genre"] = "preprint"; -- cite arxiv, cite biorxiv, cite citeseerx, cite medrxiv, cite ssrn
	elseif 'conference' == class then		elseif 'conference' == class then
	OCinSoutput["rft.genre"] = "conference"; -- cite conference (when Periodical set)		OCinSoutput["rft.genre"] = "conference"; -- cite conference (when Periodical set)

Trappist the monk: sync from sandbox;

2023-01-14T14:43:36Z

sync from sandbox;

← Previous revision		Revision as of 14:43, 14 January 2023
Line 180:		Line 180:
	});		});

	if in_array (class, {'arxiv', 'biorxiv', 'citeseerx', 'ssrn', 'journal', 'news', 'magazine'}) or (in_array (class, {'conference', 'interview', 'map', 'press release', 'web'}) and is_set(data.Periodical)) or		if in_array (class, {'arxiv', 'biorxiv', 'citeseerx', 'ssrn', 'journal', 'news', 'magazine'}) 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		('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		OCinSoutput.rft_val_fmt = "info:ofi/fmt:kev:mtx:journal"; -- journal metadata identifier
Line 201:		Line 202:
	OCinSoutput["rft.volume"] = data.Volume; -- does not apply to books		OCinSoutput["rft.volume"] = data.Volume; -- does not apply to books
	OCinSoutput["rft.issue"] = data.Issue;		OCinSoutput["rft.issue"] = data.Issue;
			OCinSoutput['rft.artnum'] = data.ArticleNumber; -- {{cite journal}} only
	OCinSoutput["rft.pages"] = data.Pages; -- also used in book metadata		OCinSoutput["rft.pages"] = data.Pages; -- also used in book metadata

Trappist the monk: update per RfC;

2022-01-22T14:11:14Z

update per RfC;

← Previous revision		Revision as of 14:11, 22 January 2022
Line 1:		Line 1:

	--[[--------------------------< F O R W A R D D E C L A R A T I O N S >--------------------------------------		--[[--------------------------< 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, strip_apostrophe_markup; -- functions in Module:Citation/CS1/Utilities		local has_accept_as_written, is_set, in_array, remove_wiki_link, strip_apostrophe_markup; -- functions in Module:Citation/CS1/Utilities

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

	local function make_coins_title (title, script)		local function make_coins_title (title, script)
			title = has_accept_as_written (title);
	if is_set (title) then		if is_set (title) then
	title = strip_apostrophe_markup (title); -- strip any apostrophe markup		title = strip_apostrophe_markup (title); -- strip any apostrophe markup
Line 302:		Line 302:
	cfg = cfg_table_ptr;		cfg = cfg_table_ptr;

	~~is_set~~ = utilities_page_ptr.~~is_set~~; -- import functions from selected Module:Citation/CS1/Utilities module		has_accept_as_written = utilities_page_ptr.has_accept_as_written; -- import functions from selected Module:Citation/CS1/Utilities module
			is_set = utilities_page_ptr.is_set;
	in_array = utilities_page_ptr.in_array;		in_array = utilities_page_ptr.in_array;
	remove_wiki_link = utilities_page_ptr.remove_wiki_link;		remove_wiki_link = utilities_page_ptr.remove_wiki_link;

Trappist the monk: sync from sandbox;

2021-04-10T13:14:45Z

sync from sandbox;

← Previous revision		Revision as of 13:14, 10 April 2021
Line 27:		Line 27:
	script = strip_apostrophe_markup (script); -- strip any apostrophe markup		script = strip_apostrophe_markup (script); -- strip any apostrophe markup
	else		else
	script = ''; -- if not set, make sure script is an empty string		script = ''; -- if not set, make sure script is an empty string
	end		end
	if is_set (title) and is_set (script) then		if is_set (title) and is_set (script) then
Line 66:		Line 66:
	end		end
	pages = pages:gsub("[%[%]]", ""); -- remove the brackets		pages = pages:gsub("[%[%]]", ""); -- remove the brackets
	pages = pages:gsub("–", "-" ); -- replace endashes with hyphens		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?		pages = pages:gsub("&%w+;", "-" ); -- and replace HTML entities (– etc.) with hyphens; do we need to replace numerical entities like and the like?
	return pages;		return pages;
	end		end
Line 137:		Line 137:
	end		end

	value = value:gsub (cfg.stripmarkers['math'], "MATH RENDER ERROR"); -- one or more couldn't be replaced; insert vague error message		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 = mw.text.unstripNoWiki (value); -- replace nowiki stripmarkers with their content
Line 144:		Line 144:
	value = value:gsub ('\226\128\138', ' '); -- replace hair space 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		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 = 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		value = mw.ustring.gsub (value, '[\226\128\141\226\128\139\194\173]', ''); -- remove zero-width joiner, zero-width space, soft hyphen
	end		end
	value = value:gsub ('[\009\010\013 ]+', ' '); -- replace horizontal tab, line feed, carriage return with plain space		value = value:gsub ('[\009\010\013 ]+', ' '); -- replace horizontal tab, line feed, carriage return with plain space
	return value;		return value;
	end		end
Line 241:		Line 241:
	OCinSoutput["rft.date"] = data.Date; -- book, journal, dissertation		OCinSoutput["rft.date"] = data.Date; -- book, journal, dissertation

	-- TODO: data.ID_list should also contain identifier validity status (to suppress output of invalid identifier metadata) as well as OL A/M/W/X type and ASIN TLD info (to special-case prefix generation)

	for k, v in pairs( data.ID_list ) do -- what to do about these? For now assume that they are common to all?		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 = v:gsub( "[^-0-9X]", "" ); end		if k == 'ISBN' then v = v:gsub( "[^-0-9X]", "" ); end
Line 250:		Line 248:
	elseif string.sub (id or "", 1, 3 ) == 'rft' then -- for isbn, issn, eissn, etc. that have defined COinS keywords		elseif string.sub (id or "", 1, 3 ) == 'rft' then -- for isbn, issn, eissn, etc. that have defined COinS keywords
	OCinSoutput[ id ] = v;		OCinSoutput[ id ] = v;
	elseif id then -- ~~when~~ ~~cfg.id_handlers[k].COinS~~ is ~~not~~ ~~nil~~		elseif 'url' == id then -- for urls that are assembled in ~/Identifiers; \|asin= and \|ol=
			OCinSoutput["rft_id"] = table.concat ({data.ID_list[k], "#id-name=", cfg.id_handlers[k].label});
			elseif id then -- when cfg.id_handlers[k].COinS is not nil so urls created here
	OCinSoutput["rft_id"] = table.concat{ cfg.id_handlers[k].prefix, v, cfg.id_handlers[k].suffix or '', "#id-name=", cfg.id_handlers[k].label }; -- others; provide a URL and indicate identifier name as #fragment (human-readable, but transparent to browsers)		OCinSoutput["rft_id"] = table.concat{ cfg.id_handlers[k].prefix, v, cfg.id_handlers[k].suffix or '', "#id-name=", cfg.id_handlers[k].label }; -- others; provide a URL and indicate identifier name as #fragment (human-readable, but transparent to browsers)
	end		end

Trappist the monk: sync from sandbox;

2021-01-09T14:11:09Z

sync from sandbox;

Show changes

Trappist the monk: sync from sandbox;

2019-09-03T11:05:48Z

sync from sandbox;

@@ Line 3: / Line 3: @@
 ]]
-local is_set, in_array, remove_wiki_link;										-- functions in Module:Citation/CS1/Utilities
+local is_set, in_array, remove_wiki_link, strip_apostrophe_markup;				-- functions in Module:Citation/CS1/Utilities
 local cfg;																		-- table of configuration tables that are defined in Module:Citation/CS1/Configuration
@@ Line 212: / Line 180: @@
 	});
-	if in_array (class, {'arxiv', 'biorxiv', 'citeseerx', 'journal', 'news', 'magazine'}) or (in_array (class, {'conference', 'interview', 'map', 'press release', 'web'}) and is_set(data.Periodical)) or
+	if in_array (class, {'arxiv', 'biorxiv', 'citeseerx', 'ssrn', 'journal', 'news', 'magazine'}) 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
+			if in_array (class, {'arxiv', 'biorxiv', 'citeseerx', 'ssrn'}) then	-- set genre according to the type of citation template we are rendering
-				OCinSoutput["rft.genre"] = "preprint";							-- cite arxiv, cite biorxiv, cite citeseerx
+				OCinSoutput["rft.genre"] = "preprint";							-- cite arxiv, cite biorxiv, cite citeseerx, cite ssrn
 			elseif 'conference' == class then
 				OCinSoutput["rft.genre"] = "conference";						-- cite conference (when Periodical set)
@@ Line 283: / Line 251: @@
 	end
 	local last, first;
 	for k, v in ipairs( data.Authors ) do
@@ Line 333: / Line 290: @@
 	cfg = cfg_table_ptr;
-	is_set = utilities_page_ptr.is_set;											-- import functions from select Module:Citation/CS1/Utilities module
+	is_set = utilities_page_ptr.is_set;											-- import functions from selected Module:Citation/CS1/Utilities module
 	in_array = utilities_page_ptr.in_array;
 	remove_wiki_link = utilities_page_ptr.remove_wiki_link;
 end

Trappist the monk: sync from sandbox;

2019-04-20T13:20:08Z

sync from sandbox;

← Previous revision		Revision as of 13:20, 20 April 2019
Line 1:		Line 1:

	local coins = {};


	--[[--------------------------< F O R W A R D D E C L A R A T I O N S >--------------------------------------		--[[--------------------------< 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 is_set, in_array, remove_wiki_link; -- functions in Module:Citation/CS1/Utilities

Line 274:		Line 272:

	for k, v in pairs( data.ID_list ) do -- what to do about these? For now assume that they are common to all?		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		if k == 'ISBN' then v = v:gsub( "[^-0-9X]", "" ); end
	local id = cfg.id_handlers[k].COinS;		local id = cfg.id_handlers[k].COinS;
Line 342:		Line 339:


			--[[--------------------------< E X P O R T E D F U N C T I O N S >------------------------------------------
			]]

	return {		return {

Trappist the monk: synch from sandbox;

2018-09-29T13:26:22Z

synch from sandbox;

← Previous revision		Revision as of 13:26, 29 September 2018
Line 214:		Line 214:
	});		});

	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		if in_array (class, {'arxiv', 'biorxiv', 'citeseerx', 'journal', 'news', 'magazine'}) 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		('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		OCinSoutput.rft_val_fmt = "info:ofi/fmt:kev:mtx:journal"; -- journal metadata identifier

Trappist the monk: synch from sandbox;

2017-11-04T10:41:13Z

synch from sandbox;

← Previous revision		Revision as of 10:41, 4 November 2017
Line 5:		Line 5:
	--[[--------------------------< F O R W A R D D E C L A R A T I O N S >--------------------------------------		--[[--------------------------< 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 is_set, in_array, remove_wiki_link; -- functions in Module:Citation/CS1/Utilities

Line 178:		Line 177:
	value = value:gsub (' ', ' '); -- replace   entity with plain space		value = value:gsub (' ', ' '); -- replace   entity with plain space
	value = value:gsub ('\226\128\138', ' '); -- replace hair space 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		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		value = value:gsub ('[\009\010\013]', ' '); -- replace horizontal tab, line feed, carriage return with plain space
	return value;		return value;
Line 320:		Line 321:

	-- sort with version string always first, and combine.		-- sort with version string always first, and combine.
	table.sort( OCinSoutput );		--table.sort( OCinSoutput );
	table.insert( OCinSoutput, 1, "ctx_ver=" .. ctx_ver ); -- such as "Z39.88-2004"		table.insert( OCinSoutput, 1, "ctx_ver=" .. ctx_ver ); -- such as "Z39.88-2004"
	return table.concat(OCinSoutput, "&");		return table.concat(OCinSoutput, "&");