Module:Format ISBN - Revision history

Trappist the monk at 21:31, 8 May 2025

2025-05-08T21:31:56Z

← Previous revision		Revision as of 21:31, 8 May 2025
Line 137:		Line 137:
	end		end

	if 13 == #isbn_str and flags.out10 then -- if isbn13 but we want an isbn10 output		if 13 == #isbn_str and flags.out10 and isbn_str:match ('^978') then -- if isbn13 but we want an isbn10 output; only for GS1 prefix of 978
	flags.isbn10_check_digit = (convert_to_isbn10 (isbn_str)):sub (-1); -- calculate and extract the isbn10 check digit for later		flags.isbn10_check_digit = (convert_to_isbn10 (isbn_str)):sub (-1); -- calculate and extract the isbn10 check digit for later
	end		end

Trappist the monk: sync from sandbox;

2023-04-29T14:54:13Z

sync from sandbox;

Show changes

Trappist the monk at 15:36, 23 April 2023

2023-04-23T15:36:40Z

← Previous revision		Revision as of 15:36, 23 April 2023
Line 77:		Line 77:

	link = link and link or false; -- <link> is whatever <link> is or it is false		link = link and link or false; -- <link> is whatever <link> is or it is false

	isbn_str = tostring (isbn_str); -- some other module may have fed us an unquoted isbn (as a number)		isbn_str = tostring (isbn_str); -- some other module may have fed us an unquoted isbn (as a number)

	local err_msg = require ("Module:Check isxn").check_isbn ({args={isbn_str, template_name=template_name}}); -- does this isbn 'look' like a valid isbn? does not check ranging		local err_msg = require ("Module:Check isxn").check_isbn ({args={isbn_str, template_name=template_name}}); -- does this isbn 'look' like a valid isbn? does not check ranging
	if '' ~= err_msg then		if '' ~= err_msg then
Line 88:		Line 88:
	end		end

			local isbn_str_raw = isbn_str; -- this will be the return value if unable to format
	isbn_str = isbn_str:gsub ('[^%dX]', ''); -- strip all formatting (spaces and hyphens) from the isbn		isbn_str = isbn_str:gsub ('[^%dX]', ''); -- strip all formatting (spaces and hyphens) from the isbn

	local isbn10_check_digit;		local isbn10_check_digit;
	if 13 == #isbn_str and ret_10 then		if 13 == #isbn_str and ret_10 then
	return ~~isbn_str~~; -- because ret_10, this function doesn't format 13-digit isbns return original text ~~without formatting~~		return isbn_str_raw; -- because ret_10, this function doesn't format 13-digit isbns return original text
	end		end
	if 10 == #isbn_str then		if 10 == #isbn_str then
Line 122:		Line 123:
	end		end

	return ~~isbn_str~~; -- should never actually be reached; but, if we do, return original text ~~without formatting~~		return isbn_str_raw; -- should never actually be reached; but, if we do, return original text
	end		end

Trappist the monk at 15:32, 23 April 2023

2023-04-23T15:32:20Z

← Previous revision		Revision as of 15:32, 23 April 2023
Line 91:		Line 91:

	local isbn10_check_digit;		local isbn10_check_digit;
		⚫	if 13 == #isbn_str and ret_10 then
		⚫	return isbn_str; -- because ret_10, this function doesn't format 13-digit isbns return original text without formatting
		⚫	end
	if 10 == #isbn_str then		if 10 == #isbn_str then
	isbn10_check_digit = isbn_str:sub (-1); -- extract the check digit for later		isbn10_check_digit = isbn_str:sub (-1); -- extract the check digit for later
	isbn_str = convert_to_isbn13 (isbn_str); -- convert isbn10 to isbn13		isbn_str = convert_to_isbn13 (isbn_str); -- convert isbn10 to isbn13
⚫	end
⚫	if 13 == #isbn_str and ret_10 then
⚫	return isbn_str; -- because ret_10, this function doesn't format 13-digit isbns return original text without formatting
	end		end

Trappist the monk at 15:28, 23 April 2023

2023-04-23T15:28:12Z

