Module:pa-Arab-translit/documentation

	This module documentation page is in beta stage.
	Module has been updated. It should work as expected for majority of the words. It may have problems with diphthongs and a minority of Arabic loanwords. Module needs verification from other native Punjabi speakers who understand Shahmukhi lemmas with diacritics, because this is quite difficult to get your head wrapped around. Check documentation for further listed problems.

This module will transliterate text in the Shahmukhi script. It is also used to transliterate Old Punjabi, Pahari-Potwari, and Saraiki.

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:pa-Arab-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.

Introduction

....

Exceptions

The following words do not need any diacritics:

Notes

نْ should be written as ن٘ when it is from an inherited nasal vowel (i.e. most cases)
Shahmukhi distinguishes Sukoon/Jazm diacritic ءْ with the absence of a diacritic ء;
- Sukoon/Jazm should be used where there is a true consonant cluster, such as in تْرے (trai), بْھرا (bhrā), گْراں (grāṉ) etc.
- The diacritic should be absent where there is a weak or semi-deleted schwa ([ə̆] or [ᵊ], rarely also [ɪ̆] and [ʊ̆]), most commonly at the end of words such as in مَجّھ (majjhă), ناࣇ (nāḷĭ) etc. but also medially as in چَھڈّݨا (chaḍḍăṇā), دَسّݨا (dassăṇā) etc.
Final ہ (h) should be written double if it joins to the previous letter, such as in مُون٘ہہ (mūṉh), ایہہ (eh) but not اوہ (oh). This does not apply when final ہ (h) is used as a vowel, e.g. in چُوچَہ (cūcā) or بارَہ (bārhā̃).

To do list

Sort out any problems with diphthongs
- make sure all diphthongs are represented correctly
- change īū -> iyū
Arabic loanwords
- al and non al words
- archaic ha murtaba tah
Diacritics detector
Distinction between a schwa and loanwords ـہ | need not diacritics when a schwa ('..a') and need when loanword ('..ah')

Working Template Examples

Headword-line templates

With replacing header:
{{pa-noun|gur=ਮਸੀਤ|g=f|head=مَسِیت}}

Check: مسیت (example can't be shown on module documentation)

Without (needing to) replacing header:
{{pa-noun|g=f|gur=ਅਲਮਾਰੀ}}

Check: الماری (example can't be shown on module documentation)

Other templates

{{ux|pa|مَیں کَلّھ لَندَن جا رہا واں۔|I am going to London tomorrow.}}:

مَیں کَلّھ لَندَن جا رِہا واں۔

maiṉ kallh landan jā rihā vāṉ.

I am going to London tomorrow.

Status

Last updated: 23/08/2021