aboutsummaryrefslogtreecommitdiff
path: root/arabluatex.dtx
diff options
context:
space:
mode:
Diffstat (limited to 'arabluatex.dtx')
-rw-r--r--arabluatex.dtx1067
1 files changed, 628 insertions, 439 deletions
diff --git a/arabluatex.dtx b/arabluatex.dtx
index 78bd3d4..3b2f4c2 100644
--- a/arabluatex.dtx
+++ b/arabluatex.dtx
@@ -1,23 +1,22 @@
1% \iffalse meta-comment 1% \iffalse meta-comment
2% ArabLuaTeX -- Processing ArabTeX notation under LuaLaTeX 2% ArabLuaTeX -- Processing ArabTeX notation under LuaLaTeX
3% Copyright (C) 2016--2020 Robert Alessi 3% Copyright (C) 2016, 2017, 2018, 2019, 2020, 2021, 2022, 2023 Robert
4%
5% Please send error reports and suggestions for improvements to Robert
6% Alessi <alessi@robertalessi.net> 4% Alessi <alessi@robertalessi.net>
7% 5%
8% This program is free software: you can redistribute it and/or modify 6% Permission to use, copy, modify, and distribute this software for any
9% it under the terms of the GNU General Public License as published by 7% purpose with or without fee is hereby granted, provided that the above
10% the Free Software Foundation, either version 3 of the License, or 8% copyright notice and this permission notice appear in all copies.
11% (at your option) any later version. 9%
12% 10% THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
13% This program is distributed in the hope that it will be useful, but 11% WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
14% WITHOUT ANY WARRANTY; without even the implied warranty of 12% MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
15% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 13% ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
16% General Public License for more details. 14% WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
15% ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
16% OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17% 17%
18% You should have received a copy of the GNU General Public License 18% Please send error reports and suggestions for improvements to Robert
19% along with this program. If not, see 19% Alessi <alessi@robertalessi.net>
20% <http://www.gnu.org/licenses/>.
21% \fi 20% \fi
22% 21%
23% \iffalse 22% \iffalse
@@ -27,7 +26,7 @@
27%<package>\NeedsTeXFormat{LaTeX2e}[1999/12/01] 26%<package>\NeedsTeXFormat{LaTeX2e}[1999/12/01]
28%<package>\ProvidesPackage{arabluatex} 27%<package>\ProvidesPackage{arabluatex}
29%<*package> 28%<*package>
30 [2020/03/23 v1.20 ArabTeX for LuaLaTeX] 29 [2023/05/21 v1.21-dev ArabTeX for LuaLaTeX]
31%</package> 30%</package>
32% 31%
33%<*driver> 32%<*driver>
@@ -37,24 +36,24 @@
37% This file is part of the `arabluatex' package 36% This file is part of the `arabluatex' package
38% 37%
39% ArabLuaTeX -- Processing ArabTeX notation under LuaLaTeX 38% ArabLuaTeX -- Processing ArabTeX notation under LuaLaTeX
40% Copyright (C) 2016--2020 Robert Alessi
41% 39%
42% Please send error reports and suggestions for improvements to Robert 40% Copyright (C) 2016, 2017, 2018, 2019, 2020, 2021, 2022, 2023
43% Alessi <alessi@robertalessi.net> 41% Robert Alessi <alessi@robertalessi.net>
44%
45% This program is free software: you can redistribute it and/or modify
46% it under the terms of the GNU General Public License as published by
47% the Free Software Foundation, either version 3 of the License, or
48% (at your option) any later version.
49% 42%
50% This program is distributed in the hope that it will be useful, but 43% Permission to use, copy, modify, and distribute this software for any
51% WITHOUT ANY WARRANTY; without even the implied warranty of 44% purpose with or without fee is hereby granted, provided that the above
52% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 45% copyright notice and this permission notice appear in all copies.
53% General Public License for more details. 46%
47% THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
48% WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
49% MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
50% ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
51% WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
52% ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
53% OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
54% 54%
55% You should have received a copy of the GNU General Public License 55% Please send error reports and suggestions for improvements to Robert
56% along with this program. If not, see 56% Alessi <alessi@robertalessi.net>
57% <http://www.gnu.org/licenses/>.
58 57
59@software{pkg:arabtex, 58@software{pkg:arabtex,
60 author = {Lagally, Klaus}, 59 author = {Lagally, Klaus},
@@ -78,6 +77,15 @@
78 url = {http://www.amirifont.org/} 77 url = {http://www.amirifont.org/}
79} 78}
80 79
80@software{pkg:ekdosis,
81 title = {The Ekdosis package},
82 subtitle = {Typesetting TEI-xml compliant Critical Editions},
83 author = {Alessi, Robert},
84 url = {http://www.ekdosis.org},
85 date = {2021-11-21},
86 version = {1.4}
87}
88
81@Book{Habash, 89@Book{Habash,
82 author = {Habash, Nizar Y.}, 90 author = {Habash, Nizar Y.},
83 title = {Introduction to Arabic Natural Language Processing}, 91 title = {Introduction to Arabic Natural Language Processing},
@@ -157,42 +165,105 @@
157 location = {London -- Edinburgh} 165 location = {London -- Edinburgh}
158} 166}
159\end{filecontents} 167\end{filecontents}
168\usepackage[letterpaper,margin=1.25in,left=50mm,nohead]{geometry}
160\usepackage{fontspec} 169\usepackage{fontspec}
170\defaultfontfeatures{Renderer=Harfbuzz}
161\usepackage[english]{babel} 171\usepackage[english]{babel}
162\usepackage{dox} 172%^^A dox does not work with the latest latex-dev:
163\doxitem{Option}{option}{options} 173\ifdefined\SpecialMacroIndex
174 \NewDocElement{Option}{option}
175\else
176 \usepackage{dox}
177 \doxitem{Option}{option}{options}
178\fi
164\usepackage{microtype} 179\usepackage{microtype}
165\defaultfontfeatures{Renderer=Harfbuzz} 180\babelfont{rm}[RawFeature=onum]{Old Standard}
166\babelfont{rm}{Old Standard} 181\babelfont{sf}{NewComputerModernSans10}
167\babelfont{sf}{NewComputerModern Sans} 182\babelfont{tt}{NewComputerModernMono10}
168\babelfont{tt}{NewComputerModern Mono} 183\usepackage{manfnt}
184\usepackage{lettrine}
185\newcommand\danger{\lettrine[loversize=-.5]{\textdbend}{\hskip6pt}}
169\usepackage{metalogox} 186\usepackage{metalogox}
170\usepackage{arabluatex}[2020/03/23] 187\usepackage{arabluatex}[2023/05/21]
188\SetTranslitConvention{dmg+}
171\SetArbUp{\textsuperscript{\thinspace#1}} % Old Standard needs this 189\SetArbUp{\textsuperscript{\thinspace#1}} % Old Standard needs this
172\usepackage[nopar]{quran} 190\usepackage[nopar]{quran}
173\usepackage[noindex]{nameauth} 191\usepackage[noindex]{nameauth}
174\usepackage{varioref} 192\usepackage{varioref}
175\usepackage{hyperxmp} 193\usepackage{latexcolors}
176\usepackage{hypdoc} 194\PassOptionsToPackage{bookmarks=true}{hyperref}
177\usepackage{uri} 195\usepackage[numbered]{hypdoc}
196\newcommand{\phts}{\phantomsection}
197\usepackage[loadlang=en]{metastr}
198\hypersetup{
199 colorlinks,
200 allcolors=cinnamon,
201 linktocpage=true,
202 pdftype={Text}
203}
204\labelformat{section}{sect.~#1}
205\labelformat{subsection}{sect.~#1}
206\labelformat{subsubsection}{sect.~#1}
207\labelformat{figure}{fig.~#1}
208\labelformat{table}{table~#1}
209\metaset{titletext}{%
210 \metapick[#1]{title}%
211 \metacompose[#1]{subtitle}{\metaget[sep]{subtitle}}{}{}}
212\metaset[print]{titletext}{%
213 \metatitleline[print]{title}%
214 \metatitleline[print]{subtitle}%
215 \metatitleline[print]{author}%
216 \metatitleline[print]{contactemail}%
217 \metatitlelinetwo[print]{date}[print]{draft}}
218\metaset[skip]{subtitle}{\vspace{1ex}}
219\metaset[skip]{author}{\vspace{2ex}}
220\metaset[skip]{date}{\vspace{1ex}}
221\metaset[style]{title}{\LARGE}
222\metaset[style]{author}{\large}
223\metaset[sep]{draft}{ -- }
224\metasetlang{en-US}
225\metaset{title}{arabluatex}
226\metaset[print]{title}{\textsf{arabluatex}}
227\metaset{date}{\filedate}
228\metaset{draft}{\fileversion}
229\metaset{subject}{ArabTeX}
230\metaset{subtitle}{ArabTeX for LuaLaTeX}
231\metaset[print]{subtitle}{Arab\TeX\ for Lua\LaTeX}
232\metaset{author}{Robert Alessi}
233\metaset{keywords}{Arabic language, Arabic,
234 arabtex, luatex}
235\metaset{contactemail}{alessi@roberalessi.net}
236\metaset[print]{contactemail}{\mailto[arabluatex]{alessi@robertalessi.net}}
237\metaset{contacturl}{http://www.roberalessi.net}
238\metaset{partof}{The arabluatex Package}
239\metaset[print]{partof}{The \textsf{arabluatex} Package}
240\metaset{copyrightowner}{\metapick[#1]{author}}
241\metaset{copyrightdate}{2016, 2017, 2018, 2019, 2020, 2021, 2022,
242 2023}
243\metaset{licensemessage}{Permission to use, copy, modify, and
244 distribute this software for any purpose with or without fee is
245 hereby granted, provided that the above copyright notice and this
246 permission notice appear in all copies.
247 THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
248 WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
249 WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
250 AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
251 DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA
252 OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
253 TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
254 PERFORMANCE OF THIS SOFTWARE.}
255\metaset{licenseurl}{%
256 https://cvsweb.openbsd.org/src/share/misc/license.template?rev=HEAD}
257\metaset[print]{licenseurl}{%
258 \url{https://cvsweb.openbsd.org/src/share/misc/license.template?rev=HEAD}}
259\metawritepdfinfo
260\metawritepdfaux
261\metawritepdfpreamble
262\metawritepdfcontact
263\metawritepdfrights
178\usepackage{bookmark} 264\usepackage{bookmark}
179\usepackage{authblk} 265\usepackage{authblk}
180\usepackage{latexcolors}
181\hypersetup{unicode=true, colorlinks, allcolors=cinnamon, keeppdfinfo,
182 linktocpage=true, pdfauthor={Robert Alessi}, pdftitle={The
183 arabluatex package}, pdfcontactemail={alessi@robertalessi.net},
184 pdfcontacturl={http://www.robertalessi.net/arabluatex},
185 pdfcopyright={Copyright (C) 2016--2020 Robert Alessi
186 <alessi@robertalessi.net>. This document is licensed under the
187 Creative Commons Attribution-ShareAlike 4.0 International
188 License. To view a copy of this license, visit
189 http://creativecommons.org/licenses/by-sa/4.0/ or send a letter to
190 Creative Commons, PO Box 1866, Mountain View, CA 94042, USA.},
191 pdflicenseurl={https://creativecommons.org/licenses/by-sa/4.0/legalcode},
192 pdfmetalang={en-US}, pdftype={Text}, pdfkeywords={Arabic language,
193 arabtex, luatex}}
194\usepackage[scale=1.5]{ccicons} 266\usepackage[scale=1.5]{ccicons}
195\usepackage[lot]{multitoc}
196\usepackage{enumitem} 267\usepackage{enumitem}
197\setlist{nosep} 268\setlist{nosep}
198\setlist[itemize]{label=\textendash} 269\setlist[itemize]{label=\textendash}
@@ -200,9 +271,11 @@
200\setlist[enumerate,2]{label=\roman*.} 271\setlist[enumerate,2]{label=\roman*.}
201\newlist{enumabjad}{enumerate}{10} 272\newlist{enumabjad}{enumerate}{10}
202\setlist[enumabjad]{label={\abjad{\arabic*}}} 273\setlist[enumabjad]{label={\abjad{\arabic*}}}
203\usepackage{multicol} 274\newlist{remarks}{enumerate}{10}
204\usepackage{cleveref} 275\setlist[remarks]{
205\crefname{footnote}{note}{notes} 276 label*=\textsc{Rem.} \emph{\alph*},
277 left=0.25in,
278 before=\smaller}
206\usepackage{quoting} 279\usepackage{quoting}
207\quotingsetup{noorphans, rightmargin=0pt} 280\quotingsetup{noorphans, rightmargin=0pt}
208\renewcommand*{\quotingfont}{\footnotesize} 281\renewcommand*{\quotingfont}{\footnotesize}
@@ -222,49 +295,66 @@
222 bottom=0mm} 295 bottom=0mm}
223\newtcblisting{example}{minted options={linenos, numbersep=0mm, 296\newtcblisting{example}{minted options={linenos, numbersep=0mm,
224 fontsize=\smaller}} 297 fontsize=\smaller}}
225\newtcblisting{code}{minted options={linenos, numbersep=0mm, 298\newtcblisting{alcode}{minted options={linenos, numbersep=0mm,
226 fontsize=\smaller}, listing only} 299 fontsize=\smaller}, listing only}
300\VerbatimFootnotes
227\newcommand{\package}[1]{\textsf{#1}\index{#1=#1 (package)}} 301\newcommand{\package}[1]{\textsf{#1}\index{#1=#1 (package)}}
228\usepackage[contents]{colordoc} 302\usepackage[contents]{colordoc}
229\usepackage{csquotes} 303\usepackage{csquotes}
230\DeclareQuoteStyle{arabic} 304\DeclareQuoteStyle{arabic}
231{\rmfamily\textquotedblright}{\rmfamily\textquotedblleft} 305{\rmfamily\textquotedblright}{\rmfamily\textquotedblleft}
232{\rmfamily\textquoteright}{\rmfamily\textquoteleft} 306{\rmfamily\textquoteright}{\rmfamily\textquoteleft}
233\usepackage[style=authoryear, indexing=cite]{biblatex} 307\usepackage[style=oxnotes-inote,indexing=cite]{biblatex}
234\DeclareIndexFieldFormat{indextitle}{\index{#1=\emph{#1}}} 308\DeclareIndexFieldFormat{indextitle}{\index{#1=\emph{#1}}}
235\addbibresource{arabluatex.bib} 309\addbibresource{arabluatex.bib}
310\NewDocumentCommand{\newfeature}{o}{%
311 \leavevmode
312 \IfNoValueTF{#1}
313 {\marginpar{\hfill\emph{New feature}}}
314 {\marginpar{\hfill\emph{New feature} #1}}%
315 \ignorespaces
316}
317\usepackage{uri}
318\usepackage[obeyspaces]{xurl}
319\usepackage{multicol}
320\usepackage{tocloft}
321\renewcommand\cftlotprehook{\begin{multicols}{2}}
322\renewcommand\cftlotposthook{\end{multicols}}
323\renewcommand\cftlottitlefont{\Large\bfseries}
236\usepackage{etoc} 324\usepackage{etoc}
237\etocsettocdepth{paragraph} 325\etocsettocdepth{paragraph}
326\makeatletter
238\newcommand{\altableofcontents}{% 327\newcommand{\altableofcontents}{%
239 \begingroup 328 \begingroup
240 \etocsetstyle{section}{}{} 329 \etocsetstyle{section}{}{}
241 {\etocsavedsectiontocline{% 330 {\l@section{%
242 \numberline{\etocnumber}\etocname}{\etocpage}}{} 331 \numberline{\etocnumber}\etocname}{\etocpage}}{}
243 \etocsetstyle{subsection}{}{} 332 \etocsetstyle{subsection}{}{}
244 {\etocsavedsubsectiontocline{% 333 {\l@subsection{%
245 \numberline{\etocnumber}\etocname}{\etocpage}}{}% 334 \numberline{\etocnumber}\etocname}{\etocpage}}{}%
246 \etocsetstyle{subsubsection}{}{} 335 \etocsetstyle{subsubsection}{}{}
247 {\etocsavedsubsubsectiontocline{% 336 {\l@subsubsection{%
248 \numberline{\etocnumber}\etocname}{\etocpage}}{}% 337 \numberline{\etocnumber}\etocname}{\etocpage}}{}%
249 \etocsetstyle{paragraph}{}{\leftskip2cm\rightskip 2.2em \parfillskip 338 \etocsetstyle{paragraph}{}{\leftskip2cm\rightskip 2.2em \parfillskip
250 0pt plus 1fil\relax \nobreak} 339 0pt plus 1fil\relax \nobreak}
251 {\noindent\etocname{} \etocpage{} }{\par}% 340 {\noindent\etocname{} \etocpage{} }{\par}%
252 \etocmulticolstyle[2]{\section*{Contents}} 341 \etocmulticolstyle[2]{\section*{Contents}}
253 \pdfbookmark[1]{Contents}{toc} 342 \pdfbookmark[1]{Contents}{toc}
254 \tableofcontents 343 \etoctoclines
344 \localtableofcontents
255 \endgroup} 345 \endgroup}
346\makeatother
347\setlength\IndexMin{100pt}
256\EnableCrossrefs 348\EnableCrossrefs
257\RecordChanges 349\RecordChanges
258\CodelineIndex 350\CodelineIndex
259\begin{document} 351\begin{document}
260 \DocInput{arabluatex.dtx} 352 \DocInput{arabluatex.dtx}
261 \printbibliography[heading=bibintoc] 353 \printbibliography[heading=bibnumbered]
262 \phantomsection 354 \phantomsection
263 \addcontentsline{toc}{section}{Change History}
264 \PrintChanges 355 \PrintChanges
265 \phantomsection 356 \phantomsection
266 \addcontentsline{toc}{section}{Index} 357 \PrintIndex
267 \PrintIndex
268\end{document} 358\end{document}
269%</driver> 359%</driver>
270% \fi 360% \fi
@@ -316,28 +406,26 @@
316% \DoNotIndex{\relax,\RenewDocumentCommand,\string,\verb,\let} 406% \DoNotIndex{\relax,\RenewDocumentCommand,\string,\verb,\let}
317% \DoNotIndex{\enskip} 407% \DoNotIndex{\enskip}
318% 408%
319% \providecommand*{\url}{\texttt}
320% \GetFileInfo{arabluatex.dtx} 409% \GetFileInfo{arabluatex.dtx}
321% 410%
322% \newcommand*{\NEWfeature}[1]{% 411% \pdfbookmark[1]{\metaterm{title}}{title}
323% \hskip 1sp \marginpar{\small\sffamily\raggedright 412% \begin{tcolorbox}[
324% New feature\\#1}} 413% colframe=black,
325% 414% enhanced,
326% \title{\tcbox[colframe=black, enhanced, tikznode, drop lifted 415% drop lifted shadow,
327% shadow, colback=white, boxrule=.25mm]% 416% colback=white,
328% {The \textsf{arabluatex} package\\ 417% boxrule=.25mm,
329% \fileversion\ -- \filedate}} 418% halign=center,
330% 419% center
331% \author{Robert Alessi \\ 420% ]
332% \href{mailto:alessi@robertalessi.net?Subject=arabluatex package}% 421% \metapick[print]{titletext}
333% {\texttt{alessi@robertalessi.net}}} 422% \end{tcolorbox}
334% \date{}
335% 423%
336% \maketitle
337% \footnotesize 424% \footnotesize
338% \altableofcontents 425% \altableofcontents
339% \listoftables 426% \listoftables
340% \normalsize 427% \normalsize
428% \VerbatimFootnotes
341% 429%
342% \begin{abstract} 430% \begin{abstract}
343% This package provides for {\LuaLaTeX} an Arab{\TeX}-like interface 431% This package provides for {\LuaLaTeX} an Arab{\TeX}-like interface
@@ -349,46 +437,59 @@
349% input notation. Its output can be set in the same modes of 437% input notation. Its output can be set in the same modes of
350% vocalization as Arab\TeX, or in different roman 438% vocalization as Arab\TeX, or in different roman
351% transliterations. It further allows many typographical 439% transliterations. It further allows many typographical
352% refinements. It will eventually interact with some other packages 440% refinements. Furthermore, it can interact with the \pkg{ekdosis}
353% yet to come to produce from \verb|.tex| source files, in addition 441% package to produce from \verb|.tex| source files, in addition to
354% to printed books, \texttt{TEI xml} compliant critical editions 442% printed books, \texttt{TEI xml} compliant critical editions and/or
355% and/or lexicons that can be searched, analyzed and correlated in 443% lexicons that can be searched, analyzed and correlated in various
356% various ways. 444% ways.
357% \end{abstract} 445% \end{abstract}
358% 446%
359% \section*{License and disclamer} 447% \section*{License and Disclaimer}
360% \addcontentsline{toc}{section}{License and disclamer} 448% \addcontentsline{toc}{section}{License and disclamer}
361% \subsection*{License applicable to the software} 449% \leavevmode\marginpar{\hfill\texttt{OpenBSD}} \pkg{arabluatex} is
362% \label{sec:license-software} 450% licensed under the terms of the so-called OpenBSD license, as it is
451% modelled after the ISC copyright, which is functionally equivalent
452% to a two-term BSD copyright with language removed that is made
453% unnecessary by the Berne convention.\footnote{More information about
454% the OpenBSD policy to which \pkg{arabluatex} adheres:
455% \url{https://www.openbsd.org/policy.html}.}
363% 456%
364% \package{arabluatex} --- Processing Arab\TeX\ notation under Lua\LaTeX.\\ 457% \iffalse
365% Copyright \textcopyright\ 2016--2020 Robert Alessi 458%<*example>
459% \fi
460\begin{minted}[linenos=false]{text}
461arabluatex -- ArabTeX for LuaLaTeX
462----------------------------------------------------------
463
464Copyright (c) 2016, 2017, 2018, 2019, 2020, 2021, 2022, 2023
465Robert Alessi <alessi@robertalessi.net>
466
467Permission to use, copy, modify, and distribute this software for any
468purpose with or without fee is hereby granted, provided that the above
469copyright notice and this permission notice appear in all copies.
470
471THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
472WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
473MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
474ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
475WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
476ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
477OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
478\end{minted}
479% \iffalse
480%</example>
481% \fi
366% 482%
367% Please send error reports and suggestions for improvements to Robert 483% Please send error reports and suggestions for improvements to Robert
368% Alessi: 484% Alessi:
369% \begin{itemize} 485% \begin{itemize}
370% \item email: \mailto[arabluatex package]{alessi@roberalessi.net} 486% \item email: \mailto[arabluatex package]{alessi@roberalessi.net}
371% \item website: \url{http://www.robertalessi.net/arabluatex} 487% \item website: \url{https://sr.ht/~ralessi/arabluatex/}
372% \item development: \url{http://git.robertalessi.net/arabluatex} 488% \item development: \url{http://git.robertalessi.net/arabluatex}
373% \item comments, feature requests, bug reports: 489% \item comments, feature requests, bug reports:
374% \url{https://gitlab.com/ralessi/arabluatex/issues} 490% \url{https://todo.sr.ht/~ralessi/arabluatex}
375% \end{itemize} 491% \end{itemize}
376% 492%
377% \marginpar{\texttt{gpl3+}}
378% This program is free software: you can redistribute it and/or modify
379% it under the terms of the GNU General Public License as published by
380% the Free Software Foundation, either version 3 of the License, or
381% (at your option) any later version.
382%
383% This program is distributed in the hope that it will be useful, but
384% WITHOUT ANY WARRANTY; without even the implied warranty of
385% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
386% General Public License for more details.
387%
388% You should have received a copy of the GNU General Public License
389% along with this program. If not, see
390% <http://www.gnu.org/licenses/>.
391%
392% This release of \package{arabluatex} consists of the following 493% This release of \package{arabluatex} consists of the following
393% source files: 494% source files:
394% \begin{itemize} 495% \begin{itemize}
@@ -401,21 +502,9 @@
401% \item |arabluatex_trans.lua| 502% \item |arabluatex_trans.lua|
402% \item |arabluatex.el| 503% \item |arabluatex.el|
403% \end{itemize} 504% \end{itemize}
404%
405% \subsection*{License applicable to this document}
406% \label{sec:documentation-license}
407% Copyright \textcopyright\ 2016--2020 Robert Alessi
408%
409% \ccbysa\marginpar{\texttt{CC BY-SA 4.0}}
410% This document is licensed under the Creative Commons
411% Attribution-ShareAlike 4.0 International License. To view a copy of
412% this license, visit
413% \url{http://creativecommons.org/licenses/by-sa/4.0/} or send a
414% letter to Creative Commons, PO Box 1866, Mountain View, CA 94042,
415% USA.
416% 505%
417% \section{Introduction} 506% \section{Introduction}
418% In comparison to Prof. Lagally's outstanding Arab\TeX,\footnote{See 507% In comparison to Prof.\ Lagally's outstanding Arab\TeX,\footnote{See
419% \url{http://ctan.org/pkg/arabtex}} Arab{\LuaTeX} is at present 508% \url{http://ctan.org/pkg/arabtex}} Arab{\LuaTeX} is at present
420% nothing more than a modest piece of software. Hopefully---if I may 509% nothing more than a modest piece of software. Hopefully---if I may
421% say so---it will eventually provide all of its valuable qualities to 510% say so---it will eventually provide all of its valuable qualities to
@@ -532,21 +621,25 @@
532% issue a warning message and attempt to load the Amiri 621% issue a warning message and attempt to load the Amiri
533% font\footnote{\textcite{pkg:amiri}.} like so:---\\ 622% font\footnote{\textcite{pkg:amiri}.} like so:---\\
534% \tcboxverb{\newfontfamily\arabicfont{Amiri}[Script=Arabic]} 623% \tcboxverb{\newfontfamily\arabicfont{Amiri}[Script=Arabic]}
535% \begin{quoting} 624% \begin{remarks}
536% \textsc{Rem.} By default Amiri places the \arb[trans]{kasraT} in 625% \item By default Amiri places the \arb[trans]{kasraT} in combination
537% combination with the \arb[trans]{ta^sdId} below the consonant, 626% with the \arb[trans]{ta^sdId} below the consonant, like so:
538% like so: \arb{BBi}\,. That is correct, as at least in the oldest 627% \arb{BBi}\,. That is correct, as at least in the oldest
539% manuscripts {\renewfontfamily\arabicfont{Amiri}[Script=Arabic, 628% manuscripts {\renewfontfamily\arabicfont{Amiri}[Script=Arabic,
540% RawFeature={+ss05}]\arb{BBi}} may stand for \arb{BBa} as 629% RawFeature={+ss05}]\arb{BBi}} may stand for \arb{BBa} as well as
541% well as \arb{BBi}\,. See \textcite[i. 14 C--D]{Wright}. The placement 630% \arb{BBi}\,. See \textcite[i. 14 C--D]{Wright}. The placement of
542% of the \arb[trans]{kasraT} above the consonant may be obtained by 631% the \arb[trans]{kasraT} above the consonant may be obtained by
543% selecting the |ss05| feature of the Amiri font, like 632% selecting the |ss05| feature of the Amiri font, like
544% so:---\footnote{See the documentation of \package{amiri}, 633% so:---\footnote{See the documentation of \package{amiri},
545% \textcite[6]{pkg:amiri}.}\\ 634% \textcite[6]{pkg:amiri}.}\\
546% \tcboxverb{\newfontfamily\arabicfont{Amiri}[Script=Arabic,RawFeature={+ss05}]} 635% \tcboxverb{\newfontfamily\arabicfont{Amiri}[Script=Arabic,RawFeature={+ss05}]}
547% 636%
548% Other Arabic fonts may behave differently. 637% Other Arabic fonts may behave differently.
549% \end{quoting} 638%
639% \item \cs{newfontfamily} can be used to have
640% either Indian of Arabic numbers printed. See
641% \vpageref{ref:arabic-numbers} for more information.
642% \end{remarks}
550% 643%
551% \subsection{Options} 644% \subsection{Options}
552% \label{sec:options} 645% \label{sec:options}
@@ -580,8 +673,8 @@
580% standards. At present, three standards are supported (see below 673% standards. At present, three standards are supported (see below
581% \vref{sec:transliteration} for more details): 674% \vref{sec:transliteration} for more details):
582% \begin{description} 675% \begin{description}
583% \item[dmg] \emph{Deutsche Morgenländische Gesellschaft}, which is 676% \item[dmg/dmg+] \emph{Deutsche Morgenländische Gesellschaft} |dmg|
584% selected by default; 677% is selected by default;
585% \item[loc] \emph{Library of Congress}; 678% \item[loc] \emph{Library of Congress};
586% \item[arabica] \emph{Arabica}. 679% \item[arabica] \emph{Arabica}.
587% \end{description} 680% \end{description}
@@ -591,7 +684,7 @@
591% \label{ref:export-global-opt} 684% \label{ref:export-global-opt}
592% \DescribeOption{export} |export|$=$|true|\verb+|+|false| 685% \DescribeOption{export} |export|$=$|true|\verb+|+|false|
593% \hfill\tcboxverb{Default: false}\\ \label{export-mode} 686% \hfill\tcboxverb{Default: false}\\ \label{export-mode}
594% \NEWfeature{v.1.13} This option acts as a named argument and does 687% \newfeature[v.1.13] This option acts as a named argument and does
595% not need a value as it defaults to |true| if it is used. It enables 688% not need a value as it defaults to |true| if it is used. It enables
596% \package{arabluatex} to produce a duplicate of the original |.tex| 689% \package{arabluatex} to produce a duplicate of the original |.tex|
597% source file in which all \textsc{ascii} strings are replaced with 690% source file in which all \textsc{ascii} strings are replaced with
@@ -600,7 +693,7 @@
600% 693%
601% \subsubsection{Classic contrasted with modern typesetting of Arabic} 694% \subsubsection{Classic contrasted with modern typesetting of Arabic}
602% \label{sec:classic-modern-typesetting} 695% \label{sec:classic-modern-typesetting}
603% \NEWfeature{v.1.2} By default, \package{arabluatex} typesets Arabic 696% \newfeature[v.1.2] By default, \package{arabluatex} typesets Arabic
604% in a classic, traditional style the most prominent features of which 697% in a classic, traditional style the most prominent features of which
605% are the following: 698% are the following:
606% \begin{itemize} 699% \begin{itemize}
@@ -639,7 +732,7 @@
639% \fi 732% \fi
640% \end{itemize} 733% \end{itemize}
641% 734%
642% \DescribeMacro{\SetArbEasy} \NEWfeature{v1.4.4} Such refinements as 735% \DescribeMacro{\SetArbEasy} \newfeature[v1.4.4] Such refinements as
643% \enquote*{classic} \arb[trans]{maddaT} may be discarded by the 736% \enquote*{classic} \arb[trans]{maddaT} may be discarded by the
644% \cs{SetArbEasy} command, either globally in the preamble or locally 737% \cs{SetArbEasy} command, either globally in the preamble or locally
645% at any point of the document. The difference between \cs{SetArbEasy} 738% at any point of the document. The difference between \cs{SetArbEasy}
@@ -649,7 +742,7 @@
649% mode, while the latter further takes it away. Default 742% mode, while the latter further takes it away. Default
650% \enquote*{classic} rules may be set back at any point of the 743% \enquote*{classic} rules may be set back at any point of the
651% document with the \DescribeMacro{\SetArbDflt}\cs{SetArbDflt} 744% document with the \DescribeMacro{\SetArbDflt}\cs{SetArbDflt}
652% command. \NEWfeature{v1.6} \DescribeMacro{\SetArbDflt*}Assimilation 745% command. \newfeature[v1.6] \DescribeMacro{\SetArbDflt*}Assimilation
653% rules laid on \vref{ref:assimilation} may also be applied by the 746% rules laid on \vref{ref:assimilation} may also be applied by the
654% \enquote*{starred} version of this command \cs{SetArbDflt*} either 747% \enquote*{starred} version of this command \cs{SetArbDflt*} either
655% in the preamble or at any point of the document.\footnote{For an 748% in the preamble or at any point of the document.\footnote{For an
@@ -748,11 +841,11 @@
748% \iffalse 841% \iffalse
749%<*example> 842%<*example>
750% \fi 843% \fi
751\begin{code} 844\begin{alcode}
752 \begin{arab} 845 \begin{arab}
753 [...] 846 [...]
754 \end{arab} 847 \end{arab}
755\end{code} 848\end{alcode}
756% \iffalse 849% \iffalse
757%</example> 850%</example>
758% \fi 851% \fi
@@ -803,43 +896,41 @@
803% where \meta{mode} may be any of |voc|, |fullvoc|, |novoc| or 896% where \meta{mode} may be any of |voc|, |fullvoc|, |novoc| or
804% |trans|. 897% |trans|.
805% 898%
806%\section{Standard Arab\TeX\ input} 899% \section{Standard Arab\TeX\ input}
807%\subsection{Consonants} 900% \subsection{Consonants}
808% \Cref{tab:arabtex-consonants} gives the Arab\TeX\ equivalents for 901% \Vref{tab:arabtex-consonants} gives the Arab\TeX\ equivalents for
809% all of the Arabic consonants. 902% all of the Arabic consonants.
810% 903%
811% \addlines[2]
812% \newcommand{\dmg}[1]{% 904% \newcommand{\dmg}[1]{%
813% \SetTranslitConvention{dmg}% 905% \SetTranslitConvention{dmg+}%
814% \arb[trans]{#1}} 906% \arb[trans]{#1}}
815% \newcommand{\loc}[1]{% 907% \newcommand{\loc}[1]{%
816% \SetTranslitConvention{loc}% 908% \SetTranslitConvention{loc}%
817% \arb[trans]{#1}\SetTranslitConvention{dmg}} 909% \arb[trans]{#1}\SetTranslitConvention{dmg+}}
818% \newcommand{\brill}[1]{% 910% \newcommand{\brill}[1]{%
819% \SetTranslitConvention{arabica}% 911% \SetTranslitConvention{arabica}%
820% \arb[trans]{#1}\SetTranslitConvention{dmg}} 912% \arb[trans]{#1}\SetTranslitConvention{dmg+}}
821% \begin{longtable}{lllll} 913% \begin{longtable}{lllll}
822% \bottomrule 914% \bottomrule
823% \caption*{\Cref*{tab:arabtex-consonants}: Standard Arab\TeX\ 915% \caption[]{Standard Arab\TeX\ (consonants)}
824% (consonants)}
825% \endfoot 916% \endfoot
826% \captionlistentry{Arab\TeX\ consonants}\\[-1em]
827% \toprule 917% \toprule
918% \captionlistentry{Standard Arab\TeX\ (consonants)}
828% Letter & \multicolumn{3}{l}{Transliteration\footnotemark} 919% Letter & \multicolumn{3}{l}{Transliteration\footnotemark}
829% & Arab\TeX\ notation \\ 920% & Arab\TeX\ notation \\
830% & \texttt{dmg} & \texttt{loc} & \texttt{arabica} & \\ \midrule 921% & \texttt{dmg+} & \texttt{loc} & \texttt{arabica} & \\ \midrule
831% \endfirsthead 922% \endfirsthead
832% \toprule 923% \toprule
833% Letter & \multicolumn{3}{l}{Transliteration} 924% Letter & \multicolumn{3}{l}{Transliteration}
834% & Arab\TeX\ notation \\ 925% & Arab\TeX\ notation \\
835% & \texttt{dmg} & \texttt{loc} & \texttt{arabica} & \\ \midrule 926% & \texttt{dmg+} & \texttt{loc} & \texttt{arabica} & \\ \midrule
836% \endhead \footnotetext{See below \vref{sec:transliteration}.} 927% \endhead \footnotetext{See below \vref{sec:transliteration}.}
837% \label{tab:arabtex-consonants} 928% \label{tab:arabtex-consonants}
838% \arb[voc]{'i 'a 'u}\footnote{See below, \emph{Rem{.} a.} For 929% \arb[voc]{'i 'a 'u}\footnote{See below, \emph{Rem{.} a.} For
839% \arb[trans]{'alif} as a consonant, see \textcite[i. 16 930% \arb[trans]{'alif} as a consonant, see \textcite[i. 16
840% D]{Wright}. The \arb[trans]{hamzaT} itself is encoded \texttt{<'>} 931% D]{Wright}. The \arb[trans]{hamzaT} itself is encoded \texttt{<'>}
841% and may be followed by either \meta{u, a} or \meta{i}. See below 932% and may be followed by either \meta{u, a} or \meta{i}. See below
842% \vref{ref:hamza}.} & \dmg{'u 'a 'i} & 933% \vref{ref:hamza}.} & \dmg{|'u, |'a, |'i} &
843% \loc{|'u, |'a, |'i} & \brill{|'u, |'a, |'i} & |'u| or |'a| or |'i| \\ 934% \loc{|'u, |'a, |'i} & \brill{|'u, |'a, |'i} & |'u| or |'a| or |'i| \\
844% \arb[novoc]{b} & \dmg{b} & \loc{b} & \brill{b} & |b| \\ 935% \arb[novoc]{b} & \dmg{b} & \loc{b} & \brill{b} & |b| \\
845% \arb[novoc]{t} & \dmg{t} & \loc{t} & \brill{t} & |t| \\ 936% \arb[novoc]{t} & \dmg{t} & \loc{t} & \brill{t} & |t| \\
@@ -852,6 +943,7 @@
852% \arb[novoc]{r} & \dmg{r} & \loc{r} & \brill{r} & |r| \\ 943% \arb[novoc]{r} & \dmg{r} & \loc{r} & \brill{r} & |r| \\
853% \arb[novoc]{z} & \dmg{z} & \loc{z} & \brill{z} & |z| \\ 944% \arb[novoc]{z} & \dmg{z} & \loc{z} & \brill{z} & |z| \\
854% \arb[novoc]{s} & \dmg{s} & \loc{s} & \brill{s} & |s| \\ 945% \arb[novoc]{s} & \dmg{s} & \loc{s} & \brill{s} & |s| \\
946% \pagebreak[1]
855% \arb[novoc]{^s} & \dmg{^s} & \loc{^s} & \brill{^s} & |^s| \\ 947% \arb[novoc]{^s} & \dmg{^s} & \loc{^s} & \brill{^s} & |^s| \\
856% \arb[novoc]{.s} & \dmg{.s} & \loc{.s} & \brill{.s} & |.s| \\ 948% \arb[novoc]{.s} & \dmg{.s} & \loc{.s} & \brill{.s} & |.s| \\
857% \arb[novoc]{.d} & \dmg{.d} & \loc{.d} & \brill{.d} & |.d| \\ 949% \arb[novoc]{.d} & \dmg{.d} & \loc{.d} & \brill{.d} & |.d| \\
@@ -869,14 +961,14 @@
869% \arb[novoc]{w} & \dmg{w} & \loc{w} & \brill{w} & |w| \\ 961% \arb[novoc]{w} & \dmg{w} & \loc{w} & \brill{w} & |w| \\
870% \arb[novoc]{y} & \dmg{y} & \loc{y} & \brill{y} & |y|\footnote{For 962% \arb[novoc]{y} & \dmg{y} & \loc{y} & \brill{y} & |y|\footnote{For
871% the letter \arb[novoc]{.y} with no diacritical points below, see 963% the letter \arb[novoc]{.y} with no diacritical points below, see
872% \emph{Rem{.} b.} below.} \\ 964% \vref{ref:dotless-ya} below.} \\
873% \arb[novoc]{T} & \dmg{aT} & \loc{aT} & \brill{aT} & |T| \\ 965% \arb[novoc]{T} & \dmg{aT} & \loc{aT} & \brill{aT} & |T| \\
874% \end{longtable} 966% \end{longtable}
875% \begin{quoting} 967% \begin{remarks}
876% \textsc{Rem.}~\emph{a.} Please note that in all cases of elision, 968% \item Please note that in all cases of elision, the
877% the \arb[trans]{'alifu 'l-wa.sli} is expressed only by the vowel 969% \arb[trans]{'alifu 'l-wa.sli} is expressed only by the vowel that
878% that accompanies the omitted \arb[trans]{hamzaT}: \meta{u, a, i} 970% accompanies the omitted \arb[trans]{hamzaT}: \meta{u, a, i} as in
879% as in |wa-inhazama| \arb[fullvoc]{wa-inhazama} 971% |wa-inhazama| \arb[fullvoc]{wa-inhazama}
880% \arb[trans]{wa-inhazama}. For more details on the definite article 972% \arb[trans]{wa-inhazama}. For more details on the definite article
881% and the \arb[trans]{'alifu 'l-wa.sli} see 973% and the \arb[trans]{'alifu 'l-wa.sli} see
882% \vref{ref:definite-article}. 974% \vref{ref:definite-article}.
@@ -890,10 +982,10 @@
890% absence of vowel), |wa-.Aan| \arb{wa-.Aan} \arb[trans]{wa-.Aan}, 982% absence of vowel), |wa-.Aan| \arb{wa-.Aan} \arb[trans]{wa-.Aan},
891% |wa-.Ain| \arb{wa-.Ain} \arb[trans]{wa-.Ain}. 983% |wa-.Ain| \arb{wa-.Ain} \arb[trans]{wa-.Ain}.
892% 984%
893% \textsc{Rem.}~\emph{b.} The letter \arb[novoc]{y} with two points 985% \item \label{ref:dotless-ya}The letter \arb[novoc]{y} with two
894% below, \arb{al-yA'u 'l-mu_tannATu min ta.hti-hA}, may also be 986% points below, \arb{al-yA'u 'l-mu_tannATu min ta.hti-hA}, may also
895% written without diacritical points as \arb[novoc]{Y}. When it is 987% be written without diacritical points as \arb[novoc]{Y}. When it
896% used as a consonant, it is encoded |aY|, where |a| recalls the 988% is used as a consonant, it is encoded |aY|, where |a| recalls the
897% \arb[trans]{fat.haT} placed above the preceding letter in 989% \arb[trans]{fat.haT} placed above the preceding letter in
898% vocalized Arabic, like so: |qaY'uN| \arb{qaY'uN} 990% vocalized Arabic, like so: |qaY'uN| \arb{qaY'uN}
899% \arb[trans]{qaY'uN}, |^saY'uN| \arb{^saY'uN} \arb[trans]{^saY'uN}, 991% \arb[trans]{qaY'uN}, |^saY'uN| \arb{^saY'uN} \arb[trans]{^saY'uN},
@@ -903,30 +995,30 @@
903% like so: |qa.y'uN| \arb{qa.y'uN} \arb[trans]{qa.y'uN}, |^sa.y'uN| 995% like so: |qa.y'uN| \arb{qa.y'uN} \arb[trans]{qa.y'uN}, |^sa.y'uN|
904% \arb{^sa.y'uN} \arb[trans]{^sa.y'uN}, |^sa.y'aN| 996% \arb{^sa.y'uN} \arb[trans]{^sa.y'uN}, |^sa.y'aN|
905% \arb[trans]{^sa.y'aN} \arb{^sa.y'aN}. 997% \arb[trans]{^sa.y'aN} \arb{^sa.y'aN}.
906% \end{quoting} 998% \end{remarks}
907% 999%
908% \subsection{Additional characters} 1000% \subsection{Additional characters}
909% \changes{v1.8.5}{2017/06/20}{Six additional Persian characters are 1001% \changes{v1.8.5}{2017/06/20}{Six additional Persian characters are
910% now available} 1002% now available}
911% \NEWfeature{v1.8.5}\Cref{tab:arabtex-additional-characters} gives 1003% \newfeature[v1.8.5]\Vref{tab:arabtex-additional-characters} gives
912% the Arab\TeX\ equivalents for some additional Persian characters. 1004% the Arab\TeX\ equivalents for some additional Persian characters.
913% 1005%
1006% \enlargethispage{2\baselineskip}
914% \begin{longtable}{lllll} 1007% \begin{longtable}{lllll}
915% \bottomrule 1008% \bottomrule
916% \caption*{\Cref*{tab:arabtex-additional-characters}: Standard 1009% \caption[]{Standard Arab\TeX\ (additional characters)}
917% Arab\TeX\ (additional characters)}
918% \endfoot 1010% \endfoot
919% \captionlistentry{Arab\TeX\ additional characters}\\[-1em]
920% \toprule 1011% \toprule
1012% \captionlistentry{Standard Arab\TeX\ (additional characters)}
921% Letter & \multicolumn{3}{l}{Transliteration\footnotemark} 1013% Letter & \multicolumn{3}{l}{Transliteration\footnotemark}
922% & Arab\TeX\ notation \\ 1014% & Arab\TeX\ notation \\
923% & \texttt{dmg} & \texttt{loc} & \texttt{arabica}\footnotemark 1015% & \texttt{dmg+} & \texttt{loc} & \texttt{arabica}\footnotemark
924% & \\ \midrule 1016% & \\ \midrule
925% \endfirsthead 1017% \endfirsthead
926% \toprule 1018% \toprule
927% Letter & \multicolumn{3}{l}{Transliteration} 1019% Letter & \multicolumn{3}{l}{Transliteration}
928% & Arab\TeX\ notation \\ 1020% & Arab\TeX\ notation \\
929% & \texttt{dmg} & \texttt{loc} & \texttt{arabica} & \\ \midrule 1021% & \texttt{dmg+} & \texttt{loc} & \texttt{arabica} & \\ \midrule
930% \endhead 1022% \endhead
931% \addtocounter{footnote}{-1} 1023% \addtocounter{footnote}{-1}
932% \footnotetext{See below \vref{sec:transliteration}.} 1024% \footnotetext{See below \vref{sec:transliteration}.}
@@ -937,40 +1029,40 @@
937% \label{tab:arabtex-additional-characters} 1029% \label{tab:arabtex-additional-characters}
938% \hskip-1em\arb[novoc]{p} & \dmg{p} & \loc{p} & \brill{p} & \verb|p| \\ 1030% \hskip-1em\arb[novoc]{p} & \dmg{p} & \loc{p} & \brill{p} & \verb|p| \\
939% \arb[novoc]{^c} & \dmg{^c} & \loc{^c} & \brill{^c} & \verb|^c| \\ 1031% \arb[novoc]{^c} & \dmg{^c} & \loc{^c} & \brill{^c} & \verb|^c| \\
1032% \pagebreak[1]
940% \arb[novoc]{^z} & \dmg{^z} & \loc{^z} & \brill{^z} & \verb|^z| \\ 1033% \arb[novoc]{^z} & \dmg{^z} & \loc{^z} & \brill{^z} & \verb|^z| \\
941% \arb[novoc]{v}\footnote{\label{fn:not-in-dmg}This character is not found in 1034% \arb[novoc]{v}\footnote{\label{fn:not-in-dmg}This character is not found in
942% \textcite[2]{dmg}. It is taken from the \textcite{din31635} standard.} & 1035% \textcite[2]{dmg}. It is taken from the \textcite{din31635} standard.} &
943% \dmg{v} & \loc{v} & \brill{v} & \verb|v| \\ 1036% \dmg{v} & \loc{v} & \brill{v} & \verb|v| \\
944% \arb[novoc]{g} & \dmg{g} & \loc{g} & \brill{g} & \verb|g| \\ 1037% \arb[novoc]{g} & \dmg{g} & \loc{g} & \brill{g} & \verb|g| \\
945% \arb[novoc]{^n}\footnote{See \cref{fn:not-in-dmg}.} & \dmg{^n} & 1038% \arb[novoc]{^n}\footnote{See \vref{fn:not-in-dmg}.} & \dmg{^n} &
946% \loc{^n} & \brill{^n} & \verb|^n| \\ 1039% \loc{^n} & \brill{^n} & \verb|^n| \\
947% \end{longtable} 1040% \end{longtable}
948% \begin{quoting} 1041% \begin{remarks}
949% \textsc{Rem.} The alveolar consonants \arb[novoc]{^c} and 1042% \item[\textsc{Rem.}] The alveolar consonants \arb[novoc]{^c} and
950% \arb[novoc]{^z} are processed as solar letters by 1043% \arb[novoc]{^z} are processed as solar letters by
951% \package{arabluatex}. 1044% \package{arabluatex}.
952% \end{quoting} 1045% \end{remarks}
953% 1046%
954% \subsection{Vowels} 1047% \subsection{Vowels}
955% \subsubsection{Long vowels} 1048% \subsubsection{Long vowels}
956% \Cref{tab:arabtex-long-vowels} gives the Arab\TeX\ equivalents for 1049% \Vref{tab:arabtex-long-vowels} gives the Arab\TeX\ equivalents for
957% the Arabic long vowels. 1050% the Arabic long vowels.
958% \enlargethispage{1\baselineskip} 1051%
959% \begin{longtable}{lllll} 1052% \begin{longtable}{lllll}
960% \bottomrule 1053% \bottomrule
961% \caption*{\Cref*{tab:arabtex-long-vowels}: Standard Arab\TeX\ (long 1054% \caption[]{Standard Arab\TeX\ (long vowels)}
962% vowels)}
963% \endfoot 1055% \endfoot
964% \captionlistentry{Arab\TeX\ long vowels}\\[-1em]
965% \toprule 1056% \toprule
1057% \captionlistentry{Standard Arab\TeX\ (long vowels)}
966% Letter & \multicolumn{3}{l}{Transliteration\footnotemark} 1058% Letter & \multicolumn{3}{l}{Transliteration\footnotemark}
967% & Arab\TeX\ notation \\ 1059% & Arab\TeX\ notation \\
968% & \texttt{dmg} & \texttt{loc} & \texttt{arabica} & \\ \midrule 1060% & \texttt{dmg+} & \texttt{loc} & \texttt{arabica} & \\ \midrule
969% \endfirsthead 1061% \endfirsthead
970% \toprule 1062% \toprule
971% Letter & \multicolumn{3}{l}{Transliteration} 1063% Letter & \multicolumn{3}{l}{Transliteration}
972% & Arab\TeX\ notation \\ 1064% & Arab\TeX\ notation \\
973% & \texttt{dmg} & \texttt{loc} & \texttt{arabica} & \\ \midrule 1065% & \texttt{dmg+} & \texttt{loc} & \texttt{arabica} & \\ \midrule
974% \endhead \footnotetext{See below \vref{sec:transliteration}.} 1066% \endhead \footnotetext{See below \vref{sec:transliteration}.}
975% \label{tab:arabtex-long-vowels} 1067% \label{tab:arabtex-long-vowels}
976% \arb[novoc]{A} & \dmg{A} & \loc{A} & \brill{A} & \verb|A| \\ 1068% \arb[novoc]{A} & \dmg{A} & \loc{A} & \brill{A} & \verb|A| \\
@@ -985,10 +1077,10 @@
985% \arb[novoc]{B_i} & \dmg{B_i} & \loc{B_i} & \brill{B_i} & \verb|_i| \\ 1077% \arb[novoc]{B_i} & \dmg{B_i} & \loc{B_i} & \brill{B_i} & \verb|_i| \\
986% \end{longtable} 1078% \end{longtable}
987% 1079%
988% \begin{quoting} 1080% \begin{remarks}
989% \textsc{Rem.}~\emph{a.} The long vowels \arb[trans]{A, U, I}, 1081% \item The long vowels \arb[trans]{A, U, I}, otherwise called
990% otherwise called \arb[trans]{.hurUf-u 'l-madd-i}, \emph{the 1082% \arb[trans]{.hurUf-u 'l-madd-i}, \emph{the letters of
991% letters of prolongation}, involve the placing of the short vowels 1083% prolongation}, involve the placing of the short vowels
992% \arb[trans]{Ba, Bu, Bi} before the letters \arb[novoc]{A}, 1084% \arb[trans]{Ba, Bu, Bi} before the letters \arb[novoc]{A},
993% \arb[novoc]{U}, \arb[novoc]{I} respectively. \package{arabluatex} 1085% \arb[novoc]{U}, \arb[novoc]{I} respectively. \package{arabluatex}
994% does that automatically in case any from |voc|, |fullvoc| or 1086% does that automatically in case any from |voc|, |fullvoc| or
@@ -996,43 +1088,42 @@
996% \arb[voc]{qIla} \arb[trans]{qIla}, \arb[voc]{yaqUlu} 1088% \arb[voc]{qIla} \arb[trans]{qIla}, \arb[voc]{yaqUlu}
997% \arb[trans]{yaqUlu}. 1089% \arb[trans]{yaqUlu}.
998% 1090%
999% \textsc{Rem.}~\emph{b.} Defective writings, such as 1091% \item Defective writings, such as \arb[novoc]{B_a},
1000% \arb[novoc]{B_a}, \arb[trans]{al-'alif-u 'l-ma.h_dUfaT-u}, or 1092% \arb[trans]{al-'alif-u 'l-ma.h_dUfaT-u}, or defective writings of
1001% defective writings of \arb[trans]{B_u} and \arb[trans]{B_i} are 1093% \arb[trans]{B_u} and \arb[trans]{B_i} are encoded |_a| |_u| and
1002% encoded |_a| |_u| and |_i| respectively, e.g. |_d_alika| 1094% |_i| respectively, e.g. |_d_alika| \arb[voc]{_d_alika},
1003% \arb[voc]{_d_alika}, |al-mal_a'ikaT-u| |'l-ra.hm_an-u| 1095% |al-mal_a'ikaT-u| |'l-ra.hm_an-u| \arb[voc]{al-mal_a'ikaT-u
1004% \arb[voc]{al-mal_a'ikaT-u 'l-ra.hm_an-u}, |.hu_dayfaT-u| |bn-u| 1096% 'l-ra.hm_an-u}, |.hu_dayfaT-u| |bn-u| |'l-yamAn_i|
1005% |'l-yamAn_i| \arb[fullvoc]{.hu_dayfaT-u bn-u 'l-yamAn_i} for 1097% \arb[fullvoc]{.hu_dayfaT-u bn-u 'l-yamAn_i} for
1006% \arb[trans]{\uc{.hu_dayfaT-u} bn-u 'l-\uc{yamAn_i}}, etc. 1098% \arb[trans]{\uc{.hu_dayfaT-u} bn-u 'l-\uc{yamAn_i}}, etc.
1007% 1099%
1008% \textsc{Rem.}~\emph{c.} The letter \arb[novoc]{y} with two points 1100% \item The letter \arb[novoc]{y} with two points below, \arb{al-yA'u
1009% below, \arb{al-yA'u 'l-mu_tannATu min ta.hti-hA}, may also be 1101% 'l-mu_tannATu min ta.hti-hA}, may also be written without
1010% written without diacritical points as \arb[novoc]{Y}. When it is 1102% diacritical points as \arb[novoc]{Y}. When it is used as a long
1011% used as a long vowel, it is encoded |iY|, where |i| recalls the 1103% vowel, it is encoded |iY|, where |i| recalls the
1012% \arb[trans]{kasraT} placed below the preceding letter in vocalized 1104% \arb[trans]{kasraT} placed below the preceding letter in vocalized
1013% Arabic, like so: |liY| \arb{liY} \arb[trans]{liY}, |yam^siY| 1105% Arabic, like so: |liY| \arb{liY} \arb[trans]{liY}, |yam^siY|
1014% \arb{yam^siY} \arb[trans]{yam^siY}. 1106% \arb{yam^siY} \arb[trans]{yam^siY}.
1015% \end{quoting} 1107% \end{remarks}
1016% 1108%
1017% \subsubsection{Short vowels} 1109% \subsubsection{Short vowels}
1018% \Cref{tab:arabtex-short-vowels} gives the Arab\TeX\ equivalents for 1110% \Vref{tab:arabtex-short-vowels} gives the Arab\TeX\ equivalents for
1019% the Arabic short vowels. 1111% the Arabic short vowels.
1020% 1112%
1021% \begin{longtable}{lllll} 1113% \begin{longtable}{lllll}
1022% \bottomrule 1114% \bottomrule
1023% \caption*{\Cref*{tab:arabtex-short-vowels}: Standard Arab\TeX\ 1115% \caption[]{Standard Arab\TeX\ (short vowels)}
1024% (short vowels)}
1025% \endfoot 1116% \endfoot
1026% \captionlistentry{Arab\TeX\ short vowels}\\[-1em]
1027% \toprule 1117% \toprule
1118% \captionlistentry{Standard Arab\TeX\ (short vowels)}
1028% Letter & \multicolumn{3}{l}{Transliteration\footnotemark} 1119% Letter & \multicolumn{3}{l}{Transliteration\footnotemark}
1029% & Arab\TeX\ notation \\ 1120% & Arab\TeX\ notation \\
1030% & \texttt{dmg} & \texttt{loc} & \texttt{arabica} & \\ \midrule 1121% & \texttt{dmg+} & \texttt{loc} & \texttt{arabica} & \\ \midrule
1031% \endfirsthead 1122% \endfirsthead
1032% \toprule 1123% \toprule
1033% Letter & \multicolumn{3}{l}{Transliteration} 1124% Letter & \multicolumn{3}{l}{Transliteration}
1034% & Arab\TeX\ notation \\ 1125% & Arab\TeX\ notation \\
1035% & \texttt{dmg} & \texttt{loc} & \texttt{arabica} & \\ \midrule 1126% & \texttt{dmg+} & \texttt{loc} & \texttt{arabica} & \\ \midrule
1036% \endhead \footnotetext{See below \vref{sec:transliteration}.} 1127% \endhead \footnotetext{See below \vref{sec:transliteration}.}
1037% \label{tab:arabtex-short-vowels} 1128% \label{tab:arabtex-short-vowels}
1038% \arb[voc]{Ba} & \dmg{Ba} & \loc{Ba} & \brill{Ba} & \verb|a| \\ 1129% \arb[voc]{Ba} & \dmg{Ba} & \loc{Ba} & \brill{Ba} & \verb|a| \\
@@ -1481,7 +1572,7 @@
1481% |al-.hamd-u| |li-l-l_ah-i| \arb[fullvoc]{al-.hamd-u li-l-l_ah-i} 1572% |al-.hamd-u| |li-l-l_ah-i| \arb[fullvoc]{al-.hamd-u li-l-l_ah-i}
1482% \arb[trans]{al-.hamd-u li-l-l_ah-i}. 1573% \arb[trans]{al-.hamd-u li-l-l_ah-i}.
1483% \end{quote} 1574% \end{quote}
1484% As said above on \cpageref{fullvoc-mode}, |fullvoc| is the mode 1575% As said above on \vpageref{fullvoc-mode}, |fullvoc| is the mode
1485% in which \package{arabluatex} expresses the \arb[trans]{sukUn} and 1576% in which \package{arabluatex} expresses the \arb[trans]{sukUn} and
1486% the \arb[trans]{wa.slaT}. \package{arabluatex} will take care of 1577% the \arb[trans]{wa.slaT}. \package{arabluatex} will take care of
1487% doing that automatically provided that the vowel which is to be 1578% doing that automatically provided that the vowel which is to be
@@ -1663,7 +1754,7 @@
1663% \enquote{pipe} and \vref{sec:transliteration} on |dmg| mode.} 1754% \enquote{pipe} and \vref{sec:transliteration} on |dmg| mode.}
1664% |al-l_ah-u| \arb[fullvoc]{yA| al-l_ah-u} \arb[trans]{yA| 1755% |al-l_ah-u| \arb[fullvoc]{yA| al-l_ah-u} \arb[trans]{yA|
1665% al-l_ah-u}, \verb+'a-fa|+\footnote{\label{fn:pipe-allah-02}See 1756% al-l_ah-u}, \verb+'a-fa|+\footnote{\label{fn:pipe-allah-02}See
1666% \cref{fn:pipe-allah-01}.}|-al-|\allowbreak|l_ah-i| 1757% \vref{fn:pipe-allah-01}.}|-al-|\allowbreak|l_ah-i|
1667% |la-ta.g`alanna| \arb[fullvoc]{'a-fa|-al-l_ah-i la-ta.g`alanna} 1758% |la-ta.g`alanna| \arb[fullvoc]{'a-fa|-al-l_ah-i la-ta.g`alanna}
1668% \arb[trans]{'a-fa|-al-l_ah-i la-ta.g`alanna}, 1759% \arb[trans]{'a-fa|-al-l_ah-i la-ta.g`alanna},
1669% |bi-'l-|\allowbreak|l_ah-i| \arb[fullvoc]{bi-'l-l_ah-i} 1760% |bi-'l-|\allowbreak|l_ah-i| \arb[fullvoc]{bi-'l-l_ah-i}
@@ -1855,27 +1946,26 @@
1855% analysis. \enquote{Quoting} that straight single quote character 1946% analysis. \enquote{Quoting} that straight single quote character
1856% like so: \meta{\texttt{"'}} allows to determine the carrier of the 1947% like so: \meta{\texttt{"'}} allows to determine the carrier of the
1857% \arb[trans]{hamzaT} freely, without any consideration for the 1948% \arb[trans]{hamzaT} freely, without any consideration for the
1858% context. \Cref{tab:quoted-hamza} gives the equivalents for all the 1949% context. \Vref{tab:quoted-hamza} gives the equivalents for all the
1859% possible carriers the \arb[trans]{hamzaT} may take. 1950% possible carriers the \arb[trans]{hamzaT} may take.
1860% 1951%
1861% \begin{longtable}{lllll} 1952% \begin{longtable}{lllll}
1862% \bottomrule 1953% \bottomrule
1863% \caption*{\Cref*{tab:quoted-hamza}: \enquote{Quoted} 1954% \caption[]{\enquote{Quoted} \arb[trans]{hamzaT}}
1864% \arb[trans]{hamzaT}}
1865% \endfoot 1955% \endfoot
1866% \captionlistentry{\enquote{Quoted} \arb[trans]{hamzaT}}\\[-1em] 1956% \toprule
1867% \toprule Letter & \multicolumn{3}{l}{Transliteration\footnotemark} 1957% \captionlistentry{\enquote{Quoted} \arb[trans]{hamzaT}}
1958% Letter & \multicolumn{3}{l}{Transliteration\footnotemark}
1868% & Arab\TeX\ notation \\ 1959% & Arab\TeX\ notation \\
1869% & \texttt{dmg} & \texttt{loc} & \texttt{arabica} & \\ \midrule 1960% & \texttt{dmg+} & \texttt{loc} & \texttt{arabica} & \\ \midrule
1870% \endfirsthead 1961% \endfirsthead
1871% \toprule Letter & \multicolumn{3}{l}{Transliteration} 1962% \toprule Letter & \multicolumn{3}{l}{Transliteration}
1872% & Arab\TeX\ notation \\ 1963% & Arab\TeX\ notation \\
1873% & \texttt{dmg} & \texttt{loc} & \texttt{arabica} & \\ \midrule 1964% & \texttt{dmg+} & \texttt{loc} & \texttt{arabica} & \\ \midrule
1874% \endhead 1965% \endhead
1875% \footnotetext{See below \vref{sec:transliteration}.} 1966% \footnotetext{See below \vref{sec:transliteration}.}
1876% \label{tab:quoted-hamza} 1967% \label{tab:quoted-hamza}
1877% \arb[novoc]{|"'} & \dmg{|"'} & \loc{|"'} & \brill{|"'} & \verb+|"'+ \\ 1968% \arb[novoc]{|"'} & \dmg{|"'} & \loc{|"'} & \brill{|"'} & \verb+|"'+ \\
1878% \pagebreak[1]
1879% \arb[novoc]{A"'} & \dmg{A"'} & \loc{A"'} & \brill{A"'} & \verb|A"'| \\ 1969% \arb[novoc]{A"'} & \dmg{A"'} & \loc{A"'} & \brill{A"'} & \verb|A"'| \\
1880% \arb[novoc]{a"'} & \dmg{a"'} & \loc{a"'} & \brill{a"'} & \verb|a"'| \\ 1970% \arb[novoc]{a"'} & \dmg{a"'} & \loc{a"'} & \brill{a"'} & \verb|a"'| \\
1881% \arb[novoc]{u"'} & \dmg{u"'} & \loc{u"'} & \brill{u"'} & \verb|u"'| \\ 1971% \arb[novoc]{u"'} & \dmg{u"'} & \loc{u"'} & \brill{u"'} & \verb|u"'| \\
@@ -1926,11 +2016,11 @@
1926% \end{quote} 2016% \end{quote}
1927% As one can see, the \enquote{pipe} character between the two 2017% As one can see, the \enquote{pipe} character between the two
1928% \meta{n} prevents the necessary \arb[trans]{ta^sdId} rule 2018% \meta{n} prevents the necessary \arb[trans]{ta^sdId} rule
1929% (\cpageref{ref:necessary-tashdid}) from being applied. 2019% (\vpageref{ref:necessary-tashdid}) from being applied.
1930% 2020%
1931% \subsection{Putting back on broken contextual analysis rules} 2021% \subsection{Putting back on broken contextual analysis rules}
1932% \label{sec:arbnull} 2022% \label{sec:arbnull}
1933% \NEWfeature{v1.7} In complex documents such as critical editions 2023% \newfeature[v1.7] In complex documents such as critical editions
1934% where footnotes and other kind of annotations can be particularly 2024% where footnotes and other kind of annotations can be particularly
1935% abundant, the contextual analysis rules that are described above may 2025% abundant, the contextual analysis rules that are described above may
1936% be broken by \LaTeX\ commands. To take an example, consider the 2026% be broken by \LaTeX\ commands. To take an example, consider the
@@ -2026,6 +2116,34 @@
2026% |sanaT-i| |1024| \arb[voc]{fI sanaT-i 1024} 2116% |sanaT-i| |1024| \arb[voc]{fI sanaT-i 1024}
2027% \end{quote} 2117% \end{quote}
2028% 2118%
2119% \needspace{2\baselineskip}
2120% \DescribeMacro{\SetArbNumbers}\newfeature[v1.21]
2121% \phts\label{ref:arabic-numbers}
2122% \cs{SetArbNumbers}\verb+{Indian|Arabic}+ %
2123% \hfill\tcboxverb{Default: Indian}\\
2124% As described above, \package{arabluatex} prints Indian numbers by
2125% default. \cs{SetArbNumbers}|{Arabic}| can be used at any point of
2126% the document to have Arabic numbers printed. Furthermore,
2127% \cs{SetArbNumbers}|{Arabic}| gives control over the way numbers are
2128% to be printed by means of the |anum| font feature, like so:---
2129%
2130% \iffalse
2131%<*example>
2132% \fi
2133\begin{alcode}
2134 \usepackage{arabluatex}
2135 \SetArbNumbers{Arabic}
2136 % use '+anum' for Arabic numbers or '-anum' for Indian numbers:
2137 \newfontfamily\arabicfont{Amiri}[Script=Arabic, RawFeature={+anum}]
2138\end{alcode}
2139% \iffalse
2140%</example>
2141% \fi
2142%
2143% \danger \cs{SetArbNumbers} must be used \emph{outside} Arabic
2144% environments. Once used, this commands operates on subsequent Arabic
2145% environments.
2146%
2029% \subsubsection{The \emph{abjad}} 2147% \subsubsection{The \emph{abjad}}
2030% \label{sec:abjad} 2148% \label{sec:abjad}
2031% The numbers may also be expressed with letters from right to left 2149% The numbers may also be expressed with letters from right to left
@@ -2034,7 +2152,7 @@
2034% \arb[trans]{'abjad} numbers are usually distinguished from the 2152% \arb[trans]{'abjad} numbers are usually distinguished from the
2035% surrounding words by a stroke placed over them. 2153% surrounding words by a stroke placed over them.
2036% 2154%
2037% \DescribeMacro{\abjad} \NEWfeature{v.1.1} \arb[trans]{'abjad} 2155% \DescribeMacro{\abjad} \newfeature[v.1.1] \arb[trans]{'abjad}
2038% numbers are inserted with the \cs{abjad}\marg{number} command in any 2156% numbers are inserted with the \cs{abjad}\marg{number} command in any
2039% of the |voc|, |fullvoc| and |novoc| modes, where \meta{number} may 2157% of the |voc|, |fullvoc| and |novoc| modes, where \meta{number} may
2040% be any number between 1 and 1999, like so:--- 2158% be any number between 1 and 1999, like so:---
@@ -2043,19 +2161,19 @@
2043% kitAbu-hu fI 'l-`AdAt-i} \arb[trans]{\abjad{45} kitAbu-hu fI 2161% kitAbu-hu fI 'l-`AdAt-i} \arb[trans]{\abjad{45} kitAbu-hu fI
2044% 'l-`AdAt-i}. 2162% 'l-`AdAt-i}.
2045% \end{quote} 2163% \end{quote}
2046% \begin{quoting} 2164% \begin{remarks}
2047% \textsc{Rem.}~\emph{a.} As can be seen in the above given example, 2165% \item As can be seen in the above given example,
2048% \package{arabluatex} expresses the \arb[trans]{'abjad} numbers in 2166% \package{arabluatex} expresses the \arb[trans]{'abjad} numbers in
2049% Roman numerals if it finds the \cs{abjad} command in any of the 2167% Roman numerals if it finds the \cs{abjad} command in any of the
2050% transliteration modes. 2168% transliteration modes.
2051% 2169%
2052% \textsc{Rem.}~\emph{b.} \cs{abjad} may also be found outside 2170% \item \cs{abjad} may also be found outside Arabic environments. In
2053% Arabic environments. In that case, \package{arabluatex} does not 2171% that case, \package{arabluatex} does not print the stroke as a
2054% print the stroke as a distinctive mark over the number for it is 2172% distinctive mark over the number for it is not surrounded by other
2055% not surrounded by other Arabic words. In case one nonetheless 2173% Arabic words. In case one nonetheless wishes to print the stroke,
2056% wishes to print the stroke, he can either use the \cs{aoline*} 2174% he can either use the \cs{aoline*} command that is described below
2057% command that is described below in \vref{sec:underlining} or 2175% in \vref{sec:underlining} or insert the \arb[trans]{'ab^gad}
2058% insert the \arb[trans]{'ab^gad} number in |\arb[novoc]{}|:--- 2176% number in |\arb[novoc]{}|:---
2059% \begin{quote} 2177% \begin{quote}
2060% |The| |\arb[trans]{'abjad}| |number| |for| |1874| |is| 2178% |The| |\arb[trans]{'abjad}| |number| |for| |1874| |is|
2061% |\abjad{1874}| The \arb[trans]{'abjad} number for 1874 is 2179% |\abjad{1874}| The \arb[trans]{'abjad} number for 1874 is
@@ -2069,9 +2187,9 @@
2069% |\arb[novoc]{\abjad{1874}}| The \arb[trans]{'abjad} number for 2187% |\arb[novoc]{\abjad{1874}}| The \arb[trans]{'abjad} number for
2070% 1874 is \arb[novoc]{\abjad{1874}}. 2188% 1874 is \arb[novoc]{\abjad{1874}}.
2071% \end{quote} 2189% \end{quote}
2072% \end{quoting} 2190% \end{remarks}
2073% 2191%
2074% \NEWfeature{v1.12}\cs{abjad} may also be used to convert values of 2192% \newfeature[v1.12]\cs{abjad} may also be used to convert values of
2075% counters into \arb[trans]{'ab^gad} numbers, like so:--- % 2193% counters into \arb[trans]{'ab^gad} numbers, like so:--- %
2076% \changes{v1.12}{2018/06/24}{\cs{abjad} can now process \LaTeX\ 2194% \changes{v1.12}{2018/06/24}{\cs{abjad} can now process \LaTeX\
2077% counters}% 2195% counters}%
@@ -2103,19 +2221,18 @@
2103% For the time being, the following is included:--- 2221% For the time being, the following is included:---
2104% \begin{longtable}{lllll} 2222% \begin{longtable}{lllll}
2105% \bottomrule 2223% \bottomrule
2106% \caption*{\Cref*{tab:additional-arabic-codings}: Additional Arabic 2224% \caption[]{Additional Arabic codings}
2107% codings}
2108% \endfoot 2225% \endfoot
2109% \captionlistentry{Additional Arabic codings}\\[-1em]
2110% \toprule 2226% \toprule
2227% \captionlistentry{Additional Arabic codings}
2111% Letter & \multicolumn{3}{l}{Transliteration\footnotemark} 2228% Letter & \multicolumn{3}{l}{Transliteration\footnotemark}
2112% & Arab\TeX\ notation \\ 2229% & Arab\TeX\ notation \\
2113% & \texttt{dmg} & \texttt{loc} & \texttt{arabica} & \\ \midrule 2230% & \texttt{dmg+} & \texttt{loc} & \texttt{arabica} & \\ \midrule
2114% \endfirsthead 2231% \endfirsthead
2115% \toprule 2232% \toprule
2116% Letter & \multicolumn{3}{l}{Transliteration} 2233% Letter & \multicolumn{3}{l}{Transliteration}
2117% & Arab\TeX\ notation \\ 2234% & Arab\TeX\ notation \\
2118% & \texttt{dmg} & \texttt{loc} & \texttt{arabica} \\ \midrule 2235% & \texttt{dmg+} & \texttt{loc} & \texttt{arabica} \\ \midrule
2119% \endhead \footnotetext{See below \vref{sec:transliteration}.} 2236% \endhead \footnotetext{See below \vref{sec:transliteration}.}
2120% \label{tab:additional-arabic-codings} 2237% \label{tab:additional-arabic-codings}
2121% \arb[novoc]{.b} & \dmg{.b} & \loc{.b} & \brill{.b} & |.b| \\ 2238% \arb[novoc]{.b} & \dmg{.b} & \loc{.b} & \brill{.b} & |.b| \\
@@ -2123,8 +2240,16 @@
2123% \arb[novoc]{.f} & \dmg{.f} & \loc{.f} & \brill{.f} & |.f| \\ 2240% \arb[novoc]{.f} & \dmg{.f} & \loc{.f} & \brill{.f} & |.f| \\
2124% \arb[novoc]{.q} & \dmg{.q} & \loc{.q} & \brill{.q} & |.q| \\ 2241% \arb[novoc]{.q} & \dmg{.q} & \loc{.q} & \brill{.q} & |.q| \\
2125% \arb[novoc]{.k} & \dmg{.k} & \loc{.k} & \brill{.k} & |.k| \\ 2242% \arb[novoc]{.k} & \dmg{.k} & \loc{.k} & \brill{.k} & |.k| \\
2126% \pagebreak[1]
2127% \arb[novoc]{.n} & \dmg{.n} & \loc{.n} & \brill{.n} & |.n| \\ 2243% \arb[novoc]{.n} & \dmg{.n} & \loc{.n} & \brill{.n} & |.n| \\
2244% \arb[novoc]{H} & \dmg{aH} & \loc{aH} & \brill{aH} &
2245% |H|\footnote{This letter can be used to encode the \arb[trans]{tA'
2246% marbUtaT} devoid of diacritical points as it is found in some
2247% manuscripts, with the same \arb[trans]{tanwIn} and the same
2248% short vowels as the standard \arb[trans]{tA' marbUtaT} with two
2249% points above, e. g. |al-madInaHa|, |madInaHaN|, \arb{al-madInaHa},
2250% \arb{madInaHaN}.} \\
2251% \arb[novoc]{.y} & \dmg{.y} & \loc{.y} & \brill{.y} &
2252% |.y|\footnote{See above \vref{ref:dotless-ya}.} \\
2128% \arb[novoc]{((} & \dmg{((} & \loc{((} & \brill{((} & |((| \\ 2253% \arb[novoc]{((} & \dmg{((} & \loc{((} & \brill{((} & |((| \\
2129% \arb[novoc]{))} & \dmg{))} & \loc{))} & \brill{))} & |))| \\ 2254% \arb[novoc]{))} & \dmg{))} & \loc{))} & \brill{))} & |))| \\
2130% \end{longtable} 2255% \end{longtable}
@@ -2151,25 +2276,25 @@
2151% \arb[trans]{\abjad{45}: kitAbu-hu \aemph{fI 'l-\uc{`AdAt-i}}}. 2276% \arb[trans]{\abjad{45}: kitAbu-hu \aemph{fI 'l-\uc{`AdAt-i}}}.
2152% \end{quote} 2277% \end{quote}
2153% 2278%
2154% \begin{quoting} 2279% \begin{remarks}
2155% \textsc{Rem.}~\emph{a.} As the above example shows, 2280% \item As the above example shows, \package{arabluatex} places the
2156% \package{arabluatex} places the horizontal stroke \emph{under} the 2281% horizontal stroke \emph{under} the emphasized words in any of the
2157% emphasized words in any of the transliteration modes. 2282% transliteration modes.
2158% 2283%
2159% \textsc{Rem.}~\emph{b.} \NEWfeature{v1.9.2}\DescribeMacro{\aemph*} 2284% \item \newfeature[v1.9.2]\DescribeMacro{\aemph*} \cs{aemph*} is also
2160% \cs{aemph*} is also provided should one wish to always have the 2285% provided should one wish to always have the horizontal stroke
2161% horizontal stroke printed over the emphasized words, like so: 2286% printed over the emphasized words, like so: |\abjad{45}:|
2162% |\abjad{45}:| |kitAbu-hu| |\aemph*{fI| |'l-`AdAt-i}| 2287% |kitAbu-hu| |\aemph*{fI| |'l-`AdAt-i}| \arb[voc]{\abjad{45}:
2163% \arb[voc]{\abjad{45}: kitAbu-hu \aemph*{fI 'l-`AdAt-i}} 2288% kitAbu-hu \aemph*{fI 'l-`AdAt-i}} \arb[trans]{\abjad{45}:
2164% \arb[trans]{\abjad{45}: kitAbu-hu \aemph*{fI 'l-\uc{`AdAt-i}}}. 2289% kitAbu-hu \aemph*{fI 'l-\uc{`AdAt-i}}}.
2165% \end{quoting} 2290% \end{remarks}
2166% 2291%
2167% \subsubsection{Underlining words or numbers} 2292% \subsubsection{Underlining words or numbers}
2168% \label{sec:underlining} 2293% \label{sec:underlining}
2169% \DescribeMacro{\aoline}% 2294% \DescribeMacro{\aoline}%
2170% \DescribeMacro{\aoline*}% 2295% \DescribeMacro{\aoline*}%
2171% \DescribeMacro{\auline}% 2296% \DescribeMacro{\auline}%
2172% \NEWfeature{v1.19}Three additional, non context-sensitive commands 2297% \newfeature[v1.19]Three additional, non context-sensitive commands
2173% are provided to distinguish words or numbers:--- 2298% are provided to distinguish words or numbers:---
2174% \begin{enumerate} 2299% \begin{enumerate}
2175% \item \cs{aoline}, which is equivalent to \cs{aemph*} described 2300% \item \cs{aoline}, which is equivalent to \cs{aemph*} described
@@ -2182,7 +2307,7 @@
2182% 2307%
2183% \section{Arabic poetry} 2308% \section{Arabic poetry}
2184% \label{sec:poetry} 2309% \label{sec:poetry}
2185% \NEWfeature{v1.6} \package{arabluatex} provides a special 2310% \newfeature[v1.6] \package{arabluatex} provides a special
2186% environment for typesetting Arabic poetry. Every line in this 2311% environment for typesetting Arabic poetry. Every line in this
2187% environment must end with |\\|. 2312% environment must end with |\\|.
2188% 2313%
@@ -2192,11 +2317,11 @@
2192% \iffalse 2317% \iffalse
2193%<*example> 2318%<*example>
2194% \fi 2319% \fi
2195\begin{code} 2320\begin{alcode}
2196 \begin{arabverse}[key1=value1, key2=value2, ...] 2321 \begin{arabverse}[key1=value1, key2=value2, ...]
2197 <verses> 2322 <verses>
2198 \end{arabverse} 2323 \end{arabverse}
2199\end{code} 2324\end{alcode}
2200% \iffalse 2325% \iffalse
2201%</example> 2326%</example>
2202% \fi 2327% \fi
@@ -2245,13 +2370,13 @@
2245% 2370%
2246% \DescribeOption{color} |color|$=$\meta{color name} 2371% \DescribeOption{color} |color|$=$\meta{color name}
2247% \hfill\tcboxverb{Default: not set}\\ 2372% \hfill\tcboxverb{Default: not set}\\
2248% \NEWfeature{v1.13} The color in which lines of poetry are to be 2373% \newfeature[v1.13] The color in which lines of poetry are to be
2249% rendered. 2374% rendered.
2250% 2375%
2251% \label{ref:poetry-export} 2376% \label{ref:poetry-export}
2252% \DescribeOption{export} |export|$=$|true|\verb+|+|false| 2377% \DescribeOption{export} |export|$=$|true|\verb+|+|false|
2253% \hfill\tcboxverb{Default: false}\\ 2378% \hfill\tcboxverb{Default: false}\\
2254% \NEWfeature{v.1.13} This named argument does not need a value as it 2379% \newfeature[v.1.13] This named argument does not need a value as it
2255% defaults to |true| if it is used. If |export| is set as a global 2380% defaults to |true| if it is used. If |export| is set as a global
2256% option as well (see above \vpageref{export-mode}), all the lines 2381% option as well (see above \vpageref{export-mode}), all the lines
2257% will be converted to Unicode and exported to the external selected 2382% will be converted to Unicode and exported to the external selected
@@ -2265,8 +2390,9 @@
2265% when \texttt{export} is set to \texttt{true} to instruct some Lua 2390% when \texttt{export} is set to \texttt{true} to instruct some Lua
2266% functions that lines of poetry have already been processed. That 2391% functions that lines of poetry have already been processed. That
2267% aside, \cs{bayt} and \cs{bayt*} do the same, and only \cs{bayt} 2392% aside, \cs{bayt} and \cs{bayt*} do the same, and only \cs{bayt}
2268% should be used.} Additionally, every \cs{bayt} command \emph{must} 2393% should be used.} Additionally, every \cs{bayt} command \emph{must}
2269% be followed with |\\| like so:---% 2394% be followed with |\\| like so:---
2395%
2270% \iffalse 2396% \iffalse
2271%<*example> 2397%<*example>
2272% \fi 2398% \fi
@@ -2371,7 +2497,7 @@
2371% 2497%
2372% \DescribeMacro{\StretchBayt} \cs{StretchBayt}\verb+[true|false]+ 2498% \DescribeMacro{\StretchBayt} \cs{StretchBayt}\verb+[true|false]+
2373% \hfill\tcboxverb{Default: true}\\ 2499% \hfill\tcboxverb{Default: true}\\
2374% \NEWfeature{v1.20} \cs{StretchBayt} takes one optional argument, 2500% \newfeature[v1.20] \cs{StretchBayt} takes one optional argument,
2375% either |true| or |false| and can be used to remove the stretching 2501% either |true| or |false| and can be used to remove the stretching
2376% form lines of Arabic poetry. As a side effect, there will be more 2502% form lines of Arabic poetry. As a side effect, there will be more
2377% space between words, but this can be compensated by inserting double 2503% space between words, but this can be compensated by inserting double
@@ -2401,6 +2527,16 @@
2401% package can also be used for the same effect. However, it must be 2527% package can also be used for the same effect. However, it must be
2402% loaded \emph{after} \package{arabluatex}.} 2528% loaded \emph{after} \package{arabluatex}.}
2403% 2529%
2530% \needspace{3\baselineskip}
2531% \paragraph{Critical Notes}
2532% \DescribeMacro{\bayt+} \newfeature[v1.21] If the \pkg{ekdosis}
2533% package be loaded,\footcite{pkg:ekdosis} the \cs{bayt} command also
2534% accepts a |+| optional argument that can be used to let critical
2535% notes be inserted in lines of poetry. Details on how to use this
2536% command are provided in the relevant section of the documentation of
2537% the \pkg{ekdosis} package.\footcite[\nopp see \enquote{Arabic
2538% Poetry}]{pkg:ekdosis}
2539%
2404% \paragraph{Line numbering} 2540% \paragraph{Line numbering}
2405% Inside the |arabverse| environment, the |linenumbers| environment of 2541% Inside the |arabverse| environment, the |linenumbers| environment of
2406% the \package{lineno} package can be used to have the lines of 2542% the \package{lineno} package can be used to have the lines of
@@ -2423,7 +2559,7 @@
2423% \iffalse 2559% \iffalse
2424%<*example> 2560%<*example>
2425% \fi 2561% \fi
2426\begin{code} 2562\begin{alcode}
2427 \begin{arab}[fullvoc] 2563 \begin{arab}[fullvoc]
2428 qAla imru'u 'l-\uc{q}aysi fI mu`allaqati-hi: 2564 qAla imru'u 'l-\uc{q}aysi fI mu`allaqati-hi:
2429 \end{arab} 2565 \end{arab}
@@ -2432,7 +2568,7 @@
2432 'l-`arU.di 'l-'_Ul_A mina 'l-.tawIli)}] 2568 'l-`arU.di 'l-'_Ul_A mina 'l-.tawIli)}]
2433 \SetArbDflt* 2569 \SetArbDflt*
2434 \begin{linenumbers*} 2570 \begin{linenumbers*}
2435 \bayt{qifA nabki min _dikr_A .habIbiN wa-manzili}{bi-saq.ti 2571 \bayt{qifA nabki min _dikr_A .habIbiN wa-manzili}{bi-siq.ti
2436 'l-liw_A bayna \uc{'l-d}a_hUli fa-\uc{.h}awmali}\\ 2572 'l-liw_A bayna \uc{'l-d}a_hUli fa-\uc{.h}awmali}\\
2437 \bayt{fa-\uc{t}U.di.ha fa-'l-\uc{m}iqrATi lam ya`fu 2573 \bayt{fa-\uc{t}U.di.ha fa-'l-\uc{m}iqrATi lam ya`fu
2438 rasmu-hA}{limA nasa^gat-hA min ^ganUbiN wa-^sam'ali}\\ 2574 rasmu-hA}{limA nasa^gat-hA min ^ganUbiN wa-^sam'ali}\\
@@ -2446,7 +2582,7 @@
2446 rasmiN dArisiN min mu`awwali}\\ 2582 rasmiN dArisiN min mu`awwali}\\
2447 \end{linenumbers*} 2583 \end{linenumbers*}
2448 \end{arabverse} 2584 \end{arabverse}
2449\end{code} 2585\end{alcode}
2450% \iffalse 2586% \iffalse
2451%</example> 2587%</example>
2452% \fi% 2588% \fi%
@@ -2461,7 +2597,7 @@
2461% 'l-`arU.di 'l-'_Ul_A mina 'l-.tawIli)}, width=.25\linewidth] 2597% 'l-`arU.di 'l-'_Ul_A mina 'l-.tawIli)}, width=.25\linewidth]
2462% \SetArbDflt* 2598% \SetArbDflt*
2463% \begin{linenumbers*} 2599% \begin{linenumbers*}
2464% \bayt{qifA nabki min _dikr_A .habIbiN wa-manzili}{bi-saq.ti 2600% \bayt{qifA nabki min _dikr_A .habIbiN wa-manzili}{bi-siq.ti
2465% 'l-liw_A bayna \uc{'l-d}a_hUli fa-\uc{.h}awmali}\\ 2601% 'l-liw_A bayna \uc{'l-d}a_hUli fa-\uc{.h}awmali}\\
2466% \bayt{fa-\uc{t}U.di.ha fa-'l-\uc{m}iqrATi lam ya`fu 2602% \bayt{fa-\uc{t}U.di.ha fa-'l-\uc{m}iqrATi lam ya`fu
2467% rasmu-hA}{limA nasa^gat-hA min ^ganUbiN wa-^sam'ali}\\ 2603% rasmu-hA}{limA nasa^gat-hA min ^ganUbiN wa-^sam'ali}\\
@@ -2486,7 +2622,7 @@
2486% 'l-`arU.di 'l-'_Ul_A mina 'l-.tawIli)}, width=.4\linewidth] 2622% 'l-`arU.di 'l-'_Ul_A mina 'l-.tawIli)}, width=.4\linewidth]
2487% \SetArbDflt* 2623% \SetArbDflt*
2488% \begin{linenumbers*} 2624% \begin{linenumbers*}
2489% \bayt{qifA nabki min _dikr_A .habIbiN wa-manzili}{bi-saq.ti 2625% \bayt{qifA nabki min _dikr_A .habIbiN wa-manzili}{bi-siq.ti
2490% 'l-liw_A bayna \uc{'l-d}a_hUli fa-\uc{.h}awmali}\\ 2626% 'l-liw_A bayna \uc{'l-d}a_hUli fa-\uc{.h}awmali}\\
2491% \bayt{fa-\uc{t}U.di.ha fa-'l-\uc{m}iqrATi lam ya`fu 2627% \bayt{fa-\uc{t}U.di.ha fa-'l-\uc{m}iqrATi lam ya`fu
2492% rasmu-hA}{limA nasa^gat-hA min ^ganUbiN wa-^sam'ali}\\ 2628% rasmu-hA}{limA nasa^gat-hA min ^ganUbiN wa-^sam'ali}\\
@@ -2515,7 +2651,7 @@
2515% 'l-`arU.di 'l-'_Ul_A mina 'l-.tawIli)}, width=.3\linewidth] 2651% 'l-`arU.di 'l-'_Ul_A mina 'l-.tawIli)}, width=.3\linewidth]
2516% \SetArbDflt* 2652% \SetArbDflt*
2517% \begin{linenumbers*} 2653% \begin{linenumbers*}
2518% \bayt{qifA nabki min _dikr_A .habIbiN wa-manzili}{bi-saq.ti 2654% \bayt{qifA nabki min _dikr_A .habIbiN wa-manzili}{bi-siq.ti
2519% 'l-liw_A bayna \uc{'l-d}a_hUli fa-\uc{.h}awmali}\\ 2655% 'l-liw_A bayna \uc{'l-d}a_hUli fa-\uc{.h}awmali}\\
2520% \bayt{fa-\uc{t}U.di.ha fa-'l-\uc{m}iqrATi lam ya`--fu 2656% \bayt{fa-\uc{t}U.di.ha fa-'l-\uc{m}iqrATi lam ya`--fu
2521% rasmu---hA}{limA nasa^gat-hA mi--n ^gan----UbiN wa-^sam'ali}\\ 2657% rasmu---hA}{limA nasa^gat-hA mi--n ^gan----UbiN wa-^sam'ali}\\
@@ -2543,7 +2679,7 @@
2543% \SetArbDflt* 2679% \SetArbDflt*
2544% \scriptsize 2680% \scriptsize
2545% \begin{linenumbers*} 2681% \begin{linenumbers*}
2546% \bayt{qifA nabki min _dikr_A .habIbiN wa-manzili}{bi-saq.ti 2682% \bayt{qifA nabki min _dikr_A .habIbiN wa-manzili}{bi-siq.ti
2547% 'l-liw_A bayna \uc{'l-d}a_hUli fa-\uc{.h}awmali}\\ 2683% 'l-liw_A bayna \uc{'l-d}a_hUli fa-\uc{.h}awmali}\\
2548% \bayt{fa-\uc{t}U.di.ha fa-'l-\uc{m}iqrATi lam ya`fu 2684% \bayt{fa-\uc{t}U.di.ha fa-'l-\uc{m}iqrATi lam ya`fu
2549% rasmu-hA}{limA nasa^gat-hA min ^ganUbiN wa-^sam'ali}\\ 2685% rasmu-hA}{limA nasa^gat-hA min ^ganUbiN wa-^sam'ali}\\
@@ -2576,7 +2712,7 @@
2576% 2712%
2577% \paragraph{Brackets} 2713% \paragraph{Brackets}
2578% \phantomsection 2714% \phantomsection
2579% \NEWfeature{v1.4.3} The various bracket symbols are useful in 2715% \newfeature[v1.4.3] The various bracket symbols are useful in
2580% technical documents such as critical editions for indicating that 2716% technical documents such as critical editions for indicating that
2581% some words or some letters must be added or 2717% some words or some letters must be added or
2582% removed. \package{arabluatex} will automatically fit those symbols 2718% removed. \package{arabluatex} will automatically fit those symbols
@@ -2614,18 +2750,18 @@
2614% \arb[trans]{\uc{qur'An}} or in classical poetry. 2750% \arb[trans]{\uc{qur'An}} or in classical poetry.
2615% 2751%
2616% \DescribeMacro{\arbmark} 2752% \DescribeMacro{\arbmark}
2617% \NEWfeature{v1.11}\cs{arbmark}\oarg{rl\textbar{}lr}\marg{shorthand} 2753% \newfeature[v1.11]\cs{arbmark}\oarg{rl\textbar{}lr}\marg{shorthand}
2618% can be used to insert such characters either in Unicode or in 2754% can be used to insert such characters either in Unicode or in
2619% romanized Arabic environments. It takes as argument a shorthand 2755% romanized Arabic environments. It takes as argument a shorthand
2620% defined beforehand in a default list which consists of the following 2756% defined beforehand in a default list which consists of the following
2621% at the time of writing:---\\ 2757% at the time of writing:---
2758%
2622% \begin{longtable}{llp{.3\linewidth}p{.3\linewidth}} 2759% \begin{longtable}{llp{.3\linewidth}p{.3\linewidth}}
2623% \bottomrule 2760% \bottomrule
2624% \caption*{\Cref*{tab:arabtex-additional-marks}: Additional Arabic 2761% \caption[]{Additional Arabic marks}
2625% marks}
2626% \endfoot 2762% \endfoot
2627% \captionlistentry{Additional Arabic marks}\\[-1em]
2628% \toprule 2763% \toprule
2764% \captionlistentry{Additional Arabic marks}
2629% Codepoint & Shorthand & Glyph & Transliteration \\ \midrule 2765% Codepoint & Shorthand & Glyph & Transliteration \\ \midrule
2630% \endfirsthead 2766% \endfirsthead
2631% \toprule 2767% \toprule
@@ -2638,12 +2774,12 @@
2638% |FDFB| & |jalla| & \arb{\arbmark{jalla}} & \arbmark{jalla} \\ 2774% |FDFB| & |jalla| & \arb{\arbmark{jalla}} & \arbmark{jalla} \\
2639% \end{longtable} 2775% \end{longtable}
2640% 2776%
2641% \NEWfeature{v1.13} 2777% \newfeature[v1.13]
2642% The mark to be inserted is determined by contextual analysis, or by 2778% The mark to be inserted is determined by contextual analysis, or by
2643% an optional argument, either |rl| to have the Arabic glyph printed, 2779% an optional argument, either |rl| to have the Arabic glyph printed,
2644% or |lr| to print the tranliterated equivalent. 2780% or |lr| to print the tranliterated equivalent.
2645% 2781%
2646% \DescribeMacro{\newarbmark} \NEWfeature{v1.11} \cs{newarbmark} is 2782% \DescribeMacro{\newarbmark} \newfeature[v1.11] \cs{newarbmark} is
2647% also provided should one wish to define new marks in addition to the 2783% also provided should one wish to define new marks in addition to the
2648% marks defined above. This command takes three arguments, like so:--- 2784% marks defined above. This command takes three arguments, like so:---
2649% \arabluabox{\cs{newarbmark}\marg{shorthand}\marg{RTL 2785% \arabluabox{\cs{newarbmark}\marg{shorthand}\marg{RTL
@@ -2711,7 +2847,7 @@
2711% character (\texttt{U+200D})}% 2847% character (\texttt{U+200D})}%
2712% {The ‘Zero width joiner’ character (\texttt{U+200D})}} 2848% {The ‘Zero width joiner’ character (\texttt{U+200D})}}
2713% \phantomsection% 2849% \phantomsection%
2714% \NEWfeature{v1.18}% 2850% \newfeature[v1.18]%
2715% The \enquote*{Zero width joiner} character (|U+200D|) belongs to the 2851% The \enquote*{Zero width joiner} character (|U+200D|) belongs to the
2716% \enquote*{General Punctuation} block (range |2000|--|206F|) of the 2852% \enquote*{General Punctuation} block (range |2000|--|206F|) of the
2717% Unicode standard. It is a non-printing character which, when it is 2853% Unicode standard. It is a non-printing character which, when it is
@@ -2753,7 +2889,7 @@
2753% new Arabic modes will be available as \package{arabluatex} will 2889% new Arabic modes will be available as \package{arabluatex} will
2754% mature. 2890% mature.
2755% 2891%
2756% \DescribeMacro{\ayah}\NEWfeature{v1.15}For the time being, 2892% \DescribeMacro{\ayah}\newfeature[v1.15]For the time being,
2757% \cs{ayah}\marg{3-digit number} is provided so as to typeset the 2893% \cs{ayah}\marg{3-digit number} is provided so as to typeset the
2758% number of the \arb[trans]{'AyaT} that it is referred to inside the 2894% number of the \arb[trans]{'AyaT} that it is referred to inside the
2759% dedicated mark---Unicode |U+06DD|: \txarb{^^^^06dd}---in Arabic 2895% dedicated mark---Unicode |U+06DD|: \txarb{^^^^06dd}---in Arabic
@@ -2809,7 +2945,7 @@
2809% 2945%
2810% \section{Color} 2946% \section{Color}
2811% \label{sec:color} 2947% \label{sec:color}
2812% \NEWfeature{v1.12}\package{arabluatex} is able to render in color 2948% \newfeature[v1.12]\package{arabluatex} is able to render in color
2813% either words, parts of words or diacritics. As the techniques 2949% either words, parts of words or diacritics. As the techniques
2814% implemented in this section may lead to some complexity, the reader 2950% implemented in this section may lead to some complexity, the reader
2815% should first become well acquainted with the following 2951% should first become well acquainted with the following
@@ -2860,6 +2996,7 @@
2860% shape of the letters while coloring them:--- 2996% shape of the letters while coloring them:---
2861% \begin{quote}\textbf{\enquote*{voc} mode}:\\ 2997% \begin{quote}\textbf{\enquote*{voc} mode}:\\
2862% |i^stara\arbcolor[brown]{y}tu-hu| |bi-_tama\arbcolor[red]{niN}| 2998% |i^stara\arbcolor[brown]{y}tu-hu| |bi-_tama\arbcolor[red]{niN}|
2999% \\
2863% |'a`\arbcolor[blue]{^ga}ba-ka| 3000% |'a`\arbcolor[blue]{^ga}ba-ka|
2864% \arb{i^stara\arbcolor[brown]{y}tu-hu bi-_tama\arbcolor[red]{niN} 3001% \arb{i^stara\arbcolor[brown]{y}tu-hu bi-_tama\arbcolor[red]{niN}
2865% 'a`\arbcolor[blue]{^ga}ba-ka} 3002% 'a`\arbcolor[blue]{^ga}ba-ka}
@@ -2868,6 +3005,7 @@
2868% \end{quote} 3005% \end{quote}
2869% \begin{quote}\textbf{\enquote*{fullvoc} mode}:\\ 3006% \begin{quote}\textbf{\enquote*{fullvoc} mode}:\\
2870% |i^stara\arbcolor[brown]{y}tu-hu| |bi-_tama\arbcolor[red]{niN}| 3007% |i^stara\arbcolor[brown]{y}tu-hu| |bi-_tama\arbcolor[red]{niN}|
3008% \\
2871% |'a`\arbcolor[blue]{^ga}ba-ka| 3009% |'a`\arbcolor[blue]{^ga}ba-ka|
2872% \arb[fullvoc]{i^stara\arbcolor[brown]{y}tu-hu 3010% \arb[fullvoc]{i^stara\arbcolor[brown]{y}tu-hu
2873% bi-_tama\arbcolor[red]{niN} 'a`\arbcolor[blue]{^ga}ba-ka} 3011% bi-_tama\arbcolor[red]{niN} 'a`\arbcolor[blue]{^ga}ba-ka}
@@ -2890,31 +3028,27 @@
2890% applying colors to bare diacritics requires them to have specific 3028% applying colors to bare diacritics requires them to have specific
2891% encodings. 3029% encodings.
2892% 3030%
2893% \Cref{tab:arbcolor-diacritics} gives the Arab\TeX\ equivalents for 3031% \Vref{tab:arbcolor-diacritics} gives the Arab\TeX\ equivalents for
2894% the diacritics to be printed inside or just after \cs{arbcolor}. 3032% the diacritics to be printed inside or just after \cs{arbcolor}.
2895% 3033%
2896% \needspace{7\baselineskip}
2897% \begin{longtable}{lllll} 3034% \begin{longtable}{lllll}
2898% \bottomrule 3035% \bottomrule
2899% \caption*{\Cref*{tab:arbcolor-diacritics}: Arab\TeX\ diacritics 3036% \caption[]{Arab\TeX\ diacritics for \cs{arbcolor}}
2900% for \cs{arbcolor}}
2901% \endfoot 3037% \endfoot
2902% \captionlistentry{Arab\TeX\ diacritics for \cs{arbcolor}}\\[-1em]
2903% \toprule 3038% \toprule
3039% \captionlistentry{Arab\TeX\ diacritics for \cs{arbcolor}}
2904% Diacritic & \multicolumn{3}{l}{Transliteration\footnotemark} 3040% Diacritic & \multicolumn{3}{l}{Transliteration\footnotemark}
2905% & Arab\TeX\ notation \\ 3041% & Arab\TeX\ notation \\
2906% & \texttt{dmg} & \texttt{loc} & \texttt{arabica} & \\ \midrule 3042% & \texttt{dmg+} & \texttt{loc} & \texttt{arabica} & \\ \midrule
2907% \endfirsthead 3043% \endfirsthead
2908% \toprule 3044% \toprule
2909% Diacritic & \multicolumn{3}{l}{Transliteration} 3045% Diacritic & \multicolumn{3}{l}{Transliteration}
2910% & Arab\TeX\ notation \\ 3046% & Arab\TeX\ notation \\
2911% & \texttt{dmg} & \texttt{loc} & \texttt{arabica} & \\ \midrule 3047% & \texttt{dmg+} & \texttt{loc} & \texttt{arabica} & \\ \midrule
2912% \endhead \footnotetext{See below \vref{sec:transliteration}.} 3048% \endhead \footnotetext{See below \vref{sec:transliteration}.}
2913% \label{tab:arbcolor-diacritics} 3049% \label{tab:arbcolor-diacritics}
2914% \arb{B.a} & \dmg{.a} & \loc{.a} & \brill{.a} & \verb|.a| \\ 3050% \arb{B.a} & \dmg{.a} & \loc{.a} & \brill{.a} & \verb|.a| \\
2915% \pagebreak[1]
2916% \arb{B.u} & \dmg{.u} & \loc{.u} & \brill{.u} & \verb|.u| \\ 3051% \arb{B.u} & \dmg{.u} & \loc{.u} & \brill{.u} & \verb|.u| \\
2917% \pagebreak[1]
2918% \arb{B.i} & \dmg{.i} & \loc{.i} & \brill{.i} & \verb|.i| \\ \midrule 3052% \arb{B.i} & \dmg{.i} & \loc{.i} & \brill{.i} & \verb|.i| \\ \midrule
2919% \arb{Bo} & \dmg{o} & \loc{o} & \brill{o} & \verb|o| \\ 3053% \arb{Bo} & \dmg{o} & \loc{o} & \brill{o} & \verb|o| \\
2920% \end{longtable} 3054% \end{longtable}
@@ -2938,7 +3072,7 @@
2938% 'a`\arbcolor[red]{^g}.aba-ka}. 3072% 'a`\arbcolor[red]{^g}.aba-ka}.
2939% 3073%
2940% |i^staraytu-hu| |bi-_tama\arbcolor[red]{n}\arbcolor[blue]{iN}| 3074% |i^staraytu-hu| |bi-_tama\arbcolor[red]{n}\arbcolor[blue]{iN}|
2941% \allowbreak 3075% \\
2942% |'a`\arbcolor[red]|\allowbreak|{^g}\arbcolor[blue]{.a}ba-ka| 3076% |'a`\arbcolor[red]|\allowbreak|{^g}\arbcolor[blue]{.a}ba-ka|
2943% \arb{i^staraytu-hu bi-_tama\arbcolor[red]{n}\arbcolor[blue]{iN} 3077% \arb{i^staraytu-hu bi-_tama\arbcolor[red]{n}\arbcolor[blue]{iN}
2944% 'a`\arbcolor[red]{^g}\arbcolor[blue]{.a}ba-ka} \linebreak 3078% 'a`\arbcolor[red]{^g}\arbcolor[blue]{.a}ba-ka} \linebreak
@@ -2949,14 +3083,15 @@
2949% 3083%
2950% \begin{quote}\textbf{\enquote*{fullvoc} mode}:\\ 3084% \begin{quote}\textbf{\enquote*{fullvoc} mode}:\\
2951% |i^staray"\arbcolor[red]{o}tu-hu| |bi-_taman"\arbcolor[red]{iN}| 3085% |i^staray"\arbcolor[red]{o}tu-hu| |bi-_taman"\arbcolor[red]{iN}|
3086% \\
2952% |'a`^g"\arbcolor[red]{.a}ba-ka| 3087% |'a`^g"\arbcolor[red]{.a}ba-ka|
2953% \arb[fullvoc]{i^staray"\arbcolor[red]{o}tu-hu 3088% \arb[fullvoc]{i^staray"\arbcolor[red]{o}tu-hu
2954% bi-_taman"\arbcolor[red]{iN} 'a`^g"\arbcolor[red]{.a}ba-ka} 3089% bi-_taman"\arbcolor[red]{iN} 'a`^g"\arbcolor[red]{.a}ba-ka}
2955% \arb[trans]{i^staray"\arbcolor[red]{o}tu-hu 3090% \arb[trans]{i^staray"\arbcolor[red]{o}tu-hu
2956% bi-_taman"\arbcolor[red]{iN} 3091% bi-_taman"\arbcolor[red]{iN} 'a`^g"\arbcolor[red]{.a}ba-ka}.
2957% \linebreak 'a`^g"\arbcolor[red]{.a}ba-ka}.
2958% 3092%
2959% |i^stara\arbcolor[red]{y"}otu-hu| |bi-_tama\arbcolor[red]{n"}iN| 3093% |i^stara\arbcolor[red]{y"}otu-hu| |bi-_tama\arbcolor[red]{n"}iN|
3094% \\
2960% |'a`\arbcolor[red]|\allowbreak|{^g"}.aba-ka| 3095% |'a`\arbcolor[red]|\allowbreak|{^g"}.aba-ka|
2961% \arb[fullvoc]{i^stara\arbcolor[red]{y"}otu-hu 3096% \arb[fullvoc]{i^stara\arbcolor[red]{y"}otu-hu
2962% bi-_tama\arbcolor[red]{n"}iN 'a`\arbcolor[red]{^g"}.aba-ka} 3097% bi-_tama\arbcolor[red]{n"}iN 'a`\arbcolor[red]{^g"}.aba-ka}
@@ -2964,8 +3099,9 @@
2964% bi-_tama\arbcolor[red]{n"}iN 'a`\arbcolor[red]{^g"}.aba-ka}. 3099% bi-_tama\arbcolor[red]{n"}iN 'a`\arbcolor[red]{^g"}.aba-ka}.
2965% 3100%
2966% |i^stara\arbcolor[red]{y"}\arbcolor[blue]{o}tu-hu| 3101% |i^stara\arbcolor[red]{y"}\arbcolor[blue]{o}tu-hu|
3102% \\
2967% |bi-_tama\arb|\allowbreak|color[red]{n"}\arbcolor[blue]{iN}| 3103% |bi-_tama\arb|\allowbreak|color[red]{n"}\arbcolor[blue]{iN}|
2968% |'a`\arbcolor[red]|\allowbreak|{^g"}\arb|\allowbreak% 3104% |'a`\arbcolor[red]|\\|{^g"}\arb|
2969% |color[blue]{.a}ba-ka| 3105% |color[blue]{.a}ba-ka|
2970% \arb[fullvoc]{i^stara\arbcolor[red]{y"}\arbcolor[blue]{o}tu-hu 3106% \arb[fullvoc]{i^stara\arbcolor[red]{y"}\arbcolor[blue]{o}tu-hu
2971% bi-_tama\arbcolor[red]{n"}\arbcolor[blue]{iN} 3107% bi-_tama\arbcolor[red]{n"}\arbcolor[blue]{iN}
@@ -2997,8 +3133,8 @@
2997% \arb{^gAmi`aT|\arbcolor[red]{\arbnull{T}aN}} 3133% \arb{^gAmi`aT|\arbcolor[red]{\arbnull{T}aN}}
2998% \arb[trans]{^gAmi`aT|\arbcolor[red]{\arbnull{T}aN}}. 3134% \arb[trans]{^gAmi`aT|\arbcolor[red]{\arbnull{T}aN}}.
2999% \end{quote} 3135% \end{quote}
3000% \begin{quoting} 3136% \begin{remarks}
3001% \textsc{Rem.} Note that in the last example 3137% \item[\textsc{Rem.}] Note that in the last example
3002% (\arb[trans]{^gAmi`aT|\arbcolor[red]{\arbnull{T}aN}}), the 3138% (\arb[trans]{^gAmi`aT|\arbcolor[red]{\arbnull{T}aN}}), the
3003% \enquote*{pipe} character has been inserted before 3139% \enquote*{pipe} character has been inserted before
3004% \cs{arbcolor}. Otherwise, the |dmg| mode of the transliteration 3140% \cs{arbcolor}. Otherwise, the |dmg| mode of the transliteration
@@ -3007,7 +3143,7 @@
3007% \txtrans{t}).\footnote{See also \vpageref{ref:ta-marbutah-pipe} 3143% \txtrans{t}).\footnote{See also \vpageref{ref:ta-marbutah-pipe}
3008% \enquote{Discarding the \arb[trans]{'i`rAb}} for more 3144% \enquote{Discarding the \arb[trans]{'i`rAb}} for more
3009% information.} 3145% information.}
3010% \end{quoting} 3146% \end{remarks}
3011% 3147%
3012% The \arb[trans]{tanwIn} preceding a \arb[novoc]{_A} conveys even 3148% The \arb[trans]{tanwIn} preceding a \arb[novoc]{_A} conveys even
3013% more intricate business to the rendering with the utmost accuracy in 3149% more intricate business to the rendering with the utmost accuracy in
@@ -3037,9 +3173,8 @@
3037% the knowledge of the writer, the \arb[trans]{wa.slaT} alone is not 3173% the knowledge of the writer, the \arb[trans]{wa.slaT} alone is not
3038% part of the Arabic Unicode block.}. 3174% part of the Arabic Unicode block.}.
3039% 3175%
3040% |fI| |"al".i-\arbcolor[red]{\arbnull{'l-}i}btidA'i| 3176% |fI| |"al".i-\arbcolor[red]{\arbnull{'l-}i}btidA'i|\\
3041% \arb[fullvoc]{fI "al".i-\arbcolor[red]{\arbnull{'l-}i}btidA'i} 3177% \arb[fullvoc]{fI "al".i-\arbcolor[red]{\arbnull{'l-}i}btidA'i}
3042% \linebreak
3043% \arb[trans]{fI "al".i-\arbcolor[red]{\arbnull{'l-}i}btidA'i}. 3178% \arb[trans]{fI "al".i-\arbcolor[red]{\arbnull{'l-}i}btidA'i}.
3044% 3179%
3045% |\arbcolor[red]{'a'\arbnull{k}}kulu| 3180% |\arbcolor[red]{'a'\arbnull{k}}kulu|
@@ -3065,10 +3200,10 @@
3065%</example> 3200%</example>
3066% \fi% 3201% \fi%
3067% 3202%
3068% \begin{quoting} 3203% \begin{remarks}
3069% \textsc{Rem.} In the preceding example, any consonant could have 3204% \item[\textsc{Rem.}] In the preceding example, any consonant could
3070% been passed as argument to the \cs{arbnull} command. 3205% have been passed as argument to the \cs{arbnull} command.
3071% \end{quoting} 3206% \end{remarks}
3072% 3207%
3073% \paragraph{\texorpdfstring{\arb[trans]{^sad\-daT}}{šaddah}} 3208% \paragraph{\texorpdfstring{\arb[trans]{^sad\-daT}}{šaddah}}
3074% In the following example, it is assumed that the 3209% In the following example, it is assumed that the
@@ -3122,18 +3257,19 @@
3122% \paragraph{\texorpdfstring{\arb[trans]{hamzaT}}{hamzah}} 3257% \paragraph{\texorpdfstring{\arb[trans]{hamzaT}}{hamzah}}
3123% The \enquote*{quoting} technique provides an easy way to determine 3258% The \enquote*{quoting} technique provides an easy way to determine
3124% the carrier of the \arb[trans]{hamzaT}, as shown in 3259% the carrier of the \arb[trans]{hamzaT}, as shown in
3125% \vref{tab:quoted-hamza}---: 3260% \vref{tab:quoted-hamza}:---
3126% \begin{quote} 3261% \begin{quote}
3127% \verb+yatasA\arbnull{'a}\arbcolor[red]{|"'}.alUna+ 3262% \verb+yatasA\arbnull{'a}\arbcolor[red]{|"'}.alUna+
3128% \arb{yatasA\arbnull{'a}\arbcolor[red]{|"'}.alUna} 3263% \arb{yatasA\arbnull{'a}\arbcolor[red]{|"'}.alUna}
3129% \arb[trans]{yatasA\arbnull{'a}\-\arbcolor[red]{|"'}.a\-lUna}, 3264% \arb[trans]{yatasA\arbnull{'a}\-\arbcolor[red]{|"'}.a\-lUna},
3265% \\
3130% \verb+^say\arbcolor[red]{|"'}\arbnull{'}aN+ 3266% \verb+^say\arbcolor[red]{|"'}\arbnull{'}aN+
3131% \arb{^say\arbcolor[red]{|"'}\arbnull{'}aN} 3267% \arb{^say\arbcolor[red]{|"'}\arbnull{'}aN}
3132% \arb[trans]{^say\arbcolor[red]{|"'}\arbnull{'}aN}, 3268% \arb[trans]{^say\arbcolor[red]{|"'}\arbnull{'}aN},
3133% \verb+^say\ar+\allowbreak\verb+bcolor[red]{|"'}iN+ 3269% \verb+^say\arbcolor[red]+\\\verb+{|"'}iN+
3134% \arb{^say\arbcolor[red]{|"'}iN} 3270% \arb{^say\arbcolor[red]{|"'}iN}
3135% \arb[trans]{^say\arbcolor[red]{|"'}iN}, 3271% \arb[trans]{^say\arbcolor[red]{|"'}iN},
3136% |\arbcolor[red]{a"'}.as\arbcolor|\allowbreak|[red]{y"'}.ilaTuN| 3272% |\arbcolor[red]{a"'}.as\arbcolor[red]{y"'}.ilaTuN|
3137% \arb{\arbcolor[red]{a"'}.as\arbcolor[red]{y"'}.ilaTuN} 3273% \arb{\arbcolor[red]{a"'}.as\arbcolor[red]{y"'}.ilaTuN}
3138% \arb[trans]{\arbcolor[red]{a"'}.as\arbcolor[red]{y"'}.ilaTuN}. 3274% \arb[trans]{\arbcolor[red]{a"'}.as\arbcolor[red]{y"'}.ilaTuN}.
3139% \end{quote} 3275% \end{quote}
@@ -3143,7 +3279,7 @@
3143% \label{sec:transliteration} 3279% \label{sec:transliteration}
3144% It may be more appropriate to speak of \enquote{romanization} than 3280% It may be more appropriate to speak of \enquote{romanization} than
3145% \enquote{transliteration} of Arabic. As seen above in 3281% \enquote{transliteration} of Arabic. As seen above in
3146% \cref{sec:options} \vpagerefrange{sec:options}{sec:local-options}, 3282% \vref{sec:options} \vpagerefrange{sec:options}{sec:local-options},
3147% the \enquote{transliteration mode} may be selected globally or locally. 3283% the \enquote{transliteration mode} may be selected globally or locally.
3148% 3284%
3149% This mode transliterates the Arab\TeX\ input into one of the 3285% This mode transliterates the Arab\TeX\ input into one of the
@@ -3154,6 +3290,9 @@
3154% adopted by the International Convention of Orientalist Scholars in 3290% adopted by the International Convention of Orientalist Scholars in
3155% Rome in 1935.\footnote{See \textcite{dmg}.} |dmg| transliteration 3291% Rome in 1935.\footnote{See \textcite{dmg}.} |dmg| transliteration
3156% convention is selected by default; 3292% convention is selected by default;
3293% \item[dmg+] This is the same as above, with the difference that the
3294% hamza is always printed, even in words preceded by the definite
3295% article, as in \arb[trans]{al-'asadu}.
3157% \item[loc] \emph{Library of Congress}: this standard is part of a 3296% \item[loc] \emph{Library of Congress}: this standard is part of a
3158% large set of standards for romanization of non-roman scripts 3297% large set of standards for romanization of non-roman scripts
3159% adopted by the American Library Association and the Library of 3298% adopted by the American Library Association and the Library of
@@ -3161,7 +3300,7 @@
3161% \url{http://www.loc.gov/catdir/cpso/roman.html} for the 3300% \url{http://www.loc.gov/catdir/cpso/roman.html} for the
3162% \href{http://www.loc.gov/catdir/cpso/romanization/arabic.pdf}{source 3301% \href{http://www.loc.gov/catdir/cpso/romanization/arabic.pdf}{source
3163% document concerning Arabic language}.} 3302% document concerning Arabic language}.}
3164% \item[arabica] \NEWfeature{v1.8} 3303% \item[arabica] \newfeature[v1.8]
3165% \changes{v1.8}{2017/03/30}{\texttt{arabica} transliteration 3304% \changes{v1.8}{2017/03/30}{\texttt{arabica} transliteration
3166% standard is now supported} \emph{Journal of Arabic and Islamic 3305% standard is now supported} \emph{Journal of Arabic and Islamic
3167% Studies}/\emph{Revue d'études arabes et islamiques}: this standard 3306% Studies}/\emph{Revue d'études arabes et islamiques}: this standard
@@ -3176,16 +3315,16 @@
3176% transliteration mode, which is set to |dmg| by default, may be 3315% transliteration mode, which is set to |dmg| by default, may be
3177% changed at any point of the document by the 3316% changed at any point of the document by the
3178% \cs{SetTranslitConvention}\marg{mode} command , where \meta{mode} 3317% \cs{SetTranslitConvention}\marg{mode} command , where \meta{mode}
3179% may be either |dmg|, |loc| or |arabica|. This command is also 3318% may be either |dmg|, |dmg+|, |loc| or |arabica|. This command is also
3180% accepted in the preamble should one wish to set the transliteration 3319% accepted in the preamble should one wish to set the transliteration
3181% mode globally, e.g.:---% 3320% mode globally, e.g.:---%
3182% \iffalse 3321% \iffalse
3183%<*example> 3322%<*example>
3184% \fi 3323% \fi
3185\begin{code} 3324\begin{alcode}
3186 \usepackage{arabluatex} 3325 \usepackage{arabluatex}
3187 \SetTranslitConvention{loc} 3326 \SetTranslitConvention{loc}
3188\end{code} 3327\end{alcode}
3189% \iffalse 3328% \iffalse
3190%</example> 3329%</example>
3191% \fi 3330% \fi
@@ -3197,7 +3336,7 @@
3197% command, where \meta{style} may be any font shape selection 3336% command, where \meta{style} may be any font shape selection
3198% command, e.g. \cs{upshape}, \cs{itshape}, \cs{slshape}, and so forth. 3337% command, e.g. \cs{upshape}, \cs{itshape}, \cs{slshape}, and so forth.
3199% 3338%
3200% \paragraph{Font} \NEWfeature{v1.4} \DescribeMacro{\SetTranslitFont} 3339% \paragraph{Font} \newfeature[v1.4] \DescribeMacro{\SetTranslitFont}
3201% \cs{SetTranslitFont}\marg{font selection command} allows any 3340% \cs{SetTranslitFont}\marg{font selection command} allows any
3202% specific font to be selected for rendering transliterated text with 3341% specific font to be selected for rendering transliterated text with
3203% the font-selecting commands of the \package{fontspec} or 3342% the font-selecting commands of the \package{fontspec} or
@@ -3207,10 +3346,10 @@
3207% \iffalse 3346% \iffalse
3208%<*example> 3347%<*example>
3209% \fi 3348% \fi
3210\begin{code} 3349\begin{alcode}
3211 \newfontfamily\translitfont{Gentium Plus}[Ligatures=TeX] 3350 \newfontfamily\translitfont{Gentium Plus}[Ligatures=TeX]
3212 \SetTranslitFont{\translitfont} 3351 \SetTranslitFont{\translitfont}
3213\end{code} 3352\end{alcode}
3214% \iffalse 3353% \iffalse
3215%</example> 3354%</example>
3216% \fi 3355% \fi
@@ -3269,7 +3408,7 @@
3269% 3408%
3270% \paragraph{\texorpdfstring{\enquote*{Long} pro\-per 3409% \paragraph{\texorpdfstring{\enquote*{Long} pro\-per
3271% names}{‘Long’ proper names}} 3410% names}{‘Long’ proper names}}
3272% \NEWfeature{v1.10} \cs{uc} is also able to process proper names 3411% \newfeature[v1.10] \cs{uc} is also able to process proper names
3273% consisting of several subsequent words:--- 3412% consisting of several subsequent words:---
3274% \begin{quote} 3413% \begin{quote}
3275% |\arb[trans]{\uc{'abU| |zaydiN| |.hunaynu| |bnu| |'is.h_aqa| 3414% |\arb[trans]{\uc{'abU| |zaydiN| |.hunaynu| |bnu| |'is.h_aqa|
@@ -3279,7 +3418,7 @@
3279% 3418%
3280% \paragraph{Proper names outside Arabic environments} 3419% \paragraph{Proper names outside Arabic environments}
3281% \changes{v1.10}{2018/01/03}{\cs{uc} supersedes \cs{cap}} 3420% \changes{v1.10}{2018/01/03}{\cs{uc} supersedes \cs{cap}}
3282% \DescribeMacro{\prname}\NEWfeature{v1.10} Transliterated proper 3421% \DescribeMacro{\prname}\newfeature[v1.10] Transliterated proper
3283% names inserted in paragraphs of English text should be printed in 3422% names inserted in paragraphs of English text should be printed in
3284% the same typeface as the surrounding text. \cs{prname}\marg{Arabic 3423% the same typeface as the surrounding text. \cs{prname}\marg{Arabic
3285% proper name} is provided to that effect:\footnote{Just as \cs{uc}, 3424% proper name} is provided to that effect:\footnote{Just as \cs{uc},
@@ -3323,18 +3462,19 @@
3323%</example> 3462%</example>
3324% \fi 3463% \fi
3325% 3464%
3326% \begin{quoting}\label{ref:prname-star} 3465% \begin{remarks}
3327% \textsc{Rem.} \DescribeMacro{\prname*} \package{arabluatex} also 3466% \item[\textsc{Rem.}] \label{ref:prname-star}
3328% provides \cs{prname*} which only renders in upright roman style 3467% \DescribeMacro{\prname*} \package{arabluatex} also provides
3329% already transliterated proper names without applying any further 3468% \cs{prname*} which only renders in upright roman style already
3469% transliterated proper names without applying any further
3330% processing. It is mostly used internally and applied to proper 3470% processing. It is mostly used internally and applied to proper
3331% names exported in Unicode to an external selected 3471% names exported in Unicode to an external selected
3332% file.\footnote{See below \vref{sec:arabtex2utf} for more details.} 3472% file.\footnote{See below \vref{sec:arabtex2utf} for more details.}
3333% \end{quoting} 3473% \end{remarks}
3334% 3474%
3335% \subsection{Additional note on \texttt{dmg} convention} 3475% \subsection{Additional note on \texttt{dmg} convention}
3336% \label{sec:additional-note-dmg} 3476% \label{sec:additional-note-dmg}
3337% \NEWfeature{v1.3} According to \textcite[6]{dmg}, Arabic 3477% \newfeature[v1.3] According to \textcite[6]{dmg}, Arabic
3338% \arb[trans]{'i`rAb} may be rendered into |dmg| in three different 3478% \arb[trans]{'i`rAb} may be rendered into |dmg| in three different
3339% ways: 3479% ways:
3340% \begin{enumerate} 3480% \begin{enumerate}
@@ -3401,29 +3541,29 @@
3401% \arb[voc]{al-.zulm-Atu} \arb[trans]{al-.zulm-Atu}. 3541% \arb[voc]{al-.zulm-Atu} \arb[trans]{al-.zulm-Atu}.
3402% \end{quote} 3542% \end{quote}
3403% 3543%
3404% \begin{quoting} 3544% \begin{remarks}
3405% \textsc{Rem.}~\emph{a.} As the \arb[trans]{tanwIn} is passed over 3545% \item As the \arb[trans]{tanwIn} is passed over in pronunciation
3406% in pronunciation when it is followed by the letters 3546% when it is followed by the letters \arb[novoc]{r}, \arb[novoc]{l},
3407% \arb[novoc]{r}, \arb[novoc]{l}, \arb[novoc]{m}, \arb[novoc]{w}, 3547% \arb[novoc]{m}, \arb[novoc]{w}, \arb[novoc]{y} (see
3408% \arb[novoc]{y} (see \vref{ref:assimilation}), it may be desirable 3548% \vref{ref:assimilation}), it may be desirable to further
3409% to further distinguish it by putting it above the line, but not to 3549% distinguish it by putting it above the line, but not to do the
3410% do the same for \arb[trans]{.gayr mun.sarif} terminations. This 3550% same for \arb[trans]{.gayr mun.sarif} terminations. This can be
3411% can be achieved by simply omitting the hyphen before any 3551% achieved by simply omitting the hyphen before any
3412% \arb[trans]{.gayr mun.sarif} termination:---\\ 3552% \arb[trans]{.gayr mun.sarif} termination:---\\
3413% |kAna| |.ganiyyaN| |l_akinna-hu| |labisa| |^gubbaTaN| |mumazzaqaN| 3553% |kAna| |.ganiyyaN| |l_akinna-hu| |labisa| |^gubbaTaN| |mumazzaqaN|
3414% |'aydu-hA| \arb[voc]{kAna .ganiyyaN l_akinna-hu labisa ^gubbaTaN 3554% |'aydu-hA| \arb[voc]{kAna .ganiyyaN l_akinna-hu labisa ^gubbaTaN
3415% mumazzaqaN 'aydu-hA} \arb[trans]{kAna .ganiyyaN l_akinna-hu labisa 3555% mumazzaqaN 'aydu-hA} \arb[trans]{kAna .ganiyyaN l_akinna-hu labisa
3416% ^gubbaTaN mumazzaqaN 'aydu-hA}. 3556% ^gubbaTaN mumazzaqaN 'aydu-hA}.
3417% 3557%
3418% \textsc{Rem.}~\emph{b.} Although the hyphen before the 3558% \item Although the hyphen before the \arb[trans]{tanwIn} is optional
3419% \arb[trans]{tanwIn} is optional as \package{arabluatex} always 3559% as \package{arabluatex} always parses nouns with such termination,
3420% parses nouns with such termination, it may also be used to mark 3560% it may also be used to mark
3421% better the inflectional endings:---\\ 3561% better the inflectional endings:---\\
3422% |mana`a| |'l-nAs-a| |kAffaT-aN| |min| |mu_hA.tabati-hi| 3562% |mana`a| |'l-nAs-a| |kAffaT-aN| |min| |mu_hA.tabati-hi|
3423% |'a.had-uN| |bi-sayyidi-nA| \arb[voc]{mana`a 'l-nAs-a kAffaT-aN 3563% |'a.had-uN| |bi-sayyidi-nA| \arb[voc]{mana`a 'l-nAs-a kAffaT-aN
3424% min mu_hA.tabati-hi 'a.had-uN bi-sayyidi-nA} \arb[trans]{mana`a 3564% min mu_hA.tabati-hi 'a.had-uN bi-sayyidi-nA} \arb[trans]{mana`a
3425% 'l-nAs-a kAffaT-aN min mu_hA.tabati-hi 'a.had-uN bi-sayyidi-nA}. 3565% 'l-nAs-a kAffaT-aN min mu_hA.tabati-hi 'a.had-uN bi-sayyidi-nA}.
3426% \end{quoting} 3566% \end{remarks}
3427% 3567%
3428% \paragraph{\texorpdfstring{Discar\-ding the 3568% \paragraph{\texorpdfstring{Discar\-ding the
3429% \arb[trans]{'i`rAb}}{Discarding the ʾiʿrāb}} 3569% \arb[trans]{'i`rAb}}{Discarding the ʾiʿrāb}}
@@ -3441,17 +3581,17 @@
3441% state): |.hikmaT| |al-l_ah| \arb[trans]{.hikmaT| \uc{al-l_ah}}, 3581% state): |.hikmaT| |al-l_ah| \arb[trans]{.hikmaT| \uc{al-l_ah}},
3442% |fi.d.daT| |al-darAhim| \arb[trans]{fi.d.daT al-darAhim}. 3582% |fi.d.daT| |al-darAhim| \arb[trans]{fi.d.daT al-darAhim}.
3443% \end{enumerate} 3583% \end{enumerate}
3444% \begin{quoting} 3584% \begin{remarks}
3445% \textsc{Rem.} It may so happen, as in the absence of the article 3585% \item[\textsc{Rem.}] It may so happen, as in the absence of the
3446% before the annexed word, that \package{arabluatex} be unable to 3586% article before the annexed word, that \package{arabluatex} be
3447% determine which of the above two cases the word ending with 3587% unable to determine which of the above two cases the word ending
3448% \arb[trans]{tA' marbU.taT} falls into. The \enquote*{pipe} 3588% with \arb[trans]{tA' marbU.taT} falls into. The \enquote*{pipe}
3449% character (see \vref{sec:pipe}) may be appended to that word to 3589% character (see \vref{sec:pipe}) may be appended to that word to
3450% indicate that what follows is in the construct state: 3590% indicate that what follows is in the construct state:
3451% |\uc{r}isAlaT| |fI| |tartIb| \verb+qirA'aT|+ |kutub| 3591% |\uc{r}isAlaT| |fI| |tartIb| \verb+qirA'aT|+ |kutub|
3452% |\uc{^g}AlInUs| \arb[trans]{\uc{r}isAlaT fI tartIb qirA'aT| 3592% |\uc{^g}AlInUs| \arb[trans]{\uc{r}isAlaT fI tartIb qirA'aT| kutub
3453% kutub \uc{^g}AlInUs}. 3593% \uc{^g}AlInUs}.
3454% \end{quoting} 3594% \end{remarks}
3455% 3595%
3456% 3596%
3457% \paragraph{Uncertain short vowels} 3597% \paragraph{Uncertain short vowels}
@@ -3468,9 +3608,9 @@
3468% \arb[trans]{\uc{ju.hA}} and his donkey (\arb[voc]{\uc{ju.hA 3608% \arb[trans]{\uc{ju.hA}} and his donkey (\arb[voc]{\uc{ju.hA
3469% wa-.himAru-hu}}). See the code \vpageref{ref:juha-code}:--- 3609% wa-.himAru-hu}}). See the code \vpageref{ref:juha-code}:---
3470% 3610%
3471% \SetTranslitConvention{dmg} 3611% \SetTranslitConvention{dmg+}
3472% \begin{arab}[trans] 3612% \begin{arab}[trans]
3473% \LR{\textbf{\emph{\enquote*{dmg}} standard:}} 'at_A .sadIquN 'il_A 3613% \LR{\textbf{\emph{\enquote*{dmg+}} standard:}} 'at_A .sadIquN 'il_A
3474% \uc{ju.hA} ya.tlubu min-hu .himAra-hu li-yarkaba-hu fI safraTiN 3614% \uc{ju.hA} ya.tlubu min-hu .himAra-hu li-yarkaba-hu fI safraTiN
3475% qa.sIraTiN fa-qAla la-hu: \enquote{sawfa 'u`Idu-hu 'ilay-ka fI 3615% qa.sIraTiN fa-qAla la-hu: \enquote{sawfa 'u`Idu-hu 'ilay-ka fI
3476% 'l-masA'-i wa-'adfa`u la-ka 'ujraTaN.} fa-qAla \uc{ju.hA}: 3616% 'l-masA'-i wa-'adfa`u la-ka 'ujraTaN.} fa-qAla \uc{ju.hA}:
@@ -3497,7 +3637,7 @@
3497% \enquote{.garIbuN 'amru-ka yA .sadIqI 'a-tu.saddiqu 'l-.himAr-a 3637% \enquote{.garIbuN 'amru-ka yA .sadIqI 'a-tu.saddiqu 'l-.himAr-a
3498% wa-tuka_d_diba-nI?} 3638% wa-tuka_d_diba-nI?}
3499% \end{arab} 3639% \end{arab}
3500% \SetTranslitConvention{dmg} 3640% \SetTranslitConvention{dmg+}
3501% 3641%
3502% \SetTranslitConvention{arabica} 3642% \SetTranslitConvention{arabica}
3503% \begin{arab}[trans] 3643% \begin{arab}[trans]
@@ -3513,11 +3653,11 @@
3513% \uc{ju.hA}: \enquote{.garIbuN 'amru-ka yA .sadIqI 'a-tu.saddiqu 3653% \uc{ju.hA}: \enquote{.garIbuN 'amru-ka yA .sadIqI 'a-tu.saddiqu
3514% 'l-.himAr-a wa-tuka_d_diba-nI?} 3654% 'l-.himAr-a wa-tuka_d_diba-nI?}
3515% \end{arab} 3655% \end{arab}
3516% \SetTranslitConvention{dmg} 3656% \SetTranslitConvention{dmg+}
3517% 3657%
3518% \section{Buckwalter input scheme} 3658% \section{Buckwalter input scheme}
3519% \label{sec:buckwalter-scheme} 3659% \label{sec:buckwalter-scheme}
3520% \NEWfeature{v1.4} Even though \package{arabluatex} is primarily 3660% \newfeature[v1.4] Even though \package{arabluatex} is primarily
3521% designed to process the Arab\TeX\ notation, it can also process the 3661% designed to process the Arab\TeX\ notation, it can also process the
3522% Buckwalter input scheme to a large extent.\footnote{See 3662% Buckwalter input scheme to a large extent.\footnote{See
3523% \url{http://www.qamus.org/transliteration.htm}} The Buckwalter 3663% \url{http://www.qamus.org/transliteration.htm}} The Buckwalter
@@ -3537,10 +3677,10 @@
3537% \iffalse 3677% \iffalse
3538%<*example> 3678%<*example>
3539% \fi 3679% \fi
3540\begin{code} 3680\begin{alcode}
3541 \usepackage{arabluatex} 3681 \usepackage{arabluatex}
3542 \SetInputScheme{buckwalter} 3682 \SetInputScheme{buckwalter}
3543\end{code} 3683\end{alcode}
3544% \iffalse 3684% \iffalse
3545%</example> 3685%</example>
3546% \fi 3686% \fi
@@ -3560,27 +3700,26 @@
3560% It is therefore recommended to use the Buckwalter \enquote*{safe} 3700% It is therefore recommended to use the Buckwalter \enquote*{safe}
3561% scheme. 3701% scheme.
3562% 3702%
3563% \Cref{tab:buckwalter-scheme} gives the Buckwalter equivalents that 3703% \Vref{tab:buckwalter-scheme} gives the Buckwalter equivalents that
3564% are currently used by \package{arabluatex}. The additional 3704% are currently used by \package{arabluatex}. The additional
3565% characters that are defined in \vref{tab:additional-arabic-codings} 3705% characters that are defined in \vref{tab:additional-arabic-codings}
3566% are also available. 3706% are also available.
3567% 3707%
3568% \enlargethispage{\baselineskip}
3569% \begin{longtable}{llllll} 3708% \begin{longtable}{llllll}
3570% \bottomrule 3709% \bottomrule
3571% \caption*{\Cref*{tab:buckwalter-scheme}: Buckwalter scheme} 3710% \caption[]{Buckwalter input scheme}
3572% \endfoot 3711% \endfoot
3573% \captionlistentry{Buckwalter scheme}\\[-1em]
3574% \toprule 3712% \toprule
3713% \captionlistentry{Buckwalter input scheme}
3575% Letter & \multicolumn{3}{l}{Transliteration\footnotemark} 3714% Letter & \multicolumn{3}{l}{Transliteration\footnotemark}
3576% & \multicolumn{2}{l}{Buckwalter notation} \\ 3715% & \multicolumn{2}{l}{Buckwalter notation} \\
3577% & \texttt{dmg} & \texttt{loc} & \texttt{arabica} & |base/xml| & 3716% & \texttt{dmg+} & \texttt{loc} & \texttt{arabica} & |base/xml| &
3578% |safe| \\ \midrule 3717% |safe| \\ \midrule
3579% \endfirsthead 3718% \endfirsthead
3580% \toprule 3719% \toprule
3581% Letter & \multicolumn{3}{l}{Transliteration} 3720% Letter & \multicolumn{3}{l}{Transliteration}
3582% & \multicolumn{2}{l}{Buckwalter notation} \\ 3721% & \multicolumn{2}{l}{Buckwalter notation} \\
3583% & \texttt{dmg} & \texttt{loc} & \texttt{arabica} & |base/xml| & 3722% & \texttt{dmg+} & \texttt{loc} & \texttt{arabica} & |base/xml| &
3584% |safe| \\ \midrule 3723% |safe| \\ \midrule
3585% \endhead \footnotetext{See \vref{sec:transliteration}.} 3724% \endhead \footnotetext{See \vref{sec:transliteration}.}
3586% \label{tab:buckwalter-scheme} 3725% \label{tab:buckwalter-scheme}
@@ -3602,7 +3741,6 @@
3602% \arb[novoc]{.t} & \dmg{.t} & \loc{.t} & \brill{.t} & |T| & |T| \\ 3741% \arb[novoc]{.t} & \dmg{.t} & \loc{.t} & \brill{.t} & |T| & |T| \\
3603% \arb[novoc]{.z} & \dmg{.z} & \loc{.z} & \brill{.z} & |Z| & |Z| \\ 3742% \arb[novoc]{.z} & \dmg{.z} & \loc{.z} & \brill{.z} & |Z| & |Z| \\
3604% \arb[novoc]{`} & \dmg{`} & \loc{`} & \brill{`} & |E| & |E| \\ 3743% \arb[novoc]{`} & \dmg{`} & \loc{`} & \brill{`} & |E| & |E| \\
3605% \pagebreak[2]
3606% \arb[novoc]{.g} & \dmg{.g} & \loc{.g} & \brill{.g} & |g| & |g| \\ 3744% \arb[novoc]{.g} & \dmg{.g} & \loc{.g} & \brill{.g} & |g| & |g| \\
3607% \arb[novoc]{f} & \dmg{f} & \loc{f} & \brill{f} & |f| & |f| \\ 3745% \arb[novoc]{f} & \dmg{f} & \loc{f} & \brill{f} & |f| & |f| \\
3608% \arb[novoc]{q} & \dmg{q} & \loc{q} & \brill{q} & |q| & |q| \\ 3746% \arb[novoc]{q} & \dmg{q} & \loc{q} & \brill{q} & |q| & |q| \\
@@ -3677,7 +3815,7 @@
3677% 3815%
3678% \section{Unicode Arabic input} 3816% \section{Unicode Arabic input}
3679% \label{sec:unicode-input} 3817% \label{sec:unicode-input}
3680% \NEWfeature{v1.5} As said above in \vref{sec:buckwalter-scheme} 3818% \newfeature[v1.5] As said above in \vref{sec:buckwalter-scheme}
3681% about the Buckwalter input scheme, even though \package{arabluatex} 3819% about the Buckwalter input scheme, even though \package{arabluatex}
3682% is primarily designed to process the Arab\TeX\ notation, it also 3820% is primarily designed to process the Arab\TeX\ notation, it also
3683% accepts Unicode Arabic input. It should be noted that 3821% accepts Unicode Arabic input. It should be noted that
@@ -3695,17 +3833,16 @@
3695% \iffalse 3833% \iffalse
3696%<*example> 3834%<*example>
3697% \fi 3835% \fi
3698\begin{code} 3836\begin{alcode}
3699 \begin{txarab} 3837 \begin{txarab}
3700 <Unicode Arabic text> 3838 <Unicode Arabic text>
3701 \end{txarab} 3839 \end{txarab}
3702\end{code} 3840\end{alcode}
3703% \iffalse 3841% \iffalse
3704%</example> 3842%</example>
3705% \fi 3843% \fi
3706% \end{enumerate} 3844% \end{enumerate}
3707% 3845%
3708% \needspace{4\baselineskip}
3709% \section{\LaTeX\ Commands in Arabic environments} 3846% \section{\LaTeX\ Commands in Arabic environments}
3710% \label{sec:commands-in-arb} 3847% \label{sec:commands-in-arb}
3711% \paragraph{General principle} \label{ref:cmd-inside-arabic}\LaTeX\ 3848% \paragraph{General principle} \label{ref:cmd-inside-arabic}\LaTeX\
@@ -3799,6 +3936,7 @@
3799% for that, but should it happen, it may be necessary to redefine in 3936% for that, but should it happen, it may be necessary to redefine in
3800% the preamble the \LaTeX\ macro \cs{thefootnote} like so:---\\ 3937% the preamble the \LaTeX\ macro \cs{thefootnote} like so:---\\
3801% \tcboxverb{\renewcommand*{\thefootnote}{\textsuperscript{\LR{\arabic{footnote}}}}} 3938% \tcboxverb{\renewcommand*{\thefootnote}{\textsuperscript{\LR{\arabic{footnote}}}}}
3939%
3802% \DescribeMacro{\FixArbFtnmk} Another solution is to put in the 3940% \DescribeMacro{\FixArbFtnmk} Another solution is to put in the
3803% preamble, below the line that loads \package{arabluatex}, the 3941% preamble, below the line that loads \package{arabluatex}, the
3804% \cs{FixArbFtnmk} command. However, for more control over the layout 3942% \cs{FixArbFtnmk} command. However, for more control over the layout
@@ -3837,7 +3975,7 @@
3837% 3975%
3838% \subsection{New commands} 3976% \subsection{New commands}
3839% \label{sec:declare-new-commands} 3977% \label{sec:declare-new-commands}
3840% \NEWfeature{v1.9}% 3978% \newfeature[v1.9]%
3841% In some particular cases, it may be useful to define new commands to 3979% In some particular cases, it may be useful to define new commands to
3842% be inserted in Arabic environments. From the general principle laid 3980% be inserted in Arabic environments. From the general principle laid
3843% \vpageref{ref:cmd-inside-arabic}, it follows that any command that 3981% \vpageref{ref:cmd-inside-arabic}, it follows that any command that
@@ -3883,7 +4021,7 @@
3883% of commands declared with \cs{MkArbBreak} are not to be processed by 4021% of commands declared with \cs{MkArbBreak} are not to be processed by
3884% \package{arabluatex}. Therefore, as in the previous example, any of 4022% \package{arabluatex}. Therefore, as in the previous example, any of
3885% their argument to be rendered in Arabic must be inserted again in 4023% their argument to be rendered in Arabic must be inserted again in
3886% \cs{arb}. \NEWfeature{v1.12}These commands themselves may have up to 4024% \cs{arb}. \newfeature[v1.12]These commands themselves may have up to
3887% two optional and/or mandatory arguments followed by one optional 4025% two optional and/or mandatory arguments followed by one optional
3888% argument, like so:--- 4026% argument, like so:---
3889% \begin{enumerate} 4027% \begin{enumerate}
@@ -3899,7 +4037,7 @@
3899% (uppermost combination) 4037% (uppermost combination)
3900% \end{enumerate} 4038% \end{enumerate}
3901% 4039%
3902% \DescribeMacro{\MkArbBreak*}\NEWfeature{v1.12} As said above, 4040% \DescribeMacro{\MkArbBreak*}\newfeature[v1.12] As said above,
3903% \cs{MkArbBreak} prevents \package{arabluatex} from processing the 4041% \cs{MkArbBreak} prevents \package{arabluatex} from processing the
3904% arguments of \enquote*{declared} commands as Arabic text. This 4042% arguments of \enquote*{declared} commands as Arabic text. This
3905% technique proves sufficient in most cases. However, a 4043% technique proves sufficient in most cases. However, a
@@ -3926,20 +4064,20 @@
3926% \label{sec:environments} 4064% \label{sec:environments}
3927% \changes{v1.5}{2016/11/14}{Environments may be nested inside the 4065% \changes{v1.5}{2016/11/14}{Environments may be nested inside the
3928% \texttt{arab} environment} 4066% \texttt{arab} environment}
3929% \NEWfeature{v1.5} Environments such as 4067% \newfeature[v1.5] Environments such as
3930% \tcboxverb{\begin{quote} ... \end{quote}} may be nested inside the 4068% \tcboxverb{\begin{quote} ... \end{quote}} may be nested inside the
3931% |arab| environment. Up to one optional argument may be passed to 4069% |arab| environment. Up to one optional argument may be passed to
3932% each nested environment, like so:--- 4070% each nested environment, like so:---
3933% \iffalse 4071% \iffalse
3934%<*example> 4072%<*example>
3935% \fi 4073% \fi
3936\begin{code} 4074\begin{alcode}
3937 \begin{arab} 4075 \begin{arab}
3938 \begin{<environment>}[<options>] 4076 \begin{<environment>}[<options>]
3939 <Arabic text> 4077 <Arabic text>
3940 \end{<environment>} 4078 \end{<environment>}
3941 \end{arab} 4079 \end{arab}
3942\end{code} 4080\end{alcode}
3943% \iffalse 4081% \iffalse
3944%</example> 4082%</example>
3945% \fi 4083% \fi
@@ -4036,13 +4174,13 @@
4036% \iffalse 4174% \iffalse
4037%<*example> 4175%<*example>
4038% \fi 4176% \fi
4039\begin{code} 4177\begin{alcode}
4040 % preamble:--- 4178 % preamble:---
4041 \usepackage{enumitem} 4179 \usepackage{enumitem}
4042 \newlist{enumabjad}{enumerate}{10} 4180 \newlist{enumabjad}{enumerate}{10}
4043 \setlist[enumabjad]{nosep, label={\abjad{\arabic*}}} 4181 \setlist[enumabjad]{nosep, label={\abjad{\arabic*}}}
4044 \usepackage{multicol} 4182 \usepackage{multicol}
4045\end{code} 4183\end{alcode}
4046\begin{example} 4184\begin{example}
4047 From \textcite[i. 29 B--C]{Wright}:--- The derived forms of the 4185 From \textcite[i. 29 B--C]{Wright}:--- The derived forms of the
4048 triliteral verb are usually reckoned fifteen in number, but the 4186 triliteral verb are usually reckoned fifteen in number, but the
@@ -4085,10 +4223,10 @@
4085% \iffalse 4223% \iffalse
4086%<*example> 4224%<*example>
4087% \fi 4225% \fi
4088\begin{code} 4226\begin{alcode}
4089 \usepackage[french]{babel} 4227 \usepackage[french]{babel}
4090 \frenchsetup{StandardLists=true} 4228 \frenchsetup{StandardLists=true}
4091\end{code} 4229\end{alcode}
4092% \iffalse 4230% \iffalse
4093%</example> 4231%</example>
4094% \fi% 4232% \fi%
@@ -4106,12 +4244,12 @@
4106% \iffalse 4244% \iffalse
4107%<*example> 4245%<*example>
4108% \fi 4246% \fi
4109\begin{code} 4247\begin{alcode}
4110 \usepackage{csquotes} 4248 \usepackage{csquotes}
4111 \DeclareQuoteStyle{arabic} 4249 \DeclareQuoteStyle{arabic}
4112 {\textquotedblright}{\textquotedblleft} 4250 {\textquotedblright}{\textquotedblleft}
4113 {\textquoteright}{\textquoteleft} 4251 {\textquoteright}{\textquoteleft}
4114\end{code} 4252\end{alcode}
4115% \iffalse 4253% \iffalse
4116%</example> 4254%</example>
4117% \fi 4255% \fi
@@ -4130,11 +4268,11 @@
4130% \iffalse 4268% \iffalse
4131%</example> 4269%</example>
4132% \fi 4270% \fi
4133% \begin{quoting} 4271% \begin{remarks}
4134% \textsc{Rem.} Do not forget to set back the quoting style to its 4272% \item[\textsc{Rem.}] Do not forget to set back the quoting style to
4135% initial state once the Arabic environment is closed. See the last 4273% its initial state once the Arabic environment is closed. See the
4136% line in the code above. 4274% last line in the code above.
4137% \end{quoting} 4275% \end{remarks}
4138% 4276%
4139% \subsection{Two-argument special commands} 4277% \subsection{Two-argument special commands}
4140% \label{sec:two-arg-cmds} 4278% \label{sec:two-arg-cmds}
@@ -4183,7 +4321,7 @@
4183% \iffalse 4321% \iffalse
4184%<*example> 4322%<*example>
4185% \fi 4323% \fi
4186\begin{code} 4324\begin{alcode}
4187 \beginnumbering 4325 \beginnumbering
4188 \pstart 4326 \pstart
4189 \begin{arab} 4327 \begin{arab}
@@ -4192,7 +4330,7 @@
4192 \end{arab} 4330 \end{arab}
4193 \pend 4331 \pend
4194 \endnumbering 4332 \endnumbering
4195\end{code} 4333\end{alcode}
4196% \iffalse 4334% \iffalse
4197%</example> 4335%</example>
4198% \fi 4336% \fi
@@ -4217,10 +4355,10 @@
4217% \iffalse 4355% \iffalse
4218%<*example> 4356%<*example>
4219% \fi 4357% \fi
4220\begin{code} 4358\begin{alcode}
4221 \usepackage{arabluatex} 4359 \usepackage{arabluatex}
4222 \usepackage[nopar]{quran} 4360 \usepackage[nopar]{quran}
4223\end{code} 4361\end{alcode}
4224% \iffalse 4362% \iffalse
4225%</example> 4363%</example>
4226% \fi 4364% \fi
@@ -4241,7 +4379,7 @@
4241% 4379%
4242% \section{Exporting Unicode Arabic to an external file} 4380% \section{Exporting Unicode Arabic to an external file}
4243% \label{sec:arabtex2utf} 4381% \label{sec:arabtex2utf}
4244% \NEWfeature{v.1.13}\package{arabluatex} is able to produce a 4382% \newfeature[v.1.13]\package{arabluatex} is able to produce a
4245% duplicate of the original |.tex| source file in which all |arabtex| 4383% duplicate of the original |.tex| source file in which all |arabtex|
4246% or |buckwalter| strings will have been replaced with Unicode 4384% or |buckwalter| strings will have been replaced with Unicode
4247% equivalents, either in Arabic script or in any accepted standard of 4385% equivalents, either in Arabic script or in any accepted standard of
@@ -4259,12 +4397,12 @@
4259% \iffalse 4397% \iffalse
4260%<*example> 4398%<*example>
4261% \fi 4399% \fi
4262\begin{code} 4400\begin{alcode}
4263 % preamble 4401 % preamble
4264 \usepackage[export]{arabluatex} 4402 \usepackage[export]{arabluatex}
4265 % or: 4403 % or:
4266 \usepackage[export=true]{arabluatex} 4404 \usepackage[export=true]{arabluatex}
4267\end{code} 4405\end{alcode}
4268% \iffalse 4406% \iffalse
4269%</example> 4407%</example>
4270% \fi 4408% \fi
@@ -4284,11 +4422,11 @@
4284% \iffalse 4422% \iffalse
4285%<*example> 4423%<*example>
4286% \fi 4424% \fi
4287\begin{code} 4425\begin{alcode}
4288 \begin{arabexport} 4426 \begin{arabexport}
4289 <Running paragraphs of either Arabic or non-Arabic text> 4427 <Running paragraphs of either Arabic or non-Arabic text>
4290 \end{arabexport} 4428 \end{arabexport}
4291\end{code} 4429\end{alcode}
4292% \iffalse 4430% \iffalse
4293%</example> 4431%</example>
4294% \fi 4432% \fi
@@ -4346,11 +4484,11 @@
4346% \iffalse 4484% \iffalse
4347%<*example> 4485%<*example>
4348% \fi 4486% \fi
4349\begin{code} 4487\begin{alcode}
4350 Package arabluatex Warning: There are still 'arabtex' strings 4488 Package arabluatex Warning: There are still 'arabtex' strings
4351 to be converted. Please open <jobname><suffix>.tex and compile 4489 to be converted. Please open <jobname><suffix>.tex and compile
4352 it one more time. 4490 it one more time.
4353\end{code} 4491\end{alcode}
4354% \iffalse 4492% \iffalse
4355%</example> 4493%</example>
4356% \fi 4494% \fi
@@ -4368,9 +4506,9 @@
4368% \iffalse 4506% \iffalse
4369%<*example> 4507%<*example>
4370% \fi 4508% \fi
4371\begin{code} 4509\begin{alcode}
4372 pandoc file_out.tex -s -o file_out.odt 4510 pandoc file_out.tex -s -o file_out.odt
4373\end{code} 4511\end{alcode}
4374% \iffalse 4512% \iffalse
4375%</example> 4513%</example>
4376% \fi 4514% \fi
@@ -4382,7 +4520,7 @@
4382% \iffalse 4520% \iffalse
4383%<*example> 4521%<*example>
4384% \fi 4522% \fi
4385\begin{code} 4523\begin{alcode}
4386 % preamble: 4524 % preamble:
4387 \usepackage{arabluatex} % note that 'export' has been removed 4525 \usepackage{arabluatex} % note that 'export' has been removed
4388 \renewcommand{\txarb}[1]{#1} 4526 \renewcommand{\txarb}[1]{#1}
@@ -4392,7 +4530,7 @@
4392 % be safe to say: 4530 % be safe to say:
4393 \renewcommand{\prname}[2]{#2} 4531 \renewcommand{\prname}[2]{#2}
4394 % &c 4532 % &c
4395\end{code} 4533\end{alcode}
4396% \iffalse 4534% \iffalse
4397%</example> 4535%</example>
4398% \fi 4536% \fi
@@ -4509,8 +4647,16 @@
4509% it to suit our purpose: 4647% it to suit our purpose:
4510% \begin{macrocode} 4648% \begin{macrocode}
4511\AtBeginDocument{\ifdef{\LR}% 4649\AtBeginDocument{\ifdef{\LR}%
4512 {\RenewDocumentCommand{\LR}{m}{\bgroup\textdir TLT\rmfamily#1\egroup}} 4650 {\RenewDocumentCommand{\LR}{m}{\bgroup\textdir TLT\reset@font#1\egroup}}
4513 {\NewDocumentCommand{\LR}{m}{\bgroup\textdir TLT\rmfamily#1\egroup}}} 4651 {\NewDocumentCommand{\LR}{m}{\bgroup\textdir TLT\reset@font#1\egroup}}}
4652% \end{macrocode}
4653% \end{macro}
4654% \begin{macro}{\SetArbNumbers}
4655% \changes{v1.21}{2023/05/21}{selects Indian or Arabic numbers}
4656% \begin{macrocode}
4657\NewDocumentCommand{\SetArbNumbers}{m}{%
4658 \luadirect{arabluatex.setnums(\luastringN{#1})}%
4659}
4514% \end{macrocode} 4660% \end{macrocode}
4515% \end{macro} 4661% \end{macro}
4516% \begin{macro}{\RL} This one typesets its argument from right to 4662% \begin{macro}{\RL} This one typesets its argument from right to
@@ -4669,12 +4815,13 @@
4669% \end{macrocode} 4815% \end{macrocode}
4670% \end{macro} 4816% \end{macro}
4671% \begin{macro}{\altrfont} 4817% \begin{macro}{\altrfont}
4672% \changes{v1.21}{2020/07/13}{new command \cs{altrfont} to store 4818% \changes{v1.21}{2023/05/21}{new command \cs{altrfont} to store
4673% font and shape information (trans mode)} Finally \cs{altrfont} 4819% font and shape information (trans mode)} Finally \cs{altrfont}
4674% is used internally by \package{arabluatex} to store the family and 4820% is used internally by \package{arabluatex} to store family and
4675% the shape of the font to be used for transliterated Arabic. 4821% shape information about the font to be used for transliterated
4822% Arabic.
4676% \begin{macrocode} 4823% \begin{macrocode}
4677\def\altrfont{\al@trans@font\al@trans@style } 4824\def\altrfont{\al@trans@font\al@trans@style}
4678% \end{macrocode} 4825% \end{macrocode}
4679% \end{macro} 4826% \end{macro}
4680% \begin{macro}{\SetTranslitConvention} 4827% \begin{macro}{\SetTranslitConvention}
@@ -4767,7 +4914,7 @@
4767 \ifvmode\leavevmode\fi% 4914 \ifvmode\leavevmode\fi%
4768 \bgroup\textdir TRT\arabicfont#1\egroup} 4915 \bgroup\textdir TRT\arabicfont#1\egroup}
4769\NewDocumentCommand{\txtrans}{+m}{% 4916\NewDocumentCommand{\txtrans}{+m}{%
4770 \bgroup\textdir TLT\al@trans@font\al@trans@style#1\egroup} 4917 \bgroup\textdir TLT\altrfont#1\egroup}
4771% \end{macrocode} 4918% \end{macrocode}
4772% \end{macro} 4919% \end{macro}
4773% \end{macro} 4920% \end{macro}
@@ -4791,7 +4938,7 @@
4791\NewDocumentEnvironment{txarabtr}{}{% 4938\NewDocumentEnvironment{txarabtr}{}{%
4792 \par% 4939 \par%
4793 \pardir TLT\textdir TLT% 4940 \pardir TLT\textdir TLT%
4794 \al@trans@font\al@trans@style}{\par} 4941 \altrfont}{\par}
4795% \end{macrocode} 4942% \end{macrocode}
4796% \end{environment} 4943% \end{environment}
4797% \begin{macro}{\arb} 4944% \begin{macro}{\arb}
@@ -4820,7 +4967,7 @@
4820 \luastringO{\al@arb@rules}, \luastringO{\al@input@scheme}))}\egroup% 4967 \luastringO{\al@arb@rules}, \luastringO{\al@input@scheme}))}\egroup%
4821 \else% 4968 \else%
4822 \ifx\@tempa\al@mode@trans% 4969 \ifx\@tempa\al@mode@trans%
4823 \bgroup\textdir TLT\al@trans@font\al@trans@style% 4970 \bgroup\textdir TLT%
4824 \luadirect{tex.sprint(arabluatex.processtrans(\luastringN{#2}, 4971 \luadirect{tex.sprint(arabluatex.processtrans(\luastringN{#2},
4825 \luastringO{\al@trans@convention}, 4972 \luastringO{\al@trans@convention},
4826 \luastringO{\al@arb@rules}, 4973 \luastringO{\al@arb@rules},
@@ -4885,7 +5032,7 @@
4885 \luastringO{\al@arb@rules}, \luastringO{\al@input@scheme}))}\egroup% 5032 \luastringO{\al@arb@rules}, \luastringO{\al@input@scheme}))}\egroup%
4886 \else% 5033 \else%
4887 \ifx\@tempa\al@mode@trans% 5034 \ifx\@tempa\al@mode@trans%
4888 \bgroup\pardir TLT\textdir TLT\al@trans@font\al@trans@style% 5035 \bgroup\pardir TLT\textdir TLT%
4889 \luadirect{tex.sprint(arabluatex.processtrans(\luastringN{#2}, 5036 \luadirect{tex.sprint(arabluatex.processtrans(\luastringN{#2},
4890 \luastringO{\al@trans@convention}, 5037 \luastringO{\al@trans@convention},
4891 \luastringO{\al@arb@rules}, 5038 \luastringO{\al@arb@rules},
@@ -4905,55 +5052,63 @@
4905% \begin{macrocode} 5052% \begin{macrocode}
4906\newlength{\al@bayt@width} 5053\newlength{\al@bayt@width}
4907\newlength{\al@gutter@width} 5054\newlength{\al@gutter@width}
5055\newlength{\al@verse@twidth}
4908\setlength{\al@bayt@width}{.3\textwidth} 5056\setlength{\al@bayt@width}{.3\textwidth}
4909\setlength{\al@gutter@width}{.15\al@bayt@width} 5057\setlength{\al@gutter@width}{.15\al@bayt@width}
4910\define@key[al]{verse}{width}{\setlength{\al@bayt@width}{#1}} 5058\define@key[al]{verse}{width}{\setlength{\al@bayt@width}{#1}}
4911\define@key[al]{verse}{gutter}{\setlength{\al@gutter@width}{#1}} 5059\define@key[al]{verse}{gutter}{\setlength{\al@gutter@width}{#1}}
4912\define@key[al]{verse}{metre}{\arb{#1}} 5060\define@key[al]{verse}{metre}{\def\al@verse@metre@value{\arb{#1}}}
4913\define@key[al]{verse}{color}[]{\color{#1}} 5061\define@key[al]{verse}{color}[]{\color{#1}}
4914\define@boolkey[al]{verse}{utf}[true]{} 5062\define@boolkey[al]{verse}{utf}[true]{}
4915\define@boolkey[al]{verse}{delim}[true]{} 5063\define@boolkey[al]{verse}{delim}[true]{}
4916\define@boolkey[al]{verse}{export}[true]{} 5064\define@boolkey[al]{verse}{export}[true]{}
4917\define@choicekey[al]{verse}{mode}{fullvoc, voc, novoc, 5065\define@choicekey[al]{verse}{mode}{fullvoc, voc, novoc,
4918 trans}{\def\al@mode{#1}} 5066 trans}{\def\al@mode{#1}}
4919\presetkeys[al]{verse}{metre={}, utf=false, 5067\presetkeys[al]{verse}{utf=false, delim=false}{}
4920 delim=false}{}
4921% \end{macrocode} 5068% \end{macrocode}
4922% Then follows the environment itself: 5069% Then follows the environment itself:
4923% \begin{macrocode} 5070% \begin{macrocode}
4924\NewDocumentEnvironment{arabverse}{!O{}}% 5071\NewDocumentEnvironment{arabverse}{!O{}}%
4925{\bgroup\setkeys[al]{verse}[width, gutter, color, utf, delim, 5072{\bgroup\setkeys[al]{verse}[width, gutter, color, utf, delim,
4926 metre]{#1}% 5073 metre]{#1}%
4927 \if@pkg@export\ifal@verse@export% 5074 \if@pkg@export
4928 \ArbOutFile{\begin{arabverse}}% 5075 \ifal@verse@export
4929 % \ifx\al@mode\al@mode@trans% 5076 \ArbOutFile{\begin{arabverse}}%
4930 % \luadirect{arabluatex.tooutfile(\luastringN{[#1]})}% 5077 % \ifx\al@mode\al@mode@trans%
4931 % \else% 5078 % \luadirect{arabluatex.tooutfile(\luastringN{[#1]})}%
4932 \IfSubStr[1]{#1}{utf}% 5079 % \else%
5080 \IfSubStr[1]{#1}{utf}%
4933 {\luadirect{arabluatex.tooutfile(\luastringN{[#1]})}}% 5081 {\luadirect{arabluatex.tooutfile(\luastringN{[#1]})}}%
4934 {\luadirect{arabluatex.tooutfile(\luastringN{[#1, utf]})}}% 5082 {\luadirect{arabluatex.tooutfile(\luastringN{[#1, utf]})}}%
4935 % \fi 5083 % \fi
4936 \else\fi\else\fi\egroup% 5084 \else
4937 \par\centering\noindent\bgroup\setkeys[al]{verse}[metre]{#1}% 5085 \fi
4938 % \ifx\al@mode\al@mode@trans% 5086 \else
4939 % \ifal@verse@utf\setRL\else\setLR\fi% 5087 \fi
4940 % \else\setRL\fi% 5088 \egroup
4941 \ifal@verse@utf% 5089 \centering\noindent\bgroup\setkeys[al]{verse}[metre]{#1}%
4942 \ifx\al@mode\al@mode@trans\setLR\else\setRL\fi% 5090 % \ifx\al@mode\al@mode@trans%
4943 \else% 5091 % \ifal@verse@utf\setRL\else\setLR\fi%
4944 \ifx\al@mode\al@mode@trans\setLR\else\setRL\fi% 5092 % \else\setRL\fi%
4945 \fi% 5093 \ifal@verse@utf
4946 \arab@v@export[#1] 5094 \ifx\al@mode\al@mode@trans\setLR\else\setRL\fi
5095 \else
5096 \ifx\al@mode\al@mode@trans\setLR\else\setRL\fi
5097 \fi
5098 \addtolength{\al@verse@twidth}{2\al@bayt@width}%
5099 \addtolength{\al@verse@twidth}{\al@gutter@width}%
5100 \arab@v@export[#1]
4947 }% 5101 }%
4948 {\endarab@v@export 5102 {\endarab@v@export
4949 \hfill\setkeys[al]{verse}[width, gutter, color, utf, delim, mode, 5103 \setkeys[al]{verse}[width, gutter, color, utf, delim, mode,
4950 export]{#1}% 5104 export]{#1}%
4951 \egroup\par% 5105 \ifdefined\al@verse@metre@value\hfill\al@verse@metre@value\fi
5106 \egroup
4952 \bgroup\setkeys[al]{verse}[width, gutter, color, utf, delim, mode, 5107 \bgroup\setkeys[al]{verse}[width, gutter, color, utf, delim, mode,
4953 metre]{#1}% 5108 metre]{#1}%
4954 \if@pkg@export\ifal@verse@export% 5109 \if@pkg@export\ifal@verse@export
4955 \ArbOutFile{\end{arabverse}} 5110 \ArbOutFile{\end{arabverse}}%
4956 \else\fi\else\fi\egroup} 5111 \else\fi\else\fi\egroup}
4957% \end{macrocode} 5112% \end{macrocode}
4958% \begin{macro}{\bayt} 5113% \begin{macro}{\bayt}
4959% \changes{v1.6}{2016/12/17}{New macro \cs{bayt} for typesetting 5114% \changes{v1.6}{2016/12/17}{New macro \cs{bayt} for typesetting
@@ -5002,22 +5157,33 @@
5002\def\al@hemistich@delim{*} 5157\def\al@hemistich@delim{*}
5003\NewDocumentCommand{\SetHemistichDelim}{m}{\def\al@hemistich@delim{#1}} 5158\NewDocumentCommand{\SetHemistichDelim}{m}{\def\al@hemistich@delim{#1}}
5004\def\al@verse@stroke{\leavevmode\xleaders\hbox{\arb{--}}\hfill\kern0pt} 5159\def\al@verse@stroke{\leavevmode\xleaders\hbox{\arb{--}}\hfill\kern0pt}
5005\NewDocumentCommand{\bayt}{s m o m}{% 5160\providebool{ekd@state}
5006 \IfBooleanTF{#1}{\relax}{\relax}% 5161\NewDocumentCommand{\bayt}{t+ s m o m}{%
5162 \IfBooleanTF{#1}{%
5163 \ifekd@state
5164 \leavevmode
5165 \stepcounter{ekd@lab}%
5166 \zlabel{ekd:\theekd@lab}%
5167 \luadirect{ekdosis.storeabspg(
5168 \luastring{\zref@extract{ekd:\theekd@lab}{abspage}})}%
5169 \add@apparatus
5170 \fi
5171 }{\relax}%
5172 \IfBooleanTF{#2}{\relax}{\relax}%
5007 \ifdefined\savenotes\savenotes\else\fi% 5173 \ifdefined\savenotes\savenotes\else\fi%
5008 \edef\al@tatweel{--}% 5174 \edef\al@tatweel{--}%
5009 \ifal@warp@bayt% 5175 \ifal@warp@bayt%
5010 \adjustbox{width=\al@bayt@width, height=\Height}{\arb@utf{#2}}% 5176 \adjustbox{width=\al@bayt@width, height=\Height}{\arb@utf{#3}}%
5011 \else% 5177 \else%
5012 \makebox[\al@bayt@width][s]{\arb@utf{#2}}% 5178 \makebox[\al@bayt@width][s]{\arb@utf{#3}}%
5013 \fi% 5179 \fi%
5014 \IfNoValueTF{#3}{% 5180 \IfNoValueTF{#4}{%
5015 \ifal@verse@delim\makebox[\al@gutter@width][c]{\al@hemistich@delim}% 5181 \ifal@verse@delim\makebox[\al@gutter@width][c]{\al@hemistich@delim}%
5016 \else% 5182 \else%
5017 \hspace{\al@gutter@width}% 5183 \hspace{\al@gutter@width}%
5018 \fi 5184 \fi
5019 }{% 5185 }{%
5020 \edef\@tempa{#3}% 5186 \edef\@tempa{#4}%
5021 \ifx\@tempa\al@tatweel% 5187 \ifx\@tempa\al@tatweel%
5022 \ifx\al@mode\al@mode@trans% 5188 \ifx\al@mode\al@mode@trans%
5023 \hspace{\al@gutter@width}% 5189 \hspace{\al@gutter@width}%
@@ -5027,17 +5193,17 @@
5027 \else% 5193 \else%
5028 \ifx\al@mode\al@mode@trans% 5194 \ifx\al@mode\al@mode@trans%
5029 \ifal@warp@bayt% 5195 \ifal@warp@bayt%
5030 \adjustbox{width=\al@gutter@width, height=\Height}{\arb@utf{#3}}% 5196 \adjustbox{width=\al@gutter@width, height=\Height}{\arb@utf{#4}}%
5031 \else% 5197 \else%
5032 \makebox[\al@gutter@width][s]{\arb@utf{#3}}% 5198 \makebox[\al@gutter@width][s]{\arb@utf{#4}}%
5033 \fi% 5199 \fi%
5034 \else% 5200 \else%
5035 \makebox[\al@gutter@width][s]{\arb@utf{#3}}% 5201 \makebox[\al@gutter@width][s]{\arb@utf{#4}}%
5036 \fi\fi}% 5202 \fi\fi}%
5037 \ifal@warp@bayt% 5203 \ifal@warp@bayt%
5038 \adjustbox{width=\al@bayt@width, height=\Height}{\arb@utf{#4}}% 5204 \adjustbox{width=\al@bayt@width, height=\Height}{\arb@utf{#5}}%
5039 \else% 5205 \else%
5040 \makebox[\al@bayt@width][s]{\arb@utf{#4}}% 5206 \makebox[\al@bayt@width][s]{\arb@utf{#5}}%
5041 \fi% 5207 \fi%
5042 \ifdefined\spewnotes\spewnotes\else\fi% 5208 \ifdefined\spewnotes\spewnotes\else\fi%
5043} 5209}
@@ -5274,14 +5440,37 @@
5274\NewDocumentEnvironment{arab@v@export}{O{} +b}{% 5440\NewDocumentEnvironment{arab@v@export}{O{} +b}{%
5275 \setkeys[al]{verse}[width, gutter, color, utf, delim, mode, 5441 \setkeys[al]{verse}[width, gutter, color, utf, delim, mode,
5276 metre]{#1} 5442 metre]{#1}
5277 \if@pkg@export\ifal@verse@export% 5443 \if@pkg@export
5278 \par 5444 \ifal@verse@export
5279 #2 5445 \ifekd@state
5280 \luadirect{arabluatex.doexport("arabverse")} 5446 \begin{ekdverse}[width=\al@verse@twidth]
5281 \luadirect{tex.sprint(arabluatex.arbtoutf(\luastringN{#2}))} 5447 #2
5282 \luadirect{arabluatex.doexport("no")} 5448 \end{ekdverse}
5283 \else\par#2\fi\else\par#2\fi 5449 \else
5284}{\par} 5450 #2
5451 \fi
5452 \luadirect{arabluatex.doexport("arabverse")}%
5453 \luadirect{tex.sprint(arabluatex.arbtoutf(\luastringN{#2}))}%
5454 \luadirect{arabluatex.doexport("no")}%
5455 \else
5456 \ifekd@state
5457 \begin{ekdverse}[width=\al@verse@twidth]
5458 #2
5459 \end{ekdverse}
5460 \else
5461 #2
5462 \fi
5463 \fi
5464 \else
5465 \ifekd@state
5466 \begin{ekdverse}[width=\al@verse@twidth]
5467 #2
5468 \end{ekdverse}
5469 \else
5470 #2
5471 \fi
5472 \fi
5473}{}
5285% \end{macrocode} 5474% \end{macrocode}
5286% \end{environment} 5475% \end{environment}
5287% \begin{macro}{\arbpardir} 5476% \begin{macro}{\arbpardir}