Module:fa-ira-translit/documentation

This module will transliterate Iranian Persian text. 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:fa-ira-translit/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.

Notes

THIS MODULE SHOULD NOT BE USED FOR CLASSICAL PERSIAN OR DARI Due to pronunciation differences between modern Iranian Persian from other varieties of Persian, as well ans differences in vowel notation, Iranian Persian cannot be transliterated the same way as other varieties of Persian. If you need to transliterate a variety of Persian other than modern Iranian Persian, use Module:fa-cls-translit.

This module uses Module:fa-cls-translit as a backend.

Test cases

(refresh)

test_translit_persian:

	Text	Expected	Actual	Differs at
	سَرْاَنْجام	sar-anjâm	sar-anjâm
	کُروز	koruz	koruz
	کُرُوز	korowz	korowz
	واو	vâv	vâv
	نُوروز	nowruz	nowruz
	قَهْوِه‌ای	ğahve-i	ğahve-i
	خوانْدَن	xândan	xândan
	خویش	xiš	xiš
	خوَد	xod	xod
	چامِه‌سَرایی	čâme-sarâyi	čâme-sarâyi
	چامه‌سَرایی	(nil)	(nil)	N/A
	طَنین	tanin	tanin
	طَنِین	taneyn	taneyn
	لِهٰذا	lehâzâ	lehâzâ
	عَصاً	asan	asan
	خانه	(nil)	(nil)	N/A
	خانِه	xâne	xâne
	کُرِهٔ شُمالی	kore-ye šomâli	kore-ye šomâli
	ضَمّه	(nil)	(nil)	N/A
	ضَمِّه	zamme	zamme
	وُدْکا	vodkâ	vodkâ
	اَرْمَنِسْتان	armanestân	armanestân
	باکو	bâku	bâku
	بَرادَرِ بُزُرْگ	barâdar-e bozorg	barâdar-e bozorg
	قُرونِ وُسْطیٰ	ğorun-e vostâ	ğorun-e vostâ
	دَرْ-آمَد	dar-âmad	dar-âmad
	بازیِ شَطْرَنْج	bâzi-ye šatranj	bâzi-ye šatranj
	متعلق	(nil)	(nil)	N/A
	مُتَعَلِّق	mota'alleğ	mota'alleğ
	اِتِّحادِیِهٔ اُروپا	ettehâdiye-ye orupâ	ettehâdiye-ye orupâ
	آیَتُ‌اللّٰه	âyato-llâh	âyato-l-lâh	8
	شِیْخ	šeyx	šeyx
	نُوْروز	nowruz	nowruz
	پَیام	payâm	peyâm	2
	اَیّوب	ayyub	eyّub	1
	شِبْهِ‌جَزیرِه	šebh-e-jazire	šebh-e-jazire
	پایْگاهِ‌دادِه	pâygâh-e-dâde	pâygâh-e-dâde
	صَحْرایِ غَرْبی	sahrâ-ye ğarbi	sahrâ-ye ğarbi