aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--arabluatex.dtx62
1 files changed, 36 insertions, 26 deletions
diff --git a/arabluatex.dtx b/arabluatex.dtx
index fb96ad5..e4ecaa0 100644
--- a/arabluatex.dtx
+++ b/arabluatex.dtx
@@ -151,7 +151,8 @@
151\usepackage{dox} 151\usepackage{dox}
152\doxitem{Option}{option}{options} 152\doxitem{Option}{option}{options}
153%\def\actualchar{ =} % there's a bug in doxitem; quick fix. 153%\def\actualchar{ =} % there's a bug in doxitem; quick fix.
154\usepackage{fontspec,luatextra} 154\usepackage{fontspec}
155\usepackage{hologo}
155\defaultfontfeatures{RawFeature={+liga}} 156\defaultfontfeatures{RawFeature={+liga}}
156\setmainfont{Old Standard}[SmallCapsFont={Latin Modern Roman Caps}, 157\setmainfont{Old Standard}[SmallCapsFont={Latin Modern Roman Caps},
157 RawFeature={+mark;+ccmp;+ss05;+ss06}] 158 RawFeature={+mark;+ccmp;+ss05;+ss06}]
@@ -310,7 +311,7 @@
310% \normalsize 311% \normalsize
311% 312%
312% \begin{abstract} 313% \begin{abstract}
313% This package provides for \LuaLaTeX\ an Arab{\TeX}-like interface 314% This package provides for \hologo{LuaLaTeX} an Arab{\TeX}-like interface
314% to generate Arabic writing from an \textsc{ascii} 315% to generate Arabic writing from an \textsc{ascii}
315% transliteration. It is particularly well-suited for complex 316% transliteration. It is particularly well-suited for complex
316% documents such as technical documents or critical editions where a 317% documents such as technical documents or critical editions where a
@@ -387,10 +388,10 @@
387% 388%
388% \section{Introduction} 389% \section{Introduction}
389% In comparison to Prof. Lagally's outstanding Arab\TeX,\footnote{See 390% In comparison to Prof. Lagally's outstanding Arab\TeX,\footnote{See
390% \url{http://ctan.org/pkg/arabtex}} Arab\LuaTeX\ is at present 391% \url{http://ctan.org/pkg/arabtex}} Arab\hologo{LuaTeX} is at present
391% nothing more than a modest piece of software. Hopefully---if I may 392% nothing more than a modest piece of software. Hopefully---if I may
392% say so---it will eventually provide all of its valuable qualities to 393% say so---it will eventually provide all of its valuable qualities to
393% the \LuaLaTeX\ users. 394% the \hologo{LuaLaTeX} users.
394% 395%
395% \package{arabtex} dates back to 1992. As far as I know, it was then 396% \package{arabtex} dates back to 1992. As far as I know, it was then
396% the first and only way to typeset Arabic texts with \TeX\ and 397% the first and only way to typeset Arabic texts with \TeX\ and
@@ -451,18 +452,18 @@
451% lexicons that can be searched, analyzed and correlated in various 452% lexicons that can be searched, analyzed and correlated in various
452% ways. 453% ways.
453% 454%
454%\subsection{\package{arabluatex} is for \LuaLaTeX} 455%\subsection{\package{arabluatex} is for \hologo{LuaLaTeX}}
455% It goes without saying that \package{arabluatex} requires 456% It goes without saying that \package{arabluatex} requires
456% \LuaLaTeX. \TeX\ and \LaTeX\ have \package{arabtex}, and \XeLaTeX\ 457% \hologo{LuaLaTeX}. \TeX\ and \LaTeX\ have \package{arabtex}, and
457% has \package{arabxetex}. Both of them are much more advanced than 458% \hologo{XeLaTeX} has \package{arabxetex}. Both of them are much more
458% \package{arabluatex}, as they can process a number of different 459% advanced than \package{arabluatex}, as they can process a number of
459% languages,\footnote{\label{fn:arabtex-languages}To date, both 460% different languages,\footnote{\label{fn:arabtex-languages}To date,
460% packages support Arabic, Maghribi, Urdu, Pashto, Sindhi, Kashmiri, 461% both packages support Arabic, Maghribi, Urdu, Pashto, Sindhi,
461% Uighuric and Old Malay; in addition to these, \package{arabtex} also 462% Kashmiri, Uighuric and Old Malay; in addition to these,
462% has a Hebrew mode, including Judeo-Arabic and Yiddish.} whereas 463% \package{arabtex} also has a Hebrew mode, including Judeo-Arabic and
463% \package{arabluatex} can process only Arabic for the time 464% Yiddish.} whereas \package{arabluatex} can process only Arabic for
464% being. More languages will be included in future releases of 465% the time being. More languages will be included in future releases
465% \package{arabluatex}. 466% of \package{arabluatex}.
466% 467%
467% In comparison to \package{arabxetex}, \package{arabluatex} works in 468% In comparison to \package{arabxetex}, \package{arabluatex} works in
468% a very different way. The former relies on the 469% a very different way. The former relies on the
@@ -484,8 +485,8 @@
484% \subsection{Activating \package{arabluatex}} 485% \subsection{Activating \package{arabluatex}}
485% As usual put in your preamble:\\ 486% As usual put in your preamble:\\
486% \arabluaverb{\usepackage{arabluatex}}\\ 487% \arabluaverb{\usepackage{arabluatex}}\\
487% The only requirement of \package{arabluatex} is \LuaLaTeX; it will 488% The only requirement of \package{arabluatex} is \hologo{LuaLaTeX};
488% complain if you try to compile your document with another 489% it will complain if you try to compile your document with another
489% engine. That aside, \package{arabluatex} does not load packages such 490% engine. That aside, \package{arabluatex} does not load packages such
490% as \package{polyglossia} or \package{luabidi}. It can work with 491% as \package{polyglossia} or \package{luabidi}. It can work with
491% \package{polyglossia} though, but does not require it. 492% \package{polyglossia} though, but does not require it.
@@ -3085,10 +3086,11 @@ muhaddamaTaN mi'_danatu-hu}: \arb[trans]{ra'aytu
3085% \label{sec:commands-in-arb} 3086% \label{sec:commands-in-arb}
3086% \paragraph{General principle} \label{ref:cmd-inside-arabic}\LaTeX\ 3087% \paragraph{General principle} \label{ref:cmd-inside-arabic}\LaTeX\
3087% commands are accepted in Arabic environments. The general principle 3088% commands are accepted in Arabic environments. The general principle
3088% which applies is that single-argument commands 3089% which applies is that any single-argument command with up to
3089% (\cs{command}\marg{arg}) such as \cs{emph}\marg{text}, 3090% \emph{two optional arguments}
3090% \cs{textbf}\marg{text} and the like, are assumed to have Arabic text 3091% (\cs{command}\oarg{opt1}\oarg{opt2}\marg{arg}) such as
3091% as their arguments:--- 3092% \cs{emph}\marg{text}, \cs{textbf}\marg{text} and the like, is
3093% assumed to have Arabic text in its mandatory argument:---
3092% \begin{quote} 3094% \begin{quote}
3093% |\abjad{45}| |kitAbu-hu| |\emph{fI| |'l-\uc{`AdAt-i}}| 3095% |\abjad{45}| |kitAbu-hu| |\emph{fI| |'l-\uc{`AdAt-i}}|
3094% \arb[voc]{\abjad{45} kitAbu-hu \emph{fI 'l-\uc{`AdAt-i}}} 3096% \arb[voc]{\abjad{45} kitAbu-hu \emph{fI 'l-\uc{`AdAt-i}}}
@@ -3096,6 +3098,9 @@ muhaddamaTaN mi'_danatu-hu}: \arb[trans]{ra'aytu
3096% 'l-\uc{`AdAt-i}}}.\footnote{This is odd in Arabic script, but 3098% 'l-\uc{`AdAt-i}}}.\footnote{This is odd in Arabic script, but
3097% using such features as \cs{emph} or \cs{textbf} is a matter of 3099% using such features as \cs{emph} or \cs{textbf} is a matter of
3098% personal taste.} 3100% personal taste.}
3101%
3102% |\arb{\abjad{45} \framebox[1in][s]{kitAbu-hu fI 'l-`AdAti}}|\\
3103% \arb{\abjad{45} \framebox[1in][s]{kitAbu-hu fI 'l-`AdAti}}
3099% \end{quote} 3104% \end{quote}
3100% 3105%
3101% The same applies to footnotes:--- 3106% The same applies to footnotes:---
@@ -3246,7 +3251,8 @@ qAla barzawayhi bn-u 'azhar-a, ra's-u 'a.tibbA'-i fAris-a...
3246% \package{arabluatex}. Therefore, as in the previous example, any of 3251% \package{arabluatex}. Therefore, as in the previous example, any of
3247% their argument to be rendered in Arabic must be inserted again in 3252% their argument to be rendered in Arabic must be inserted again in
3248% \cs{arb}. \NEWfeature{v1.12}These commands themselves may have up to 3253% \cs{arb}. \NEWfeature{v1.12}These commands themselves may have up to
3249% two optional and/or mandatory arguments, like so:--- 3254% two optional and/or mandatory arguments followed by one optional
3255% argument, like so:---
3250% \begin{enumerate} 3256% \begin{enumerate}
3251% \item \cs{command} (no argument, lowermost combination) 3257% \item \cs{command} (no argument, lowermost combination)
3252% \item \cs{command}\oarg{opt1} (one optional argument) 3258% \item \cs{command}\oarg{opt1} (one optional argument)
@@ -3255,9 +3261,13 @@ qAla barzawayhi bn-u 'azhar-a, ra's-u 'a.tibbA'-i fAris-a...
3255% mandatory argument) 3261% mandatory argument)
3256% \item{} [\ldots] 3262% \item{} [\ldots]
3257% \item \cs{command}\oarg{opt1}\oarg{opt2}\marg{arg1}\marg{arg2} 3263% \item \cs{command}\oarg{opt1}\oarg{opt2}\marg{arg1}\marg{arg2}
3258% (uppermost combination) 3264% \item
3265% \cs{command}\oarg{opt1}\oarg{opt2}\marg{arg1}\marg{arg2}\oarg{opt3}
3266% (uppermost combination)
3259% \end{enumerate} 3267% \end{enumerate}
3260% 3268%
3269% \DescribeMacro{\MkArbBreak*}\NEWfeature{v1.12} As said above,
3270% \cs{MkArbBreak}
3261% 3271%
3262% \subsection{Environments} 3272% \subsection{Environments}
3263% \label{sec:environments} 3273% \label{sec:environments}
@@ -3615,8 +3625,8 @@ wa-ya.sIru ta.hta 'l-jild-i
3615[2018/03/31 v1.11 An ArabTeX-like interface for LuaLaTeX] 3625[2018/03/31 v1.11 An ArabTeX-like interface for LuaLaTeX]
3616\RequirePackage{ifluatex} 3626\RequirePackage{ifluatex}
3617% \end{macrocode} 3627% \end{macrocode}
3618% \package{arabluatex} requires \LuaLaTeX\ of course. Issue a warning 3628% \package{arabluatex} requires \hologo{LuaLaTeX} of course. Issue a
3619% if the document is processed with another engine. 3629% warning if the document is processed with another engine.
3620% \begin{macrocode} 3630% \begin{macrocode}
3621\ifluatex\else 3631\ifluatex\else
3622 \PackageError{arabluatex}{lualatex needed}{% 3632 \PackageError{arabluatex}{lualatex needed}{%
@@ -4194,7 +4204,7 @@ wa-ya.sIru ta.hta 'l-jild-i
4194% 4204%
4195% The following is taken from |latex.ltx|. I had to make this patch 4205% The following is taken from |latex.ltx|. I had to make this patch
4196% for I could not find a way to process the list environments in 4206% for I could not find a way to process the list environments in
4197% right-to-left mode. The \LuaTeX\ primitives \cs{bodydir} and 4207% right-to-left mode. The \hologo{LuaTeX} primitives \cs{bodydir} and
4198% \cs{pagedir} will eventually allow us to get rid of this: 4208% \cs{pagedir} will eventually allow us to get rid of this:
4199% \begin{macrocode} 4209% \begin{macrocode}
4200\def\list#1#2{% 4210\def\list#1#2{%