diff options
Diffstat (limited to 'macros/xetex/latex/xepersian-hm/xepersian-hm-doc.tex')
-rw-r--r-- | macros/xetex/latex/xepersian-hm/xepersian-hm-doc.tex | 113 |
1 files changed, 113 insertions, 0 deletions
diff --git a/macros/xetex/latex/xepersian-hm/xepersian-hm-doc.tex b/macros/xetex/latex/xepersian-hm/xepersian-hm-doc.tex new file mode 100644 index 0000000000..9320152898 --- /dev/null +++ b/macros/xetex/latex/xepersian-hm/xepersian-hm-doc.tex @@ -0,0 +1,113 @@ +%% +%% 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{hypdoc} + +\title{ + The \textsf{xepersian-hm} package\\Fixing kashida in xepersian +} + +\author{ + Hossein Movahhedian\thanks + { + E-mail: + \href{mailto:dma8hm1334@gmail.com} + {\textsf{dma8hm1334@gmail.com}} + } +} + +\date{Released 2020-03-23} + +\begin{document} + +\maketitle + +Kashida feature in \textsf{xepersian} has problem with some fonts such as \texttt{HM Series} +fonts available at +\href{https://dma8hm1334.bitbucket.io}{\texttt{https://dma8hm1334.bitbucket.io}} +and \texttt{X Series 2} fonts 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 this problem. + +The file \texttt{texmf-dist/doc/xelatex/xepersian-hm/test-kashida.tex} can be +used as a simple example of the usage of the package. + +Any comments or suggestions would be gratefully appreciated. +Please report any bug or issue to \href{mailto:dma8hm1334@gmail.com}{\textsf{dma8hm1334@gmail.com}}. + +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. + +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{Kashida=off,RTLdocument=on}{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}: with two possible values, \texttt{on} which enables + \texttt{Kashida} feature and \texttt{off} which disables that feature. For + example \texttt{Kashida=on} enables \texttt{Kashida} feature. + \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{tabular}{ll} + \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{tabular} + + For example: \mbox{\texttt{'kashidastretch=titr'}} is equivalent to\linebreak + \mbox{\texttt{'kashidastretch=0.12 em plus 0.5 em'}} +\end{itemize} + +\end{document} + +%%% Local Variables: +%%% mode: latex +%%% TeX-master: t +%%% End: |