The SIL Arabic script fonts are encoded according to Unicode, so your application must support Unicode text in order to access letters other than the standard ANSI characters. Most applications now provide basic Unicode support. You will, however, need some way of entering Unicode text into your document.

Arabic script is a complex and difficult script, and this complexity is compounded by the fact that Arabic script is used for many different languages and cultures with variations in acceptable calligraphic style. From a computer perspective at least, the technologies used to implement Arabic script are not yet fully mature. The result is that while a given font might work for one set of languages on a given software platform, the same font might not work for other languages or on other platforms. This means that it is very difficult to give an accurate answer to the question of software requirements.

Requirements

This font is supported by all major operating systems (macOS, Windows, Linux-based, iOS, and Android), however the extent of that support depends on the individual OS and application.

Installation

Install the font by decompressing the .zip archive and installing the font using the standard font installation process for .ttf (TrueType/OpenType) fonts for your platform. For additional tips see the help page on Font installation.

Keyboarding and character set support

This font package does not include keyboards or other software for entering text. To type the symbols in this font, use the keyboarding systems provided in your OS or use a separate utility. Keyman is a cross-platform keyboarding system.

Various other means may be available for different operating-system platforms to create additional input methods. Some suggestions are listed here: Keyboard Systems Overview.

See Character set support for details of the Unicode characters supported by this font.

Keyman keyboards

Keyman provides quite a few keyboards for languages which use the Nastaliq style of Arabic script. Go to Keyman.com. Click on Keyboards and then type the language for which you wish to select a keyboard. It will offer you keyboard packages if any are available for that language.

Installing an Urdu keyboard

On Windows 10/11:

  • Open the Language control panel.
  • Click on Add a language.
  • Choose “Urdu (Pakistan)” and click OK.
  • Activate the keyboard using the Taskbar control or language bar.

To see a visual layout for the keyboard:

On Windows 10/11: see Use the On-Screen Keyboard (OSK) to type.

Rendering and application support

The Awami Nastaliq font requires software enabled with the very latest Graphite engine (version 1.3.4+) in order to render correctly. The font does not support OpenType rendering. It will not work with standard software such as Microsoft Office.

Currently, the only software that can render Awami Nastaliq are the Firefox web browser, the LibreOffice suite, XeTeX/XeLaTeX, and linguistic software such as FieldWorks, Paratext, PTXprint, and Bloom.

If a developer wishes to add support for Graphite, the Graphite engine is available here.

Here are links for downloading appropriate versions:

Firefox

You will need a recent version of Firefox – version 46 or later.

Due to security concerns, Graphite has sometimes been disabled in Firefox by default, so you might need to enable it. Follow these instructions for enabling Graphite in Firefox.

LibreOffice

We recommend LibreOffice 5.3+ which supports version 1.3.8 of the Graphite engine.

Version 5.2 fixed the bug that was in version 5.1.

Version 5.1 supports Awami, but it has a bug where certain characters (eg, the small tah) would be displayed in an incorrect position.

XeTeX

The TeXLive 2017 version of XeTeX contains a fix for Harfbuzz which was causing combining marks to clash at the end of words when followed by a Latin character.

TeXLive is available from https://www.tug.org/texlive/.

Full Collision Avoidance

To use the full collision avoidance (both intra- and inter- word) of Awami in XeTeX (required version 0.99995 or newer) a macro parameter needs to be set.

Explanations of this parameter are at:

https://tug.org/pipermail/xetex/2016-February/026398.html
https://tug.org/pipermail/xetex/2016-February/026401.html
https://tug.org/pipermail/xetex/2016-February/026402.html
https://tug.org/pipermail/xetex/2016-February/026403.html
https://tug.org/pipermail/xetex/2016-February/026474.html

This parameter should be set in a .tex file. The file could look something like:

%% Cross-space contextualization

% No cross-space contextualization.
% This is how XeTeX behaves by default.
% Most projects will use this setting.
% \XeTeXinterwordspaceshaping = 0

% Some cross-space contextualization.
% Spaces between words are adjusted,
% but the rendering of individual words is not affected by the spaces.
% \XeTeXinterwordspaceshaping = 1

% Full cross-space contextualization.
% Spaces between words are adjusted,
% and the rendering of individual words is affected by the spaces.
% \XeTeXinterwordspaceshaping = 2

You must uncomment the appropriate command! For Awami Nastaliq, you will likely want to uncomment the last line (\XeTeXinterwordspaceshaping = 2). That allows the full support for collision avoidance.

The above text (all comments and commented out statements) will give the same behaviour as before this feature was added to XeTeX, so existing users do not see any unexpected changes.

Bidi Support

XeTeX in TeXLive 2017+ uses the latest version of Harfbuzz (1.4.6+) which fixes a bug in bidirectional data.

Web fonts

Web font versions of this font (in WOFF and WOFF2 formats) are available in the web folder. These can be copied to a web server and used as fonts on web pages. A very basic HTML/CSS demo page is also included. For more information on the options and techniques available for using these fonts on web pages see Using SIL Fonts on Web Pages.

Text conversion

One common type of data conversion is from Roman script to Arabic script. Cross-script conversion is often very language specific. TECkit is one program that can be used for character encoding conversion. TECkit allows users to write their own custom conversion mappings. The TECkit package is available for download from SIL’s TECkit Web site. The SIL Converters software will be an important tool in data conversion.

One page that may prove helpful is: Roman Script to Arabic Script Conversion.

Other suggestions are listed here: Introduction to Text Conversion and Transliteration.

See also: Arabic Fonts — Resources.

Advanced features

See Font features for further information.