aboutsummaryrefslogtreecommitdiff
path: root/arabluatex.dtx
diff options
context:
space:
mode:
authorRobert Alessi <alessi@robertalessi.net>2016-05-28 10:36:47 +0200
committerRobert Alessi <alessi@robertalessi.net>2016-05-28 10:36:47 +0200
commitb8c169ea96b982c664dcbde90e29ca87cfe39188 (patch)
tree3a3d3e332f607727dfd23788bfe777e1f88f3943 /arabluatex.dtx
parentb90f4668198eb701d5524b8f93f50f0d26c7bea2 (diff)
downloadarabluatex-b8c169ea96b982c664dcbde90e29ca87cfe39188.tar.gz
done implementing ʾiʿrāb ġayr munṣarif, done documenting. getting close to v1.3
Diffstat (limited to 'arabluatex.dtx')
-rw-r--r--arabluatex.dtx113
1 files changed, 84 insertions, 29 deletions
diff --git a/arabluatex.dtx b/arabluatex.dtx
index 613257b..52dc19f 100644
--- a/arabluatex.dtx
+++ b/arabluatex.dtx
@@ -448,9 +448,10 @@
448% corresponding \arb[trans]{tanwIn} (\arb{BuN}, \arb{B|aN}\,, 448% corresponding \arb[trans]{tanwIn} (\arb{BuN}, \arb{B|aN}\,,
449% \arb{TaN}, \arb{BaN_A} or \arb{BiN}) is generated. Finally, \meta{u, 449% \arb{TaN}, \arb{BaN_A} or \arb{BiN}) is generated. Finally, \meta{u,
450% a, i} at the commencement of a word indicate a \enquote{connective 450% a, i} at the commencement of a word indicate a \enquote{connective
451% \arb[trans]{'alif}\,} (\arb[trans]{'alifu 'l-wa.sli}), but |voc| mode 451% \arb[trans]{'alif}\,} (\arb[trans]{'alifu 'l-wa.sli}), but |voc|
452% does not show the \arb[trans]{wa.slaT} above the \arb[trans]{'alif}; 452% mode does not show the \arb[trans]{wa.slaT} above the
453% instead, the accompanying vowel is expressed (\arb{u a i}). 453% \arb[trans]{'alif}; instead, the accompanying vowel may be expressed
454% at the beginning of a sentence (\arb{u} \arb{a} \arb{i}).
454% 455%
455% \DescribeOption{fullvoc}\\ \label{fullvoc-mode}In addition to what 456% \DescribeOption{fullvoc}\\ \label{fullvoc-mode}In addition to what
456% the |voc| mode does, |fullvoc| expresses the \arb[trans]{sukUn} and 457% the |voc| mode does, |fullvoc| expresses the \arb[trans]{sukUn} and
@@ -863,7 +864,7 @@ vowels (see §~3).
863% 864%
864% \paragraph{\arb[trans]{\cap{`amruNU}}, and the silent 865% \paragraph{\arb[trans]{\cap{`amruNU}}, and the silent
865% \arb[novoc]{U}} To that name a silent \arb[novoc]{U} is added to 866% \arb[novoc]{U}} To that name a silent \arb[novoc]{U} is added to
866% distinguish it from \arb[trans]{\cap{`umaruN}}: see \textcite[i. 12 867% distinguish it from \arb[trans]{\cap{`umar-u}}: see \textcite[i. 12
867% C]{Wright}. In no way this affects the sound of the 868% C]{Wright}. In no way this affects the sound of the
868% \arb[trans]{tanwIn}, so it has to be discarded in |trans| mode: 869% \arb[trans]{tanwIn}, so it has to be discarded in |trans| mode:
869% \begin{quote} 870% \begin{quote}
@@ -996,7 +997,7 @@ vowels (see §~3).
996% \arb[voc]{'a^syA'-a} \arb[trans]{'a^syA'-a}, |.zim'aN| 997% \arb[voc]{'a^syA'-a} \arb[trans]{'a^syA'-a}, |.zim'aN|
997% \arb[voc]{.zim'aN} \arb[trans]{.zim'aN}. 998% \arb[voc]{.zim'aN} \arb[trans]{.zim'aN}.
998% 999%
999% \textbf{\arb[trans]{ta_hfIfu 'l-hamzaTi}}: if the 1000% \textbf{\arb[trans]{ta_hfIf-u 'l-hamzaT-i}}: if the
1000% \arb[trans]{hamzaT} has \arb[trans]{jazmaT} and is preceded by 1001% \arb[trans]{hamzaT} has \arb[trans]{jazmaT} and is preceded by
1001% \emph{\arb[trans]{'alif} hamzatum}, it must be changed into the 1002% \emph{\arb[trans]{'alif} hamzatum}, it must be changed into the
1002% letter of prolongation that is homogeneous with the preceding 1003% letter of prolongation that is homogeneous with the preceding
@@ -1029,8 +1030,8 @@ vowels (see §~3).
1029%</example> 1030%</example>
1030% \fi 1031% \fi
1031% 1032%
1032% \package{arabluatex} otherwise determines \arb[trans]{al-'alifu 1033% \package{arabluatex} otherwise determines \arb[trans]{al-'alif-u
1033% 'l-mamdUdaTu} by context analysis. 1034% 'l-mamdUdaT-u} by context analysis.
1034% 1035%
1035% \begin{quote} 1036% \begin{quote}
1036% |'is'AduN| \arb[voc]{'is'AduN} \arb[trans]{'is'AduN}, |'AkilUna| 1037% |'is'AduN| \arb[voc]{'is'AduN} \arb[trans]{'is'AduN}, |'AkilUna|
@@ -1158,7 +1159,6 @@ vowels (see §~3).
1158% |fa-lammA| |ra'aW| |'l-najm-a| \arb[fullvoc]{fa-lammA ra'aW 1159% |fa-lammA| |ra'aW| |'l-najm-a| \arb[fullvoc]{fa-lammA ra'aW
1159% 'l-najm-a} \arb[trans]{fa-lammA ra'aW 'l-najm-a}. 1160% 'l-najm-a} \arb[trans]{fa-lammA ra'aW 'l-najm-a}.
1160% 1161%
1161% \newpage
1162% \textbf{Particles}:--- 1162% \textbf{Particles}:---
1163% \begin{compactenum}[(a)] 1163% \begin{compactenum}[(a)]
1164% \item \arb[trans]{li-}: \arb[trans]{'alif-u 'l-wa.sl-i} is omitted 1164% \item \arb[trans]{li-}: \arb[trans]{'alif-u 'l-wa.sl-i} is omitted
@@ -1198,11 +1198,17 @@ vowels (see §~3).
1198% \arb[trans]{'awi ismu-hu}, |zayduN| |ibn-u| |`amriNU| 1198% \arb[trans]{'awi ismu-hu}, |zayduN| |ibn-u| |`amriNU|
1199% \arb[fullvoc]{\cap{z}ayduN ibn-u \cap{`amriNU}} 1199% \arb[fullvoc]{\cap{z}ayduN ibn-u \cap{`amriNU}}
1200% \arb[trans]{\cap{z}ayduN ibn-u 1200% \arb[trans]{\cap{z}ayduN ibn-u
1201% \cap{`amriNU}},\footnote{\enquote{\arb[trans]{\cap{z}ayd} is the 1201% \cap{`amriNU}},\footnote{\label{fn:zayd-is-son}%
1202% son of \arb[trans]{\cap{`a}mr}}: the second noun is not in 1202% \enquote{\arb[trans]{\cap{z}ayd} is the son of
1203% apposition to the first, but forms part of the predicate. Hence 1203% \arb[trans]{\cap{`a}mr}}: the second noun is not in apposition to
1204% \arb[voc]{zayduN ibn-u `amriNU} and not \arb[voc]{zayd-u bn-u 1204% the first, but forms part of the predicate. Hence \arb[voc]{zayduN
1205% `amriNU}, \enquote{Zayd, son of ʿAmr}.} |imru'-u| |'l-qays-i| 1205% ibn-u `amriNU} and not \arb[voc]{zayd-u bn-u `amriNU},
1206% \enquote{Zayd, son of ʿAmr}.} |`umar-u| |ibn-u| |'l-_ha.t.tAb-i|
1207% \arb[fullvoc]{\cap{`umar}-u ibn-u \cap{'l-_ha.t.tAb-i}}
1208% \arb[trans]{\cap{`umar}-u ibn-u
1209% \cap{'l-_ha.t.tAb-i}},\footnote{\enquote{\arb[trans]{\cap{`umar}}
1210% is the son of \arb[trans]{\cap{al-_ha.t.tAb}}} (see
1211% \vref{fn:zayd-is-son}).} |imru'-u| |'l-qays-i|
1206% \arb[fullvoc]{imru'-u 'l-qays-i} \arb[trans]{\cap{i}mru'-u 1212% \arb[fullvoc]{imru'-u 'l-qays-i} \arb[trans]{\cap{i}mru'-u
1207% \cap{'l-qays-i}}, |la-aymun-u| |'l-l_ah-i| 1213% \cap{'l-qays-i}}, |la-aymun-u| |'l-l_ah-i|
1208% \arb[fullvoc]{la-aymun-u 'l-l_ah-i} \arb[trans]{la-aymun-u 1214% \arb[fullvoc]{la-aymun-u 'l-l_ah-i} \arb[trans]{la-aymun-u
@@ -1219,7 +1225,9 @@ vowels (see §~3).
1219% 'l-nAs-i}, |'abU| |'l-wazIr-i| \arb[fullvoc]{'abU 'l-wazIr-i} 1225% 'l-nAs-i}, |'abU| |'l-wazIr-i| \arb[fullvoc]{'abU 'l-wazIr-i}
1220% \arb[trans]{'abU 'l-wazIr-i}, |fI| |'l-ibtidA'-i| \arb[fullvoc]{fI 1226% \arb[trans]{'abU 'l-wazIr-i}, |fI| |'l-ibtidA'-i| \arb[fullvoc]{fI
1221% 'l-ibtidA'-i} \arb[trans]{fI 'l-ibtidA'-i}, |_dU 'l-i`lAl-i| 1227% 'l-ibtidA'-i} \arb[trans]{fI 'l-ibtidA'-i}, |_dU 'l-i`lAl-i|
1222% \arb[fullvoc]{_dU 'l-i`lAl-i} \arb[trans]{_dU 'l-i`lAl-i}. 1228% \arb[fullvoc]{_dU 'l-i`lAl-i} \arb[trans]{_dU 'l-i`lAl-i},
1229% |maqh_A| |'l-'amIr-i| \arb[voc]{maqh_A 'l-'amIr-i}
1230% \arb[trans]{maqh_A 'l-'amIr-i}.
1223% \end{quote} 1231% \end{quote}
1224% 1232%
1225% \subparagraph{\arb[trans]{'alif-u 'l-wa.sl-i} preceded by a diphthong} 1233% \subparagraph{\arb[trans]{'alif-u 'l-wa.sl-i} preceded by a diphthong}
@@ -1247,8 +1255,8 @@ vowels (see §~3).
1247% cases \parencite[i. 22 A--C]{Wright}, it is encoded explicitly, like 1255% cases \parencite[i. 22 A--C]{Wright}, it is encoded explicitly, like
1248% so:--- 1256% so:---
1249% \begin{quote} 1257% \begin{quote}
1250% |'antumu| |'l-kA_dibUna| \arb[fullvoc]{'antumu 'l-kA_dibUna} 1258% |'antumu| |'l-kA_dib-Una| \arb[fullvoc]{'antumu 'l-kA_dib-Una}
1251% \arb[trans]{'antumu 'l-kA_dibUna}, |ra'aytumu| |'l-rajul-a| 1259% \arb[trans]{'antumu 'l-kA_dib-Una}, |ra'aytumu| |'l-rajul-a|
1252% \arb[fullvoc]{ra'aytumu 'l-rajul-a} \arb[trans]{ra'aytumu 1260% \arb[fullvoc]{ra'aytumu 'l-rajul-a} \arb[trans]{ra'aytumu
1253% 'l-rajul-a}, |mani| |'l-ka_d_dAb-u| \arb[fullvoc]{mani 1261% 'l-rajul-a}, |mani| |'l-ka_d_dAb-u| \arb[fullvoc]{mani
1254% 'l-ka_d_dAb-u} \arb[trans]{mani 'l-ka_d_dAb-u}, |qatalati| 1262% 'l-ka_d_dAb-u} \arb[trans]{mani 'l-ka_d_dAb-u}, |qatalati|
@@ -1315,9 +1323,9 @@ vowels (see §~3).
1315% |'a_hAfu| |mina| |'l-malik-i| |'lla_dI| |ya.zlimu| |'l-nAs-a| 1323% |'a_hAfu| |mina| |'l-malik-i| |'lla_dI| |ya.zlimu| |'l-nAs-a|
1316% \arb[fullvoc]{'a_hAfu mina 'l-malik-i 'lla_dI ya.zlimu 'l-nAs-a} 1324% \arb[fullvoc]{'a_hAfu mina 'l-malik-i 'lla_dI ya.zlimu 'l-nAs-a}
1317% \arb[trans]{'a_hAfu mina 'l-malik-i 'lla_dI ya.zlimu 'l-nAs-a}, 1325% \arb[trans]{'a_hAfu mina 'l-malik-i 'lla_dI ya.zlimu 'l-nAs-a},
1318% |`udtu| |'l-^say_h-a| |'lladI| |huwa| |marI.duN| 1326% |`udtu| |'l-^say_h-a| |'lla_dI| |huwa| |marI.duN|
1319% \arb[fullvoc]{`udtu 'l-^say_h-a 'lladI huwa marI.duN} 1327% \arb[fullvoc]{`udtu 'l-^say_h-a 'lla_dI huwa marI.duN}
1320% \arb[trans]{`udtu 'l-^say_h-a 'lladI huwa marI.duN}, |mA| |'anA| 1328% \arb[trans]{`udtu 'l-^say_h-a 'lla_dI huwa marI.duN}, |mA| |'anA|
1321% |bi-'lla_dI| |qA'iluN| |la-ka| |^say'aN| \arb[fullvoc]{mA 'anA 1329% |bi-'lla_dI| |qA'iluN| |la-ka| |^say'aN| \arb[fullvoc]{mA 'anA
1322% bi-'lla_dI qA'iluN la-ka ^say'aN} \arb[trans]{mA 'anA bi-'lla_dI 1330% bi-'lla_dI qA'iluN la-ka ^say'aN} \arb[trans]{mA 'anA bi-'lla_dI
1323% qA'iluN la-ka ^say'aN}. 1331% qA'iluN la-ka ^say'aN}.
@@ -1329,11 +1337,11 @@ vowels (see §~3).
1329% \end{quote} 1337% \end{quote}
1330% The other forms are encoded regularly as |al-l| or |'l-l|:--- 1338% The other forms are encoded regularly as |al-l| or |'l-l|:---
1331% \begin{quote} 1339% \begin{quote}
1332% |fa-'innA| |na_dkuru| |'l-.sawtayni| |'l-la_dayni| |rawaynA-humA| 1340% |fa-'innA| |na_dkuru| |'l-.sawt-ayni| |'l-la_dayni| |rawaynA-humA|
1333% |`an| |ja.h.zaT-a| \arb[fullvoc]{fa-'innA na_dkuru 'l-.sawtayni 1341% |`an| |ja.h.zaT-a| \arb[fullvoc]{fa-'innA na_dkuru 'l-.sawt-ayni
1334% 'l-la_dayni rawaynA-humA `an \cap{ja.h.zaT-a}} \arb[trans]{fa-'innA 1342% 'l-la_dayni rawaynA-humA `an \cap{ja.h.zaT-a}}
1335% na_dkuru 'l-.sawtayni 'l-la_dayni rawaynA-humA `an 1343% \arb[trans]{fa-'innA na_dkuru 'l-.sawt-ayni 'l-la_dayni
1336% \cap{ja.h.zaT-a}}. 1344% rawaynA-humA `an \cap{ja.h.zaT-a}}.
1337% 1345%
1338% And also: |al-la_dAni| \arb[fullvoc]{al-la_dAni} 1346% And also: |al-la_dAni| \arb[fullvoc]{al-la_dAni}
1339% \arb[trans]{al-la_dAni}, |al-la_dayni| \arb[fullvoc]{al-la_dayni} 1347% \arb[trans]{al-la_dAni}, |al-la_dayni| \arb[fullvoc]{al-la_dayni}
@@ -1793,8 +1801,8 @@ vowels (see §~3).
1793% \end{compactenum} 1801% \end{compactenum}
1794% \DescribeMacro{\arbup} By default, \package{arabluatex} applies rule 1802% \DescribeMacro{\arbup} By default, \package{arabluatex} applies rule
1795% \ref{ref:dmg-up-rend}. Once delimited by a set of Lua functions, 1803% \ref{ref:dmg-up-rend}. Once delimited by a set of Lua functions,
1796% every \arb[trans]{tanwIn} is passed as an argument on to a 1804% \arb[trans]{'i`rAb} is passed as an argument on to a \cs{arbup}
1797% \cs{arbup} command which is set to \cs{textsuperscript}. 1805% command which is set to \cs{textsuperscript}.
1798% 1806%
1799% \DescribeMacro{\NoArbUp} \DescribeMacro{\ArbUpDflt} \cs{NoArbUp} may 1807% \DescribeMacro{\NoArbUp} \DescribeMacro{\ArbUpDflt} \cs{NoArbUp} may
1800% be used either in the preamble or at any point of the document in 1808% be used either in the preamble or at any point of the document in
@@ -1803,7 +1811,7 @@ vowels (see §~3).
1803% any point of the document. 1811% any point of the document.
1804% 1812%
1805% \DescribeMacro{\SetArbUp} Finally, \cs{SetArbUp}\marg{formatting 1813% \DescribeMacro{\SetArbUp} Finally, \cs{SetArbUp}\marg{formatting
1806% directives} may be used to customize the way \arb[trans]{tanwIn} is 1814% directives} may be used to customize the way \arb[trans]{'i`rAb} is
1807% displayed. To take one example, here is how Arabic 1815% displayed. To take one example, here is how Arabic
1808% \arb[trans]{'i`rAb} may be rendered as subscript text:--- 1816% \arb[trans]{'i`rAb} may be rendered as subscript text:---
1809% \iffalse 1817% \iffalse
@@ -1822,7 +1830,54 @@ muhaddamaTaN mi'_danatu-hu}: \arb[trans]{ra'aytu
1822% As shown in the above example, |#1| is the token that is replaced 1830% As shown in the above example, |#1| is the token that is replaced
1823% with the actual \arb[trans]{tanwIn} in the formatting directives of 1831% with the actual \arb[trans]{tanwIn} in the formatting directives of
1824% the \cs{SetArbUp} command. 1832% the \cs{SetArbUp} command.
1825% 1833%
1834% \paragraph{\arb[trans]{'i`rAb} boundaries}
1835% Every declinable noun (\arb[trans]{mu`rab}) may be declined either
1836% with or without \arb[trans]{tanwIn}, viz. \arb[trans]{mun.sarifuN}
1837% or \arb[trans]{.gayr-u mun.sarifiN}. The former is automatically
1838% parsed by \package{arabluatex}, whereas the latter has to be
1839% delimited with an hyphen, like so:---
1840% \begin{quote}
1841% \arb[trans]{\textbf{mun.sarif}}: |mu`allimuN|
1842% \arb[voc]{mu`allimuN} \arb[trans]{mu`allimuN}, |kA'inuN|
1843% \arb[voc]{kA'inuN} \arb[trans]{kA'inuN}, |kA'inAtuN|
1844% \arb[voc]{kA'inAtuN} \arb[trans]{kA'inAtuN}, |\cap{`amraNU}|
1845% \arb[voc]{\cap{`amraNU}} \arb[trans]{\cap{`amraNU}}, |fataN_A|
1846% \arb[voc]{fataN_A} \arb[trans]{fataN_A}.
1847%
1848% \arb[trans]{\textbf{.gayr mun.sarif}}: |al-mu`allim-u|
1849% \arb[voc]{al-mu`allim-u} \arb[trans]{al-mu`allim-u}, |kitAb-Ani|
1850% \arb[voc]{kitAb-Ani} \arb[trans]{kitAb-Ani}, |ra^sa'-Ani|
1851% \arb[voc]{ra^sa'-Ani} \arb[trans]{ra^sa'-Ani}, |sAriq-Una|
1852% \arb[voc]{sAriq-Una} \arb[trans]{sAriq-Una}, |qA.d-Una|
1853% \arb[voc]{qA.d-Una} \arb[trans]{qA.d-Una}, |al-.zulm-Atu|
1854% \arb[voc]{al-.zulm-Atu} \arb[trans]{al-.zulm-Atu}.
1855% \end{quote}
1856%
1857% \begin{quoting}
1858% \textsc{Rem.}~\emph{a.} As the \arb[trans]{tanwIn} is passed over
1859% in pronunciation when it is followed by the letters
1860% \arb[novoc]{r}, \arb[novoc]{l}, \arb[novoc]{m}, \arb[novoc]{w},
1861% \arb[novoc]{y} (see \vref{ref:assimilation}), it may be desirable
1862% to further distinguish it by putting it above the line, but not to
1863% do the same for \arb[trans]{.gayr mun.sarif} terminations. This
1864% can be achieved by simply omitting the hyphen before any
1865% \arb[trans]{.gayr mun.sarif} termination:---\\
1866% |kAna| |.ganiyyaN| |l_akinna-hu| |labisa| |^gubbaTaN| |mumazzaqaN|
1867% |'aydu-hA| \arb[voc]{kAna .ganiyyaN l_akinna-hu labisa ^gubbaTaN
1868% mumazzaqaN 'aydu-hA} \arb[trans]{kAna .ganiyyaN l_akinna-hu labisa
1869% ^gubbaTaN mumazzaqaN 'aydu-hA}.
1870%
1871% \textsc{Rem.}~\emph{b.} Although the hyphen before the
1872% \arb[trans]{tanwIn} is optional as \package{arabluatex} always
1873% parses nouns with such termination, it may also be used to mark
1874% better the inflectional endings:---\\
1875% |mana`a| |'l-nAs-a| |kAffaT-aN| |min| |mu_hA.tabati-hi|
1876% |'a.had-uN| |bi-sayyidi-nA| \arb[voc]{mana`a 'l-nAs-a kAffaT-aN
1877% min mu_hA.tabati-hi 'a.had-uN bi-sayyidi-nA} \arb[trans]{mana`a
1878% 'l-nAs-a kAffaT-aN min mu_hA.tabati-hi 'a.had-uN bi-sayyidi-nA}.
1879% \end{quoting}
1880%
1826% \subsection{Examples} 1881% \subsection{Examples}
1827% \label{sec:examples-translit} 1882% \label{sec:examples-translit}
1828% Here follows in transliteration the story of 1883% Here follows in transliteration the story of
@@ -2226,7 +2281,7 @@ wa-ya.sIru ta.hta 'l-jild-i
2226% \end{macrocode} 2281% \end{macrocode}
2227% \end{macro} 2282% \end{macro}
2228% \begin{macro}{\arbup} 2283% \begin{macro}{\arbup}
2229% \changes{v1.3}{2016/05/19}{\arb[trans]{tanwIn} is now written as 2284% \changes{v1.3}{2016/05/19}{\arb[trans]{'i`rAb} is now written as
2230% superscript text in \texttt{dmg} mode by default.} 2285% superscript text in \texttt{dmg} mode by default.}
2231% \begin{macro}{\NoArbUp} 2286% \begin{macro}{\NoArbUp}
2232% \begin{macro}{\ArbUpDflt} 2287% \begin{macro}{\ArbUpDflt}