xepersian-hm (1may20)

git-svn-id: svn://tug.org/texlive/trunk@54962 c570f23f-e606-0410-a88d-b1316a301751

8 files changed, 316 insertions, 37 deletions

diff --git a/Master/texmf-dist/doc/xelatex/xepersian-hm/README.txt b/Master/texmf-dist/doc/xelatex/xepersian-hm/README.txt
index 9911cde2848..30f6d3240c7 100644
--- a/Master/texmf-dist/doc/xelatex/xepersian-hm/README.txt
+++ b/Master/texmf-dist/doc/xelatex/xepersian-hm/README.txt
@@ -1,35 +1,22 @@
-%%
-%% This is file `README.txt',
-%% generated with the docstrip utility.
-%%
-%% The original source files were:
-%%
-%% xepersian-hm.dtx  (with options: `README')
-%% 
-%% Copyright (C) 2020 Hossein Movahhedian
-%% 
-%% 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
-%% 
 The XEPERSIAN-HM package
 ------------------------
 
-Kashida feature in `xepersian' has problems with some fonts such as `HM Series'
-fonts available at `https://dma8hm1334.bitbucket.io' and `X Series 2' fonts
-available at `http://wiki.irmug.com/index.php/X_Series_2'. The `xepersian-hm'
-package fixes these problems.
+Kashida feature in 'xepersian' has problems with some fonts such as 'HM Series'
+available at 'https://dma8hm1334.bitbucket.io' and 'X Series 2' available at
+'http://wiki.irmug.com/index.php/X_Series_2'. The 'xepersian-hm' package fixes
+these problems.
 
-The file `texmf-dist/doc/xelatex/xepersian-hm/kashida-example.tex' can be used as
-a simple example of the usage of the package.
+The files 'kashida-glyph-example.tex' and 'kashida-hrule-example.tex' in
+the directory 'texmf-dist/doc/xelatex/xepersian-hm/' can be used as simple
+examples of the usage of the package.
 
 Please use the Bitbucket issue tracker:
-https://bitbucket.org/dma8hm1334/xepersian-hm/issues
-to report a bug, request a feature or if you have a comment.
+'https://bitbucket.org/dma8hm1334/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.
+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.
 %% 
 %%
 %% End of file `README.txt'.
diff --git a/Master/texmf-dist/doc/xelatex/xepersian-hm/kashida-glyph-example.pdf b/Master/texmf-dist/doc/xelatex/xepersian-hm/kashida-glyph-example.pdf
new file mode 100644
index 00000000000..91047f8cec4
--- /dev/null
+++ b/Master/texmf-dist/doc/xelatex/xepersian-hm/kashida-glyph-example.pdf
diff --git a/Master/texmf-dist/doc/xelatex/xepersian-hm/kashida-example.tex b/Master/texmf-dist/doc/xelatex/xepersian-hm/kashida-glyph-example.tex
index 6702fd36875..299b605aa71 100644
--- a/Master/texmf-dist/doc/xelatex/xepersian-hm/kashida-example.tex
+++ b/Master/texmf-dist/doc/xelatex/xepersian-hm/kashida-glyph-example.tex
@@ -31,56 +31,79 @@
 \defpersianfont\HMXKayhanSd[Scale=4.5]{HM XKayhan Shadow}
 
 % \def\SampleText{\discouragebadlinebreaks[8][0.14 em plus 5.5 em]{
-%  راهی جایی تابی چاپی چاههی تلاشهایی
-%  شتابهایی تابی چاپی راهی تلاشهــایی
-%  که کتابهایی که کلاههایی که کتابهایی }}
+%   راهی جایی تابی چاپی چاههی تلاشهایی
+%   شتابهایی تابی چاپی راهی تلاشهــایی
+%   که کتابهایی که کلاههایی که کتابهایی }}
 
 % \def\SampleText{\discouragebadlinebreaks[10][0.12 em plus 5.5 em]{
-%  راهی جایی تابی چاپی چاههی تلاشهایی
-%  شتابهایی تابی چاپی راهی تلاشهــایی
-%  که کتابهایی که کلاههایی که کتابهایی }}
+%   راهی جایی تابی چاپی چاههی تلاشهایی
+%   شتابهایی تابی چاپی راهی تلاشهــایی
+%   که کتابهایی که کلاههایی که کتابهایی }}
 
 \def\SampleText{\discouragebadlinebreaks{
   راهی جایی تابی چاپی چاههی تلاشهایی
   شتابهایی تابی چاپی راهی تلاشهــایی
   که کتابهایی که کلاههایی که کتابهایی }}
 
+% \def\SampleText{
+%   راهی جایی تابی چاپی چاههی تلاشهایی
+%   شتابهایی تابی چاپی راهی تلاشهــایی
+%   که کتابهایی که کلاههایی که کتابهایی }
+
 \setlength\parindent{0pt}
 \pagestyle{empty}
 
 \begin{document}
 
