done documenting brackets implementation; this will be v1.4.3v1.4.3

1 files changed, 42 insertions, 10 deletions

diff --git a/arabluatex.dtx b/arabluatex.dtx
index fccee3c..ff52e80 100644
--- a/arabluatex.dtx
+++ b/arabluatex.dtx
@@ -27,7 +27,7 @@
 %<package-info>\NeedsTeXFormat{LaTeX2e}[1999/12/01]
 %<package-info>\ProvidesPackage{arabluatex}
 %<*package-info>
-    [2016/09/09 v1.4.2 This is ArabTeX for LuaLaTeX]
+    [2016/09/14 v1.4.3 This is ArabTeX for LuaLaTeX]
 %</package-info>
 %
 %<*driver>
@@ -145,7 +145,7 @@
 \defaultfontfeatures{RawFeature={+liga}}
 \setmainfont{Old Standard}[SmallCapsFont={Latin Modern Roman Caps},
   RawFeature={+mark;+ccmp;+ss05;+ss06}]
-\usepackage{arabluatex}[2016/09/09]
+\usepackage{arabluatex}[2016/09/14]
 \usepackage{varioref}
 \usepackage{hypdoc}
 \hypersetup{unicode=true, colorlinks, allcolors=blue,
@@ -161,7 +161,7 @@
 \usepackage[position=below]{caption}
 \usepackage{longtable}
 \usepackage{booktabs}
-\usepackage[defaultlines=2,all]{nowidow}
+\usepackage[defaultlines=3,all]{nowidow}
 \usepackage{tikz}
 \usepackage[breakable, skins, listings, xparse]{tcolorbox}
 \DeclareTCBListing{arabluacode}{s O{}}{colback=white, boxrule=.15mm,
@@ -198,7 +198,7 @@
 %</driver>
 % \fi
 %
-% \CheckSum{0}
+% \CheckSum{376}
 %
 % \CharacterTable
 %  {Upper-case    \A\B\C\D\E\F\G\H\I\J\K\L\M\N\O\P\Q\R\S\T\U\V\W\X\Y\Z
@@ -1524,7 +1524,7 @@ vowels (see §~3).
 % \arb[novoc]{a"'} & \dmg{a"'} & \loc{a"'} & \verb|a"'| \\
 % \arb[novoc]{u"'} & \dmg{u"'} & \loc{u"'} & \verb|u"'| \\
 % \arb[novoc]{w"'} & \dmg{w"'} & \loc{w"'} & \verb|w"'| \\
-% \arb[novoc]{i"'} & \dmg{i"'} & \loc{i"'} & \verb|i"'| \\ \pagebreak
+% \arb[novoc]{i"'} & \dmg{i"'} & \loc{i"'} & \verb|i"'| \\
 % \arb[novoc]{y"'} & \dmg{y"'} & \loc{y"'} & \verb|y"'| \\
 % \bottomrule
 % \caption*{\Cref*{tab:quoted-hamza}: \enquote{Quoted} \arb[trans]{hamzaT}}
@@ -1712,6 +1712,37 @@ vowels (see §~3).
 %   \arb[trans]{B--aN}, |B"| \arb[voc]{B"}\,.
 % \end{quote}
 %
+% \paragraph{Brackets}
+% \NEWfeature{v1.4.3} The various bracket symbols are useful in
+% technical documents such as critical editions for indicating that
+% some words or some letters must be added or
+% removed. \package{arabluatex} will automatically fit those symbols
+% to the direction of the text. For the time being, the following
+% symbols are supported:
+% \begin{compactitem}
+% \item parentheses: |()|
+% \item square brackets: |[]|
+% \item angle brackets: |<>|
+% \item braces: |{}|
+% \end{compactitem}
+%
+% \DescribeMacro{\abraces} Parentheses, square and angle brackets may
+% be input directly at the keyboard; however, words or letters that
+% are to be read between braces must be passed as arguments to the
+% command \cs{abraces}:---
+% \iffalse
+%<*example>
+% \fi
+\begin{arabluacode}
+  \begin{arab}
+    \abraces{wa-qAla} 'inna 'abI kAna mina 'l-muqAtilaTi
+    wa-kAna--<--t> 'ummI min `u.zamA'i buyUti 'l-zamAzimaTi.
+  \end{arab}
+\end{arabluacode}
+% \iffalse
+%</example>
+% \fi
+%
 % \section{Transliteration}
 % \label{sec:transliteration}
 % It may be more appropriate to speak of \enquote{romanization} than
@@ -2352,7 +2383,7 @@ wa-ya.sIru ta.hta 'l-jild-i
 %    \begin{macrocode}
 \NeedsTeXFormat{LaTeX2e}
 \ProvidesPackage{arabluatex}%
-[2016/09/09 v1.4.2 ArabTeX-like interface for LuaLaTeX]
+[2016/09/14 v1.4.3 ArabTeX-like interface for LuaLaTeX]
 \RequirePackage{ifluatex}
 %    \end{macrocode}
 % \package{arabluatex} requires \LuaLaTeX\ of course. Issue a warning
@@ -2636,10 +2667,11 @@ wa-ya.sIru ta.hta 'l-jild-i
 %    \end{macrocode}
 % \end{macro}
 % \begin{macro}{\abraces}
-%   \cs{abraces}\marg{Arabic text} puts its argument between curly
-%   braces.
-%   \changes{v1.4.3}{2016/09/13}{New command \cs{abraces} expresses
-%   its argument between curly braces.}
+%   \cs{abraces}\marg{Arabic text} puts its argument between
+%   braces. This macro is written in Lua and is dependent on the
+%   current value of |tex.textdir|.
+%   \changes{v1.4.3}{2016/09/14}{New command \cs{abraces} which
+%   expresses its argument between braces.}
 %    \begin{macrocode}
 \NewDocumentCommand{\abraces}{+m}{%
   \luadirect{tex.sprint(abraces(\luastringN{#1}))}}