diff options
author | Norbert Preining <norbert@preining.info> | 2020-05-08 03:02:15 +0000 |
---|---|---|
committer | Norbert Preining <norbert@preining.info> | 2020-05-08 03:02:15 +0000 |
commit | 8b5866024fec68c13a91973cc6cfc2cb5697baba (patch) | |
tree | 6abad841dced763b6ee50ae5bb83fc50d8816ca1 /macros/xetex/latex/xepersian-hm/xepersian-hm-doc.ltx | |
parent | 56bd1f5b8377f54b4af39a114362a7762d27f13c (diff) |
CTAN sync 202005080302
Diffstat (limited to 'macros/xetex/latex/xepersian-hm/xepersian-hm-doc.ltx')
-rw-r--r-- | macros/xetex/latex/xepersian-hm/xepersian-hm-doc.ltx | 79 |
1 files changed, 76 insertions, 3 deletions
diff --git a/macros/xetex/latex/xepersian-hm/xepersian-hm-doc.ltx b/macros/xetex/latex/xepersian-hm/xepersian-hm-doc.ltx index 1a2d88f8aa..ba04fee903 100644 --- a/macros/xetex/latex/xepersian-hm/xepersian-hm-doc.ltx +++ b/macros/xetex/latex/xepersian-hm/xepersian-hm-doc.ltx @@ -8,8 +8,11 @@ %% 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 @@ -24,9 +27,12 @@ } } -\date{Released \quad 2020-05-01 \quad v0.5c} +\date{Released \quad 2020-05-07 \quad v0.5d} +\let\tmpthepage\thepage +\renewcommand{\thepage}{\lr{\Large\textbf\tmpthepage}} \begin{document} +\begin{latin} \maketitle @@ -49,6 +55,61 @@ 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 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{Figure \ref{fig:xepersian-XB}}, +\mbox{Figure \ref{fig:xepersian-hm-hrule}}, and +\mbox{Figure \ref{fig:xepersian-hm-glyph}}. + +\begin{figure} + \centerline{\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}} + \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}} + \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, @@ -56,7 +117,7 @@ so you may only pass options to the package using the command \verb|\PassOptionsToPackage| before \verb|\documentclass|. For example: \begin{verbatim} -\PassOptionsToPackage{Kashida=off,RTLdocument=on}{xepersian} +\PassOptionsToPackage{debugfootnotedirection=off,localise=off}{xepersian} \documentclass{report} \usepackage{xcolor} \usepackage[Kashida,kashidastretch=0.14 em plus 0.5 em]{xepersian-hm} @@ -77,7 +138,8 @@ The options available in \textsf{xepersian-hm} are: 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. + 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. @@ -154,6 +216,17 @@ The options available in \textsf{xepersian-hm} are: \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. +\end{description} + +\end{latin} \end{document} %% %% |