Module:he-translit/old/documentation

This module will transliterate Hebrew language text per WT:HE TR.

The module should preferably not be called directly from templates or other modules. To use it from a template, use {{xlit}}. Within a module, use Module:languages#Language:transliterate.

For testcases, see Module:he-translit/old/testcases.

Functions

tr(text, lang, sc)

Transliterates a given piece of text written in the script specified by the code sc, and language specified by the code lang.

When the transliteration fails, returns nil.

Test cases

(refresh)

test_biblical:

	Text	Expected	Actual	Differs at	Comments
	בַּיִת	bayiṯ	bayiṯ
	בֵּית	bēṯ	bēṯ
	עַכּוֹ‎		ʿakkō‎	1
	בָּתִּים	bāttīm	bāttīm
	מַחֲנֶה	maḥăne	maḥăne
	בָּרָא	bārā	bārā
	רֶגֶל	reḡel	reḡel
	כֹּהֵן	kōhēn	kōhēn
	מֶלֶךְ	meleḵ	meleḵ
	מַמְלָכָה	mamlāḵā	mamlāḵā
	הַמַּמְלָכָה	hammamlāḵā	hammamlāḵā
	הַלְּלוּיָהּ	halləlūyāh	halləlūyāh
	הַלְלוּיָהּ	haləlūyāh	haləlūyāh
	יָדַע	yāḏaʿ	yāḏaʿ
	שָׁבוּעַ	šāḇūaʿ	šāḇūaʿ
	רוּחַ	rūaḥ	rūaḥ
	גָּבֹהַּ	gāḇōah	gāḇōah
	מָשִׁיחַ	māšīaḥ	māšīaḥ
	רֵיחַ	rēaḥ	rēaḥ
	שָׂדֶה	śāḏe	śāḏe
	שְׂדֵה	śəḏē	śəḏē
	בָּנַי	bānay	bānay
	בְּנֵי	bənē	bənē
	צָרְכִּי	ṣorkī	ṣorkī
	חָכְמָה	ḥāḵəmā	ḥāḵəmā		ambiguous case: could be ḥāḵəmā or ḥoḵmā, but I think ḥāḵəmā is the preferred default
	שִׁפְרָה	šip̄rā	šip̄rā
	שָׁכְבְּךָ	šoḵbəḵā	šoḵbəḵā
	הָפְכָּה	hop̄kā	hop̄kā		made-up word, but a particular potentially problematic Unicode situation
	קָטְבּוֹ	qoṭbō	qoṭbō		another particular potentially problematic Unicode situation
	נִשְׂרְפָה	niśrəp̄ā	niśrəp̄ā
	בָּנָיו	bānāw	bānāw
	בָּנֶיהָ	bānehā	bānehā
	מִצְוֹת	miṣwōṯ	miṣwōṯ
	זִוּוּג	ziwwūḡ	ziwwūḡ
	רֹאשׁ	rōš	rōš
	רֵאשִׁית	rēšīṯ	rēšīṯ
	רִאשׁוֹן	rīšōn	rīšōn
	מְלָאכָה	məlāḵā	məlāḵā
	מְלֶאכֶת	məleḵeṯ	məleḵeṯ
	חֵטְא	ḥēṭ	ḥēṭ
	בָּרָאתָ	bārāṯā	bārāṯā
	חַטֹּאות	ḥaṭṭōṯ	ḥaṭṭōṯ
	יְראוּ	yərū	yərū
	וַיֶּאְסֹר	wayyeʾsōr	wayyeʾsōr
	הָחְלַט	hoḥlaṭ	hoḥlaṭ
	וַיֵּבְךְּ	wayyēḇk	wayyēḇk
	אַרְאֶךָּ	ʾarʾekkā	ʾarʾekkā
	וַיַּשְׁקְ	wayyašq	wayyašq
	אַתְּ	ʾatt	ʾatt
	וּוָווֹ	ūwāwō	ūwāwō
	וָו	wāw	wāw
	תָּו	tāw	tāw
	קַו	qaw	qaw
	לָאו	lāw	lāw
	חַי	ḥay	ḥay
	חָי	ḥāy	ḥāy		pausal
	פִּיו	pīw	pīw
	כִּסְלֵו	kislēw	kislēw
	גּוֹי	gōy	gōy
	גֹּי	gōy	gōy
	גֹּיִים	gōyīm	gōyīm
	רָאוּי	rāʾūy	rāʾūy
	קִיא	qī	qī
	יָבִיאוּ	yāḇīʾū	yāḇīū	5
	יְבִיאוּן	yəḇīʾūn	yəḇīūn	5
	מֵאוּן	mēʾūn	mēʾūn
	מֵיאוּן	mēʾūn	mēyūn	3
	בּוֹאוּ	bōʾū	bōʾū
	בֹּאוּ	bōʾū	bōʾū
	בּוּאוּ	būʾū	būʾū		made-up word, but may help identify the issue
	אָבִיאָה	ʾāḇīʾā	ʾāḇīʾā
	מֵאָה	mēʾā	mēʾā
	גֵּיאָהּ	gēʾāh	gēʾāh
	אָבוֹאָה	ʾāḇōʾā	ʾāḇōʾā
	אָבֹאָה	ʾāḇōʾā	ʾāḇōʾā
	נְשׂוּאָה	nəśūʾā	nəśūʾā
	קִיאוֹ	qīʾō	qīō	3
	גֵּאוֹ	gēʾō	gēʾō
	גֵּיאוֹ	gēʾō	gēʾō
	בּוֹאוֹ	bōʾō	bōʾō
	בֹּאוֹ	bōʾō	bōʾō
	מִלּוּאוֹ	millūʾō	millūʾō
	מִי	mī	mī
	אִיִּים	ʾiyyīm	ʾiyyīm
	אִיּוֹב	ʾiyyōḇ	ʾiyyōḇ
	אִיּוּן	ʾiyyūn	ʾiyyūn
	אַיִן	ʾayin	ʾayin
	בּוֹא	bō	bō
	יְפֵהפֶה	yəp̄ēp̄e	yəp̄ēp̄e
	אֹהֶל	ʾōhel	ʾōhel
	הָאֹהֱלָה	hāʾōhĕlā	hāʾōhĕlā
	אָהֳלוֹ	ʾohŏlō	ʾāhŏlō	2
	אָהָלְךָ	ʾoholəḵā	ʾāhāləḵā	2
	יִשָּׂשכָר	yiśśāḵār	yiśśāḵār		Still undecided if this actually needs to be handled
	הוֹשִׁיעָה נָּא	hōšīʿā nnā	hōšīʿā nnā
	עַד בֹּאֲךָ	ʿaḏ bōʾăḵā	ʿaḏ bōʾăḵā
	וַיַּשְׁקְ אֶת הַצֹּאן	wayyašq ʾeṯ haṣṣōn	wayyašq ʾeṯ haṣṣōn
	בְּנֵי בְרָק	bənē ḇərāq	bənē ḇərāq
	בְרָק	ḇərāq	ḇərāq
	אִישׁ יְהוּדִי הָיָה בְּשׁוּשַׁן הַבִּירָה וּשְׁמוֹ מָרְדֳּכַי בֶּן יָאִיר בֶּן־שִׁמְעִי בֶּן־קִישׁ אִישׁ יְמִינִי׃	ʾīš yəhūḏī hāyā bəšūšan habbīrā ūšəmō mordŏḵay ben yāʾīr ben-šimʿī ben-qīš ʾīš yəmīnī.	ʾīš yəhūḏī hāyā bəšūšan habbīrā ūšəmō mordŏḵay ben yāʾīr ben-šimʿī ben-qīš ʾīš yəmīnī.
	אִ֣ישׁ יְהוּדִ֔י הָיָ֖ה בְּשׁוּשַׁ֣ן הַבִּירָ֑ה וּשְׁמ֣וֹ מָרְדֳּכַ֗י בֶּ֣ן יָאִ֧יר בֶּן־שִׁמְעִ֛י בֶּן־קִ֖ישׁ אִ֥ישׁ יְמִינִֽי׃	ʾīš yəhūḏī hāyā bəšūšan habbīrā ūšəmō mordŏḵay ben yāʾīr ben-šimʿī ben-qīš ʾīš yəmīnī.	ʾi֣yš yəhūḏi֔y hāyā֖h bəšūša֣n habbīrā֑h ūšəm֣ō mordŏḵa֗y be֣n yāʾi֧yr ben-šimʿi֛y ben-qi֖yš ʾi֥yš yəmīniֽy.	2	fully accented verse; stress should not be indicated in the final syllable
	וַיְהִי הַמַּבּוּל אַרְבָּעִים יוֹם עַל־הָאָרֶץ וַיִּרְבּוּ הַמַּיִם וַיִּשְׂאוּ אֶת־הַתֵּבָה וַתָּרָם מֵעַל הָאָרֶץ׃	wayəhī hammabbūl ʾarbāʿīm yōm ʿal-hāʾā́reṣ wayyirbū hammáyim wayyiśəʾū ʾeṯ-hattēḇā wattā́rom mēʿal hāʾāreṣ.	wayhī hammabbūl ʾarbāʿīm yōm ʿal-hāʾāreṣ wayyirbū hammayim wayyiśʾū ʾeṯ-hattēḇā wattārām mēʿal hāʾāreṣ.	4	a reminder of why this is hard
	וַיְהִ֧י הַמַּבּ֛וּל אַרְבָּעִ֥ים י֖וֹם עַל־הָאָ֑רֶץ וַיִּרְבּ֣וּ הַמַּ֗יִם וַיִּשְׂאוּ֙ אֶת־הַתֵּבָ֔ה וַתָּ֖רָם מֵעַ֥ל הָאָֽרֶץ׃	wayəhī hammabbūl ʾarbāʿīm yōm ʿal-hāʾā́reṣ wayyirbū hammáyim wayyiśəʾū ʾeṯ-hattēḇā wattā́rom mēʿal hāʾāreṣ.	wayhi֧y hammabb֛ūl ʾarbāʿi֥ym y֖ōm ʿal-hāʾā֑reṣ wayyirb֣ū hamma֗yim wayyiśʾū֙ ʾeṯ-hattēḇā֔h wattā֖rām mēʿa֥l hāʾāֽreṣ.	4	fully accented verse version of the above