-\KashidaOff\lr{(Kashida Off, Regular)}
+\begin{latin}
+\begin{center}
+\Huge\textsf{xepersian-hm}\\ \vspace{20pt} Example of Use\vspace{20pt}\\ \texttt{Kashida=glyph} \vspace{40pt} 
+
+{\Large
+\begin{tabular}{ll}
+  \textsf{Font:} & \textsf{HM XKayhan} \\
+  \textsf{Font Scale:} & \texttt{4.5} \\
+  \textsf{linebreakpenalty:} & \texttt8 \\
+  \textsf{kashidastretch:} & \texttt{0.14em plus 5.5em}
+\end{tabular}
+}
+\end{center}
+
+\end{latin}
+
+\newpage
+
+\KashidaOff{\hfill\lr{(Kashida Off, Regular)}\hfill}
 
 \SampleText
 
 \newpage
 
-\KashidaOn\lr{(Kashida On, Regular)}
+\KashidaOn{\hfill\lr{(Kashida On, Regular)}\hfill}
 
 \SampleText
 
 \newpage
 
-\KashidaOn\lr{(Kashida On, Italic)}
+\KashidaOn{\hfill\lr{(Kashida On, Italic)}\hfill}
 
 {\HMXKayhanIt \SampleText}
 
 \newpage
 
-\KashidaOn\lr{(Kashida On, Oblique)}
+\KashidaOn{\hfill\lr{(Kashida On, Oblique)}\hfill}
 
 {\HMXKayhanOb \SampleText}
 
 \newpage
 
-\KashidaOn\lr{(Kashida On, Outline)}
+\KashidaOn{\hfill\lr{(Kashida On, Outline)}\hfill}
 
 {\HMXKayhanOl \SampleText}
 
 \newpage
 
-\KashidaOn\lr{(Kashida On, Shadow)}
+\KashidaOn{\hfill\lr{(Kashida On, Shadow)}\hfill}
 
 {\HMXKayhanSd \SampleText}
 
