Module:LDSverse - Revision history

Lectonar: Protected "Module:LDSverse": request at RfPP ([Edit=Require autoconfirmed or confirmed access] (indefinite) [Move=Require autoconfirmed or confirmed access] (indefinite))

2020-09-08T10:14:55Z

Protected "Module:LDSverse": request at RfPP ([Edit=Require autoconfirmed or confirmed access] (indefinite) [Move=Require autoconfirmed or confirmed access] (indefinite))

← Previous revision	Revision as of 10:14, 8 September 2020
(No difference)

Biggins: added forgotten helper function

2020-09-01T12:49:58Z

added forgotten helper function

← Previous revision		Revision as of 12:49, 1 September 2020
Line 432:		Line 432:
	wikiText = wikiText .. "]]" -- DON'T FORGET!!!		wikiText = wikiText .. "]]" -- DON'T FORGET!!!
	return wikiText		return wikiText
			end

			-- like the name says, this just counts the number of keys (aka indexes) in a table
			local function countKeys(t)
			local i = 0
			for k,v in pairs(t) do i = i+1 end
			return i
	end		end

Biggins: added function to get a (wikitable-ified) list of all the book name aliases for use in template documentation

2020-09-01T12:42:07Z

added function to get a (wikitable-ified) list of all the book name aliases for use in template documentation

@@ Line 432: / Line 432: @@
 	wikiText = wikiText .. "]]"		-- DON'T FORGET!!!
 	return wikiText
 end

Biggins: added a todo item in the intro comments

2020-09-01T10:23:35Z

added a todo item in the intro comments

← Previous revision		Revision as of 10:23, 1 September 2020
Line 3:		Line 3:

	-- TODO:		-- TODO:
			-- Check the verse parameter to make sure it's a number (sometimes users
⚫	-- Take out the error statements and handle errors more gracefully?
			-- mistakenly include the en dash and ending verse number in this
⚫	-- Functions with error statements in them:
			-- parameter, e.g., {{LDS\|Alma\|alma\|7\|11–12}}). If it isn't a number,
			-- default to citing to the chapter as a whole?
		⚫	-- Take out the remaining error statements and handle errors more gracefully.
			-- (As of September 2020, many have already been removed, so that's good.)
		⚫	-- Functions with error statements left in them:
	-- getFullBookName		-- getFullBookName
	-- handleOD		-- handleOD

Biggins: Removed some unnecessary error/assert statements, handled some errors more gracefully

2020-08-28T09:50:35Z

Removed some unnecessary error/assert statements, handled some errors more gracefully

← Previous revision		Revision as of 09:50, 28 August 2020
Line 3:		Line 3:

	-- TODO:		-- TODO:
	-- Take out the ~~assert/~~error statements and handle errors more gracefully?		-- Take out the error statements and handle errors more gracefully?
			-- Functions with error statements in them:
			-- getFullBookName
			-- handleOD
			-- getStandardWork (only throws an error if pre-conditions not met)
			-- getLectureOrdinal (only called with pcall)

	--[[		--[[
Line 156:		Line 161:
	local function getFullBookName(bookParam)		local function getFullBookName(bookParam)
	Returns the full name of a book of scripture based on the name/abbrev./alias provided		Returns the full name of a book of scripture based on the name/abbrev./alias provided
			Pre-condition: bookParam is non-nil
		⚫
	NB: Because both Matthew in the NT and JST Matthew have just the title		NB: Because both Matthew in the NT and JST Matthew have just the title
	"Matthew" on Wikisource, this function returns "JST Matthew" as the full name		"Matthew" on Wikisource, this function returns "JST Matthew" as the full name
Line 163:		Line 170:
	]]		]]
	local function getFullBookName(bookParam)		local function getFullBookName(bookParam)

	assert(bookParam, "No book name provided")
⚫
	for title,bookList in pairs(standardWorks) do		for title,bookList in pairs(standardWorks) do
	if bookList[bookParam] then		if bookList[bookParam] then
Line 207:		Line 213:
	returns the Standard Work (as titled by Wikisource) that contains the book		returns the Standard Work (as titled by Wikisource) that contains the book
	passed in.		passed in.
			Preconditions: bookName is non-nil and was returned by getFullBookName
	]]		]]
	local function getStandardWork(~~bookParam~~)		local function getStandardWork(bookName)

	assert(bookParam, "No book name provided")

	local book = getFullBookName(bookParam)
	assert(book, "Book <" .. bookParam .. "> not found in Standard Works")

	-- check the standardWorks table for any values that have a key with the		-- check the standardWorks table for any values that have a key with the
	-- full name of the book; if so, return the key (the title of the SW)		-- full name of the book; if so, return the key (the title of the SW)
	for title,bookList in pairs(standardWorks) do		for title,bookList in pairs(standardWorks) do
	if bookList[~~book~~] then return title end		if bookList[bookName] then return title end
	end		end

	error("Book <" .. ~~book~~ .. "> is not a full book name found in Standard Works", 0)		error("Book <" .. bookName .. "> is not a full book name found in Standard Works", 0)
			-- pre-conditions mean that this error should never occur, aka if it does,
			-- something went very wrong!
	end		end

