# Overview 

This package provides for [LuaLaTeX](https://luatex.org) an
[ArabTeX](https://ctan.org/pkg/arabtex)-like interface to generate
Arabic writing from an [ascii]{.smallcaps} 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 can also operate with
the [ekdosis](https://ctan.org/pkg/ekdosis) package to produce from
`.tex` source files, in addition to printed books, `TEI xml` compliant
critical editions and/or lexicons that can be searched, analyzed and
correlated in various ways.

# License and disclamer 

ArabLuaTeX -- Processing ArabTeX notation under LuaLaTeX

Copyright ⓒ 2016, 2017, 2018, 2019, 2020, 2021, 2022, 2023 Robert Alessi
\<`alessi@robertalessi.net`\>

Permission to use, copy, modify, and distribute this software for any
purpose with or without fee is hereby granted, provided that the above
copyright notice and this permission notice appear in all copies.

THE SOFTWARE IS PROVIDED \"AS IS\" AND THE AUTHOR DISCLAIMS ALL
WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES
OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE
FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY
DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER
IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

Please send error reports and suggestions for improvements to Robert
Alessi:

-   email: <alessi@robertalessi.net>

-   website: <https://sr.ht/~ralessi/arabluatex>

-   comments, feature requests, bug reports:
    <https://todo.sr.ht/~ralessi/arabluatex>

This release of arabluatex consists of the following source files:

-   `arabluatex.ins`

-   `arabluatex.dtx`

-   `arabluatex.lua`

-   `arabluatex_voc.lua`

-   `arabluatex_fullvoc.lua`

-   `arabluatex_novoc.lua`

-   `arabluatex_trans.lua`

# Installation 

1.  Run `'lualatex arabluatex.ins'` to produce the `arabluatex.sty`
    file;

2.  To finish the installation you have to move the following files into
    a directory where LaTeX can find them. See the FAQ on `texfaq.org`
    at <https://texfaq.org/FAQ-inst-wlcf> for more on this:

    -   `arabluatex.sty`

    -   `arabluatex-patch.sty`

    -   `arabluatex.lua`

    -   `arabluatex_voc.lua`

    -   `arabluatex_fullvoc.lua`

    -   `arabluatex_novoc.lua`

    -   `arabluatex_trans.lua`

3.  Additionally, those who use emacs with AUCTeX may copy
    `arabluatex.el` to their `~/.emacs.d/auctex/auto` local directory.
    This will enable the appropriate hooks for ArabLuaTeX in AUCTeX.

# Development, Git Repository 

## Browse the code 

You can browse ArabLuaTeX repository on the web:
<http://git.robertalessi.net/arabluatex>\
or\
<https://sr.ht/~ralessi/arabluatex>

From this page, you can download all the releases of ArabLuaTeX. For
instructions on how to install ArabLuaTeX, please see above.

## Comments, Feature requests, Bug Reports 

<https://todo.sr.ht/~ralessi/arabluatex>

## Download the repository 

ArabLuaTeX development is facilitated by git, a distributed version
control system. You will need to install git (most Unix/Linux
distributions package it in their repositories).

Use this command to download the repository

    git clone https://git.sr.ht/~ralessi/arabluatex

A new directory named arabluatex will have been created, containing
ArabLuaTeX.

## Git hosting 

Make an account on <https://sr.ht> and navigate (while logged in) to
<https://git.sr.ht/~ralessi/arabluatex>. Click *Clone repo to your
account* and you will have in your account your own repository of
`arabluatex` where you will be able to make whatever changes you like
to.