From 5db636f4d15cdd2e07e273d0b1819f35c8ae1dd5 Mon Sep 17 00:00:00 2001 From: Robert Alessi Date: Wed, 30 Nov 2016 19:36:56 +0100 Subject: updated documentation --- arabluatex.dtx | 67 ++++++++++++++++++++++++++++++++++++++++------------------ 1 file changed, 47 insertions(+), 20 deletions(-) diff --git a/arabluatex.dtx b/arabluatex.dtx index 4bd9057..f85c0c5 100644 --- a/arabluatex.dtx +++ b/arabluatex.dtx @@ -191,8 +191,11 @@ \CodelineIndex \begin{document} \DocInput{arabluatex.dtx} + \printbibliography[heading=bibintoc] + \phantomsection \addcontentsline{toc}{section}{Change History} \PrintChanges + \phantomsection \addcontentsline{toc}{section}{Index} \PrintIndex \end{document} @@ -506,21 +509,24 @@ % \end{quote} % \item The euphonic \arb[trans]{ta^sdId} is generated (see % \vpageref{ref:euphonic-tashdid}). -% \item Assimilation rules laid on \vref{ref:assimilation} are -% applied. % \item In |fullvoc| mode, the \arb[trans]{sukUn} is expressed. % \end{compactitem} % % \DescribeMacro{\SetArbEasy} \NEWfeature{v1.4.4} % \DescribeMacro{\SetArbEasy*} \DescribeMacro{\SetArbDflt} Such -% refinements may be discarded by the command \cs{SetArbEasy}, either -% globally in the preamble or locally at any point of the -% document. The difference between \cs{SetArbEasy} and its -% \enquote*{starred} version \cs{SetArbEasy*} is that the former keeps -% the \arb[trans]{sukUn} that is generated by the |fullvoc| mode, -% while the latter further takes it away. Default \enquote*{classic} -% rules may be set back at any point of the document with the command -% \cs{SetArbDflt}. Examples follow:--- +% refinements as \enquote*{classic} \arb[trans]{maddaT} may be +% discarded by the command \cs{SetArb\allowbreak{}Easy}, either globally in the +% preamble or locally at any point of the document. The difference +% between \cs{SetArbEasy} and its \enquote*{starred} version +% \cs{SetArbEasy*} is that the former keeps the \arb[trans]{sukUn} +% that is generated by the |fullvoc| mode, while the latter further +% takes it away. Default \enquote*{classic} rules may be set back at +% any point of the document with the command +% \cs{SetArbDflt}. \NEWfeature{v1.6} +% \DescribeMacro{\SetArbDflt*}Assimilation rules laid on +% \vref{ref:assimilation} may also be applied by the +% \enquote*{starred} version of this command \cs{SetArbDflt*} either +% in the preamble or at any point of the document. Examples follow:--- % \begin{compactenum}[(a)] % \item \cs{SetArbDflt}: % \begin{compactenum}[i.] @@ -531,6 +537,15 @@ % \item |trans| \arb[trans]{wa-mAta istisqA'aN qabla 'an yutimma % kitAba-hu fI nujUm-i 'l-samA'-i} % \end{compactenum} +% \item \cs{SetArbDflt*}: +% \begin{compactenum}[i.]\SetArbDflt* +% \item |voc| \arb[voc]{wa-mAta istisqA'aN qabla 'an yutimma +% kitAba-hu fI nujUm-i 'l-samA'-i} +% \item |fullvoc| \arb[fullvoc]{wa-mAta istisqA'aN qabla 'an yutimma +% kitAba-hu fI nujUm-i 'l-samA'-i} +% \item |trans| \arb[trans]{wa-mAta istisqA'aN qabla 'an yutimma +% kitAba-hu fI nujUm-i 'l-samA'-i}\SetArbDflt +% \end{compactenum} % \item \cs{SetArbEasy}: % \begin{compactenum}[i.]\SetArbEasy % \item |voc| \arb[voc]{wa-mAta istisqA'aN qabla 'an yutimma @@ -1153,7 +1168,7 @@ vowels (see §~3). % \arb[novoc]{l}, \arb[novoc]{m}, \arb[novoc]{w}, \arb[novoc]{y} % after \arb[voc]{n} with \arb[trans]{jazmaT}, and also after the % \arb[trans]{tanwIn}:--- -% \begin{quote} +% \begin{quote}\SetArbDflt* % Note the absence of \arb[trans]{sukUn} above the passed over % \arb[novoc]{n} in the following examples, each of which is % accompanied by a consistent transliteration: |min rabbi-hi| @@ -1162,8 +1177,22 @@ vowels (see §~3). % |'an| |yaqtula| \arb[fullvoc]{'an yaqtula} \arb[trans]{'an yaqtula}. % % With \arb[trans]{tanwIn}: |kitAbuN| |mubInuN| \arb[voc]{kitAbuN -% mubInuN} \arb[trans]{kitAbuN mubInuN}. +% mubInuN} \arb[trans]{kitAbuN mubInuN}.\SetArbDflt % \end{quote} +% \iffalse +%<*example> +% \fi +\begin{arabluacode}[text only] + \textsc{Rem.} This particular feature must be put into operation by + the command \cs{SetArbDflt*} explicitly. See above + \vref{sec:classic-modern-typesetting} for further details. Other + kinds of assimilations, including the various cases of + \arb[trans]{'id.gAm}, will be included in \package{arabluatex} + gradually. +\end{arabluacode} +% \iffalse +% +% \fi % \item With the letter \arb[voc]{t} after the dentals % \arb[novoc]{_t}, \arb[novoc]{d}, \arb[novoc]{_d}, \arb[novoc]{.d}, % \arb[novoc]{.t}, \arb[novoc]{.z} in certain parts of the verb: @@ -1540,7 +1569,7 @@ vowels (see §~3). % \end{quote} % % \subsubsection{\texorpdfstring{Quoting the -% \arb[trans]{hamzaT}}{Quoting the hamza}} +% \arb[trans]{hamzaT}}{Quoting the hamzah}} % \label{sec:quoting-hamza} % As said above in \vref{ref:hamza}, the \arb[trans]{hamzaT} is always % written \meta{\texttt{'}}, its carrier being determined by contextual @@ -2753,11 +2782,11 @@ wa-ya.sIru ta.hta 'l-jild-i % back at any point of the document with \cs{SetArbDflt}. % \begin{macro}{\SetArbDflt*} % \changes{v1.6}{2016/11/30}{This starred version applies the -% assimilation rules (\arb[trans]{al-'id.gAm}) in addition to what -% \cs{SetArbDflt} already does.} As of v1.6, \package{arabluatex} -% does not applies any more the assimilation rules that are laid on -% \vref{ref:assimilation}; a new starred version \cs{SetArbDflt*} is -% now available to the user should he wish to apply them. +% assimilation rules in addition to what \cs{SetArbDflt} already +% does.} As of v1.6, \package{arabluatex} does not applies any more +% the assimilation rules that are laid on \vref{ref:assimilation}; a +% new starred version \cs{SetArbDflt*} is now available to the user +% should he wish to apply them. % \begin{macrocode} \def\al@arb@rules{dflt} \NewDocumentCommand{\SetArbEasy}{s}{% @@ -3128,7 +3157,5 @@ wa-ya.sIru ta.hta 'l-jild-i % % \fi % -% \printbibliography[heading=bibintoc] -% % \Finale \endinput -- cgit v1.2.3