aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: 96a9ffb993f15b22df3209bf553b3810a685fd15 (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
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
Overview {#sec:overview .unnumbered}
========

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 `.tex`
source files, in addition to printed books, `TEI xml` compliant critical
editions and/or lexicons that can be searched, analyzed and correlated
in various ways.

License and disclamer {#license-and-disclamer .unnumbered}
=====================

Copyright ⓒ 2016 Robert Alessi

Please send error reports and suggestions for improvements to Robert
Alessi:

-   email: [alessi@robertalessi.net](alessi@robertalessi.net)

-   website: <http://www.robertalessi.net/arabluatex>

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.

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.

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.

This release of arabluatex consists of the following source files:

-   `arabluatex.ins`

-   `arabluatex.dtx`

-   `arabluatex.lua`

-   `arabluatex_voc.lua`

-   `arabluatex_fullvoc.lua`

-   `arabluatex_novoc.lua`

-   `arabluatex_trans.lua`

-   `arabluatex.bib`

Installation {#sec:installation .unnumbered}
============

1.  run `lualatex arabluatex.ins` to produce the `arabluatex.sty` file;

2.  To finish the installation you have to move the following files into
    a directory where LaTeX can find them. See the FAQ on `tex.ac.uk` at
    <http://www.tex.ac.uk/faq/FAQ-inst-wlcf.html> for more on this:

    -   `arabluatex.sty`

    -   `arabluatex.lua`

    -   `arabluatex_voc.lua`

    -   `arabluatex_fullvoc.lua`

    -   `arabluatex_novoc.lua`

    -   `arabluatex_trans.lua`

Development, Git Repository {#sec:devel-git-repos}
===========================

Browse the code {#sec:browse-code .unnumbered}
---------------

You can browse ArabLuaTeX repository on the web:
<http://git.robertalessi.net/arabluatex>

From this page, you can download all the releases of ArabLuaTeX. For
instructions on how to install ArabLuaTeX, please see the “about” tab at
<http://git.robertalessi.net/arabluatex>.

Comments, Feature requests, Bug Reports {#sec:comm-feat-requ .unnumbered}
---------------------------------------

<https://notabug.org/ralessi/arabluatex>

Download the repository {#sec:download-repository .unnumbered}
-----------------------

ArabLuaTeX development is facilitated by git, a distributed version
control system. You will need to install git (most GNU/Linux
distributions package it in their repositories).

Use this command to download the repository

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

A new directory named arabluatex will have been created, containing
ArabLuaTeX. Git hosting

Please, do not use GitHub or GitLab: see
[there](https://libreboot.org/git/#githosting).