done documenting \ayah. updated to v1.15

1 files changed, 67 insertions, 5 deletions

diff --git a/arabluatex.dtx b/arabluatex.dtx
index 50af415..db2b663 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/08/29 v1.14 An ArabTeX-like interface for LuaLaTeX]
+    [2018/10/09 v1.15 An ArabTeX-like interface for LuaLaTeX]
 %</package-info>
 %
 %<*driver>
@@ -158,7 +158,7 @@
 \usepackage{newunicodechar}
 \newunicodechar{ǧ}{ǧ} % Old Standard does not include ǧ/Ǧ
 \newunicodechar{Ǧ}{Ǧ} %
-\usepackage{arabluatex}[2018/08/29]
+\usepackage{arabluatex}[2018/10/09]
 \usepackage[nopar]{quran}
 \usepackage[noindex]{nameauth}
 \usepackage{varioref}
@@ -258,7 +258,7 @@
 %</driver>
 % \fi
 %
-% \CheckSum{0}
+% \CheckSum{899}
 %
 % \CharacterTable
 %  {Upper-case    \A\B\C\D\E\F\G\H\I\J\K\L\M\N\O\P\Q\R\S\T\U\V\W\X\Y\Z
@@ -2610,6 +2610,68 @@ word that \cs{arbnull} is applied to.
 %</example>
 % \fi
 %
+% \subsection{\texorpdfstring{The \prname{qur'An}}{The Qurʾān}}
+% \label{sec:the-quran}
+% This sub-part is destined to become a part of its own, as fine
+% typesetting of \prname{qur'An}ic text is planned in the versions of
+% \package{arabluatex} to come in the medium-term. New functions and
+% new Arabic modes will be available as \package{arabluatex} will
+% mature.
+%
+% \DescribeMacro{\ayah}\NEWfeature{v1.15}For the time being,
+% \cs{ayah}\marg{3-digit number} is provided so as to typeset in
+% Arabic script the number of the \arb[trans]{'AyaT} that it is
+% referred to inside the dedicated mark---Unicode |U+06DD|:
+% \txarb{^^^^06dd}---and inside parentheses in romanized Arabic:---
+% \begin{quote}
+%   |\ayah{123}| \arb{\ayah{123}} \arb[trans]{\ayah{123}}.
+% \end{quote}
+%
+% An example follows:---
+% \iffalse
+%<*example>
+% \fi
+\begin{arabluacode}
+  \SetArbDflt*
+  \newarbmark{alifsp}{^^^^0627}{\arb[trans]{'alif} }
+  \newarbmark{lamsp}{^^^^0644^^^^0653}{\arb[trans]{lAm} }
+  \newarbmark{mim}{^^^^0645^^^^0653}{\arb[trans]{mIm}}
+  \begin{arab}[fullvoc]
+    min ((sUraTi \uc{'l-b}aqaraTi)):
+  \end{arab}
+  \begin{arab}[fullvoc]
+    \arbmark{alifsp}\arbmark{lamsp}\arbmark{mim}~\ayah{1}
+    _d_alika 'l-kit_abu lA rayba fI-hi hudaN_A
+    li-l-muttaqIna~\ayah{2} 'lla_dIna yu'minUna bi-'l-.gaybi
+    wa-yuqImUna 'l-.sal_aUTa wa-mimmA razaqn_a-hum
+    yunfiqUna~\ayah{3}
+  \end{arab}
+\end{arabluacode}
+\begin{arabluacode}[text only]
+  \SetArbDflt*
+  \begin{arab}[trans]
+    min ((sUraTi \uc{'l-b}aqaraTi)):
+  \end{arab}
+  \begin{arab}[trans]
+    \arbmark{alifsp}\arbmark{lamsp}\arbmark{mim}~\ayah{1}
+    _d_alika 'l-kit_abu lA rayba fI-hi hudaN_A
+    li-l-muttaqIna~\ayah{2} 'lla_dIna yu'minUna bi-'l-.gaybi
+    wa-yuqImUna 'l-.sal_aUTa wa-mimmA razaqn_a-hum
+    yunfiqUna~\ayah{3}
+  \end{arab}
+\end{arabluacode}
+% \iffalse
+%</example>
+% \fi
+%
+% \paragraph{Caveat}
+% For some reason, most of the Arabic fonts do not show the number
+% properly: some are only able to display at most two digits, while
+% others display the digits outside the \enquote*{end of
+% \arb[trans]{'AyaT}} sign, let alone those that print the digits
+% stacked. To the knowledge of the writer, this should be reported to
+% the developpers of those fonts.
+% 
 % \section{Color}
 % \label{sec:color}
 % \NEWfeature{v1.12}\package{arabluatex} is able to render in color
@@ -4237,7 +4299,7 @@ wa-ya.sIru ta.hta 'l-jild-i
 %    \begin{macrocode}
 \NeedsTeXFormat{LaTeX2e}
 \ProvidesPackage{arabluatex}%
-[2018/08/29 v1.14 An ArabTeX-like interface for LuaLaTeX]
+[2018/10/09 v1.15 An ArabTeX-like interface for LuaLaTeX]
 \RequirePackage{ifluatex}
 %    \end{macrocode}
 % \package{arabluatex} requires \hologo{LuaLaTeX} of course. Issue a
@@ -4785,7 +4847,7 @@ wa-ya.sIru ta.hta 'l-jild-i
   \fi}
 %    \end{macrocode}
 % \end{macro}
-% \begin{macro}{\ayah}\changes{v1.15}{2018/10/02}{Prints End of Ayah
+% \begin{macro}{\ayah}\changes{v1.15}{2018/10/09}{Prints End of Ayah
 % sign}\cs{ayah}\marg{number} prints up to 3-digit numbers inside
 % \enquote*{end of Ayah} sign (|U+06DD|) or inside parentheses
 % depending on the mode which is selected.