From cfa490f2f0ec6ffd35af24a948e7c1c304928083 Mon Sep 17 00:00:00 2001 From: Robert Alessi Date: Sun, 8 Nov 2020 11:15:33 +0100 Subject: use geometry in the documentation. minted needs a temporary patch because of a bug in the current luatex hyphenation mechanism --- README.md | 34 +++++++++++++++++----------------- about.html | 42 ++++++++++++++++++++++++------------------ arabluatex.dtx | 8 ++++++++ makefile | 1 + 4 files changed, 50 insertions(+), 35 deletions(-) diff --git a/README.md b/README.md index 5cd4118..908a6ba 100644 --- a/README.md +++ b/README.md @@ -1,32 +1,32 @@ --- author: - Robert Alessi -title: 'The arabluatex package – README file' +title: 'The arabluatex package -- README file' --- +\maketitle Overview ======== 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. +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 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 ===================== -ArabLuaTeX – Processing ArabTeX notation under LuaLaTeX +ArabLuaTeX -- Processing ArabTeX notation under LuaLaTeX -Copyright ⓒ 2016–2020 Robert Alessi +Copyright ⓒ 2016--2020 Robert Alessi Please send error reports and suggestions for improvements to Robert Alessi: @@ -49,7 +49,7 @@ 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/>. +with this program. If not, see \. This release of arabluatex consists of the following source files: @@ -70,7 +70,7 @@ This release of arabluatex consists of the following source files: License applicable to the documentation --------------------------------------- -Copyright ⓒ 2016–2020 Robert Alessi +Copyright ⓒ 2016--2020 Robert Alessi The documentation file `arabluatex.pdf` that is generated from the `arabluatex.dtx` source is licensed under the Creative Commons @@ -104,7 +104,7 @@ Installation 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. + This will enable the appropriate hooks for ArabLuaTeX in AUCTeX. Development, Git Repository =========================== diff --git a/about.html b/about.html index a846bab..8ef882e 100644 --- a/about.html +++ b/about.html @@ -1,21 +1,27 @@ - - + + - - + + 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

+

Robert Alessi

+ + +

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

ArabLuaTeX – Processing ArabTeX notation under LuaLaTeX

Copyright ⓒ 2016–2020 Robert Alessi

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

@@ -37,10 +43,10 @@
  • arabluatex_novoc.lua

  • arabluatex_trans.lua

  • -

    License applicable to the documentation

    +

    License applicable to the documentation

    Copyright ⓒ 2016–2020 Robert Alessi

    The documentation file arabluatex.pdf that is generated from the arabluatex.dtx source is licensed under the Creative Commons Attribution-ShareAlike 4.0 International License. To view a copy of this license, visit http://creativecommons.org/licenses/by-sa/4.0/ or send a letter to Creative Commons, PO Box 1866, Mountain View, CA 94042, USA.

    -

    Installation

    +

    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:

      @@ -53,20 +59,20 @@
    3. arabluatex_novoc.lua

    4. arabluatex_trans.lua

    5. -
    6. 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.

    7. +
    8. 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

    +

    Browse the code

    You can browse ArabLuaTeX repository on the web: http://git.robertalessi.net/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

    +

    Comments, Feature requests, Bug Reports

    https://gitlab.com/ralessi/arabluatex/issues

    -

    Download the repository

    +

    Download the repository

    ArabLuaTeX 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

    git clone http://git.robertalessi.net/arabluatex

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

    -

    Git hosting

    +

    Git hosting

    Make an account on https://gitlab.com and navigate (while logged in) to https://gitlab.com/ralessi/arabluatex. Click Fork and you will have in your account your own repository of arabluatex where you will be able to make whatever changes you like to.

    diff --git a/arabluatex.dtx b/arabluatex.dtx index 01ceabc..610181b 100644 --- a/arabluatex.dtx +++ b/arabluatex.dtx @@ -157,6 +157,7 @@ location = {London -- Edinburgh} } \end{filecontents} +\usepackage[letterpaper,margin=1.25in,left=50mm,nohead]{geometry} \usepackage{fontspec} \usepackage[english]{babel} \usepackage{dox} @@ -216,6 +217,13 @@ \usepackage{relsize} \usepackage{tikz} \usepackage[breakable, skins, xparse, minted]{tcolorbox} +\makeatletter +\patchcmd{\minted@checkstyle}{\minted@input{% + \minted@outputdir\minted@cachedir/\ifstrempty{#1}{default-pyg-prefix}{#1}.pygstyle}% + }{\minted@input{% + \minted@outputdir\minted@cachedir/\ifstrempty{#1}{default-pyg-prefix}{#1}.pygstyle}% + \def\PYGZhy{\mbox{\char`\-}}}{}{} +\makeatother \tcbset{colback=white, boxrule=.15mm, colframe=cinnamon, breakable} \newtcbox{\arabluabox}{boxrule=.3mm, left=0mm, right=0mm, top=0mm, diff --git a/makefile b/makefile index 4ceb067..d6a1e7d 100644 --- a/makefile +++ b/makefile @@ -3,6 +3,7 @@ ver := $(shell ltxfileinfo -v $(pkg).dtx|sed -e 's/^v//') TEXMFDIR := $(shell kpsewhich -expand-var='$$TEXMFHOME') HOMEDIR := $$HOME CMP = lualatex-dev +SHELL = bash sty: clean $(CMP) $(pkg).ins -- cgit v1.2.3