From 3a323f1740ab27c06354124b389e1e94d7e2c81b Mon Sep 17 00:00:00 2001
From: Robert Alessi <alessi@robertalessi.net>
Date: Fri, 11 Mar 2016 20:44:58 +0100
Subject: =?UTF-8?q?corrected=20final=20t=C4=81=CA=BE=20marb=C5=AB=E1=B9=AD?=
 =?UTF-8?q?a,=20writing=20documentation=20(continued)?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 arabluatex.dtx | 27 ++++++++++++++++++++++++---
 1 file changed, 24 insertions(+), 3 deletions(-)

(limited to 'arabluatex.dtx')

diff --git a/arabluatex.dtx b/arabluatex.dtx
index 0e7f8db..ef1a9a6 100644
--- a/arabluatex.dtx
+++ b/arabluatex.dtx
@@ -282,13 +282,13 @@
 % font\footnote{\textcite{pkg:amiri}.} like so:\\
 % \arabluaverb{\newfontfamily\arabicfont[Script=Arabic]{Amiri}}
 % \begin{quote}\footnotesize
-%   \textbf{Rem.} By default Amiri places the \arb[trans]{kasra} in
+%   \textbf{Rem.} By default Amiri places the \arb[trans]{kasraT} in
 %   combination with the \arb[trans]{ta^sdId} below the consonant,
 %   like so: \arb{BBi}\,. This is correct, as at least in the oldest
 %   manuscripts {\newfontfamily\arabicfont[Script=Arabic,
 %   RawFeature={+ss05}]{Amiri}\arb{BBi}} may stand for \arb{BBa} as
 %   well as \arb{BBi}\,. See \textcite[i.14.C--D]{Wright}. The placement
-%   of the \arb[trans]{kasra} above the consonant may be obtained by
+%   of the \arb[trans]{kasraT} above the consonant may be obtained by
 %   selecting the |ss05| feature of the Amiri font, like
 %   so:\footnote{See the documentation of \package{amiri},
 %   \textcite[5]{pkg:amiri}.}\\
@@ -301,7 +301,28 @@
 % \package{arabluatex} may be loaded with four global options, each of
 % which may be overriden at any point of the document:
 % 
-% \DescribeOption{voc}\hfill\arabluaverb{default}\\ good for me
+% \DescribeOption{voc}\hfill\arabluaverb{default}\\ In this mode,
+% which is the one selected by default, every short vowel written
+% generates its corresponding diacritical mark: \arb[trans]{.dammaT}
+% (\arb{Bu}), \arb[trans]{fat.haT} (\arb{Ba}) and \arb[trans]{kasraT}
+% (\arb{Bi}). If a vowel is followed by \meta{N}, then the
+% corresponding \arb[trans]{tanwIn} (\arb{BuN}, \arb{BaN}\,,
+% \arb{TaN}, \arb{BaN_A} or \arb{BiN}) is generated. Finally, \meta{u,
+% a, i} at the commencement of a word indicate a \enquote{connective
+% \arb[trans]{'alif}\,} (\arb[trans]{'alifu 'l-wa.sli}), but |voc| mode
+% does not show the \arb[trans]{wa.slaT} above the \arb[trans]{'alif};
+% instead, the accompanying vowel is expressed (\arb{u a i}).
+%
+% \DescribeOption{fullvoc}\\ In addition to what the |voc| mode does,
+% |fullvoc| expresses the \arb[trans]{sukUn} and the
+% \arb[trans]{wa.slaT}.
+%
+% \DescribeOption{novoc}\\ None of the diacritics is showed in |novoc|
+% mode, unless otherwise specified.
+%
+% \DescribeOption{trans} \\
+%
+%
 % \begin{itemize}
 %   \item voc Vocalized Arabic
 %   \item novoc Full vocalized Arabic
-- 
cgit v1.2.3

