aboutsummaryrefslogtreecommitdiff
path: root/arabluatex.dtx
diff options
context:
space:
mode:
authorRobert Alessi <alessi@robertalessi.net>2018-06-15 12:01:43 +0200
committerRobert Alessi <alessi@robertalessi.net>2018-06-15 12:01:43 +0200
commit429eb1e3b9149985e8fdef15e066b02ca8dfa24a (patch)
treefa117dda8502e35fa31b27a09edde3dae8d304bf /arabluatex.dtx
parentee2efa8348a6a853c496cead8082fc139448f41f (diff)
downloadarabluatex-429eb1e3b9149985e8fdef15e066b02ca8dfa24a.tar.gz
documenting the new features. added \arbcolor[]{} in .el style file
Diffstat (limited to 'arabluatex.dtx')
-rw-r--r--arabluatex.dtx161
1 files changed, 102 insertions, 59 deletions
diff --git a/arabluatex.dtx b/arabluatex.dtx
index 790b13c..3b74ab6 100644
--- a/arabluatex.dtx
+++ b/arabluatex.dtx
@@ -1,6 +1,6 @@
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--2018 Robert Alessi 3% Copyright (C) 2016--2018 Robert Alesssi
4% 4%
5% Please send error reports and suggestions for improvements to Robert 5% Please send error reports and suggestions for improvements to Robert
6% Alessi <alessi@robertalessi.net> 6% Alessi <alessi@robertalessi.net>
@@ -74,7 +74,7 @@
74 maintainer = {Hosny, Khaled}, 74 maintainer = {Hosny, Khaled},
75 title = {Amiri}, 75 title = {Amiri},
76 indextitle = {Amiri}, 76 indextitle = {Amiri},
77 date = {2015-09-20}, 77 date = {2017-12-13},
78 url = {http://www.amirifont.org/} 78 url = {http://www.amirifont.org/}
79} 79}
80 80
@@ -163,6 +163,7 @@
163\usepackage{hyperxmp} 163\usepackage{hyperxmp}
164\PassOptionsToPackage{pdfa}{hyperref} 164\PassOptionsToPackage{pdfa}{hyperref}
165\usepackage{hypdoc} 165\usepackage{hypdoc}
166\usepackage{bookmark}
166\usepackage{authblk} 167\usepackage{authblk}
167\hypersetup{unicode=true, colorlinks, allcolors=blue, 168\hypersetup{unicode=true, colorlinks, allcolors=blue,
168 linktocpage=true, pdfauthor={Robert Alessi}, pdftitle={The 169 linktocpage=true, pdfauthor={Robert Alessi}, pdftitle={The
@@ -533,7 +534,7 @@
533% of the \arb[trans]{kasraT} above the consonant may be obtained by 534% of the \arb[trans]{kasraT} above the consonant may be obtained by
534% selecting the |ss05| feature of the Amiri font, like 535% selecting the |ss05| feature of the Amiri font, like
535% so:---\footnote{See the documentation of \package{amiri}, 536% so:---\footnote{See the documentation of \package{amiri},
536% \textcite[5]{pkg:amiri}.}\\ 537% \textcite[6]{pkg:amiri}.}\\
537% \arabluaverb{\newfontfamily\arabicfont{Amiri}[Script=Arabic,RawFeature={+ss05}]} 538% \arabluaverb{\newfontfamily\arabicfont{Amiri}[Script=Arabic,RawFeature={+ss05}]}
538% 539%
539% Other Arabic fonts may behave differently. 540% Other Arabic fonts may behave differently.
@@ -1081,19 +1082,19 @@ vowels (see §~3).
1081% \arb[voc]{murU'aTuN} \arb[trans]{murU'aTuN}. 1082% \arb[voc]{murU'aTuN} \arb[trans]{murU'aTuN}.
1082% \end{quote} 1083% \end{quote}
1083% 1084%
1084% \paragraph{\arb[trans]{'alif maq.sUraT}} It is written \meta{\_A} or 1085% \paragraph{\texorpdfstring{\arb[trans]{'alif maq.sUraT}}{ʾalif
1085% \meta{Y}: 1086% maqṣūrah}} It is written \meta{\_A} or \meta{Y}:
1086% \begin{quote} 1087% \begin{quote}
1087% |al-fat_A| \arb[voc]{al-fat_A} \arb[trans]{al-fat_A}, |al-maqh_A| 1088% |al-fat_A| \arb[voc]{al-fat_A} \arb[trans]{al-fat_A}, |al-maqh_A|
1088% \arb[voc]{al-maqh_A} \arb[trans]{al-maqh_A}, |'il_A| 1089% \arb[voc]{al-maqh_A} \arb[trans]{al-maqh_A}, |'il_A|
1089% \arb[voc]{'il_A} \arb[trans]{'il_A}. 1090% \arb[voc]{'il_A} \arb[trans]{'il_A}.
1090% \end{quote} 1091% \end{quote}
1091% 1092%
1092% \paragraph{\arb[trans]{'alif} \emph{otiosum}} Said 1093% \paragraph{\texorpdfstring{\arb[trans]{'alif} \emph{otiosum}}alif
1093% \arb[trans]{'alif-u 'l-wiqAyaT-i}, \enquote{the guarding 1094% otiosum}} Said \arb[trans]{'alif-u 'l-wiqAyaT-i}, \enquote{the
1094% \arb[trans]{'alif}}\,, after \arb[novoc]{U} at the end of a word, both 1095% guarding \arb[trans]{'alif}}\,, after \arb[novoc]{U} at the end of a
1095% when preceded by \arb[trans]{.dammaT} and by \arb[trans]{fat.haT} is 1096% word, both when preceded by \arb[trans]{.dammaT} and by
1096% written \meta{UA} or \meta{aW, aWA}: 1097% \arb[trans]{fat.haT} is written \meta{UA} or \meta{aW, aWA}:
1097% \begin{quote} 1098% \begin{quote}
1098% |na.sarUA| \arb[voc]{na.sarUA} \arb[trans]{na.sarUA}, |katabUA| 1099% |na.sarUA| \arb[voc]{na.sarUA} \arb[trans]{na.sarUA}, |katabUA|
1099% \arb[voc]{katabUA} \arb[trans]{katabUA}, |ya.gzUA| 1100% \arb[voc]{katabUA} \arb[trans]{katabUA}, |ya.gzUA|
@@ -1102,8 +1103,9 @@ vowels (see §~3).
1102% \arb[fullvoc]{banaWA}, \arb[trans]{banaWA}. 1103% \arb[fullvoc]{banaWA}, \arb[trans]{banaWA}.
1103% \end{quote} 1104% \end{quote}
1104% 1105%
1105% \paragraph{\arb[trans]{'alif ma.h_dUfaT} and defective \arb[trans]{U, 1106% \paragraph{\texorpdfstring{\arb[trans]{'alif ma.h_dUfaT} and
1106% I}} They are written \meta{\_a, \_i \_u}: 1107% defective \arb[trans]{U, I}}{ʾalif maḥḏūfah and defective ū, ī}}
1108% They are written \meta{\_a, \_i \_u}:
1107% \begin{quote} 1109% \begin{quote}
1108% |al-l_ah-u| \arb[voc]{al-l_ah-u} \arb[trans]{al-l_ah-u}, 1110% |al-l_ah-u| \arb[voc]{al-l_ah-u} \arb[trans]{al-l_ah-u},
1109% |'il_ahuN| \arb[voc]{'il_ahuN} \arb[trans]{'il_ahuN}. 1111% |'il_ahuN| \arb[voc]{'il_ahuN} \arb[trans]{'il_ahuN}.
@@ -1118,7 +1120,8 @@ vowels (see §~3).
1118% \arb[trans]{al-\uc{`A.s_i}}. 1120% \arb[trans]{al-\uc{`A.s_i}}.
1119% \end{quote} 1121% \end{quote}
1120% 1122%
1121% \paragraph{Silent \arb[novoc]{U}/\arb[novoc]{I}} 1123% \paragraph{\texorpdfstring{Silent
1124% \arb[novoc]{U}/\arb[novoc]{I}}{Silent ي/و}}
1122% Some words ending with \arb[voc]{BAT} are usually written 1125% Some words ending with \arb[voc]{BAT} are usually written
1123% \arb[voc]{BawT} or \arb[voc]{B_aUT} instead of \arb[voc]{BAT}: see 1126% \arb[voc]{BawT} or \arb[voc]{B_aUT} instead of \arb[voc]{BAT}: see
1124% \textcite[i. 12 A]{Wright}. \package{arabluatex} preserves that 1127% \textcite[i. 12 A]{Wright}. \package{arabluatex} preserves that
@@ -1136,11 +1139,12 @@ vowels (see §~3).
1136% \arb[trans]{al-rib_aIT-u}. 1139% \arb[trans]{al-rib_aIT-u}.
1137% \end{quote} 1140% \end{quote}
1138% 1141%
1139% \paragraph{\arb[trans]{\uc{`amruNU}}, and the silent 1142% \paragraph{\texorpdfstring{\arb[trans]{\uc{`amruNU}}, and the silent
1140% \arb[novoc]{U}} To that name a silent \arb[novoc]{U} is added to 1143% \arb[novoc]{U}}{ʿAmrun, and the silent و}} To that name a silent
1141% distinguish it from \arb[trans]{\uc{`umar-u}}: see \textcite[i. 12 1144% \arb[novoc]{U} is added to distinguish it from
1142% C]{Wright}. In no way this affects the sound of the 1145% \arb[trans]{\uc{`umar-u}}: see \textcite[i. 12 C]{Wright}. In no way
1143% \arb[trans]{tanwIn}, so it has to be discarded in |trans| mode: 1146% this affects the sound of the \arb[trans]{tanwIn}, so it has to be
1147% discarded in |trans| mode:
1144% \begin{quote} 1148% \begin{quote}
1145% |`amruNU| \arb[voc]{`amruNU} \arb[trans]{`amruNU}, |`amraNU| 1149% |`amruNU| \arb[voc]{`amruNU} \arb[trans]{`amruNU}, |`amraNU|
1146% \arb[voc]{`amraNU} \arb[trans]{`amraNU}, |`amriNU| 1150% \arb[voc]{`amraNU} \arb[trans]{`amraNU}, |`amriNU|
@@ -1159,7 +1163,7 @@ vowels (see §~3).
1159% \arb[trans]{ribaNU}. 1163% \arb[trans]{ribaNU}.
1160% \end{quote} 1164% \end{quote}
1161% 1165%
1162%\paragraph{\arb[trans]{tanwIn}} 1166% \paragraph{\texorpdfstring{\arb[trans]{tanwIn}}{tanwīn}}
1163% The marks of doubled short vowels, \arb{BuN}, \arb{BaN}, \arb{BiN}, 1167% The marks of doubled short vowels, \arb{BuN}, \arb{BaN}, \arb{BiN},
1164% are written \meta{uN, aN, iN} respectively. \package{arabluatex} 1168% are written \meta{uN, aN, iN} respectively. \package{arabluatex}
1165% deals with special cases, such as \arb{BaN} taking an \arb[novoc]{A} 1169% deals with special cases, such as \arb{BaN} taking an \arb[novoc]{A}
@@ -1192,7 +1196,7 @@ vowels (see §~3).
1192% \end{quote} 1196% \end{quote}
1193% 1197%
1194% \subsection{Other orthographic signs} 1198% \subsection{Other orthographic signs}
1195% \paragraph{\arb[trans]{tA' marbU.taT}} 1199% \paragraph{\texorpdfstring{\arb[trans]{tA' marbU.taT}}{tāʾ marbūṭah}}
1196% It is written \meta{T}: 1200% It is written \meta{T}:
1197% \begin{quote} 1201% \begin{quote}
1198% |madInaTuN| \arb[voc]{madInaTuN} \arb[trans]{madInaTuN}, 1202% |madInaTuN| \arb[voc]{madInaTuN} \arb[trans]{madInaTuN},
@@ -1200,11 +1204,11 @@ vowels (see §~3).
1200% |madInaTiN| \arb[voc]{madInaTiN} \arb[trans]{madInaTiN}. 1204% |madInaTiN| \arb[voc]{madInaTiN} \arb[trans]{madInaTiN}.
1201% \end{quote} 1205% \end{quote}
1202% 1206%
1203% \paragraph{\arb[trans]{hamzaT}} \label{ref:hamza}It is written 1207% \paragraph{\texorpdfstring{\arb[trans]{hamzaT}}{hamzah}}
1204% \meta{\texttt{'}}, its carrier being determined by contextual 1208% \label{ref:hamza}It is written \meta{\texttt{'}}, its carrier being
1205% analysis. In case one wishes to bypass this mechanism, he can use 1209% determined by contextual analysis. In case one wishes to bypass this
1206% the \enquote{quoting} feature that is described below in 1210% mechanism, he can use the \enquote{quoting} feature that is
1207% \vref{sec:quoting}. 1211% described below in \vref{sec:quoting}.
1208% \begin{quote} 1212% \begin{quote}
1209% \textbf{Initial \arb[trans]{hamzaT}}: |'asaduN| \arb[voc]{'asaduN} 1213% \textbf{Initial \arb[trans]{hamzaT}}: |'asaduN| \arb[voc]{'asaduN}
1210% \arb[trans]{'asaduN}, |'u_htuN| \arb[voc]{'u_htuN} 1214% \arb[trans]{'asaduN}, |'u_htuN| \arb[voc]{'u_htuN}
@@ -1326,14 +1330,14 @@ vowels (see §~3).
1326% \arb[voc]{mi'a|TuN} \arb[trans]{mi'a|TuN}. 1330% \arb[voc]{mi'a|TuN} \arb[trans]{mi'a|TuN}.
1327% \end{quote} 1331% \end{quote}
1328% 1332%
1329% \paragraph{\arb[trans]{maddaT}} \label{ref:madda}At the beginning of 1333% \paragraph{\texorpdfstring{\arb[trans]{maddaT}}{maddah}}
1330% a syllabe, \arb[trans]{'alif} with \arb[trans]{hamzaT} and 1334% \label{ref:madda}At the beginning of a syllabe, \arb[trans]{'alif}
1331% \arb[trans]{fat.haT} (\arb[voc]{'a}) followed by \arb[trans]{'alifu 1335% with \arb[trans]{hamzaT} and \arb[trans]{fat.haT} (\arb[voc]{'a})
1332% 'l-maddi} (\arb[trans]{'alif} of prolongation) or \arb[trans]{'alif} 1336% followed by \arb[trans]{'alifu 'l-maddi} (\arb[trans]{'alif} of
1333% with \arb[trans]{hamzaT} and \arb[trans]{jazmaT} (\arb[voc]{a"'"}) 1337% prolongation) or \arb[trans]{'alif} with \arb[trans]{hamzaT} and
1334% are both represented in writing \arb[trans]{'alif} with 1338% \arb[trans]{jazmaT} (\arb[voc]{a"'"}) are both represented in
1335% \arb[trans]{maddaT}: \arb[voc]{A"'} \parencite[see][i. 25 1339% writing \arb[trans]{'alif} with \arb[trans]{maddaT}: \arb[voc]{A"'}
1336% A--B]{Wright}. 1340% \parencite[see][i. 25 A--B]{Wright}.
1337% 1341%
1338% \iffalse 1342% \iffalse
1339%<*example> 1343%<*example>
@@ -1363,13 +1367,13 @@ vowels (see §~3).
1363% \arb[voc]{yaxba'Ani} \arb[trans]{yaxba'Ani}. 1367% \arb[voc]{yaxba'Ani} \arb[trans]{yaxba'Ani}.
1364% \end{quote} 1368% \end{quote}
1365% 1369%
1366% \paragraph{\arb[trans]{^saddaT}} 1370% \paragraph{\texorpdfstring{\arb[trans]{^saddaT}}{šaddah}}
1367% \arb[trans]{ta^sdId} is either \emph{necessary} or \emph{euphonic}. 1371% \arb[trans]{ta^sdId} is either \emph{necessary} or \emph{euphonic}.
1368% 1372%
1369% \subparagraph{The necessary 1373% \subparagraph{The necessary \arb[trans]{ta^sdId}}
1370% \arb[trans]{ta^sdId}} \label{ref:necessary-tashdid}always follows a 1374% \label{ref:necessary-tashdid}always follows a vowel, whether short
1371% vowel, whether short or long \parencite[see][i. 15 A--B]{Wright}. It 1375% or long \parencite[see][i. 15 A--B]{Wright}. It is encoded in
1372% is encoded in writing the consonant that carries it twice: 1376% writing the consonant that carries it twice:
1373% \begin{quote} 1377% \begin{quote}
1374% |`allaqa| \arb[voc]{`allaqa} \arb[trans]{`allaqa}, |mAdduN| 1378% |`allaqa| \arb[voc]{`allaqa} \arb[trans]{`allaqa}, |mAdduN|
1375% \arb[voc]{mAdduN} \arb[trans]{mAdduN}, |'ammara| 1379% \arb[voc]{mAdduN} \arb[trans]{mAdduN}, |'ammara|
@@ -1447,7 +1451,9 @@ vowels (see §~3).
1447% grammarians \parencite[see][i. 16 B--C]{Wright}. 1451% grammarians \parencite[see][i. 16 B--C]{Wright}.
1448% \end{enumerate} 1452% \end{enumerate}
1449% 1453%
1450% \paragraph{The definite article and the \arb[trans]{'alif-u 'l-wa.sl-i}} 1454% \paragraph{\texorpdfstring{The definite article and the
1455% \arb[trans]{'alif-u 'l-wa.sl-i}}{The definite article and the ʾalifu
1456% 'l-waṣli}}
1451% \label{ref:definite-article} 1457% \label{ref:definite-article}
1452% At the beginning of a sentence, \arb[fullvoc]{"a} is never written, 1458% At the beginning of a sentence, \arb[fullvoc]{"a} is never written,
1453% as \arb[fullvoc]{'l-.hamd-u li-ll_ah-i}; instead, to indicate that 1459% as \arb[fullvoc]{'l-.hamd-u li-ll_ah-i}; instead, to indicate that
@@ -1653,7 +1659,8 @@ vowels (see §~3).
1653% \arb[trans]{li-l-l_ah-i 'l-qA'il-u}. 1659% \arb[trans]{li-l-l_ah-i 'l-qA'il-u}.
1654% \end{quote} 1660% \end{quote}
1655% 1661%
1656% \paragraph{The conjunctive \arb[voc]{alla_dI}} 1662% \paragraph{\texorpdfstring{The conjunctive \arb[voc]{alla_dI}}{The
1663% conjunctive اَلَّذِي}}
1657% Although it is compounded of the article \arb[fullvoc]{al}, the 1664% Although it is compounded of the article \arb[fullvoc]{al}, the
1658% demonstrative letter \arb[novoc]{l} and the demonstrative pronoun 1665% demonstrative letter \arb[novoc]{l} and the demonstrative pronoun
1659% \arb[voc]{_dA}, both masculine and feminine forms that are written 1666% \arb[voc]{_dA}, both masculine and feminine forms that are written
@@ -2414,6 +2421,7 @@ word that \cs{arbnull} is applied to.
2414% 2421%
2415% \section{Special applications} 2422% \section{Special applications}
2416% \label{sec:special-applications} 2423% \label{sec:special-applications}
2424% \phantomsection
2417% \paragraph{Linguistics} 2425% \paragraph{Linguistics}
2418% The same horizontal stroke as the \arb[trans]{ta.twIl} (see 2426% The same horizontal stroke as the \arb[trans]{ta.twIl} (see
2419% \vref{sec:tatwil}) may be encoded \meta{B}; \meta{BB} will receive 2427% \vref{sec:tatwil}) may be encoded \meta{B}; \meta{BB} will receive
@@ -2427,6 +2435,7 @@ word that \cs{arbnull} is applied to.
2427% \end{quote} 2435% \end{quote}
2428% 2436%
2429% \paragraph{Brackets} 2437% \paragraph{Brackets}
2438% \phantomsection
2430% \NEWfeature{v1.4.3} The various bracket symbols are useful in 2439% \NEWfeature{v1.4.3} The various bracket symbols are useful in
2431% technical documents such as critical editions for indicating that 2440% technical documents such as critical editions for indicating that
2432% some words or some letters must be added or 2441% some words or some letters must be added or
@@ -2551,6 +2560,12 @@ word that \cs{arbnull} is applied to.
2551%</example> 2560%</example>
2552% \fi 2561% \fi
2553% 2562%
2563% \paragraph{Color}\NEWfeature{v1.12} this:
2564% \begingroup \newfontfamily\arabicfont{FreeSerif}[Script=Arabic]
2565% \arb{da_hal"+\arbcolor[red]{+t\arbcolor[blue]{+u}}
2566% mub"t+\arbcolor[brown]{+a}s+\arbcolor[blue]{+i\arbcolor[brown]{+maN}}}
2567% \endgroup
2568%
2554% \section{Transliteration} 2569% \section{Transliteration}
2555% \label{sec:transliteration} 2570% \label{sec:transliteration}
2556% It may be more appropriate to speak of \enquote{romanization} than 2571% It may be more appropriate to speak of \enquote{romanization} than
@@ -2679,7 +2694,7 @@ word that \cs{arbnull} is applied to.
2679% \uc{'l-rAziyyu}}. 2694% \uc{'l-rAziyyu}}.
2680% \end{quote} 2695% \end{quote}
2681% 2696%
2682% \paragraph{\enquote*{Long} proper names} 2697% \paragraph{\enquote*{Long} pro\-per names}
2683% \NEWfeature{v1.10} \cs{uc} is also able to process proper names 2698% \NEWfeature{v1.10} \cs{uc} is also able to process proper names
2684% consisting of several subsequent words:--- 2699% consisting of several subsequent words:---
2685% \begin{quote} 2700% \begin{quote}
@@ -2778,7 +2793,8 @@ muhaddamaTaN mi'_danatu-hu}: \arb[trans]{ra'aytu
2778% with the actual \arb[trans]{tanwIn} in the formatting directives of 2793% with the actual \arb[trans]{tanwIn} in the formatting directives of
2779% the \cs{SetArbUp} command. 2794% the \cs{SetArbUp} command.
2780% 2795%
2781% \paragraph{\arb[trans]{'i`rAb} boundaries} 2796% \paragraph{\texorpdfstring{\arb[trans]{'i`rAb} boundaries}{ʾiʿrāb
2797% boundaries}}
2782% Every declinable noun (\arb[trans]{mu`rab}) may be declined either 2798% Every declinable noun (\arb[trans]{mu`rab}) may be declined either
2783% with or without \arb[trans]{tanwIn}, viz. \arb[trans]{mun.sarifuN} 2799% with or without \arb[trans]{tanwIn}, viz. \arb[trans]{mun.sarifuN}
2784% or \arb[trans]{.gayr-u mun.sarifiN}. The former is automatically 2800% or \arb[trans]{.gayr-u mun.sarifiN}. The former is automatically
@@ -2826,7 +2842,8 @@ muhaddamaTaN mi'_danatu-hu}: \arb[trans]{ra'aytu
2826% 'l-nAs-a kAffaT-aN min mu_hA.tabati-hi 'a.had-uN bi-sayyidi-nA}. 2842% 'l-nAs-a kAffaT-aN min mu_hA.tabati-hi 'a.had-uN bi-sayyidi-nA}.
2827% \end{quoting} 2843% \end{quoting}
2828% 2844%
2829% \paragraph{Discarding the \arb[trans]{'i`rAb}} 2845% \paragraph{\texorpdfstring{Discar\-ding the
2846% \arb[trans]{'i`rAb}}{Discarding the ʾiʿrāb}}
2830% As said above (\vref{ref:irab-discarded}), the \arb[trans]{'i`rAb} 2847% As said above (\vref{ref:irab-discarded}), the \arb[trans]{'i`rAb}
2831% may be discarded in some cases, as in transliterated proper names or 2848% may be discarded in some cases, as in transliterated proper names or
2832% book titles. \package{arabluatex} is able to render words ending 2849% book titles. \package{arabluatex} is able to render words ending
@@ -3106,8 +3123,8 @@ muhaddamaTaN mi'_danatu-hu}: \arb[trans]{ra'aytu
3106% \paragraph{General principle} \label{ref:cmd-inside-arabic}\LaTeX\ 3123% \paragraph{General principle} \label{ref:cmd-inside-arabic}\LaTeX\
3107% commands are accepted in Arabic environments. The general principle 3124% commands are accepted in Arabic environments. The general principle
3108% which applies is that any single-argument command with up to 3125% which applies is that any single-argument command with up to
3109% \emph{two optional arguments} 3126% \emph{two optional arguments}---that is:
3110% (\cs{command}\oarg{opt1}\oarg{opt2}\marg{arg}) such as 3127% \cs{command}\oarg{opt1}\oarg{opt2}\marg{arg}---such as
3111% \cs{emph}\marg{text}, \cs{textbf}\marg{text} and the like, is 3128% \cs{emph}\marg{text}, \cs{textbf}\marg{text} and the like, is
3112% assumed to have Arabic text in its mandatory argument:--- 3129% assumed to have Arabic text in its mandatory argument:---
3113% \begin{quote} 3130% \begin{quote}
@@ -3169,11 +3186,13 @@ al-muqAtil-Ina.}, wa-kAnat 'ummI min `u.zamA'-i buyUt-i
3169%<*example> 3186%<*example>
3170% \fi 3187% \fi
3171\begin{arabluacode} 3188\begin{arabluacode}
3172\arb[fullvoc]{\uc{z}ayd-uN\LRfootnote{% 3189 \begin{arab}[fullvoc]
3173\enquote{\arb[trans]{\uc{z}ayd} is the son of 3190 \uc{z}ayd-uN\LRfootnote{%
3174\arb[trans]{\uc{`a}mr}}: the second 3191 \enquote{\arb[trans]{\uc{z}ayd} is the son of
3175noun is not in apposition to the first, but forms 3192 \arb[trans]{\uc{`a}mr}}: the second noun is not in
3176part of the predicate\ldots} "ibn-u \uc{`a}mr-iNU} 3193 apposition to the first, but forms part of the
3194 predicate\ldots} "ibn-u \uc{`a}mr-iNU
3195 \end{arab}
3177\end{arabluacode} 3196\end{arabluacode}
3178% \iffalse 3197% \iffalse
3179%</example> 3198%</example>
@@ -3194,9 +3213,10 @@ part of the predicate\ldots} "ibn-u \uc{`a}mr-iNU}
3194% the documentation of \package{KOMA-script} for details about the 3213% the documentation of \package{KOMA-script} for details about the
3195% \cs{deffootnotemark} and \cs{deffootnote} commands.} 3214% \cs{deffootnotemark} and \cs{deffootnote} commands.}
3196% 3215%
3197% \DescribeMacro{\LRmarginpar} The \cs{LRmarginpar} command does for 3216% \DescribeMacro{\LRmarginpar} The
3198% marginal notes the same as \cs{LRfootnote} does for footnotes. Of 3217% \cs{LRmarginpar}\oarg{left}\marg{right} command does for marginal
3199% course, it is supposed to be used in Arabic environments. Note that 3218% notes the same as \cs{LRfootnote} does for footnotes. Of course, it
3219% is supposed to be used in Arabic environments. Note that
3200% \cs{marginpar} also works in Arabic environments, but it acts as any 3220% \cs{marginpar} also works in Arabic environments, but it acts as any
3201% other single-argument command inserted in Arabic environments. The 3221% other single-argument command inserted in Arabic environments. The
3202% general principle laid \vpageref{ref:cmd-inside-arabic} applies. 3222% general principle laid \vpageref{ref:cmd-inside-arabic} applies.
@@ -3247,8 +3267,7 @@ qAla barzawayhi bn-u 'azhar-a, ra's-u 'a.tibbA'-i fAris-a...
3247% 3267%
3248% For example, here follows a way to define a new command |\fvred| to 3268% For example, here follows a way to define a new command |\fvred| to
3249% distinguish words with a different color and always print them in 3269% distinguish words with a different color and always print them in
3250% fully vocalized Arabic:---\footnote{See below \vref{sec:textcolor} for 3270% fully vocalized Arabic:--- %
3251% more information on two-argument commands.} %
3252% \iffalse 3271% \iffalse
3253%<*example> 3272%<*example>
3254% \fi 3273% \fi
@@ -3286,7 +3305,28 @@ qAla barzawayhi bn-u 'azhar-a, ra's-u 'a.tibbA'-i fAris-a...
3286% \end{enumerate} 3305% \end{enumerate}
3287% 3306%
3288% \DescribeMacro{\MkArbBreak*}\NEWfeature{v1.12} As said above, 3307% \DescribeMacro{\MkArbBreak*}\NEWfeature{v1.12} As said above,
3289% \cs{MkArbBreak} 3308% \cs{MkArbBreak} prevents \package{arabluatex} from processing the
3309% arguments of \enquote*{declared} commands as Arabic text. This
3310% technique proves sufficient in most cases. However, a
3311% \enquote*{starred} version of this
3312% command---\cs{MkArbBreak*}\marg{csv list of commands}---is also
3313% provided. It goes a step further, as it directs \package{arabluatex}
3314% to \emph{close} the current Arabic environment before any of the
3315% \enquote*{declared} commands, then \emph{resume} it just after.
3316%
3317% \iffalse
3318%<*example>
3319% \fi
3320\begin{arabluacode}[text only]
3321 It must be noted that \cs{MkArbBreak*} must be used with the utmost
3322 care and \emph{should never be used} if \cs{MkArbBreak} gives
3323 satisfaction. At any rate, the latter must always be tested before
3324 the former.
3325\end{arabluacode}
3326% \iffalse
3327%</example>
3328% \fi%
3329%
3290% 3330%
3291% \subsection{Environments} 3331% \subsection{Environments}
3292% \label{sec:environments} 3332% \label{sec:environments}
@@ -3505,10 +3545,10 @@ qAla barzawayhi bn-u 'azhar-a, ra's-u 'a.tibbA'-i fAris-a...
3505% \subsection{Two-argument special commands} 3545% \subsection{Two-argument special commands}
3506% \label{sec:two-arg-cmds} 3546% \label{sec:two-arg-cmds}
3507% 3547%
3508% \paragraph{Color} 3548% \paragraph{textcolor}
3509% \label{sec:textcolor} 3549% \label{sec:textcolor}
3510% The two-argument command 3550% The two-argument command
3511% \cs{textcolor}\marg{color}\marg{\cs{arb}\oarg{opt}\marg{Arabic 3551% \cs{textcolor}\marg{color}\marg{\cs{arb}\oarg{opt}\marg{Ara\-bic
3512% text}} is supported inside \cs{begin}|{arab}| \ldots\ 3552% text}} is supported inside \cs{begin}|{arab}| \ldots\
3513% \cs{end}|{arab}|. One simple example follows:--- % 3553% \cs{end}|{arab}|. One simple example follows:--- %
3514% \iffalse 3554% \iffalse
@@ -4170,7 +4210,10 @@ wa-ya.sIru ta.hta 'l-jild-i
4170% inserted in an Arabic environment. It typsets his argument in a 4210% inserted in an Arabic environment. It typsets his argument in a
4171% marginal note from left to right. 4211% marginal note from left to right.
4172% \begin{macrocode} 4212% \begin{macrocode}
4173\DeclareDocumentCommand{\LRmarginpar}{m}{\marginpar{\textdir TLT #1}} 4213\DeclareDocumentCommand{\LRmarginpar}{o m}{%
4214 \IfNoValueTF{#1}
4215 {\marginpar{\textdir TLT #2}}
4216 {\marginpar[\textdir TLT #1]{\textdir TLT #2}}}
4174% \end{macrocode} 4217% \end{macrocode}
4175% \end{macro} 4218% \end{macro}
4176% \begin{macro}{\LRfootnote} \cs{LRfootnote} and \cs{RLfootnote} are 4219% \begin{macro}{\LRfootnote} \cs{LRfootnote} and \cs{RLfootnote} are