updated checksum and documentation

1 files changed, 15 insertions, 6 deletions

diff --git a/arabluatex.dtx b/arabluatex.dtx
index 83ce9f1..a2f56c4 100644
--- a/arabluatex.dtx
+++ b/arabluatex.dtx
@@ -217,7 +217,7 @@
 %</driver>
 % \fi
 %
-% \CheckSum{0}
+% \CheckSum{700}
 %
 % \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
@@ -311,6 +311,7 @@
 % \url{https://notabug.org/ralessi/arabluatex/issues}
 % \end{compactitem}
 %
+% \marginpar{\texttt{gpl3+}}
 % This program is free software: you can redistribute it and/or modify
 % it under the terms of the GNU General Public License as published by
 % the Free Software Foundation, either version 3 of the License, or
@@ -342,7 +343,7 @@
 % \label{sec:documentation-license}
 % Copyright \textcopyright\ 2016--2017  Robert Alessi
 %
-% \ccbysa\
+% \ccbysa\marginpar{\texttt{CC BY-SA 4.0}}
 % This document is licensed under the Creative Commons
 % Attribution-ShareAlike 4.0 International License. To view a copy of
 % this license, visit
@@ -3297,14 +3298,22 @@ wa-ya.sIru ta.hta 'l-jild-i
 \DeclareDocumentCommand{\cap}{m}%
   {\luadirect{tex.sprint(cap(\luastringN{#1}))}}
 %    \end{macrocode}
-% \begin{macro}{\Cap} \changes{v1.8.2}{2017/04/02}{New \cs{Cap} macro:
-% does the same as \cs{cap}, but not to be used outside \texttt{trans}
-% mode.}
+% \end{macro}
+% \begin{macro}{\Cap} \cs{cap} may be used safely in all of the modes
+%   that are provided by \package{arabluatex} as any of the |voc|,
+%   |fullvoc| and |novoc| modes discard it on top of any other
+%   functions to be run.  \cs{Cap} does the same as \cs{cap} except
+%   that \emph{it is never discarded}. For that reason, \cs{Cap}
+%   \emph{should never be used outside the} |trans|
+%   \emph{mode}. \package{arabluatex} uses \cs{Cap} internally so as
+%   to prevent \cs{cap} from being discarded in case words that are to
+%   be transliterated are inserted into Arabic commands or
+%   environments where transliteration is not required. Therefore, it
+%   is not documented.
 %    \begin{macrocode}
 \let\Cap\cap
 %    \end{macrocode}
 % \end{macro}
-% \end{macro}
 % \begin{macro}{\txarb} \cs{txarb} sets the direction to right-to-left
 %   and selects the Arabic font. It is used internally by several Lua
 %   functions, but available to the user should he wish to insert