Raqm is a small library that encapsulates the logic for complex text layout and provide a convenient API.
It currently provides bidirectional text support (using FriBiDi), shaping (using HarfBuzz), with proper script itemization. By the virtue of this, Raqm can support most writing systems covered by Unicode.
This is an early prototype and is still work in progress. We try to not break the API and ABI needlessly, though.
The documentation can be accessed on the web at:
Raqm (Arabic: رَقْم) is writing, also number or digit and the Arabic word for digital (رَقَمِيّ) shares the same root, so it is a play on “digital writing”.
Raqm depends on the follwing libraries:
To build the documentation you will also need:
And the units tests require:
To install dependencies on Ubuntu:
sudo apt-get install libfreetype6-dev libharfbuzz-dev libfribidi-dev \
libglib2.0-dev gtk-doc-tools
On Mac OS X you can use Homeberw:
brew install freetype harfbuzz fribidi glib gtk-doc
export XML_CATALOG_FILES="/usr/local/etc/xml/catalog" # for the docs
Once you have the source code and the dependencies, you can proceed to build. To do that, run the customary sequence of commands in the source code directory:
$ ./configure
$ make
$ make install
To build the documentation, pass --enable-gtk-doc to the configure script.
To run the units tests:
$ make check
Once you have made a change that you are happy with, contribute it back, we’ll be happy to integrate it! Just fork the repository and make a pull request.
- ImageMagick
The follwing projects have patches to support complex text layout using Raqm:
- LibGD: libgd/libgd#196
- Pillow: python-pillow/Pillow#1682
- SDL_ttf: https://bugzilla.libsdl.org/show_bug.cgi?id=3211
- Pygame: https://bitbucket.org/pygame/pygame/pull-requests/52
- Blender: https://developer.blender.org/D1809