diff options
author | Robert Alessi <alessi@robertalessi.net> | 2020-11-08 11:15:33 +0100 |
---|---|---|
committer | Robert Alessi <alessi@robertalessi.net> | 2020-11-08 11:15:33 +0100 |
commit | cfa490f2f0ec6ffd35af24a948e7c1c304928083 (patch) | |
tree | 53eb3e37ee119920e08ce6031f6aa44c502178f9 /README.md | |
parent | f25eea6af4f41ef7529e1488d2c2e6777f1dca7a (diff) | |
download | arabluatex-cfa490f2f0ec6ffd35af24a948e7c1c304928083.tar.gz |
use geometry in the documentation. minted needs a temporary patch because of a bug in the current luatex hyphenation mechanism
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 34 |
1 files changed, 17 insertions, 17 deletions
@@ -1,32 +1,32 @@ | |||
1 | --- | 1 | --- |
2 | author: | 2 | author: |
3 | - Robert Alessi | 3 | - Robert Alessi |
4 | title: 'The arabluatex package – README file' | 4 | title: 'The arabluatex package -- README file' |
5 | --- | 5 | --- |
6 | 6 | ||
7 | \maketitle | ||
7 | Overview | 8 | Overview |
8 | ======== | 9 | ======== |
9 | 10 | ||
10 | This package provides for [LuaLaTeX](http://luatex.org) an | 11 | This package provides for [LuaLaTeX](http://luatex.org) an |
11 | [ArabTeX](http://ctan.org/pkg/arabtex)-like interface to generate Arabic | 12 | [ArabTeX](http://ctan.org/pkg/arabtex)-like interface to generate Arabic |
12 | writing from an <span style="font-variant:small-caps;">ascii</span> | 13 | writing from an [ascii]{.smallcaps} transliteration. It is particularly |
13 | transliteration. It is particularly well-suited for complex documents | 14 | well-suited for complex documents such as technical documents or |
14 | such as technical documents or critical editions where a lot of | 15 | critical editions where a lot of left-to-right commands intertwine with |
15 | left-to-right commands intertwine with Arabic writing. arabluatex is | 16 | Arabic writing. arabluatex is able to process any ArabTeX input |
16 | able to process any ArabTeX input notation. Its output can be set in the | 17 | notation. Its output can be set in the same modes of vocalization as |
17 | same modes of vocalization as ArabTeX, or in different roman | 18 | ArabTeX, or in different roman transliterations. It further allows many |
18 | transliterations. It further allows many typographical refinements. It | 19 | typographical refinements. It will eventually interact with some other |
19 | will eventually interact with some other packages yet to come to produce | 20 | packages yet to come to produce from `.tex` source files, in addition to |
20 | from `.tex` source files, in addition to printed books, `TEI xml` | 21 | printed books, `TEI xml` compliant critical editions and/or lexicons |
21 | compliant critical editions and/or lexicons that can be searched, | 22 | that can be searched, analyzed and correlated in various ways. |
22 | analyzed and correlated in various ways. | ||
23 | 23 | ||
24 | License and disclamer | 24 | License and disclamer |
25 | ===================== | 25 | ===================== |
26 | 26 | ||
27 | ArabLuaTeX – Processing ArabTeX notation under LuaLaTeX | 27 | ArabLuaTeX -- Processing ArabTeX notation under LuaLaTeX |
28 | 28 | ||
29 | Copyright ⓒ 2016–2020 Robert Alessi | 29 | Copyright ⓒ 2016--2020 Robert Alessi |
30 | 30 | ||
31 | Please send error reports and suggestions for improvements to Robert | 31 | Please send error reports and suggestions for improvements to Robert |
32 | Alessi: | 32 | Alessi: |
@@ -49,7 +49,7 @@ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General | |||
49 | Public License for more details. | 49 | Public License for more details. |
50 | 50 | ||
51 | You should have received a copy of the GNU General Public License along | 51 | You should have received a copy of the GNU General Public License along |
52 | with this program. If not, see <http://www.gnu.org/licenses/>. | 52 | with this program. If not, see \<http://www.gnu.org/licenses/\>. |
53 | 53 | ||
54 | This release of arabluatex consists of the following source files: | 54 | This release of arabluatex consists of the following source files: |
55 | 55 | ||
@@ -70,7 +70,7 @@ This release of arabluatex consists of the following source files: | |||
70 | License applicable to the documentation | 70 | License applicable to the documentation |
71 | --------------------------------------- | 71 | --------------------------------------- |
72 | 72 | ||
73 | Copyright ⓒ 2016–2020 Robert Alessi | 73 | Copyright ⓒ 2016--2020 Robert Alessi |
74 | 74 | ||
75 | The documentation file `arabluatex.pdf` that is generated from the | 75 | The documentation file `arabluatex.pdf` that is generated from the |
76 | `arabluatex.dtx` source is licensed under the Creative Commons | 76 | `arabluatex.dtx` source is licensed under the Creative Commons |
@@ -104,7 +104,7 @@ Installation | |||
104 | 104 | ||
105 | 3. Additionally, those who use emacs with AUCTeX may copy | 105 | 3. Additionally, those who use emacs with AUCTeX may copy |
106 | `arabluatex.el` to their `~/.emacs.d/auctex/auto` local directory. | 106 | `arabluatex.el` to their `~/.emacs.d/auctex/auto` local directory. |
107 | This will enable the appropriate hooks for ArabLuaTeX in AUCTeX. | 107 | This will enable the appropriate hooks for ArabLuaTeX in AUCTeX. |
108 | 108 | ||
109 | Development, Git Repository | 109 | Development, Git Repository |
110 | =========================== | 110 | =========================== |