aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
0 files changed, 0 insertions, 0 deletions
generated by cgit v1.2.3 (git 2.25.1) at 2024-09-29 02:21:21 +0000
ef='#n73'>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 119 120 121 122 123 124 125 126 
% The arabluatex package -- README file
% Robert Alessi
% May 17, 2016
\documentclass{article}

\usepackage{fontspec,luatextra}
\usepackage{libertine}

\title{The arabluatex package -- README file}
\author{Robert Alessi}
\usepackage{hyperref}
\hypersetup{pdftitle={The arabluatex package -- README file},
  pdfauthor={Robert Alessi}}

\begin{document}
\maketitle

\section*{Overview}
\label{sec:overview}
This package provides for \href{http://luatex.org}{Lua\LaTeX} an
\href{http://ctan.org/pkg/arabtex}{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}
ArabLuaTeX -- Processing ArabTeX notation under LuaLaTeX

Copyright ⓒ 2016  Robert Alessi

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}
\item comments, feature requests, bug reports:
  \url{http://issues.robertalessi.net}
\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 3 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, see
<http://www.gnu.org/licenses/>.

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|
\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: