CTAN Comprehensive TeX Archive Network

Direc­tory macros/luatex/latex/arabluatex

README.md

au­thor:

  • Robert Alessi
ti­tle: 'The arablu­a­tex pack­age – README file'

Overview

This pack­age pro­vides for Lua an Arab-like in­ter­face to gen­er­ate Ara­bic writ­ing from an ascii translit­er­a­tion. It is par­tic­u­larly well-suited for com­plex doc­u­ments such as tech­ni­cal doc­u­ments or crit­i­cal edi­tions where a lot of left-to-right com­mands in­ter­twine with Ara­bic writ­ing. arablu­a­tex is able to pro­cess any Arab in­put no­ta­tion. Its out­put can be set in the same modes of vo­cal­iza­tion as Arab, or in dif­fer­ent ro­man translit­er­a­tions. It fur­ther al­lows many ty­po­graph­i­cal re­fine­ments. It will even­tu­ally in­ter­act with some other pack­ages yet to come to pro­duce from .tex source files, in ad­di­tion to printed books, TEI xml com­pli­ant crit­i­cal edi­tions and/or lex­i­cons that can be searched, an­a­lyzed and cor­re­lated in var­i­ous ways.

Li­cense and dis­clamer

ArabLua – Pro­cess­ing Arab no­ta­tion un­der Lua

Copy­right ⓒ 2016–2018 Robert Alessi

Please send er­ror re­ports and sug­ges­tions for im­prove­ments to Robert Alessi:

  • email: <alessi@rober­ta­lessi.net>

This pro­gram is free soft­ware: you can re­dis­tribute it and/or mod­ify it un­der the terms of the GNU Gen­eral Public Li­cense as pub­lished by the Free Soft­ware Foun­da­tion, ei­ther ver­sion 3 of the Li­cense, or (at your op­tion) any later ver­sion.

This pro­gram is dis­tributed in the hope that it will be use­ful, but WITHOUT ANY WARRANTY; with­out even the im­plied war­ranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Gen­eral Public Li­cense for more de­tails.

You should have re­ceived a copy of the GNU Gen­eral Public Li­cense along with this pro­gram. If not, see <http://www.gnu.org/li­censes/>.

This re­lease of arablu­a­tex con­sists of the fol­low­ing source files:

  • arabluatex.ins
  • arabluatex.dtx
  • arabluatex.lua
  • arabluatex_voc.lua
  • arabluatex_fullvoc.lua
  • arabluatex_novoc.lua
  • arabluatex_trans.lua

Li­cense ap­pli­ca­ble to the doc­u­men­ta­tion

Copy­right ⓒ 2016–2018 Robert Alessi

The doc­u­men­ta­tion file arabluatex.pdf that is gen­er­ated from the arabluatex.dtx source is li­censed un­der the Creative Com­mons At­tri­bu­tion-ShareA­like 4.0 In­ter­na­tional Li­cense. To view a copy of this li­cense, visit http://cre­ativecom­mons.org/li­censes/by-sa/4.0/ or send a let­ter to Creative Com­mons, PO Box 1866, Moun­tain View, CA 94042, USA.

In­stal­la­tion

  1. Run 'lualatex arabluatex.ins' to pro­duce the arabluatex.sty file;
  1. To fin­ish the in­stal­la­tion you have to move the fol­low­ing files into a di­rec­tory where can find them. See the FAQ on texfaq.org at https://tex­faq.org/FAQ-inst-wlcf for more on this:
-   `arabluatex.sty`
-   `arabluatex-patch.sty`
-   `arabluatex.lua`
-   `arabluatex_voc.lua`
-   `arabluatex_fullvoc.lua`
-   `arabluatex_novoc.lua`
-   `arabluatex_trans.lua`
  1. Ad­di­tion­ally, those who use emacs with AUC may copy arabluatex.el to their ~/.emacs.d/auctex/auto lo­cal di­rec­tory. This will en­able the ap­pro­pri­ate hooks for ArabLua in AUC.

Devel­op­ment, Git Re­pos­i­tory

Browse the code

You can browse ArabLua repos­i­tory on the web: http://git.rober­ta­lessi.net/arablu­a­tex

From this page, you can down­load all the re­leases of ArabLua. For in­struc­tions on how to in­stall ArabLua, please see above.

Com­ments, Fea­ture re­quests, Bug Re­ports

https://no­tabug.org/ra­lessi/arablu­a­tex/is­sues

Down­load the repos­i­tory

ArabLua de­vel­op­ment is fa­cil­i­tated by git, a dis­tributed ver­sion con­trol sys­tem. You will need to in­stall git (most GNU/Linux dis­tri­bu­tions pack­age it in their repos­i­to­ries).

Use this com­mand to down­load the repos­i­tory

git clone http://git.robertalessi.net/arabluatex

A new di­rec­tory named arablu­a­tex will have been cre­ated, con­tain­ing ArabLua.

Git host­ing

Make an ac­count on https://no­tabug.org and nav­i­gate (while logged in) to https://no­tabug.org/ra­lessi/arablu­a­tex. Click Fork and you will have in your ac­count your own repos­i­tory of arabluatex where you will be able to make what­ever changes you like to.

Down­load the con­tents of this pack­age in one zip archive (843.0k).

arablu­a­tex – An Arab-like in­ter­face for Lua

This pack­age pro­vides for Lua an Arab-like in­ter­face to gen­er­ate Ara­bic writ­ing from an ascii translit­er­a­tion. It is par­tic­u­larly well-suited for com­plex doc­u­ments such as tech­ni­cal doc­u­ments or crit­i­cal edi­tions where a lot of left-to-right com­mands in­ter­twine with Ara­bic writ­ing. arablu­a­tex is able to pro­cess any Arab in­put no­ta­tion. Its out­put can be set in the same modes of vo­cal­iza­tion as Arab, or in dif­fer­ent ro­man translit­er­a­tions. It fur­ther al­lows many ty­po­graph­i­cal re­fine­ments. It will even­tu­ally in­ter­act with some other pack­ages yet to come to pro­duce from .tex source files, in ad­di­tion to printed books, TEI xml com­pli­ant crit­i­cal edi­tions and/or lex­i­cons that can be searched, an­a­lyzed and cor­re­lated in var­i­ous ways.

Pack­agearablu­a­tex
Home pagehttp://www.rober­ta­lessi.net/arablu­a­tex
Bug trackerhttps://no­tabug.org/ra­lessi/arablu­a­tex/is­sues
Re­pos­i­toryhttp://git.rober­ta­lessi.net/arablu­a­tex
Ver­sion1.15.1 2018-10-11
Li­censesCC BY-SA 4.0
GNU Gen­eral Public Li­cense, ver­sion 3 or newer
Copy­right2016–2018 Robert Alessi
Main­tainerRobert Alessi
TDS archivearabluatex.tds.zip
Con­tained inTeX Live as arablu­a­tex
MiKTeX as arablu­a­tex
TopicsMulti-lin­gual
Ara­bic
Lua
...
Guest Book Sitemap Contact Contact Author