about.html 5.4 KB

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