aboutsummaryrefslogtreecommitdiff
path: root/about.html
diff options
context:
space:
mode:
Diffstat (limited to 'about.html')
-rw-r--r--about.html245
1 files changed, 222 insertions, 23 deletions
diff --git a/about.html b/about.html
index af0eb19..0f7d390 100644
--- a/about.html
+++ b/about.html
@@ -7,13 +7,157 @@
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> 9 <style>
10 html {
11 line-height: 1.5;
12 font-family: Georgia, serif;
13 font-size: 20px;
14 color: #1a1a1a;
15 background-color: #fdfdfd;
16 }
17 body {
18 margin: 0 auto;
19 max-width: 36em;
20 padding-left: 50px;
21 padding-right: 50px;
22 padding-top: 50px;
23 padding-bottom: 50px;
24 hyphens: auto;
25 overflow-wrap: break-word;
26 text-rendering: optimizeLegibility;
27 font-kerning: normal;
28 }
29 @media (max-width: 600px) {
30 body {
31 font-size: 0.9em;
32 padding: 1em;
33 }
34 h1 {
35 font-size: 1.8em;
36 }
37 }
38 @media print {
39 body {
40 background-color: transparent;
41 color: black;
42 font-size: 12pt;
43 }
44 p, h2, h3 {
45 orphans: 3;
46 widows: 3;
47 }
48 h2, h3, h4 {
49 page-break-after: avoid;
50 }
51 }
52 p {
53 margin: 1em 0;
54 }
55 a {
56 color: #1a1a1a;
57 }
58 a:visited {
59 color: #1a1a1a;
60 }
61 img {
62 max-width: 100%;
63 }
64 h1, h2, h3, h4, h5, h6 {
65 margin-top: 1.4em;
66 }
67 h5, h6 {
68 font-size: 1em;
69 font-style: italic;
70 }
71 h6 {
72 font-weight: normal;
73 }
74 ol, ul {
75 padding-left: 1.7em;
76 margin-top: 1em;
77 }
78 li > ol, li > ul {
79 margin-top: 0;
80 }
81 blockquote {
82 margin: 1em 0 1em 1.7em;
83 padding-left: 1em;
84 border-left: 2px solid #e6e6e6;
85 color: #606060;
86 }
87 code {
88 font-family: Menlo, Monaco, 'Lucida Console', Consolas, monospace;
89 font-size: 85%;
90 margin: 0;
91 }
92 pre {
93 margin: 1em 0;
94 overflow: auto;
95 }
96 pre code {
97 padding: 0;
98 overflow: visible;
99 overflow-wrap: normal;
100 }
101 .sourceCode {
102 background-color: transparent;
103 overflow: visible;
104 }
105 hr {
106 background-color: #1a1a1a;
107 border: none;
108 height: 1px;
109 margin: 1em 0;
110 }
111 table {
112 margin: 1em 0;
113 border-collapse: collapse;
114 width: 100%;
115 overflow-x: auto;
116 display: block;
117 font-variant-numeric: lining-nums tabular-nums;
118 }
119 table caption {
120 margin-bottom: 0.75em;
121 }
122 tbody {
123 margin-top: 0.5em;
124 border-top: 1px solid #1a1a1a;
125 border-bottom: 1px solid #1a1a1a;
126 }
127 th {
128 border-top: 1px solid #1a1a1a;
129 padding: 0.25em 0.5em 0.25em 0.5em;
130 }
131 td {
132 padding: 0.125em 0.5em 0.25em 0.5em;
133 }
134 header {
135 margin-bottom: 4em;
136 text-align: center;
137 }
138 #TOC li {
139 list-style: none;
140 }
141 #TOC ul {
142 padding-left: 1.3em;
143 }
144 #TOC > ul {
145 padding-left: 0;
146 }
147 #TOC a:not(:hover) {
148 text-decoration: none;
149 }
10 code{white-space: pre-wrap;} 150 code{white-space: pre-wrap;}
11 span.smallcaps{font-variant: small-caps;} 151 span.smallcaps{font-variant: small-caps;}
12 span.underline{text-decoration: underline;} 152 span.underline{text-decoration: underline;}
13 div.column{display: inline-block; vertical-align: top; width: 50%;} 153 div.column{display: inline-block; vertical-align: top; width: 50%;}
14 div.hanging-indent{margin-left: 1.5em; text-indent: -1.5em;} 154 div.hanging-indent{margin-left: 1.5em; text-indent: -1.5em;}
15 ul.task-list{list-style: none;} 155 ul.task-list{list-style: none;}
156 .display.math{display: block; text-align: center; margin: 0.5rem auto;}
16 </style> 157 </style>
158 <!--[if lt IE 9]>
159 <script src="//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js"></script>
160 <![endif]-->
17</head> 161</head>
18<body> 162<body>
19<header id="title-block-header"> 163<header id="title-block-header">
@@ -21,20 +165,47 @@
21<p class="author">Robert Alessi</p> 165<p class="author">Robert Alessi</p>
22</header> 166</header>
23<h1 class="unnumbered" id="sec:overview">Overview</h1> 167<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> 168<p>This package provides for <a href="http://luatex.org">LuaLaTeX</a> an
25<h1 class="unnumbered" id="license-and-disclamer">License and disclamer</h1> 169<a href="http://ctan.org/pkg/arabtex">ArabTeX</a>-like interface to
170generate Arabic writing from an <span class="smallcaps">ascii</span>
171transliteration. It is particularly well-suited for complex documents
172such as technical documents or critical editions where a lot of
173left-to-right commands intertwine with Arabic writing. arabluatex is
174able to process any ArabTeX input notation. Its output can be set in the
175same modes of vocalization as ArabTeX, or in different roman
176transliterations. It further allows many typographical refinements. It
177will eventually interact with some other packages yet to come to produce
178from <code>.tex</code> source files, in addition to printed books,
179<code>TEI xml</code> compliant critical editions and/or lexicons that
180can be searched, analyzed and correlated in various ways.</p>
181<h1 class="unnumbered" id="license-and-disclamer">License and
182disclamer</h1>
26<p>ArabLuaTeX – Processing ArabTeX notation under LuaLaTeX</p> 183<p>ArabLuaTeX – Processing ArabTeX notation under LuaLaTeX</p>
27<p>Copyright ⓒ 2016–2022 Robert Alessi</p> 184<p>Copyright ⓒ 2016–2022 Robert Alessi</p>
28<p>Please send error reports and suggestions for improvements to Robert Alessi:</p> 185<p>Please send error reports and suggestions for improvements to Robert
186Alessi:</p>
29<ul> 187<ul>
30<li><p>email: <a href="mailto:alessi@robertalessi.net">alessi@robertalessi.net</a></p></li> 188<li><p>email: <a
31<li><p>website: <a href="http://www.robertalessi.net/arabluatex">http://www.robertalessi.net/arabluatex</a></p></li> 189href="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> 190<li><p>website: <a href="http://www.robertalessi.net/arabluatex"
191class="uri">http://www.robertalessi.net/arabluatex</a></p></li>
192<li><p>comments, feature requests, bug reports: <a
193href="https://gitlab.com/ralessi/arabluatex/issues"
194class="uri">https://gitlab.com/ralessi/arabluatex/issues</a></p></li>
33</ul> 195</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> 196<p>This program is free software: you can redistribute it and/or modify
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> 197it under the terms of the GNU General Public License as published by the
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> 198Free Software Foundation, either version 3 of the License, or (at your
37<p>This release of arabluatex consists of the following source files:</p> 199option) any later version.</p>
200<p>This program is distributed in the hope that it will be useful, but
201WITHOUT ANY WARRANTY; without even the implied warranty of
202MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General
203Public License for more details.</p>
204<p>You should have received a copy of the GNU General Public License
205along with this program. If not, see
206&lt;http://www.gnu.org/licenses/&gt;.</p>
207<p>This release of arabluatex consists of the following source
208files:</p>
38<ul> 209<ul>
39<li><p><code>arabluatex.ins</code></p></li> 210<li><p><code>arabluatex.ins</code></p></li>
40<li><p><code>arabluatex.dtx</code></p></li> 211<li><p><code>arabluatex.dtx</code></p></li>
@@ -44,13 +215,23 @@
44<li><p><code>arabluatex_novoc.lua</code></p></li> 215<li><p><code>arabluatex_novoc.lua</code></p></li>
45<li><p><code>arabluatex_trans.lua</code></p></li> 216<li><p><code>arabluatex_trans.lua</code></p></li>
46</ul> 217</ul>
47<h2 class="unnumbered" id="sec:documentation-license">License applicable to the documentation</h2> 218<h2 class="unnumbered" id="sec:documentation-license">License applicable
219to the documentation</h2>
48<p>Copyright ⓒ 2016–2022 Robert Alessi</p> 220<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> 221<p>Permission is granted to copy, distribute and/or modify this document
222under the terms of the GNU Free Documentation License, Version 1.3 or
223any later version published by the Free Software Foundation; with no
224Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A
225copy of the license is included in the section entitled “GNU Free
226Documentation License” of the documentation.</p>
50<h1 class="unnumbered" id="sec:installation">Installation</h1> 227<h1 class="unnumbered" id="sec:installation">Installation</h1>
51<ol> 228<ol>
52<li><p>Run <code>'lualatex arabluatex.ins'</code> to produce the <code>arabluatex.sty</code> file;</p></li> 229<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> 230<code>arabluatex.sty</code> file;</p></li>
231<li><p>To finish the installation you have to move the following files
232into a directory where LaTeX can find them. See the FAQ on
233<code>texfaq.org</code> at <a href="https://texfaq.org/FAQ-inst-wlcf"
234class="uri">https://texfaq.org/FAQ-inst-wlcf</a> for more on this:</p>
54<ul> 235<ul>
55<li><p><code>arabluatex.sty</code></p></li> 236<li><p><code>arabluatex.sty</code></p></li>
56<li><p><code>arabluatex-patch.sty</code></p></li> 237<li><p><code>arabluatex-patch.sty</code></p></li>
@@ -60,20 +241,38 @@
60<li><p><code>arabluatex_novoc.lua</code></p></li> 241<li><p><code>arabluatex_novoc.lua</code></p></li>
61<li><p><code>arabluatex_trans.lua</code></p></li> 242<li><p><code>arabluatex_trans.lua</code></p></li>
62</ul></li> 243</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> 244<li><p>Additionally, those who use emacs with AUCTeX may copy
245<code>arabluatex.el</code> to their <code>~/.emacs.d/auctex/auto</code>
246local directory. This will enable the appropriate hooks for
247ArabLuaTeX in AUCTeX.</p></li>
64</ol> 248</ol>
65<h1 id="sec:devel-git-repos">Development, Git Repository</h1> 249<h1 id="sec:devel-git-repos">Development, Git Repository</h1>
66<h2 class="unnumbered" id="sec:browse-code">Browse the code</h2> 250<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> 251<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> 252href="http://git.robertalessi.net/arabluatex"
69<h2 class="unnumbered" id="sec:comm-feat-requ">Comments, Feature requests, Bug Reports</h2> 253class="uri">http://git.robertalessi.net/arabluatex</a></p>
70<p><a href="https://gitlab.com/ralessi/arabluatex/issues">https://gitlab.com/ralessi/arabluatex/issues</a></p> 254<p>From this page, you can download all the releases of ArabLuaTeX. For
71<h2 class="unnumbered" id="sec:download-repository">Download the repository</h2> 255instructions on how to install ArabLuaTeX, please see above.</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> 256<h2 class="unnumbered" id="sec:comm-feat-requ">Comments, Feature
257requests, Bug Reports</h2>
258<p><a href="https://gitlab.com/ralessi/arabluatex/issues"
259class="uri">https://gitlab.com/ralessi/arabluatex/issues</a></p>
260<h2 class="unnumbered" id="sec:download-repository">Download the
261repository</h2>
262<p>ArabLuaTeX development is facilitated by git, a distributed version
263control system. You will need to install git (most GNU/Linux
264distributions package it in their repositories).</p>
73<p>Use this command to download the repository</p> 265<p>Use this command to download the repository</p>
74<pre><code>git clone http://git.robertalessi.net/arabluatex</code></pre> 266<pre><code>git clone http://git.robertalessi.net/arabluatex</code></pre>
75<p>A new directory named arabluatex will have been created, containing ArabLuaTeX.</p> 267<p>A new directory named arabluatex will have been created, containing
268ArabLuaTeX.</p>
76<h2 class="unnumbered" id="sec:git-hosting">Git hosting</h2> 269<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> 270<p>Make an account on <a href="https://gitlab.com"
271class="uri">https://gitlab.com</a> and navigate (while logged in) to <a
272href="https://gitlab.com/ralessi/arabluatex"
273class="uri">https://gitlab.com/ralessi/arabluatex</a>. Click
274<em>Fork</em> and you will have in your account your own repository of
275<code>arabluatex</code> where you will be able to make whatever changes
276you like to.</p>
78</body> 277</body>
79</html> 278</html>
generated by cgit v1.2.3 (git 2.25.1) at 2024-11-21 20:40:53 +0000