From a0cabb2f3e821251d81ae678df0e906286b6bc5a Mon Sep 17 00:00:00 2001 From: Robert Alessi Date: Tue, 5 Apr 2016 10:29:55 +0200 Subject: .md and .html files are now standalone --- README.md | 41 +++++++++++++++++++++++------------------ README.tex | 34 ++++++++++++++++++++-------------- about.html | 24 ++++++++++++++++++++---- makefile | 4 ++-- 4 files changed, 65 insertions(+), 38 deletions(-) diff --git a/README.md b/README.md index 2e1df44..d686738 100644 --- a/README.md +++ b/README.md @@ -1,27 +1,31 @@ +--- +author: +- Robert Alessi +title: 'The arabluatex package – README file' +--- + Overview ======== -This package provides for LuaLaTeX an ArabTeX-like -interface to generate Arabic writing from an 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 -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 `.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. +This package provides for [LuaLaTeX](http://luatex.org) an +[ArabTeX](http://ctan.org/pkg/arabtex)-like interface to generate Arabic +writing from an 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 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 `.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 ===================== -Copyright ⓒ 2016 Robert Alessi - -Please send error reports and suggestions for improvements to Robert -Alessi: +Copyright ⓒ 2016 Robert Alessi Please send error reports and suggestions +for improvements to Robert Alessi: - email: [alessi@robertalessi.net](alessi@robertalessi.net) @@ -62,7 +66,8 @@ This release of arabluatex consists of the following source files: Installation ============ -1. run `lualatex arabluatex.ins` to produce the `arabluatex.sty` file; +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 `tex.ac.uk` at diff --git a/README.tex b/README.tex index adcee9c..01cd3bc 100644 --- a/README.tex +++ b/README.tex @@ -1,34 +1,40 @@ +% The arabluatex package -- README file +% Robert Alessi +% March 5, 2016 \documentclass{article} \usepackage{fontspec,luatextra} +\usepackage{libertine} -\title{The arabluatex package} +\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 Lua\LaTeX\ an Arab{\TeX}-like interface to +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. +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} Copyright ⓒ 2016 Robert Alessi - -\addcontentsline{toc}{section}{License and disclamer} Please send -error reports and suggestions for improvements to Robert Alessi: +Please send error reports and suggestions for improvements to Robert +Alessi: \begin{itemize} \item email: \url{alessi@robertalessi.net} \item website: \url{http://www.robertalessi.net/arabluatex} @@ -65,7 +71,7 @@ source files: \section*{Installation} \label{sec:installation} \begin{enumerate} -\item run \verb+lualatex arabluatex.ins+ to produce the +\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 diff --git a/about.html b/about.html index 050dcb5..5a69d60 100644 --- a/about.html +++ b/about.html @@ -1,8 +1,22 @@ + + + + + + + + The arabluatex package – README file + + + +

Overview

This package provides for LuaLaTeX an ArabTeX-like interface to generate Arabic writing from an 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 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 .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

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

email: alessi@robertalessi.net
website: http://www.robertalessi.net/arabluatex

Installation

run lualatex arabluatex.ins to produce the arabluatex.sty file;
run 'lualatex arabluatex.ins' to produce the arabluatex.sty file;
To finish the installation you have to move the following files into a directory where LaTeX can find them. See the FAQ on tex.ac.uk at http://www.tex.ac.uk/faq/FAQ-inst-wlcf.html for more on this:
- arabluatex.sty