diff --git a/Master/texmf-dist/doc/xelatex/xepersian-hm/kashida-example.pdf b/Master/texmf-dist/doc/xelatex/xepersian-hm/kashida-hrule-example.pdf
index 2585a684267..865d7a3551c 100644
--- a/Master/texmf-dist/doc/xelatex/xepersian-hm/kashida-example.pdf
+++ b/Master/texmf-dist/doc/xelatex/xepersian-hm/kashida-hrule-example.pdf
diff --git a/Master/texmf-dist/doc/xelatex/xepersian-hm/kashida-hrule-example.tex b/Master/texmf-dist/doc/xelatex/xepersian-hm/kashida-hrule-example.tex
new file mode 100644
index 00000000000..64926c354a0
--- /dev/null
+++ b/Master/texmf-dist/doc/xelatex/xepersian-hm/kashida-hrule-example.tex
@@ -0,0 +1,109 @@
+% \PassOptionsToPackage{Kashida=off,RTLdocument=on}{xepersian}  % Load xepersian with a few options
+\documentclass{report}
+% \textwidth=345.0pt
+% \textheight=550.0pt
+% \textheight=620pt
+% \usepackage[Kashida]{xepersian}  % Fails
+% \usepackage{xepersian-hm}  % Succeeds
+\usepackage[Kashida=hrule,kashidastretch=0.14 em plus 0.5 em]{xepersian-hm}  % Succeeds
+% \usepackage[Kashida=hrule,kashidastretch=0.14 em plus 5.5 em]{xepersian-hm}  % Succeeds
+% \usepackage[Kashida=glyph,linebreakpenalty=8,kashidastretch=0.14 em plus 5.5 em]{xepersian-hm}  % Succeeds
+% \usepackage[Kashida=glyph,kashidastretch=kayhan]{xepersian-hm}  % Succeeds
+% \usepackage[Kashida,kashidastretch=0.14 em plus 0.5 em]{xepersian-hm}  % Succeeds
+% \usepackage[Kashida,kashidastretch=noskip]{xepersian-hm}  % Succeeds
+% \usepackage[Kashida,kashidastretch=default]{xepersian-hm}  % Succeeds
+% \usepackage[Kashida,kashidastretch=kayhan]{xepersian-hm}  % Succeeds
+% \usepackage[Kashida,kashidastretch=khorramshahr]{xepersian-hm}  % Succeeds
+
+% \settextfont[Scale=4.5,Colour=darkgray]{XB Kayhan}
+\settextfont[Scale=4.5]{HM XKayhan}
+% \settextfont[Scale=4.5,Colour=darkgray]{HM XNiloofar} 
+% \settextfont[Scale=4.5,Colour=darkgray]{HM XYas} 
+% \settextfont[Scale=4.5,Colour=darkgray]{HM XZar} 
+% \settextfont[Scale=1,Colour=darkgray]{HM XKayhan}
+
+% \setlatintextfont[Scale=2.5,Colour=0000FF]{XB Kayhan}
+\setlatintextfont[Scale=1.5,Colour=0000FF]{HM XKayhan}
+
+\defpersianfont\HMXKayhanIt[Scale=4.5]{HM XKayhan Italic}
+\defpersianfont\HMXKayhanOb[Scale=4.5]{HM XKayhanOb Oblique}
+\defpersianfont\HMXKayhanOl[Scale=4.5]{HM XKayhan Outline}
+\defpersianfont\HMXKayhanSd[Scale=4.5]{HM XKayhan Shadow}
+
+% \def\SampleText{\discouragebadlinebreaks[8][0.14 em plus 5.5 em]{
+%   راهی جایی تابی چاپی چاههی تلاشهایی
+%   شتابهایی تابی چاپی راهی تلاشهــایی
+%   که کتابهایی که کلاههایی که کتابهایی }}
+
+% \def\SampleText{\discouragebadlinebreaks[10][0.12 em plus 5.5 em]{
+%   راهی جایی تابی چاپی چاههی تلاشهایی
+%   شتابهایی تابی چاپی راهی تلاشهــایی
+%   که کتابهایی که کلاههایی که کتابهایی }}
+
+% \def\SampleText{\discouragebadlinebreaks{
+%   راهی جایی تابی چاپی چاههی تلاشهایی
+%   شتابهایی تابی چاپی راهی تلاشهــایی
+%   که کتابهایی که کلاههایی که کتابهایی }}
+
+\def\SampleText{
+  راهی جایی تابی چاپی چاههی تلاشهایی
+  شتابهایی تابی چاپی راهی تلاشهــایی
+  که کتابهایی که کلاههایی که کتابهایی }
+
+\setlength\parindent{0pt}
+\pagestyle{empty}
+
+\begin{document}
+
+\begin{latin}
+\begin{center}
+\Huge\textsf{xepersian-hm}\vspace{20pt}\\ Example of Use\vspace{20pt}\\  \texttt{Kashida=hrule} \vspace{40pt}
+
+{\Large
+\begin{tabular}{ll}
+  \textsf{Font:} & \textsf{HM XKayhan} \\
+  \textsf{Font Scale:} & \texttt{4.5} \\
+  \textsf{kashidastretch:} & \texttt{0.14em plus 0.5em}
+\end{tabular}
+}
+\end{center}
+
+\end{latin}
+
+\newpage
+
+\KashidaOff{\hfill\lr{(Kashida Off, Regular)}\hfill}
+
+\SampleText
+
+\newpage
+
+\KashidaOn{\hfill\lr{(Kashida On, Regular)}\hfill}
+
+\SampleText
+
+\newpage
+
+\KashidaOn{\hfill\lr{(Kashida On, Italic)}\hfill}
+
+{\HMXKayhanIt \SampleText}
+
+\newpage
+
+\KashidaOn{\hfill\lr{(Kashida On, Oblique)}\hfill}
+
+{\HMXKayhanOb \SampleText}
+
+\newpage
+
+\KashidaOn{\hfill\lr{(Kashida On, Outline)}\hfill}
+
+{\HMXKayhanOl \SampleText}
+
+\newpage
+
+\KashidaOn{\hfill\lr{(Kashida On, Shadow)}\hfill}
+
+{\HMXKayhanSd \SampleText}
+
+\end{document}
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
new file mode 100644
index 00000000000..1a2d88f8aa5
--- /dev/null
+++ b/Master/texmf-dist/doc/xelatex/xepersian-hm/xepersian-hm-doc.ltx
@@ -0,0 +1,160 @@
+%%
+%% 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{longtable}
+\usepackage{hypdoc}
+
+\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-01 \quad v0.5c}
+
+\begin{document}
+
+\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{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{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}: \\
+    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.
+
+      \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'}}
+\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}
+\end{document}
+%% 
+%%
+%% End of file `xepersian-hm-doc.ltx'.
diff --git a/Master/texmf-dist/doc/xelatex/xepersian-hm/xepersian-hm-doc.pdf b/Master/texmf-dist/doc/xelatex/xepersian-hm/xepersian-hm-doc.pdf
new file mode 100644
index 00000000000..cc80a884439
--- /dev/null
+++ b/Master/texmf-dist/doc/xelatex/xepersian-hm/xepersian-hm-doc.pdf
diff --git a/Master/texmf-dist/doc/xelatex/xepersian-hm/xepersian-hm.pdf b/Master/texmf-dist/doc/xelatex/xepersian-hm/xepersian-hm.pdf
index 43dd46a0a4d..b460f20455c 100644
--- a/Master/texmf-dist/doc/xelatex/xepersian-hm/xepersian-hm.pdf
+++ b/Master/texmf-dist/doc/xelatex/xepersian-hm/xepersian-hm.pdf