aboutsummaryrefslogtreecommitdiff
path: root/about.html
blob: f00e3e1510db35951e9a5c5163bb1d94570124f9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
<h1 id="sec:overview" class="unnumbered">Overview</h1>
<p>This package provides for LuaLaTeX an Arab<span>TeX</span>-like interface to generate Arabic writing from an <span style="font-variant: small-caps;">ascii</span> transliteration. It is particularly well-suited for complex documents such as technical documents or critical editions where a lot of left-to-right commands intertwine with Arabic writing. arabluatex is able to process any ArabTeX input notation. Its output can be set in the same modes of vocalization as ArabTeX, or in different roman transliterations. It further allows many typographical refinements. It will eventually interact with some other packages yet to come to produce from <code>.tex</code> source files, in addition to printed books, <code>TEI xml</code> compliant critical editions and/or lexicons that can be searched, analyzed and correlated in various ways.</p>
<h1 id="license-and-disclamer" class="unnumbered">License and disclamer</h1>
<p>Copyright ⓒ 2016 Robert Alessi</p>
<p>Please send error reports and suggestions for improvements to Robert Alessi:</p>
<ul>
<li><p>email: <a href="alessi@robertalessi.net" class="uri">alessi@robertalessi.net</a></p></li>
<li><p>website: <a href="http://www.robertalessi.net/arabluatex" class="uri">http://www.robertalessi.net/arabluatex</a></p></li>
</ul>
<p>This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.</p>
<p>This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.</p>
<p>You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.</p>
<p>This release of arabluatex consists of the following source files:</p>
<ul>
<li><p><code>arabluatex.ins</code></p></li>
<li><p><code>arabluatex.dtx</code></p></li>
<li><p><code>arabluatex.lua</code></p></li>
<li><p><code>arabluatex_voc.lua</code></p></li>
<li><p><code>arabluatex_fullvoc.lua</code></p></li>
<li><p><code>arabluatex_novoc.lua</code></p></li>
<li><p><code>arabluatex_trans.lua</code></p></li>
<li><p><code>arabluatex.bib</code></p></li>
</ul>
<h1 id="sec:installation" class="unnumbered">Installation</h1>
<ol>
<li><p>run <code>lualatex arabluatex.ins</code> to produce the <code>arabluatex.sty</code> file;</p></li>
<li><p>To finish the installation you have to move the following files into a directory searched by LaTeX. See the FAQ on CTAN at /help/uk-tex-faq for more on this:</p>
<ul>
<li><p><code>arabluatex.sty</code></p></li>
<li><p><code>arabluatex.lua</code></p></li>
<li><p><code>arabluatex_voc.lua</code></p></li>
<li><p><code>arabluatex_fullvoc.lua</code></p></li>
<li><p><code>arabluatex_novoc.lua</code></p></li>
<li><p><code>arabluatex_trans.lua</code></p></li>
</ul></li>
</ol>