From 0b19d4db2bcce2184f8709a2b0c60b8107ace2ca Mon Sep 17 00:00:00 2001 From: Robert Alessi Date: Wed, 9 Mar 2016 23:23:47 +0100 Subject: reverted to ltxdoc --- arabluatex.bib | 6 ++- arabluatex.dtx | 115 ++++++++++++++++++++++++++++++--------------------------- 2 files changed, 65 insertions(+), 56 deletions(-) diff --git a/arabluatex.bib b/arabluatex.bib index 3d8dc67..cd56afc 100644 --- a/arabluatex.bib +++ b/arabluatex.bib @@ -20,10 +20,12 @@ % Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA % 02111-1307, USA. -@Online{Lagally2004, +@package{pkg:arabtex, author = {Lagally, Klaus}, + maintainer = {Lagally, Klaus}, title = {Arab\TeX}, - year = 2004, + date = {2004-11-03}, + version = {4.00}, url = {http://mirrors.ctan.org/language/arabic/arabtex/doc/html/arabtex.htm}, subtitle = {Typesetting Arabic and Hebrew}, diff --git a/arabluatex.dtx b/arabluatex.dtx index cad42c7..a885799 100644 --- a/arabluatex.dtx +++ b/arabluatex.dtx @@ -31,7 +31,7 @@ % % %<*driver> -\documentclass{cnltx-doc} +\documentclass{ltxdoc} \usepackage[english]{babel} \usepackage[letterpaper, includemp, reversemp, hmargin=.8in, marginpar=.8in]{geometry} @@ -42,7 +42,7 @@ \setmonofont[Scale=.9]{Libertinus Mono} \usepackage{arabluatex}[2016/01/26] \usepackage{hypdoc} -%\hypersetup{colorlinks, allcolors=blue} +\hypersetup{colorlinks, allcolors=blue} \usepackage{multicol} \newcommand{\package}[1]{\textsf{#1}} \usepackage{paralist} @@ -51,6 +51,9 @@ \usepackage{booktabs} \usepackage{tikz} \usepackage[skins,listings]{tcolorbox} +\newtcblisting{arabluacode}[1]{colback=white, boxrule=.15mm, + colframe=red!50!white, listing options={style=tcblatex, + numbers=left, numberstyle=\tiny}, #1} \usepackage{csquotes} \usepackage[style=authoryear, natbib]{biblatex} \addbibresource{arabluatex.bib} @@ -124,7 +127,7 @@ % transliteration. It is particularly well-suited for complex % documents such as technical documents or critical editions where a % lot of left-to-right commands intertwine with Arabic -% writing. \pkg*{arabluatex} is able to process any Arab\TeX\ +% writing. \package{arabluatex} is able to process any Arab\TeX\ % input notation. Its output can be set in the same modes of % vocalization as Arab\TeX\ ones, or in different roman % transliterations. It further allows some typographical @@ -133,9 +136,13 @@ % % \section*{License and disclamer} % \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}}> +% error reports and suggestions for improvements to Robert Alessi: +% \begin{itemize} +% \item email: <\href{mailto:alessi@robertalessi.net?Subject=arabluatex}% +% {\texttt{alessi@{\allowbreak}robertalessi.net}}> +% \item website: \url{http://www.robertalessi.net/arabluatex} +% \end{itemize} +% % % This program is free software; you can redistribute it and/or % modify it under the terms of the GNU General Public License @@ -159,31 +166,30 @@ % say so---it will eventually provide all of its valuable qualities to % the \LuaLaTeX\ users. % -% \pkg{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, \pkg{arabtex} 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}.\footnote{\textcite[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} +% \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} 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}.\footnote{\textcite[2]{pkg:arabtex}.} 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{Gáspár Sinai's Yudit probably has the -% best Unicode support. See \url{www.yudit.org}.} Nonetheless, it +% best Unicode support. See \url{http://www.yudit.org}.} Nonetheless, it % remains that inserting all the time these invisible characters in % complex documents rapidly becomes confusing and cumbersome. % @@ -210,26 +216,26 @@ % that can stand to close grammatical scrutiny and to complex textual % searches as well. % -% Having that in mind, I started \pkg*{arabluatex}. With the help +% Having that in mind, I started \package{arabluatex}. With the help % of Lua, it will eventually interact with some other packages yet to % come to produce from \verb|.tex| source files, in addition to % printed books, \texttt{TEI xml} compliant critical editions and/or % lexicons that can be searched, analyzed and correlated in various % ways. % -%\subsection{\pkg*{arabluatex} is for \LuaLaTeX} -% It goes without saying that \pkg*{arabluatex} requires -% \LuaLaTeX. \TeX\ and \LaTeX\ have \pkg*{arabtex}, and \XeLaTeX\ -% has \pkg*{arabxetex}. Both of them are much more advanced than -% \pkg*{arabluatex}, as they can process a number of different +%\subsection{\package{arabluatex} is for \LuaLaTeX} +% It goes without saying that \package{arabluatex} requires +% \LuaLaTeX. \TeX\ and \LaTeX\ have \package{arabtex}, and \XeLaTeX\ +% has \package{arabxetex}. Both of them are much more advanced than +% \package{arabluatex}, as they can process a number of different % languages,\footnote{To date, both packages support Arabic, Maghribi, % Urdu, Pashto, Sindhi, Kashmiri, Uighuric and Old Malay; in addition -% to these, \pkg*{arabtex} also has a Hebrew mode, including -% Judeo-Arabic and Yiddish.} whereas \pkg*{arabluatex} can process +% to these, \package{arabtex} also has a Hebrew mode, including +% Judeo-Arabic and Yiddish.} whereas \package{arabluatex} can process % only Arabic for the time being. More languages will be included in -% future releases of \pkg*{arabluatex}. +% future releases of \package{arabluatex}. % -% In comparison to \pkg*{arabxetex}, \pkg*{arabluatex} works in +% In comparison to \package{arabxetex}, \package{arabluatex} works in % a very different way. The former relies on the % \href{http://scripts.sil.org/TECkitIntro}{\texttt{TECkit}} engine % which converts Arab\TeX\ input on the fly into Unicode Arabic @@ -246,19 +252,20 @@ % processing. % % \section{Usage} -% \subsection{Getting started} +% \subsection{Activating \package{arabluatex}} % As usual put in your preamble: -% \begin{commands} -% \command{usepackage}[\Marg{arabluatex}] -% \end{commands} -% -% \begin{options} -% \opt{voc}\Default{voc} Vocalized Arabic -% \opt{novoc} Full vocalized Arabic -% \end{options} -% \begin{sidebyside} -% \arb{daxala} -% \end{sidebyside} +% |\usepackage{arabluatex}| +% The only requirement of \package{arabluatex} is \LuaLaTeX; it will +% complain if you try to compile your document with another +% engine. That aside, \package{arabluatex} does not load packages such +% as \package{polyglossia} or \package{luabidi}. It can work with +% \package{polyglossia} but does not require it. +% +% \begin{itemize} +% \item voc Vocalized Arabic +% \item novoc Full vocalized Arabic +% \end{itemize} +% % \newcommand{\dmg}[1]{% % \SetTranslitConvention{dmg}% % \arb[trans]{#1}} @@ -301,7 +308,7 @@ [2016/01/26 v1.0 ArabTeX-like interface for LuaLaTeX] \RequirePackage{ifluatex} % \end{macrocode} -% \pkg*{arabluatex} requires \LuaLaTeX\ of course. +% \package{arabluatex} requires \LuaLaTeX\ of course. % \begin{macrocode} \ifluatex\else \PackageError{arabluatex}{lualatex needed}{% @@ -330,8 +337,8 @@ \RequirePackage{environ} \luadirect{dofile(kpse.find_file("arabluatex.lua"))} % \end{macrocode} -% This is needed by the current versions of \pkg*{polyglossia} and -% \pkg*{luabidi}. \pkg*{luabidi} provides a \cs{Footnote} +% This is needed by the current versions of \package{polyglossia} and +% \package{luabidi}. \package{luabidi} provides a \cs{Footnote} % command. Use it as well if it is loaded. % \begin{macrocode} \luadirect{tex.enableprimitives("luatex",tex.extraprimitives("omega"))} @@ -389,7 +396,7 @@ % \end{macrocode} % \end{macro} % \begin{environment}{arab} -% Here comes the description of the environment \env*{arab} +% Here comes the description of the environment |arab| % \begin{macrocode} \NewEnviron{arab}[1][\al@mode]% {\par\edef\@tempa{#1}% -- cgit v1.2.3