about.html 6.4 KB

  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
  5. <meta http-equiv="Content-Style-Type" content="text/css" />
  6. <meta name="generator" content="pandoc" />
  7. <meta name="author" content="Robert Alessi" />
  8. <title>The arabluatex package – README file</title>
  9. <style type="text/css">code{white-space: pre;}</style>
  10. </head>
  11. <body>
  12. <div id="header">
  13. <h1 class="title">The arabluatex package – README file</h1>
  14. <h2 class="author">Robert Alessi</h2>
  15. </div>
  16. <h1 id="sec:overview" class="unnumbered">Overview</h1>
  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>
  18. <h1 id="license-and-disclamer" class="unnumbered">License and disclamer</h1>
  19. <p>ArabLuaTeX – Processing ArabTeX notation under LuaLaTeX</p>
  20. <p>Copyright ⓒ 2016–2019 Robert Alessi</p>
  21. <p>Please send error reports and suggestions for improvements to Robert Alessi:</p>
  22. <ul>
  23. <li><p>email: <a href="mailto:alessi@robertalessi.net">alessi@robertalessi.net</a></p></li>
  24. <li><p>website: <a href="http://www.robertalessi.net/arabluatex" class="uri">http://www.robertalessi.net/arabluatex</a></p></li>
  25. <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>
  26. </ul>
  27. <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>
  28. <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>
  29. <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>
  30. <p>This release of arabluatex consists of the following source files:</p>
  31. <ul>
  32. <li><p><code>arabluatex.ins</code></p></li>
  33. <li><p><code>arabluatex.dtx</code></p></li>
  34. <li><p><code>arabluatex.lua</code></p></li>
  35. <li><p><code>arabluatex_voc.lua</code></p></li>
  36. <li><p><code>arabluatex_fullvoc.lua</code></p></li>
  37. <li><p><code>arabluatex_novoc.lua</code></p></li>
  38. <li><p><code>arabluatex_trans.lua</code></p></li>
  39. </ul>
  40. <h2 id="sec:documentation-license" class="unnumbered">License applicable to the documentation</h2>
  41. <p>Copyright ⓒ 2016–2019 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>
  43. <h1 id="sec:installation" class="unnumbered">Installation</h1>
  44. <ol>
  45. <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>
  47. <ul>
  48. <li><p><code>arabluatex.sty</code></p></li>
  49. <li><p><code>arabluatex-patch.sty</code></p></li>
  50. <li><p><code>arabluatex.lua</code></p></li>
  51. <li><p><code>arabluatex_voc.lua</code></p></li>
  52. <li><p><code>arabluatex_fullvoc.lua</code></p></li>
  53. <li><p><code>arabluatex_novoc.lua</code></p></li>
  54. <li><p><code>arabluatex_trans.lua</code></p></li>
  55. </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>
  57. </ol>
  58. <h1 id="sec:devel-git-repos">Development, Git Repository</h1>
  59. <h2 id="sec:browse-code" class="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>
  61. <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>
  63. <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>
  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>
  66. <p>Use this command to download the repository</p>
  67. <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>
  69. <h2 id="sec:git-hosting" class="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>
  71. </body>
  72. </html>