From 959ecb27586c882d75d5b8c2dd5e489e5508af49 Mon Sep 17 00:00:00 2001
From: Robert Alessi <alessi@robertalessi.net>
Date: Fri, 1 Jun 2018 21:45:57 +0200
Subject: almost done documenting. ready to merge into master

---
 arabluatex.dtx | 35 +++++++++++++++++++----------------
 1 file changed, 19 insertions(+), 16 deletions(-)

(limited to 'arabluatex.dtx')

diff --git a/arabluatex.dtx b/arabluatex.dtx
index 560405c..e68f64c 100644
--- a/arabluatex.dtx
+++ b/arabluatex.dtx
@@ -2569,7 +2569,7 @@ word that \cs{arbnull} is applied to.
 % \cs{SetTranslitConvention}\marg{mode} command , where \meta{mode}
 % may be either |dmg|, |loc| or |arabica|. This command is also
 % accepted in the preamble should one wish to set the transliteration
-% mode globally, eg.:---%
+% mode globally, e.g.:---%
 % \iffalse
 %<*example>
 % \fi
@@ -2586,7 +2586,7 @@ word that \cs{arbnull} is applied to.
 % also can be changed either globally in the preamble or locally at
 % any point of the document by the \cs{SetTranslitStyle}\marg{style}
 % command, where \meta{style} may be any font shape selection
-% command, eg. \cs{upshape}, \cs{itshape}, \cs{slshape}, and so forth.
+% command, e.g. \cs{upshape}, \cs{itshape}, \cs{slshape}, and so forth.
 %
 % \paragraph{Font} \NEWfeature{v1.4} \DescribeMacro{\SetTranslitFont}
 % \cs{SetTranslitFont}\marg{font selection command} allows any
@@ -3116,7 +3116,7 @@ al-muqAtil-Ina.}, wa-kAnat 'ummI min `u.zamA'-i buyUt-i
 % \fi
 %
 % Some commands, however, do not expect running text in their
-% arguments, or one may wish to insert English text eg. in footnotes
+% arguments, or one may wish to insert English text e.g. in footnotes
 % or in marginal notes. \package{arabluatex} provides a set of
 % commands to handle such cases.
 %
@@ -3252,7 +3252,7 @@ qAla barzawayhi bn-u 'azhar-a, ra's-u 'a.tibbA'-i fAris-a...
 % \item \cs{command}\marg{arg1} (one mandatory argument)
 % \item \cs{command}\oarg{opt1}\marg{arg1} (one optional and one
 %   mandatory argument)
-% \item (\ldots)
+% \item{} [\ldots]
 % \item \cs{command}\oarg{opt1}\oarg{opt2}\marg{arg1}\marg{arg2}
 % (uppermost combination)
 % \end{compactenum}
@@ -3291,18 +3291,19 @@ qAla barzawayhi bn-u 'azhar-a, ra's-u 'a.tibbA'-i fAris-a...
     dajAjaTaN. wa-kAnat dajAjatu-hu 'llatI 'ahdA-hA dUna mA kAna
     yuttaxa_du li-\uc{muwaysiN}. wa-l_akinna-hu bi-karami-hi
     wa-bi-.husni xuluqi-hi 'a.zhara 'l-ta`ajjuba min simani-hA
-    wa-.tIbi la.hmi-hA. wa-kAna <\uc{'abU} \uc{'l-hu_dayli}> yu`rafu
-    bi-'l-'imsAki 'l-^sadIdi. fa-qAla: \enquote{wa-kayfa ra'ayta yA
-      \uc{'abA} \uc{`imrAna} tilka 'l-dajAjaTa?} qAla:
+    wa-.tIbi la.hmi-hA. wa-kAna <\uc{'abU} \uc{'l-hu_dayli}>
+    yu`rafu bi-'l-'imsAki 'l-^sadIdi. fa-qAla: \enquote{wa-kayfa
+      ra'ayta yA \uc{'abA} \uc{`imrAna} tilka 'l-dajAjaTa?} qAla:
     \enquote{kAnat `ajabaN mina 'l-`ajabi!}  fa-yaqUlu:
-    \begin{quoting}[begintext=», endtext=«]
+    \begin{quoting}[begintext=\textquotedblright,
+      endtext=\textquotedblleft]
       wa-tadrI mA jinsu-hA? wa-tadrI mA sinnu-hA?  fa-'inna
-      'l-dajAjaTa 'inna-mA ta.tIbu bi-'l-jinsi wa-'l-sinni. wa-tadrI
-      bi-'ayyi ^say'iN kunnA nusamminu-hA? wa-fI 'ayyi makAniN kunnA
-      na`lifu-hA?
+      'l-dajAjaTa 'inna-mA ta.tIbu bi-'l-jinsi wa-'l-sinni.
+      wa-tadrI bi-'ayyi ^say'iN kunnA nusamminu-hA? wa-fI 'ayyi
+      makAniN kunnA na`lifu-hA?
     \end{quoting}
-    fa-lA yazAlu fI h_a_dA wa-'l-'A_haru ya.d.haku .da.hkaN na`rifu-hu
-    na.hnu wa-lA ya`rifu-hu \uc{'abU} \uc{'l-hu_dayli}.
+    fa-lA yazAlu fI h_a_dA wa-'l-'A_haru ya.d.haku .da.hkaN
+    na`rifu-hu na.hnu wa-lA ya`rifu-hu \uc{'abU} \uc{'l-hu_dayli}.
   \end{arab}
 \end{arabluacode}
 % \iffalse
@@ -3507,9 +3508,11 @@ qAla barzawayhi bn-u 'azhar-a, ra's-u 'a.tibbA'-i fAris-a...
 % \paragraph{\package{reledmac}}
 % \label{sec:reledmac}
 % The two-argument command \cs{edtext}\marg{lemma}\marg{commands} is
-% supported inside \cs{begin}|{arab}| \ldots\ \cs{end}|{arab}|. As an
-% example, one may get \package{arabluatex} and \package{reledmac} to
-% work together like so:---
+% supported inside \cs{begin}|{arab}| \ldots\
+% \cs{end}|{arab}|.\footnote{\cs{pstart} and \cs{pend} are also
+% supported inside the |arab| environment.} As an example, one may get
+% \package{arabluatex} and \package{reledmac} to work together like
+% so:--- %
 % \iffalse
 %<*example>
 % \fi
-- 
cgit v1.2.3

