documenting the features to be included in v1.9.2

1 files changed, 60 insertions, 10 deletions

diff --git a/arabluatex.dtx b/arabluatex.dtx
index 2e503be..c38feaf 100644
--- a/arabluatex.dtx
+++ b/arabluatex.dtx
@@ -1173,13 +1173,16 @@ vowels (see §~3).
 %   \arb[voc]{mas'alaTuN} \arb[trans]{mas'alaTuN}, |'as'alu|
 %   \arb[voc]{'as'alu} \arb[trans]{'as'alu}, |yatasA'alUna|
 %   \arb[voc]{yatasA'alUna}\linebreak \arb[trans]{yatasA'alUna},
-%   |murU'aTuN| \arb[voc]{murU'aTuN} \arb[trans]{murU'aTuN},
-%   |ta'xIruN| \arb[fullvoc]{ta'xIruN} \arb[trans]{ta'xIruN},
-%   |ta'ax|\allowbreak|xara| \arb[voc]{ta'axxara}
-%   \arb[trans]{ta'axxara}, |ji'tu-ka| \arb[voc]{ji'tu-ka}
-%   \arb[trans]{ji'tu-ka}, |qA'iluN| \arb[voc]{qA'iluN}
-%   \arb[trans]{qA'iluN}, |.hIna'i_diN| \arb[trans]{.hIna'i_diN}
-%   \arb[voc]{.hIna'i_diN}.
+%   |murU'aTuN| \arb[voc]{murU'aTuN}, |taw'amuN|
+%   \arb[fullvoc]{taw'amuN} \arb[trans]{taw'amuN},
+%   \arb[trans]{murU'aTuN}, |ta'xIruN| \arb[fullvoc]{ta'xIruN}
+%   \arb[trans]{ta'xIruN}, |ta'ax|\allowbreak|xara|
+%   \arb[voc]{ta'axxara} \arb[trans]{ta'axxara}, |ji'tu-ka|
+%   \arb[voc]{ji'tu-ka} \arb[trans]{ji'tu-ka}, |qA'iluN|
+%   \arb[voc]{qA'iluN} \arb[trans]{qA'iluN}, |.hIna'i_diN|
+%   \arb[trans]{.hIna'i_diN} \arb[voc]{.hIna'i_diN}, |hay'aTuN|
+%   \arb[voc]{hay'aTuN} \arb[trans]{hay\-'aTuN}, |hay'AtuN|
+%   \arb[voc]{hay'AtuN} \arb[trans]{hay'AtuN}.
 %
 %   From \textcite[i. 14 B]{Wright}:--- All consonants, whatsoever,
 %   not even \arb[trans]{'alif} \emph{hèmzatum} excepted, admit of
@@ -1219,7 +1222,8 @@ vowels (see §~3).
 %   \arb[voc]{al-^say'-u} \arb[trans]{al-^say'-u}, |'a^syA'-u|
 %   \arb[voc]{'a^syA'-u} \arb[trans]{'a^syA'-u}, |'a^syA'-a|
 %   \arb[voc]{'a^syA'-a} \arb[trans]{'a^syA'-a}, |.zim'aN|
-%   \arb[voc]{.zim'aN} \arb[trans]{.zim'aN}.
+%   \arb[voc]{.zim'aN} \arb[trans]{.zim'aN}, |radI'aN|
+%   \arb[voc]{radI'aN} \arb[trans]{radI'aN}.
 %
 %   \label{ref:taxfif-hamzah}
 %   \textbf{\arb[trans]{ta_hfIf-u 'l-hamzaT-i}}: if the
@@ -1232,6 +1236,34 @@ vowels (see §~3).
 %   of encoding such sequences, see \vpageref{ref:initial-hamza}
 %   (\arb[trans]{hamzaT} followed by \arb[novoc]{U} and \arb[novoc]{I})
 %   and the \arb[trans]{maddaT} \vpageref{ref:madda}.
+%
+%   Imperatives of verbs that have the \arb[trans]{hamzaT} as the
+%   first radical are other cases of \arb[trans]{ta_hfIf-u
+%   'l-hamzaT-i}: |i'sir| \arb[fullvoc]{i'sir} \arb[trans]{i'sir},
+%   |i'_dan| \arb[fullvoc]{i'_dan} \arb[trans]{i'_dan}, |u'mul|
+%   \arb[fullvoc]{u'mul} \arb[trans]{u'mul}.  \package{arabluatex}
+%   also provides ways of encoding those words when the initial
+%   \arb[trans]{'alif} comes into \arb[trans]{wa.sl}, so as to make
+%   the \arb[trans]{'alif wa.sl} fall away when preceded by
+%   \arb[voc]{wa} or \arb[voc]{fa}: |wa-'sir| \arb[fullvoc]{wa-'sir}
+%   \arb[trans]{wa-'sir}, |fa-'_dan| \arb[fullvoc]{fa-'_dan}
+%   \arb[trans]{fa-'_dan}, |fa-'ti| \arb[fullvoc]{fa-'ti}
+%   \arb[trans]{fa-'ti}, |wa-'tamirUA| \arb[fullvoc]{wa-'tamirUA}
+%   \arb[trans]{wa-'tamirUA}; or be retained outside the imperative,
+%   as in |fa-i'tazarat| \arb[fullvoc]{fa-i'tazarat}
+%   \arb[trans]{fa-i'tazarat}, |ba`da| |i'tilAfiN| \arb[fullvoc]{ba`da
+%   i'tilAfiN} \arb[trans]{ba`da i'tilAfiN}.
+%
+%   \textbf{The strange spelling of \arb[trans]{mi'aTuN}}: |mi'aTuN|
+%   \arb[voc]{mi'aTuN} \arb[trans]{mi'aTuN}, \linebreak |mi'atAni|
+%   \arb[voc]{mi'atAni} \arb[trans]{mi'atAni}, |mi'atayni|
+%   \arb[voc]{mi'atayni} \arb[trans]{mi'atayni}, |mi'Una|
+%   \arb[voc]{mi'Una} \arb[trans]{mi'Una}, |mi'AtuN|
+%   \arb[voc]{mi'AtuN} \arb[trans]{mi'AtuN}, |mi'aN_A|
+%   \arb[voc]{mi'aN_A} \arb[trans]{mi'aN_A}. Of course, the
+%   \enquote*{pipe} character may be used to prevent this rule from
+%   being applied (see \vref{sec:pipe}): \verb+mi'a|TuN+
+%   \arb[voc]{mi'a|TuN} \arb[trans]{mi'a|TuN}.
 % \end{quote}
 %
 % \paragraph{\arb[trans]{maddaT}} \label{ref:madda}At the beginning of
@@ -2000,9 +2032,17 @@ word that \cs{arbnull} is applied to.
 % \begin{quote}
 %   |\abjad{45}:| |kitAbu-hu| |\aemph{fI| |'l-`AdAt-i}|
 %   \arb[voc]{\abjad{45}: kitAbu-hu \aemph{fI 'l-`AdAt-i}}
-%   \arb[trans]{\abjad{45}: kitAbu-hu fI 'l-\cap{`AdAt-i}}.
+%   \arb[trans]{\abjad{45}: kitAbu-hu \aemph{fI 'l-\cap{`AdAt-i}}}.
 % \end{quote}
+% 
+% \begin{quoting}
+%   \textsc{Rem.} As the above example shows, \package{arabluatex}
+%   places the horizontal stroke \emph{under} the emphasized words in
+%   any of the transliteration modes.
 %
+%   \DescribeMacro{\aemph*}\NEWfeature{v1.9.2} 
+% \end{quoting}
+% 
 % \section{Arabic poetry}
 % \label{sec:poetry}
 % \NEWfeature{v1.6} \package{arabluatex} provides a special
@@ -2552,6 +2592,14 @@ muhaddamaTaN mi'_danatu-hu}: \arb[trans]{ra'aytu
 %   'l-nAs-a kAffaT-aN min mu_hA.tabati-hi 'a.had-uN bi-sayyidi-nA}.
 % \end{quoting}
 %
+% \paragraph{Uncertain short vowels}
+% In some printed books, it may happen that more than one short vowel
+% be placed on a consonant in cases where the vocalization is
+% uncertain or ambiguous, like so: \arb[voc]{fa`uaila}. In
+% transliteration, the uncertain vowels go between slashes and are
+% separated by commas: |fa`uaila| \arb[voc]{fa`uaila}
+% \arb[trans]{fa`uaila}.
+%
 % \subsection{Examples}
 % \label{sec:examples-translit}
 % Here follows in transliteration the story of
@@ -3358,7 +3406,9 @@ wa-ya.sIru ta.hta 'l-jild-i
 %    \end{macrocode}
 % \end{macro}
 % \begin{macro}{\aemph} Arabic emphasis. Needs to be redefined as
-% well. The function is actually coded in Lua.
+%   well. The function is actually coded in
+%   Lua. \changes{v1.9.2}{2017/10/24}{\cs{aemph*} Starred version
+%   which always puts the stroke over its argument}
 %    \begin{macrocode}
 \AtBeginDocument{\ifdef{\aemph}%
   {\RenewDocumentCommand{\aemph}{s m}{%