aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRobert Alessi <alessi@robertalessi.net>2016-12-17 14:44:00 +0100
committerRobert Alessi <alessi@robertalessi.net>2016-12-17 14:44:00 +0100
commit691967091af4145114f5fee6c65d234896413efa (patch)
treec68760027290a1cf5d4768080ccfc200ccd4687f
parentc4bb186ab38a68a4f44028848d3bfbecb9ee84bb (diff)
downloadarabluatex-691967091af4145114f5fee6c65d234896413efa.tar.gz
a few additions in the documentation
-rw-r--r--arabluatex.dtx71
1 files changed, 39 insertions, 32 deletions
diff --git a/arabluatex.dtx b/arabluatex.dtx
index 041620c..e1fda64 100644
--- a/arabluatex.dtx
+++ b/arabluatex.dtx
@@ -516,18 +516,20 @@
516% \DescribeMacro{\SetArbEasy} \NEWfeature{v1.4.4} 516% \DescribeMacro{\SetArbEasy} \NEWfeature{v1.4.4}
517% \DescribeMacro{\SetArbEasy*} \DescribeMacro{\SetArbDflt} Such 517% \DescribeMacro{\SetArbEasy*} \DescribeMacro{\SetArbDflt} Such
518% refinements as \enquote*{classic} \arb[trans]{maddaT} may be 518% refinements as \enquote*{classic} \arb[trans]{maddaT} may be
519% discarded by the command \cs{SetArb\allowbreak{}Easy}, either globally in the 519% discarded by the command \cs{SetArb\allowbreak{}Easy}, either
520% preamble or locally at any point of the document. The difference 520% globally in the preamble or locally at any point of the
521% between \cs{SetArbEasy} and its \enquote*{starred} version 521% document. The difference between \cs{SetArbEasy} and its
522% \cs{SetArbEasy*} is that the former keeps the \arb[trans]{sukUn} 522% \enquote*{starred} version \cs{SetArbEasy*} is that the former keeps
523% that is generated by the |fullvoc| mode, while the latter further 523% the \arb[trans]{sukUn} that is generated by the |fullvoc| mode,
524% takes it away. Default \enquote*{classic} rules may be set back at 524% while the latter further takes it away. Default \enquote*{classic}
525% any point of the document with the command 525% rules may be set back at any point of the document with the command
526% \cs{SetArbDflt}. \NEWfeature{v1.6} 526% \cs{SetArbDflt}. \NEWfeature{v1.6}
527% \DescribeMacro{\SetArbDflt*}Assimilation rules laid on 527% \DescribeMacro{\SetArbDflt*}Assimilation rules laid on
528% \vref{ref:assimilation} may also be applied by the 528% \vref{ref:assimilation} may also be applied by the
529% \enquote*{starred} version of this command \cs{SetArbDflt*} either 529% \enquote*{starred} version of this command \cs{SetArbDflt*} either
530% in the preamble or at any point of the document. Examples follow:--- 530% in the preamble or at any point of the document.\footnote{For an
531% example, see \vref{sec:poetry-example}.} Examples
532% follow:---
531% \begin{compactenum}[(a)] 533% \begin{compactenum}[(a)]
532% \item \cs{SetArbDflt}: 534% \item \cs{SetArbDflt}:
533% \begin{compactenum}[i.] 535% \begin{compactenum}[i.]
@@ -1804,7 +1806,7 @@ vowels (see §~3).
1804% The description of the optional arguments follows:--- 1806% The description of the optional arguments follows:---
1805% 1807%
1806% \DescribeOption{mode} |mode|$=$\meta{mode}, either |voc|, |fullvoc|, 1808% \DescribeOption{mode} |mode|$=$\meta{mode}, either |voc|, |fullvoc|,
1807% |novoc| or |trans|. The default mode is the one which is set at load 1809% |novoc| or |trans|. The default mode is the one that is set at load
1808% time as already seen \vref{sec:options}. 1810% time as already seen \vref{sec:options}.
1809% 1811%
1810% \DescribeOption{width} |width|$=$\meta{length} 1812% \DescribeOption{width} |width|$=$\meta{length}
@@ -1891,10 +1893,10 @@ vowels (see §~3).
1891% 'l-wa.sl-i},\footnote{See \vref{ref:definite-article}} while the 1893% 'l-wa.sl-i},\footnote{See \vref{ref:definite-article}} while the
1892% following two select the figure of the letter \arb[trans]{lAm} 1894% following two select the figure of the letter \arb[trans]{lAm}
1893% connected with a following letter. In the \arb[trans]{`a^guz}, the 1895% connected with a following letter. In the \arb[trans]{`a^guz}, the
1894% first two hyphens select the letter \arb[trans]{yA'} connected with 1896% last two hyphens select the letter \arb[trans]{yA'} connected with a
1895% a preceding letter, while the last one is simply discarded in this 1897% preceding letter, while the first one is simply discarded in this
1896% mode, but may appear as it should, if the |trans| mode be 1898% mode, but still may appear as it should, if the |trans| mode be
1897% selected:--- 1899% selected:---%
1898% \iffalse 1900% \iffalse
1899%<*example> 1901%<*example>
1900% \fi 1902% \fi
@@ -1930,7 +1932,7 @@ vowels (see §~3).
1930% \arb[trans]{.sadr} and the second to the \arb[trans]{`a^guz}. One 1932% \arb[trans]{.sadr} and the second to the \arb[trans]{`a^guz}. One
1931% solution to avoid splitting this word in such a way is to write 1933% solution to avoid splitting this word in such a way is to write
1932% inside the \arb[trans]{tadwIr} the part of it that belongs to either 1934% inside the \arb[trans]{tadwIr} the part of it that belongs to either
1933% hemistichs, without omitting to add a space after it. In the second 1935% hemistich, without omitting to add a space after it. In the second
1934% line, the word \arb{'ummu} should be split into \arb{'um"-- --mu}, 1936% line, the word \arb{'ummu} should be split into \arb{'um"-- --mu},
1935% so that the only way to avoid splitting it into two parts is to 1937% so that the only way to avoid splitting it into two parts is to
1936% write it all inside the \arb[trans]{tadwIr}. In that case, as the 1938% write it all inside the \arb[trans]{tadwIr}. In that case, as the
@@ -1952,9 +1954,9 @@ vowels (see §~3).
1952% there are two easy ways to have them printed. 1954% there are two easy ways to have them printed.
1953% 1955%
1954% If they are little in number, each footnote may be split into pairs 1956% If they are little in number, each footnote may be split into pairs
1955% of |\footnotemark{}| (please mind the braces) in either argument of 1957% of \cs{footnote\allowbreak{}mark}|{}| (please mind the braces) in
1956% the \cs{bayt} command and |\footnotetext{}| outside the \cs{bayt} 1958% either argument of the \cs{bayt} command and \cs{footnotetext}
1957% command. 1959% outside the \cs{bayt} command.
1958% 1960%
1959% If the footnotes are abundant in number, it is advised to load the 1961% If the footnotes are abundant in number, it is advised to load the
1960% \package{footnote} package which \package{arabluatex} will then use 1962% \package{footnote} package which \package{arabluatex} will then use
@@ -1970,17 +1972,22 @@ vowels (see §~3).
1970% 1972%
1971% \subsection{Example} 1973% \subsection{Example}
1972% \label{sec:poetry-example} 1974% \label{sec:poetry-example}
1973% Here follows the first lines of \arb[trans]{\upshape{}\cap{i}mru'u 1975% Here follow the first lines of \arb[trans]{\upshape{}\cap{i}mru'u
1974% 'l-\cap{q}aysi}'s \arb[trans]{\cap{m}u`allaqaT}:---% 1976% 'l-\cap{q}aysi}'s \arb[trans]{\cap{m}u`allaqaT}. In this example,
1977% \cs{SetArbDflt*} has been selected so as to mark the
1978% \arb[trans]{'id.gAm} that is fit to this declamatory
1979% poetry:---\footnote{See \vref{sec:classic-modern-typesetting} for
1980% more information.}%
1975% \iffalse 1981% \iffalse
1976%<*example> 1982%<*example>
1977% \fi 1983% \fi
1978\begin{arabluaverbatim} 1984\begin{arabluaverbatim}
1979\begin{arab}[fullvoc] 1985\begin{arab}[fullvoc]
1980 qAla \cap{i}mru'u 'l-\cap{q}aysi fI ^si`ri-hi 'l-\cap{m}u`allaqaTi: 1986 qAla \cap{i}mru'u 'l-\cap{q}aysi fI mu`allaqati-hi:
1981\end{arab} 1987\end{arab}
1982 1988
1983\begin{arabverse}[mode=fullvoc, metre=(al-.tawIlu)] 1989\begin{arabverse}[mode=fullvoc, metre={(al-.darbu 'l-_tAnI mina
1990 'l-`arU.di 'l-'_Ul_A mina 'l-.tawIli)}]
1984 \SetArbDflt* 1991 \SetArbDflt*
1985 \begin{linenumbers*} 1992 \begin{linenumbers*}
1986 \bayt{qifA nabki min _dikr_A .habibiN wa-manzili}{bi-saq.ti 1993 \bayt{qifA nabki min _dikr_A .habibiN wa-manzili}{bi-saq.ti
@@ -1989,7 +1996,7 @@ vowels (see §~3).
1989 rasmu-hA}{limA nasa^gat-hA min ^ganUbiN wa-^sam'ali}\\ 1996 rasmu-hA}{limA nasa^gat-hA min ^ganUbiN wa-^sam'ali}\\
1990 \bayt{tar_A ba`ara 'l-'ar'Ami fI `ara.sAti-hA}{wa-qI`Ani-hA 1997 \bayt{tar_A ba`ara 'l-'ar'Ami fI `ara.sAti-hA}{wa-qI`Ani-hA
1991 ka-'anna-hu .habbu fulfuli}\\ 1998 ka-'anna-hu .habbu fulfuli}\\
1992 \bayt{ka-'annI .gadATa 'l-bayni yawma ta.hammalUA}{lad_A 1999 \bayt{ka-'annI .gadATa 'l-bayni yawma ta.hammalUA}{laday
1993 samurAti 'l-.hayyi nAqifu .han.zali}\\ 2000 samurAti 'l-.hayyi nAqifu .han.zali}\\
1994 \bayt{wuqUfaN bi-hA .sa.hbI `alayya ma.tiyya-hum}{yaqUlUna lA 2001 \bayt{wuqUfaN bi-hA .sa.hbI `alayya ma.tiyya-hum}{yaqUlUna lA
1995 tahlik 'asaN_A wa-ta^gammali}\\ 2002 tahlik 'asaN_A wa-ta^gammali}\\
@@ -2002,12 +2009,12 @@ vowels (see §~3).
2002%</example> 2009%</example>
2003% \fi% 2010% \fi%
2004% \begin{arab}[fullvoc] 2011% \begin{arab}[fullvoc]
2005% qAla \cap{i}mru'u 'l-\cap{q}aysi fI ^si`ri-hi 2012% qAla \cap{i}mru'u 'l-\cap{q}aysi fI mu`allaqati-hi:
2006% 'l-\cap{m}u`allaqaTi:
2007% \end{arab} 2013% \end{arab}
2008% 2014%
2009% \begin{arabverse}[mode=fullvoc, metre=(al-.tawIlu), width=.25\linewidth] 2015% \begin{arabverse}[mode=fullvoc, metre={(al-.darbu 'l-_tAnI mina
2010% \SetArbDflt* 2016% 'l-`arU.di 'l-'_Ul_A mina 'l-.tawIli)}, width=.25\linewidth]
2017% \SetArbDflt*
2011% \begin{linenumbers*} 2018% \begin{linenumbers*}
2012% \bayt{qifA nabki min _dikr_A .habibiN wa-manzili}{bi-saq.ti 2019% \bayt{qifA nabki min _dikr_A .habibiN wa-manzili}{bi-saq.ti
2013% 'l-liw_A bayna \cap{'l-da_hUl}i wa-\cap{.h}awmali}\\ 2020% 'l-liw_A bayna \cap{'l-da_hUl}i wa-\cap{.h}awmali}\\
@@ -2015,7 +2022,7 @@ vowels (see §~3).
2015% rasmu-hA}{limA nasa^gat-hA min ^ganUbiN wa-^sam'ali}\\ 2022% rasmu-hA}{limA nasa^gat-hA min ^ganUbiN wa-^sam'ali}\\
2016% \bayt{tar_A ba`ara 'l-'ar'Ami fI `ara.sAti-hA}{wa-qI`Ani-hA 2023% \bayt{tar_A ba`ara 'l-'ar'Ami fI `ara.sAti-hA}{wa-qI`Ani-hA
2017% ka-'anna-hu .habbu fulfuli}\\ 2024% ka-'anna-hu .habbu fulfuli}\\
2018% \bayt{ka-'annI .gadATa 'l-bayni yawma ta.hammalUA}{lad_A 2025% \bayt{ka-'annI .gadATa 'l-bayni yawma ta.hammalUA}{laday
2019% samurAti 2026% samurAti
2020% 'l-.hayyi nAqifu .han.zali}\\ 2027% 'l-.hayyi nAqifu .han.zali}\\
2021% \bayt{wuqUfaN bi-hA .sa.hbI `alayya ma.tiyya-hum}{yaqUlUna lA 2028% \bayt{wuqUfaN bi-hA .sa.hbI `alayya ma.tiyya-hum}{yaqUlUna lA
@@ -2026,12 +2033,12 @@ vowels (see §~3).
2026% \end{arabverse} 2033% \end{arabverse}
2027% 2034%
2028% \begin{arab}[trans] 2035% \begin{arab}[trans]
2029% qAla \cap{i}mru'u 'l-\cap{q}aysi fI ^si`ri-hi 2036% qAla \cap{i}mru'u 'l-\cap{q}aysi fI mu`allaqati-hi:
2030% 'l-\cap{m}u`allaqaTi:
2031% \end{arab} 2037% \end{arab}
2032% 2038%
2033% \begin{arabverse}[mode=trans, metre=(al-.tawIlu), width=.4\linewidth] 2039% \begin{arabverse}[mode=trans, metre={(al-.darbu 'l-_tAnI mina
2034% \SetArbDflt* 2040% 'l-`arU.di 'l-'_Ul_A mina 'l-.tawIli)}, width=.4\linewidth]
2041% \SetArbDflt*
2035% \begin{linenumbers*} 2042% \begin{linenumbers*}
2036% \bayt{qifA nabki min _dikr_A .habibiN wa-manzili}{bi-saq.ti 2043% \bayt{qifA nabki min _dikr_A .habibiN wa-manzili}{bi-saq.ti
2037% 'l-liw_A bayna \cap{'l-da_hUl}i wa-\cap{.h}awmali}\\ 2044% 'l-liw_A bayna \cap{'l-da_hUl}i wa-\cap{.h}awmali}\\
@@ -2039,7 +2046,7 @@ vowels (see §~3).
2039% rasmu-hA}{limA nasa^gat-hA min ^ganUbiN wa-^sam'ali}\\ 2046% rasmu-hA}{limA nasa^gat-hA min ^ganUbiN wa-^sam'ali}\\
2040% \bayt{tar_A ba`ara 'l-'ar'Ami fI `ara.sAti-hA}{wa-qI`Ani-hA 2047% \bayt{tar_A ba`ara 'l-'ar'Ami fI `ara.sAti-hA}{wa-qI`Ani-hA
2041% ka-'anna-hu .habbu fulfuli}\\ 2048% ka-'anna-hu .habbu fulfuli}\\
2042% \bayt{ka-'annI .gadATa 'l-bayni yawma ta.hammalUA}{lad_A 2049% \bayt{ka-'annI .gadATa 'l-bayni yawma ta.hammalUA}{laday
2043% samurAti 2050% samurAti
2044% 'l-.hayyi nAqifu .han.zali}\\ 2051% 'l-.hayyi nAqifu .han.zali}\\
2045% \bayt{wuqUfaN bi-hA .sa.hbI `alayya ma.tiyya-hum}{yaqUlUna lA 2052% \bayt{wuqUfaN bi-hA .sa.hbI `alayya ma.tiyya-hum}{yaqUlUna lA