You can now use eiktub™ technology on your web site!
LinguArabica is pleased to annouce the beta release of an API that allows developers to access the eiktub™ transliteration engine from their web sites. Follow the simple steps below to make any text element on your web page "eiktub-enabled". As in any beta relase, your feedback in reporting bugs and providing suggestions is essential to improving the service. Feel free to contact us at any time.
1. In the header of the html page, insert reference to the eiktub™ API as follows:
2. In the text element (e.g. textbox or textarea) add reference to the class eiktub_api as follows:
<textarea class="eiktub_api" ></textarea>
That's it! Your text element is now "eiktub-enabled". The eiktub™ icon should now appear to the left of the text element as shown in the example below. By clicking on this icon you can change some of the transliteration options such as enabling or disabling vowelization (taHriik).
The eiktub™ API operates in one of the 3 transliteration modes described below:
- Multiple-match: This is the default mode. In the multiple-match mode, eiktub returns a list of Arabic words to choose from for every typed Latin word. Once you type a word, the list will appear after a short pause. If you press space or puncuation, the top word in the list will be automatically chosen. By cliking on a transliterated word, the list will appear once again, giving you the chance to correct your selection. Note that in this early phase of the release, the accuracy of the suggested word list will be modest. As data is gathered from usage, the accuracy is expected to improve considerably.
- Exact BATR: This mode transliterates words by strictly following the Bikdash Arabic Transilteration Rules (BATR). Enable this mode by adding the class eiktub_exact to the text element.
- Fuzzy BATR: In this mode, eiktub attempts to improve the guess of the typed word by invoking some of the rules of Arabic dictation. Enable this mode by adding the class eiktub_fuzzy to the text element.
- Multiple-match: سمر , صمر , سامر, صامر
- Exact BATR: سمأر
- Fuzzy BATR: سمر
The eiktub™ API comes with the following useful features that can be configured by the developer:
- Enabling tips: Add the class eiktub_tips to the text element to display live tips as you type. The tips are designed to help you learn the transliteration scheme.
- Disabling transliteration: Transliteration is enabled by default. Disable transliteartion by default by adding the class eiktub_off to the text element. This feature is especially usefull for text elements where Arabic is only used occasionally.
- Disabling vowelization (taHriik): taHriik is enabled by deafult. Disable taHriik by default by adding the class eiktub_Harakaatoff to the text element.
- Enabling Auto-sukuun: eiktub™ has a new feature called "Auto-sukuun", which assigns the silent vowel (high circle) to any unvowelized letter. This feature is disabled by default. Enable Auto-sukuun by default by adding the class eiktub_autosukuun to the text element.