aboutsummaryrefslogtreecommitdiff
path: root/arabluatex.dtx
diff options
context:
space:
mode:
Diffstat (limited to 'arabluatex.dtx')
-rw-r--r--arabluatex.dtx133
1 files changed, 72 insertions, 61 deletions
diff --git a/arabluatex.dtx b/arabluatex.dtx
index e68f64c..61375e3 100644
--- a/arabluatex.dtx
+++ b/arabluatex.dtx
@@ -178,12 +178,13 @@
178 arabtex, luatex}} 178 arabtex, luatex}}
179\usepackage[scale=1.5]{ccicons} 179\usepackage[scale=1.5]{ccicons}
180\usepackage[toc,lot]{multitoc} 180\usepackage[toc,lot]{multitoc}
181\usepackage{paralist}
182\setdefaultitem{\textendash}{\textendash}{\textendash}{\textendash}
183\usepackage{enumitem} 181\usepackage{enumitem}
184\setlist{nosep} 182\setlist{nosep}
183\setlist[itemize]{label=\textendash}
184\setlist[enumerate,1]{label=(\alph*)}
185\setlist[enumerate,2]{label=\roman*.}
185\newlist{enumabjad}{enumerate}{10} 186\newlist{enumabjad}{enumerate}{10}
186\setlist[enumabjad]{label={\aemph*{\abjad{\arabic*}}}} 187\setlist[enumabjad]{label={\abjad{\arabic*}}}
187\usepackage{multicol} 188\usepackage{multicol}
188\usepackage{cleveref} 189\usepackage{cleveref}
189\usepackage{quoting} 190\usepackage{quoting}
@@ -335,14 +336,14 @@
335% 336%
336% Please send error reports and suggestions for improvements to Robert 337% Please send error reports and suggestions for improvements to Robert
337% Alessi: 338% Alessi:
338% \begin{compactitem} 339% \begin{itemize}
339% \item email: <\href{mailto:alessi@robertalessi.net?Subject=arabluatex}% 340% \item email: <\href{mailto:alessi@robertalessi.net?Subject=arabluatex}%
340% {\texttt{alessi@robertalessi.net}}> 341% {\texttt{alessi@robertalessi.net}}>
341% \item website: \url{http://www.robertalessi.net/arabluatex} 342% \item website: \url{http://www.robertalessi.net/arabluatex}
342% \item development: \url{http://git.robertalessi.net/arabluatex} 343% \item development: \url{http://git.robertalessi.net/arabluatex}
343% \item comments, feature requests, bug reports: 344% \item comments, feature requests, bug reports:
344% \url{https://notabug.org/ralessi/arabluatex/issues} 345% \url{https://notabug.org/ralessi/arabluatex/issues}
345% \end{compactitem} 346% \end{itemize}
346% 347%
347% \marginpar{\texttt{gpl3+}} 348% \marginpar{\texttt{gpl3+}}
348% This program is free software: you can redistribute it and/or modify 349% This program is free software: you can redistribute it and/or modify
@@ -361,7 +362,7 @@
361% 362%
362% This release of \package{arabluatex} consists of the following 363% This release of \package{arabluatex} consists of the following
363% source files: 364% source files:
364% \begin{compactitem} 365% \begin{itemize}
365% \item |arabluatex.ins| 366% \item |arabluatex.ins|
366% \item |arabluatex.dtx| 367% \item |arabluatex.dtx|
367% \item |arabluatex.lua| 368% \item |arabluatex.lua|
@@ -370,7 +371,7 @@
370% \item |arabluatex_novoc.lua| 371% \item |arabluatex_novoc.lua|
371% \item |arabluatex_trans.lua| 372% \item |arabluatex_trans.lua|
372% \item |arabluatex.el| 373% \item |arabluatex.el|
373% \end{compactitem} 374% \end{itemize}
374% 375%
375% \subsection*{License applicable to this document} 376% \subsection*{License applicable to this document}
376% \label{sec:documentation-license} 377% \label{sec:documentation-license}
@@ -549,12 +550,12 @@
549% transliterates the Arab\TeX\ input into one of the accepted 550% transliterates the Arab\TeX\ input into one of the accepted
550% standards. At present, three standards are supported (see below 551% standards. At present, three standards are supported (see below
551% \vref{sec:transliteration} for more details): 552% \vref{sec:transliteration} for more details):
552% \begin{compactdesc} 553% \begin{description}
553% \item[dmg] \emph{Deutsche Morgenländische Gesellschaft}, which is 554% \item[dmg] \emph{Deutsche Morgenländische Gesellschaft}, which is
554% selected by default; 555% selected by default;
555% \item[loc] \emph{Library of Congress}; 556% \item[loc] \emph{Library of Congress};
556% \item[arabica] \emph{Arabica}. 557% \item[arabica] \emph{Arabica}.
557% \end{compactdesc} 558% \end{description}
558% More standards will be included in future releases of 559% More standards will be included in future releases of
559% \package{arabluatex}. 560% \package{arabluatex}.
560% 561%
@@ -563,7 +564,7 @@
563% \NEWfeature{v.1.2} By default, \package{arabluatex} typesets Arabic 564% \NEWfeature{v.1.2} By default, \package{arabluatex} typesets Arabic
564% in a classic, traditional style the most prominent features of which 565% in a classic, traditional style the most prominent features of which
565% are the following: 566% are the following:
566% \begin{compactitem} 567% \begin{itemize}
567% \item \enquote*{Classic} \arb[trans]{maddaT}: when 568% \item \enquote*{Classic} \arb[trans]{maddaT}: when
568% \arb[trans]{'alif} and \arb[trans]{hamzaT} accompanied by a simple 569% \arb[trans]{'alif} and \arb[trans]{hamzaT} accompanied by a simple
569% vowel or \arb[trans]{tanwIn} is preceded by an \arb[trans]{'alif} of 570% vowel or \arb[trans]{tanwIn} is preceded by an \arb[trans]{'alif} of
@@ -597,7 +598,7 @@ advisable to use \cs{SetArbEasy}.
597% \iffalse 598% \iffalse
598%</example> 599%</example>
599% \fi 600% \fi
600% \end{compactitem} 601% \end{itemize}
601% 602%
602% \DescribeMacro{\SetArbEasy} \NEWfeature{v1.4.4} 603% \DescribeMacro{\SetArbEasy} \NEWfeature{v1.4.4}
603% \DescribeMacro{\SetArbEasy*} \DescribeMacro{\SetArbDflt} Such 604% \DescribeMacro{\SetArbEasy*} \DescribeMacro{\SetArbDflt} Such
@@ -615,44 +616,44 @@ advisable to use \cs{SetArbEasy}.
615% \enquote*{starred} version of this command \cs{SetArbDflt*} either 616% \enquote*{starred} version of this command \cs{SetArbDflt*} either
616% in the preamble or at any point of the document.\footnote{For an 617% in the preamble or at any point of the document.\footnote{For an
617% example, see \vref{sec:poetry-example}.} Examples follow:--- 618% example, see \vref{sec:poetry-example}.} Examples follow:---
618% \begin{compactenum}[(a)] 619% \begin{enumerate}
619% \item \cs{SetArbDflt}: 620% \item \cs{SetArbDflt}:
620% \begin{compactenum}[i.] 621% \begin{enumerate}
621% \item |voc| \arb[voc]{wa-mAta istisqA'aN qabla 'an yutimma 622% \item |voc| \arb[voc]{wa-mAta istisqA'aN qabla 'an yutimma
622% kitAba-hu fI nujUm-i 'l-samA'-i} 623% kitAba-hu fI nujUm-i 'l-samA'-i}
623% \item |fullvoc| \arb[fullvoc]{wa-mAta istisqA'aN qabla 'an yutimma 624% \item |fullvoc| \arb[fullvoc]{wa-mAta istisqA'aN qabla 'an yutimma
624% kitAba-hu fI nujUm-i 'l-samA'-i} 625% kitAba-hu fI nujUm-i 'l-samA'-i}
625% \item |trans| \arb[trans]{wa-mAta istisqA'aN qabla 'an yutimma 626% \item |trans| \arb[trans]{wa-mAta istisqA'aN qabla 'an yutimma
626% kitAba-hu fI nujUm-i 'l-samA'-i} 627% kitAba-hu fI nujUm-i 'l-samA'-i}
627% \end{compactenum} 628% \end{enumerate}
628% \item \cs{SetArbDflt*}: 629% \item \cs{SetArbDflt*}:
629% \begin{compactenum}[i.]\SetArbDflt* 630% \begin{enumerate}\SetArbDflt*
630% \item |voc| \arb[voc]{wa-mAta istisqA'aN qabla 'an yutimma 631% \item |voc| \arb[voc]{wa-mAta istisqA'aN qabla 'an yutimma
631% kitAba-hu fI nujUm-i 'l-samA'-i} 632% kitAba-hu fI nujUm-i 'l-samA'-i}
632% \item |fullvoc| \arb[fullvoc]{wa-mAta istisqA'aN qabla 'an yutimma 633% \item |fullvoc| \arb[fullvoc]{wa-mAta istisqA'aN qabla 'an yutimma
633% kitAba-hu fI nujUm-i 'l-samA'-i} 634% kitAba-hu fI nujUm-i 'l-samA'-i}
634% \item |trans| \arb[trans]{wa-mAta istisqA'aN qabla 'an yutimma 635% \item |trans| \arb[trans]{wa-mAta istisqA'aN qabla 'an yutimma
635% kitAba-hu fI nujUm-i 'l-samA'-i}\SetArbDflt 636% kitAba-hu fI nujUm-i 'l-samA'-i}\SetArbDflt
636% \end{compactenum} 637% \end{enumerate}
637% \item \cs{SetArbEasy}: 638% \item \cs{SetArbEasy}:
638% \begin{compactenum}[i.]\SetArbEasy 639% \begin{enumerate}\SetArbEasy
639% \item |voc| \arb[voc]{wa-mAta istisqA'aN qabla 'an yutimma 640% \item |voc| \arb[voc]{wa-mAta istisqA'aN qabla 'an yutimma
640% kitAba-hu fI nujUm-i 'l-samA'-i} 641% kitAba-hu fI nujUm-i 'l-samA'-i}
641% \item |fullvoc| \arb[fullvoc]{wa-mAta istisqA'aN qabla 'an yutimma 642% \item |fullvoc| \arb[fullvoc]{wa-mAta istisqA'aN qabla 'an yutimma
642% kitAba-hu fI nujUm-i 'l-samA'-i} 643% kitAba-hu fI nujUm-i 'l-samA'-i}
643% \item |trans| \arb[trans]{wa-mAta istisqA'aN qabla 'an yutimma 644% \item |trans| \arb[trans]{wa-mAta istisqA'aN qabla 'an yutimma
644% kitAba-hu fI nujUm-i 'l-samA'-i}\SetArbDflt 645% kitAba-hu fI nujUm-i 'l-samA'-i}\SetArbDflt
645% \end{compactenum} 646% \end{enumerate}
646% \item \cs{SetArbEasy*}: 647% \item \cs{SetArbEasy*}:
647% \begin{compactenum}[i.]\SetArbEasy* 648% \begin{enumerate}\SetArbEasy*
648% \item |voc| \arb[voc]{wa-mAta istisqA'aN qabla 'an yutimma 649% \item |voc| \arb[voc]{wa-mAta istisqA'aN qabla 'an yutimma
649% kitAba-hu fI nujUm-i 'l-samA'-i} 650% kitAba-hu fI nujUm-i 'l-samA'-i}
650% \item |fullvoc| \arb[fullvoc]{wa-mAta istisqA'aN qabla 'an yutimma 651% \item |fullvoc| \arb[fullvoc]{wa-mAta istisqA'aN qabla 'an yutimma
651% kitAba-hu fI nujUm-i 'l-samA'-i} 652% kitAba-hu fI nujUm-i 'l-samA'-i}
652% \item |trans| \arb[trans]{wa-mAta istisqA'aN qabla 'an yutimma 653% \item |trans| \arb[trans]{wa-mAta istisqA'aN qabla 'an yutimma
653% kitAba-hu fI nujUm-i 'l-samA'-i}\SetArbDflt 654% kitAba-hu fI nujUm-i 'l-samA'-i}\SetArbDflt
654% \end{compactenum} 655% \end{enumerate}
655% \end{compactenum} 656% \end{enumerate}
656% 657%
657% \iffalse 658% \iffalse
658%<*example> 659%<*example>
@@ -760,12 +761,12 @@ vowels (see §~3).
760% document, as the \cs{arb} command may take any of the |voc|, 761% document, as the \cs{arb} command may take any of the |voc|,
761% |fullvoc|, |novoc| or |trans| modes as optional argument, like 762% |fullvoc|, |novoc| or |trans| modes as optional argument, like
762% so:--- 763% so:---
763% \begin{compactitem} 764% \begin{itemize}
764% \item \DescribeOption{voc} \cs{arb}|[voc]|\marg{Arabic text}; 765% \item \DescribeOption{voc} \cs{arb}|[voc]|\marg{Arabic text};
765% \item \DescribeOption{fullvoc} \cs{arb}|[fullvoc]|\marg{Arabic text}; 766% \item \DescribeOption{fullvoc} \cs{arb}|[fullvoc]|\marg{Arabic text};
766% \item \DescribeOption{novoc} \cs{arb}|[novoc]|\marg{Arabic text}; 767% \item \DescribeOption{novoc} \cs{arb}|[novoc]|\marg{Arabic text};
767% \item \DescribeOption{trans} \cs{arb}|[trans]|\marg{Arabic text}. 768% \item \DescribeOption{trans} \cs{arb}|[trans]|\marg{Arabic text}.
768% \end{compactitem} 769% \end{itemize}
769% 770%
770% The same optional arguments may be passed to the environment |arab|: 771% The same optional arguments may be passed to the environment |arab|:
771% one may have \cs{begin}|{arab}|\oarg{mode}|...|\cs{end}|{arab}|, 772% one may have \cs{begin}|{arab}|\oarg{mode}|...|\cs{end}|{arab}|,
@@ -1026,7 +1027,7 @@ vowels (see §~3).
1026% That said, there is no need to write the short vowels 1027% That said, there is no need to write the short vowels
1027% \arb[trans]{fat.haT}, \arb[trans]{.dammaT} or \arb[trans]{kasraT} 1028% \arb[trans]{fat.haT}, \arb[trans]{.dammaT} or \arb[trans]{kasraT}
1028% except in the following cases:--- 1029% except in the following cases:---
1029% \begin{compactitem} 1030% \begin{itemize}
1030% \item at the commencement of a word, to indicate that a connective 1031% \item at the commencement of a word, to indicate that a connective
1031% \arb[trans]{'alif} is needed, with the exception of the article (see 1032% \arb[trans]{'alif} is needed, with the exception of the article (see
1032% below \vref{sec:quoting}); 1033% below \vref{sec:quoting});
@@ -1034,7 +1035,7 @@ vowels (see §~3).
1034% analysis to determine the carrier of the \arb[trans]{hamzaT}; 1035% analysis to determine the carrier of the \arb[trans]{hamzaT};
1035% \item in the various transliteration modes, as vowels are always 1036% \item in the various transliteration modes, as vowels are always
1036% expressed in romanized Arabic. 1037% expressed in romanized Arabic.
1037% \end{compactitem} 1038% \end{itemize}
1038% 1039%
1039%\section{\package{arabluatex} in action} 1040%\section{\package{arabluatex} in action}
1040%\subsection{The vowels and diphthongs} 1041%\subsection{The vowels and diphthongs}
@@ -1360,7 +1361,7 @@ vowels (see §~3).
1360% \label{ref:euphonic-tashdid} always follows a vowelless consonant 1361% \label{ref:euphonic-tashdid} always follows a vowelless consonant
1361% which is passed over in pronunciation and assimilated to a following 1362% which is passed over in pronunciation and assimilated to a following
1362% consonant. It may be found \parencite[i. 15 B--16 C]{Wright}:--- 1363% consonant. It may be found \parencite[i. 15 B--16 C]{Wright}:---
1363% \begin{compactenum}[(a)] 1364% \begin{enumerate}
1364% \item With the \emph{solar} letters \arb[novoc]{t}, \arb[novoc]{_t}, 1365% \item With the \emph{solar} letters \arb[novoc]{t}, \arb[novoc]{_t},
1365% \arb[novoc]{d}, \arb[novoc]{_d}, \arb[novoc]{r}, \arb[novoc]{z}, 1366% \arb[novoc]{d}, \arb[novoc]{_d}, \arb[novoc]{r}, \arb[novoc]{z},
1366% \arb[novoc]{s}, \arb[novoc]{^s}, \arb[novoc]{.s}, \arb[novoc]{.d}, 1367% \arb[novoc]{s}, \arb[novoc]{^s}, \arb[novoc]{.s}, \arb[novoc]{.d},
@@ -1424,7 +1425,7 @@ vowels (see §~3).
1424% \arb[voc]{labi_ttu} \arb[trans]{labi_ttu}, will be discarded here, 1425% \arb[voc]{labi_ttu} \arb[trans]{labi_ttu}, will be discarded here,
1425% as it is largely condemned by the 1426% as it is largely condemned by the
1426% grammarians \parencite[see][i. 16 B--C]{Wright}. 1427% grammarians \parencite[see][i. 16 B--C]{Wright}.
1427% \end{compactenum} 1428% \end{enumerate}
1428% 1429%
1429% \paragraph{The definite article and the \arb[trans]{'alif-u 'l-wa.sl-i}} 1430% \paragraph{The definite article and the \arb[trans]{'alif-u 'l-wa.sl-i}}
1430% \label{ref:definite-article} 1431% \label{ref:definite-article}
@@ -1443,7 +1444,7 @@ vowels (see §~3).
1443% doing that automatically provided that the vowel which is to be 1444% doing that automatically provided that the vowel which is to be
1444% absorbed by the final vowel of the preceding word be properly 1445% absorbed by the final vowel of the preceding word be properly
1445% encoded, like so:--- 1446% encoded, like so:---
1446% \begin{compactenum}[(a)] 1447% \begin{enumerate}
1447% \item Definite article at the beginning of a sentence is encoded\\ 1448% \item Definite article at the beginning of a sentence is encoded\\
1448% \arabluaverb{al-}, or \arabluaverb{a<solar letter>-}\\ if one 1449% \arabluaverb{al-}, or \arabluaverb{a<solar letter>-}\\ if one
1449% wishes to mark the assimilation---which is in no way required, as 1450% wishes to mark the assimilation---which is in no way required, as
@@ -1453,7 +1454,7 @@ vowels (see §~3).
1453% \item In all remaining cases of elision, the \arb[trans]{'alifu 1454% \item In all remaining cases of elision, the \arb[trans]{'alifu
1454% 'l-wa.sli} is expressed by the vowel that accompanies the omitted 1455% 'l-wa.sli} is expressed by the vowel that accompanies the omitted
1455% \arb[trans]{hamzaT}: \meta{u, a, i}. 1456% \arb[trans]{hamzaT}: \meta{u, a, i}.
1456% \end{compactenum} 1457% \end{enumerate}
1457% \begin{quote} 1458% \begin{quote}
1458% \textbf{Article}: |bAb-u| |'l-madrasaT-i| \arb[fullvoc]{bAb-u 1459% \textbf{Article}: |bAb-u| |'l-madrasaT-i| \arb[fullvoc]{bAb-u
1459% 'l-madrasaT-i} \arb[trans]{bAb-u 'l-madrasaT-i}, 1460% 'l-madrasaT-i} \arb[trans]{bAb-u 'l-madrasaT-i},
@@ -1471,7 +1472,7 @@ vowels (see §~3).
1471% 'l-najm-a} \arb[trans]{fa-lammA ra'aW 'l-najm-a}. 1472% 'l-najm-a} \arb[trans]{fa-lammA ra'aW 'l-najm-a}.
1472% 1473%
1473% \textbf{Particles}:--- 1474% \textbf{Particles}:---
1474% \begin{compactenum}[(a)] 1475% \begin{enumerate}
1475% \item \arb[trans]{li-}: \arb[trans]{'alif-u 'l-wa.sl-i} is omitted 1476% \item \arb[trans]{li-}: \arb[trans]{'alif-u 'l-wa.sl-i} is omitted
1476% in the article \arb[fullvoc]{al} when it is preceded by the 1477% in the article \arb[fullvoc]{al} when it is preceded by the
1477% preposition \arb[fullvoc]{li}: |li-l-rajul-i| 1478% preposition \arb[fullvoc]{li}: |li-l-rajul-i|
@@ -1491,7 +1492,7 @@ vowels (see §~3).
1491% |bi-'l-|\allowbreak|qalam-i| \arb[fullvoc]{bi-'l-qalam-i} 1492% |bi-'l-|\allowbreak|qalam-i| \arb[fullvoc]{bi-'l-qalam-i}
1492% \arb[trans]{bi-'l-qalam-i}, |bi-'l-ru`b-i| 1493% \arb[trans]{bi-'l-qalam-i}, |bi-'l-ru`b-i|
1493% \arb[fullvoc]{bi-'l-ru`b-i} \arb[trans]{bi-'l-ru`b-i}. 1494% \arb[fullvoc]{bi-'l-ru`b-i} \arb[trans]{bi-'l-ru`b-i}.
1494% \end{compactenum} 1495% \end{enumerate}
1495% 1496%
1496% \textbf{Perfect active, imperative, nomen actionis}: |qAla| 1497% \textbf{Perfect active, imperative, nomen actionis}: |qAla|
1497% |isma`| \arb[fullvoc]{qAla isma`} \arb[trans]{qAla isma`}, |qAla| 1498% |isma`| \arb[fullvoc]{qAla isma`} \arb[trans]{qAla isma`}, |qAla|
@@ -1710,7 +1711,7 @@ vowels (see §~3).
1710% 1711%
1711% \paragraph{\texttt{novoc}} In this mode, \enquote{quoting} 1712% \paragraph{\texttt{novoc}} In this mode, \enquote{quoting}
1712% essentially means make visible something that ought not to be so. 1713% essentially means make visible something that ought not to be so.
1713% \begin{compactenum}[(a)] 1714% \begin{enumerate}
1714% \item Quoting a vowel, either short or long, makes the 1715% \item Quoting a vowel, either short or long, makes the
1715% \arb[trans]{.dammaT}, \arb[trans]{fat.haT} or \arb[trans]{kasraT} 1716% \arb[trans]{.dammaT}, \arb[trans]{fat.haT} or \arb[trans]{kasraT}
1716% appear above the appropriate consonant:--- 1717% appear above the appropriate consonant:---
@@ -1744,13 +1745,13 @@ vowels (see §~3).
1744% "inhazama} \arb[trans]{huwa "inhazama}, |al-"intiqA.d-u| 1745% "inhazama} \arb[trans]{huwa "inhazama}, |al-"intiqA.d-u|
1745% \arb[novoc]{al-"intiqA.d-u} \arb[trans]{al-"intiqA.d-u}. 1746% \arb[novoc]{al-"intiqA.d-u} \arb[trans]{al-"intiqA.d-u}.
1746% \end{quote} 1747% \end{quote}
1747% \end{compactenum} 1748% \end{enumerate}
1748% 1749%
1749% \paragraph{\texttt{voc}} 1750% \paragraph{\texttt{voc}}
1750% In accordance with the general rule, in this mode, \enquote{quoting} 1751% In accordance with the general rule, in this mode, \enquote{quoting}
1751% makes the vowels and the \arb[trans]{tanwIn} disappear, should this 1752% makes the vowels and the \arb[trans]{tanwIn} disappear, should this
1752% feature be required for some reason:--- 1753% feature be required for some reason:---
1753% \begin{compactenum}[(a)] 1754% \begin{enumerate}
1754% \item Short and long vowels:--- 1755% \item Short and long vowels:---
1755% \begin{quote} 1756% \begin{quote}
1756% |q"Ala q"A'iluN| \arb[voc]{q"Ala q"A'iluN} \arb[trans]{q"Ala 1757% |q"Ala q"A'iluN| \arb[voc]{q"Ala q"A'iluN} \arb[trans]{q"Ala
@@ -1765,12 +1766,12 @@ vowels (see §~3).
1765% \arb[voc]{hud"aN_A} \arb[trans]{hud"aN_A}, |^say'"iN| 1766% \arb[voc]{hud"aN_A} \arb[trans]{hud"aN_A}, |^say'"iN|
1766% \arb[voc]{^say'"iN} \arb[trans]{^say'"iN}. 1767% \arb[voc]{^say'"iN} \arb[trans]{^say'"iN}.
1767% \end{quote} 1768% \end{quote}
1768% \end{compactenum} 1769% \end{enumerate}
1769% One may more usefully \enquote{quote} the initial vowels to write 1770% One may more usefully \enquote{quote} the initial vowels to write
1770% the \arb[trans]{wa.slaT} above the \arb[trans]{'alif} or insert a 1771% the \arb[trans]{wa.slaT} above the \arb[trans]{'alif} or insert a
1771% straight double quote after a consonant not followed by a vowel to 1772% straight double quote after a consonant not followed by a vowel to
1772% make the \arb[trans]{sukUn} appear:--- 1773% make the \arb[trans]{sukUn} appear:---
1773% \begin{compactenum}[(a)] 1774% \begin{enumerate}
1774% \item \arb[trans]{'alif-u 'l-wa.sl-i}:--- 1775% \item \arb[trans]{'alif-u 'l-wa.sl-i}:---
1775% \begin{quote} 1776% \begin{quote}
1776% |fI "istiq.sA'-iN| \arb[voc]{fI "istiq.sA'-iN} \arb[trans]{fI 1777% |fI "istiq.sA'-iN| \arb[voc]{fI "istiq.sA'-iN} \arb[trans]{fI
@@ -1789,7 +1790,7 @@ vowels (see §~3).
1789% \arb[trans]{kam" qad" ma.dat" min" 1790% \arb[trans]{kam" qad" ma.dat" min"
1790% laylaTiN}.\label{ref:quoted-sukun-e} 1791% laylaTiN}.\label{ref:quoted-sukun-e}
1791% \end{quote} 1792% \end{quote}
1792% \end{compactenum} 1793% \end{enumerate}
1793% 1794%
1794% \paragraph{\texttt{fullvoc}} 1795% \paragraph{\texttt{fullvoc}}
1795% In this mode, \enquote{quoting} can be used to take away any short 1796% In this mode, \enquote{quoting} can be used to take away any short
@@ -2190,7 +2191,7 @@ word that \cs{arbnull} is applied to.
2190% to the following or the preceding ones over the 2191% to the following or the preceding ones over the
2191% \arb[trans]{tadwIr}. The optional argument of the \cs{bayt} command 2192% \arb[trans]{tadwIr}. The optional argument of the \cs{bayt} command
2192% is designed to deal with the various situations that may arise:--- 2193% is designed to deal with the various situations that may arise:---
2193% \begin{compactenum}[(a)] 2194% \begin{enumerate}
2194% \item If the two hemistichs be connected with one another by a 2195% \item If the two hemistichs be connected with one another by a
2195% prominent horizontal flexible stroke, the \arb[trans]{ta.twIl} should 2196% prominent horizontal flexible stroke, the \arb[trans]{ta.twIl} should
2196% be used, like so: |[--]| (see \vref{sec:tatwil}). Of course, the 2197% be used, like so: |[--]| (see \vref{sec:tatwil}). Of course, the
@@ -2261,7 +2262,7 @@ word that \cs{arbnull} is applied to.
2261% write it all inside the \arb[trans]{tadwIr}. In that case, as the 2262% write it all inside the \arb[trans]{tadwIr}. In that case, as the
2262% word is to be placed in the middle, it has been surrounded by 2263% word is to be placed in the middle, it has been surrounded by
2263% spaces. 2264% spaces.
2264% \end{compactenum} 2265% \end{enumerate}
2265% 2266%
2266% \paragraph{Scaling and distortion of characters} 2267% \paragraph{Scaling and distortion of characters}
2267% The |arabverse| environment and the \cs{bayt} command are designed 2268% The |arabverse| environment and the \cs{bayt} command are designed
@@ -2412,12 +2413,12 @@ word that \cs{arbnull} is applied to.
2412% removed. \package{arabluatex} will automatically fit those symbols 2413% removed. \package{arabluatex} will automatically fit those symbols
2413% to the direction of the text. For the time being, the following 2414% to the direction of the text. For the time being, the following
2414% symbols are supported: 2415% symbols are supported:
2415% \begin{compactitem} 2416% \begin{itemize}
2416% \item parentheses: |()| 2417% \item parentheses: |()|
2417% \item square brackets: |[]| 2418% \item square brackets: |[]|
2418% \item angle brackets: |<>| 2419% \item angle brackets: |<>|
2419% \item braces: |{}| 2420% \item braces: |{}|
2420% \end{compactitem} 2421% \end{itemize}
2421% 2422%
2422% \DescribeMacro{\abraces} Parentheses, square and angle brackets may 2423% \DescribeMacro{\abraces} Parentheses, square and angle brackets may
2423% be input directly at the keyboard; however, words or letters that 2424% be input directly at the keyboard; however, words or letters that
@@ -2540,7 +2541,7 @@ word that \cs{arbnull} is applied to.
2540% This mode transliterates the Arab\TeX\ input into one of the 2541% This mode transliterates the Arab\TeX\ input into one of the
2541% accepted standards. As said above \vpageref{ref:describe-trans}, 2542% accepted standards. As said above \vpageref{ref:describe-trans},
2542% three standards are supported at present: 2543% three standards are supported at present:
2543% \begin{compactdesc} 2544% \begin{description}
2544% \item[dmg] \emph{Deutsche Morgenländische Gesellschaft}, which was 2545% \item[dmg] \emph{Deutsche Morgenländische Gesellschaft}, which was
2545% adopted by the International Convention of Orientalist Scholars in 2546% adopted by the International Convention of Orientalist Scholars in
2546% Rome in 1935.\footnote{See \textcite{dmg}.} |dmg| transliteration 2547% Rome in 1935.\footnote{See \textcite{dmg}.} |dmg| transliteration
@@ -2559,7 +2560,7 @@ word that \cs{arbnull} is applied to.
2559% is most widely used by scholars in the field of Arabic 2560% is most widely used by scholars in the field of Arabic
2560% studies.\footnote{See 2561% studies.\footnote{See
2561% \url{http://www.brill.nl/files/brill.nl/specific/authors_instructions/ARAB.pdf}.} 2562% \url{http://www.brill.nl/files/brill.nl/specific/authors_instructions/ARAB.pdf}.}
2562% \end{compactdesc} 2563% \end{description}
2563% More standards will be included in future releases of 2564% More standards will be included in future releases of
2564% \package{arabluatex}. 2565% \package{arabluatex}.
2565% 2566%
@@ -2718,13 +2719,13 @@ Then as \Hunayn, \Razi.
2718% \NEWfeature{v1.3} According to \textcite[6]{dmg}, Arabic 2719% \NEWfeature{v1.3} According to \textcite[6]{dmg}, Arabic
2719% \arb[trans]{'i`rAb} may be rendered into |dmg| in three different 2720% \arb[trans]{'i`rAb} may be rendered into |dmg| in three different
2720% ways: 2721% ways:
2721% \begin{compactenum}[(a)] 2722% \begin{enumerate}
2722% \item \label{ref:dmg-full-rend}In full: 2723% \item \label{ref:dmg-full-rend}In full:
2723% \NoArbUp\arb[trans]{\uc{`amruNU}}\ArbUpDflt\,; 2724% \NoArbUp\arb[trans]{\uc{`amruNU}}\ArbUpDflt\,;
2724% \item \label{ref:dmg-up-rend}As superscript text: 2725% \item \label{ref:dmg-up-rend}As superscript text:
2725% \arb[trans]{\uc{`amruNU}}\,; 2726% \arb[trans]{\uc{`amruNU}}\,;
2726% \item \label{ref:irab-discarded}Discarded: \arb[trans]{\uc{`amr}}. 2727% \item \label{ref:irab-discarded}Discarded: \arb[trans]{\uc{`amr}}.
2727% \end{compactenum} 2728% \end{enumerate}
2728% \DescribeMacro{\arbup} By default, \package{arabluatex} applies rule 2729% \DescribeMacro{\arbup} By default, \package{arabluatex} applies rule
2729% \ref{ref:dmg-up-rend}. Once delimited by a set of Lua functions, 2730% \ref{ref:dmg-up-rend}. Once delimited by a set of Lua functions,
2730% \arb[trans]{'i`rAb} is passed as an argument on to a \cs{arbup} 2731% \arb[trans]{'i`rAb} is passed as an argument on to a \cs{arbup}
@@ -2811,14 +2812,14 @@ muhaddamaTaN mi'_danatu-hu}: \arb[trans]{ra'aytu
2811% book titles. \package{arabluatex} is able to render words ending 2812% book titles. \package{arabluatex} is able to render words ending
2812% with \arb[trans]{tA' marbU.taT} in different ways, depending on 2813% with \arb[trans]{tA' marbU.taT} in different ways, depending on
2813% their function:--- 2814% their function:---
2814% \begin{compactenum}[(a)] 2815% \begin{enumerate}
2815% \item Nouns followed by an adjective in apposition: |madInaT| 2816% \item Nouns followed by an adjective in apposition: |madInaT|
2816% |kabIraT| \arb[trans]{madInaT kabIraT}, |al-madInaT| |al-kabIraT| 2817% |kabIraT| \arb[trans]{madInaT kabIraT}, |al-madInaT| |al-kabIraT|
2817% \arb[trans]{al-madInaT al-kabIraT}. 2818% \arb[trans]{al-madInaT al-kabIraT}.
2818% \item Nouns followed by another noun in the genitive (contruct 2819% \item Nouns followed by another noun in the genitive (contruct
2819% state): |.hikmaT| |al-l_ah| \arb[trans]{.hikmaT| \uc{al-l_ah}}, 2820% state): |.hikmaT| |al-l_ah| \arb[trans]{.hikmaT| \uc{al-l_ah}},
2820% |fi.d.daT| |al-darAhim| \arb[trans]{fi.d.daT al-darAhim}. 2821% |fi.d.daT| |al-darAhim| \arb[trans]{fi.d.daT al-darAhim}.
2821% \end{compactenum} 2822% \end{enumerate}
2822% \begin{quoting} 2823% \begin{quoting}
2823% \textsc{Rem.} It may so happen, as in the absence of the article 2824% \textsc{Rem.} It may so happen, as in the absence of the article
2824% before the annexed word, that \package{arabluatex} be unable to 2825% before the annexed word, that \package{arabluatex} be unable to
@@ -3062,7 +3063,7 @@ muhaddamaTaN mi'_danatu-hu}: \arb[trans]{ra'aytu
3062% 3063%
3063% That said, there are two ways of inserting Unicode 3064% That said, there are two ways of inserting Unicode
3064% Arabic: 3065% Arabic:
3065% \begin{compactenum}[(a)] 3066% \begin{enumerate}
3066% \item \DescribeMacro{\txarb} The \cs{txarb}\marg{Unicode Arabic} 3067% \item \DescribeMacro{\txarb} The \cs{txarb}\marg{Unicode Arabic}
3067% command for inserting Unicode Arabic text in paragraphs; 3068% command for inserting Unicode Arabic text in paragraphs;
3068% \item The \DescribeEnv{txarab} |txarab| environment for inserting 3069% \item The \DescribeEnv{txarab} |txarab| environment for inserting
@@ -3078,7 +3079,7 @@ muhaddamaTaN mi'_danatu-hu}: \arb[trans]{ra'aytu
3078% \iffalse 3079% \iffalse
3079%</example> 3080%</example>
3080% \fi 3081% \fi
3081% \end{compactenum} 3082% \end{enumerate}
3082% 3083%
3083% \section{\LaTeX\ Commands in Arabic environments} 3084% \section{\LaTeX\ Commands in Arabic environments}
3084% \label{sec:commands-in-arb} 3085% \label{sec:commands-in-arb}
@@ -3246,7 +3247,7 @@ qAla barzawayhi bn-u 'azhar-a, ra's-u 'a.tibbA'-i fAris-a...
3246% their argument to be rendered in Arabic must be inserted again in 3247% their argument to be rendered in Arabic must be inserted again in
3247% \cs{arb}. \NEWfeature{v1.12}These commands themselves may have up to 3248% \cs{arb}. \NEWfeature{v1.12}These commands themselves may have up to
3248% two optional and/or mandatory arguments, like so:--- 3249% two optional and/or mandatory arguments, like so:---
3249% \begin{compactenum}[(a)] 3250% \begin{enumerate}
3250% \item \cs{command} (no argument, lowermost combination) 3251% \item \cs{command} (no argument, lowermost combination)
3251% \item \cs{command}\oarg{opt1} (one optional argument) 3252% \item \cs{command}\oarg{opt1} (one optional argument)
3252% \item \cs{command}\marg{arg1} (one mandatory argument) 3253% \item \cs{command}\marg{arg1} (one mandatory argument)
@@ -3255,7 +3256,7 @@ qAla barzawayhi bn-u 'azhar-a, ra's-u 'a.tibbA'-i fAris-a...
3255% \item{} [\ldots] 3256% \item{} [\ldots]
3256% \item \cs{command}\oarg{opt1}\oarg{opt2}\marg{arg1}\marg{arg2} 3257% \item \cs{command}\oarg{opt1}\oarg{opt2}\marg{arg1}\marg{arg2}
3257% (uppermost combination) 3258% (uppermost combination)
3258% \end{compactenum} 3259% \end{enumerate}
3259% 3260%
3260% 3261%
3261% \subsection{Environments} 3262% \subsection{Environments}
@@ -3376,7 +3377,7 @@ qAla barzawayhi bn-u 'azhar-a, ra's-u 'a.tibbA'-i fAris-a...
3376 % preamble:--- 3377 % preamble:---
3377 \usepackage{enumitem} 3378 \usepackage{enumitem}
3378 \newlist{enumabjad}{enumerate}{10} 3379 \newlist{enumabjad}{enumerate}{10}
3379 \setlist[enumabjad]{nosep, label={\aemph*{\abjad{\arabic*}}}} 3380 \setlist[enumabjad]{nosep, label={\abjad{\arabic*}}}
3380 \usepackage{multicol} 3381 \usepackage{multicol}
3381\end{arabluaverbatim} 3382\end{arabluaverbatim}
3382\begin{arabluacode} 3383\begin{arabluacode}
@@ -3576,25 +3577,25 @@ wa-ya.sIru ta.hta 'l-jild-i
3576% \label{sec:future-work} 3577% \label{sec:future-work}
3577% A short, uncommented, list of what is planned in the versions of 3578% A short, uncommented, list of what is planned in the versions of
3578% \package{arabluatex} to come follows: 3579% \package{arabluatex} to come follows:
3579% \begin{compactenum}[(a)] 3580% \begin{enumerate}
3580% \item Short-term: 3581% \item Short-term:
3581% \begin{compactenum}[i.] 3582% \begin{enumerate}
3582% \item \texttt{TEI xml} support: \package{arabluatex} will 3583% \item \texttt{TEI xml} support: \package{arabluatex} will
3583% interoperate with \texttt{TEI xml} through new global and local 3584% interoperate with \texttt{TEI xml} through new global and local
3584% options that will output Arabic in a \texttt{TEI xml} compliant 3585% options that will output Arabic in a \texttt{TEI xml} compliant
3585% file in addition to the usual PDF output: see 3586% file in addition to the usual PDF output: see
3586% \vpageref{ref:tei-to-come}. 3587% \vpageref{ref:tei-to-come}.
3587% \end{compactenum} 3588% \end{enumerate}
3588% \item Medium-term: 3589% \item Medium-term:
3589% \begin{compactenum}[i.] 3590% \begin{enumerate}
3590% \item More languages: the list of supported languages will 3591% \item More languages: the list of supported languages will
3591% eventually be the same as \package{arabtex}: see 3592% eventually be the same as \package{arabtex}: see
3592% \vref{fn:arabtex-languages}. 3593% \vref{fn:arabtex-languages}.
3593% \item Formulate propositions for extending the Arab\TeX\ notation 3594% \item Formulate propositions for extending the Arab\TeX\ notation
3594% and the transliteration tables. Include them in 3595% and the transliteration tables. Include them in
3595% \package{arabluatex}. See \vref{sec:additional-characters}. 3596% \package{arabluatex}. See \vref{sec:additional-characters}.
3596% \end{compactenum} 3597% \end{enumerate}
3597% \end{compactenum} 3598% \end{enumerate}
3598% 3599%
3599% \StopEventually{} 3600% \StopEventually{}
3600% 3601%
@@ -3906,19 +3907,25 @@ wa-ya.sIru ta.hta 'l-jild-i
3906\NewDocumentCommand{\arb}{O{\al@mode} +m}% 3907\NewDocumentCommand{\arb}{O{\al@mode} +m}%
3907{\edef\@tempa{#1}% 3908{\edef\@tempa{#1}%
3908 \ifx\@tempa\al@mode@voc% 3909 \ifx\@tempa\al@mode@voc%
3910 \booltrue{al@rlmode}%
3909 \bgroup\textdir TRT\arabicfont% 3911 \bgroup\textdir TRT\arabicfont%
3910 \luadirect{tex.sprint(processvoc(\luastringN{#2}, 3912 \luadirect{tex.sprint(processvoc(\luastringN{#2},
3911 \luastringO{\al@arb@rules}, \luastringO{\al@input@scheme}))}\egroup% 3913 \luastringO{\al@arb@rules}, \luastringO{\al@input@scheme}))}\egroup%
3914 \boolfalse{al@rlmode}%
3912 \else% 3915 \else%
3913 \ifx\@tempa\al@mode@fullvoc% 3916 \ifx\@tempa\al@mode@fullvoc%
3917 \booltrue{al@rlmode}%
3914 \bgroup\textdir TRT\arabicfont% 3918 \bgroup\textdir TRT\arabicfont%
3915 \luadirect{tex.sprint(processfullvoc(\luastringN{#2}, 3919 \luadirect{tex.sprint(processfullvoc(\luastringN{#2},
3916 \luastringO{\al@arb@rules}, \luastringO{\al@input@scheme}))}\egroup% 3920 \luastringO{\al@arb@rules}, \luastringO{\al@input@scheme}))}\egroup%
3921 \boolfalse{al@rlmode}%
3917 \else% 3922 \else%
3918 \ifx\@tempa\al@mode@novoc% 3923 \ifx\@tempa\al@mode@novoc%
3924 \booltrue{al@rlmode}%
3919 \bgroup\textdir TRT\arabicfont% 3925 \bgroup\textdir TRT\arabicfont%
3920 \luadirect{tex.sprint(processnovoc(\luastringN{#2}, 3926 \luadirect{tex.sprint(processnovoc(\luastringN{#2},
3921 \luastringO{\al@arb@rules}, \luastringO{\al@input@scheme}))}\egroup% 3927 \luastringO{\al@arb@rules}, \luastringO{\al@input@scheme}))}\egroup%
3928 \boolfalse{al@rlmode}%
3922 \else% 3929 \else%
3923 \ifx\@tempa\al@mode@trans% 3930 \ifx\@tempa\al@mode@trans%
3924 \bgroup\textdir TLT\al@trans@style% 3931 \bgroup\textdir TLT\al@trans@style%
@@ -4081,11 +4088,15 @@ wa-ya.sIru ta.hta 'l-jild-i
4081\AtBeginDocument{% 4088\AtBeginDocument{%
4082 \ifdefined\abjad% 4089 \ifdefined\abjad%
4083 \RenewDocumentCommand{\abjad}{m}% 4090 \RenewDocumentCommand{\abjad}{m}%
4084 {\luadirect{tex.sprint(abjadify(\luastring{#1}))}}% 4091 {\ifbool{al@rlmode}%
4092 {\aemph{\luadirect{tex.sprint(abjadify(\luastring{#1}))}}}
4093 {\luadirect{tex.sprint(abjadify(\luastring{#1}))}}}
4085 \else% 4094 \else%
4086 \NewDocumentCommand{\abjad}{m}% 4095 \NewDocumentCommand{\abjad}{m}%
4087 {\luadirect{tex.sprint(abjadify(\luastring{#1}))}} 4096 {\ifbool{al@rlmode}%
4088\fi} 4097 {\aemph{\luadirect{tex.sprint(abjadify(\luastring{#1}))}}}
4098 {\luadirect{tex.sprint(abjadify(\luastring{#1}))}}}
4099 \fi}
4089% \end{macrocode} 4100% \end{macrocode}
4090% \end{macro} 4101% \end{macro}
4091% \begin{macro}{\arbnull} 4102% \begin{macro}{\arbnull}