aboutsummaryrefslogtreecommitdiff
path: root/about.html
diff options
context:
space:
mode:
Diffstat (limited to 'about.html')
-rw-r--r--about.html127
1 files changed, 77 insertions, 50 deletions
diff --git a/about.html b/about.html
index af0eb19..d5b5236 100644
--- a/about.html
+++ b/about.html
@@ -1,40 +1,47 @@
1<!DOCTYPE html>
2<html xmlns="http://www.w3.org/1999/xhtml" lang="" xml:lang="">
3<head>
4 <meta charset="utf-8" />
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" />
8 <title>The arabluatex package – README file</title>
9 <style>
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 div.hanging-indent{margin-left: 1.5em; text-indent: -1.5em;}
15 ul.task-list{list-style: none;}
16 </style>
17</head>
18<body>
19<header id="title-block-header">
20<h1 class="title">The arabluatex package – README file</h1>
21<p class="author">Robert Alessi</p>
22</header>
23<h1 class="unnumbered" id="sec:overview">Overview</h1> 1<h1 class="unnumbered" id="sec:overview">Overview</h1>
24<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> 2<p>This package provides for <a href="https://luatex.org">LuaLaTeX</a>
25<h1 class="unnumbered" id="license-and-disclamer">License and disclamer</h1> 3an <a href="https://ctan.org/pkg/arabtex">ArabTeX</a>-like interface to
4generate Arabic writing from an <span class="smallcaps">ascii</span>
5transliteration. It is particularly well-suited for complex documents
6such as technical documents or critical editions where a lot of
7left-to-right commands intertwine with Arabic writing. arabluatex is
8able to process any ArabTeX input notation. Its output can be set in the
9same modes of vocalization as ArabTeX, or in different roman
10transliterations. It further allows many typographical refinements. It
11can also operate with the <a
12href="https://ctan.org/pkg/ekdosis">ekdosis</a> package to produce from
13<code>.tex</code> source files, in addition to printed books,
14<code>TEI xml</code> compliant critical editions and/or lexicons that
15can be searched, analyzed and correlated in various ways.</p>
16<h1 class="unnumbered" id="license-and-disclamer">License and
17disclamer</h1>
26<p>ArabLuaTeX – Processing ArabTeX notation under LuaLaTeX</p> 18<p>ArabLuaTeX – Processing ArabTeX notation under LuaLaTeX</p>
27<p>Copyright ⓒ 2016–2022 Robert Alessi</p> 19<p>Copyright ⓒ 2016, 2017, 2018, 2019, 2020, 2021, 2022, 2023 Robert
28<p>Please send error reports and suggestions for improvements to Robert Alessi:</p> 20Alessi &lt;<code>alessi@robertalessi.net</code>&gt;</p>
21<p>Permission to use, copy, modify, and distribute this software for any
22purpose with or without fee is hereby granted, provided that the above
23copyright notice and this permission notice appear in all copies.</p>
24<p>THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
25WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES
26OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE
27FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY
28DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER
29IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
30OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
31SOFTWARE.</p>
32<p>Please send error reports and suggestions for improvements to Robert
33Alessi:</p>
29<ul> 34<ul>
30<li><p>email: <a href="mailto:alessi@robertalessi.net">alessi@robertalessi.net</a></p></li> 35<li><p>email: <a
31<li><p>website: <a href="http://www.robertalessi.net/arabluatex">http://www.robertalessi.net/arabluatex</a></p></li> 36href="mailto:alessi@robertalessi.net">alessi@robertalessi.net</a></p></li>
32<li><p>comments, feature requests, bug reports: <a href="https://gitlab.com/ralessi/arabluatex/issues">https://gitlab.com/ralessi/arabluatex/issues</a></p></li> 37<li><p>website: <a href="https://sr.ht/~ralessi/arabluatex"
38class="uri">https://sr.ht/~ralessi/arabluatex</a></p></li>
39<li><p>comments, feature requests, bug reports: <a
40href="https://todo.sr.ht/~ralessi/arabluatex"
41class="uri">https://todo.sr.ht/~ralessi/arabluatex</a></p></li>
33</ul> 42</ul>
34<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> 43<p>This release of arabluatex consists of the following source
35<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> 44files:</p>
36<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>
37<p>This release of arabluatex consists of the following source files:</p>
38<ul> 45<ul>
39<li><p><code>arabluatex.ins</code></p></li> 46<li><p><code>arabluatex.ins</code></p></li>
40<li><p><code>arabluatex.dtx</code></p></li> 47<li><p><code>arabluatex.dtx</code></p></li>
@@ -44,13 +51,14 @@
44<li><p><code>arabluatex_novoc.lua</code></p></li> 51<li><p><code>arabluatex_novoc.lua</code></p></li>
45<li><p><code>arabluatex_trans.lua</code></p></li> 52<li><p><code>arabluatex_trans.lua</code></p></li>
46</ul> 53</ul>
47<h2 class="unnumbered" id="sec:documentation-license">License applicable to the documentation</h2>
48<p>Copyright ⓒ 2016–2022 Robert Alessi</p>
49<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>
50<h1 class="unnumbered" id="sec:installation">Installation</h1> 54<h1 class="unnumbered" id="sec:installation">Installation</h1>
51<ol> 55<ol>
52<li><p>Run <code>'lualatex arabluatex.ins'</code> to produce the <code>arabluatex.sty</code> file;</p></li> 56<li><p>Run <code>'lualatex arabluatex.ins'</code> to produce the
53<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">https://texfaq.org/FAQ-inst-wlcf</a> for more on this:</p> 57<code>arabluatex.sty</code> file;</p></li>
58<li><p>To finish the installation you have to move the following files
59into a directory where LaTeX can find them. See the FAQ on
60<code>texfaq.org</code> at <a href="https://texfaq.org/FAQ-inst-wlcf"
61class="uri">https://texfaq.org/FAQ-inst-wlcf</a> for more on this:</p>
54<ul> 62<ul>
55<li><p><code>arabluatex.sty</code></p></li> 63<li><p><code>arabluatex.sty</code></p></li>
56<li><p><code>arabluatex-patch.sty</code></p></li> 64<li><p><code>arabluatex-patch.sty</code></p></li>
@@ -60,20 +68,39 @@
60<li><p><code>arabluatex_novoc.lua</code></p></li> 68<li><p><code>arabluatex_novoc.lua</code></p></li>
61<li><p><code>arabluatex_trans.lua</code></p></li> 69<li><p><code>arabluatex_trans.lua</code></p></li>
62</ul></li> 70</ul></li>
63<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> 71<li><p>Additionally, those who use emacs with AUCTeX may copy
72<code>arabluatex.el</code> to their <code>~/.emacs.d/auctex/auto</code>
73local directory. This will enable the appropriate hooks for
74ArabLuaTeX in AUCTeX.</p></li>
64</ol> 75</ol>
65<h1 id="sec:devel-git-repos">Development, Git Repository</h1> 76<h1 id="sec:devel-git-repos">Development, Git Repository</h1>
66<h2 class="unnumbered" id="sec:browse-code">Browse the code</h2> 77<h2 class="unnumbered" id="sec:browse-code">Browse the code</h2>
67<p>You can browse ArabLuaTeX repository on the web: <a href="http://git.robertalessi.net/arabluatex">http://git.robertalessi.net/arabluatex</a></p> 78<p>You can browse ArabLuaTeX repository on the web: <a
68<p>From this page, you can download all the releases of ArabLuaTeX. For instructions on how to install ArabLuaTeX, please see above.</p> 79href="http://git.robertalessi.net/arabluatex"
69<h2 class="unnumbered" id="sec:comm-feat-requ">Comments, Feature requests, Bug Reports</h2> 80class="uri">http://git.robertalessi.net/arabluatex</a><br />
70<p><a href="https://gitlab.com/ralessi/arabluatex/issues">https://gitlab.com/ralessi/arabluatex/issues</a></p> 81or<br />
71<h2 class="unnumbered" id="sec:download-repository">Download the repository</h2> 82<a href="https://sr.ht/~ralessi/arabluatex"
72<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> 83class="uri">https://sr.ht/~ralessi/arabluatex</a></p>
84<p>From this page, you can download all the releases of ArabLuaTeX. For
85instructions on how to install ArabLuaTeX, please see above.</p>
86<h2 class="unnumbered" id="sec:comm-feat-requ">Comments, Feature
87requests, Bug Reports</h2>
88<p><a href="https://todo.sr.ht/~ralessi/arabluatex"
89class="uri">https://todo.sr.ht/~ralessi/arabluatex</a></p>
90<h2 class="unnumbered" id="sec:download-repository">Download the
91repository</h2>
92<p>ArabLuaTeX development is facilitated by git, a distributed version
93control system. You will need to install git (most Unix/Linux
94distributions package it in their repositories).</p>
73<p>Use this command to download the repository</p> 95<p>Use this command to download the repository</p>
74<pre><code>git clone http://git.robertalessi.net/arabluatex</code></pre> 96<pre><code>git clone https://git.sr.ht/~ralessi/arabluatex</code></pre>
75<p>A new directory named arabluatex will have been created, containing ArabLuaTeX.</p> 97<p>A new directory named arabluatex will have been created, containing
98ArabLuaTeX.</p>
76<h2 class="unnumbered" id="sec:git-hosting">Git hosting</h2> 99<h2 class="unnumbered" id="sec:git-hosting">Git hosting</h2>
77<p>Make an account on <a href="https://gitlab.com">https://gitlab.com</a> and navigate (while logged in) to <a href="https://gitlab.com/ralessi/arabluatex">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> 100<p>Make an account on <a href="https://sr.ht"
78</body> 101class="uri">https://sr.ht</a> and navigate (while logged in) to <a
79</html> 102href="https://git.sr.ht/~ralessi/arabluatex"
103class="uri">https://git.sr.ht/~ralessi/arabluatex</a>. Click <em>Clone
104repo to your account</em> and you will have in your account your own
105repository of <code>arabluatex</code> where you will be able to make
106whatever changes you like to.</p>
generated by cgit v1.2.3 (git 2.25.1) at 2024-05-04 13:06:33 +0000