← Previous revision		Revision as of 15:28, 23 April 2023
Line 88:		Line 88:
	end		end

	isbn_str = isbn_str:gsub ('[^%dX]', ''); -- strip spaces and hyphens from the isbn		isbn_str = isbn_str:gsub ('[^%dX]', ''); -- strip all formatting (spaces and hyphens) from the isbn

	local isbn10_check_digit;		local isbn10_check_digit;
	if ~~#isbn_str~~ == 10 then		if 10 == #isbn_str then
	isbn10_check_digit = isbn_str:sub (-1); -- extract the check digit for later		isbn10_check_digit = isbn_str:sub (-1); -- extract the check digit for later
	isbn_str = convert_to_isbn13 (isbn_str); -- convert isbn10 to isbn13		isbn_str = convert_to_isbn13 (isbn_str); -- convert isbn10 to isbn13
	end		end
			if 13 == #isbn_str and ret_10 then

			return isbn_str; -- because ret_10, this function doesn't format 13-digit isbns return original text without formatting
			end

	local index = binary_search (isbn_str); -- look for the formatting that applies to this isbn		local index = binary_search (isbn_str); -- look for the formatting that applies to this isbn
	if index then -- if found		if index then -- if found
Line 119:		Line 122:
	end		end

	return isbn_str; -- should never actually be reached; but, if we do, return ~~the~~ original text		return isbn_str; -- should never actually be reached; but, if we do, return original text without formatting
	end		end

Trappist the monk at 01:16, 23 April 2023

2023-04-23T01:16:42Z

← Previous revision		Revision as of 01:16, 23 April 2023
Line 71:		Line 71:
	]]		]]

	local function format_isbn (isbn_str, link, show_err_msg, separator, template_name)		local function format_isbn (isbn_str, link, show_err_msg, separator, ret_10, template_name)
	if (not isbn_str) or ('' == isbn_str) then		if (not isbn_str) or ('' == isbn_str) then
	return ''; -- empty or nil input? empty output		return ''; -- empty or nil input? empty output
Line 90:		Line 90:
	isbn_str = isbn_str:gsub ('[^%dX]', ''); -- strip spaces and hyphens from the isbn		isbn_str = isbn_str:gsub ('[^%dX]', ''); -- strip spaces and hyphens from the isbn

			local isbn10_check_digit;
	if #isbn_str == 10 then		if #isbn_str == 10 then
			isbn10_check_digit = isbn_str:sub (-1); -- extract the check digit for later
	isbn_str = convert_to_isbn13 (isbn_str); -- convert isbn10 to isbn13		isbn_str = convert_to_isbn13 (isbn_str); -- convert isbn10 to isbn13
	end		end
Line 107:		Line 109:

	local formatted_isbn_str = table.concat (result_t, separator and ' ' or '-'); -- assemble isbn with space separators or hyphens (default)		local formatted_isbn_str = table.concat (result_t, separator and ' ' or '-'); -- assemble isbn with space separators or hyphens (default)
			if isbn10_check_digit and ret_10 then
			formatted_isbn_str = formatted_isbn_str:gsub ('^978%-', ''):gsub ('%d$', isbn10_check_digit);
			end
	if link then		if link then
	return '[[Special:BookSources/' ..isbn_str .. '\|' .. formatted_isbn_str ..']]';		return '[[Special:BookSources/' ..isbn_str .. '\|' .. formatted_isbn_str ..']]';
