aboutsummaryrefslogtreecommitdiff
path: root/arabluatex.dtx
diff options
context:
space:
mode:
authorRobert Alessi <alessi@robertalessi.net>2016-03-14 15:50:45 +0100
committerRobert Alessi <alessi@robertalessi.net>2016-03-14 15:50:45 +0100
commit01d0809f81a7cf1f21d2774e447174959b9373cf (patch)
treef19b5b607fb76ecd0870139a67293dcbacbba741 /arabluatex.dtx
parent3a323f1740ab27c06354124b389e1e94d7e2c81b (diff)
downloadarabluatex-01d0809f81a7cf1f21d2774e447174959b9373cf.tar.gz
some corrections in the tables as |BaN|; still writing the documentation
Diffstat (limited to 'arabluatex.dtx')
-rw-r--r--arabluatex.dtx241
1 files changed, 208 insertions, 33 deletions
diff --git a/arabluatex.dtx b/arabluatex.dtx
index ef1a9a6..b388438 100644
--- a/arabluatex.dtx
+++ b/arabluatex.dtx
@@ -46,14 +46,21 @@
46\usepackage{multicol} 46\usepackage{multicol}
47\usepackage{paralist} 47\usepackage{paralist}
48\setdefaultitem{\textendash}{\textendash}{\textendash}{\textendash} 48\setdefaultitem{\textendash}{\textendash}{\textendash}{\textendash}
49\usepackage{varioref}
50\usepackage{quoting}
51\quotingsetup{noorphans, rightmargin=0pt}
52\renewcommand*{\quotingfont}{\footnotesize}
49\usepackage{longtable} 53\usepackage{longtable}
50\usepackage{booktabs} 54\usepackage{booktabs}
51\usepackage{tikz} 55\usepackage{tikz}
52\usepackage[breakable, skins,listings,xparse]{tcolorbox} 56\usepackage[breakable, skins, listings, xparse]{tcolorbox}
53\DeclareTCBListing{arabluacode}{s}{colback=white, boxrule=.15mm, 57\DeclareTCBListing{arabluacode}{s O{}}{colback=white, boxrule=.15mm,
54 colframe=red!50!white, listing options={style=tcblatex, 58 colframe=red!50!white, breakable, listing options={style=tcblatex,
55 numbers=left, numberstyle=\tiny}, IfBooleanTF={#1}{listing side 59 numbers=left, numberstyle=\tiny}, IfBooleanTF={#1}{listing side
56 text}{}} 60 text}{#2}}
61\DeclareTCBListing{arabluaverbatim}{}{colback=white, boxrule=.15mm,
62 colframe=red!50!white, breakable, listing options={style=tcblatex,
63 numbers=left, numberstyle=\tiny}, listing only}
57\DeclareTotalTCBox{\arabluaverb}{v}{verbatim, colback=white, 64\DeclareTotalTCBox{\arabluaverb}{v}{verbatim, colback=white,
58 boxrule=.15mm, colframe=red!50!white}{#1} 65 boxrule=.15mm, colframe=red!50!white}{#1}
59\DeclareTotalTCBox{\arabluabox}{m}{left=0mm, right=0mm, top=0mm, 66\DeclareTotalTCBox{\arabluabox}{m}{left=0mm, right=0mm, top=0mm,
@@ -61,6 +68,9 @@
61 colframe=red!50!white}{#1} 68 colframe=red!50!white}{#1}
62\newcommand{\package}[1]{\textsf{#1}\index{#1=#1 (package)}} 69\newcommand{\package}[1]{\textsf{#1}\index{#1=#1 (package)}}
63\usepackage{csquotes} 70\usepackage{csquotes}
71\DeclareQuoteStyle{arabic}
72{\rmfamily\textquotedblright}{\rmfamily\textquotedblleft}
73{\rmfamily\textquoteright}{\rmfamily\textquoteleft}
64\usepackage[style=authoryear, indexing=cite]{biblatex} 74\usepackage[style=authoryear, indexing=cite]{biblatex}
65\DeclareIndexFieldFormat{indextitle}{\index{#1=\emph{#1}}} 75\DeclareIndexFieldFormat{indextitle}{\index{#1=\emph{#1}}}
66\addbibresource{arabluatex.bib} 76\addbibresource{arabluatex.bib}
@@ -144,11 +154,11 @@
144% \section*{License and disclamer} 154% \section*{License and disclamer}
145% \addcontentsline{toc}{section}{License and disclamer} Please send 155% \addcontentsline{toc}{section}{License and disclamer} Please send
146% error reports and suggestions for improvements to Robert Alessi: 156% error reports and suggestions for improvements to Robert Alessi:
147% \begin{itemize} 157% \begin{compactitem}
148% \item email: <\href{mailto:alessi@robertalessi.net?Subject=arabluatex}% 158% \item email: <\href{mailto:alessi@robertalessi.net?Subject=arabluatex}%
149% {\texttt{alessi@{\allowbreak}robertalessi.net}}> 159% {\texttt{alessi@{\allowbreak}robertalessi.net}}>
150% \item website: \url{http://www.robertalessi.net/arabluatex} 160% \item website: \url{http://www.robertalessi.net/arabluatex}
151% \end{itemize} 161% \end{compactitem}
152% 162%
153% 163%
154% This program is free software; you can redistribute it and/or 164% This program is free software; you can redistribute it and/or
@@ -258,7 +268,7 @@
258% some other Arab\TeX\ input yet to be processed---for further 268% some other Arab\TeX\ input yet to be processed---for further
259% processing. 269% processing.
260% 270%
261% \section{Usage} 271% \section{The basics of \package{arabluatex}}
262% \subsection{Activating \package{arabluatex}} 272% \subsection{Activating \package{arabluatex}}
263% As usual put in your preamble:\\ 273% As usual put in your preamble:\\
264% \arabluaverb{\usepackage{arabluatex}}\\ 274% \arabluaverb{\usepackage{arabluatex}}\\
@@ -281,8 +291,8 @@
281% issue a warning message and attempt to load the Amiri 291% issue a warning message and attempt to load the Amiri
282% font\footnote{\textcite{pkg:amiri}.} like so:\\ 292% font\footnote{\textcite{pkg:amiri}.} like so:\\
283% \arabluaverb{\newfontfamily\arabicfont[Script=Arabic]{Amiri}} 293% \arabluaverb{\newfontfamily\arabicfont[Script=Arabic]{Amiri}}
284% \begin{quote}\footnotesize 294% \begin{quoting}
285% \textbf{Rem.} By default Amiri places the \arb[trans]{kasraT} in 295% \textsc{Rem.} By default Amiri places the \arb[trans]{kasraT} in
286% combination with the \arb[trans]{ta^sdId} below the consonant, 296% combination with the \arb[trans]{ta^sdId} below the consonant,
287% like so: \arb{BBi}\,. This is correct, as at least in the oldest 297% like so: \arb{BBi}\,. This is correct, as at least in the oldest
288% manuscripts {\newfontfamily\arabicfont[Script=Arabic, 298% manuscripts {\newfontfamily\arabicfont[Script=Arabic,
@@ -295,18 +305,18 @@
295% \arabluaverb{\newfontfamily\arabicfont[Script=Arabic,RawFeature={+ss05}]{Amiri}} 305% \arabluaverb{\newfontfamily\arabicfont[Script=Arabic,RawFeature={+ss05}]{Amiri}}
296% 306%
297% Other Arabic fonts may behave differently. 307% Other Arabic fonts may behave differently.
298% \end{quote} 308% \end{quoting}
299% 309%
300% \subsection{Options} 310% \subsection{Options}
301% \package{arabluatex} may be loaded with four global options, each of 311% \package{arabluatex} may be loaded with four global options, each of
302% which may be overriden at any point of the document: 312% which may be overriden at any point of the document (see below **):
303% 313%
304% \DescribeOption{voc}\hfill\arabluaverb{default}\\ In this mode, 314% \DescribeOption{voc}\hfill\arabluaverb{default}\\ In this mode,
305% which is the one selected by default, every short vowel written 315% which is the one selected by default, every short vowel written
306% generates its corresponding diacritical mark: \arb[trans]{.dammaT} 316% generates its corresponding diacritical mark: \arb[trans]{.dammaT}
307% (\arb{Bu}), \arb[trans]{fat.haT} (\arb{Ba}) and \arb[trans]{kasraT} 317% (\arb{Bu}), \arb[trans]{fat.haT} (\arb{Ba}) and \arb[trans]{kasraT}
308% (\arb{Bi}). If a vowel is followed by \meta{N}, then the 318% (\arb{Bi}). If a vowel is followed by \meta{uN, aN, iN}, then the
309% corresponding \arb[trans]{tanwIn} (\arb{BuN}, \arb{BaN}\,, 319% corresponding \arb[trans]{tanwIn} (\arb{BuN}, \arb{B|aN}\,,
310% \arb{TaN}, \arb{BaN_A} or \arb{BiN}) is generated. Finally, \meta{u, 320% \arb{TaN}, \arb{BaN_A} or \arb{BiN}) is generated. Finally, \meta{u,
311% a, i} at the commencement of a word indicate a \enquote{connective 321% a, i} at the commencement of a word indicate a \enquote{connective
312% \arb[trans]{'alif}\,} (\arb[trans]{'alifu 'l-wa.sli}), but |voc| mode 322% \arb[trans]{'alif}\,} (\arb[trans]{'alifu 'l-wa.sli}), but |voc| mode
@@ -318,16 +328,92 @@
318% \arb[trans]{wa.slaT}. 328% \arb[trans]{wa.slaT}.
319% 329%
320% \DescribeOption{novoc}\\ None of the diacritics is showed in |novoc| 330% \DescribeOption{novoc}\\ None of the diacritics is showed in |novoc|
321% mode, unless otherwise specified. 331% mode, unless otherwise specified (see \enquote{quoting} technique
322% 332% below **).
323% \DescribeOption{trans} \\ 333%
324% 334% \DescribeOption{trans} \\ This mode transliterates the Arab\TeX\
325% 335% input into one of the accepted standards. At present, two standards
326% \begin{itemize} 336% are supported:
327% \item voc Vocalized Arabic 337% \begin{compactdesc}
328% \item novoc Full vocalized Arabic 338% \item[dmg] \emph{Deutsche Morgenländische Gesellschaft}, which was
329% \end{itemize} 339% adopted by the International Convention of Orientalist Scholars in
340% Rome in 1935.\footnote{See \textcite{dmg}.} |dmg| transliteration
341% convention is selected by default;
342% \item[loc] \emph{Library of Congress}: this standard is part of a
343% large set of standards for romanization of non-roman scripts
344% adopted by the American Library Association and the Library of
345% Congress.\footnote{See
346% \url{http://www.loc.gov/catdir/cpso/roman.html} for the
347% \href{http://www.loc.gov/catdir/cpso/romanization/arabic.pdf}{source
348% document concerning Arabic language}.}
349% \end{compactdesc}
350% More standards will be included in future releases of
351% \package{arabluatex}.
352%
353%\subsection{Typing Arabic}
354% \DescribeMacro{arb} Once \package{arabluatex} is loaded, a command
355% \cs{arb}\marg{Arabic text} is available for inserting Arabic text in
356% paragraphs, like so:---
357% \iffalse
358%<*example>
359% \fi
360\begin{arabluacode}
361From \textcite[i. 1 A]{Wright}:--- Arabic, like Hebrew and
362Syriac, is written and read from right to left. The letters
363of the alphabet (\arb{.hurUfu 'l-hijA'i}, \arb{.hurUfu
364'l-tahajjI}, \arb{al-.hurUfu 'l-hijA'iyyaTu}, or \arb{.hurUfu
365'l-mu`jami}) are twenty-eight in number and are all
366consonants, though three of them are also used as vowels
367(see §~3).
368\end{arabluacode}
369% \iffalse
370%</example>
371% \fi
372%
373% \DescribeEnv{arab} Running paragraphs of Arabic text should rather
374% be placed inside an \emph{Arabic environment}
330% 375%
376% \iffalse
377%<*example>
378% \fi
379\begin{arabluaverbatim}
380 \begin{arab}
381 [...]
382 \end{arab}
383\end{arabluaverbatim}
384% \iffalse
385%</example>
386% \fi
387% like so:---
388% \setquotestyle{arabic}
389% \iffalse
390%<*example>
391% \fi
392\begin{arabluacode}
393 \begin{arab}
394 'at_A .sadIquN 'il_A ju.hA ya.tlubu min-hu .himAra-hu
395 li-yarkaba-hu fI safraTiN qa.sIraTiN wa-qAla la-hu:
396 \enquote{sawfa 'u`Idu-hu 'ilay-ka fI 'l-masA'i
397 wa-'adfa`u la-ka 'ujraTaN.} fa-qAla ju.hA:
398 \enquote{'anA 'AsifuN jiddaN 'annI lA 'asta.tI`u 'an
399 'u.haqqiqa la-ka .garbata-ka fa-'l-.himAru laysa hunA
400 'l-yawma.} wa-qabla 'an yutimma ju.hA kalAma-hu bada'a
401 'l-.himAru yanhaqu fI 'i.s.tabili-hi. fa-qAla la-hu
402 .sadIqu-hu: \enquote{'innI 'asma`u .himAra-ka yA ju.hA
403 yanhaqu.} fa-qAla la-hu ju.hA: \enquote{.garIbuN
404 'amru-ka yA .sadIqI 'a-tu.saddiqu 'l-.himAra
405 wa-tuka_d_dibu-nI?}
406 \end{arab}
407\end{arabluacode}
408% \iffalse
409%</example>
410% \fi
411% \setquotestyle{english}
412%
413%\section{Standard Arab\TeX\ input}
414%\subsection{Consonants}
415% Table\vref{tab:arabtex-consonants} gives the Arab\TeX\ equivalents for
416% all of the Arabic consonants.
331% \newcommand{\dmg}[1]{% 417% \newcommand{\dmg}[1]{%
332% \SetTranslitConvention{dmg}% 418% \SetTranslitConvention{dmg}%
333% \arb[trans]{#1}} 419% \arb[trans]{#1}}
@@ -340,19 +426,108 @@
340% & Arab\TeX\ notation \\ 426% & Arab\TeX\ notation \\
341% & \texttt{dmg} & \texttt{loc} & \\ \midrule 427% & \texttt{dmg} & \texttt{loc} & \\ \midrule
342% \endhead \footnotetext{See below **} 428% \endhead \footnotetext{See below **}
343% \arb[novoc]{a} & \dmg{A} & \loc{A} & \verb|A| \\ 429% \arb[novoc]{a}\footnote{For \arb[trans]{'alif} as a consonant, see
344% \arb[novoc]{b} & \dmg{b} & \loc{b} & \verb|b| \\ 430% \textcite[i. 16 D]{Wright}.} & \dmg{a} & \loc{a} & \verb|a| \\
345% \arb[novoc]{t} & \dmg{t} & \loc{t} & \verb|t| \\ 431% \arb[novoc]{b} & \dmg{b} & \loc{b} & |b| \\
346% \arb[novoc]{_t} & \dmg{_t} & \loc{_t} & \verb|_t| \\ 432% \arb[novoc]{t} & \dmg{t} & \loc{t} & |t| \\
347% \arb[novoc]{j} & \dmg{j} & \loc{j} & \verb|^g| or \verb|j| \\ 433% \arb[novoc]{_t} & \dmg{_t} & \loc{_t} & |_t| \\
348% \arb[novoc]{.h} & \dmg{.h} & \loc{.h} & \verb|.h| \\ 434% \arb[novoc]{j} & \dmg{j} & \loc{j} & |^g| or |j| \\
349% \arb[novoc]{x} & \dmg{x} & \loc{x} & \verb|_h| or \verb|x|\\ 435% \arb[novoc]{.h} & \dmg{.h} & \loc{.h} & |.h| \\
350% \arb[novoc]{d} & \dmg{d} & \loc{d} & \verb|d| \\ 436% \arb[novoc]{x} & \dmg{x} & \loc{x} & |_h| or |x|\\
351% \arb[novoc]{_d} & \dmg{_d} & \loc{_d} & \verb|_d| \\ 437% \arb[novoc]{d} & \dmg{d} & \loc{d} & |d| \\
352% \arb[novoc]{r} & \dmg{r} & \loc{r} & \verb|r| \\ 438% \arb[novoc]{_d} & \dmg{_d} & \loc{_d} & |_d| \\
439% \arb[novoc]{r} & \dmg{r} & \loc{r} & |r| \\
440% \arb[novoc]{z} & \dmg{z} & \loc{z} & |z| \\
441% \arb[novoc]{s} & \dmg{s} & \loc{s} & |s| \\
442% \arb[novoc]{^s} & \dmg{^s} & \loc{^s} & |^s| \\
443% \arb[novoc]{.s} & \dmg{.s} & \loc{.s} & |.s| \\
444% \arb[novoc]{.d} & \dmg{.d} & \loc{.d} & |.d| \\
445% \arb[novoc]{.t} & \dmg{.t} & \loc{.t} & |.t| \\
446% \arb[novoc]{.z} & \dmg{.z} & \loc{.z} & |.z| \\
447% \arb[novoc]{`} & \dmg{`} & \loc{`} & |`| \\
448% \arb[novoc]{.g} & \dmg{.g} & \loc{.g} & |.g| \\
449% \arb[novoc]{f} & \dmg{f} & \loc{f} & |f| \\
450% \arb[novoc]{q} & \dmg{q} & \loc{q} & |q| \\
451% \arb[novoc]{k} & \dmg{k} & \loc{k} & |k| \\
452% \arb[novoc]{l} & \dmg{l} & \loc{l} & |l| \\
453% \arb[novoc]{m} & \dmg{m} & \loc{m} & |m| \\
454% \arb[novoc]{n} & \dmg{n} & \loc{n} & |n| \\
455% \arb[novoc]{h} & \dmg{h} & \loc{h} & |h| \\
456% \arb[novoc]{w} & \dmg{w} & \loc{w} & |w| \\
457% \arb[novoc]{y} & \dmg{y} & \loc{y} & |y| \\ \hline
458% \arb[novoc]{T} & \dmg{aT} & \loc{aT} & |T| \\
353% \bottomrule 459% \bottomrule
354% \caption{Standard notation for Arabic} 460% \caption[Arab\TeX\ consonants]{Standard Arab\TeX\ (consonants)}
461% \label{tab:arabtex-consonants}
355% \end{longtable} 462% \end{longtable}
463%
464% \subsection{Vowels}
465% \subsubsection{Long vowels}
466% Table\vref{tab:arabtex-long-vowels} gives the Arab\TeX\ equivalents for
467% the Arabic long vowels.
468% \begin{longtable}{llll}
469% \toprule
470% Letter & \multicolumn{2}{l}{Transliteration\footnotemark}
471% & Arab\TeX\ notation \\
472% & \texttt{dmg} & \texttt{loc} & \\ \midrule
473% \endhead \footnotetext{See below **}
474% \arb[novoc]{A} & \dmg{A} & \loc{A} & \verb|A| \\
475% \arb[novoc]{U} & \dmg{U} & \loc{U} & \verb|U| \\
476% \arb[novoc]{I} & \dmg{I} & \loc{I} & \verb|I| \\
477% \arb[novoc]{_A}\footnote{$=$ \arb[trans]{al-'alif 'l-maq.sUraT}.}
478% & \dmg{_A} & \loc{_A} & \verb|_A| or \verb|Y| \\
479% \arb[novoc]{B_a} & \dmg{B_a} & \loc{B_a} & \verb|_a| \\
480% \arb[novoc]{B_u} & \dmg{B_u} & \loc{B_u} & \verb|_u| \\
481% \arb[novoc]{B_i} & \dmg{B_i} & \loc{B_i} & \verb|_i| \\
482% \bottomrule
483% \caption[Arab\TeX\ long vowels]{Standard Arab\TeX\ (long vowels)}
484% \label{tab:arabtex-long-vowels}
485% \end{longtable}
486%
487% \begin{quoting}
488% \textsc{Rem.}~\emph{a.} The long vowels \arb[trans]{A, U, I},
489% otherwise called \arb[trans]{.hurUfu 'l-maddi}, \emph{the letters
490% of prolongation}, involve the placing of the short vowels
491% \arb[trans]{Ba, Bu, Bi} before the letters \arb[novoc]{A},
492% \arb[novoc]{U}, \arb[novoc]{I} respectively. \package{arabluatex}
493% does that automatically in case any from |voc|, |fullvoc| or
494% |trans| modes is selected e.g. \arb[voc]{qAla} \arb[trans]{qAla},
495% \arb[voc]{qIla} \arb[trans]{qIla}, \arb[voc]{yaqUlu}
496% \arb[trans]{yaqUlu}.
497%
498% \textsc{Rem.}~\emph{b.} Defective writings, such as
499% \arb[novoc]{B_a}, \arb[trans]{al-'alifu 'l-ma.h_dUfaTu}, or
500% defective writings of \arb[trans]{B_u} and \arb[trans]{B_i} are
501% encoded |_a| |_u| and |_i| respectively, e.g. |_d_alika|
502% \arb[voc]{_d_alika}, |al-mal_a'ikaTu 'l-ra.hm_anu|
503% \arb[voc]{al-mal_a'ikaTu 'l-ra.hm_anu},
504% |.hu_dayfaTu bnu 'l-yamAn_i| \arb[fullvoc]{.hu_dayfaTu bnu
505% 'l-yamAn_i} for \arb[trans]{\cap{.hu_dayfaTu} bnu
506% 'l-\cap{yamAn_i}}, etc.
507% \end{quoting}
508%
509% \subsubsection{Short vowels}
510% Table\vref{tab:arabtex-short-vowels} gives the Arab\TeX\ equivalents for
511% the Arabic short vowels.
512% \begin{longtable}{llll}
513% \toprule
514% Letter & \multicolumn{2}{l}{Transliteration\footnotemark}
515% & Arab\TeX\ notation \\
516% & \texttt{dmg} & \texttt{loc} & \\ \midrule
517% \endhead \footnotetext{See below **}
518% \arb[voc]{Ba} & \dmg{Ba} & \loc{Ba} & \verb|a| \\
519% \arb[voc]{Bu} & \dmg{Bu} & \loc{Bu} & \verb|u| \\
520% \arb[voc]{Bi} & \dmg{Bi} & \loc{Bi} & \verb|i| \\
521% \arb[voc]{BaN} & \dmg{BaN} & \loc{BaN} & \verb|aN| \\
522% \arb[voc]{BuN} & \dmg{BuN} & \loc{BuN} & \verb|uN| \\
523% \arb[voc]{BiN} & \dmg{BiN} & \loc{BiN} & \verb|iN| \\
524% \bottomrule
525% \caption[Arab\TeX\ short vowels]{Standard Arab\TeX\ (short vowels)}
526% \label{tab:arabtex-short-vowels}
527% \end{longtable}
528%
529%
530%
356% Usage goes here. \cs{hop}\oarg{ah}\marg{ouh}\meta{pop} 531% Usage goes here. \cs{hop}\oarg{ah}\marg{ouh}\meta{pop}
357% 532%
358% 533%