summaryrefslogtreecommitdiff
path: root/macros/xetex/latex/xepersian-hm/xepersian-hm-doc.ltx
diff options
context:
space:
mode:
Diffstat (limited to 'macros/xetex/latex/xepersian-hm/xepersian-hm-doc.ltx')
-rw-r--r--macros/xetex/latex/xepersian-hm/xepersian-hm-doc.ltx59
1 files changed, 51 insertions, 8 deletions
diff --git a/macros/xetex/latex/xepersian-hm/xepersian-hm-doc.ltx b/macros/xetex/latex/xepersian-hm/xepersian-hm-doc.ltx
index ba04fee903..42c5562caf 100644
--- a/macros/xetex/latex/xepersian-hm/xepersian-hm-doc.ltx
+++ b/macros/xetex/latex/xepersian-hm/xepersian-hm-doc.ltx
@@ -27,7 +27,7 @@
}
}
-\date{Released \quad 2020-05-07 \quad v0.5d}
+\date{Released \quad 2020-05-12 \quad v0.5e}
\let\tmpthepage\thepage
\renewcommand{\thepage}{\lr{\Large\textbf\tmpthepage}}
@@ -81,6 +81,19 @@ problems. These problems along withe fixes in xepersian-hm are briefly:
filled by horizontal rule appears as a solid box. This is fixed by
using the \textsf{kashida} glyph instead of the horizontal rule in
\textsf{xepersian-hm}.
+ \item Activating kashida in \textsf{xepersian} disturbs ligatures. This is
+ fixed in \textsf{xepersian-hm} by escaping the components of the
+ ligature which form the glyph, i.e. by inserting an escape character
+ before Persian letters joined to form the ligature without any empty
+ characters, blank characters, invisible characters and whitespace
+ characters which form the glyph. See
+ \mbox{Figures \ref{fig:ligatures-xep} and \ref{fig:ligatures-xephm}}.
+ Currently only 3 ligature glyphs are available in
+ \textsf{xepersian-hm}, but you can add as many as you want or let
+ me know the ligature glyphs that you need, so that I can add them in
+ the next release of the package. Of course, this is not the best
+ solution, but it works.
+
\item If italic or oblique style of some fonts such as \textsf{X Series 2}
is used in \textsf{xepersian}, an extra gap is left between the
stretched characters. This is fixed in \textsf{HM Series} fonts.
@@ -88,24 +101,34 @@ problems. These problems along withe fixes in xepersian-hm are briefly:
For comparing the outputs of \textsf{xepersian} and \textsf{xepersian-hm} with
a variety of options available to these packages, please see the
-\mbox{Figure \ref{fig:xepersian-XB}},
-\mbox{Figure \ref{fig:xepersian-hm-hrule}}, and
-\mbox{Figure \ref{fig:xepersian-hm-glyph}}.
+\mbox{Figures \ref{fig:xepersian-XB}, \ref{fig:xepersian-hm-hrule}}, and \ref{fig:xepersian-hm-glyph}.
+
+\begin{figure}
+ \centerline{\fbox{\includegraphics[scale=1]{doc-ligature-xep.pdf}}}
+ \caption{Package: \textsf{xeprsian}, Font: \textsf{Noto Sans Arabic}, \textsf{Scale=1.1}, \textsf{Kashida=On}}
+ \label{fig:ligatures-xep}
+\end{figure}
+
+\begin{figure}
+ \centerline{\fbox{\includegraphics[scale=1]{doc-ligature-xephm.pdf}}}
+ \caption{Package: \textsf{xeprsian-hm}, Font: \textsf{Noto Sans Arabic}, \textsf{Scale=1.1}, \textsf{Kashida=glyph}}
+ \label{fig:ligatures-xephm}
+\end{figure}
\begin{figure}
- \centerline{\includegraphics[scale=1]{doc-samples-xep.pdf}}
+ \centerline{\fbox{\includegraphics[scale=1]{doc-samples-xep.pdf}}}
\caption{Package: \textsf{xeprsian}, Font: \textsf{XB Kayhan}, \textsf{Scale=4.5}, \textsf{Kashida=0n}}
\label{fig:xepersian-XB}
\end{figure}
\begin{figure}
- \centerline{\includegraphics[scale=1]{doc-samples-hrule.pdf}}
+ \centerline{\fbox{\includegraphics[scale=1]{doc-samples-hrule.pdf}}}
\caption{Package: \textsf{xeprsian-hm}, Font: \textsf{HM XKayhan}, \textsf{Scale=4.5}, \textsf{Kashida=hrule}}
\label{fig:xepersian-hm-hrule}
\end{figure}
\begin{figure}
- \centerline{\includegraphics[scale=1]{doc-samples-glyph.pdf}}
+ \centerline{\fbox{\includegraphics[scale=1]{doc-samples-glyph.pdf}}}
\caption{Package: \textsf{xeprsian-hm}, Font: \textsf{HM XKayhan}, \textsf{Scale=4.5}, \textsf{Kashida=glyph}}
\label{fig:xepersian-hm-glyph}
\end{figure}
@@ -160,6 +183,7 @@ The options available in \textsf{xepersian-hm} are:
\texttt{high}: & \texttt{25} \\
\texttt{max}: & \texttt{10000}
\end{longtable}
+
\item \texttt{kashidastretch}: \\
which specifies the amount of extra stretching
for some combinations of characters. You may strictly specify the value of
@@ -202,6 +226,25 @@ The options available in \textsf{xepersian-hm} are:
For example: \mbox{\texttt{'kashidastretch=titr'}} is equivalent to\linebreak
\mbox{\texttt{'kashidastretch=0.12 em plus 0.5 em'}}
+
+ \item \texttt{ligature}: \\
+ which fixes the disturbance of ligatures caused by activation of kashida in
+ \textsf{xepersian}. You may strictly specify the value of this option.
+ For example \texttt{'ligature=dlig'} or you may use the default value.
+ The available values are:
+
+ \begin{longtable}{ll}
+ \texttt{aalt}: & Access All Alternatives \\
+ \texttt{ccmp}: & Glyph Composition/Decomposition \\
+ \texttt{dlig}: & Discretionary Ligatures \\
+ \texttt{fina}: & Final (Terminal) Forms \\
+ \texttt{init}: & Initial Forms \\
+ \texttt{locl}: & Localized Forms \\
+ \texttt{medi}: & Medial Forms \\
+ \texttt{rlig}: & Required Ligatures \\
+ \texttt{default}: & All the above features
+ \end{longtable}
+ Please note that this feature is still experimental and is not regarded as stable.
\end{itemize}
\section{Commands}
@@ -223,7 +266,7 @@ The options available in \textsf{xepersian-hm} are:
\item Kashida and ligatures:
The method used to implement kashida feature breaks a ligature if it is applied to the letters which are joined to form
- the ligature.
+ the ligature. This is fixed in \textsf{xepersian-hm}, but it is still immature.
\end{description}
\end{latin}