README.tex 4.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135
  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, 2017, 2018, 2019, 2020, 2021, 2022, 2023
  31. Robert Alessi <\verb|alessi@robertalessi.net|>
  32. Permission to use, copy, modify, and distribute this software for any
  33. purpose with or without fee is hereby granted, provided that the above
  34. copyright notice and this permission notice appear in all copies.
  35. THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
  36. WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  37. MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
  38. ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  39. WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  40. ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  41. OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  42. Please send error reports and suggestions for improvements to Robert
  43. Alessi:
  44. \begin{itemize}
  45. \item email: \href{mailto:alessi@robertalessi.net}{alessi@robertalessi.net}
  46. \item website: \url{https://sr.ht/~ralessi/arabluatex}
  47. \item comments, feature requests, bug reports:
  48. \url{https://todo.sr.ht/~ralessi/arabluatex}
  49. \end{itemize}
  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. \section*{Installation}
  62. \label{sec:installation}
  63. \begin{enumerate}
  64. \item Run \verb+'lualatex arabluatex.ins'+ to produce the
  65. \verb+arabluatex.sty+ file;
  66. \item To finish the installation you have to move the following files
  67. into a directory where LaTeX can find them. See the FAQ on
  68. \verb|texfaq.org| at
  69. \url{https://texfaq.org/FAQ-inst-wlcf} for more on this:
  70. \begin{itemize}
  71. \item \verb|arabluatex.sty|
  72. \item \verb|arabluatex-patch.sty|
  73. \item \verb|arabluatex.lua|
  74. \item \verb|arabluatex_voc.lua|
  75. \item \verb|arabluatex_fullvoc.lua|
  76. \item \verb|arabluatex_novoc.lua|
  77. \item \verb|arabluatex_trans.lua|
  78. \end{itemize}
  79. \item Additionally, those who use emacs with AUC\TeX\ may copy
  80. \verb|arabluatex.el| to their \verb|~/.emacs.d/auctex/auto| local
  81. directory. This will enable the appropriate hooks for ArabLua\TeX\
  82. in AUC\TeX.
  83. \end{enumerate}
  84. \section{Development, Git Repository}
  85. \label{sec:devel-git-repos}
  86. \subsection*{Browse the code}
  87. \label{sec:browse-code}
  88. You can browse ArabLua\TeX\ repository on the web:
  89. \url{http://git.robertalessi.net/arabluatex}\\
  90. or\\
  91. \url{https://sr.ht/~ralessi/arabluatex}
  92. From this page, you can download all the releases of ArabLua\TeX. For
  93. instructions on how to install ArabLua\TeX, please see above.
  94. \subsection*{Comments, Feature requests, Bug Reports}
  95. \label{sec:comm-feat-requ}
  96. \url{https://todo.sr.ht/~ralessi/arabluatex}
  97. \subsection*{Download the repository}
  98. \label{sec:download-repository}
  99. ArabLua\TeX\ development is facilitated by git, a distributed version
  100. control system. You will need to install git (most Unix/Linux
  101. distributions package it in their repositories).
  102. Use this command to download the repository
  103. \begin{verbatim}
  104. git clone https://git.sr.ht/~ralessi/arabluatex
  105. \end{verbatim}
  106. A new directory named arabluatex will have been created, containing
  107. ArabLuaTeX.
  108. \subsection*{Git hosting}
  109. \label{sec:git-hosting}
  110. Make an account on \url{https://sr.ht} and navigate (while logged in)
  111. to \url{https://git.sr.ht/~ralessi/arabluatex}. Click \emph{Clone repo
  112. to your account} and you will have in your account your own
  113. repository of \verb|arabluatex| where you will be able to make
  114. whatever changes you like to.
  115. \end{document}