Line 134:		Line 139:
	local isbn_str = args_t[1]		local isbn_str = args_t[1]
	local separator = 'space' == args_t.separator;		local separator = 'space' == args_t.separator;
	return format_isbn (isbn_str, nil, nil, separator, args_t.template_name); -- no linking, no error messaging		return format_isbn (isbn_str, nil, nil, separator, nil, args_t.template_name); -- no linking, no error messaging
			end


			--[[--------------------------< F O R M A T _ P L A I N 1 0 >--------------------------------------------------

			plain text output:
			no linking to Special:BookSources
			no error message output – on error return input; for use in cs1\|2 template \|isbn= params, no point in causing confusion due to multiple error messages
			preserves isbn10 when input is isbn10 – does not convert isbn13 to isbn10; isbn13 input -> formatted isbn13 output

			\|separator=space – render formatted ISBN with spaces instead of hyphens

			{{#invoke:format isbn\|format_plain10\|template_name=Format ISBN10}}

			]]

			local function format_plain10 (frame)
			local args_t = get_args(frame)
			local isbn_str = args_t[1]
			local separator = 'space' == args_t.separator;
			local ret_10 = true
			return format_isbn (isbn_str, nil, nil, separator, true, args_t.template_name); -- no linking, no error messaging; return formatted isbn10
	end		end

Line 164:		Line 191:
	return {		return {
	format_plain = format_plain,		format_plain = format_plain,
			format_plain10 = format_plain10,
	format_linked = format_linked,		format_linked = format_linked,
	}		}

Trappist the monk at 19:16, 22 April 2023

2023-04-22T19:16:40Z

← Previous revision		Revision as of 19:16, 22 April 2023
Line 2:		Line 2:
	local get_args = require ('Module:Arguments').getArgs;		local get_args = require ('Module:Arguments').getArgs;

	local data = mw.loadData ('Module:~~Sandbox/trappist the monk/~~Format ISBN/data')		local data = mw.loadData ('Module:Format ISBN/data')
	local index_t = data.index_t;		local index_t = data.index_t;
	local hyphen_pos_t = data.hyphen_pos_t;		local hyphen_pos_t = data.hyphen_pos_t;

Trappist the monk: Trappist the monk moved page Module:Sandbox/trappist the monk/Format ISBN to Module:Format ISBN without leaving a redirect: get it out of my sandbox

2023-04-22T19:15:21Z

Trappist the monk moved page Module:Sandbox/trappist the monk/Format ISBN to Module:Format ISBN without leaving a redirect: get it out of my sandbox

← Previous revision	Revision as of 19:15, 22 April 2023
(No difference)

Trappist the monk at 22:29, 20 April 2023

2023-04-20T22:29:20Z

← Previous revision		Revision as of 22:29, 20 April 2023
Line 45:		Line 45:

	--[[--------------------------< C O N V E R T _ T O _ I S B N 1 3 >--------------------------------------------		--[[--------------------------< C O N V E R T _ T O _ I S B N 1 3 >--------------------------------------------

			convert 10-digit isbn to 13-digit isbn; adds 978 GS1 prefix and recalculates the check digit

	]]		]]

	local function convert_to_isbn13 (isbn10)		local function convert_to_isbn13 (isbn10)
	local isbn12 = '978'.. (isbn10):sub(1, 9); -- concatenate '978' with first 9 digits of <isbn10> (drop the check digit)		local isbn12 = '978'.. isbn10:sub(1, 9); -- concatenate '978' with first 9 digits of <isbn10> (drop the check digit)
	local check = 0; -- initialize the check digit calculation		local check = 0; -- initialize the check digit calculation
	for i=1, 12 do -- for the first 12 digits ('978' and 9 others)		for i=1, 12 do -- for the first 12 digits ('978' and 9 others)
Line 59:		Line 62:
	--[[--------------------------< F O R M A T _ I S B N >--------------------------------------------------------		--[[--------------------------< F O R M A T _ I S B N >--------------------------------------------------------

	takes ~~three~~ inputs:		takes five inputs:
	<isbn_str> – isbn as a string		<isbn_str> – isbn as a string
	<link> – boolean: when true, link formatted isbn to Special:BookSources; not linked else		<link> – boolean: when true, link formatted isbn to Special:BookSources; not linked else
	<show_err_msg>: boolean: when true, shows error message returned from check_isbn(); no message else		<show_err_msg>: boolean: when true, shows error message returned from check_isbn(); no message else
			<separator>: boolean: when true, use space character as separator; hyphen else
			<template_name>: supplied by the template for use in error messaging

	]]		]]
Line 74:		Line 79:

	isbn_str = tostring (isbn_str); -- some other module may have fed us an unquoted isbn (as a number)		isbn_str = tostring (isbn_str); -- some other module may have fed us an unquoted isbn (as a number)
	local ~~test~~ = require ("Module:Check isxn").check_isbn ({args={isbn_str, template_name=template_name}})		local err_msg = require ("Module:Check isxn").check_isbn ({args={isbn_str, template_name=template_name}}); -- does this isbn 'look' like a valid isbn? does not check ranging
	if '' ~= ~~test~~ then		if '' ~= err_msg then
	if show_err_msg then		if show_err_msg then
	return isbn_str .. ' ' .. ~~test~~; -- when check_isbn() returns an error message and when messages are enabled, return <isbn_str> with the message		return isbn_str .. ' ' .. err_msg; -- when check_isbn() returns an error message and when messages are enabled, return <isbn_str> with the message
	else		else
	return isbn_str; -- there was an error but not showing error message, return the ~~bogus~~ isbn		return isbn_str; -- there was an error but not showing error message, return the isbn as is
	end		end
	end		end
Line 93:		Line 98:
	local format_t = hyphen_pos_t[index]; -- get the formatting sequence		local format_t = hyphen_pos_t[index]; -- get the formatting sequence
	local result_t = {isbn_str:sub (1, 3)}; -- init <result_t> with prefix; the first three digits ('978' or '979')		local result_t = {isbn_str:sub (1, 3)}; -- init <result_t> with prefix; the first three digits ('978' or '979')
	local digit_ptr = 4; -- initialize to point at first digit following the prefix		local digit_ptr = 4; -- initialize to point at first digit following the prefix

	for _, n in ipairs (format_t) do -- loop through the formatting sequence		for _, n in ipairs (format_t) do -- loop through the formatting sequence

Trappist the monk at 22:13, 20 April 2023

2023-04-20T22:13:06Z

← Previous revision		Revision as of 22:13, 20 April 2023
Line 66:		Line 66:
	]]		]]

	local function format_isbn (isbn_str, link, show_err_msg, template_name)		local function format_isbn (isbn_str, link, show_err_msg, separator, template_name)
	if (not isbn_str) or ('' == isbn_str) then		if (not isbn_str) or ('' == isbn_str) then
	return ''; -- empty or nil input? empty output		return ''; -- empty or nil input? empty output
