aboutsummaryrefslogtreecommitdiff
path: root/about.html
blob: 0f7d390eef0f96ef688e8bdda35f743e903e51e6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml" lang="" xml:lang="">
<head>
  <meta charset="utf-8" />
  <meta name="generator" content="pandoc" />
  <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes" />
  <meta name="author" content="Robert Alessi" />
  <title>The arabluatex package – README file</title>
  <style>
    html {
      line-height: 1.5;
      font-family: Georgia, serif;
      font-size: 20px;
      color: #1a1a1a;
      background-color: #fdfdfd;
    }
    body {
      margin: 0 auto;
      max-width: 36em;
      padding-left: 50px;
      padding-right: 50px;
      padding-top: 50px;
      padding-bottom: 50px;
      hyphens: auto;
      overflow-wrap: break-word;
      text-rendering: optimizeLegibility;
      font-kerning: normal;
    }
    @media (max-width: 600px) {
      body {
        font-size: 0.9em;
        padding: 1em;
      }
      h1 {
        font-size: 1.8em;
      }
    }
    @media print {
      body {
        background-color: transparent;
        color: black;
        font-size: 12pt;
      }
      p, h2, h3 {
        orphans: 3;
        widows: 3;
      }
      h2, h3, h4 {
        page-break-after: avoid;
      }
    }
    p {
      margin: 1em 0;
    }
    a {
      color: #1a1a1a;
    }
    a:visited {
      color: #1a1a1a;
    }
    img {
      max-width: 100%;
    }
    h1, h2, h3, h4, h5, h6 {
      margin-top: 1.4em;
    }
    h5, h6 {
      font-size: 1em;
      font-style: italic;
    }
    h6 {
      font-weight: normal;
    }
    ol, ul {
      padding-left: 1.7em;
      margin-top: 1em;
    }
    li > ol, li > ul {
      margin-top: 0;
    }
    blockquote {
      margin: 1em 0 1em 1.7em;
      padding-left: 1em;
      border-left: 2px solid #e6e6e6;
      color: #606060;
    }
    code {
      font-family: Menlo, Monaco, 'Lucida Console', Consolas, monospace;
      font-size: 85%;
      margin: 0;
    }
    pre {
      margin: 1em 0;
      overflow: auto;
    }
    pre code {
      padding: 0;
      overflow: visible;
      overflow-wrap: normal;
    }
    .sourceCode {
     background-color: transparent;
     overflow: visible;
    }
    hr {
      background-color: #1a1a1a;
      border: none;
      height: 1px;
      margin: 1em 0;
    }
    table {
      margin: 1em 0;
      border-collapse: collapse;
      width: 100%;
      overflow-x: auto;
      display: block;
      font-variant-numeric: lining-nums tabular-nums;
    }
    table caption {
      margin-bottom: 0.75em;
    }
    tbody {
      margin-top: 0.5em;
      border-top: 1px solid #1a1a1a;
      border-bottom: 1px solid #1a1a1a;
    }
    th {
      border-top: 1px solid #1a1a1a;
      padding: 0.25em 0.5em 0.25em 0.5em;
    }
    td {
      padding: 0.125em 0.5em 0.25em 0.5em;
    }
    header {
      margin-bottom: 4em;
      text-align: center;
    }
    #TOC li {
      list-style: none;
    }
    #TOC ul {
      padding-left: 1.3em;
    }
    #TOC > ul {
      padding-left: 0;
    }
    #TOC a:not(:hover) {
      text-decoration: none;
    }
    code{white-space: pre-wrap;}
    span.smallcaps{font-variant: small-caps;}
    span.underline{text-decoration: underline;}
    div.column{display: inline-block; vertical-align: top; width: 50%;}
    div.hanging-indent{margin-left: 1.5em; text-indent: -1.5em;}
    ul.task-list{list-style: none;}
    .display.math{display: block; text-align: center; margin: 0.5rem auto;}
  </style>
  <!--[if lt IE 9]>
    <script src="//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js"></script>
  <![endif]-->
