Skip to content
This repository has been archived by the owner on Oct 29, 2024. It is now read-only.
/ m17n-fa-post Public archive

✏️ Persian input method for m17n using postfix modifiers

License

Notifications You must be signed in to change notification settings

sfischer13/m17n-fa-post

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Persian m17n

Persian input method for m17n using postfix modifiers.

For a description of the layout, have a look at the reference, the examples below, and the Wikipedia article about romanization of Persian. In general, this input method is based on the schemes of the Deutsche Morgenländische Gesellschaft, the Encyclopædia Iranica, and the Hans Wehr transliteration system.

Contents

Installation

You have to copy fa-post.mim to a place where m17n can find it (~/.m17n.d/) and then restart your input method.

A recent Linux system with an input method (IBus, UIM, SCIM, Fcitx) that supports the m17n library is required.

Ubuntu + IBus

sudo apt-get install ibus-m17n
git clone https://github.com/sfischer13/m17n-fa-post.git
cd m17n-fa-post
make

Potential Problems

IBus can be buggy if your keyboard is non-US:

Examples

In the examples below, spaces were added for clarification only.

There is a lot more to discover: shortcuts, typography, bi-directional text, …
Check the reference for a documentation of all features.

Letters

Reference

  • Input: yk, dv, sh
  • Output: یک، دو، سه

Arabic variants are available:

  • Input: k: y:

  • Output: ك ي

  • Input: 4: 5: 6:

  • Output: ٤ ٥ ٦

Diacritics are prefixed with ':

  • Input 1: t 'a s^ 's k 'e y l
  • Input 2: t 'a S 's k 'e y l
  • Output: تَشْکِیل

Diacritics

Reference

  • Input: n 'a n 'A n 't n 's
  • Output: نَ نً نّ نْ

Numbers

Reference

A-1 means Alt key plus 1 key.

  • Input: 1 A-2 3 A-4
  • Output: ‏۱ 2 ۳ 4

Symbols + Typography

Reference

  • Input: , ? ...

  • Output: ، ؟ …

  • Input: l A-- l

  • Output: لـل

(Non-)Joiners: ZWNJ/ZWJ

Reference

  • Zero-width non-joiner (ZWNJ)
    • Input: mm m(A-␣)m (A-␣) means Alt key plus Space key.
    • Output: مم م‌م
  • Zero-width joiner (ZWJ)
    • Input: aa a(A-+)a (A-+) means Alt key plus + key.
    • Output: اا ا‍ا

Bi-directional text

Control characters for bi-directional text are available, too.

Reference

There is a lot more to discover: shortcuts, typography, bi-directional text, …

The reference contains a complete documentation of the functionality of m17n-fa-post. If you're interested in how m17n works, you could have a look at the definitions in fa-post.mim.

License

Copyright (c) 2015-2021 Stefan Fischer
The source code is available under the MIT License.
See LICENSE for further details.