aboutsummaryrefslogtreecommitdiff
path: root/README.tex
blob: adcee9c264a57b7417b613e97f602ee6c049b516 (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
117
118
\documentclass{article}

\usepackage{fontspec,luatextra}

\title{The arabluatex package}
\author{Robert Alessi}
\usepackage{hyperref}

\begin{document}
\maketitle

\section*{Overview}
\label{sec:overview}
This package provides for Lua\LaTeX\ an Arab{\TeX}-like interface to
generate Arabic writing from an \textsc{ascii} 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 Arab\TeX\ input notation. Its output can be set in the
same modes of vocalization as Arab\TeX, 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 \verb|.tex| source files, in addition to printed books,
\texttt{TEI xml} compliant critical editions and/or lexicons that can
be searched, analyzed and correlated in various ways.

\section*{License and disclamer}
Copyright ⓒ 2016  Robert Alessi

\addcontentsline{toc}{section}{License and disclamer} Please send
error reports and suggestions for improvements to Robert Alessi:
\begin{itemize}
\item email: \url{alessi@robertalessi.net}
\item website: \url{http://www.robertalessi.net/arabluatex}
\end{itemize}

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:
\begin{itemize}
\item \verb|arabluatex.ins|
\item \verb|arabluatex.dtx|
\item \verb|arabluatex.lua|
\item \verb|arabluatex_voc.lua|
\item \verb|arabluatex_fullvoc.lua|
\item \verb|arabluatex_novoc.lua|
\item \verb|arabluatex_trans.lua|
\item \verb|arabluatex.bib|
\end{itemize}

\section*{Installation}
\label{sec:installation}
\begin{enumerate}
\item run \verb+lualatex arabluatex.ins+ to produce the
  \verb+arabluatex.sty+ file;
\item To finish the installation you have to move the following files
  into a directory where LaTeX can find them. See the FAQ on
  \verb|tex.ac.uk| at
  \url{http://www.tex.ac.uk/faq/FAQ-inst-wlcf.html} for more on this:
\begin{itemize}
\item \verb|arabluatex.sty|
\item \verb|arabluatex.lua|
\item \verb|arabluatex_voc.lua|
\item \verb|arabluatex_fullvoc.lua|
\item \verb|arabluatex_novoc.lua|
\item \verb|arabluatex_trans.lua|
\end{itemize}
\end{enumerate}

\section{Development, Git Repository}
\label{sec:devel-git-repos}
\subsection*{Browse the code}
\label{sec:browse-code}

You can browse ArabLua\TeX\ repository on the web:
\url{http://git.robertalessi.net/arabluatex}

From this page, you can download all the releases of ArabLua\TeX. For
instructions on how to install ArabLua\TeX, please see the ``about''
tab at \url{http://git.robertalessi.net/arabluatex}.

\subsection*{Comments, Feature requests, Bug Reports}
\label{sec:comm-feat-requ}
\url{https://notabug.org/ralessi/arabluatex}

\subsection*{Download the repository}
\label{sec:download-repository}
ArabLua\TeX\ 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
\begin{verbatim}
git clone http://git.robertalessi.net/cgit.cgi/arabluatex
\end{verbatim}


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

Please, do not use GitHub or GitLab: see
\href{https://libreboot.org/git/#githosting}{there}.

\end{document}