Line 101:		Line 101:
	table.insert (result_t, isbn_str:sub (13)); -- and add the check digit to <result_t>		table.insert (result_t, isbn_str:sub (13)); -- and add the check digit to <result_t>

	local formatted_isbn_str = table.concat (result_t, '-');		local formatted_isbn_str = table.concat (result_t, separator and ' ' or '-'); -- assemble isbn with space separators or hyphens (default)
	if link then		if link then
	return '[[Special:BookSources/' ..isbn_str .. '\|' .. formatted_isbn_str ..']]';		return '[[Special:BookSources/' ..isbn_str .. '\|' .. formatted_isbn_str ..']]';
Line 119:		Line 119:
	no error message output – on error return input; for use in cs1\|2 template \|isbn= params, no point in causing confusion due to multiple error messages		no error message output – on error return input; for use in cs1\|2 template \|isbn= params, no point in causing confusion due to multiple error messages

			\|separator=space – render formatted ISBN with spaces instead of hyphens
⚫	{{#invoke:format isbn\|format_plain}}

		⚫	{{#invoke:format isbn\|format_plain\|template=Format ISBN}}

	]]		]]
Line 126:		Line 128:
	local args_t = get_args(frame)		local args_t = get_args(frame)
	local isbn_str = args_t[1]		local isbn_str = args_t[1]
	return format_isbn (isbn_str, nil, nil, args_t.template_name) -- no linking, no error messaging		local separator = 'space' == args_t.separator;
			return format_isbn (isbn_str, nil, nil, separator, args_t.template_name); -- no linking, no error messaging
	end		end

Line 134:		Line 137:
	linked text output:		linked text output:
	links to Special:BookSources		links to Special:BookSources
	shows error message output unless suppressed by \|suppress-errors=yes

			\|suppress-errors=yes – suppress error messages
⚫	{{#invoke:format isbn\|format_linked}}
			\|separator=space – render formatted ISBN with spaces instead of hyphens

		⚫	{{#invoke:format isbn\|format_linked\|template=Format ISBN link}}

	]]		]]
Line 144:		Line 149:
	local isbn_str = args_t[1];		local isbn_str = args_t[1];
	local show_err_msg = 'yes' ~= args_t['suppress-errors']; -- always show errors unless \|suppress-errors=yes		local show_err_msg = 'yes' ~= args_t['suppress-errors']; -- always show errors unless \|suppress-errors=yes
			local separator = 'space' == args_t.separator; -- boolean: when true use space separator; hyphen else
	return format_isbn (isbn_str, true, show_err_msg, args_t.template_name) -- linked output, show error messages unless suppressed		return format_isbn (isbn_str, true, show_err_msg, separator, args_t.template_name) -- linked output, show error messages unless suppressed
	end		end