summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/doc')
-rw-r--r--Master/texmf-dist/doc/xelatex/xepersian-hm/README.txt24
-rw-r--r--Master/texmf-dist/doc/xelatex/xepersian-hm/test-kashida.pdf (renamed from Master/texmf-dist/doc/xelatex/xepersian-hm/test-kasida.pdf)bin17987 -> 17989 bytes
-rw-r--r--Master/texmf-dist/doc/xelatex/xepersian-hm/test-kashida.tex (renamed from Master/texmf-dist/doc/xelatex/xepersian-hm/test-kasida.tex)25
-rw-r--r--Master/texmf-dist/doc/xelatex/xepersian-hm/xepersian-hm-doc.pdfbin0 -> 36112 bytes
-rw-r--r--Master/texmf-dist/doc/xelatex/xepersian-hm/xepersian-hm-doc.tex113
5 files changed, 143 insertions, 19 deletions
diff --git a/Master/texmf-dist/doc/xelatex/xepersian-hm/README.txt b/Master/texmf-dist/doc/xelatex/xepersian-hm/README.txt
index 5bd2194c2e7..f271209861a 100644
--- a/Master/texmf-dist/doc/xelatex/xepersian-hm/README.txt
+++ b/Master/texmf-dist/doc/xelatex/xepersian-hm/README.txt
@@ -1,10 +1,26 @@
+%%
+%% This is file `README.txt'
+%%
+%% 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
+%%
The XEPERSIAN-HM package
------------------------
-Kashida feature in xepersian has problem with some fonts such as HM Series
-fonts available at 'https://dma8hm1334.bitbucket.io' and XB Series fonts
-available at 'http://wiki.irmug.com/index.php/X_Series_2'. The `xepersian-hm'
+Kashida feature in `xepersian' has problem 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 this problem.
-The file texmf-dist/doc/xelatex/xepersian-hm/test-kashida.tex can be used as
+The file `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 bugs or issues to `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.
diff --git a/Master/texmf-dist/doc/xelatex/xepersian-hm/test-kasida.pdf b/Master/texmf-dist/doc/xelatex/xepersian-hm/test-kashida.pdf
index e2c92cbc994..ec20b35a83b 100644
--- a/Master/texmf-dist/doc/xelatex/xepersian-hm/test-kasida.pdf
+++ b/Master/texmf-dist/doc/xelatex/xepersian-hm/test-kashida.pdf
Binary files differ
diff --git a/Master/texmf-dist/doc/xelatex/xepersian-hm/test-kasida.tex b/Master/texmf-dist/doc/xelatex/xepersian-hm/test-kashida.tex
index 1c599c1cc04..d3492c93ef6 100644
--- a/Master/texmf-dist/doc/xelatex/xepersian-hm/test-kasida.tex
+++ b/Master/texmf-dist/doc/xelatex/xepersian-hm/test-kashida.tex
@@ -1,25 +1,20 @@
+% \PassOptionsToPackage{Kashida=off,RTLdocument=on}{xepersian} % Load xepersian with a few options
\documentclass{report}
-\usepackage{graphicx}
\usepackage{xcolor}
-% \usepackage[Kashida=off,fontsloadable=true,RTLdocument=on]{xepersian} % Load xepersian with a few options
-\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]{IRXLotus}
-
-% \settextfont[Scale=4.5,Colour=darkgray]{IRLotus}
-
+% \usepackage[Kashida]{xepersian} % Fails
+\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,Colour=darkgray]{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}
+% \setlatintextfont[Scale=2.5,Colour=teal]{XB Kayhan}
\setlatintextfont[Scale=2.5,Colour=teal]{HM XKayhan}
\def\SampleText{راهی جایی تابی چاپی چاههی تلاشهایی شتابهایی تابی چاپی راهی تلاشهــایی که کتابهایی که کلاههایی که}
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..a4bf9aa17d5
--- /dev/null
+++ b/Master/texmf-dist/doc/xelatex/xepersian-hm/xepersian-hm-doc.pdf
Binary files differ
diff --git a/Master/texmf-dist/doc/xelatex/xepersian-hm/xepersian-hm-doc.tex b/Master/texmf-dist/doc/xelatex/xepersian-hm/xepersian-hm-doc.tex
new file mode 100644
index 00000000000..93201528988
--- /dev/null
+++ b/Master/texmf-dist/doc/xelatex/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: