aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--arabluatex.dtx795
1 files changed, 690 insertions, 105 deletions
diff --git a/arabluatex.dtx b/arabluatex.dtx
index 392e4cd..f7278f1 100644
--- a/arabluatex.dtx
+++ b/arabluatex.dtx
@@ -173,25 +173,72 @@
173\usepackage[nopar]{quran} 173\usepackage[nopar]{quran}
174\usepackage[noindex]{nameauth} 174\usepackage[noindex]{nameauth}
175\usepackage{varioref} 175\usepackage{varioref}
176\usepackage{hyperxmp} 176\usepackage{latexcolors}
177\usepackage{hypdoc} 177\PassOptionsToPackage{bookmarks=true}{hyperref}
178\usepackage[numbered]{hypdoc}
178\usepackage{uri} 179\usepackage{uri}
180\usepackage[loadlang=en]{metastr}
181\hypersetup{
182 colorlinks,
183 allcolors=cinnamon,
184 linktocpage=true,
185 pdftype={Text}
186}
187\labelformat{section}{sect.~#1}
188\labelformat{subsection}{sect.~#1}
189\labelformat{subsubsection}{sect.~#1}
190\labelformat{figure}{fig.~#1}
191\labelformat{table}{tab.~#1}
192\metaset{titletext}{%
193 \metapick[#1]{title}%
194 \metacompose[#1]{subtitle}{\metaget[sep]{subtitle}}{}{}}
195\metaset[print]{titletext}{%
196 \metatitleline[print]{title}%
197 \metatitleline[print]{subtitle}%
198 \metatitleline[print]{author}%
199 \metatitleline[print]{contactemail}%
200 \metatitlelinetwo[print]{date}[print]{draft}}
201\metaset[skip]{subtitle}{\vspace{1ex}}
202\metaset[skip]{author}{\vspace{2ex}}
203\metaset[skip]{date}{\vspace{1ex}}
204\metaset[style]{title}{\LARGE}
205\metaset[style]{author}{\large}
206\metaset[sep]{draft}{ -- }
207\metasetlang{en-US}
208\metaset{title}{arabluatex}
209\metaset{date}{\filedate}
210\metaset{draft}{\fileversion}
211\metaset{subject}{ArabTeX}
212\metaset{subtitle}{ArabTeX for LuaLaTeX}
213\metaset[print]{subtitle}{Arab\TeX\ for Lua\LaTeX}
214\metaset{author}{Robert Alessi}
215\metaset{keywords}{Arabic language, Arabic,
216 arabtex, luatex}
217\metaset{contactemail}{alessi@roberalessi.net}
218\metaset[print]{contactemail}{\mailto[arabluatex]{alessi@robertalessi.net}}
219\metaset{contacturl}{http://www.roberalessi.net}
220\metaset{partof}{The arabluatex Package}
221\metaset[print]{partof}{The \textsf{arabluatex} Package}
222\metaset{copyrightowner}{\metapick[#1]{author}}
223\metaset{copyrightdate}{2016--2020}
224\metaset{licensemessage}{Permission is granted to copy, distribute
225 and/or modify this document under the terms of the GNU Free
226 Documentation License, Version 1.3 or any later version published by
227 the Free Software Foundation; with no Invariant Sections, no
228 Front-Cover Texts, and no Back-Cover Texts. A copy of the license
229 is included in the section entitled ``GNU Free Documentation
230 License''.}
231\metaset{licenseurl}{https://www.gnu.org/licenses/fdl-1.3.html}
232\metaset[print]{licenseurl}{%
233 \url{https://www.gnu.org/licenses/fdl-1.3.html}}
234\metaset[cmd]{licenselogo}{\includegraphics[scale=0.75]{#1}}
235\metawritepdfinfo
236\metawritepdfaux
237\metawritepdfpreamble
238\metawritepdfcontact
239\metawritepdfrights
179\usepackage{bookmark} 240\usepackage{bookmark}
180\usepackage{authblk} 241\usepackage{authblk}
181\usepackage{latexcolors}
182\hypersetup{unicode=true, colorlinks, allcolors=cinnamon, keeppdfinfo,
183 linktocpage=true, pdfauthor={Robert Alessi}, pdftitle={The
184 arabluatex package}, pdfcontactemail={alessi@robertalessi.net},
185 pdfcontacturl={http://www.robertalessi.net/arabluatex},
186 pdfcopyright={Copyright (C) 2016--2020 Robert Alessi
187 <alessi@robertalessi.net>. This document is licensed under the
188 Creative Commons Attribution-ShareAlike 4.0 International
189 License. To view a copy of this license, visit
190 http://creativecommons.org/licenses/by-sa/4.0/ or send a letter to
191 Creative Commons, PO Box 1866, Mountain View, CA 94042, USA.},
192 pdflicenseurl={https://creativecommons.org/licenses/by-sa/4.0/legalcode},
193 pdfmetalang={en-US}, pdftype={Text}, pdfkeywords={Arabic language,
194 arabtex, luatex}}
195\usepackage[scale=1.5]{ccicons} 242\usepackage[scale=1.5]{ccicons}
196\usepackage[lot]{multitoc} 243\usepackage[lot]{multitoc}
197\usepackage{enumitem} 244\usepackage{enumitem}
@@ -202,8 +249,7 @@
202\newlist{enumabjad}{enumerate}{10} 249\newlist{enumabjad}{enumerate}{10}
203\setlist[enumabjad]{label={\abjad{\arabic*}}} 250\setlist[enumabjad]{label={\abjad{\arabic*}}}
204\usepackage{multicol} 251\usepackage{multicol}
205\usepackage{cleveref} 252\setlength\IndexMin{100pt}
206\crefname{footnote}{note}{notes}
207\usepackage{quoting} 253\usepackage{quoting}
208\quotingsetup{noorphans, rightmargin=0pt} 254\quotingsetup{noorphans, rightmargin=0pt}
209\renewcommand*{\quotingfont}{\footnotesize} 255\renewcommand*{\quotingfont}{\footnotesize}
@@ -234,6 +280,13 @@
234\usepackage[style=authoryear, indexing=cite]{biblatex} 280\usepackage[style=authoryear, indexing=cite]{biblatex}
235\DeclareIndexFieldFormat{indextitle}{\index{#1=\emph{#1}}} 281\DeclareIndexFieldFormat{indextitle}{\index{#1=\emph{#1}}}
236\addbibresource{arabluatex.bib} 282\addbibresource{arabluatex.bib}
283\NewDocumentCommand{\newfeature}{o}{%
284 \leavevmode
285 \IfNoValueTF{#1}
286 {\marginpar{\hfill\emph{New feature}}}
287 {\marginpar{\hfill\emph{New feature} #1}}%
288 \ignorespaces
289}
237\usepackage{etoc} 290\usepackage{etoc}
238\etocsettocdepth{paragraph} 291\etocsettocdepth{paragraph}
239\newcommand{\altableofcontents}{% 292\newcommand{\altableofcontents}{%
@@ -317,24 +370,21 @@
317% \DoNotIndex{\relax,\RenewDocumentCommand,\string,\verb,\let} 370% \DoNotIndex{\relax,\RenewDocumentCommand,\string,\verb,\let}
318% \DoNotIndex{\enskip} 371% \DoNotIndex{\enskip}
319% 372%
320% \providecommand*{\url}{\texttt}
321% \GetFileInfo{arabluatex.dtx} 373% \GetFileInfo{arabluatex.dtx}
322% 374%
323% \newcommand*{\NEWfeature}[1]{% 375% \pdfbookmark[1]{\metaterm{title}}{title}
324% \hskip 1sp \marginpar{\small\sffamily\raggedright 376% \begin{tcolorbox}[
325% New feature\\#1}} 377% colframe=black,
326% 378% enhanced,
327% \title{\tcbox[colframe=black, enhanced, tikznode, drop lifted 379% drop lifted shadow,
328% shadow, colback=white, boxrule=.25mm]% 380% colback=white,
329% {The \textsf{arabluatex} package\\ 381% boxrule=.25mm,
330% \fileversion\ -- \filedate}} 382% halign=center,
383% center
384% ]
385% \metapick[print]{titletext}
386% \end{tcolorbox}
331% 387%
332% \author{Robert Alessi \\
333% \href{mailto:alessi@robertalessi.net?Subject=arabluatex package}%
334% {\texttt{alessi@robertalessi.net}}}
335% \date{}
336%
337% \maketitle
338% \footnotesize 388% \footnotesize
339% \altableofcontents 389% \altableofcontents
340% \listoftables 390% \listoftables
@@ -357,13 +407,19 @@
357% various ways. 407% various ways.
358% \end{abstract} 408% \end{abstract}
359% 409%
360% \section*{License and disclamer} 410% \section*{License and Disclaimer}
361% \addcontentsline{toc}{section}{License and disclamer} 411% \addcontentsline{toc}{section}{License and disclamer}
362% \subsection*{License applicable to the software} 412% \subsection*{License Applicable to this Document}
413% \pdfbookmark[2]{Licence applicable to this document}{copyright-doc}
414% \leavevmode\marginpar{\hfill\texttt{fdl1.3}}
415% \metapick[print]{rightstext} (See below \vref{sec:fdl}.)
416%
417% \subsection*{License Applicable to the Software}
418% \pdfbookmark[2]{Licence applicable to the software}{copyright-soft}
363% \label{sec:license-software} 419% \label{sec:license-software}
364% 420%
365% \package{arabluatex} --- Processing Arab\TeX\ notation under Lua\LaTeX.\\ 421% \package{arabluatex} --- \metapick[print]{subtitle}
366% Copyright \textcopyright\ 2016--2020 Robert Alessi 422% \metapick[print]{copyrightstatement}
367% 423%
368% Please send error reports and suggestions for improvements to Robert 424% Please send error reports and suggestions for improvements to Robert
369% Alessi: 425% Alessi:
@@ -375,7 +431,7 @@
375% \url{https://gitlab.com/ralessi/arabluatex/issues} 431% \url{https://gitlab.com/ralessi/arabluatex/issues}
376% \end{itemize} 432% \end{itemize}
377% 433%
378% \marginpar{\texttt{gpl3+}} 434% \leavevmode\marginpar{\hfill\texttt{gpl3+}}
379% This program is free software: you can redistribute it and/or modify 435% This program is free software: you can redistribute it and/or modify
380% it under the terms of the GNU General Public License as published by 436% it under the terms of the GNU General Public License as published by
381% the Free Software Foundation, either version 3 of the License, or 437% the Free Software Foundation, either version 3 of the License, or
@@ -388,7 +444,8 @@
388% 444%
389% You should have received a copy of the GNU General Public License 445% You should have received a copy of the GNU General Public License
390% along with this program. If not, see 446% along with this program. If not, see
391% <http://www.gnu.org/licenses/>. 447% \href{http://www.gnu.org/licenses}%
448% {\texttt{<http://www.gnu.org/licenses/>}}.
392% 449%
393% This release of \package{arabluatex} consists of the following 450% This release of \package{arabluatex} consists of the following
394% source files: 451% source files:
@@ -402,21 +459,9 @@
402% \item |arabluatex_trans.lua| 459% \item |arabluatex_trans.lua|
403% \item |arabluatex.el| 460% \item |arabluatex.el|
404% \end{itemize} 461% \end{itemize}
405%
406% \subsection*{License applicable to this document}
407% \label{sec:documentation-license}
408% Copyright \textcopyright\ 2016--2020 Robert Alessi
409%
410% \ccbysa\marginpar{\texttt{CC BY-SA 4.0}}
411% This document is licensed under the Creative Commons
412% Attribution-ShareAlike 4.0 International License. To view a copy of
413% this license, visit
414% \url{http://creativecommons.org/licenses/by-sa/4.0/} or send a
415% letter to Creative Commons, PO Box 1866, Mountain View, CA 94042,
416% USA.
417% 462%
418% \section{Introduction} 463% \section{Introduction}
419% In comparison to Prof. Lagally's outstanding Arab\TeX,\footnote{See 464% In comparison to Prof.\ Lagally's outstanding Arab\TeX,\footnote{See
420% \url{http://ctan.org/pkg/arabtex}} Arab{\LuaTeX} is at present 465% \url{http://ctan.org/pkg/arabtex}} Arab{\LuaTeX} is at present
421% nothing more than a modest piece of software. Hopefully---if I may 466% nothing more than a modest piece of software. Hopefully---if I may
422% say so---it will eventually provide all of its valuable qualities to 467% say so---it will eventually provide all of its valuable qualities to
@@ -592,7 +637,7 @@
592% \label{ref:export-global-opt} 637% \label{ref:export-global-opt}
593% \DescribeOption{export} |export|$=$|true|\verb+|+|false| 638% \DescribeOption{export} |export|$=$|true|\verb+|+|false|
594% \hfill\tcboxverb{Default: false}\\ \label{export-mode} 639% \hfill\tcboxverb{Default: false}\\ \label{export-mode}
595% \NEWfeature{v.1.13} This option acts as a named argument and does 640% \newfeature[v.1.13] This option acts as a named argument and does
596% not need a value as it defaults to |true| if it is used. It enables 641% not need a value as it defaults to |true| if it is used. It enables
597% \package{arabluatex} to produce a duplicate of the original |.tex| 642% \package{arabluatex} to produce a duplicate of the original |.tex|
598% source file in which all \textsc{ascii} strings are replaced with 643% source file in which all \textsc{ascii} strings are replaced with
@@ -601,7 +646,7 @@
601% 646%
602% \subsubsection{Classic contrasted with modern typesetting of Arabic} 647% \subsubsection{Classic contrasted with modern typesetting of Arabic}
603% \label{sec:classic-modern-typesetting} 648% \label{sec:classic-modern-typesetting}
604% \NEWfeature{v.1.2} By default, \package{arabluatex} typesets Arabic 649% \newfeature[v.1.2] By default, \package{arabluatex} typesets Arabic
605% in a classic, traditional style the most prominent features of which 650% in a classic, traditional style the most prominent features of which
606% are the following: 651% are the following:
607% \begin{itemize} 652% \begin{itemize}
@@ -640,7 +685,7 @@
640% \fi 685% \fi
641% \end{itemize} 686% \end{itemize}
642% 687%
643% \DescribeMacro{\SetArbEasy} \NEWfeature{v1.4.4} Such refinements as 688% \DescribeMacro{\SetArbEasy} \newfeature[v1.4.4] Such refinements as
644% \enquote*{classic} \arb[trans]{maddaT} may be discarded by the 689% \enquote*{classic} \arb[trans]{maddaT} may be discarded by the
645% \cs{SetArbEasy} command, either globally in the preamble or locally 690% \cs{SetArbEasy} command, either globally in the preamble or locally
646% at any point of the document. The difference between \cs{SetArbEasy} 691% at any point of the document. The difference between \cs{SetArbEasy}
@@ -650,7 +695,7 @@
650% mode, while the latter further takes it away. Default 695% mode, while the latter further takes it away. Default
651% \enquote*{classic} rules may be set back at any point of the 696% \enquote*{classic} rules may be set back at any point of the
652% document with the \DescribeMacro{\SetArbDflt}\cs{SetArbDflt} 697% document with the \DescribeMacro{\SetArbDflt}\cs{SetArbDflt}
653% command. \NEWfeature{v1.6} \DescribeMacro{\SetArbDflt*}Assimilation 698% command. \newfeature[v1.6] \DescribeMacro{\SetArbDflt*}Assimilation
654% rules laid on \vref{ref:assimilation} may also be applied by the 699% rules laid on \vref{ref:assimilation} may also be applied by the
655% \enquote*{starred} version of this command \cs{SetArbDflt*} either 700% \enquote*{starred} version of this command \cs{SetArbDflt*} either
656% in the preamble or at any point of the document.\footnote{For an 701% in the preamble or at any point of the document.\footnote{For an
@@ -806,7 +851,7 @@
806% 851%
807%\section{Standard Arab\TeX\ input} 852%\section{Standard Arab\TeX\ input}
808%\subsection{Consonants} 853%\subsection{Consonants}
809% \Cref{tab:arabtex-consonants} gives the Arab\TeX\ equivalents for 854% \Vref{tab:arabtex-consonants} gives the Arab\TeX\ equivalents for
810% all of the Arabic consonants. 855% all of the Arabic consonants.
811% 856%
812% \addlines[2] 857% \addlines[2]
@@ -821,7 +866,7 @@
821% \arb[trans]{#1}\SetTranslitConvention{dmg}} 866% \arb[trans]{#1}\SetTranslitConvention{dmg}}
822% \begin{longtable}{lllll} 867% \begin{longtable}{lllll}
823% \bottomrule 868% \bottomrule
824% \caption*{\Cref*{tab:arabtex-consonants}: Standard Arab\TeX\ 869% \caption*{\Vref{tab:arabtex-consonants}: Standard Arab\TeX\
825% (consonants)} 870% (consonants)}
826% \endfoot 871% \endfoot
827% \captionlistentry{Arab\TeX\ consonants}\\[-1em] 872% \captionlistentry{Arab\TeX\ consonants}\\[-1em]
@@ -909,12 +954,12 @@
909% \subsection{Additional characters} 954% \subsection{Additional characters}
910% \changes{v1.8.5}{2017/06/20}{Six additional Persian characters are 955% \changes{v1.8.5}{2017/06/20}{Six additional Persian characters are
911% now available} 956% now available}
912% \NEWfeature{v1.8.5}\Cref{tab:arabtex-additional-characters} gives 957% \newfeature[v1.8.5]\Vref{tab:arabtex-additional-characters} gives
913% the Arab\TeX\ equivalents for some additional Persian characters. 958% the Arab\TeX\ equivalents for some additional Persian characters.
914% 959%
915% \begin{longtable}{lllll} 960% \begin{longtable}{lllll}
916% \bottomrule 961% \bottomrule
917% \caption*{\Cref*{tab:arabtex-additional-characters}: Standard 962% \caption*{\Vref{tab:arabtex-additional-characters}: Standard
918% Arab\TeX\ (additional characters)} 963% Arab\TeX\ (additional characters)}
919% \endfoot 964% \endfoot
920% \captionlistentry{Arab\TeX\ additional characters}\\[-1em] 965% \captionlistentry{Arab\TeX\ additional characters}\\[-1em]
@@ -943,7 +988,7 @@
943% \textcite[2]{dmg}. It is taken from the \textcite{din31635} standard.} & 988% \textcite[2]{dmg}. It is taken from the \textcite{din31635} standard.} &
944% \dmg{v} & \loc{v} & \brill{v} & \verb|v| \\ 989% \dmg{v} & \loc{v} & \brill{v} & \verb|v| \\
945% \arb[novoc]{g} & \dmg{g} & \loc{g} & \brill{g} & \verb|g| \\ 990% \arb[novoc]{g} & \dmg{g} & \loc{g} & \brill{g} & \verb|g| \\
946% \arb[novoc]{^n}\footnote{See \cref{fn:not-in-dmg}.} & \dmg{^n} & 991% \arb[novoc]{^n}\footnote{See \vref{fn:not-in-dmg}.} & \dmg{^n} &
947% \loc{^n} & \brill{^n} & \verb|^n| \\ 992% \loc{^n} & \brill{^n} & \verb|^n| \\
948% \end{longtable} 993% \end{longtable}
949% \begin{quoting} 994% \begin{quoting}
@@ -954,12 +999,12 @@
954% 999%
955% \subsection{Vowels} 1000% \subsection{Vowels}
956% \subsubsection{Long vowels} 1001% \subsubsection{Long vowels}
957% \Cref{tab:arabtex-long-vowels} gives the Arab\TeX\ equivalents for 1002% \Vref{tab:arabtex-long-vowels} gives the Arab\TeX\ equivalents for
958% the Arabic long vowels. 1003% the Arabic long vowels.
959% \enlargethispage{1\baselineskip} 1004% \enlargethispage{1\baselineskip}
960% \begin{longtable}{lllll} 1005% \begin{longtable}{lllll}
961% \bottomrule 1006% \bottomrule
962% \caption*{\Cref*{tab:arabtex-long-vowels}: Standard Arab\TeX\ (long 1007% \caption*{\Vref{tab:arabtex-long-vowels}: Standard Arab\TeX\ (long
963% vowels)} 1008% vowels)}
964% \endfoot 1009% \endfoot
965% \captionlistentry{Arab\TeX\ long vowels}\\[-1em] 1010% \captionlistentry{Arab\TeX\ long vowels}\\[-1em]
@@ -1016,12 +1061,12 @@
1016% \end{quoting} 1061% \end{quoting}
1017% 1062%
1018% \subsubsection{Short vowels} 1063% \subsubsection{Short vowels}
1019% \Cref{tab:arabtex-short-vowels} gives the Arab\TeX\ equivalents for 1064% \Vref{tab:arabtex-short-vowels} gives the Arab\TeX\ equivalents for
1020% the Arabic short vowels. 1065% the Arabic short vowels.
1021% 1066%
1022% \begin{longtable}{lllll} 1067% \begin{longtable}{lllll}
1023% \bottomrule 1068% \bottomrule
1024% \caption*{\Cref*{tab:arabtex-short-vowels}: Standard Arab\TeX\ 1069% \caption*{\Vref{tab:arabtex-short-vowels}: Standard Arab\TeX\
1025% (short vowels)} 1070% (short vowels)}
1026% \endfoot 1071% \endfoot
1027% \captionlistentry{Arab\TeX\ short vowels}\\[-1em] 1072% \captionlistentry{Arab\TeX\ short vowels}\\[-1em]
@@ -1482,7 +1527,7 @@
1482% |al-.hamd-u| |li-l-l_ah-i| \arb[fullvoc]{al-.hamd-u li-l-l_ah-i} 1527% |al-.hamd-u| |li-l-l_ah-i| \arb[fullvoc]{al-.hamd-u li-l-l_ah-i}
1483% \arb[trans]{al-.hamd-u li-l-l_ah-i}. 1528% \arb[trans]{al-.hamd-u li-l-l_ah-i}.
1484% \end{quote} 1529% \end{quote}
1485% As said above on \cpageref{fullvoc-mode}, |fullvoc| is the mode 1530% As said above on \vpageref{fullvoc-mode}, |fullvoc| is the mode
1486% in which \package{arabluatex} expresses the \arb[trans]{sukUn} and 1531% in which \package{arabluatex} expresses the \arb[trans]{sukUn} and
1487% the \arb[trans]{wa.slaT}. \package{arabluatex} will take care of 1532% the \arb[trans]{wa.slaT}. \package{arabluatex} will take care of
1488% doing that automatically provided that the vowel which is to be 1533% doing that automatically provided that the vowel which is to be
@@ -1664,7 +1709,7 @@
1664% \enquote{pipe} and \vref{sec:transliteration} on |dmg| mode.} 1709% \enquote{pipe} and \vref{sec:transliteration} on |dmg| mode.}
1665% |al-l_ah-u| \arb[fullvoc]{yA| al-l_ah-u} \arb[trans]{yA| 1710% |al-l_ah-u| \arb[fullvoc]{yA| al-l_ah-u} \arb[trans]{yA|
1666% al-l_ah-u}, \verb+'a-fa|+\footnote{\label{fn:pipe-allah-02}See 1711% al-l_ah-u}, \verb+'a-fa|+\footnote{\label{fn:pipe-allah-02}See
1667% \cref{fn:pipe-allah-01}.}|-al-|\allowbreak|l_ah-i| 1712% \vref{fn:pipe-allah-01}.}|-al-|\allowbreak|l_ah-i|
1668% |la-ta.g`alanna| \arb[fullvoc]{'a-fa|-al-l_ah-i la-ta.g`alanna} 1713% |la-ta.g`alanna| \arb[fullvoc]{'a-fa|-al-l_ah-i la-ta.g`alanna}
1669% \arb[trans]{'a-fa|-al-l_ah-i la-ta.g`alanna}, 1714% \arb[trans]{'a-fa|-al-l_ah-i la-ta.g`alanna},
1670% |bi-'l-|\allowbreak|l_ah-i| \arb[fullvoc]{bi-'l-l_ah-i} 1715% |bi-'l-|\allowbreak|l_ah-i| \arb[fullvoc]{bi-'l-l_ah-i}
@@ -1856,12 +1901,12 @@
1856% analysis. \enquote{Quoting} that straight single quote character 1901% analysis. \enquote{Quoting} that straight single quote character
1857% like so: \meta{\texttt{"'}} allows to determine the carrier of the 1902% like so: \meta{\texttt{"'}} allows to determine the carrier of the
1858% \arb[trans]{hamzaT} freely, without any consideration for the 1903% \arb[trans]{hamzaT} freely, without any consideration for the
1859% context. \Cref{tab:quoted-hamza} gives the equivalents for all the 1904% context. \Vref{tab:quoted-hamza} gives the equivalents for all the
1860% possible carriers the \arb[trans]{hamzaT} may take. 1905% possible carriers the \arb[trans]{hamzaT} may take.
1861% 1906%
1862% \begin{longtable}{lllll} 1907% \begin{longtable}{lllll}
1863% \bottomrule 1908% \bottomrule
1864% \caption*{\Cref*{tab:quoted-hamza}: \enquote{Quoted} 1909% \caption*{\Vref{tab:quoted-hamza}: \enquote{Quoted}
1865% \arb[trans]{hamzaT}} 1910% \arb[trans]{hamzaT}}
1866% \endfoot 1911% \endfoot
1867% \captionlistentry{\enquote{Quoted} \arb[trans]{hamzaT}}\\[-1em] 1912% \captionlistentry{\enquote{Quoted} \arb[trans]{hamzaT}}\\[-1em]
@@ -1927,11 +1972,11 @@
1927% \end{quote} 1972% \end{quote}
1928% As one can see, the \enquote{pipe} character between the two 1973% As one can see, the \enquote{pipe} character between the two
1929% \meta{n} prevents the necessary \arb[trans]{ta^sdId} rule 1974% \meta{n} prevents the necessary \arb[trans]{ta^sdId} rule
1930% (\cpageref{ref:necessary-tashdid}) from being applied. 1975% (\vpageref{ref:necessary-tashdid}) from being applied.
1931% 1976%
1932% \subsection{Putting back on broken contextual analysis rules} 1977% \subsection{Putting back on broken contextual analysis rules}
1933% \label{sec:arbnull} 1978% \label{sec:arbnull}
1934% \NEWfeature{v1.7} In complex documents such as critical editions 1979% \newfeature[v1.7] In complex documents such as critical editions
1935% where footnotes and other kind of annotations can be particularly 1980% where footnotes and other kind of annotations can be particularly
1936% abundant, the contextual analysis rules that are described above may 1981% abundant, the contextual analysis rules that are described above may
1937% be broken by \LaTeX\ commands. To take an example, consider the 1982% be broken by \LaTeX\ commands. To take an example, consider the
@@ -2035,7 +2080,7 @@
2035% \arb[trans]{'abjad} numbers are usually distinguished from the 2080% \arb[trans]{'abjad} numbers are usually distinguished from the
2036% surrounding words by a stroke placed over them. 2081% surrounding words by a stroke placed over them.
2037% 2082%
2038% \DescribeMacro{\abjad} \NEWfeature{v.1.1} \arb[trans]{'abjad} 2083% \DescribeMacro{\abjad} \newfeature[v.1.1] \arb[trans]{'abjad}
2039% numbers are inserted with the \cs{abjad}\marg{number} command in any 2084% numbers are inserted with the \cs{abjad}\marg{number} command in any
2040% of the |voc|, |fullvoc| and |novoc| modes, where \meta{number} may 2085% of the |voc|, |fullvoc| and |novoc| modes, where \meta{number} may
2041% be any number between 1 and 1999, like so:--- 2086% be any number between 1 and 1999, like so:---
@@ -2072,7 +2117,7 @@
2072% \end{quote} 2117% \end{quote}
2073% \end{quoting} 2118% \end{quoting}
2074% 2119%
2075% \NEWfeature{v1.12}\cs{abjad} may also be used to convert values of 2120% \newfeature[v1.12]\cs{abjad} may also be used to convert values of
2076% counters into \arb[trans]{'ab^gad} numbers, like so:--- % 2121% counters into \arb[trans]{'ab^gad} numbers, like so:--- %
2077% \changes{v1.12}{2018/06/24}{\cs{abjad} can now process \LaTeX\ 2122% \changes{v1.12}{2018/06/24}{\cs{abjad} can now process \LaTeX\
2078% counters}% 2123% counters}%
@@ -2104,7 +2149,7 @@
2104% For the time being, the following is included:--- 2149% For the time being, the following is included:---
2105% \begin{longtable}{lllll} 2150% \begin{longtable}{lllll}
2106% \bottomrule 2151% \bottomrule
2107% \caption*{\Cref*{tab:additional-arabic-codings}: Additional Arabic 2152% \caption*{\Vref{tab:additional-arabic-codings}: Additional Arabic
2108% codings} 2153% codings}
2109% \endfoot 2154% \endfoot
2110% \captionlistentry{Additional Arabic codings}\\[-1em] 2155% \captionlistentry{Additional Arabic codings}\\[-1em]
@@ -2157,7 +2202,7 @@
2157% \package{arabluatex} places the horizontal stroke \emph{under} the 2202% \package{arabluatex} places the horizontal stroke \emph{under} the
2158% emphasized words in any of the transliteration modes. 2203% emphasized words in any of the transliteration modes.
2159% 2204%
2160% \textsc{Rem.}~\emph{b.} \NEWfeature{v1.9.2}\DescribeMacro{\aemph*} 2205% \textsc{Rem.}~\emph{b.} \newfeature[v1.9.2]\DescribeMacro{\aemph*}
2161% \cs{aemph*} is also provided should one wish to always have the 2206% \cs{aemph*} is also provided should one wish to always have the
2162% horizontal stroke printed over the emphasized words, like so: 2207% horizontal stroke printed over the emphasized words, like so:
2163% |\abjad{45}:| |kitAbu-hu| |\aemph*{fI| |'l-`AdAt-i}| 2208% |\abjad{45}:| |kitAbu-hu| |\aemph*{fI| |'l-`AdAt-i}|
@@ -2170,7 +2215,7 @@
2170% \DescribeMacro{\aoline}% 2215% \DescribeMacro{\aoline}%
2171% \DescribeMacro{\aoline*}% 2216% \DescribeMacro{\aoline*}%
2172% \DescribeMacro{\auline}% 2217% \DescribeMacro{\auline}%
2173% \NEWfeature{v1.19}Three additional, non context-sensitive commands 2218% \newfeature[v1.19]Three additional, non context-sensitive commands
2174% are provided to distinguish words or numbers:--- 2219% are provided to distinguish words or numbers:---
2175% \begin{enumerate} 2220% \begin{enumerate}
2176% \item \cs{aoline}, which is equivalent to \cs{aemph*} described 2221% \item \cs{aoline}, which is equivalent to \cs{aemph*} described
@@ -2183,7 +2228,7 @@
2183% 2228%
2184% \section{Arabic poetry} 2229% \section{Arabic poetry}
2185% \label{sec:poetry} 2230% \label{sec:poetry}
2186% \NEWfeature{v1.6} \package{arabluatex} provides a special 2231% \newfeature[v1.6] \package{arabluatex} provides a special
2187% environment for typesetting Arabic poetry. Every line in this 2232% environment for typesetting Arabic poetry. Every line in this
2188% environment must end with |\\|. 2233% environment must end with |\\|.
2189% 2234%
@@ -2246,13 +2291,13 @@
2246% 2291%
2247% \DescribeOption{color} |color|$=$\meta{color name} 2292% \DescribeOption{color} |color|$=$\meta{color name}
2248% \hfill\tcboxverb{Default: not set}\\ 2293% \hfill\tcboxverb{Default: not set}\\
2249% \NEWfeature{v1.13} The color in which lines of poetry are to be 2294% \newfeature[v1.13] The color in which lines of poetry are to be
2250% rendered. 2295% rendered.
2251% 2296%
2252% \label{ref:poetry-export} 2297% \label{ref:poetry-export}
2253% \DescribeOption{export} |export|$=$|true|\verb+|+|false| 2298% \DescribeOption{export} |export|$=$|true|\verb+|+|false|
2254% \hfill\tcboxverb{Default: false}\\ 2299% \hfill\tcboxverb{Default: false}\\
2255% \NEWfeature{v.1.13} This named argument does not need a value as it 2300% \newfeature[v.1.13] This named argument does not need a value as it
2256% defaults to |true| if it is used. If |export| is set as a global 2301% defaults to |true| if it is used. If |export| is set as a global
2257% option as well (see above \vpageref{export-mode}), all the lines 2302% option as well (see above \vpageref{export-mode}), all the lines
2258% will be converted to Unicode and exported to the external selected 2303% will be converted to Unicode and exported to the external selected
@@ -2372,7 +2417,7 @@
2372% 2417%
2373% \DescribeMacro{\StretchBayt} \cs{StretchBayt}\verb+[true|false]+ 2418% \DescribeMacro{\StretchBayt} \cs{StretchBayt}\verb+[true|false]+
2374% \hfill\tcboxverb{Default: true}\\ 2419% \hfill\tcboxverb{Default: true}\\
2375% \NEWfeature{v1.20} \cs{StretchBayt} takes one optional argument, 2420% \newfeature[v1.20] \cs{StretchBayt} takes one optional argument,
2376% either |true| or |false| and can be used to remove the stretching 2421% either |true| or |false| and can be used to remove the stretching
2377% form lines of Arabic poetry. As a side effect, there will be more 2422% form lines of Arabic poetry. As a side effect, there will be more
2378% space between words, but this can be compensated by inserting double 2423% space between words, but this can be compensated by inserting double
@@ -2577,7 +2622,7 @@
2577% 2622%
2578% \paragraph{Brackets} 2623% \paragraph{Brackets}
2579% \phantomsection 2624% \phantomsection
2580% \NEWfeature{v1.4.3} The various bracket symbols are useful in 2625% \newfeature[v1.4.3] The various bracket symbols are useful in
2581% technical documents such as critical editions for indicating that 2626% technical documents such as critical editions for indicating that
2582% some words or some letters must be added or 2627% some words or some letters must be added or
2583% removed. \package{arabluatex} will automatically fit those symbols 2628% removed. \package{arabluatex} will automatically fit those symbols
@@ -2615,14 +2660,14 @@
2615% \arb[trans]{\uc{qur'An}} or in classical poetry. 2660% \arb[trans]{\uc{qur'An}} or in classical poetry.
2616% 2661%
2617% \DescribeMacro{\arbmark} 2662% \DescribeMacro{\arbmark}
2618% \NEWfeature{v1.11}\cs{arbmark}\oarg{rl\textbar{}lr}\marg{shorthand} 2663% \newfeature[v1.11]\cs{arbmark}\oarg{rl\textbar{}lr}\marg{shorthand}
2619% can be used to insert such characters either in Unicode or in 2664% can be used to insert such characters either in Unicode or in
2620% romanized Arabic environments. It takes as argument a shorthand 2665% romanized Arabic environments. It takes as argument a shorthand
2621% defined beforehand in a default list which consists of the following 2666% defined beforehand in a default list which consists of the following
2622% at the time of writing:---\\ 2667% at the time of writing:---\\
2623% \begin{longtable}{llp{.3\linewidth}p{.3\linewidth}} 2668% \begin{longtable}{llp{.3\linewidth}p{.3\linewidth}}
2624% \bottomrule 2669% \bottomrule
2625% \caption*{\Cref*{tab:arabtex-additional-marks}: Additional Arabic 2670% \caption*{\Vref{tab:arabtex-additional-marks}: Additional Arabic
2626% marks} 2671% marks}
2627% \endfoot 2672% \endfoot
2628% \captionlistentry{Additional Arabic marks}\\[-1em] 2673% \captionlistentry{Additional Arabic marks}\\[-1em]
@@ -2639,12 +2684,12 @@
2639% |FDFB| & |jalla| & \arb{\arbmark{jalla}} & \arbmark{jalla} \\ 2684% |FDFB| & |jalla| & \arb{\arbmark{jalla}} & \arbmark{jalla} \\
2640% \end{longtable} 2685% \end{longtable}
2641% 2686%
2642% \NEWfeature{v1.13} 2687% \newfeature[v1.13]
2643% The mark to be inserted is determined by contextual analysis, or by 2688% The mark to be inserted is determined by contextual analysis, or by
2644% an optional argument, either |rl| to have the Arabic glyph printed, 2689% an optional argument, either |rl| to have the Arabic glyph printed,
2645% or |lr| to print the tranliterated equivalent. 2690% or |lr| to print the tranliterated equivalent.
2646% 2691%
2647% \DescribeMacro{\newarbmark} \NEWfeature{v1.11} \cs{newarbmark} is 2692% \DescribeMacro{\newarbmark} \newfeature[v1.11] \cs{newarbmark} is
2648% also provided should one wish to define new marks in addition to the 2693% also provided should one wish to define new marks in addition to the
2649% marks defined above. This command takes three arguments, like so:--- 2694% marks defined above. This command takes three arguments, like so:---
2650% \arabluabox{\cs{newarbmark}\marg{shorthand}\marg{RTL 2695% \arabluabox{\cs{newarbmark}\marg{shorthand}\marg{RTL
@@ -2712,7 +2757,7 @@
2712% character (\texttt{U+200D})}% 2757% character (\texttt{U+200D})}%
2713% {The ‘Zero width joiner’ character (\texttt{U+200D})}} 2758% {The ‘Zero width joiner’ character (\texttt{U+200D})}}
2714% \phantomsection% 2759% \phantomsection%
2715% \NEWfeature{v1.18}% 2760% \newfeature[v1.18]%
2716% The \enquote*{Zero width joiner} character (|U+200D|) belongs to the 2761% The \enquote*{Zero width joiner} character (|U+200D|) belongs to the
2717% \enquote*{General Punctuation} block (range |2000|--|206F|) of the 2762% \enquote*{General Punctuation} block (range |2000|--|206F|) of the
2718% Unicode standard. It is a non-printing character which, when it is 2763% Unicode standard. It is a non-printing character which, when it is
@@ -2754,7 +2799,7 @@
2754% new Arabic modes will be available as \package{arabluatex} will 2799% new Arabic modes will be available as \package{arabluatex} will
2755% mature. 2800% mature.
2756% 2801%
2757% \DescribeMacro{\ayah}\NEWfeature{v1.15}For the time being, 2802% \DescribeMacro{\ayah}\newfeature[v1.15]For the time being,
2758% \cs{ayah}\marg{3-digit number} is provided so as to typeset the 2803% \cs{ayah}\marg{3-digit number} is provided so as to typeset the
2759% number of the \arb[trans]{'AyaT} that it is referred to inside the 2804% number of the \arb[trans]{'AyaT} that it is referred to inside the
2760% dedicated mark---Unicode |U+06DD|: \txarb{^^^^06dd}---in Arabic 2805% dedicated mark---Unicode |U+06DD|: \txarb{^^^^06dd}---in Arabic
@@ -2810,7 +2855,7 @@
2810% 2855%
2811% \section{Color} 2856% \section{Color}
2812% \label{sec:color} 2857% \label{sec:color}
2813% \NEWfeature{v1.12}\package{arabluatex} is able to render in color 2858% \newfeature[v1.12]\package{arabluatex} is able to render in color
2814% either words, parts of words or diacritics. As the techniques 2859% either words, parts of words or diacritics. As the techniques
2815% implemented in this section may lead to some complexity, the reader 2860% implemented in this section may lead to some complexity, the reader
2816% should first become well acquainted with the following 2861% should first become well acquainted with the following
@@ -2891,13 +2936,13 @@
2891% applying colors to bare diacritics requires them to have specific 2936% applying colors to bare diacritics requires them to have specific
2892% encodings. 2937% encodings.
2893% 2938%
2894% \Cref{tab:arbcolor-diacritics} gives the Arab\TeX\ equivalents for 2939% \Vref{tab:arbcolor-diacritics} gives the Arab\TeX\ equivalents for
2895% the diacritics to be printed inside or just after \cs{arbcolor}. 2940% the diacritics to be printed inside or just after \cs{arbcolor}.
2896% 2941%
2897% \needspace{7\baselineskip} 2942% \needspace{7\baselineskip}
2898% \begin{longtable}{lllll} 2943% \begin{longtable}{lllll}
2899% \bottomrule 2944% \bottomrule
2900% \caption*{\Cref*{tab:arbcolor-diacritics}: Arab\TeX\ diacritics 2945% \caption*{\Vref{tab:arbcolor-diacritics}: Arab\TeX\ diacritics
2901% for \cs{arbcolor}} 2946% for \cs{arbcolor}}
2902% \endfoot 2947% \endfoot
2903% \captionlistentry{Arab\TeX\ diacritics for \cs{arbcolor}}\\[-1em] 2948% \captionlistentry{Arab\TeX\ diacritics for \cs{arbcolor}}\\[-1em]
@@ -3144,7 +3189,7 @@
3144% \label{sec:transliteration} 3189% \label{sec:transliteration}
3145% It may be more appropriate to speak of \enquote{romanization} than 3190% It may be more appropriate to speak of \enquote{romanization} than
3146% \enquote{transliteration} of Arabic. As seen above in 3191% \enquote{transliteration} of Arabic. As seen above in
3147% \cref{sec:options} \vpagerefrange{sec:options}{sec:local-options}, 3192% \vref{sec:options} \vpagerefrange{sec:options}{sec:local-options},
3148% the \enquote{transliteration mode} may be selected globally or locally. 3193% the \enquote{transliteration mode} may be selected globally or locally.
3149% 3194%
3150% This mode transliterates the Arab\TeX\ input into one of the 3195% This mode transliterates the Arab\TeX\ input into one of the
@@ -3162,7 +3207,7 @@
3162% \url{http://www.loc.gov/catdir/cpso/roman.html} for the 3207% \url{http://www.loc.gov/catdir/cpso/roman.html} for the
3163% \href{http://www.loc.gov/catdir/cpso/romanization/arabic.pdf}{source 3208% \href{http://www.loc.gov/catdir/cpso/romanization/arabic.pdf}{source
3164% document concerning Arabic language}.} 3209% document concerning Arabic language}.}
3165% \item[arabica] \NEWfeature{v1.8} 3210% \item[arabica] \newfeature[v1.8]
3166% \changes{v1.8}{2017/03/30}{\texttt{arabica} transliteration 3211% \changes{v1.8}{2017/03/30}{\texttt{arabica} transliteration
3167% standard is now supported} \emph{Journal of Arabic and Islamic 3212% standard is now supported} \emph{Journal of Arabic and Islamic
3168% Studies}/\emph{Revue d'études arabes et islamiques}: this standard 3213% Studies}/\emph{Revue d'études arabes et islamiques}: this standard
@@ -3198,7 +3243,7 @@
3198% command, where \meta{style} may be any font shape selection 3243% command, where \meta{style} may be any font shape selection
3199% command, e.g. \cs{upshape}, \cs{itshape}, \cs{slshape}, and so forth. 3244% command, e.g. \cs{upshape}, \cs{itshape}, \cs{slshape}, and so forth.
3200% 3245%
3201% \paragraph{Font} \NEWfeature{v1.4} \DescribeMacro{\SetTranslitFont} 3246% \paragraph{Font} \newfeature[v1.4] \DescribeMacro{\SetTranslitFont}
3202% \cs{SetTranslitFont}\marg{font selection command} allows any 3247% \cs{SetTranslitFont}\marg{font selection command} allows any
3203% specific font to be selected for rendering transliterated text with 3248% specific font to be selected for rendering transliterated text with
3204% the font-selecting commands of the \package{fontspec} or 3249% the font-selecting commands of the \package{fontspec} or
@@ -3270,7 +3315,7 @@
3270% 3315%
3271% \paragraph{\texorpdfstring{\enquote*{Long} pro\-per 3316% \paragraph{\texorpdfstring{\enquote*{Long} pro\-per
3272% names}{‘Long’ proper names}} 3317% names}{‘Long’ proper names}}
3273% \NEWfeature{v1.10} \cs{uc} is also able to process proper names 3318% \newfeature[v1.10] \cs{uc} is also able to process proper names
3274% consisting of several subsequent words:--- 3319% consisting of several subsequent words:---
3275% \begin{quote} 3320% \begin{quote}
3276% |\arb[trans]{\uc{'abU| |zaydiN| |.hunaynu| |bnu| |'is.h_aqa| 3321% |\arb[trans]{\uc{'abU| |zaydiN| |.hunaynu| |bnu| |'is.h_aqa|
@@ -3280,7 +3325,7 @@
3280% 3325%
3281% \paragraph{Proper names outside Arabic environments} 3326% \paragraph{Proper names outside Arabic environments}
3282% \changes{v1.10}{2018/01/03}{\cs{uc} supersedes \cs{cap}} 3327% \changes{v1.10}{2018/01/03}{\cs{uc} supersedes \cs{cap}}
3283% \DescribeMacro{\prname}\NEWfeature{v1.10} Transliterated proper 3328% \DescribeMacro{\prname}\newfeature[v1.10] Transliterated proper
3284% names inserted in paragraphs of English text should be printed in 3329% names inserted in paragraphs of English text should be printed in
3285% the same typeface as the surrounding text. \cs{prname}\marg{Arabic 3330% the same typeface as the surrounding text. \cs{prname}\marg{Arabic
3286% proper name} is provided to that effect:\footnote{Just as \cs{uc}, 3331% proper name} is provided to that effect:\footnote{Just as \cs{uc},
@@ -3335,7 +3380,7 @@
3335% 3380%
3336% \subsection{Additional note on \texttt{dmg} convention} 3381% \subsection{Additional note on \texttt{dmg} convention}
3337% \label{sec:additional-note-dmg} 3382% \label{sec:additional-note-dmg}
3338% \NEWfeature{v1.3} According to \textcite[6]{dmg}, Arabic 3383% \newfeature[v1.3] According to \textcite[6]{dmg}, Arabic
3339% \arb[trans]{'i`rAb} may be rendered into |dmg| in three different 3384% \arb[trans]{'i`rAb} may be rendered into |dmg| in three different
3340% ways: 3385% ways:
3341% \begin{enumerate} 3386% \begin{enumerate}
@@ -3518,7 +3563,7 @@
3518% 3563%
3519% \section{Buckwalter input scheme} 3564% \section{Buckwalter input scheme}
3520% \label{sec:buckwalter-scheme} 3565% \label{sec:buckwalter-scheme}
3521% \NEWfeature{v1.4} Even though \package{arabluatex} is primarily 3566% \newfeature[v1.4] Even though \package{arabluatex} is primarily
3522% designed to process the Arab\TeX\ notation, it can also process the 3567% designed to process the Arab\TeX\ notation, it can also process the
3523% Buckwalter input scheme to a large extent.\footnote{See 3568% Buckwalter input scheme to a large extent.\footnote{See
3524% \url{http://www.qamus.org/transliteration.htm}} The Buckwalter 3569% \url{http://www.qamus.org/transliteration.htm}} The Buckwalter
@@ -3561,7 +3606,7 @@
3561% It is therefore recommended to use the Buckwalter \enquote*{safe} 3606% It is therefore recommended to use the Buckwalter \enquote*{safe}
3562% scheme. 3607% scheme.
3563% 3608%
3564% \Cref{tab:buckwalter-scheme} gives the Buckwalter equivalents that 3609% \Vref{tab:buckwalter-scheme} gives the Buckwalter equivalents that
3565% are currently used by \package{arabluatex}. The additional 3610% are currently used by \package{arabluatex}. The additional
3566% characters that are defined in \vref{tab:additional-arabic-codings} 3611% characters that are defined in \vref{tab:additional-arabic-codings}
3567% are also available. 3612% are also available.
@@ -3569,7 +3614,7 @@
3569% \enlargethispage{\baselineskip} 3614% \enlargethispage{\baselineskip}
3570% \begin{longtable}{llllll} 3615% \begin{longtable}{llllll}
3571% \bottomrule 3616% \bottomrule
3572% \caption*{\Cref*{tab:buckwalter-scheme}: Buckwalter scheme} 3617% \caption*{\Vref{tab:buckwalter-scheme}: Buckwalter scheme}
3573% \endfoot 3618% \endfoot
3574% \captionlistentry{Buckwalter scheme}\\[-1em] 3619% \captionlistentry{Buckwalter scheme}\\[-1em]
3575% \toprule 3620% \toprule
@@ -3678,7 +3723,7 @@
3678% 3723%
3679% \section{Unicode Arabic input} 3724% \section{Unicode Arabic input}
3680% \label{sec:unicode-input} 3725% \label{sec:unicode-input}
3681% \NEWfeature{v1.5} As said above in \vref{sec:buckwalter-scheme} 3726% \newfeature[v1.5] As said above in \vref{sec:buckwalter-scheme}
3682% about the Buckwalter input scheme, even though \package{arabluatex} 3727% about the Buckwalter input scheme, even though \package{arabluatex}
3683% is primarily designed to process the Arab\TeX\ notation, it also 3728% is primarily designed to process the Arab\TeX\ notation, it also
3684% accepts Unicode Arabic input. It should be noted that 3729% accepts Unicode Arabic input. It should be noted that
@@ -3838,7 +3883,7 @@
3838% 3883%
3839% \subsection{New commands} 3884% \subsection{New commands}
3840% \label{sec:declare-new-commands} 3885% \label{sec:declare-new-commands}
3841% \NEWfeature{v1.9}% 3886% \newfeature[v1.9]%
3842% In some particular cases, it may be useful to define new commands to 3887% In some particular cases, it may be useful to define new commands to
3843% be inserted in Arabic environments. From the general principle laid 3888% be inserted in Arabic environments. From the general principle laid
3844% \vpageref{ref:cmd-inside-arabic}, it follows that any command that 3889% \vpageref{ref:cmd-inside-arabic}, it follows that any command that
@@ -3884,7 +3929,7 @@
3884% of commands declared with \cs{MkArbBreak} are not to be processed by 3929% of commands declared with \cs{MkArbBreak} are not to be processed by
3885% \package{arabluatex}. Therefore, as in the previous example, any of 3930% \package{arabluatex}. Therefore, as in the previous example, any of
3886% their argument to be rendered in Arabic must be inserted again in 3931% their argument to be rendered in Arabic must be inserted again in
3887% \cs{arb}. \NEWfeature{v1.12}These commands themselves may have up to 3932% \cs{arb}. \newfeature[v1.12]These commands themselves may have up to
3888% two optional and/or mandatory arguments followed by one optional 3933% two optional and/or mandatory arguments followed by one optional
3889% argument, like so:--- 3934% argument, like so:---
3890% \begin{enumerate} 3935% \begin{enumerate}
@@ -3900,7 +3945,7 @@
3900% (uppermost combination) 3945% (uppermost combination)
3901% \end{enumerate} 3946% \end{enumerate}
3902% 3947%
3903% \DescribeMacro{\MkArbBreak*}\NEWfeature{v1.12} As said above, 3948% \DescribeMacro{\MkArbBreak*}\newfeature[v1.12] As said above,
3904% \cs{MkArbBreak} prevents \package{arabluatex} from processing the 3949% \cs{MkArbBreak} prevents \package{arabluatex} from processing the
3905% arguments of \enquote*{declared} commands as Arabic text. This 3950% arguments of \enquote*{declared} commands as Arabic text. This
3906% technique proves sufficient in most cases. However, a 3951% technique proves sufficient in most cases. However, a
@@ -3927,7 +3972,7 @@
3927% \label{sec:environments} 3972% \label{sec:environments}
3928% \changes{v1.5}{2016/11/14}{Environments may be nested inside the 3973% \changes{v1.5}{2016/11/14}{Environments may be nested inside the
3929% \texttt{arab} environment} 3974% \texttt{arab} environment}
3930% \NEWfeature{v1.5} Environments such as 3975% \newfeature[v1.5] Environments such as
3931% \tcboxverb{\begin{quote} ... \end{quote}} may be nested inside the 3976% \tcboxverb{\begin{quote} ... \end{quote}} may be nested inside the
3932% |arab| environment. Up to one optional argument may be passed to 3977% |arab| environment. Up to one optional argument may be passed to
3933% each nested environment, like so:--- 3978% each nested environment, like so:---
@@ -4242,7 +4287,7 @@
4242% 4287%
4243% \section{Exporting Unicode Arabic to an external file} 4288% \section{Exporting Unicode Arabic to an external file}
4244% \label{sec:arabtex2utf} 4289% \label{sec:arabtex2utf}
4245% \NEWfeature{v.1.13}\package{arabluatex} is able to produce a 4290% \newfeature[v.1.13]\package{arabluatex} is able to produce a
4246% duplicate of the original |.tex| source file in which all |arabtex| 4291% duplicate of the original |.tex| source file in which all |arabtex|
4247% or |buckwalter| strings will have been replaced with Unicode 4292% or |buckwalter| strings will have been replaced with Unicode
4248% equivalents, either in Arabic script or in any accepted standard of 4293% equivalents, either in Arabic script or in any accepted standard of
@@ -4422,6 +4467,546 @@
4422% \end{enumerate} 4467% \end{enumerate}
4423% \end{enumerate} 4468% \end{enumerate}
4424% 4469%
4470% \section{GNU Free Documentation License}
4471% \label{sec:fdl}
4472% \textbf{Version 1.3, 3 November 2008}
4473%
4474% \begin{center}
4475% Version 1.3, 3 November 2008
4476%
4477% Copyright \copyright{} 2000, 2001, 2002, 2007, 2008 Free
4478% Software Foundation, Inc.
4479%
4480% \bigskip
4481%
4482% \url{https://fsf.org/}
4483%
4484% \bigskip
4485%
4486% Everyone is permitted to copy and distribute verbatim copies
4487% of this license document, but changing it is not allowed.
4488% \end{center}
4489%
4490% \needspace{3\baselineskip}
4491% \begin{center}
4492% {\bf\large Preamble}
4493% \end{center}
4494%
4495% The purpose of this License is to make a manual, textbook, or other
4496% functional and useful document \enquote{free} in the sense of
4497% freedom: to assure everyone the effective freedom to copy and
4498% redistribute it, with or without modifying it, either commercially
4499% or noncommercially. Secondarily, this License preserves for the
4500% author and publisher a way to get credit for their work, while not
4501% being considered responsible for modifications made by others.
4502%
4503% This License is a kind of \enquote{copyleft}, which means that
4504% derivative works of the document must themselves be free in the same
4505% sense. It complements the GNU General Public License, which is a
4506% copyleft license designed for free software.
4507%
4508% We have designed this License in order to use it for manuals for
4509% free software, because free software needs free documentation: a
4510% free program should come with manuals providing the same freedoms
4511% that the software does. But this License is not limited to software
4512% manuals; it can be used for any textual work, regardless of subject
4513% matter or whether it is published as a printed book. We recommend
4514% this License principally for works whose purpose is instruction or
4515% reference.
4516%
4517% \needspace{3\baselineskip}
4518% \begin{center}
4519% {\large\bf 1. APPLICABILITY AND DEFINITIONS\par}
4520% \end{center}
4521%
4522% This License applies to any manual or other work, in any medium,
4523% that contains a notice placed by the copyright holder saying it can
4524% be distributed under the terms of this License. Such a notice
4525% grants a world-wide, royalty-free license, unlimited in duration, to
4526% use that work under the conditions stated herein. The
4527% \enquote{\textbf{Document}}, below, refers to any such manual or
4528% work. Any member of the public is a licensee, and is addressed as
4529% \enquote{\textbf{you}}. You accept the license if you copy, modify
4530% or distribute the work in a way requiring permission under copyright
4531% law.
4532%
4533% A \enquote{\textbf{Modified Version}} of the Document means any work
4534% containing the Document or a portion of it, either copied verbatim,
4535% or with modifications and/or translated into another language.
4536%
4537% A \enquote{\textbf{Secondary Section}} is a named appendix or a
4538% front-matter section of the Document that deals exclusively with the
4539% relationship of the publishers or authors of the Document to the
4540% Document's overall subject (or to related matters) and contains
4541% nothing that could fall directly within that overall subject.
4542% (Thus, if the Document is in part a textbook of mathematics, a
4543% Secondary Section may not explain any mathematics.) The
4544% relationship could be a matter of historical connection with the
4545% subject or with related matters, or of legal, commercial,
4546% philosophical, ethical or political position regarding them.
4547%
4548% The \enquote{\textbf{Invariant Sections}} are certain Secondary
4549% Sections whose titles are designated, as being those of Invariant
4550% Sections, in the notice that says that the Document is released
4551% under this License. If a section does not fit the above definition
4552% of Secondary then it is not allowed to be designated as Invariant.
4553% The Document may contain zero Invariant Sections. If the Document
4554% does not identify any Invariant Sections then there are none.
4555%
4556% The \enquote{\textbf{Cover Texts}} are certain short passages of
4557% text that are listed, as Front-Cover Texts or Back-Cover Texts, in
4558% the notice that says that the Document is released under this
4559% License. A Front-Cover Text may be at most 5 words, and a
4560% Back-Cover Text may be at most 25 words.
4561%
4562% A \enquote{\textbf{Transparent}} copy of the Document means a
4563% machine-readable copy, represented in a format whose specification
4564% is available to the general public, that is suitable for revising
4565% the document straightforwardly with generic text editors or (for
4566% images composed of pixels) generic paint programs or (for drawings)
4567% some widely available drawing editor, and that is suitable for input
4568% to text formatters or for automatic translation to a variety of
4569% formats suitable for input to text formatters. A copy made in an
4570% otherwise Transparent file format whose markup, or absence of
4571% markup, has been arranged to thwart or discourage subsequent
4572% modification by readers is not Transparent. An image format is not
4573% Transparent if used for any substantial amount of text. A copy that
4574% is not \enquote{Transparent} is called \enquote{\textbf{Opaque}}.
4575%
4576% Examples of suitable formats for Transparent copies include plain
4577% ASCII without markup, Texinfo input format, LaTeX input format, SGML
4578% or XML using a publicly available DTD, and standard-conforming
4579% simple HTML, PostScript or PDF designed for human modification.
4580% Examples of transparent image formats include PNG, XCF and JPG.
4581% Opaque formats include proprietary formats that can be read and
4582% edited only by proprietary word processors, SGML or XML for which
4583% the DTD and/or processing tools are not generally available, and the
4584% machine-generated HTML, PostScript or PDF produced by some word
4585% processors for output purposes only.
4586%
4587% The \enquote{\textbf{Title Page}} means, for a printed book, the
4588% title page itself, plus such following pages as are needed to hold,
4589% legibly, the material this License requires to appear in the title
4590% page. For works in formats which do not have any title page as
4591% such, \enquote{Title Page} means the text near the most prominent
4592% appearance of the work's title, preceding the beginning of the body
4593% of the text.
4594%
4595% The \enquote{\textbf{publisher}} means any person or entity that
4596% distributes copies of the Document to the public.
4597%
4598% A section \enquote{\textbf{Entitled XYZ}} means a named subunit of
4599% the Document whose title either is precisely XYZ or contains XYZ in
4600% parentheses following text that translates XYZ in another language.
4601% (Here XYZ stands for a specific section name mentioned below, such
4602% as \enquote{\textbf{Acknowledgements}},
4603% \enquote{\textbf{Dedications}}, \enquote{\textbf{Endorsements}}, or
4604% \enquote{\textbf{History}}.) To \enquote{\textbf{Preserve the
4605% Title}} of such a section when you modify the Document means that it
4606% remains a section \enquote{Entitled XYZ} according to this
4607% definition.
4608%
4609% The Document may include Warranty Disclaimers next to the notice
4610% which states that this License applies to the Document. These
4611% Warranty Disclaimers are considered to be included by reference in
4612% this License, but only as regards disclaiming warranties: any other
4613% implication that these Warranty Disclaimers may have is void and has
4614% no effect on the meaning of this License.
4615%
4616% \needspace{3\baselineskip}
4617% \begin{center}
4618% {\large\bf 2. VERBATIM COPYING\par}
4619% \end{center}
4620%
4621% You may copy and distribute the Document in any medium, either
4622% commercially or noncommercially, provided that this License, the
4623% copyright notices, and the license notice saying this License
4624% applies to the Document are reproduced in all copies, and that you
4625% add no other conditions whatsoever to those of this License. You
4626% may not use technical measures to obstruct or control the reading or
4627% further copying of the copies you make or distribute. However, you
4628% may accept compensation in exchange for copies. If you distribute a
4629% large enough number of copies you must also follow the conditions in
4630% section~3.
4631%
4632% You may also lend copies, under the same conditions stated above,
4633% and you may publicly display copies.
4634%
4635% \needspace{3\baselineskip}
4636% \begin{center}
4637% {\large\bf 3. COPYING IN QUANTITY\par}
4638% \end{center}
4639%
4640% If you publish printed copies (or copies in media that commonly have
4641% printed covers) of the Document, numbering more than 100, and the
4642% Document's license notice requires Cover Texts, you must enclose the
4643% copies in covers that carry, clearly and legibly, all these Cover
4644% Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on
4645% the back cover. Both covers must also clearly and legibly identify
4646% you as the publisher of these copies. The front cover must present
4647% the full title with all words of the title equally prominent and
4648% visible. You may add other material on the covers in addition.
4649% Copying with changes limited to the covers, as long as they preserve
4650% the title of the Document and satisfy these conditions, can be
4651% treated as verbatim copying in other respects.
4652%
4653% If the required texts for either cover are too voluminous to fit
4654% legibly, you should put the first ones listed (as many as fit
4655% reasonably) on the actual cover, and continue the rest onto adjacent
4656% pages.
4657%
4658% If you publish or distribute Opaque copies of the Document numbering
4659% more than 100, you must either include a machine-readable
4660% Transparent copy along with each Opaque copy, or state in or with
4661% each Opaque copy a computer-network location from which the general
4662% network-using public has access to download using public-standard
4663% network protocols a complete Transparent copy of the Document, free
4664% of added material. If you use the latter option, you must take
4665% reasonably prudent steps, when you begin distribution of Opaque
4666% copies in quantity, to ensure that this Transparent copy will remain
4667% thus accessible at the stated location until at least one year after
4668% the last time you distribute an Opaque copy (directly or through
4669% your agents or retailers) of that edition to the public.
4670%
4671% It is requested, but not required, that you contact the authors of
4672% the Document well before redistributing any large number of copies,
4673% to give them a chance to provide you with an updated version of the
4674% Document.
4675%
4676% \needspace{3\baselineskip}
4677% \begin{center}
4678% {\large\bf 4. MODIFICATIONS\par}
4679% \end{center}
4680%
4681% You may copy and distribute a Modified Version of the Document under
4682% the conditions of sections 2 and 3 above, provided that you release
4683% the Modified Version under precisely this License, with the Modified
4684% Version filling the role of the Document, thus licensing
4685% distribution and modification of the Modified Version to whoever
4686% possesses a copy of it. In addition, you must do these things in
4687% the Modified Version:
4688%
4689% \begin{itemize}
4690% \item[A.] Use in the Title Page (and on the covers, if any) a title
4691% distinct from that of the Document, and from those of previous
4692% versions (which should, if there were any, be listed in the
4693% History section of the Document). You may use the same title as a
4694% previous version if the original publisher of that version gives
4695% permission.
4696%
4697% \item[B.] List on the Title Page, as authors, one or more persons
4698% or entities responsible for authorship of the modifications in
4699% the Modified Version, together with at least five of the
4700% principal authors of the Document (all of its principal authors,
4701% if it has fewer than five), unless they release you from this
4702% requirement.
4703%
4704% \item[C.] State on the Title page the name of the publisher of the
4705% Modified Version, as the publisher.
4706%
4707% \item[D.] Preserve all the copyright notices of the Document.
4708%
4709% \item[E.] Add an appropriate copyright notice for your
4710% modifications adjacent to the other copyright notices.
4711%
4712% \item[F.] Include, immediately after the copyright notices, a
4713% license notice giving the public permission to use the Modified
4714% Version under the terms of this License, in the form shown in the
4715% Addendum below.
4716%
4717% \item[G.] Preserve in that license notice the full lists of
4718% Invariant Sections and required Cover Texts given in the
4719% Document's license notice.
4720%
4721% \item[H.] Include an unaltered copy of this License.
4722%
4723% \item[I.] Preserve the section Entitled \enquote{History},
4724% Preserve its Title, and add to it an item stating at least the
4725% title, year, new authors, and publisher of the Modified Version
4726% as given on the Title Page. If there is no section Entitled
4727% \enquote{History} in the Document, create one stating the title,
4728% year, authors, and publisher of the Document as given on its
4729% Title Page, then add an item describing the Modified Version as
4730% stated in the previous sentence.
4731%
4732% \item[J.] Preserve the network location, if any, given in the
4733% Document for public access to a Transparent copy of the Document,
4734% and likewise the network locations given in the Document for
4735% previous versions it was based on. These may be placed in the
4736% \enquote{History} section. You may omit a network location for a
4737% work that was published at least four years before the Document
4738% itself, or if the original publisher of the version it refers to
4739% gives permission.
4740%
4741% \item[K.] For any section Entitled \enquote{Acknowledgements} or
4742% \enquote{Dedications}, Preserve the Title of the section, and
4743% preserve in the section all the substance and tone of each of the
4744% contributor acknowledgements and/or dedications given therein.
4745%
4746% \item[L.] Preserve all the Invariant Sections of the Document,
4747% unaltered in their text and in their titles. Section numbers or
4748% the equivalent are not considered part of the section titles.
4749%
4750% \item[M.] Delete any section Entitled \enquote{Endorsements}.
4751% Such a section may not be included in the Modified Version.
4752%
4753% \item[N.] Do not retitle any existing section to be Entitled
4754% \enquote{Endorsements} or to conflict in title with any Invariant
4755% Section.
4756%
4757% \item[O.] Preserve any Warranty Disclaimers.
4758% \end{itemize}
4759%
4760% If the Modified Version includes new front-matter sections or
4761% appendices that qualify as Secondary Sections and contain no
4762% material copied from the Document, you may at your option designate
4763% some or all of these sections as invariant. To do this, add their
4764% titles to the list of Invariant Sections in the Modified Version's
4765% license notice. These titles must be distinct from any other
4766% section titles.
4767%
4768% You may add a section Entitled \enquote{Endorsements}, provided it
4769% contains nothing but endorsements of your Modified Version by
4770% various parties---for example, statements of peer review or that the
4771% text has been approved by an organization as the authoritative
4772% definition of a standard.
4773%
4774% You may add a passage of up to five words as a Front-Cover Text, and
4775% a passage of up to 25 words as a Back-Cover Text, to the end of the
4776% list of Cover Texts in the Modified Version. Only one passage of
4777% Front-Cover Text and one of Back-Cover Text may be added by (or
4778% through arrangements made by) any one entity. If the Document
4779% already includes a cover text for the same cover, previously added
4780% by you or by arrangement made by the same entity you are acting on
4781% behalf of, you may not add another; but you may replace the old one,
4782% on explicit permission from the previous publisher that added the
4783% old one.
4784%
4785% The author(s) and publisher(s) of the Document do not by this
4786% License give permission to use their names for publicity for or to
4787% assert or imply endorsement of any Modified Version.
4788%
4789% \needspace{3\baselineskip}
4790% \begin{center}
4791% {\large\bf 5. COMBINING DOCUMENTS\par}
4792% \end{center}
4793%
4794% You may combine the Document with other documents released under
4795% this License, under the terms defined in section~4 above for
4796% modified versions, provided that you include in the combination all
4797% of the Invariant Sections of all of the original documents,
4798% unmodified, and list them all as Invariant Sections of your combined
4799% work in its license notice, and that you preserve all their Warranty
4800% Disclaimers.
4801%
4802% The combined work need only contain one copy of this License, and
4803% multiple identical Invariant Sections may be replaced with a single
4804% copy. If there are multiple Invariant Sections with the same name
4805% but different contents, make the title of each such section unique
4806% by adding at the end of it, in parentheses, the name of the original
4807% author or publisher of that section if known, or else a unique
4808% number. Make the same adjustment to the section titles in the list
4809% of Invariant Sections in the license notice of the combined work.
4810%
4811% In the combination, you must combine any sections Entitled
4812% \enquote{History} in the various original documents, forming one
4813% section Entitled \enquote{History}; likewise combine any sections
4814% Entitled \enquote{Acknowledgements}, and any sections Entitled
4815% \enquote{Dedications}. You must delete all sections Entitled
4816% \enquote{Endorsements}.
4817%
4818% \needspace{3\baselineskip}
4819% \begin{center}
4820% {\large\bf 6. COLLECTIONS OF DOCUMENTS\par}
4821% \end{center}
4822%
4823% You may make a collection consisting of the Document and other
4824% documents released under this License, and replace the individual
4825% copies of this License in the various documents with a single copy
4826% that is included in the collection, provided that you follow the
4827% rules of this License for verbatim copying of each of the documents
4828% in all other respects.
4829%
4830% You may extract a single document from such a collection, and
4831% distribute it individually under this License, provided you insert a
4832% copy of this License into the extracted document, and follow this
4833% License in all other respects regarding verbatim copying of that
4834% document.
4835%
4836% \needspace{3\baselineskip}
4837% \begin{center}
4838% {\large\bf 7. AGGREGATION WITH INDEPENDENT WORKS\par}
4839% \end{center}
4840%
4841% A compilation of the Document or its derivatives with other separate
4842% and independent documents or works, in or on a volume of a storage
4843% or distribution medium, is called an \enquote{aggregate} if the
4844% copyright resulting from the compilation is not used to limit the
4845% legal rights of the compilation's users beyond what the individual
4846% works permit. When the Document is included in an aggregate, this
4847% License does not apply to the other works in the aggregate which are
4848% not themselves derivative works of the Document.
4849%
4850% If the Cover Text requirement of section~3 is applicable to these
4851% copies of the Document, then if the Document is less than one half
4852% of the entire aggregate, the Document's Cover Texts may be placed on
4853% covers that bracket the Document within the aggregate, or the
4854% electronic equivalent of covers if the Document is in electronic
4855% form. Otherwise they must appear on printed covers that bracket the
4856% whole aggregate.
4857%
4858% \needspace{3\baselineskip}
4859% \begin{center}
4860% {\large\bf 8. TRANSLATION\par}
4861% \end{center}
4862%
4863% Translation is considered a kind of modification, so you may
4864% distribute translations of the Document under the terms of
4865% section~4. Replacing Invariant Sections with translations requires
4866% special permission from their copyright holders, but you may include
4867% translations of some or all Invariant Sections in addition to the
4868% original versions of these Invariant Sections. You may include a
4869% translation of this License, and all the license notices in the
4870% Document, and any Warranty Disclaimers, provided that you also
4871% include the original English version of this License and the
4872% original versions of those notices and disclaimers. In case of a
4873% disagreement between the translation and the original version of
4874% this License or a notice or disclaimer, the original version will
4875% prevail.
4876%
4877% If a section in the Document is Entitled \enquote{Acknowledgements},
4878% \enquote{Dedications}, or \enquote{History}, the requirement
4879% (section~4) to Preserve its Title (section~1) will typically require
4880% changing the actual title.
4881%
4882% \needspace{3\baselineskip}
4883% \begin{center}
4884% {\large\bf 9. TERMINATION\par}
4885% \end{center}
4886%
4887% You may not copy, modify, sublicense, or distribute the Document
4888% except as expressly provided under this License. Any attempt
4889% otherwise to copy, modify, sublicense, or distribute it is void, and
4890% will automatically terminate your rights under this License.
4891%
4892% However, if you cease all violation of this License, then your
4893% license from a particular copyright holder is reinstated (a)
4894% provisionally, unless and until the copyright holder explicitly and
4895% finally terminates your license, and (b) permanently, if the
4896% copyright holder fails to notify you of the violation by some
4897% reasonable means prior to 60 days after the cessation.
4898%
4899% Moreover, your license from a particular copyright holder is
4900% reinstated permanently if the copyright holder notifies you of the
4901% violation by some reasonable means, this is the first time you have
4902% received notice of violation of this License (for any work) from
4903% that copyright holder, and you cure the violation prior to 30 days
4904% after your receipt of the notice.
4905%
4906% Termination of your rights under this section does not terminate the
4907% licenses of parties who have received copies or rights from you
4908% under this License. If your rights have been terminated and not
4909% permanently reinstated, receipt of a copy of some or all of the same
4910% material does not give you any rights to use it.
4911%
4912% \needspace{3\baselineskip}
4913% \begin{center}
4914% {\large\bf 10. FUTURE REVISIONS OF THIS LICENSE\par}
4915% \end{center}
4916%
4917% The Free Software Foundation may publish new, revised versions of
4918% the GNU Free Documentation License from time to time. Such new
4919% versions will be similar in spirit to the present version, but may
4920% differ in detail to address new problems or concerns. See
4921% \url{https://www.gnu.org/licenses/}.
4922%
4923% Each version of the License is given a distinguishing version
4924% number. If the Document specifies that a particular numbered
4925% version of this License \enquote{or any later version} applies to
4926% it, you have the option of following the terms and conditions either
4927% of that specified version or of any later version that has been
4928% published (not as a draft) by the Free Software Foundation. If the
4929% Document does not specify a version number of this License, you may
4930% choose any version ever published (not as a draft) by the Free
4931% Software Foundation. If the Document specifies that a proxy can
4932% decide which future versions of this License can be used, that
4933% proxy's public statement of acceptance of a version permanently
4934% authorizes you to choose that version for the Document.
4935%
4936% \needspace{3\baselineskip}
4937% \begin{center}
4938% {\large\bf 11. RELICENSING\par}
4939% \end{center}
4940%
4941% \enquote{Massive Multiauthor Collaboration Site} (or \enquote{MMC
4942% Site}) means any World Wide Web server that publishes copyrightable
4943% works and also provides prominent facilities for anybody to edit
4944% those works. A public wiki that anybody can edit is an example of
4945% such a server. A \enquote{Massive Multiauthor Collaboration} (or
4946% \enquote{MMC}) contained in the site means any set of copyrightable
4947% works thus published on the MMC site.
4948%
4949% \enquote{CC-BY-SA} means the Creative Commons Attribution-Share
4950% Alike 3.0 license published by Creative Commons Corporation, a
4951% not-for-profit corporation with a principal place of business in San
4952% Francisco, California, as well as future copyleft versions of that
4953% license published by that same organization.
4954%
4955% \enquote{Incorporate} means to publish or republish a Document, in
4956% whole or in part, as part of another Document.
4957%
4958% An MMC is \enquote{eligible for relicensing} if it is licensed under
4959% this License, and if all works that were first published under this
4960% License somewhere other than this MMC, and subsequently incorporated
4961% in whole or in part into the MMC, (1) had no cover texts or
4962% invariant sections, and (2) were thus incorporated prior to November
4963% 1, 2008.
4964%
4965% The operator of an MMC Site may republish an MMC contained in the
4966% site under CC-BY-SA on the same site at any time before August 1,
4967% 2009, provided the MMC is eligible for relicensing.
4968%
4969% \needspace{3\baselineskip}
4970% \begin{center}
4971% {\large\bf ADDENDUM: How to use this License for your documents\par}
4972% \end{center}
4973%
4974% To use this License in a document you have written, include a copy
4975% of the License in the document and put the following copyright and
4976% license notices just after the title page:
4977%
4978% \bigskip
4979% \begin{quote}
4980% Copyright \copyright{} YEAR YOUR NAME. Permission is granted to
4981% copy, distribute and/or modify this document under the terms of
4982% the GNU Free Documentation License, Version 1.3 or any later
4983% version published by the Free Software Foundation; with no
4984% Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
4985% A copy of the license is included in the section entitled
4986% \enquote{GNU Free Documentation License}.
4987% \end{quote}
4988% \bigskip
4989%
4990% If you have Invariant Sections, Front-Cover Texts and Back-Cover
4991% Texts, replace the \enquote{with \dots\ Texts.}\ line with this:
4992%
4993% \bigskip
4994% \begin{quote}
4995% with the Invariant Sections being LIST THEIR TITLES, with the
4996% Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST.
4997% \end{quote}
4998% \bigskip
4999%
5000% If you have Invariant Sections without Cover Texts, or some other
5001% combination of the three, merge those two alternatives to suit the
5002% situation.
5003%
5004% If your document contains nontrivial examples of program code, we
5005% recommend releasing these examples in parallel under your choice of
5006% free software license, such as the GNU General Public License,
5007% to permit their use in free software.
5008%
5009%
4425% \StopEventually{} 5010% \StopEventually{}
4426% 5011%
4427% \section{Implementation} 5012% \section{Implementation}