Line 268:		Line 272:

	-- Special case for handling the Official Declarations in the D&C		-- Special case for handling the Official Declarations in the D&C
	~~local~~ ~~function~~ ~~handleOD(~~displayTextParam, ~~chapter)~~		-- Pre-condition: displayTextParam is non-nil
			local function handleOD(displayTextParam, decNumber)
	if ~~chapter~~ == "1" then		if decNumber == "1" then
	return wsBaseURL .. "The_Doctrine_and_Covenants/Official_Declaration_1\|" .. displayTextParam .. " 1]]"		return wsBaseURL .. "The_Doctrine_and_Covenants/Official_Declaration_1\|" .. displayTextParam .. " 1]]"
	elseif ~~chapter~~ == "2" then		elseif decNumber == "2" then
	return "[https://www.churchofjesuschrist.org/study/scriptures/dc-testament/od/2?lang=eng " .. displayTextParam .. " 2]"		return "[https://www.churchofjesuschrist.org/study/scriptures/dc-testament/od/2?lang=eng " .. displayTextParam .. " 2]"
			else -- decNumber wasn't 1 or 2 (and could even be nil)
			if decNumber then
			error("No such Official Declaration: " .. decNumber, 0)
	else		else
	error("No ~~such~~ ~~Official~~ ~~Declaration:~~ " ~~.. chapter~~, 0)		error("No official declaration number provided", 0)
	end		end
			end
	end		end

			-- for when the user has provided either no parameters or just one (the display
			-- text for the wikilink)
	local function handleFewParams(displayTextParam)		local function handleFewParams(displayTextParam)
	if not displayTextParam then		if not displayTextParam then
Line 336:		Line 347:
	end		end

			-- pre-condition: lectureNum is non-nil
	local function getLectureOrdinal(lectureNum)		local function getLectureOrdinal(lectureNum)
	if lectureNum == "1" then return "First"		if lectureNum == "1" then return "First"
Line 391:		Line 403:
	if fullBookName == "Lectures on Faith" then		if fullBookName == "Lectures on Faith" then
	if chapterParam then		if chapterParam then
	~~fullBookName~~ = ~~"Lecture~~ " ~~.. getLectureOrdinal~~(chapterParam)		local status, ordinal = pcall(getLectureOrdinal, chapterParam)
			if status then
			fullBookName = "Lecture " .. ordinal
			else
			fullBookName = nil -- just cite to LoF generally
			chapterParam = chapterParam .. " (invalid)" -- so user knows there was a problem
			mw.log(ordinal) -- print error message to debug console (?)
			end
	else		else
	fullBookName = nil -- The user has not provided a chapter (lecture) so this is treated as wanting to cite the LoF generally		fullBookName = nil -- The user has not provided a chapter (lecture) so this is treated as wanting to cite the LoF generally

Biggins: Remove completed TODO item and convert assert(false) statements into straight-up error calls

2020-08-28T09:06:07Z

Remove completed TODO item and convert assert(false) statements into straight-up error calls

