From afb31dd98fa8de93b1f3d7698aa70a11160d7421 Mon Sep 17 00:00:00 2001 From: Robert Alessi Date: Sun, 6 Mar 2016 19:54:14 +0100 Subject: started writing the doc --- arabluatex.dtx | 67 +++++++++++++++++++++++++++++++++++++++++++++++++--------- 1 file changed, 57 insertions(+), 10 deletions(-) diff --git a/arabluatex.dtx b/arabluatex.dtx index 4914d3a..435e905 100644 --- a/arabluatex.dtx +++ b/arabluatex.dtx @@ -45,6 +45,8 @@ \newcommand{\package}[1]{\textsf{#1}} \usepackage{paralist} \setdefaultitem{\textendash}{\textendash}{\textendash}{\textendash} +\usepackage{longtable} +\usepackage{booktabs} \usepackage{tikz} \usepackage[skins]{tcolorbox} \usepackage{csquotes} @@ -96,7 +98,9 @@ % \hskip 1sp \marginpar{\small\sffamily\raggedright % New feature\\#1}} % -% \author{Robert Alessi \\ \url{alessi@robertalessi.net}} +% \author{Robert Alessi \\ +% \href{mailto:alessi@robertalessi.net?Subject=arabluatex}% +% {\texttt{alessi@robertalessi.net}}} % \date{} % % \maketitle @@ -120,9 +124,10 @@ % \end{abstract} % % \section*{License and disclamer} -% \addcontentsline{toc}{section}{License and disclamer} -% Please send error reports and suggestions for improvements to -% Robert Alessi <\url{alessi@robertalessi.net}> +% \addcontentsline{toc}{section}{License and disclamer} Please send +% error reports and suggestions for improvements to Robert Alessi +% <\href{mailto:alessi@robertalessi.net?Subject=arabluatex}% +% {\texttt{alessi@{\allowbreak}robertalessi.net}}> % % This program is free software; you can redistribute it and/or % modify it under the terms of the GNU General Public License @@ -147,14 +152,56 @@ % the \LuaLaTeX\ users. \package{arabtex} dates back to 1992. As far % as I know, it was then the first and only way to typeset Arabic % texts with \TeX\ and \LaTeX. To achieve this, \package{arabtex} -% provides an Arabic font in \emph{Nasḫī} style and a macro package -% that defines its own input notation which is, as the author states, -% \enquote{both machine, and human, readable, and suited for -% electronic transmission and e-mail -% communication}.\footcite[2]{Lagally2004} +% provided---and still does---an Arabic font in \emph{Nasḫī} style and +% a macro package that defined its own input notation which was, as +% the author stated, \enquote{both machine, and human, readable, and +% suited for electronic transmission and e-mail +% communication}.\footcite[2]{Lagally2004} Even if the same can be +% said about Unicode, Arab\TeX\ \textsc{ASCII} input notation still +% surpasses Unicode input, in my opinion, when it comes to typesetting +% complex documents, such as scientific documents or critical editions +% where footnotes and other kind of annotations can be particulary +% abundant. It must also be said that most text editors have trouble +% in displaying Arabic script connected with preceding or following +% \LaTeX\ commands: it often happens that commands seem misplaced, not +% to mention punctuation marks, or opening or closing braces, brackets +% or parentheses that are unexpectedly displayed in the wrong +% direction. Of course, some text editors provide ways to get around +% such difficulties by inserting invisible Unicode characters, such as +% LEFT-TO-RIGHT or RIGHT-TO-LEFT MARKS (\texttt{U+200E}, +% \texttt{U+200F}), RTL/LTR \enquote{embed} characters +% (\texttt{U+202B}, \texttt{U+202A}) and RLO/LRO +% \enquote{bidi-override} characters (\texttt{U+202E}, +% \texttt{U+202D}).\footnote{Yudit probably has the best Unicode +% support. See \url{www.yudit.org}.} Nonetheless, it remains that +% inserting all the time these invisible characters in complex +% documents rapidly becomes confusing and cumbersome. +% % -% \section{Usage} % +% \section{Usage} +% \newcommand{\dmg}[1]{% +% \SetTranslitConvention{dmg}% +% \arb[trans]{#1}} +% \newcommand{\loc}[1]{% +% \SetTranslitConvention{loc}% +% \arb[trans]{#1}\SetTranslitConvention{dmg}} +% \begin{longtable}{llll} +% \toprule +% Letter & \multicolumn{2}{l}{Transliteration\footnotemark} +% & Arab\TeX\ notation \\ +% & \texttt{dmg} & \texttt{loc} & \\ \midrule +% \endhead \footnotetext{See below **} +% \arb[novoc]{a} & \dmg{A} & \loc{A} & \verb|a| \\ +% \arb[novoc]{b} & \dmg{b} & \loc{b} & \verb|b| \\ +% \arb[novoc]{t} & \dmg{t} & \loc{t} & \verb|t| \\ +% \arb[novoc]{_t} & \dmg{_t} & \loc{_t} & \verb|_t| \\ +% \arb[novoc]{j} & \dmg{j} & \loc{j} & \verb|^g| or \verb|j| \\ +% \arb[novoc]{.h} & \dmg{.h} & \loc{.h} & \verb|.h| \\ +% \arb[novoc]{x} & \dmg{x} & \loc{x} & \verb|_h| or \verb|x|\\ +% \bottomrule +% \caption{Standard notation for Arabic} +% \end{longtable} % Usage goes here. % % \StopEventually{} -- cgit v1.2.3