diff options
Diffstat (limited to 'Master/texmf-dist/doc/xelatex/xepersian-hm/xepersian-hm-doc.ltx')
-rw-r--r-- | Master/texmf-dist/doc/xelatex/xepersian-hm/xepersian-hm-doc.ltx | 66 |
1 files changed, 46 insertions, 20 deletions
diff --git a/Master/texmf-dist/doc/xelatex/xepersian-hm/xepersian-hm-doc.ltx b/Master/texmf-dist/doc/xelatex/xepersian-hm/xepersian-hm-doc.ltx index e1145052290..535b6dedd41 100644 --- a/Master/texmf-dist/doc/xelatex/xepersian-hm/xepersian-hm-doc.ltx +++ b/Master/texmf-dist/doc/xelatex/xepersian-hm/xepersian-hm-doc.ltx @@ -27,7 +27,7 @@ } } -\date{Released \quad 2020-05-20 \quad v0.5f} +\date{Released \quad 2020-05-31 \quad v1.0a} \let\tmpthepage\thepage \renewcommand{\thepage}{\lr{\Large\textbf\tmpthepage}} @@ -43,9 +43,14 @@ 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. +The following files in the directory \texttt{texmf-dist/doc/xelatex/xepersian-hm/} can be used as simple +examples of the usage of the package: +\newcounter{beanx} + \begin{list}{\arabic{beanx}.}{\usecounter{beanx}\setlength{\rightmargin}{\leftmargin}} + \item \texttt{kashida-glyph-example.tex} + \item \texttt{kashida-leaders-glyph-example.tex} + \item \texttt{kashida-leaders-hrule-example.tex} +\end{list} Please use the Bitbucket issue tracker: \href{https://bitbucket.org/dma8hm1334/xepersian-hm/issues}{\textsf{https://bitbucket.org/dma8hm1334/\linebreak[4]xepersian-hm/issues}} @@ -59,7 +64,7 @@ which I cannot make time to fix. 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: +problems. These problems along with the fixes in \textsf{xepersian-hm} are briefly: \newcounter{bean} \begin{list}{P-\Roman{bean}}{\usecounter{bean}\setlength{\rightmargin}{\leftmargin}} @@ -117,7 +122,7 @@ a variety of options available to these packages, please see the \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}} + \caption{Package: \textsf{xeprsian}, Font: \textsf{XB Kayhan}, \textsf{Scale=4.5}, \textsf{Kashida=On}} \label{fig:xepersian-XB} \end{figure} @@ -143,16 +148,16 @@ so you may only pass options to the package using the command \PassOptionsToPackage{debugfootnotedirection=off,localise=off}{xepersian} \documentclass{report} \usepackage{xcolor} -\usepackage[Kashida,kashidastretch=0.14 em plus 0.5 em]{xepersian-hm} +\usepackage[Kashida=leaders+glyph,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: + which implements kashida feature with three possible values: \begin{itemize} \item \texttt{glyph}: \\ - which uses the \texttt{Kashida} character to stretch the text. + 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 \\ @@ -161,19 +166,38 @@ 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. Also, note - that the value of \texttt{Kashida} is mandatory. + If you are going to use this option be ready for unpredictable results. + + Also note that with this option, for each gap which is to be filled with kashida, + some commands, current position on the page, and references are saved in the + \texttt{\bslash jobname.aux} file and if the text is long, the file size may get + too large. + + \item \texttt{leaders+glyph}: \\ + which uses kashida glyph leaders to stretch the text. + Please note that the option `Kashida=leaders+glyph' is currently only + supported by \mbox{\textsf{HM Series}} fonts available at + \href{https://dma8hm1334.bitbucket.io}{\texttt{https://dma8hm1334.bitbucket.io}}. + If you know of any other font that supports this option, please + let me know to add it to the list of corresponding fonts. + + Contrary to the option \texttt{Kashida=glyph}, in this case nothing is saved + in \texttt{.aux} files. - \item \texttt{hrule}: \\ - which uses a horizontal rule (\verb|\hrule|) to stretch the text. + \item \texttt{leaders+hrule}: \\ + which uses horizontal rule (\verb|\hrule|) leaders to stretch the text. \end{itemize} - For example \texttt{Kashida=glyph} inserts a stretched \texttt{Kashida} glyph where ever it is needed. + Also, please note that the value of \texttt{Kashida} is mandatory. + For example \texttt{Kashida=glyph} inserts a stretched \texttt{kashida} glyph + and \linebreak[4] \texttt{Kashida=leaders+glyph} inserts \texttt{kashida} leaders wherever + 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 + You may strictly specify the value of this option. For example you may either set % \linebreak[4] + \texttt{'linebreakpenalty=8'} or + 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} @@ -254,10 +278,12 @@ The options available in \textsf{xepersian-hm} are: {\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: + 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 + you may set this option as follows: - \texttt{\bslash discouragebadlinebreaks[9][0.12 em plus 0.5 em]\{\dots\}} + \texttt{\bslash discouragebadlinebreaks[9][0.12 em plus 0.5 em]\{$\dots\,$\}} \end{description} \section{Important notes} @@ -266,7 +292,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. This is fixed in \textsf{xepersian-hm}, but it is still immature. + the ligature. This is fixed in \textsf{xepersian-hm}, but it is not well developed yet. \end{description} \end{latin} |