diff options
-rw-r--r-- | README.md | 41 | ||||
-rw-r--r-- | README.tex | 34 | ||||
-rw-r--r-- | about.html | 24 | ||||
-rw-r--r-- | makefile | 4 |
4 files changed, 65 insertions, 38 deletions
@@ -1,27 +1,31 @@ | |||
1 | --- | ||
2 | author: | ||
3 | - Robert Alessi | ||
4 | title: 'The arabluatex package – README file' | ||
5 | --- | ||
6 | |||
1 | Overview | 7 | Overview |
2 | ======== | 8 | ======== |
3 | 9 | ||
4 | This package provides for LuaLaTeX an Arab<span>TeX</span>-like | 10 | This package provides for [LuaLaTeX](http://luatex.org) an |
5 | interface to generate Arabic writing from an <span | 11 | [ArabTeX](http://ctan.org/pkg/arabtex)-like interface to generate Arabic |
6 | style="font-variant:small-caps;">ascii</span> transliteration. It is | 12 | writing from an <span style="font-variant:small-caps;">ascii</span> |
7 | particularly well-suited for complex documents such as technical | 13 | transliteration. It is particularly well-suited for complex documents |
8 | documents or critical editions where a lot of left-to-right commands | 14 | such as technical documents or critical editions where a lot of |
9 | intertwine with Arabic writing. arabluatex is able to process any | 15 | left-to-right commands intertwine with Arabic writing. arabluatex is |
10 | ArabTeX input notation. Its output can be set in the same modes of | 16 | able to process any ArabTeX input notation. Its output can be set in the |
11 | vocalization as ArabTeX, or in different roman transliterations. It | 17 | same modes of vocalization as ArabTeX, or in different roman |
12 | further allows many typographical refinements. It will eventually | 18 | transliterations. It further allows many typographical refinements. It |
13 | interact with some other packages yet to come to produce from `.tex` | 19 | will eventually interact with some other packages yet to come to produce |
14 | source files, in addition to printed books, `TEI xml` compliant critical | 20 | from `.tex` source files, in addition to printed books, `TEI xml` |
15 | editions and/or lexicons that can be searched, analyzed and correlated | 21 | compliant critical editions and/or lexicons that can be searched, |
16 | in various ways. | 22 | analyzed and correlated in various ways. |
17 | 23 | ||
18 | License and disclamer | 24 | License and disclamer |
19 | ===================== | 25 | ===================== |
20 | 26 | ||
21 | Copyright ⓒ 2016 Robert Alessi | 27 | Copyright ⓒ 2016 Robert Alessi Please send error reports and suggestions |
22 | 28 | for improvements to Robert Alessi: | |
23 | Please send error reports and suggestions for improvements to Robert | ||
24 | Alessi: | ||
25 | 29 | ||
26 | - email: [alessi@robertalessi.net](alessi@robertalessi.net) | 30 | - email: [alessi@robertalessi.net](alessi@robertalessi.net) |
27 | 31 | ||
@@ -62,7 +66,8 @@ This release of arabluatex consists of the following source files: | |||
62 | Installation | 66 | Installation |
63 | ============ | 67 | ============ |
64 | 68 | ||
65 | 1. run `lualatex arabluatex.ins` to produce the `arabluatex.sty` file; | 69 | 1. run `'lualatex arabluatex.ins'` to produce the `arabluatex.sty` |
70 | file; | ||
66 | 71 | ||
67 | 2. To finish the installation you have to move the following files into | 72 | 2. To finish the installation you have to move the following files into |
68 | a directory where LaTeX can find them. See the FAQ on `tex.ac.uk` at | 73 | a directory where LaTeX can find them. See the FAQ on `tex.ac.uk` at |
@@ -1,34 +1,40 @@ | |||
1 | % The arabluatex package -- README file | ||
2 | % Robert Alessi | ||
3 | % March 5, 2016 | ||
1 | \documentclass{article} | 4 | \documentclass{article} |
2 | 5 | ||
3 | \usepackage{fontspec,luatextra} | 6 | \usepackage{fontspec,luatextra} |
7 | \usepackage{libertine} | ||
4 | 8 | ||
5 | \title{The arabluatex package} | 9 | \title{The arabluatex package -- README file} |
6 | \author{Robert Alessi} | 10 | \author{Robert Alessi} |
7 | \usepackage{hyperref} | 11 | \usepackage{hyperref} |
12 | \hypersetup{pdftitle={The arabluatex package -- README file}, | ||
13 | pdfauthor={Robert Alessi}} | ||
8 | 14 | ||
9 | \begin{document} | 15 | \begin{document} |
10 | \maketitle | 16 | \maketitle |
11 | 17 | ||
12 | \section*{Overview} | 18 | \section*{Overview} |
13 | \label{sec:overview} | 19 | \label{sec:overview} |
14 | This package provides for Lua\LaTeX\ an Arab{\TeX}-like interface to | 20 | This package provides for \href{http://luatex.org}{Lua\LaTeX} an |
21 | \href{http://ctan.org/pkg/arabtex}{Arab\TeX}-like interface to | ||
15 | generate Arabic writing from an \textsc{ascii} transliteration. It is | 22 | generate Arabic writing from an \textsc{ascii} transliteration. It is |
16 | particularly well-suited for complex documents such as technical | 23 | particularly well-suited for complex documents such as technical |
17 | documents or critical editions where a lot of left-to-right commands | 24 | documents or critical editions where a lot of left-to-right commands |
18 | intertwine with Arabic writing. arabluatex is able to | 25 | intertwine with Arabic writing. arabluatex is able to process any |
19 | process any Arab\TeX\ input notation. Its output can be set in the | 26 | Arab\TeX\ input notation. Its output can be set in the same modes of |
20 | same modes of vocalization as Arab\TeX, or in different roman | 27 | vocalization as Arab\TeX, or in different roman transliterations. It |
21 | transliterations. It further allows many typographical refinements. It | 28 | further allows many typographical refinements. It will eventually |
22 | will eventually interact with some other packages yet to come to | 29 | interact with some other packages yet to come to produce from |
23 | produce from \verb|.tex| source files, in addition to printed books, | 30 | \verb|.tex| source files, in addition to printed books, \texttt{TEI |
24 | \texttt{TEI xml} compliant critical editions and/or lexicons that can | 31 | xml} compliant critical editions and/or lexicons that can be |
25 | be searched, analyzed and correlated in various ways. | 32 | searched, analyzed and correlated in various ways. |
26 | 33 | ||
27 | \section*{License and disclamer} | 34 | \section*{License and disclamer} |
28 | Copyright ⓒ 2016 Robert Alessi | 35 | Copyright ⓒ 2016 Robert Alessi |
29 | 36 | Please send error reports and suggestions for improvements to Robert | |
30 | \addcontentsline{toc}{section}{License and disclamer} Please send | 37 | Alessi: |
31 | error reports and suggestions for improvements to Robert Alessi: | ||
32 | \begin{itemize} | 38 | \begin{itemize} |
33 | \item email: \url{alessi@robertalessi.net} | 39 | \item email: \url{alessi@robertalessi.net} |
34 | \item website: \url{http://www.robertalessi.net/arabluatex} | 40 | \item website: \url{http://www.robertalessi.net/arabluatex} |
@@ -65,7 +71,7 @@ source files: | |||
65 | \section*{Installation} | 71 | \section*{Installation} |
66 | \label{sec:installation} | 72 | \label{sec:installation} |
67 | \begin{enumerate} | 73 | \begin{enumerate} |
68 | \item run \verb+lualatex arabluatex.ins+ to produce the | 74 | \item run \verb+'lualatex arabluatex.ins'+ to produce the |
69 | \verb+arabluatex.sty+ file; | 75 | \verb+arabluatex.sty+ file; |
70 | \item To finish the installation you have to move the following files | 76 | \item To finish the installation you have to move the following files |
71 | into a directory where LaTeX can find them. See the FAQ on | 77 | into a directory where LaTeX can find them. See the FAQ on |
@@ -1,8 +1,22 @@ | |||
1 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> | ||
2 | <html xmlns="http://www.w3.org/1999/xhtml"> | ||
3 | <head> | ||
4 | <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> | ||
5 | <meta http-equiv="Content-Style-Type" content="text/css" /> | ||
6 | <meta name="generator" content="pandoc" /> | ||
7 | <meta name="author" content="Robert Alessi" /> | ||
8 | <title>The arabluatex package – README file</title> | ||
9 | <style type="text/css">code{white-space: pre;}</style> | ||
10 | </head> | ||
11 | <body> | ||
12 | <div id="header"> | ||
13 | <h1 class="title">The arabluatex package – README file</h1> | ||
14 | <h2 class="author">Robert Alessi</h2> | ||
15 | </div> | ||
1 | <h1 id="sec:overview" class="unnumbered">Overview</h1> | 16 | <h1 id="sec:overview" class="unnumbered">Overview</h1> |
2 | <p>This package provides for LuaLaTeX an Arab<span>TeX</span>-like interface to generate Arabic writing from an <span style="font-variant: small-caps;">ascii</span> 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 will eventually interact with some other packages yet to come to produce from <code>.tex</code> source files, in addition to printed books, <code>TEI xml</code> compliant critical editions and/or lexicons that can be searched, analyzed and correlated in various ways.</p> | 17 | <p>This package provides for <a href="http://luatex.org">LuaLaTeX</a> an <a href="http://ctan.org/pkg/arabtex">ArabTeX</a>-like interface to generate Arabic writing from an <span style="font-variant: small-caps;">ascii</span> 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 will eventually interact with some other packages yet to come to produce from <code>.tex</code> source files, in addition to printed books, <code>TEI xml</code> compliant critical editions and/or lexicons that can be searched, analyzed and correlated in various ways.</p> |
3 | <h1 id="license-and-disclamer" class="unnumbered">License and disclamer</h1> | 18 | <h1 id="license-and-disclamer" class="unnumbered">License and disclamer</h1> |
4 | <p>Copyright ⓒ 2016 Robert Alessi</p> | 19 | <p>Copyright ⓒ 2016 Robert Alessi Please send error reports and suggestions for improvements to Robert Alessi:</p> |
5 | <p>Please send error reports and suggestions for improvements to Robert Alessi:</p> | ||
6 | <ul> | 20 | <ul> |
7 | <li><p>email: <a href="alessi@robertalessi.net" class="uri">alessi@robertalessi.net</a></p></li> | 21 | <li><p>email: <a href="alessi@robertalessi.net" class="uri">alessi@robertalessi.net</a></p></li> |
8 | <li><p>website: <a href="http://www.robertalessi.net/arabluatex" class="uri">http://www.robertalessi.net/arabluatex</a></p></li> | 22 | <li><p>website: <a href="http://www.robertalessi.net/arabluatex" class="uri">http://www.robertalessi.net/arabluatex</a></p></li> |
@@ -23,7 +37,7 @@ | |||
23 | </ul> | 37 | </ul> |
24 | <h1 id="sec:installation" class="unnumbered">Installation</h1> | 38 | <h1 id="sec:installation" class="unnumbered">Installation</h1> |
25 | <ol> | 39 | <ol> |
26 | <li><p>run <code>lualatex arabluatex.ins</code> to produce the <code>arabluatex.sty</code> file;</p></li> | 40 | <li><p>run <code>'lualatex arabluatex.ins'</code> to produce the <code>arabluatex.sty</code> file;</p></li> |
27 | <li><p>To finish the installation you have to move the following files into a directory where LaTeX can find them. See the FAQ on <code>tex.ac.uk</code> at <a href="http://www.tex.ac.uk/faq/FAQ-inst-wlcf.html" class="uri">http://www.tex.ac.uk/faq/FAQ-inst-wlcf.html</a> for more on this:</p> | 41 | <li><p>To finish the installation you have to move the following files into a directory where LaTeX can find them. See the FAQ on <code>tex.ac.uk</code> at <a href="http://www.tex.ac.uk/faq/FAQ-inst-wlcf.html" class="uri">http://www.tex.ac.uk/faq/FAQ-inst-wlcf.html</a> for more on this:</p> |
28 | <ul> | 42 | <ul> |
29 | <li><p><code>arabluatex.sty</code></p></li> | 43 | <li><p><code>arabluatex.sty</code></p></li> |
@@ -46,3 +60,5 @@ | |||
46 | <pre><code>git clone http://git.robertalessi.net/cgit.cgi/arabluatex</code></pre> | 60 | <pre><code>git clone http://git.robertalessi.net/cgit.cgi/arabluatex</code></pre> |
47 | <p>A new directory named arabluatex will have been created, containing ArabLuaTeX. Git hosting</p> | 61 | <p>A new directory named arabluatex will have been created, containing ArabLuaTeX. Git hosting</p> |
48 | <p>Please, do not use GitHub or GitLab: see <a href="https://libreboot.org/git/#githosting">there</a>.</p> | 62 | <p>Please, do not use GitHub or GitLab: see <a href="https://libreboot.org/git/#githosting">there</a>.</p> |
63 | </body> | ||
64 | </html> | ||
@@ -42,5 +42,5 @@ clean: | |||
42 | rm *.* | 42 | rm *.* |
43 | cp saved/* . | 43 | cp saved/* . |
44 | rm -rf saved/ | 44 | rm -rf saved/ |
45 | pandoc README.tex -o README.md && sed -i 's/{#.*}//g' README.md | 45 | pandoc -s README.tex -o README.md && sed -i 's/{#.*}//g' README.md |
46 | pandoc README.tex -o about.html | 46 | pandoc -s README.tex -o about.html |