From 42067f8524741964c43e8a10c791ad26e98c7888 Mon Sep 17 00:00:00 2001
From: Robert Alessi <alessi@robertalessi.net>
Date: Sun, 24 Jun 2018 18:45:05 +0200
Subject: done documenting the new features

---
 arabluatex.dtx | 241 ++++++++++++++++++++++++++++++++++-----------------------
 1 file changed, 145 insertions(+), 96 deletions(-)

(limited to 'arabluatex.dtx')

diff --git a/arabluatex.dtx b/arabluatex.dtx
index 879a132..97667b3 100644
--- a/arabluatex.dtx
+++ b/arabluatex.dtx
@@ -27,7 +27,7 @@
 %<package-info>\NeedsTeXFormat{LaTeX2e}[1999/12/01]
 %<package-info>\ProvidesPackage{arabluatex}
 %<*package-info>
-    [2018/03/31 v1.11 An ArabTeX-like interface for LuaLaTeX]
+    [2018/06/23 v1.12 An ArabTeX-like interface for LuaLaTeX]
 %</package-info>
 %
 %<*driver>
@@ -150,13 +150,12 @@
 \usepackage[english]{babel}
 \usepackage{dox}
 \doxitem{Option}{option}{options}
-%\def\actualchar{ =} % there's a bug in doxitem; quick fix.
 \usepackage{fontspec}
 \usepackage{hologo}
 \defaultfontfeatures{RawFeature={+liga}}
 \setmainfont{Old Standard}[SmallCapsFont={Latin Modern Roman Caps},
   RawFeature={+mark;+ccmp;+ss05;+ss06}]
-\usepackage{arabluatex}[2018/03/31]
+\usepackage{arabluatex}[2018/06/23]
 \usepackage[nopar]{quran}
 \usepackage[noindex]{nameauth}
 \usepackage{varioref}
@@ -197,6 +196,7 @@
 \usepackage{longtable}
 \usepackage{booktabs}
 \usepackage[defaultlines=3,all]{nowidow}
+\usepackage{needspace}
 \usepackage{tikz}
 \usepackage[breakable, skins, listings, xparse]{tcolorbox}
 \DeclareTCBListing{arabluacode}{s O{}}{colback=white, boxrule=.15mm,
@@ -318,10 +318,7 @@
 % 
 % \author{Robert Alessi \\
 % \href{mailto:alessi@robertalessi.net?Subject=arabluatex}%
-% {\texttt{alessi@robertalessi.net}}\thanks{Institutional email:
-% \href{mailto:robert.alessi@cnrs.fr?Subject=arabluatex}%
-% {\texttt{robert.alessi@cnrs.fr}}}}
-% \affil{\normalsize CNRS UMR 8167 Paris (France)}
+% {\texttt{alessi@robertalessi.net}}}
 % \date{}
 % 
 % \maketitle
@@ -503,22 +500,22 @@
 %
 % \section{The basics of \package{arabluatex}}
 % \subsection{Activating \package{arabluatex}}
-% As usual put in your preamble:\\
+% \package{arabluatex} is loaded the usual way:\\
 % \arabluaverb{\usepackage{arabluatex}}\\
 % The only requirement of \package{arabluatex} is \hologo{LuaLaTeX};
-% it will complain if you try to compile your document with another
+% it will complain if the document is compiled with another
 % engine. That aside, \package{arabluatex} does not load packages such
-% as \package{polyglossia} or \package{luabidi}. It can work with
-% \package{polyglossia} though, but does not require it.
+% as \package{polyglossia}. Although it can work with
+% \package{polyglossia}, it does not require it.
 %
 % \paragraph{Font setup}
-% If you wish to use your own Arabic font, you can define it before
-% loading \package{arabluatex}. Assuming that \package{fontspec} is
-% loaded, put this in your preamble just above the line that loads
-% \package{arabluatex}:
+% Any Arabic font can be defined to be used with
+% \package{arabluatex}. For example, assuming that \package{fontspec}
+% is loaded, this line may be inserted in the preamble, just above the
+% line that loads \package{arabluatex}:
 % \arabluabox{\cs{newfontfamily}\cs{arabicfont}\marg{fontname}[Script=Arabic]}
 % \noindent where \meta{fontname} is the standard name of the Arabic
-% font you wish to use.
+% font to be used.
 %
 % By default, if no Arabic font is selected, \package{arabluatex} will
 % issue a warning message and attempt to load the Amiri
