diff options
| author | Wael El Oraiby <wael.eloraiby@gmail.com> | 2016-01-30 20:42:20 -0500 |
|---|---|---|
| committer | Wael El Oraiby <wael.eloraiby@gmail.com> | 2016-01-30 20:42:20 -0500 |
| commit | 7828903cc54415d348968e79f6a32b6d90271640 (patch) | |
| tree | 182fed9ef78f57184735a1530813175eb6864eff | |
| parent | 787220cff87d915906341ec2277b79ac2a619ae5 (diff) | |
Update README.md
| -rw-r--r-- | README.md | 10 |
1 files changed, 5 insertions, 5 deletions
@@ -1,4 +1,4 @@ -<U><B>Arabtype</B></U> +# Arabtype A small and simple implementation that transform isolated arabic utf8 character strings into contextual forms useful for rendering (rendering example is provided). @@ -7,7 +7,7 @@ This is mostly suitable for lightweight UIs (embedded systems, games, media play It's worthy to note that this is far more lightweight than HarfBuzz (used by Qt/Pango...). Freetype 2 on the other hand lacks this functionality. -<U><B>Usage:</B></U> +### Usage One call will convert a utf8 string to a sequence of code points: @@ -30,16 +30,16 @@ Where `return`: return the total number of code points transformed -<U><B>Details:</B></U> +### Details Arabic letters have 4 forms: Isolated, Initial, Medial and Ending. An arabic letter will have one of these forms depending on the letters preceding and succeeding it: For instance take the letter ﺡ : This is the isolated form (i.e. nothing precedes nor succeeds it), if it comes at the start of a syllable it will have the initial form ( ﺣ ). If it ends a syllable it will have the ending form ( ﺢ ) and if it is in the middle of a syllable it will have the medial form ( ﺤ ). Some even have more complicated ligature forms (such as Lam and Alef together: ﻻ ) . A utf8 arabic string usually only comprises of isolated letters from [Arabic Unicode Block](http://en.wikipedia.org/wiki/Arabic_%28Unicode_block%29). With this library you will transform it to the rendering/presentation form: [Arabic Presentation Forms B](http://en.wikipedia.org/wiki/Arabic_Presentation_Forms-B) -<U><B>Example ([Khalil Gibran](http://en.wikipedia.org/wiki/Kahlil_Gibran)'s Al-Nay):</B></U> +### Example ([Khalil Gibran](http://en.wikipedia.org/wiki/Kahlil_Gibran)'s Al-Nay)  -<U><B>LICENSE:</B></U> +### LICENSE Arabtype, Copyrights 2012-2015(c) Wael El Oraiby. All rights reserved. |