%% %% This is file `xepersian-hm-doc.tex' %% %% Copyright (c) Hossein Movahhedian 2020 %% %% It may be distributed and/or modified under the LaTeX Project Public License, %% version 1.3c or higher (your choice). The latest version of %% this license is at: http://www.latex-project.org/lppl.txt %% \documentclass{ltxdoc} \usepackage{graphicx} \usepackage{longtable} \usepackage{hypdoc} \usepackage{xepersian-hm} \settextfont[Scale=1]{HM XKayhan} \title{ The \textsf{xepersian-hm} package\\Fixing kashida in xepersian\\User Documentation } \author{ Hossein Movahhedian\thanks { E-mail: \href{mailto:dma8hm1334@gmail.com} {\textsf{dma8hm1334@gmail.com}} } } \date{Released \quad 2020-05-12 \quad v0.5e} \let\tmpthepage\thepage \renewcommand{\thepage}{\lr{\Large\textbf\tmpthepage}} \begin{document} \begin{latin} \maketitle Kashida feature in \textsf{xepersian} has problems with some fonts such as \mbox{\textsf{HM Series}} available at \href{https://dma8hm1334.bitbucket.io}{\texttt{https://dma8hm1334.bitbucket.io}} and \mbox{\textsf{X Series 2}} available at \href{http://wiki.irmug.com/index.php/X_Series_2}{\texttt{http://wiki.irmug.com/index.php/X\_Series\_2}}. The \textsf{xepersian-hm} package fixes these problems. The files \texttt{kashida-glyph-example.tex} and \texttt{kashida-hrule-example.tex} in the directory \texttt{texmf-dist/doc/xelatex/xepersian-hm/} can be used as simple examples of the usage of the package. Please use the Bitbucket issue tracker: \href{https://bitbucket.org/dma8hm1334/xepersian-hm/issues}{\textsf{https://bitbucket.org/dma8hm1334/\linebreak[4]xepersian-hm/issues}} to report a bug, request a feature or if you have a comment. I will do my best to fix all the bugs you report, but, unfortunately, time is a big hurdle to overcome; so, my apologies in advance for those which I cannot make time to fix. \section{Brief outline of the issues} Kashida is one of the most important features that must be included in any Persian typesetter. In xepersian this feature is implemented but with some problems. These problems along withe fixes in xepersian-hm are briefly: \newcounter{bean} \begin{list}{P-\Roman{bean}}{\usecounter{bean}\setlength{\rightmargin}{\leftmargin}} \item In \textsf{xepersian} overlapping of glyphs occurs in letter combinations such as "\rl{‏ب‍ + ‍ی‏}", "\rl{‏ت‍ + ‍ی‏}", and "\rl{‏پ‍ + ‍ی‏}" because the character \textsf{U+FEF0 (ARABIC LETTER FARSI YEH FINAL FORM)} is replaced with another character. This is fixed by modifying the fixed part of the glue inserted between the consecutive characters. Furthermore, both, the fixed and the stretchable parts of the glue can be changed by the user. \item In letter combinations such as "\rl{‏ه‍ + ‍ی‏}", in \textsf{xepersian}, the character \textsf{U+FEEB (ARABIC LETTER HEH INITIAL FORM)} is replaced with \textsf{U+06BE (ARABIC LETTER HEH DOACHASHEMEE)}. This is fixed by inserting the character \textsf{U+200E} before the combination "\textsf{U+200D + hrule + U+200D}" which is used as stretching item. \item In \textsf{xepersian} when outline or shadow fonts are used, the gaps 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. \end{list} For comparing the outputs of \textsf{xepersian} and \textsf{xepersian-hm} with a variety of options available to these packages, please see the \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{\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{\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{\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} \section{Package loading and options} Please note that \textsf{xepersian-hm} loads \textsf{xepersian} automatically, so you may only pass options to the package using the command \verb|\PassOptionsToPackage| before \verb|\documentclass|. For example: \begin{verbatim} \PassOptionsToPackage{debugfootnotedirection=off,localise=off}{xepersian} \documentclass{report} \usepackage{xcolor} \usepackage[Kashida,kashidastretch=0.14 em plus 0.5 em]{xepersian-hm} \end{verbatim} The options available in \textsf{xepersian-hm} are: \begin{itemize} \item \texttt{Kashida}: \\ which implements kashida feature with two possible values: \begin{itemize} \item \texttt{glyph}: \\ which uses the \texttt{Kashida} character to stretch the text. With this option you should run \texttt{xelatex} thrice. For example: \\ \texttt{rm -f kashida-example.aux \\ xelatex kashida-example.tex \\ xelatex kashida-example.tex \\ xelatex kashida-example.tex} Please note that this feature is still experimental and is not regarded as stable. If you are going to use this option be ready for unpredictable results. Note that the value of \texttt{Kashida} is mandatory. \item \texttt{hrule}: \\ which uses a horizontal rule (\verb|\hrule|) to stretch the text. \end{itemize} For example \texttt{Kashida=glyph} inserts a stretched \texttt{Kashida} glyph where ever it is needed. \item \texttt{linebreakpenalty}: \\ which specifies the amount of penalty for preventing bad line-breaking. You may strictly specify the value of this option. For example \texttt{'linebreakpenalty=8'} or you may use the default values. The available default values of penalties which are put into the horizontal list output are the negative of the followings: \begin{longtable}{ll} \texttt{min}: & \texttt{0} \\ \texttt{low}: & \texttt{8} \\ \texttt{medium}: & \texttt{15} \\ \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 this option. For example \texttt{'kashidastretch=0.14 em plus 0.5 em'} or you may use the default values. The available default values are: \begin{longtable}{lll} \texttt{kayhan} & \texttt{0.14 em plus 0.5 em} \\ \texttt{khorramshahr} & \texttt{0.131 em plus 0.5 em} \\ \texttt{kayhannavaar} & \texttt{0.129 em plus 0.5 em} \\ \texttt{kayhanpook} & \texttt{0.133 em plus 0.5 em} \\ \texttt{kayhansayeh} & \texttt{0.135 em plus 0.5 em} \\ \texttt{khoramshahr} & \texttt{0.128 em plus 0.5 em} \\ \texttt{khorramshahr} & \texttt{0.13 em plus 0.5 em} \\ \texttt{niloofar} & \texttt{0.132 em plus 0.5 em} \\ \texttt{paatch} & \texttt{0.127 em plus 0.5 em} \\ \texttt{riyaz} & \texttt{0.125 em plus 0.5 em} \\ \texttt{roya} & \texttt{0.142 em plus 0.5 em} \\ \texttt{shafigh} & \texttt{0.143 em plus 0.5 em} \\ \texttt{shafighKurd} & \texttt{0.126 em plus 0.5 em} \\ \texttt{shafighUzbek} & \texttt{0.123 em plus 0.5 em} \\ \texttt{shiraz} & \texttt{0.122 em plus 0.5 em} \\ \texttt{sols} & \texttt{0.124 em plus 0.5 em} \\ \texttt{tabriz} & \texttt{0.119 em plus 0.5 em} \\ \texttt{titr} & \texttt{0.12 em plus 0.5 em} \\ \texttt{titre} & \texttt{0.121 em plus 0.5 em} \\ \texttt{traffic} & \texttt{0.124 em plus 0.5 em} \\ \texttt{vahid} & \texttt{0.134 em plus 0.5 em} \\ \texttt{vosta} & \texttt{0.136 em plus 0.5 em} \\ \texttt{yaghut} & \texttt{0.138 em plus 0.5 em} \\ \texttt{yagut} & \texttt{0.137 em plus 0.5 em} \\ \texttt{yas} & \texttt{0.126 em plus 0.5 em} \\ \texttt{yekan} & \texttt{0.141 em plus 0.5 em} \\ \texttt{yermook} & \texttt{0.139 em plus 0.5 em} \\ \texttt{zar} & \texttt{0.116 em plus 0.5 em} \\ \texttt{ziba} & \texttt{0.119 em plus 0.5 em} \\ \texttt{default} & \texttt{0.14 em plus 0.5 em} \\ \texttt{noskip} & \texttt{0 em plus 0.5 em} \end{longtable} 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} \begin{description} \item \verb|\discouragebadlinebreaks[linebreakpenalty][kashidastretch]{|{\it text}\verb|}|: {\it text} may not contain paragraph breaks. This command puts a penalty after each Persian word. The optional arguments \texttt{linebreakpenalty} and \texttt{kashidastretch} locally specify the value of the penalty and the amount of extra stretching for some combinations of characters respectively as discussed previously. For example: \texttt{\bslash discouragebadlinebreaks[9][0.12 em plus 0.5 em]\{\dots\}} \end{description} \section{Important notes} \begin{description} \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. This is fixed in \textsf{xepersian-hm}, but it is still immature. \end{description} \end{latin} \end{document} %% %% %% End of file `xepersian-hm-doc.ltx'.