aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRobert Alessi <alessi@robertalessi.net>2016-03-06 19:54:14 +0100
committerRobert Alessi <alessi@robertalessi.net>2016-03-06 19:54:14 +0100
commitafb31dd98fa8de93b1f3d7698aa70a11160d7421 (patch)
tree13f43e87330872392e56f6cf6c7c575013fb7a12
parentfabbefbf12e079db522910957d5a078dc11fa45a (diff)
downloadarabluatex-afb31dd98fa8de93b1f3d7698aa70a11160d7421.tar.gz
started writing the doc
-rw-r--r--arabluatex.dtx67
1 files changed, 57 insertions, 10 deletions
diff --git a/arabluatex.dtx b/arabluatex.dtx
index 4914d3a..435e905 100644
--- a/arabluatex.dtx
+++ b/arabluatex.dtx
@@ -45,6 +45,8 @@
45\newcommand{\package}[1]{\textsf{#1}} 45\newcommand{\package}[1]{\textsf{#1}}
46\usepackage{paralist} 46\usepackage{paralist}
47\setdefaultitem{\textendash}{\textendash}{\textendash}{\textendash} 47\setdefaultitem{\textendash}{\textendash}{\textendash}{\textendash}
48\usepackage{longtable}
49\usepackage{booktabs}
48\usepackage{tikz} 50\usepackage{tikz}
49\usepackage[skins]{tcolorbox} 51\usepackage[skins]{tcolorbox}
50\usepackage{csquotes} 52\usepackage{csquotes}
@@ -96,7 +98,9 @@
96% \hskip 1sp \marginpar{\small\sffamily\raggedright 98% \hskip 1sp \marginpar{\small\sffamily\raggedright
97% New feature\\#1}} 99% New feature\\#1}}
98% 100%
99% \author{Robert Alessi \\ \url{alessi@robertalessi.net}} 101% \author{Robert Alessi \\
102% \href{mailto:alessi@robertalessi.net?Subject=arabluatex}%
103% {\texttt{alessi@robertalessi.net}}}
100% \date{} 104% \date{}
101% 105%
102% \maketitle 106% \maketitle
@@ -120,9 +124,10 @@
120% \end{abstract} 124% \end{abstract}
121% 125%
122% \section*{License and disclamer} 126% \section*{License and disclamer}
123% \addcontentsline{toc}{section}{License and disclamer} 127% \addcontentsline{toc}{section}{License and disclamer} Please send
124% Please send error reports and suggestions for improvements to 128% error reports and suggestions for improvements to Robert Alessi
125% Robert Alessi <\url{alessi@robertalessi.net}> 129% <\href{mailto:alessi@robertalessi.net?Subject=arabluatex}%
130% {\texttt{alessi@{\allowbreak}robertalessi.net}}>
126% 131%
127% This program is free software; you can redistribute it and/or 132% This program is free software; you can redistribute it and/or
128% modify it under the terms of the GNU General Public License 133% modify it under the terms of the GNU General Public License
@@ -147,14 +152,56 @@
147% the \LuaLaTeX\ users. \package{arabtex} dates back to 1992. As far 152% the \LuaLaTeX\ users. \package{arabtex} dates back to 1992. As far
148% as I know, it was then the first and only way to typeset Arabic 153% as I know, it was then the first and only way to typeset Arabic
149% texts with \TeX\ and \LaTeX. To achieve this, \package{arabtex} 154% texts with \TeX\ and \LaTeX. To achieve this, \package{arabtex}
150% provides an Arabic font in \emph{Nasḫī} style and a macro package 155% provided---and still does---an Arabic font in \emph{Nasḫī} style and
151% that defines its own input notation which is, as the author states, 156% a macro package that defined its own input notation which was, as
152% \enquote{both machine, and human, readable, and suited for 157% the author stated, \enquote{both machine, and human, readable, and
153% electronic transmission and e-mail 158% suited for electronic transmission and e-mail
154% communication}.\footcite[2]{Lagally2004} 159% communication}.\footcite[2]{Lagally2004} Even if the same can be
160% said about Unicode, Arab\TeX\ \textsc{ASCII} input notation still
161% surpasses Unicode input, in my opinion, when it comes to typesetting
162% complex documents, such as scientific documents or critical editions
163% where footnotes and other kind of annotations can be particulary
164% abundant. It must also be said that most text editors have trouble
165% in displaying Arabic script connected with preceding or following
166% \LaTeX\ commands: it often happens that commands seem misplaced, not
167% to mention punctuation marks, or opening or closing braces, brackets
168% or parentheses that are unexpectedly displayed in the wrong
169% direction. Of course, some text editors provide ways to get around
170% such difficulties by inserting invisible Unicode characters, such as
171% LEFT-TO-RIGHT or RIGHT-TO-LEFT MARKS (\texttt{U+200E},
172% \texttt{U+200F}), RTL/LTR \enquote{embed} characters
173% (\texttt{U+202B}, \texttt{U+202A}) and RLO/LRO
174% \enquote{bidi-override} characters (\texttt{U+202E},
175% \texttt{U+202D}).\footnote{Yudit probably has the best Unicode
176% support. See \url{www.yudit.org}.} Nonetheless, it remains that
177% inserting all the time these invisible characters in complex
178% documents rapidly becomes confusing and cumbersome.
179%
155% 180%
156% \section{Usage}
157% 181%
182% \section{Usage}
183% \newcommand{\dmg}[1]{%
184% \SetTranslitConvention{dmg}%
185% \arb[trans]{#1}}
186% \newcommand{\loc}[1]{%
187% \SetTranslitConvention{loc}%
188% \arb[trans]{#1}\SetTranslitConvention{dmg}}
189% \begin{longtable}{llll}
190% \toprule
191% Letter & \multicolumn{2}{l}{Transliteration\footnotemark}
192% & Arab\TeX\ notation \\
193% & \texttt{dmg} & \texttt{loc} & \\ \midrule
194% \endhead \footnotetext{See below **}
195% \arb[novoc]{a} & \dmg{A} & \loc{A} & \verb|a| \\
196% \arb[novoc]{b} & \dmg{b} & \loc{b} & \verb|b| \\
197% \arb[novoc]{t} & \dmg{t} & \loc{t} & \verb|t| \\
198% \arb[novoc]{_t} & \dmg{_t} & \loc{_t} & \verb|_t| \\
199% \arb[novoc]{j} & \dmg{j} & \loc{j} & \verb|^g| or \verb|j| \\
200% \arb[novoc]{.h} & \dmg{.h} & \loc{.h} & \verb|.h| \\
201% \arb[novoc]{x} & \dmg{x} & \loc{x} & \verb|_h| or \verb|x|\\
202% \bottomrule
203% \caption{Standard notation for Arabic}
204% \end{longtable}
158% Usage goes here. 205% Usage goes here.
159% 206%
160% \StopEventually{} 207% \StopEventually{}