aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRobert Alessi <alessi@robertalessi.net>2016-03-09 14:59:30 +0100
committerRobert Alessi <alessi@robertalessi.net>2016-03-09 14:59:30 +0100
commit7429fe6075af086ea8a0366a1d8cb64fcdcf5a87 (patch)
tree3ed15044739e3d288576402c94be37a0129507e4
parent1b11ee7d7a30f4424b26aa85e77e1816f736b417 (diff)
downloadarabluatex-7429fe6075af086ea8a0366a1d8cb64fcdcf5a87.tar.gz
writing documentation (continued)
-rw-r--r--arabluatex.bib2
-rw-r--r--arabluatex.dtx103
-rw-r--r--makefile2
3 files changed, 64 insertions, 43 deletions
diff --git a/arabluatex.bib b/arabluatex.bib
index 909d634..3d8dc67 100644
--- a/arabluatex.bib
+++ b/arabluatex.bib
@@ -1,3 +1,5 @@
1% This file is part of the `arabluatex' package
2%
1% copyright (C) 2016 Robert Alessi 3% copyright (C) 2016 Robert Alessi
2% 4%
3% Please send error reports and suggestions for improvements to 5% Please send error reports and suggestions for improvements to
diff --git a/arabluatex.dtx b/arabluatex.dtx
index 8d42b1b..6c89aa4 100644
--- a/arabluatex.dtx
+++ b/arabluatex.dtx
@@ -31,8 +31,10 @@
31%</package-info> 31%</package-info>
32% 32%
33%<*driver> 33%<*driver>
34\documentclass{ltxdoc} 34\documentclass{cnltx-doc}
35\usepackage[english]{babel} 35\usepackage[english]{babel}
36\usepackage[letterpaper, includemp, reversemp, hmargin=.8in,
37 marginpar=.8in]{geometry}
36\usepackage{fontspec,luatextra,realscripts} 38\usepackage{fontspec,luatextra,realscripts}
37\defaultfontfeatures{RawFeature={+liga}} 39\defaultfontfeatures{RawFeature={+liga}}
38\setmainfont{Libertinus Serif} 40\setmainfont{Libertinus Serif}
@@ -40,7 +42,7 @@
40\setmonofont[Scale=.9]{Libertinus Mono} 42\setmonofont[Scale=.9]{Libertinus Mono}
41\usepackage{arabluatex}[2016/01/26] 43\usepackage{arabluatex}[2016/01/26]
42\usepackage{hypdoc} 44\usepackage{hypdoc}
43\hypersetup{colorlinks, allcolors=blue} 45%\hypersetup{colorlinks, allcolors=blue}
44\usepackage{multicol} 46\usepackage{multicol}
45\newcommand{\package}[1]{\textsf{#1}} 47\newcommand{\package}[1]{\textsf{#1}}
46\usepackage{paralist} 48\usepackage{paralist}
@@ -215,8 +217,6 @@
215% lexicons that can be searched, analyzed and correlated in various 217% lexicons that can be searched, analyzed and correlated in various
216% ways. 218% ways.
217% 219%
218%
219%
220%\subsection{\package{arabluatex} is for \LuaLaTeX} 220%\subsection{\package{arabluatex} is for \LuaLaTeX}
221% It goes without saying that \package{arabluatex} requires 221% It goes without saying that \package{arabluatex} requires
222% \LuaLaTeX. \TeX\ and \LaTeX\ have \package{arabtex}, and \XeLaTeX\ 222% \LuaLaTeX. \TeX\ and \LaTeX\ have \package{arabtex}, and \XeLaTeX\
@@ -246,6 +246,14 @@
246% processing. 246% processing.
247% 247%
248% \section{Usage} 248% \section{Usage}
249% \sinceversion{1.0}
250% \begin{options}
251% \opt{voc}\Default{voc} Vocalized Arabic
252% \opt{novoc} Full vocalized Arabic
253% \end{options}
254% \begin{sidebyside}
255% \arb{daxala}
256% \end{sidebyside}
249% \newcommand{\dmg}[1]{% 257% \newcommand{\dmg}[1]{%
250% \SetTranslitConvention{dmg}% 258% \SetTranslitConvention{dmg}%
251% \arb[trans]{#1}} 259% \arb[trans]{#1}}
@@ -271,8 +279,9 @@
271% \bottomrule 279% \bottomrule
272% \caption{Standard notation for Arabic} 280% \caption{Standard notation for Arabic}
273% \end{longtable} 281% \end{longtable}
274% Usage goes here. \cs{hop}\oarg{ah}\marg{ouh} 282% Usage goes here. \cs{hop}\oarg{ah}\marg{ouh}\meta{pop}
275% 283%
284%
276% \StopEventually{} 285% \StopEventually{}
277% 286%
278% \section{Implementation} 287% \section{Implementation}
@@ -348,46 +357,56 @@
348 TRT\arabicfont#1\egroup} 357 TRT\arabicfont#1\egroup}
349\DeclareDocumentCommand{\txtrans}{+m}{\bgroup\textdir 358\DeclareDocumentCommand{\txtrans}{+m}{\bgroup\textdir
350 TLT\rmfamily#1\egroup} 359 TLT\rmfamily#1\egroup}
360% \end{macrocode}
361% \begin{macro}{\arb}
362% Here begins the description of \cs{arb}
363% \begin{macrocode}
351\DeclareDocumentCommand{\arb}{O{\al@mode} +m}% 364\DeclareDocumentCommand{\arb}{O{\al@mode} +m}%
352{\edef\@tempa{#1}% 365{\edef\@tempa{#1}%
353 \ifx\@tempa\al@mode@voc% 366 \ifx\@tempa\al@mode@voc%
354 \bgroup\textdir TRT\arabicfont% 367 \bgroup\textdir TRT\arabicfont%
355 \luadirect{tex.sprint(processvoc(\luastringN{#2}))}\egroup% 368 \luadirect{tex.sprint(processvoc(\luastringN{#2}))}\egroup%
356 \else% 369 \else%
357 \ifx\@tempa\al@mode@fullvoc% 370 \ifx\@tempa\al@mode@fullvoc%
358 \bgroup\textdir TRT\arabicfont% 371 \bgroup\textdir TRT\arabicfont%
359 \luadirect{tex.sprint(processfullvoc(\luastringN{#2}))}\egroup% 372 \luadirect{tex.sprint(processfullvoc(\luastringN{#2}))}\egroup%
360 \else% 373 \else%
361 \ifx\@tempa\al@mode@novoc% 374 \ifx\@tempa\al@mode@novoc%
362 \bgroup\textdir TRT\arabicfont% 375 \bgroup\textdir TRT\arabicfont%
363 \luadirect{tex.sprint(processnovoc(\luastringN{#2}))}\egroup% 376 \luadirect{tex.sprint(processnovoc(\luastringN{#2}))}\egroup%
364 \else% 377 \else%
365 \ifx\@tempa\al@mode@trans% 378 \ifx\@tempa\al@mode@trans%
366 \bgroup\textdir TLT\al@trans@style% 379 \bgroup\textdir TLT\al@trans@style%
367 \luadirect{tex.sprint(processtrans(\luastringN{#2}, 380 \luadirect{tex.sprint(processtrans(\luastringN{#2},
368 \luastringO{\al@trans@convention}))}\egroup% 381 \luastringO{\al@trans@convention}))}\egroup%
369 \else% 382 \else%
370 \fi\fi\fi\fi} 383 \fi\fi\fi\fi}
384% \end{macrocode}
385% \end{macro}
386% \begin{environment}{arab}
387% Here comes the description of the environment \env*{arab}
388% \begin{macrocode}
371\NewEnviron{arab}[1][\al@mode]% 389\NewEnviron{arab}[1][\al@mode]%
372{\par\edef\@tempa{#1}% 390{\par\edef\@tempa{#1}%
373 \ifx\@tempa\al@mode@voc% 391 \ifx\@tempa\al@mode@voc%
374 \bgroup\pardir TRT\textdir TRT\arabicfont% 392 \bgroup\pardir TRT\textdir TRT\arabicfont%
375 \luadirect{tex.sprint(processvoc(\luastringO{\BODY}))}\egroup% 393 \luadirect{tex.sprint(processvoc(\luastringO{\BODY}))}\egroup%
376 \else% 394 \else%
377 \ifx\@tempa\al@mode@fullvoc% 395 \ifx\@tempa\al@mode@fullvoc%
378 \bgroup\pardir TRT\textdir TRT\arabicfont% 396 \bgroup\pardir TRT\textdir TRT\arabicfont%
379 \luadirect{tex.sprint(processfullvoc(\luastringO{\BODY}))}\egroup% 397 \luadirect{tex.sprint(processfullvoc(\luastringO{\BODY}))}\egroup%
380 \else% 398 \else%
381 \ifx\@tempa\al@mode@novoc% 399 \ifx\@tempa\al@mode@novoc%
382 \bgroup\pardir TRT\textdir TRT\arabicfont% 400 \bgroup\pardir TRT\textdir TRT\arabicfont%
383 \luadirect{tex.sprint(processnovoc(\luastringO{\BODY}))}\egroup% 401 \luadirect{tex.sprint(processnovoc(\luastringO{\BODY}))}\egroup%
384 \else 402 \else \ifx\@tempa\al@mode@trans%
385 \ifx\@tempa\al@mode@trans% 403 \bgroup\pardir TLT\textdir TLT\al@trans@style%
386 \bgroup\pardir TLT\textdir TLT\al@trans@style% 404 \luadirect{tex.sprint(processtrans(\luastringO{\BODY},
387 \luadirect{tex.sprint(processtrans(\luastringO{\BODY}, 405 \luastringO{\al@trans@convention}))}\egroup%
388 \luastringO{\al@trans@convention}))}\egroup% 406 \else \fi\fi\fi\fi}[\par]
389 \else 407% \end{macrocode}
390 \fi\fi\fi\fi}[\par] 408% \end{environment}
409% \begin{macrocode}
391\DeclareDocumentCommand{\Marginpar}{m}{\marginpar{\textdir TLT #1}} 410\DeclareDocumentCommand{\Marginpar}{m}{\marginpar{\textdir TLT #1}}
392\RenewDocumentCommand{\thefootnote}{}{\bgroup\textdir 411\RenewDocumentCommand{\thefootnote}{}{\bgroup\textdir
393 TLT\arabic{footnote}\egroup} 412 TLT\arabic{footnote}\egroup}
diff --git a/makefile b/makefile
index 31a21ee..b523cdc 100644
--- a/makefile
+++ b/makefile
@@ -24,7 +24,7 @@ package: clean all
24 mkdir -p doc/lualatex/arabluatex/ 24 mkdir -p doc/lualatex/arabluatex/
25 cp *.pdf doc/lualatex/arabluatex/ 25 cp *.pdf doc/lualatex/arabluatex/
26 mkdir -p source/lualatex/arabluatex/ 26 mkdir -p source/lualatex/arabluatex/
27 cp *.lua *.ins *.dtx source/lualatex/arabluatex/ 27 cp *.lua *.ins *.dtx *.bib source/lualatex/arabluatex/
28 zip -r arabluatex.tds.zip tex doc source 28 zip -r arabluatex.tds.zip tex doc source
29 mv arabluatex.tds.zip arabluatex 29 mv arabluatex.tds.zip arabluatex
30 tar czf arabluatex.tar.gz arabluatex 30 tar czf arabluatex.tar.gz arabluatex