aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRobert Alessi <alessi@robertalessi.net>2020-11-08 11:15:33 +0100
committerRobert Alessi <alessi@robertalessi.net>2020-11-08 11:15:33 +0100
commitcfa490f2f0ec6ffd35af24a948e7c1c304928083 (patch)
tree53eb3e37ee119920e08ce6031f6aa44c502178f9
parentf25eea6af4f41ef7529e1488d2c2e6777f1dca7a (diff)
downloadarabluatex-cfa490f2f0ec6ffd35af24a948e7c1c304928083.tar.gz
use geometry in the documentation. minted needs a temporary patch because of a bug in the current luatex hyphenation mechanism
Diffstat
-rw-r--r--README.md34
-rw-r--r--about.html42
-rw-r--r--arabluatex.dtx8
-rw-r--r--makefile1
4 files changed, 50 insertions, 35 deletions
diff --git a/README.md b/README.md
index 5cd4118..908a6ba 100644
--- a/README.md
+++ b/README.md
@@ -1,32 +1,32 @@
1--- 1---
2author: 2author:
3- Robert Alessi 3- Robert Alessi
4title: 'The arabluatex package – README file' 4title: 'The arabluatex package -- README file'
5--- 5---
6 6
7\maketitle
7Overview 8Overview
8======== 9========
9 10
10This package provides for [LuaLaTeX](http://luatex.org) an 11This package provides for [LuaLaTeX](http://luatex.org) an
11[ArabTeX](http://ctan.org/pkg/arabtex)-like interface to generate Arabic 12[ArabTeX](http://ctan.org/pkg/arabtex)-like interface to generate Arabic
12writing from an <span style="font-variant:small-caps;">ascii</span> 13writing from an [ascii]{.smallcaps} transliteration. It is particularly
13transliteration. It is particularly well-suited for complex documents 14well-suited for complex documents such as technical documents or
14such as technical documents or critical editions where a lot of 15critical editions where a lot of left-to-right commands intertwine with
15left-to-right commands intertwine with Arabic writing. arabluatex is 16Arabic writing. arabluatex is able to process any ArabTeX input
16able to process any ArabTeX input notation. Its output can be set in the 17notation. Its output can be set in the same modes of vocalization as
17same modes of vocalization as ArabTeX, or in different roman 18ArabTeX, or in different roman transliterations. It further allows many
18transliterations. It further allows many typographical refinements. It 19typographical refinements. It will eventually interact with some other
19will eventually interact with some other packages yet to come to produce 20packages yet to come to produce from `.tex` source files, in addition to
20from `.tex` source files, in addition to printed books, `TEI xml` 21printed books, `TEI xml` compliant critical editions and/or lexicons
21compliant critical editions and/or lexicons that can be searched, 22that can be searched, analyzed and correlated in various ways.
22analyzed and correlated in various ways.
23 23
24License and disclamer 24License and disclamer
25===================== 25=====================
26 26
27ArabLuaTeX – Processing ArabTeX notation under LuaLaTeX 27ArabLuaTeX -- Processing ArabTeX notation under LuaLaTeX
28 28
29Copyright ⓒ 2016–2020 Robert Alessi 29Copyright ⓒ 2016--2020 Robert Alessi
30 30
31Please send error reports and suggestions for improvements to Robert 31Please send error reports and suggestions for improvements to Robert
32Alessi: 32Alessi:
@@ -49,7 +49,7 @@ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General
49Public License for more details. 49Public License for more details.
50 50
51You should have received a copy of the GNU General Public License along 51You should have received a copy of the GNU General Public License along
52with this program. If not, see &lt;http://www.gnu.org/licenses/&gt;. 52with this program. If not, see \<http://www.gnu.org/licenses/\>.
53 53
54This release of arabluatex consists of the following source files: 54This release of arabluatex consists of the following source files:
55 55
@@ -70,7 +70,7 @@ This release of arabluatex consists of the following source files:
70License applicable to the documentation 70License applicable to the documentation
71--------------------------------------- 71---------------------------------------
72 72
73Copyright ⓒ 2016–2020 Robert Alessi 73Copyright ⓒ 2016--2020 Robert Alessi
74 74
75The documentation file `arabluatex.pdf` that is generated from the 75The documentation file `arabluatex.pdf` that is generated from the
76`arabluatex.dtx` source is licensed under the Creative Commons 76`arabluatex.dtx` source is licensed under the Creative Commons
@@ -104,7 +104,7 @@ Installation
104 104
1053. Additionally, those who use emacs with AUCTeX may copy 1053. Additionally, those who use emacs with AUCTeX may copy
106 `arabluatex.el` to their `~/.emacs.d/auctex/auto` local directory. 106 `arabluatex.el` to their `~/.emacs.d/auctex/auto` local directory.
107 This will enable the appropriate hooks for ArabLuaTeX in AUCTeX. 107 This will enable the appropriate hooks for ArabLuaTeX in AUCTeX.
108 108
109Development, Git Repository 109Development, Git Repository
110=========================== 110===========================
diff --git a/about.html b/about.html
index a846bab..8ef882e 100644
--- a/about.html
+++ b/about.html
@@ -1,21 +1,27 @@
1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> 1<!DOCTYPE html>
2<html xmlns="http://www.w3.org/1999/xhtml"> 2<html xmlns="http://www.w3.org/1999/xhtml" lang="" xml:lang="">
3<head> 3<head>
4 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> 4 <meta charset="utf-8" />
5 <meta http-equiv="Content-Style-Type" content="text/css" />
6 <meta name="generator" content="pandoc" /> 5 <meta name="generator" content="pandoc" />
6 <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes" />
7 <meta name="author" content="Robert Alessi" /> 7 <meta name="author" content="Robert Alessi" />
8 <title>The arabluatex package – README file</title> 8 <title>The arabluatex package – README file</title>
9 <style type="text/css">code{white-space: pre;}</style> 9 <style type="text/css">
10 code{white-space: pre-wrap;}
11 span.smallcaps{font-variant: small-caps;}
12 span.underline{text-decoration: underline;}
13 div.column{display: inline-block; vertical-align: top; width: 50%;}
14 </style>
10</head> 15</head>
11<body> 16<body>
12<div id="header"> 17<header>
13<h1 class="title">The arabluatex package – README file</h1> 18<h1 class="title">The arabluatex package – README file</h1>
14<h2 class="author">Robert Alessi</h2> 19<p class="author">Robert Alessi</p>
15</div> 20</header>
16<h1 id="sec:overview" class="unnumbered">Overview</h1> 21
17<p>This package provides for <a href="http://luatex.org">LuaLaTeX</a> an <a href="http://ctan.org/pkg/arabtex">ArabTeX</a>-like interface to generate Arabic writing from an <span style="font-variant: small-caps;">ascii</span> 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. arabluatex is able to process any ArabTeX input notation. Its output can be set in the same modes of vocalization as ArabTeX, or in different roman transliterations. It further allows many typographical refinements. It will eventually interact with some other packages yet to come to produce from <code>.tex</code> source files, in addition to printed books, <code>TEI xml</code> compliant critical editions and/or lexicons that can be searched, analyzed and correlated in various ways.</p> 22<h1 id="sec:overview" class="unnumbered unnumbered">Overview</h1>
18<h1 id="license-and-disclamer" class="unnumbered">License and disclamer</h1> 23<p>This package provides for <a href="http://luatex.org">LuaLaTeX</a> an <a href="http://ctan.org/pkg/arabtex">ArabTeX</a>-like interface to generate Arabic writing from an <span class="smallcaps">ascii</span> 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. arabluatex is able to process any ArabTeX input notation. Its output can be set in the same modes of vocalization as ArabTeX, or in different roman transliterations. It further allows many typographical refinements. It will eventually interact with some other packages yet to come to produce from <code>.tex</code> source files, in addition to printed books, <code>TEI xml</code> compliant critical editions and/or lexicons that can be searched, analyzed and correlated in various ways.</p>
24<h1 id="license-and-disclamer" class="unnumbered unnumbered">License and disclamer</h1>
19<p>ArabLuaTeX – Processing ArabTeX notation under LuaLaTeX</p> 25<p>ArabLuaTeX – Processing ArabTeX notation under LuaLaTeX</p>
20<p>Copyright ⓒ 2016–2020 Robert Alessi</p> 26<p>Copyright ⓒ 2016–2020 Robert Alessi</p>
21<p>Please send error reports and suggestions for improvements to Robert Alessi:</p> 27<p>Please send error reports and suggestions for improvements to Robert Alessi:</p>
@@ -37,10 +43,10 @@
37<li><p><code>arabluatex_novoc.lua</code></p></li> 43<li><p><code>arabluatex_novoc.lua</code></p></li>
38<li><p><code>arabluatex_trans.lua</code></p></li> 44<li><p><code>arabluatex_trans.lua</code></p></li>
39</ul> 45</ul>
40<h2 id="sec:documentation-license" class="unnumbered">License applicable to the documentation</h2> 46<h2 id="sec:documentation-license" class="unnumbered unnumbered">License applicable to the documentation</h2>
41<p>Copyright ⓒ 2016–2020 Robert Alessi</p> 47<p>Copyright ⓒ 2016–2020 Robert Alessi</p>
42<p>The documentation file <code>arabluatex.pdf</code> that is generated from the <code>arabluatex.dtx</code> source is licensed under the Creative Commons Attribution-ShareAlike 4.0 International License. To view a copy of this license, visit <a href="http://creativecommons.org/licenses/by-sa/4.0/" class="uri">http://creativecommons.org/licenses/by-sa/4.0/</a> or send a letter to Creative Commons, PO Box 1866, Mountain View, CA 94042, USA.</p> 48<p>The documentation file <code>arabluatex.pdf</code> that is generated from the <code>arabluatex.dtx</code> source is licensed under the Creative Commons Attribution-ShareAlike 4.0 International License. To view a copy of this license, visit <a href="http://creativecommons.org/licenses/by-sa/4.0/" class="uri">http://creativecommons.org/licenses/by-sa/4.0/</a> or send a letter to Creative Commons, PO Box 1866, Mountain View, CA 94042, USA.</p>
43<h1 id="sec:installation" class="unnumbered">Installation</h1> 49<h1 id="sec:installation" class="unnumbered unnumbered">Installation</h1>
44<ol> 50<ol>
45<li><p>Run <code>'lualatex arabluatex.ins'</code> to produce the <code>arabluatex.sty</code> file;</p></li> 51<li><p>Run <code>'lualatex arabluatex.ins'</code> to produce the <code>arabluatex.sty</code> file;</p></li>
46<li><p>To finish the installation you have to move the following files into a directory where LaTeX can find them. See the FAQ on <code>texfaq.org</code> at <a href="https://texfaq.org/FAQ-inst-wlcf" class="uri">https://texfaq.org/FAQ-inst-wlcf</a> for more on this:</p> 52<li><p>To finish the installation you have to move the following files into a directory where LaTeX can find them. See the FAQ on <code>texfaq.org</code> at <a href="https://texfaq.org/FAQ-inst-wlcf" class="uri">https://texfaq.org/FAQ-inst-wlcf</a> for more on this:</p>
@@ -53,20 +59,20 @@
53<li><p><code>arabluatex_novoc.lua</code></p></li> 59<li><p><code>arabluatex_novoc.lua</code></p></li>
54<li><p><code>arabluatex_trans.lua</code></p></li> 60<li><p><code>arabluatex_trans.lua</code></p></li>
55</ul></li> 61</ul></li>
56<li><p>Additionally, those who use emacs with AUCTeX may copy <code>arabluatex.el</code> to their <code>~/.emacs.d/auctex/auto</code> local directory. This will enable the appropriate hooks for ArabLuaTeX in AUCTeX.</p></li> 62<li><p>Additionally, those who use emacs with AUCTeX may copy <code>arabluatex.el</code> to their <code>~/.emacs.d/auctex/auto</code> local directory. This will enable the appropriate hooks for ArabLuaTeX in AUCTeX.</p></li>
57</ol> 63</ol>
58<h1 id="sec:devel-git-repos">Development, Git Repository</h1> 64<h1 id="sec:devel-git-repos">Development, Git Repository</h1>
59<h2 id="sec:browse-code" class="unnumbered">Browse the code</h2> 65<h2 id="sec:browse-code" class="unnumbered unnumbered">Browse the code</h2>
60<p>You can browse ArabLuaTeX repository on the web: <a href="http://git.robertalessi.net/arabluatex" class="uri">http://git.robertalessi.net/arabluatex</a></p> 66<p>You can browse ArabLuaTeX repository on the web: <a href="http://git.robertalessi.net/arabluatex" class="uri">http://git.robertalessi.net/arabluatex</a></p>
61<p>From this page, you can download all the releases of ArabLuaTeX. For instructions on how to install ArabLuaTeX, please see above.</p> 67<p>From this page, you can download all the releases of ArabLuaTeX. For instructions on how to install ArabLuaTeX, please see above.</p>
62<h2 id="sec:comm-feat-requ" class="unnumbered">Comments, Feature requests, Bug Reports</h2> 68<h2 id="sec:comm-feat-requ" class="unnumbered unnumbered">Comments, Feature requests, Bug Reports</h2>
63<p><a href="https://gitlab.com/ralessi/arabluatex/issues" class="uri">https://gitlab.com/ralessi/arabluatex/issues</a></p> 69<p><a href="https://gitlab.com/ralessi/arabluatex/issues" class="uri">https://gitlab.com/ralessi/arabluatex/issues</a></p>
64<h2 id="sec:download-repository" class="unnumbered">Download the repository</h2> 70<h2 id="sec:download-repository" class="unnumbered unnumbered">Download the repository</h2>
65<p>ArabLuaTeX development is facilitated by git, a distributed version control system. You will need to install git (most GNU/Linux distributions package it in their repositories).</p> 71<p>ArabLuaTeX development is facilitated by git, a distributed version control system. You will need to install git (most GNU/Linux distributions package it in their repositories).</p>
66<p>Use this command to download the repository</p> 72<p>Use this command to download the repository</p>
67<pre><code>git clone http://git.robertalessi.net/arabluatex</code></pre> 73<pre><code>git clone http://git.robertalessi.net/arabluatex</code></pre>
68<p>A new directory named arabluatex will have been created, containing ArabLuaTeX.</p> 74<p>A new directory named arabluatex will have been created, containing ArabLuaTeX.</p>
69<h2 id="sec:git-hosting" class="unnumbered">Git hosting</h2> 75<h2 id="sec:git-hosting" class="unnumbered unnumbered">Git hosting</h2>
70<p>Make an account on <a href="https://gitlab.com" class="uri">https://gitlab.com</a> and navigate (while logged in) to <a href="https://gitlab.com/ralessi/arabluatex" class="uri">https://gitlab.com/ralessi/arabluatex</a>. Click <em>Fork</em> and you will have in your account your own repository of <code>arabluatex</code> where you will be able to make whatever changes you like to.</p> 76<p>Make an account on <a href="https://gitlab.com" class="uri">https://gitlab.com</a> and navigate (while logged in) to <a href="https://gitlab.com/ralessi/arabluatex" class="uri">https://gitlab.com/ralessi/arabluatex</a>. Click <em>Fork</em> and you will have in your account your own repository of <code>arabluatex</code> where you will be able to make whatever changes you like to.</p>
71</body> 77</body>
72</html> 78</html>
diff --git a/arabluatex.dtx b/arabluatex.dtx
index 01ceabc..610181b 100644
--- a/arabluatex.dtx
+++ b/arabluatex.dtx
@@ -157,6 +157,7 @@
157 location = {London -- Edinburgh} 157 location = {London -- Edinburgh}
158} 158}
159\end{filecontents} 159\end{filecontents}
160\usepackage[letterpaper,margin=1.25in,left=50mm,nohead]{geometry}
160\usepackage{fontspec} 161\usepackage{fontspec}
161\usepackage[english]{babel} 162\usepackage[english]{babel}
162\usepackage{dox} 163\usepackage{dox}
@@ -216,6 +217,13 @@
216\usepackage{relsize} 217\usepackage{relsize}
217\usepackage{tikz} 218\usepackage{tikz}
218\usepackage[breakable, skins, xparse, minted]{tcolorbox} 219\usepackage[breakable, skins, xparse, minted]{tcolorbox}
220\makeatletter
221\patchcmd{\minted@checkstyle}{\minted@input{%
222 \minted@outputdir\minted@cachedir/\ifstrempty{#1}{default-pyg-prefix}{#1}.pygstyle}%
223 }{\minted@input{%
224 \minted@outputdir\minted@cachedir/\ifstrempty{#1}{default-pyg-prefix}{#1}.pygstyle}%
225 \def\PYGZhy{\mbox{\char`\-}}}{}{}
226\makeatother
219\tcbset{colback=white, boxrule=.15mm, colframe=cinnamon, 227\tcbset{colback=white, boxrule=.15mm, colframe=cinnamon,
220 breakable} 228 breakable}
221\newtcbox{\arabluabox}{boxrule=.3mm, left=0mm, right=0mm, top=0mm, 229\newtcbox{\arabluabox}{boxrule=.3mm, left=0mm, right=0mm, top=0mm,
diff --git a/makefile b/makefile
index 4ceb067..d6a1e7d 100644
--- a/makefile
+++ b/makefile
@@ -3,6 +3,7 @@ ver := $(shell ltxfileinfo -v $(pkg).dtx|sed -e 's/^v//')
3TEXMFDIR := $(shell kpsewhich -expand-var='$$TEXMFHOME') 3TEXMFDIR := $(shell kpsewhich -expand-var='$$TEXMFHOME')
4HOMEDIR := $$HOME 4HOMEDIR := $$HOME
5CMP = lualatex-dev 5CMP = lualatex-dev
6SHELL = bash
6 7
7sty: clean 8sty: clean
8 $(CMP) $(pkg).ins 9 $(CMP) $(pkg).ins
generated by cgit v1.2.3 (git 2.25.1) at 2024-11-23 10:03:37 +0000