README.tex 5.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146
  1. % The arabluatex package -- README file
  2. % Robert Alessi
  3. % March 18, 2017
  4. \documentclass{article}
  5. \usepackage{fontspec}
  6. \title{The arabluatex package -- README file}
  7. \author{Robert Alessi}
  8. \usepackage{hyperref}
  9. \hypersetup{pdftitle={The arabluatex package -- README file},
  10. pdfauthor={Robert Alessi}}
  11. \begin{document}
  12. \maketitle
  13. \section*{Overview}
  14. \label{sec:overview}
  15. This package provides for \href{http://luatex.org}{Lua\LaTeX} an
  16. \href{http://ctan.org/pkg/arabtex}{Arab\TeX}-like interface to
  17. generate Arabic writing from an \textsc{ascii} transliteration. It is
  18. particularly well-suited for complex documents such as technical
  19. documents or critical editions where a lot of left-to-right commands
  20. intertwine with Arabic writing. arabluatex is able to process any
  21. Arab\TeX\ input notation. Its output can be set in the same modes of
  22. vocalization as Arab\TeX, or in different roman transliterations. It
  23. further allows many typographical refinements. It will eventually
  24. interact with some other packages yet to come to produce from
  25. \verb|.tex| source files, in addition to printed books, \texttt{TEI
  26. xml} compliant critical editions and/or lexicons that can be
  27. searched, analyzed and correlated in various ways.
  28. \section*{License and disclamer}
  29. ArabLuaTeX -- Processing ArabTeX notation under LuaLaTeX
  30. Copyright ⓒ 2016--2022 Robert Alessi
  31. Please send error reports and suggestions for improvements to Robert
  32. Alessi:
  33. \begin{itemize}
  34. \item email: \href{mailto:alessi@robertalessi.net}{alessi@robertalessi.net}
  35. \item website: \url{http://www.robertalessi.net/arabluatex}
  36. \item comments, feature requests, bug reports:
  37. \url{https://gitlab.com/ralessi/arabluatex/issues}
  38. \end{itemize}
  39. This program is free software: you can redistribute it and/or modify
  40. it under the terms of the GNU General Public License as published by
  41. the Free Software Foundation, either version 3 of the License, or
  42. (at your option) any later version.
  43. This program is distributed in the hope that it will be useful, but
  44. WITHOUT ANY WARRANTY; without even the implied warranty of
  45. MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  46. General Public License for more details.
  47. You should have received a copy of the GNU General Public License
  48. along with this program. If not, see
  49. <http://www.gnu.org/licenses/>.
  50. This release of arabluatex consists of the following
  51. source files:
  52. \begin{itemize}
  53. \item \verb|arabluatex.ins|
  54. \item \verb|arabluatex.dtx|
  55. \item \verb|arabluatex.lua|
  56. \item \verb|arabluatex_voc.lua|
  57. \item \verb|arabluatex_fullvoc.lua|
  58. \item \verb|arabluatex_novoc.lua|
  59. \item \verb|arabluatex_trans.lua|
  60. \end{itemize}
  61. \subsection*{License applicable to the documentation}
  62. \label{sec:documentation-license}
  63. Copyright ⓒ 2016--2022 Robert Alessi
  64. Permission is granted to copy, distribute and/or modify this document
  65. under the terms of the GNU Free Documentation License, Version 1.3 or
  66. any later version published by the Free Software Foundation; with no
  67. Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A
  68. copy of the license is included in the section entitled ``GNU Free
  69. Documentation License'' of the documentation.
  70. \section*{Installation}
  71. \label{sec:installation}
  72. \begin{enumerate}
  73. \item Run \verb+'lualatex arabluatex.ins'+ to produce the
  74. \verb+arabluatex.sty+ file;
  75. \item To finish the installation you have to move the following files
  76. into a directory where LaTeX can find them. See the FAQ on
  77. \verb|texfaq.org| at
  78. \url{https://texfaq.org/FAQ-inst-wlcf} for more on this:
  79. \begin{itemize}
  80. \item \verb|arabluatex.sty|
  81. \item \verb|arabluatex-patch.sty|
  82. \item \verb|arabluatex.lua|
  83. \item \verb|arabluatex_voc.lua|
  84. \item \verb|arabluatex_fullvoc.lua|
  85. \item \verb|arabluatex_novoc.lua|
  86. \item \verb|arabluatex_trans.lua|
  87. \end{itemize}
  88. \item Additionally, those who use emacs with AUC\TeX\ may copy
  89. \verb|arabluatex.el| to their \verb|~/.emacs.d/auctex/auto| local
  90. directory. This will enable the appropriate hooks for ArabLua\TeX\
  91. in AUC\TeX.
  92. \end{enumerate}
  93. \section{Development, Git Repository}
  94. \label{sec:devel-git-repos}
  95. \subsection*{Browse the code}
  96. \label{sec:browse-code}
  97. You can browse ArabLua\TeX\ repository on the web:
  98. \url{http://git.robertalessi.net/arabluatex}
  99. From this page, you can download all the releases of ArabLua\TeX. For
  100. instructions on how to install ArabLua\TeX, please see above.
  101. \subsection*{Comments, Feature requests, Bug Reports}
  102. \label{sec:comm-feat-requ}
  103. \url{https://gitlab.com/ralessi/arabluatex/issues}
  104. \subsection*{Download the repository}
  105. \label{sec:download-repository}
  106. ArabLua\TeX\ development is facilitated by git, a distributed version
  107. control system. You will need to install git (most GNU/Linux
  108. distributions package it in their repositories).
  109. Use this command to download the repository
  110. \begin{verbatim}
  111. git clone http://git.robertalessi.net/arabluatex
  112. \end{verbatim}
  113. A new directory named arabluatex will have been created, containing
  114. ArabLuaTeX.
  115. \subsection*{Git hosting}
  116. \label{sec:git-hosting}
  117. Make an account on \url{https://gitlab.com} and navigate (while
  118. logged in) to \url{https://gitlab.com/ralessi/arabluatex}. Click
  119. \emph{Fork} and you will have in your account your own repository of
  120. \verb|arabluatex| where you will be able to make whatever changes you
  121. like to.
  122. \end{document}