aboutsummaryrefslogtreecommitdiff
path: root/about.html
diff options
context:
space:
mode:
Diffstat (limited to 'about.html')
-rw-r--r--about.html47
1 files changed, 24 insertions, 23 deletions
diff --git a/about.html b/about.html
index a718fa2..af0eb19 100644
--- a/about.html
+++ b/about.html
@@ -6,29 +6,30 @@
6 <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes" /> 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"> 9 <style>
10 code{white-space: pre-wrap;} 10 code{white-space: pre-wrap;}
11 span.smallcaps{font-variant: small-caps;} 11 span.smallcaps{font-variant: small-caps;}
12 span.underline{text-decoration: underline;} 12 span.underline{text-decoration: underline;}
13 div.column{display: inline-block; vertical-align: top; width: 50%;} 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;}
14 </style> 16 </style>
15</head> 17</head>
16<body> 18<body>
17<header> 19<header id="title-block-header">
18<h1 class="title">The arabluatex package – README file</h1> 20<h1 class="title">The arabluatex package – README file</h1>
19<p class="author">Robert Alessi</p> 21<p class="author">Robert Alessi</p>
20</header> 22</header>
21 23<h1 class="unnumbered" id="sec:overview">Overview</h1>
22<h1 id="sec:overview" class="unnumbered unnumbered">Overview</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<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> 25<h1 class="unnumbered" id="license-and-disclamer">License and disclamer</h1>
25<p>ArabLuaTeX – Processing ArabTeX notation under LuaLaTeX</p> 26<p>ArabLuaTeX – Processing ArabTeX notation under LuaLaTeX</p>
26<p>Copyright ⓒ 2016–2020 Robert Alessi</p> 27<p>Copyright ⓒ 2016–2022 Robert Alessi</p>
27<p>Please send error reports and suggestions for improvements to Robert Alessi:</p> 28<p>Please send error reports and suggestions for improvements to Robert Alessi:</p>
28<ul> 29<ul>
29<li><p>email: <a href="mailto:alessi@robertalessi.net">alessi@robertalessi.net</a></p></li> 30<li><p>email: <a href="mailto:alessi@robertalessi.net">alessi@robertalessi.net</a></p></li>
30<li><p>website: <a href="http://www.robertalessi.net/arabluatex" class="uri">http://www.robertalessi.net/arabluatex</a></p></li> 31<li><p>website: <a href="http://www.robertalessi.net/arabluatex">http://www.robertalessi.net/arabluatex</a></p></li>
31<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> 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>
32</ul> 33</ul>
33<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> 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>
34<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> 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>
@@ -43,13 +44,13 @@
43<li><p><code>arabluatex_novoc.lua</code></p></li> 44<li><p><code>arabluatex_novoc.lua</code></p></li>
44<li><p><code>arabluatex_trans.lua</code></p></li> 45<li><p><code>arabluatex_trans.lua</code></p></li>
45</ul> 46</ul>
46<h2 id="sec:documentation-license" class="unnumbered unnumbered">License applicable to the documentation</h2> 47<h2 class="unnumbered" id="sec:documentation-license">License applicable to the documentation</h2>
47<p>Copyright ⓒ 2016–2020 Robert Alessi</p> 48<p>Copyright ⓒ 2016–2022 Robert Alessi</p>
48<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> 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>
49<h1 id="sec:installation" class="unnumbered unnumbered">Installation</h1> 50<h1 class="unnumbered" id="sec:installation">Installation</h1>
50<ol> 51<ol>
51<li><p>Run <code>'lualatex arabluatex.ins'</code> to produce the <code>arabluatex.sty</code> file;</p></li> 52<li><p>Run <code>'lualatex arabluatex.ins'</code> to produce the <code>arabluatex.sty</code> file;</p></li>
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<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>
53<ul> 54<ul>
54<li><p><code>arabluatex.sty</code></p></li> 55<li><p><code>arabluatex.sty</code></p></li>
55<li><p><code>arabluatex-patch.sty</code></p></li> 56<li><p><code>arabluatex-patch.sty</code></p></li>
@@ -62,17 +63,17 @@
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> 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>
63</ol> 64</ol>
64<h1 id="sec:devel-git-repos">Development, Git Repository</h1> 65<h1 id="sec:devel-git-repos">Development, Git Repository</h1>
65<h2 id="sec:browse-code" class="unnumbered unnumbered">Browse the code</h2> 66<h2 class="unnumbered" id="sec:browse-code">Browse the code</h2>
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> 67<p>You can browse ArabLuaTeX repository on the web: <a href="http://git.robertalessi.net/arabluatex">http://git.robertalessi.net/arabluatex</a></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> 68<p>From this page, you can download all the releases of ArabLuaTeX. For instructions on how to install ArabLuaTeX, please see above.</p>
68<h2 id="sec:comm-feat-requ" class="unnumbered unnumbered">Comments, Feature requests, Bug Reports</h2> 69<h2 class="unnumbered" id="sec:comm-feat-requ">Comments, Feature requests, Bug Reports</h2>
69<p><a href="https://gitlab.com/ralessi/arabluatex/issues" class="uri">https://gitlab.com/ralessi/arabluatex/issues</a></p> 70<p><a href="https://gitlab.com/ralessi/arabluatex/issues">https://gitlab.com/ralessi/arabluatex/issues</a></p>
70<h2 id="sec:download-repository" class="unnumbered unnumbered">Download the repository</h2> 71<h2 class="unnumbered" id="sec:download-repository">Download the repository</h2>
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> 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>
72<p>Use this command to download the repository</p> 73<p>Use this command to download the repository</p>
73<pre><code>git clone http://git.robertalessi.net/arabluatex</code></pre> 74<pre><code>git clone http://git.robertalessi.net/arabluatex</code></pre>
74<p>A new directory named arabluatex will have been created, containing ArabLuaTeX.</p> 75<p>A new directory named arabluatex will have been created, containing ArabLuaTeX.</p>
75<h2 id="sec:git-hosting" class="unnumbered unnumbered">Git hosting</h2> 76<h2 class="unnumbered" id="sec:git-hosting">Git hosting</h2>
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> 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>
77</body> 78</body>
78</html> 79</html>
generated by cgit v1.2.3 (git 2.25.1) at 2024-05-02 02:51:49 +0000