</head>
<body>
<header id="title-block-header">
<h1 class="title">The arabluatex package – README file</h1>
<p class="author">Robert Alessi</p>
</header>
<h1 class="unnumbered" id="sec:overview">Overview</h1>
<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>
<h1 class="unnumbered" id="license-and-disclamer">License and
disclamer</h1>
<p>ArabLuaTeX – Processing ArabTeX notation under LuaLaTeX</p>
<p>Copyright ⓒ 20162022 Robert Alessi</p>
<p>Please send error reports and suggestions for improvements to Robert
Alessi:</p>
<ul>
<li><p>email: <a
href="mailto:alessi@robertalessi.net">alessi@robertalessi.net</a></p></li>
<li><p>website: <a href="http://www.robertalessi.net/arabluatex"
class="uri">http://www.robertalessi.net/arabluatex</a></p></li>
<li><p>comments, feature requests, bug reports: <a
href="https://gitlab.com/ralessi/arabluatex/issues"
class="uri">https://gitlab.com/ralessi/arabluatex/issues</a></p></li>
</ul>
<p>This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by the
Free Software Foundation, either version 3 of the License, or (at your
option) any later version.</p>
<p>This program is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General
Public License for more details.</p>
<p>You should have received a copy of the GNU General Public License
along with this program. If not, see
&lt;http://www.gnu.org/licenses/&gt;.</p>
<p>This release of arabluatex consists of the following source
files:</p>
<ul>
<li><p><code>arabluatex.ins</code></p></li>
<li><p><code>arabluatex.dtx</code></p></li>
<li><p><code>arabluatex.lua</code></p></li>
<li><p><code>arabluatex_voc.lua</code></p></li>
<li><p><code>arabluatex_fullvoc.lua</code></p></li>
<li><p><code>arabluatex_novoc.lua</code></p></li>
<li><p><code>arabluatex_trans.lua</code></p></li>
</ul>
<h2 class="unnumbered" id="sec:documentation-license">License applicable
to the documentation</h2>
<p>Copyright ⓒ 20162022 Robert Alessi</p>
<p>Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.3 or
any later version published by the Free Software Foundation; with no
Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A
copy of the license is included in the section entitled “GNU Free
Documentation License” of the documentation.</p>
<h1 class="unnumbered" id="sec:installation">Installation</h1>
<ol>
<li><p>Run <code>'lualatex arabluatex.ins'</code> to produce the
<code>arabluatex.sty</code> file;</p></li>
<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>
<ul>
<li><p><code>arabluatex.sty</code></p></li>
<li><p><code>arabluatex-patch.sty</code></p></li>
<li><p><code>arabluatex.lua</code></p></li>
<li><p><code>arabluatex_voc.lua</code></p></li>
<li><p><code>arabluatex_fullvoc.lua</code></p></li>
<li><p><code>arabluatex_novoc.lua</code></p></li>
<li><p><code>arabluatex_trans.lua</code></p></li>
</ul></li>
<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>
</ol>
<h1 id="sec:devel-git-repos">Development, Git Repository</h1>
<h2 class="unnumbered" id="sec:browse-code">Browse the code</h2>
<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>
<p>From this page, you can download all the releases of ArabLuaTeX. For
instructions on how to install ArabLuaTeX, please see above.</p>
<h2 class="unnumbered" id="sec:comm-feat-requ">Comments, Feature
requests, Bug Reports</h2>
<p><a href="https://gitlab.com/ralessi/arabluatex/issues"
class="uri">https://gitlab.com/ralessi/arabluatex/issues</a></p>
<h2 class="unnumbered" id="sec:download-repository">Download the
repository</h2>
<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>
<p>Use this command to download the repository</p>
<pre><code>git clone http://git.robertalessi.net/arabluatex</code></pre>
<p>A new directory named arabluatex will have been created, containing
ArabLuaTeX.</p>
<h2 class="unnumbered" id="sec:git-hosting">Git hosting</h2>
<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>
</body>
</html>