summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/xelatex/xepersian/xepersian-esse.tex
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/doc/xelatex/xepersian/xepersian-esse.tex')
-rw-r--r--Master/texmf-dist/doc/xelatex/xepersian/xepersian-esse.tex54
1 files changed, 25 insertions, 29 deletions
diff --git a/Master/texmf-dist/doc/xelatex/xepersian/xepersian-esse.tex b/Master/texmf-dist/doc/xelatex/xepersian/xepersian-esse.tex
index 26691aadd10..b7bda8b57b7 100644
--- a/Master/texmf-dist/doc/xelatex/xepersian/xepersian-esse.tex
+++ b/Master/texmf-dist/doc/xelatex/xepersian/xepersian-esse.tex
@@ -7,7 +7,7 @@ There is a change in the manual. I wrote a new \LaTeX\ class\footnote{The name o
I have rewritten almost all the macros, new functionalities have been added and lots of changes have been done, therefore, I would like to encourage all the users to read this manual very carefully before trying to use the package. \XePersian\ now works with \textsf{article}, \textsf{report}, \textsf{book}, \textsf{amsart}, \textsf{amsbook}, \textsf{refrep}, \textsf{bookest} and \textsf{beamer} classes. Also I have written some new classes: \textsf{xepersian-thesis} (for typesetting Persian thesis), \textsf{xepersian-presentation} (for typesetting plain electronic Persian presentations) and \textsf{xepersian-magazine} (for typesetting Persian magazines, newspapers and other papers).
\File{\textsf{Thanks}}
-Please note that \XePersian\ is not just mine, it belongs to all and it is the result of the hard work of several other people. I would like to thanks \textsf{Jonathan Kew} (the author of \XeTeX) for making such a wonderful \TeX\ system and answering my questions, \textsf{Karl Berry} and \textsf{Jim Hefferon} for all their wonderful encouragements, \textsf{Ross Moore} (my teacher and an abosolute \TeX acker) for helping and guiding me patiently and kindly, \textsf{Will Robertson} (the author of \textsf{fontspec} package) for his excellent \textsf{fontspec} package and also answering my question, \textsf{François Charette} (the author of several \XeLaTeX\ packages, more importantly the \textsf{bidi} package) for his wonderful \textsf{bidi} package which is currently the basis of \XePersian , \textsf{Mostafa Vahedi} for writing the preliminary version of the package and also motivating me to develop the package, \textsf{Mehdi Omidali} for participating in the development of \XePersian , contributiong mapping files, testing the development version of the package, his bug reports, bug fixes and writing the manual in Persian, and eventually I would like to thanks to all the users of \XePersian, firstly for using the package and secondly for their bug reports.
+Please note that \XePersian\ is not just mine, it belongs to all and it is the result of the hard work of several other people. I would like to thanks \textsf{Jonathan Kew} (the author of \XeTeX) for making such a wonderful \TeX\ system and answering my questions, \textsf{Karl Berry} and \textsf{Jim Hefferon} for all their wonderful encouragements, \textsf{Ross Moore} (my teacher and an abosolute \TeX acker) for helping and guiding me patiently and kindly, \textsf{Will Robertson} (the author of \textsf{fontspec} package) for his excellent \textsf{fontspec} package and also answering my question, \textsf{Mostafa Vahedi} for writing the preliminary version of the package and also motivating me to develop the package, \textsf{Mehdi Omidali} for participating in the development of \XePersian , contributiong mapping files, testing the development version of the package, his bug reports, bug fixes and writing the manual in Persian, and eventually I would like to thanks to all the users of \XePersian, firstly for using the package and secondly for their bug reports.
@@ -93,11 +93,19 @@ Inserts Iranian date of today.
Inserts Roman date of today.
-\mitem \rldblcolumn
+\mitem \@RTLtrue
+
+Typesets the main text of the document from right to left (default).
+
+\mitem \@RTLfalse
+
+Typesets the main text of the document from left to right.
+
+\mitem \RTLdblcol
Places columns from right to left in the \emph{twocolumns} documents (default).
-\mitem \lrdblcolumn
+\mitem \LTRdblcol
Places columns from left to right in the \emph{twocolumns} documents.
@@ -105,6 +113,14 @@ Places columns from left to right in the \emph{twocolumns} documents.
Typesets \emph{table of contents} in two columns (needs to load \textsf{fmultico} package at the permeable of the document).
+\mitem \LRE{...}
+
+Places a short text from left to right without affecting the font.
+
+\mitem \RLE{...}
+
+Places a short text from right to left without affecting the font.
+
\mitem \lr{...}
Typesets a short Roman text in a Persian paragraph.
@@ -157,19 +173,13 @@ Typesets the the Roman footnote numbers in Persian (default).
Typesets the Roman footnote numbers in Roman.
-\mitem \RomanBibNum
-
-Typesets the numbers of \n\bibitem\ in Roman (default).
-\mitem \PersianBibNum
-
-Typesets the numbers of \n\bibitem\ in Persian.
\end{description}
\subsection{Using Different Fonts}
To write a minimal document with \XePersian\, you will need to select a font for typesetting the main text. We achieve this by the following command:
\begingroup
\catcode`\<=12
- \Mac \settextfont`[Scale=<integer>]'{<fontname>}
+ \Mac \settextfont`[Scale=<number>]'{<fontname>}
\endgroup
For example with the command:
\begin{LVerb}
@@ -182,18 +192,18 @@ We choose {\UsageFont XB Zar} as the main text font with the Scale of 1.
In addition to selecting the main text font, we also need to choose the fonts for Roman texts and digits in maths formuals. We select the font for Roman texts by the following command:
\begingroup
\catcode`\<=12
- \Mac \setromantextfont`[Scale=<integer>]'{<fontname>}
+ \Mac \setromantextfont`[Scale=<number>]'{<fontname>}
\endgroup
And we select the font for digits in maths formuals by the command:
\begingroup
\catcode`\<=12
- \Mac \setdigitfont`[Scale=<integer>]'{<fontname>}
+ \Mac \setdigitfont`[Scale=<number>]'{<fontname>}
\endgroup
You also can define as many extra Persian and Roman fonts as you wish and use them in your document. This is done in the following syntax:
\begingroup
\catcode`\<=12
- \Mac \defpersianfont\n\fontname`[Scale=<integer>]'{<fontname>}
- \Mac \defromanfont\n\fontname`[Scale=<integer>]'{<fontname>}
+ \Mac \defpersianfont\n\fontname`[Scale=<number>]'{<fontname>}
+ \Mac \defromanfont\n\fontname`[Scale=<number>]'{<fontname>}
\endgroup
For example, the command:
\begin{LVerb}
@@ -235,27 +245,16 @@ If you wish all Roman footnote numbers appear in Roman instead Persian, then you
\Mac \usepackage[RomanFootNum]{xepersian}
In addition to this, two commands: \n\PersianFootNum\ and \n\RomanFootNum\ are provided, as you might have guessed from the name of the commands \n\PersianFootNum\ puts the number of all Roman footnote in Persian and \n\RomanFootNum\ puts the number of all Roman footnotes in Roman.
-\subsubsection{The bibitem Numbers}
-
-\File{OPTION!}
-\XePersian\ will put the numbers of all Roman \n\bibitem\ In Roman by default, but if you wish that all Roman \n\bibitem\ numbers appear in Persian, you can load \XePersian\ with the appropriate option as follow:
- \Mac \usepackage[PersianBibNum]{xepersian}
-In addition to this, two commands: \n\RomanBibNum\ and \n\PersianBibNum\ are provided, the command \n\RomanBibNum\ puts the number of all Roman \n\bibitem\ in Roman and \n\PersianBibNum\ puts the number of all Roman \n\bibitem\ in Persian.
-\File{Summary}
-If you wish to have Roman \n\bibitem\ numbers in Persian and the Roman footnote numbers in Roman, you can load \XePersian\ with the appropriate options as follow:
- \Mac \usepackage[PersianBibNum,RomanFootNum]{xepersian}
\section{The Counters}
The following counters are defined in the package:
\begin{description}
\mitem arabic
-The main {\UsageFont arabic} counter of \LaTeX\ has been redefined for comaptibility with the package.
+The main {\UsageFont arabic} counter of \LaTeX.
-\mitem persian
-Has the effect of the main {\UsageFont arabic} counter of \LaTeX .
\mitem adadi
@@ -299,7 +298,4 @@ To generate index, you will need to place \textsf{persian.xdy} file in the curre
tex2xindy < filename.idx > filename.raw
xindy -I xindy -M persian.xdy filename.raw
\end{LVerb}
-\begin{drivers}
-To generate index, the page counter should be \textsf{persian}\footnote{This is the default counter.}.
-\end{drivers}
\endinput