aboutsummaryrefslogtreecommitdiff
path: root/README.tex
diff options
context:
space:
mode:
Diffstat (limited to 'README.tex')
-rw-r--r--README.tex34
1 files changed, 20 insertions, 14 deletions
diff --git a/README.tex b/README.tex
index adcee9c..01cd3bc 100644
--- a/README.tex
+++ b/README.tex
@@ -1,34 +1,40 @@
1% The arabluatex package -- README file
2% Robert Alessi
3% March 5, 2016
1\documentclass{article} 4\documentclass{article}
2 5
3\usepackage{fontspec,luatextra} 6\usepackage{fontspec,luatextra}
7\usepackage{libertine}
4 8
5\title{The arabluatex package} 9\title{The arabluatex package -- README file}
6\author{Robert Alessi} 10\author{Robert Alessi}
7\usepackage{hyperref} 11\usepackage{hyperref}
12\hypersetup{pdftitle={The arabluatex package -- README file},
13 pdfauthor={Robert Alessi}}
8 14
9\begin{document} 15\begin{document}
10\maketitle 16\maketitle
11 17
12\section*{Overview} 18\section*{Overview}
13\label{sec:overview} 19\label{sec:overview}
14This package provides for Lua\LaTeX\ an Arab{\TeX}-like interface to 20This package provides for \href{http://luatex.org}{Lua\LaTeX} an
21\href{http://ctan.org/pkg/arabtex}{Arab\TeX}-like interface to
15generate Arabic writing from an \textsc{ascii} transliteration. It is 22generate Arabic writing from an \textsc{ascii} transliteration. It is
16particularly well-suited for complex documents such as technical 23particularly well-suited for complex documents such as technical
17documents or critical editions where a lot of left-to-right commands 24documents or critical editions where a lot of left-to-right commands
18intertwine with Arabic writing. arabluatex is able to 25intertwine with Arabic writing. arabluatex is able to process any
19process any Arab\TeX\ input notation. Its output can be set in the 26Arab\TeX\ input notation. Its output can be set in the same modes of
20same modes of vocalization as Arab\TeX, or in different roman 27vocalization as Arab\TeX, or in different roman transliterations. It
21transliterations. It further allows many typographical refinements. It 28further allows many typographical refinements. It will eventually
22will eventually interact with some other packages yet to come to 29interact with some other packages yet to come to produce from
23produce from \verb|.tex| source files, in addition to printed books, 30\verb|.tex| source files, in addition to printed books, \texttt{TEI
24\texttt{TEI xml} compliant critical editions and/or lexicons that can 31 xml} compliant critical editions and/or lexicons that can be
25be searched, analyzed and correlated in various ways. 32searched, analyzed and correlated in various ways.
26 33
27\section*{License and disclamer} 34\section*{License and disclamer}
28Copyright ⓒ 2016 Robert Alessi 35Copyright ⓒ 2016 Robert Alessi
29 36Please send error reports and suggestions for improvements to Robert
30\addcontentsline{toc}{section}{License and disclamer} Please send 37Alessi:
31error reports and suggestions for improvements to Robert Alessi:
32\begin{itemize} 38\begin{itemize}
33\item email: \url{alessi@robertalessi.net} 39\item email: \url{alessi@robertalessi.net}
34\item website: \url{http://www.robertalessi.net/arabluatex} 40\item website: \url{http://www.robertalessi.net/arabluatex}
@@ -65,7 +71,7 @@ source files:
65\section*{Installation} 71\section*{Installation}
66\label{sec:installation} 72\label{sec:installation}
67\begin{enumerate} 73\begin{enumerate}
68\item run \verb+lualatex arabluatex.ins+ to produce the 74\item run \verb+'lualatex arabluatex.ins'+ to produce the
69 \verb+arabluatex.sty+ file; 75 \verb+arabluatex.sty+ file;
70\item To finish the installation you have to move the following files 76\item To finish the installation you have to move the following files
71 into a directory where LaTeX can find them. See the FAQ on 77 into a directory where LaTeX can find them. See the FAQ on