implicit ktiv/qre that would be nice to have
	הִוא	hī	hī
	יְרוּשָׁלִַם	yərūšālayim	yərūšālayim
	יְרוּשָׁלִָם	yərūšālāyim	yərūšālāyim		pausal form
	יְרוּשָׁלְַמָה	yərūšālaymā	yərūšālaymā
	יְרוּשָׁלְָמָה	yərūšālāymā	yərūšālāymā
ktiv male tests
	חַיָּיב	ḥayyāḇ	ḥayyāḇ
	חַוָּוה	ḥawwā	ḥawwā
	הֱוֵוה	hĕwē	hĕwē
	הַיְינוּ	haynū	haynū
	הִתְכַּוְּונוּ	hiṯkawwənū	hiṯkawwənū
	גַּוְונָא	gawnā	gawnā
	מְייוּחָד	məyūḥāḏ	məyūḥāḏ		there is no way to tell that it really should be məyuḥāḏ, but anyway this test is for the double yod
	כְּדַאי	kəḏay	kəḏay
	כּוּלָּם	kullām	kullām		shuruk does not necessarily imply a long vowel
	קִידּוּשׁ	qiddūš	qiddūš		chiriq male does not necessarily imply a long vowel

test_translit_hebrew:

	Text	Expected	Actual	Differs at	Comments
	מַקְלֵעַ	maklea'	maklea'
	אַבְּסוּרְד	'ab'sur'd	'ab'sur'd		not sure about what should be expected here
	בִּיּוֹמֶטְרִיָּה	biyometriya	biyometriya
	קַפְרִיסִין	kafrisin	kafrisin
	חֹרֶף	khoref	khoref
	טוּרְקִיז	turkiz	tur'kiz	4
	טַחַב	takhav	takhav
	יִוָּלֵד	yivaled	yivaled
	יָקִינְתּוֹן	yakinton	yakinton
	כֻּתְנָה	kutna	kutna
	נַגָּרִיָּה	nagariya	nagariya
	נַעֲלֶה	na'ale	na'ale
	מִצְווֹת	mitsvot	mitsvot
	מָקוֹם	makom	makom
	פֶּרוּאָנִי	peru'ani	peru'ani
	צִדְפָּה	tsidpa	tsidpa
	תׇּכְנָה	tokhna	tokhna
	רְאוּ	r'u	r'u
	גּ׳וּק	juk	juk
	ג׳וּק	juk	juk
	גִּ׳ירָאפָה	jirafa	jirafa
	גִ׳ירָאפָה	jirafa	jirafa
	זַ׳רְגוֹן	zhargon	zhargon
	קַפּוּצִ׳ינוֹ	kapuchino	kapuchino
	סְקוֹץ׳	s'koch	s'koch
	סְתוֹם תַּ׳פֶּה	s'tom ta′pe	s'tom ta′pe
	אִמָּא׳לֶה	'ima′le	'ima′le
	חָזָ״ל	khaza″l	khaza″l
	נַחַ״ל	nakha″l	nakha″l
	רה״מ	rh″m	rh″m
	ב״ה	b″h	b″h
	ת״א	t″'	t″'