added a paragraph about hyphenation in the documentation

1 files changed, 15 insertions, 0 deletions

diff --git a/arabluatex.dtx b/arabluatex.dtx
index f72d1d9..a8504a6 100644
--- a/arabluatex.dtx
+++ b/arabluatex.dtx
@@ -1805,6 +1805,21 @@ vowels (see §~3).
 % argument of \cs{cap} vz. up to the first letter that is to be
 % uppercased, like so: |\cap{m}u.hammaduN|.
 %
+% \paragraph{Hyphenation}
+% In case transliterated Arabic words break the \TeX\ hyphenation
+% algorithm, one may use the command |\-| to insert discretionary
+% hyphens. This command will be discarded in all of the Arabic modes
+% of \package{arabluatex}, but will be processed by any of the
+% transliteration modes:---
+% \begin{quote}
+%   |\cap{'abU}| |\cap{bakriN}| |\cap{mu\-.ham\-maduN}| |bnu|
+%   |\cap{za\-ka| |\-riy\-yA'a}| |\cap{'l-rAzI}| \arb{\cap{'abU}
+%   \cap{bakriN} \cap{mu\-.ham\-maduN} bnu \cap{za\-ka\-riy\-yA'a}
+%   \cap{'l-rAzI}} \arb[trans]{\cap{'abU} \cap{bakriN}
+%   \cap{mu\-.ham\-maduN} bn-u \cap{za\-ka\-riy\-yA'-a}
+%   \cap{'l-rAzI}}.
+% \end{quote}
+%
 % \subsection{Additional note on \texttt{dmg} convention}
 % \label{sec:additional-note-dmg}
 % \NEWfeature{v1.3} According to \textcite[6]{dmg}, Arabic