@@ -621,19 +618,18 @@ advisable to use \cs{SetArbEasy}.
 % \fi
 % \end{itemize}
 % 
-% \DescribeMacro{\SetArbEasy} \NEWfeature{v1.4.4}
-% \DescribeMacro{\SetArbEasy*} \DescribeMacro{\SetArbDflt} Such
-% refinements as \enquote*{classic} \arb[trans]{maddaT} may be
-% discarded by the \cs{SetArb\allowbreak{}Easy} command, either
-% globally in the preamble or locally at any point of the
-% document. The difference between \cs{SetArbEasy} and its
-% \enquote*{starred} version \cs{SetArbEasy*} is that the former keeps
-% the \arb[trans]{sukUn} that is generated by the |fullvoc| mode,
-% while the latter further takes it away. Default \enquote*{classic}
-% rules may be set back at any point of the document with the
-% \cs{SetArbDflt} command. \NEWfeature{v1.6}
-% \DescribeMacro{\SetArbDflt*}Assimilation rules laid on
-% \vref{ref:assimilation} may also be applied by the
+% \DescribeMacro{\SetArbEasy} \NEWfeature{v1.4.4} Such refinements as
+% \enquote*{classic} \arb[trans]{maddaT} may be discarded by the
+% \cs{SetArbEasy} command, either globally in the preamble or locally
+% at any point of the document. The difference between \cs{SetArbEasy}
+% and its \enquote*{starred} version
+% \DescribeMacro{\SetArbEasy*}\cs{SetArbEasy*} is that the former
+% keeps the \arb[trans]{sukUn} that is generated by the |fullvoc|
+% mode, while the latter further takes it away. Default
+% \enquote*{classic} rules may be set back at any point of the
+% document with the \DescribeMacro{\SetArbDflt}\cs{SetArbDflt}
+% command. \NEWfeature{v1.6} \DescribeMacro{\SetArbDflt*}Assimilation
+% rules laid on \vref{ref:assimilation} may also be applied by the
 % \enquote*{starred} version of this command \cs{SetArbDflt*} either
 % in the preamble or at any point of the document.\footnote{For an
 % example, see \vref{sec:poetry-example}.} Examples follow:---
@@ -798,7 +794,8 @@ vowels (see §~3).
 %\subsection{Consonants}
 % \Cref{tab:arabtex-consonants} gives the Arab\TeX\ equivalents for
 % all of the Arabic consonants.
