Module:he-utilities

The following documentation is located at Module:he-utilities/documentation. ^[edit] Categories were auto-generated by Module:module categorization. ^[edit]

Useful links: subpage list • links • transclusions • testcases • sandbox

Some utilities for use in other Hebrew modules.

---

local p = {}

-- A wrapper function allowing the contents of this module to be called from
-- templates. For example, '{{#invoke:he-utilities|main|otSofit|כ}}' produces
-- 'ך', as does '{{#invoke:he-utilities|main|letters|kafSofit}}'.
function p.main(frame)
	if type(p[frame.args[1]]) == 'function' then
		return p[frame.args[1]](frame.args[2])
	else
		return p[frame.args[1]][frame.args[2]]
	end
end

-- A mapping from strings containing letter-names, e.g. "alef", to strings
-- containing letters, e.g. "\215\144". (The latter is a UTF-8-encoded string
-- containing the single Unicode character U+05D0 HEBREW LETTER ALEF.)
p.letters = {}
for i, name in ipairs({ 'alef', 'bet', 'gimel', 'dalet', 'hei', 'vav', 'zayen',
						'khet', 'tet', 'yud', 'kafSofit', 'kaf', 'lamed',
						'memSofit', 'mem', 'nunSofit', 'nun', 'samekh', 'ayin',
						'peiSofit', 'pei', 'tsadiSofit', 'tsadi', 'kuf', 'resh',
						'shin', 'tav' }) do
	p.letters[name] = mw.ustring.char(0x05D0 + i - 1)
end
p.letters.sin = p.letters.shin

-- Same as previous, but for vowels instead of letters. (It also includes a few
-- marks and diacritics that aren't quite "vowels", but are in the same sequence
-- of Unicode characters.)
p.vowels = {}
for i, name in ipairs({ 'shva', 'khatafSegol', 'khatafPatakh', 'khatafKamats',
						'khirik', 'tseirei', 'segol', 'patakh', 'kamats',
						'kholam', 'ignoreMe', 'kubuts', 'dagesh', 'meteg',
						'makaf', 'rafe', 'pasek', 'shinDot', 'sinDot',
						'sofPasuk', 'upperDot' }) do
	p.vowels[name] = mw.ustring.char(0x05B0 + i - 1)
end
p.vowels.ignoreMe = nil
p.vowels.mapik = p.vowels.dagesh

-- If letter is kaf, mem, nun, pei, or tsadi, returns kaf sofit, mem sofit,
-- etc., respectively; otherwise, just returns letter.
function p.otSofit(letter)
	if letter == p.letters.kaf or letter == p.letters.mem
			or letter == p.letters.nun or letter == p.letters.pei
			or letter == p.letters.tsadi then
		return mw.ustring.char(mw.ustring.codepoint(letter) - 1)
	else
		return letter
	end
end

-- Same as previous, except that if letter is kaf or kaf sofit, also tacks on
-- a sh'va (since kaf sofit is written with a sh'va when it has no other vowel).
function p.otSofitShva(letter)
	letter = p.otSofit(letter)
	if letter == p.letters.kafSofit then
		return letter .. p.vowels.shva
	else
		return letter
	end
end

-- If letter is kaf sofit, mem sofit, etc., returns kaf, mem, etc.; otherwise,
-- just returns letter.
function p.otLoSofit(letter)
	if letter == p.letters.kafSofit or letter == p.letters.memSofit
			or letter == p.letters.nunSofit or letter == p.letters.peiSofit
			or letter == p.letters.tsadiSofit then
		return mw.ustring.char(mw.ustring.codepoint(letter) + 1)
	else
		return letter
	end
end

-- If letter is bet, gimel, dalet, kaf, pei, or tav, returns letter plus a
-- dagesh; otherwise, just returns letter.
function p.dageshKal(letter)
	if letter == p.letters.bet or letter == p.letters.gimel
			or letter == p.letters.dalet or letter == p.letters.kaf
			or letter == p.letters.pei or letter == p.letters.tav then
		return letter .. p.vowels.dagesh
	else
		return letter
	end
end

-- If letter is shin plus a shin or sin dot, returns shin (without the dot);
-- otherwise, just returns letter.
function p.dotlessShin(letter)
	if letter == p.letters.shin .. p.letters.shinDot
			or letter == p.letters.sin .. p.letters.sinDot then
		return p.letters.shin
	else
		return letter
	end
end

return p