added \MkArbBreak* in a macro environment

1 files changed, 14 insertions, 7 deletions

diff --git a/arabluatex.dtx b/arabluatex.dtx
index 89d0e51..879a132 100644
--- a/arabluatex.dtx
+++ b/arabluatex.dtx
@@ -4063,13 +4063,19 @@ wa-ya.sIru ta.hta 'l-jild-i
 %    \end{macrocode}
 % \end{macro}
 % \begin{macro}{\MkArbBreak}
-% \changes{v1.9}{2017/07/05}{New \cs{MkArbBreak} command for inserting
-% user-defined macros in Arabic environments}
-% The \cs{MkArbBreak}\marg{csv list of commands} command can be used
-% to give any command---either new or already existing---the
-% precedence over \package{arabluatex} inside Arabic environments. It
-% is actually coded in Lua.
-% \changes{v1.12}{2018/06/11}{TODO}
+% \changes{v1.9}{2017/07/05}{New \cs{MkArbBreak} command for
+% inserting user-defined macros in Arabic environments} The
+% \cs{MkArbBreak}\marg{csv list of commands} command can be used to
+% give any command---either new or already existing---the precedence
+% over \package{arabluatex} inside Arabic environments. It is
+% actually coded in Lua.
+% \begin{macro}{\MkArbBreak*}
+% \changes{v1.12}{2018/06/11}{\enquote*{starred} version which
+% closes Arabic environments before processing declared commands.}
+% \cs{MkArbBreak*} goes a step further as it directs
+% \package{arabluatex} to close the current Arabic environment before
+% processing any \enquote*{declared} command then resume it just
+% after.
 %    \begin{macrocode}
 \NewDocumentCommand{\MkArbBreak}{s m}{%
   \IfBooleanTF{#1}
@@ -4078,6 +4084,7 @@ wa-ya.sIru ta.hta 'l-jild-i
 }
 %    \end{macrocode}
 % \end{macro}
+% \end{macro}
 % \begin{macro}{\aemph} Arabic emphasis. Needs to be redefined as
 %   well. The function is actually coded in Lua.
 % \begin{macro}{\aemph*} The \enquote*{starred} version of this