-% 
+%
+% \needspace{7\baselineskip}
 % \newcommand{\dmg}[1]{%
 %   \SetTranslitConvention{dmg}%
 %   \arb[trans]{#1}}
@@ -809,6 +806,10 @@ vowels (see §~3).
 %   \SetTranslitConvention{arabica}%
 %   \arb[trans]{#1}\SetTranslitConvention{dmg}}
 % \begin{longtable}{lllll}
+% \bottomrule
+% \caption*{\Cref*{tab:arabtex-consonants}: Standard Arab\TeX\
+% (consonants)}
+% \endfoot
 % \captionlistentry{Arab\TeX\ consonants}\\[-1em]
 % \toprule
 % Letter & \multicolumn{3}{l}{Transliteration\footnotemark}
@@ -857,8 +858,6 @@ vowels (see §~3).
 % the letter \arb[novoc]{.y} with no diacritical points below, see
 % \emph{Rem{.} b.} below.} \\
 % \arb[novoc]{T} & \dmg{aT} & \loc{aT} & \brill{aT} & |T| \\
-% \bottomrule
-% \caption*{\Cref*{tab:arabtex-consonants}: Standard Arab\TeX\ (consonants)}
 % \end{longtable}
 % \begin{quoting}
 %   \textsc{Rem.}~\emph{a.} Please note that in all cases of elision,
@@ -900,6 +899,10 @@ vowels (see §~3).
 % the Arab\TeX\ equivalents for some additional Persian characters.
 % 
 % \begin{longtable}{lllll}
+% \bottomrule
+% \caption*{\Cref*{tab:arabtex-additional-characters}: Standard
+% Arab\TeX\ (additional characters)}
+% \endfoot
 % \captionlistentry{Arab\TeX\ additional characters}\\[-1em]
 % \toprule
 % Letter & \multicolumn{3}{l}{Transliteration\footnotemark}
@@ -928,9 +931,6 @@ vowels (see §~3).
 % \arb[novoc]{g} & \dmg{g} & \loc{g} & \brill{g} & \verb|g| \\
 % \arb[novoc]{^n}\footnote{See \cref{fn:not-in-dmg}.} & \dmg{^n} &
 % \loc{^n} & \brill{^n} & \verb|^n| \\
-% \bottomrule
-% \caption*{\Cref*{tab:arabtex-additional-characters}: Standard
-% Arab\TeX\ (additional characters)}
 % \end{longtable}
 % \begin{quoting}
 %   \textsc{Rem.} The alveolar consonants \arb[novoc]{^c} and
@@ -942,8 +942,13 @@ vowels (see §~3).
 % \subsubsection{Long vowels}
 % \Cref{tab:arabtex-long-vowels} gives the Arab\TeX\ equivalents for
 % the Arabic long vowels.
-% 
+%
+% \needspace{7\baselineskip}
 % \begin{longtable}{lllll}
+% \bottomrule
+% \caption*{\Cref*{tab:arabtex-long-vowels}: Standard Arab\TeX\ (long
+% vowels)}
+% \endfoot
 % \captionlistentry{Arab\TeX\ long vowels}\\[-1em]
 % \toprule
 % Letter & \multicolumn{3}{l}{Transliteration\footnotemark}
@@ -966,8 +971,6 @@ vowels (see §~3).
 % \arb[novoc]{B_a} & \dmg{B_a} & \loc{B_a} & \brill{B_a} & \verb|_a| \\
 % \arb[novoc]{B_u} & \dmg{B_u} & \loc{B_u} & \brill{B_u} & \verb|_u| \\
 % \arb[novoc]{B_i} & \dmg{B_i} & \loc{B_i} & \brill{B_i} & \verb|_i| \\
-% \bottomrule
-% \caption*{\Cref*{tab:arabtex-long-vowels}: Standard Arab\TeX\ (long vowels)}
 % \end{longtable}
 %
 % \begin{quoting}
@@ -1004,6 +1007,10 @@ vowels (see §~3).
 % the Arabic short vowels.
 % 
 % \begin{longtable}{lllll}
+% \bottomrule
+% \caption*{\Cref*{tab:arabtex-short-vowels}: Standard Arab\TeX\
+% (short vowels)}
+% \endfoot
 % \captionlistentry{Arab\TeX\ short vowels}\\[-1em]
 % \toprule
 % Letter & \multicolumn{3}{l}{Transliteration\footnotemark}
@@ -1022,8 +1029,6 @@ vowels (see §~3).
 % \arb[voc]{BaN} & \dmg{BaN} & \loc{BaN} & \brill{BaN} & \verb|aN| \\
 % \arb[voc]{BuN} & \dmg{BuN} & \loc{BuN} & \brill{BuN} & \verb|uN| \\
 % \arb[voc]{BiN} & \dmg{BiN} & \loc{BiN} & \brill{BiN} & \verb|iN| \\
-% \bottomrule
-% \caption*{\Cref*{tab:arabtex-short-vowels}: Standard Arab\TeX\ (short vowels)}
 % \end{longtable}
 %
 % Whether Arabic texts be vocalized or not is essentially a matter of
@@ -1613,11 +1618,11 @@ vowels (see §~3).
 %   |mu.hammaduN| |'l-nabI| \arb[fullvoc]{mu.hammaduN 'l-nabI}
 %   \arb[trans]{\uc{m}u.hammaduN 'l-nabI}, |salAmuN| |ud_hulUA|
 %   \arb[fullvoc]{salAmuN ud_hulUA} \arb[trans]{salAmuN ud_hulUA},
-%   |qa.sIdata-hu| |fI| |qatl-i| |\uc{'a}bI| |\uc{m}uslimiN|
-%   |'llatI| |yaqUlu| |fI-hA| \arb[fullvoc]{qa.sIdata-hu fI qatl-i
-%   \uc{'a}bI \uc{m}uslimiN 'llatI yaqUlu fI-hA}
-%   \arb[trans]{qa.sIdata-hu fI qatl-i \uc{'a}bI \uc{m}uslimiN
-%   'llatI yaqUlu fI-hA}.
+%   |qa.sIdata-hu| |fI| |qatl-i| |\uc{'a}bI|
+%   |\uc{m}|\allowbreak|uslimiN| |'llatI| |yaqUlu| |fI-hA|
+%   \arb[fullvoc]{qa.sIdata-hu fI qatl-i \uc{'a}bI \uc{m}uslimiN
+%   'llatI yaqUlu fI-hA} \arb[trans]{qa.sIdata-hu fI qatl-i \uc{'a}bI
+%   \uc{m}uslimiN 'llatI yaqUlu fI-hA}.
 % \end{quote}
 %
 % \subsection{Special orthographies}
@@ -1842,27 +1847,29 @@ vowels (see §~3).
 % possible carriers the \arb[trans]{hamzaT} may take.
 % 
 % \begin{longtable}{lllll}
+% \bottomrule
+% \caption*{\Cref*{tab:quoted-hamza}: \enquote{Quoted}
+% \arb[trans]{hamzaT}}
+% \endfoot
 % \captionlistentry{\enquote{Quoted} \arb[trans]{hamzaT}}\\[-1em]
-% \toprule
-% Letter & \multicolumn{3}{l}{Transliteration\footnotemark}
+% \toprule Letter & \multicolumn{3}{l}{Transliteration\footnotemark}
 % & Arab\TeX\ notation \\
-%        & \texttt{dmg} & \texttt{loc} & \texttt{arabica} & \\ \midrule
+% & \texttt{dmg} & \texttt{loc} & \texttt{arabica} & \\ \midrule
 % \endfirsthead
-% \toprule
-% Letter & \multicolumn{3}{l}{Transliteration}
+% \toprule Letter & \multicolumn{3}{l}{Transliteration}
 % & Arab\TeX\ notation \\
-%        & \texttt{dmg} & \texttt{loc} & \texttt{arabica} & \\ \midrule
-% \endhead \footnotetext{See below \vref{sec:transliteration}.}
+% & \texttt{dmg} & \texttt{loc} & \texttt{arabica} & \\ \midrule
+% \endhead
+% \footnotetext{See below \vref{sec:transliteration}.}
 % \label{tab:quoted-hamza}
 % \arb[novoc]{|"'} & \dmg{|"'} & \loc{|"'} & \brill{|"'} & \verb+|"'+ \\
+% \pagebreak[1]
 % \arb[novoc]{A"'} & \dmg{A"'} & \loc{A"'} & \brill{A"'} & \verb|A"'| \\
 % \arb[novoc]{a"'} & \dmg{a"'} & \loc{a"'} & \brill{a"'} & \verb|a"'| \\
 % \arb[novoc]{u"'} & \dmg{u"'} & \loc{u"'} & \brill{u"'} & \verb|u"'| \\
 % \arb[novoc]{w"'} & \dmg{w"'} & \loc{w"'} & \brill{w"'} & \verb|w"'| \\
 % \arb[novoc]{i"'} & \dmg{i"'} & \loc{i"'} & \brill{i"'} & \verb|i"'| \\
 % \arb[novoc]{y"'} & \dmg{y"'} & \loc{y"'} & \brill{y"'} & \verb|y"'| \\
-% \bottomrule
-% \caption*{\Cref*{tab:quoted-hamza}: \enquote{Quoted} \arb[trans]{hamzaT}}
 % \end{longtable}
 %
 % As one can see from \vref{tab:quoted-hamza}, the carrier of the
@@ -1921,7 +1928,7 @@ vowels (see §~3).
 \begin{arabluacode}
   This is wrong:
   \begin{arab}[fullvoc]
-    fa-lammA ra'aW\LRfootnote{A footnote that interferes with the
+    fa-lammA ra'aW\LRfootnote{A footnote which interferes with the
       contextual analysis.} 'l-na^gma...
   \end{arab}
 \end{arabluacode}
@@ -1957,20 +1964,23 @@ word that \cs{arbnull} is applied to.
 % \fi
 \begin{arabluacode}
   \begin{arab}[fullvoc]
-    fa-lammA ra'aW\arbnull{'l-na^gma}\LRfootnote{A footnote that
+    fa-lammA ra'aW\arbnull{'l-na^gma}\LRfootnote{A footnote which
       interferes with the contextual analysis.} 'l-na^gma...
 
-    qAla\LRfootnote{A footnote that interferes with the contextual
+    qAla\LRfootnote{A footnote which interferes with the contextual
       analysis.} \arbnull{qAla}uhrub fa-lan tuqtala.
 
-    \uc{z}ayduN\arbnull{ibnu}\LRfootnote{A footnote that interferes
-      with the contextual analysis.} \arbnull{zayduN}ibn-u
-    \uc{`a}mriNU.\LRfootnote{See \vref{fn:zayd-is-son}.}
+    \uc{z}ayduN\arbnull{ibnu}\LRfootnote{A footnote which
+      interferes with the contextual analysis.}
+    \arbnull{zayduN}ibn-u \uc{`a}mriNU.\LRfootnote{See
+      \vref{fn:zayd-is-son}.}
   \end{arab}
+  
   \begin{arab}[trans]
-    \uc{z}ayduN\arbnull{ibnu}\LRfootnote{A footnote that interferes
-      with the contextual analysis.} \arbnull{zayduN}ibn-u
-    \uc{`a}mriNU.\LRfootnote{See \vref{fn:zayd-is-son}.}
+    \uc{z}ayduN\arbnull{ibnu}\LRfootnote{A footnote which
+      interferes with the contextual analysis.}
+    \arbnull{zayduN}ibn-u \uc{`a}mriNU.\LRfootnote{See
+      \vref{fn:zayd-is-son}.}
   \end{arab}
 \end{arabluacode}
 % \iffalse
@@ -2044,7 +2054,7 @@ word that \cs{arbnull} is applied to.
 %
 % \NEWfeature{v1.12}\cs{abjad} may also be used to convert values of
 % counters into \arb[trans]{'ab^gad} numbers, like so:--- %
-% \changes{v1.12}{2018/05/29}{\cs{abjad} can now process \LaTeX\
+% \changes{v1.12}{2018/06/23}{\cs{abjad} can now process \LaTeX\
 % counters}%
 % \iffalse
 %<*example>
@@ -2073,6 +2083,10 @@ word that \cs{arbnull} is applied to.
 %
 % For the time being, the following is included:---
 % \begin{longtable}{lllll}
+% \bottomrule
+% \caption*{\Cref*{tab:additional-arabic-codings}: Additional Arabic
+% codings}
+% \endfoot
 % \captionlistentry{Additional Arabic codings}\\[-1em]
 % \toprule
 % Letter & \multicolumn{3}{l}{Transliteration\footnotemark}
@@ -2092,10 +2106,8 @@ word that \cs{arbnull} is applied to.
 % \arb[novoc]{.k} & \dmg{.k} & \loc{.k} & \brill{.k} & |.k| \\
 % \arb[novoc]{.n} & \dmg{.n} & \loc{.n} & \brill{.n} & |.n| \\
 % \arb[novoc]{((} & \dmg{((} & \loc{((} & \brill{((} & |((| \\
+% \pagebreak
 % \arb[novoc]{))} & \dmg{))} & \loc{))} & \brill{))} & |))| \\
-% \bottomrule
-% \caption*{\Cref*{tab:additional-arabic-codings}: Additional Arabic
-% codings}
 % \end{longtable}
 % 
 % \begin{quote}
@@ -2480,6 +2492,10 @@ word that \cs{arbnull} is applied to.
 % a default list which consists of the following
 % at the time of writing:---\\
 % \begin{longtable}{llp{.3\linewidth}p{.3\linewidth}}
+% \bottomrule
+% \caption*{\Cref*{tab:arabtex-additional-marks}: Additional Arabic
+% marks}
+% \endfoot
 % \captionlistentry{Additional Arabic marks}\\[-1em]
 % \toprule
 % Codepoint & Shorthand & Glyph & Transliteration \\ \midrule
@@ -2492,9 +2508,6 @@ word that \cs{arbnull} is applied to.
 % |FDF5| & |salam| & \arb{\arbmark{salam}} & \arbmark{salam} \\
 % |FDFA| & |slm| & \arb{\arbmark{slm}} & \arbmark{slm} \\
 % |FDFB| & |jalla| & \arb{\arbmark{jalla}} & \arbmark{jalla} \\
-% \bottomrule
-% \caption*{\Cref*{tab:arabtex-additional-marks}: Additional Arabic
-% marks}
 % \end{longtable}
 % 
 % \DescribeMacro{\newarbmark} \NEWfeature{v1.11} \cs{newarbmark} is
@@ -2645,9 +2658,13 @@ word that \cs{arbnull} is applied to.
 % encodings.
 %
 % \Cref{tab:arbcolor-diacritics} gives the Arab\TeX\ equivalents for
-% the diacritics to be rendered inside or just after \cs{arbcolor}.
+% the diacritics to be printed inside or just after \cs{arbcolor}.
 % 
 % \begin{longtable}{lllll}
+% \bottomrule
+% \caption*{\Cref*{tab:arbcolor-diacritics}: Arab\TeX\ diacritics
+% for \cs{arbcolor}}
+% \endfoot
 % \captionlistentry{Arab\TeX\ diacritics for \cs{arbcolor}}\\[-1em]
 % \toprule
 % Diacritic & \multicolumn{3}{l}{Transliteration\footnotemark}
@@ -2661,12 +2678,10 @@ word that \cs{arbnull} is applied to.
 % \endhead \footnotetext{See below \vref{sec:transliteration}.}
 % \label{tab:arbcolor-diacritics}
 % \arb{B.a} & \dmg{.a} & \loc{.a} & \brill{.a} & \verb|.a| \\
+% \pagebreak[1]
 % \arb{B.u} & \dmg{.u} & \loc{.u} & \brill{.u} & \verb|.u| \\
 % \arb{B.i} & \dmg{.i} & \loc{.i} & \brill{.i} & \verb|.i| \\ \midrule
 % \arb{Bo} & \dmg{o} & \loc{o} & \brill{o} & \verb|o| \\
-% \bottomrule
-% \caption*{\Cref*{tab:arbcolor-diacritics}: Arab\TeX\ diacritics
-% for \cs{arbcolor}}
 % \end{longtable}
 %
 % The following examples show how the letters, or the diacritics above
@@ -2785,7 +2800,12 @@ word that \cs{arbnull} is applied to.
 %   \arb[trans]{wa-\arbcolor[red]{\arbnull{wa}i}stisqA'uN}\footnote{To
 %   the knowledge of the writer, the \arb[trans]{wa.slaT} alone is not
 %   part of the Arabic Unicode block.}.
-%   
+%
+%   |fI| |"al".i-\arbcolor[red]{\arbnull{'l-}i}btidA'i|
+%   \arb[fullvoc]{fI "al".i-\arbcolor[red]{\arbnull{'l-}i}btidA'i}
+%   \linebreak
+%   \arb[trans]{fI "al".i-\arbcolor[red]{\arbnull{'l-}i}btidA'i}.
+%
 %   |\arbcolor[red]{'a'\arbnull{k}}kulu|
 %   \arb{\arbcolor[red]{'a'\arbnull{k}}kulu}
 %   \arb[trans]{\arbcolor[red]{'a'\arbnull{k}}kulu},\\
@@ -2795,7 +2815,7 @@ word that \cs{arbnull} is applied to.
 % \end{quote}
 %
 % The Unicode codepoint of the \arb[trans]{maddaT} is 0653, while bare
-% \arb[trans]{'alif} is 0627. So:---
+% \arb[trans]{'alif} is 0627. So:--- %
 % \iffalse
 %<*example>
 % \fi
@@ -2821,7 +2841,8 @@ word that \cs{arbnull} is applied to.
 % rendered in red. Thus the Arabic mark must generate the
 % \arb[trans]{^saddaT} alone---of which the Unicode codepoint is
 % 0651---in Arabic script and the letter \enquote*{l} in
-% transliteration:--- \iffalse
+% transliteration:--- %
+%\iffalse
 %<*example>
 % \fi
 \begin{arabluacode}
@@ -2833,6 +2854,35 @@ word that \cs{arbnull} is applied to.
 %</example>
 % \fi%
 %
+% \paragraph{\texorpdfstring{The definite article and the euphonic
+% \arb[trans]{ta^sdId}}{The definite article and the euphonic tašdīd}}
+% The intricate business of rendering in color the initial
+% \arb[trans]{'alif al-wa.sl} of the definite article followed by a
+% solar consonant must be unraveled.
+%
+% From the examples provided above, in |fI 'l-nAsi| \arb[fullvoc]{fI
+% 'l-nAsi} \arb[trans]{fI 'l-nAsi}, the initial \arb[trans]{'alif-u
+% 'l-wa.sl-i} can be rendered in red like so:
+% |\arbcolor[red]{\arbnull{al-}a}|
+% \arb[fullvoc]{\arbcolor[red]{\arbnull{al-}a}}. Then, the following
+% two letters, namely |l-n|, must print the string \arb[trans]{lAm}
+% $+$ \arb[trans]{nUn} $+$ \arb[trans]{^saddaT} in Arabic, and exactly
+% \txtrans{n-n} in transliteration. Thus an Arabic mark is
+% needed:--- %
+% \iffalse
+%<*example>
+% \fi
+\begin{arabluacode}
+  \newarbmark{lnn}{^^^^0644^^^^0646^^^^0651}{n-n}
+  \arb[fullvoc]{fI\arbnull{al-}
+    \arbcolor[red]{\arbnull{al-}a}\arbmark{lnn}Asi}
+  \arb[trans]{fI\arbnull{al-}
+    \arbcolor[red]{\arbnull{al-}a}\arbmark{lnn}Asi}.
+\end{arabluacode}
+% \iffalse
+%</example>
+% \fi%
+%
 % \paragraph{\texorpdfstring{\arb[trans]{hamzaT}}{hamzah}}
 % The \enquote*{quoting} technique provides an easy way to determine
 % the carrier of the \arb[trans]{hamzaT}, as shown in
@@ -3270,6 +3320,9 @@ muhaddamaTaN mi'_danatu-hu}: \arb[trans]{ra'aytu
 % are also available.
 % 
 % \begin{longtable}{llllll}
+% \bottomrule
+% \caption*{\Cref*{tab:buckwalter-scheme}: Buckwalter scheme}
+% \endfoot
 % \captionlistentry{Buckwalter scheme}\\[-1em]
 % \toprule
 % Letter & \multicolumn{3}{l}{Transliteration\footnotemark}
@@ -3287,6 +3340,7 @@ muhaddamaTaN mi'_danatu-hu}: \arb[trans]{ra'aytu
 % \arb[novoc]{a} & \dmg{a} & \loc{a} & \brill{a} & |A| & |A| \\
 % \arb[novoc]{b} & \dmg{b} & \loc{b} & \brill{b} & |b| & |b| \\
 % \arb[novoc]{t} & \dmg{t} & \loc{t} & \brill{t} & |t| & |t| \\
+% \pagebreak[1]
 % \arb[novoc]{_t} & \dmg{_t} & \loc{_t} & \brill{_t} & |v| & |v| \\
 % \arb[novoc]{j} & \dmg{j} & \loc{j} & \brill{j} & |j| & |j| \\
 % \arb[novoc]{.h} & \dmg{.h} & \loc{.h} & \brill{.h} & |H| & |H| \\
@@ -3298,6 +3352,7 @@ muhaddamaTaN mi'_danatu-hu}: \arb[trans]{ra'aytu
 % \arb[novoc]{s} & \dmg{s} & \loc{s} & \brill{s} & |s| & |s| \\
 % \arb[novoc]{^s} & \dmg{^s} & \loc{^s} & \brill{^s} & |$| & |c| \\
 % \arb[novoc]{.s} & \dmg{.s} & \loc{.s} & \brill{.s} & |S| & |S| \\
+% \pagebreak[1]
 % \arb[novoc]{.d} & \dmg{.d} & \loc{.d} & \brill{.d} & |D| & |D| \\
 % \arb[novoc]{.t} & \dmg{.t} & \loc{.t} & \brill{.t} & |T| & |T| \\
 % \arb[novoc]{.z} & \dmg{.z} & \loc{.z} & \brill{.z} & |Z| & |Z| \\
@@ -3336,8 +3391,6 @@ muhaddamaTaN mi'_danatu-hu}: \arb[trans]{ra'aytu
 % \arb[novoc]{B_a} & \dmg{B_a} & \loc{B_a} & \brill{B_a} &  |`| & |e| \\
 % \midrule
 % \arb[novoc]{--} (\arb[trans]{ta.twIl}) & --- & --- & --- & |_| & |_| \\
-% \bottomrule
-% \caption*{\Cref*{tab:buckwalter-scheme}: Buckwalter scheme}
 % \end{longtable}
 %
 % \paragraph{Transliteration}
@@ -3406,6 +3459,7 @@ muhaddamaTaN mi'_danatu-hu}: \arb[trans]{ra'aytu
 % \fi
 % \end{enumerate}
 %
+% \needspace{4\baselineskip}
 % \section{\LaTeX\ Commands in Arabic environments}
 % \label{sec:commands-in-arb}
 % \paragraph{General principle} \label{ref:cmd-inside-arabic}\LaTeX\
@@ -3475,11 +3529,11 @@ al-muqAtil-Ina.}, wa-kAnat 'ummI min `u.zamA'-i buyUt-i
 % \fi
 \begin{arabluacode}
   \begin{arab}[fullvoc]
-    \uc{z}ayd-uN\LRfootnote{%
+    \uc{z}ayd-uN\arbnull{ibnu}\LRfootnote{%
       \enquote{\arb[trans]{\uc{z}ayd} is the son of
         \arb[trans]{\uc{`a}mr}}: the second noun is not in
       apposition to the first, but forms part of the
-      predicate\ldots} "ibn-u \uc{`a}mr-iNU
+      predicate\ldots} \arbnull{zayduN}ibn-u \uc{`a}mr-iNU
   \end{arab}
 \end{arabluacode}
 % \iffalse
@@ -3835,10 +3889,12 @@ qAla barzawayhi bn-u 'azhar-a, ra's-u 'a.tibbA'-i fAris-a...
 %
 % \paragraph{textcolor}
 % \label{sec:textcolor}
-% The two-argument command
-% \cs{textcolor}\marg{color}\marg{\cs{arb}\oarg{opt}\marg{Ara\-bic
-% text}} is supported inside \cs{begin}|{arab}| \ldots\
-% \cs{end}|{arab}|. One simple example follows:--- %
+% The two-argument command \cs{textcolor}\marg{color}\marg{Ara\-bic
+% text} is supported inside \cs{begin}|{arab}| \ldots\
+% \cs{end}|{arab}|. One simple example
+% follows:\footnote{\package{arabluatex} provides its own
+% \cs{arbcolor} command which is able to render syllabes or diacritics
+% in colors. See \vref{sec:color}.}--- %
 % \iffalse
 %<*example>
 % \fi
@@ -3969,7 +4025,7 @@ wa-ya.sIru ta.hta 'l-jild-i
 %    \begin{macrocode}
 \NeedsTeXFormat{LaTeX2e}
 \ProvidesPackage{arabluatex}%
-[2018/03/31 v1.11 An ArabTeX-like interface for LuaLaTeX]
+[2018/06/23 v1.12 An ArabTeX-like interface for LuaLaTeX]
 \RequirePackage{ifluatex}
 %    \end{macrocode}
 % \package{arabluatex} requires \hologo{LuaLaTeX} of course. Issue a
@@ -4018,12 +4074,6 @@ wa-ya.sIru ta.hta 'l-jild-i
 %    \begin{macrocode}
 \luadirect{dofile(kpse.find_file("arabluatex.lua"))}
 %    \end{macrocode}
-% This is needed by the current versions of \package{polyglossia} and
-% \package{luabidi}.  \package{luabidi} provides a \cs{Footnote}
-% command. Use it as well if it is loaded.
-%    \begin{macrocode}
-\luadirect{tex.enableprimitives("luatex",tex.extraprimitives("omega"))}
-%    \end{macrocode}
 % Font setup. If no Arabic font is selected, issue a warning message
 % and attempt to load the Amiri font which is included in \TeX{}live:
 %    \begin{macrocode}
@@ -4033,8 +4083,7 @@ wa-ya.sIru ta.hta 'l-jild-i
 \newfontfamily\arabicfont[Script=Arabic]{Amiri}\fi}%
 %    \end{macrocode}
 % \begin{macro}{\setRL}
-%   This neutralizes what is defined by the same command in
-%   \package{luabidi}:
+%   This neutralizes what may be defined by other packages:
 %    \begin{macrocode}
 \AtBeginDocument{\def\setRL{\booltrue{al@rlmode}\pardir TRT\textdir TRT}}
 %    \end{macrocode}
@@ -4070,7 +4119,7 @@ wa-ya.sIru ta.hta 'l-jild-i
 % over \package{arabluatex} inside Arabic environments. It is
 % actually coded in Lua.
 % \begin{macro}{\MkArbBreak*}
-% \changes{v1.12}{2018/06/11}{\enquote*{starred} version which
+% \changes{v1.12}{2018/06/23}{\enquote*{starred} version which
 % closes Arabic environments before processing declared commands.}
 % \cs{MkArbBreak*} goes a step further as it directs
 % \package{arabluatex} to close the current Arabic environment before
@@ -4104,7 +4153,7 @@ wa-ya.sIru ta.hta 'l-jild-i
 %    \end{macrocode}
 % \end{macro}
 % \end{macro}
-% \begin{macro}{\arbcolor}\changes{v1.12}{2018/06/10}{Standard color
+% \begin{macro}{\arbcolor}\changes{v1.12}{2018/06/23}{Standard color
 % command for Arabic environments}
 % \cs{arbcolor}\oarg{color}\marg{Arabic text} takes the Arabic text to
 % be colored as argument.
-- 
cgit v1.2.3