← Previous revision		Revision as of 09:06, 28 August 2020
Line 3:		Line 3:

	-- TODO:		-- TODO:
	-- Take out the assert statements and handle errors more gracefully?		-- Take out the assert/error statements and handle errors more gracefully?
	-- Handle situations where the book name parameter is mistakenly left out (e.g., {{LDS\|Alma\|7\|11}}): if the "bookParam" evaluates to a number, shift all the parameters "down" one (i.e., bookParam->chapterParam, chapterParam->verseParam, etc.) and treat the display text (minus any period or other punctuation) is the bookParam.

	--[[		--[[
Line 200:		Line 199:
	-- At this point we've searched, without regard to case, creed, or color,		-- At this point we've searched, without regard to case, creed, or color,
	-- for the alleged book of scripture they provided, but it ain't here!		-- for the alleged book of scripture they provided, but it ain't here!
	~~assert~~(~~false,~~ "Book <" .. bookParam .. "> not found in Standard Works")		error("Book <" .. bookParam .. "> not found in Standard Works", 0)
	return ""		return ""
	end --function getFullBookName(bookParam)		end --function getFullBookName(bookParam)
Line 222:		Line 221:
	end		end

	~~assert~~(~~false,~~ "Book <" .. book .. "> is not a full book name found in Standard Works")		error("Book <" .. book .. "> is not a full book name found in Standard Works", 0)
	end		end

Line 275:		Line 274:
	return "[https://www.churchofjesuschrist.org/study/scriptures/dc-testament/od/2?lang=eng " .. displayTextParam .. " 2]"		return "[https://www.churchofjesuschrist.org/study/scriptures/dc-testament/od/2?lang=eng " .. displayTextParam .. " 2]"
	else		else
	~~assert~~(~~false,~~ "No such Official Declaration: " .. chapter)		error("No such Official Declaration: " .. chapter, 0)
	end		end
	end		end
Line 347:		Line 346:
	end		end

	~~assert~~(~~false,~~ "Lecture on Faith number <" .. lectureNum .. "> does not exist (should be between 1 and 7)")		error("Lecture on Faith number <" .. lectureNum .. "> does not exist (should be between 1 and 7)", 0)
	end		end

Biggins: Remove periods in book abbreviations

2020-08-28T08:51:01Z

Remove periods in book abbreviations

← Previous revision		Revision as of 08:51, 28 August 2020
Line 26:		Line 26:
	["Testimony of Three Witnesses"] = {"three", "3witnesses"},		["Testimony of Three Witnesses"] = {"three", "3witnesses"},
	["Testimony of Eight Witnesses"] = {"eight", "8witnesses"},		["Testimony of Eight Witnesses"] = {"eight", "8witnesses"},
	["1 Nephi"] = {"1-ne", "1_ne", "1ne"},		["1 Nephi"] = {"1-ne", "1_ne", "1ne", "1 ne"},
	["2 Nephi"] = {"2-ne", "2_ne", "2ne"},		["2 Nephi"] = {"2-ne", "2_ne", "2ne", "2 ne"},
	["Jacob"] = {"jac"},		["Jacob"] = {"jac"},
	["Enos"] = {"en"},		["Enos"] = {"en"},
Line 36:		Line 36:
	["Alma"] = {},		["Alma"] = {},
	["Helaman"] = {"hel"},		["Helaman"] = {"hel"},
	["3 Nephi"] = {"3-ne", "3_ne", "3ne"},		["3 Nephi"] = {"3-ne", "3_ne", "3ne", "3 ne"},
	["4 Nephi"] = {"4-ne", "4_ne", "4ne"},		["4 Nephi"] = {"4-ne", "4_ne", "4ne", "4 ne"},
	["Mormon"] = {"morm", "mormon"},		["Mormon"] = {"morm", "mormon"},
	["Ether"] = {},		["Ether"] = {},
Line 58:		Line 58:
	["JST Matthew"] = {"js-m", "jsm", "joseph smith matthew", "jst matt",		["JST Matthew"] = {"js-m", "jsm", "joseph smith matthew", "jst matt",
	"jst-matt", "jst-matthew", "js matthew"}, -- NB: This is a special case!		"jst-matt", "jst-matthew", "js matthew"}, -- NB: This is a special case!
	["History"] = {"js-h", "jsh", "js history", "joseph smith history", ~~"js-hist"},~~		["History"] = {"js-h", "jsh", "js history", "joseph smith history",
			"js-hist", "js hist"},
	["Articles of Faith"] = {"a-of-f", "a_of_f", "aoff", "the articles of faith"}		["Articles of Faith"] = {"a-of-f", "a_of_f", "aoff", "the articles of faith"}
	}		}
Line 71:		Line 72:
	["Judges"] = {"judg", "jgs"},		["Judges"] = {"judg", "jgs"},
	["Ruth"] = {"ru", "ruth"},		["Ruth"] = {"ru", "ruth"},
	["1 Samuel"] = {"1sam", "1sm", "1_sam", "1-sam"},		["1 Samuel"] = {"1sam", "1sm", "1_sam", "1-sam", "1 sam"},
	["2 Samuel"] = {"2sam", "2sm", "2_sam", "2-sam"},		["2 Samuel"] = {"2sam", "2sm", "2_sam", "2-sam", "2 sam"},
	["1 Kings"] = {"1kgs", "1-kgs", "1_kgs"},		["1 Kings"] = {"1kgs", "1-kgs", "1_kgs", "1 kgs"},
	["2 Kings"] = {"2kgs", "2-kgs", "2_kgs"},		["2 Kings"] = {"2kgs", "2-kgs", "2_kgs", "2 kgs"},
	["1 Chronicles"] = {"1chron", "1chr", "1-chr", "1_chr"},		["1 Chronicles"] = {"1chron", "1chr", "1-chr", "1_chr", "1 chr"},
	["2 Chronicles"] = {"2chron", "2chr", "2-chr", "2_chr"},		["2 Chronicles"] = {"2chron", "2chr", "2-chr", "2_chr", "2 chr"},
	["Ezra"] = {},		["Ezra"] = {},
	["Nehemiah"] = {"neh"},		["Nehemiah"] = {"neh"},
Line 103:		Line 104:
	["Zechariah"] = {"zech", "zec", "zach", "zac"}, -- catch typos		["Zechariah"] = {"zech", "zec", "zach", "zac"}, -- catch typos
	["Malachi"] = {"mal"},		["Malachi"] = {"mal"},

	["Matthew"] = {"matt", "mt"}, -- New Testament		["Matthew"] = {"matt", "mt"}, -- New Testament
	["Mark"] = {"mk"},		["Mark"] = {"mk"},
	["Luke"] = {"lk"},		["Luke"] = {"lk"},
	["John"] = {"jn"},		["John"] = {"jn"},
	["Acts"] = {"actsoftheapostles", "the acts"},		["Acts"] = {"actsoftheapostles", "the acts", "acts of the apostles",
			"the acts of the apostles"},
	["Romans"] = {"rom", "roman"},		["Romans"] = {"rom", "roman"},
	["1 Corinthians"] = {"1cor", "1-cor", "1_cor"},		["1 Corinthians"] = {"1cor", "1-cor", "1_cor", "1 cor"},
	["2 Corinthians"] = {"2cor", "2-cor", "2_cor"},		["2 Corinthians"] = {"2cor", "2-cor", "2_cor", "2 cor"},
	["Galatians"] = {"gal"},		["Galatians"] = {"gal"},
	["Ephesians"] = {"eph"},		["Ephesians"] = {"eph"},
Line 116:		Line 119:
	["Colossians"] = {"col"},		["Colossians"] = {"col"},
	["1 Thessalonians"] = {"1thess", "1thes", "1-thes",		["1 Thessalonians"] = {"1thess", "1thes", "1-thes",
	"1_thes", "1-thess", "1_thess"}, -- catch typos		"1_thes", "1-thess", "1_thess", "1 thess", "1 thes"}, -- catch typos
	["2 Thessalonians"] = {"2thess", "2thes", "2-thes",		["2 Thessalonians"] = {"2thess", "2thes", "2-thes",
	"2_thes", "2-thess", "2_thess"}, -- catch typos		"2_thes", "2-thess", "2_thess", "2 thess", "2 thes"}, -- catch typos
	["1 Timothy"] = {"1tim", "1tm", "1-tim", "1_tim"},		["1 Timothy"] = {"1tim", "1tm", "1-tim", "1_tim", "1 tim"},
	["2 Timothy"] = {"2tim", "2tm", "2-tim", "2_tim"},		["2 Timothy"] = {"2tim", "2tm", "2-tim", "2_tim", "2 tim"},
	["Titus"] = {"ti"},		["Titus"] = {"ti"},
	["Philemon"] = {"philem", "phlm"},		["Philemon"] = {"philem", "phlm"},
	["Hebrews"] = {"heb", "hebrew"}, -- catch typos		["Hebrews"] = {"heb", "hebrew"}, -- catch typos
	["James"] = {"jas"},		["James"] = {"jas"},
	["1 Peter"] = {"1pet", "1pt", "1-pet", "1_pet"},		["1 Peter"] = {"1pet", "1pt", "1-pet", "1_pet", "1 pet"},
	["2 Peter"] = {"2pet", "2pt", "2-pet", "2_pet"},		["2 Peter"] = {"2pet", "2pt", "2-pet", "2_pet", "2 pet"},
	["1 John"] = {"1jn", "1-jn", "1_jn"},		["1 John"] = {"1jn", "1-jn", "1_jn", "1 jn"},
	["2 John"] = {"2jn", "2-jn", "2_jn"},		["2 John"] = {"2jn", "2-jn", "2_jn", "2 jn"},
	["3 John"] = {"3jn", "3-jn", "3_jn"},		["3 John"] = {"3jn", "3-jn", "3_jn", "3 jn"},
	["Jude"] = {},		["Jude"] = {},
	["Revelation"] = {"rev", "apocalypse", "apoc", "rv",		["Revelation"] = {"rev", "apocalypse", "apoc", "rv",
Line 285:		Line 288:
	end		end

			local function removePeriods(arg)
			if arg then
			return string.gsub(arg, "%.", "")
			else
			return nil
			end
			end

			-- this function removes leading and trailing spaces via regex magic
	local function trimSpaces(arg)		local function trimSpaces(arg)
	if arg then		if arg then
Line 298:		Line 310:
	local function extractParams(args)		local function extractParams(args)
	local displayTextParam = trimSpaces(args[1])		local displayTextParam = trimSpaces(args[1])
	local bookParam = trimSpaces(args[2])		local bookParam = removePeriods(trimSpaces(args[2])) -- take out periods and spaces
	local chapterParam = trimSpaces(args[3])		local chapterParam = trimSpaces(args[3])
	local verseParam = trimSpaces(args[4])		local verseParam = trimSpaces(args[4])
Line 315:		Line 327:
	if tonumber(args[2]) then		if tonumber(args[2]) then
	-- the second parameter is a number (tonumber returns nil if there is any text in its argument)		-- the second parameter is a number (tonumber returns nil if there is any text in its argument)
	bookParam = trimSpaces(args[1]) -- use the display text and hope it's the full name of the book (or a valid abbreviation)!		bookParam = removePeriods(trimSpaces(args[1])) -- use the display text and hope it's the full name of the book (or a valid abbreviation)!
	chapterParam = trimSpaces(args[2])		chapterParam = trimSpaces(args[2])
	verseParam = trimSpaces(args[3])		verseParam = trimSpaces(args[3])

Biggins: Added logic to handle the common user error in which where the user forgets the second parameter and goes right into the chapter number without specifying the book parameter

2020-08-28T05:22:48Z

Added logic to handle the common user error in which where the user forgets the second parameter and goes right into the chapter number without specifying the book parameter

@@ Line 293: / Line 293: @@
 end
 local function extractParams(args)
 	local displayTextParam = trimSpaces(args[1])
@@ Line 301: / Line 304: @@
 	-- the 6th and 7th parameters, for footnotes and cross-references, have no
 	--	use on Wikisource (and don't seem to work even on CoCJ.org, but whatever)
 	local endVerseFlag = trimSpaces(args[8])
 	return displayTextParam, bookParam, chapterParam, verseParam, endVerseParam, endVerseFlag
 end

Biggins: Updated bomBooks table to reflect new WS pages for the Title Page and the testimonies of the 3/8 witnesses

2020-08-27T12:46:03Z

Updated bomBooks table to reflect new WS pages for the Title Page and the testimonies of the 3/8 witnesses

← Previous revision		Revision as of 12:46, 27 August 2020
Line 23:		Line 23:

	local bomBooks = {		local bomBooks = {
	["~~Introduction~~"] = {"~~intro~~", "~~bom-intro~~", "~~bom_intro~~", "~~three~~", "~~eight~~"},		["Title Page"] = {"ttl", "ttlpg", "title", "title-page", "title_page"},
			["Testimony of Three Witnesses"] = {"three", "3witnesses"},
			["Testimony of Eight Witnesses"] = {"eight", "8witnesses"},
	["1 Nephi"] = {"1-ne", "1_ne", "1ne"},		["1 Nephi"] = {"1-ne", "1_ne", "1ne"},
	["2 Nephi"] = {"2-ne", "2_ne", "2ne"},		["2 Nephi"] = {"2-ne", "2_ne", "2ne"},

Biggins: Fixed typo (extra definite article)

2020-08-27T12:09:47Z

Fixed typo (extra definite article)

← Previous revision		Revision as of 12:09, 27 August 2020
Line 356:		Line 356:
	end		end
	-- Special case for Lectures on Faith		-- Special case for Lectures on Faith
	if fullBookName == "~~The~~ Lectures on Faith" then		if fullBookName == "Lectures on Faith" then
	if chapterParam then		if chapterParam then
	fullBookName = "Lecture " .. getLectureOrdinal(chapterParam)		fullBookName = "Lecture " .. getLectureOrdinal(chapterParam)