diff options
author | Norbert Preining <norbert@preining.info> | 2020-03-01 03:01:38 +0000 |
---|---|---|
committer | Norbert Preining <norbert@preining.info> | 2020-03-01 03:01:38 +0000 |
commit | ad1928316d819ffb337fc4a926dbef47607dfb95 (patch) | |
tree | ccca9edbbeacc0e88602998f86c75b2c24c02af6 /macros/luatex/latex/arabluatex/README.tex | |
parent | 4736ac744a8c914e0d5ced1d157e017a385bbf43 (diff) |
CTAN sync 202003010301
Diffstat (limited to 'macros/luatex/latex/arabluatex/README.tex')
-rw-r--r-- | macros/luatex/latex/arabluatex/README.tex | 146 |
1 files changed, 146 insertions, 0 deletions
diff --git a/macros/luatex/latex/arabluatex/README.tex b/macros/luatex/latex/arabluatex/README.tex new file mode 100644 index 0000000000..5d4871603f --- /dev/null +++ b/macros/luatex/latex/arabluatex/README.tex @@ -0,0 +1,146 @@ +% The arabluatex package -- README file +% Robert Alessi +% March 18, 2017 +\documentclass{article} + +\usepackage{fontspec} + +\title{The arabluatex package -- README file} +\author{Robert Alessi} +\usepackage{hyperref} +\hypersetup{pdftitle={The arabluatex package -- README file}, + pdfauthor={Robert Alessi}} + +\begin{document} +\maketitle + +\section*{Overview} +\label{sec:overview} +This package provides for \href{http://luatex.org}{Lua\LaTeX} an +\href{http://ctan.org/pkg/arabtex}{Arab\TeX}-like interface to +generate Arabic writing from an \textsc{ascii} 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 +Arab\TeX\ input notation. Its output can be set in the same modes of +vocalization as Arab\TeX, 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 +\verb|.tex| source files, in addition to printed books, \texttt{TEI + xml} compliant critical editions and/or lexicons that can be +searched, analyzed and correlated in various ways. + +\section*{License and disclamer} +ArabLuaTeX -- Processing ArabTeX notation under LuaLaTeX + +Copyright ⓒ 2016--2020 Robert Alessi + +Please send error reports and suggestions for improvements to Robert +Alessi: +\begin{itemize} +\item email: \href{mailto:alessi@robertalessi.net}{alessi@robertalessi.net} +\item website: \url{http://www.robertalessi.net/arabluatex} +\item comments, feature requests, bug reports: + \url{https://gitlab.com/ralessi/arabluatex/issues} +\end{itemize} + +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. + +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. + +You should have received a copy of the GNU General Public License +along with this program. If not, see +<http://www.gnu.org/licenses/>. + +This release of arabluatex consists of the following +source files: +\begin{itemize} +\item \verb|arabluatex.ins| +\item \verb|arabluatex.dtx| +\item \verb|arabluatex.lua| +\item \verb|arabluatex_voc.lua| +\item \verb|arabluatex_fullvoc.lua| +\item \verb|arabluatex_novoc.lua| +\item \verb|arabluatex_trans.lua| +\end{itemize} + +\subsection*{License applicable to the documentation} +\label{sec:documentation-license} +Copyright ⓒ 2016--2020 Robert Alessi + +The documentation file \verb|arabluatex.pdf| that is generated from +the \verb|arabluatex.dtx| source is licensed under the Creative +Commons Attribution-ShareAlike 4.0 International License. To view a +copy of this license, visit +\url{http://creativecommons.org/licenses/by-sa/4.0/} or send a letter +to Creative Commons, PO Box 1866, Mountain View, CA 94042, USA. + +\section*{Installation} +\label{sec:installation} +\begin{enumerate} +\item Run \verb+'lualatex arabluatex.ins'+ to produce the + \verb+arabluatex.sty+ file; +\item To finish the installation you have to move the following files + into a directory where LaTeX can find them. See the FAQ on + \verb|texfaq.org| at + \url{https://texfaq.org/FAQ-inst-wlcf} for more on this: +\begin{itemize} +\item \verb|arabluatex.sty| +\item \verb|arabluatex-patch.sty| +\item \verb|arabluatex.lua| +\item \verb|arabluatex_voc.lua| +\item \verb|arabluatex_fullvoc.lua| +\item \verb|arabluatex_novoc.lua| +\item \verb|arabluatex_trans.lua| +\end{itemize} +\item Additionally, those who use emacs with AUC\TeX\ may copy + \verb|arabluatex.el| to their \verb|~/.emacs.d/auctex/auto| local + directory. This will enable the appropriate hooks for ArabLua\TeX\ + in AUC\TeX. +\end{enumerate} + +\section{Development, Git Repository} +\label{sec:devel-git-repos} +\subsection*{Browse the code} +\label{sec:browse-code} + +You can browse ArabLua\TeX\ repository on the web: +\url{http://git.robertalessi.net/arabluatex} + +From this page, you can download all the releases of ArabLua\TeX. For +instructions on how to install ArabLua\TeX, please see above. + +\subsection*{Comments, Feature requests, Bug Reports} +\label{sec:comm-feat-requ} +\url{https://gitlab.com/ralessi/arabluatex/issues} + +\subsection*{Download the repository} +\label{sec:download-repository} +ArabLua\TeX\ 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). + +Use this command to download the repository +\begin{verbatim} +git clone http://git.robertalessi.net/arabluatex +\end{verbatim} + + +A new directory named arabluatex will have been created, containing +ArabLuaTeX. + +\subsection*{Git hosting} +\label{sec:git-hosting} +Make an account on \url{https://gitlab.com} and navigate (while +logged in) to \url{https://gitlab.com/ralessi/arabluatex}. Click +\emph{Fork} and you will have in your account your own repository of +\verb|arabluatex| where you will be able to make whatever changes you +like to. + +\end{document}
\ No newline at end of file |