summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2010-05-14 18:38:35 +0000
committerKarl Berry <karl@freefriends.org>2010-05-14 18:38:35 +0000
commitafc4f8ea64aab19792d8dfc601c957eea844ff13 (patch)
tree79617fdeaf2681333f816d72a959abb6257da592 /Master/texmf-dist/doc
parent7d90c1647c043c87a58609fbc1f9a5fe179dd916 (diff)
xepersian update (12may10)
git-svn-id: svn://tug.org/texlive/trunk@18262 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc')
-rw-r--r--Master/texmf-dist/doc/xelatex/xepersian/README12
-rw-r--r--Master/texmf-dist/doc/xelatex/xepersian/magazine-sample.tex8
-rw-r--r--Master/texmf-dist/doc/xelatex/xepersian/persian.xdy118
-rw-r--r--Master/texmf-dist/doc/xelatex/xepersian/xepersian-doc.pdfbin249682 -> 269213 bytes
-rw-r--r--Master/texmf-dist/doc/xelatex/xepersian/xepersian-doc.tex169
5 files changed, 74 insertions, 233 deletions
diff --git a/Master/texmf-dist/doc/xelatex/xepersian/README b/Master/texmf-dist/doc/xelatex/xepersian/README
index 25bd34c4666..325bea7f938 100644
--- a/Master/texmf-dist/doc/xelatex/xepersian/README
+++ b/Master/texmf-dist/doc/xelatex/xepersian/README
@@ -1,10 +1,10 @@
_________________
The XePersian package
-v1.0.4
+v1.0.6
XePersian is a package written for XeLaTeX that allows users to typeset
-Persian easily. The current version is 1.0.4 and it will be developed to
- meet the needs of Persian typesetting properly.
+Persian easily. The current version is 1.0.6 and it will be developed to
+meet the needs of Persian typesetting properly.
The XePersian package is independent of any operating system, meaning it
will work on all operating systems.
@@ -15,13 +15,11 @@ This version fixes all known bugs and adds new features explained in the
documentation. Support for xepersian-thesis class is removed as explained
in the documentation.
-To get help, please subscribe to the XeTeX mailing list and ask your question there.
-
-Next version is planned to be ready for MiKTeX 2.9 and TeXLive 2010.
+To get help, please explore http://forum.parsilatex.com
______________
Vafa Khalighi
-vafa@users.berlios.de
+vafakh84@gmail.com
Copyright 2008-2010
Distributed under the LaTeX Project Public License
diff --git a/Master/texmf-dist/doc/xelatex/xepersian/magazine-sample.tex b/Master/texmf-dist/doc/xelatex/xepersian/magazine-sample.tex
index 28e19a651e2..2c43efdecdf 100644
--- a/Master/texmf-dist/doc/xelatex/xepersian/magazine-sample.tex
+++ b/Master/texmf-dist/doc/xelatex/xepersian/magazine-sample.tex
@@ -1,6 +1,6 @@
\documentclass[12pt,twoside]{xepersian-magazine}
\usepackage{graphicx}
-\usepackage{xunicode}
+\usepackage{xltxtra}
\usepackage{amsmath}
\usepackage{xepersian}
\settextfont[Scale=1]{XB Zar}
@@ -13,7 +13,7 @@
\customlogo{مجلهٔ زی‌پرشین}
\customminilogo{مجلهٔ زی‌پرشین}
\custommagazinename{مجلهٔ زی‌پرشین}
-\customwwwTxt{http://developer.berlios.de/projects/xepersian}
+\customwwwTxt{http://google.com}
\begin{document}
\begin{frontpage}
\firstimage{img/ireland.jpg}{این زیرنویس تصویر اصلی در صفحهٔ اول است.}
@@ -54,8 +54,8 @@
وفا خلیقی، مهدی امیدعلی و مصطفی واحدی
-\texttt{vafa@users.berlios.de\\[5pt]
-http://developer.berlios.de/projects/xepersian}\\
+\texttt{vafakh84@gmail.com\\[5pt]
+http://google.com}\\
\end{authorblock}
\end{frontpage}
\newsection{قسمت الف}
diff --git a/Master/texmf-dist/doc/xelatex/xepersian/persian.xdy b/Master/texmf-dist/doc/xelatex/xepersian/persian.xdy
deleted file mode 100644
index 548d939286d..00000000000
--- a/Master/texmf-dist/doc/xelatex/xepersian/persian.xdy
+++ /dev/null
@@ -1,118 +0,0 @@
-;; $Id: makeidx.xdy,v 1.1 1997/02/07 14:17:31 kehr Exp $
-;;
-;; This file implements the Output Style Specifiers for plain
-;; makeindex (see manpage of makeindex 2.x) in conjuction with
-;; TeX/LaTeX.
-;;
-;; The Input Style Specifiers of makeindex cannot de defined in a
-;; `xindy' style file. Use an appropriate version of the program
-;; `tex2xindy' which should be included with this distribution.
-;;
-;; Since `xindy' uses a different specification language than
-;; makeindex and some of the command-line options of makeindex are now
-;; only available as style-file commands, this file can only serve as
-;; a template that produces the default-markup of makeindex. However,
-;; it may be used as a starting point for further modification and
-;; specialization.
-;;
-;; The following values are taken from the source of the makeindex
-;; distribution (see file scanst.h and the manpage) for further
-;; details.
-;;
-
-;; Define all attributes appearing in your document. Your attributes
-;; are all encapsulators you use in your \index commands following the
-;; vertical bar sign `|'. For example `foo' is the attribute in the
-;; command \index{...|foo}. Here you specify the set of attributes
-;; that appear in your document, the order in which they appear in the
-;; index and which one superdes the other.
-;;
-;; Example: a) (define-attibutes (("default") ("bf") ("it")))
-;; b) (define-attibutes (("bf" "default")))
-;;
-;; The initial command is (change it accordingly):
-
-(define-attributes ("default"))
-
-;; The description of the location-classes.
-;; Add more location classes as needed.
-
-(define-location-class "arabic-page-numbers" ("arabic-numbers"))
-(define-location-class "roman-page-numbers" ("roman-numbers-lowercase"))
-(define-location-class "Roman-page-numbers" ("roman-numbers-uppercase"))
-(define-location-class "alpha-page-numbers" ("alpha"))
-(define-location-class "Alpha-page-numbers" ("ALPHA"))
-
-;; The most frequently used cross reference class "see". Add more, if
-;; necessary.
-
-(define-crossref-class "see")
-(markup-crossref-list :open "\see{" :close "}{}" :class "see")
-
-;; In makeindex: page_precedence <string> "rnaRA"
-;; List all location classes appearing in your document.
-
-(define-location-class-order ("roman-page-numbers"
- "arabic-page-numbers"
- "alpha-page-numbers"
- "Roman-page-numbers"
- "Alpha-page-numbers"
- "see"))
-
-
-;; preamble <string> "\\begin{theindex}\n"
-;; postamble <string> "\n\n\\end{theindex}\n"
-
-(markup-index :open "\begin{theindex}~n"
- :close "~n~n\end{theindex}~n"
- :tree)
-
-;; These specifiers are not directly supported via a command-line
-;; switch as in makeindex. Add the appropriate markup-commands into
-;; the preamble.
-
-;; setpage_prefix <string> "~n \setcounter{page}{"
-;; setpage_suffix <string> "}~n"
-
-;; group_skip <string> "~n~n \indexspace~n"
-
-(markup-letter-group-list :sep "~n~n \indexspace~n")
-
-;; The indexentries (item_<..> specifiers)
-
-(markup-indexentry :open "~n \item " :depth 0)
-(markup-indexentry :open "~n \subitem " :depth 1)
-(markup-indexentry :open "~n \subsubitem " :depth 2)
-
-;; Location-references
-
-;; delim_0 <string> ", "
-;; delim_1 <string> ", "
-;; delim_2 <string> ", "
-
-(markup-locclass-list :open ", " :sep ", ")
-
-;; delim_n <string> ", "
-
-(markup-locref-list :sep ", ")
-
-;; delim_r <string> "--"
-
-(markup-range :sep "--")
-
-;; Here follow all letter-groups. The short-cut notation is used here.
-
-(define-letter-groups
- ("آ" "ا" "ب" "پ" "ت" "ث" "ج" "چ" "ح" "خ" "د" "ذ" "ر" "ز"
- "ژ" "س" "ش" "ص" "ض" "ط" "ظ" "ع" "غ" "ف" "ق" "ک" "گ" "ل" "م" "ن" "ه" "و" "ی"))
-
-;;
-;; The sort-rules map all letters to their lowercase counterpart.
-;;
-
-
-;; End
-
-;; Local Variables:
-;; mode: lisp
-;; End:
diff --git a/Master/texmf-dist/doc/xelatex/xepersian/xepersian-doc.pdf b/Master/texmf-dist/doc/xelatex/xepersian/xepersian-doc.pdf
index c92f2f4d9a3..bd6503e1269 100644
--- a/Master/texmf-dist/doc/xelatex/xepersian/xepersian-doc.pdf
+++ b/Master/texmf-dist/doc/xelatex/xepersian/xepersian-doc.pdf
Binary files differ
diff --git a/Master/texmf-dist/doc/xelatex/xepersian/xepersian-doc.tex b/Master/texmf-dist/doc/xelatex/xepersian/xepersian-doc.tex
index 879ad1e3e7b..de17ea9b702 100644
--- a/Master/texmf-dist/doc/xelatex/xepersian/xepersian-doc.tex
+++ b/Master/texmf-dist/doc/xelatex/xepersian/xepersian-doc.tex
@@ -1,23 +1,25 @@
-\documentclass{report}
+\documentclass{rapport3}
+\usepackage{url}
\usepackage{supertabular}
\usepackage{fontspec}
\usepackage{calc}
\usepackage{pifont}
\usepackage{bbding}
-\usepackage[left=2.5cm,right=4cm,top=2.5cm,bottom=2.5cm,nohead]{geometry}
\usepackage[colorlinks=true,linkcolor=mybrown,urlcolor=mygreen]{hyperref}
\usepackage{bidicode}
\usepackage{bidi}
-\newfontfamily\ParsiFont[Script=Arabic,Scale=1.2]{Scheherazade}
+\newfontfamily\ParsiFont[Script=Arabic]{XB Roya}
\def\Pcs#1{\nxPLcs{#1}}
\def\nxPLcs#1{\RLE{\texttt{\symbol{92}\ParsiFont#1}}}
\def\Lenv#1{\texttt{#1}}
\def\Penv#1{\RLE{\ParsiFont#1}}
-\def\xepersianversion{v1.0.4}
-\def\xepersianrevision{revision 147}
-\def\xepersiandate{2010/03/01}
-\def\XePersian{\leavevmode$\smash{\hbox{X\lower.5ex
- \hbox{\kern-.125em\reflect{E}}Persian}}$}
+\let\parsitext\Penv
+\def\xepersianversion{v1.0.5}
+\def\xepersiancommit{commit 1}
+\def\xepersiandate{2010/07/25}
+\def\XeTeX{Xe\TeX}
+\def\XeLaTeX{Xe\LaTeX}
+\def\XePersian{XePersian}
\newcounter{local}
\renewcommand\theenumi{\protect\setcounter{local}%
{201+\the\value{enumi}}\protect\ding{\value{local}}}
@@ -29,46 +31,34 @@
\definecolor{mybrown}{rgb}{.6,0,0}
\definecolor{mygreen}{rgb}{0,.43,0}
\definecolor{Orange}{rgb}{1,.4,.2}
-\title{The \textsf{\XePersian} Package\\ \href{http://xepersian.berlios.de}{\texttt{http://xepersian.berlios.de}}}
-\author{Vafa Khalighi\\ \href{mailto:vafa@users.berlios.de}{\texttt{vafa@users.berlios.de}}}
-\date{Version 1.0.4}
+\title{The \textsf{\XePersian} Package\\ \href{http://bitbucket.org/vafa/xepersian}{\texttt{http://bitbucket.org/vafa/xepersian}}}
+\author{Vafa Khalighi\\ \href{mailto:vafakh84@gmail.com}{\texttt{vafakh84@gmail.com}}}
+\date{Version 1.0.6}
\begin{document}
\maketitle
\tableofcontents
-\lstlistoflistings
\chapter{Introduction}
\XePersian\ is a package for typesetting Persian/English documents with \XeLaTeX. The package includes adaptations for use with many other commonly-used packages.
\section{Important Notes}
\begin{itemize}
\item The \textsf{\XePersian} package only works with \XeTeX\ engine.
-\item Before reading this documentation, you should have read the documentation of the version 1.0.4 of \textsf{bidi} package. The \textsf{\XePersian} package automatically loads \textsf{bidi} package with \texttt{RTLdocument} option enabled and hence any commands that \textsf{bidi} package offers, is also available in \textsf{\XePersian} package. Here, in this documentation, we will not repeat any of \textsf{bidi} package's commands.
-\item In previous versions of \XePersian, a thesis class, namely \texttt{xepersian-thesis.cls} provided for typesetting thesis. I no longer provide this class because I am not familiar with specification of a thesis in Iran and even if I was, the specifications are different from University to University. \XePersian\ is a general package like \LaTeX\ and should not provide any class for typesetting thesis. So if you really want to have a class file for typesetting thesis, then you should ask your University/department to write one for you.
-\item To get help, please subscribe to \XeTeX\ mailing list and ask your question there.
+\item Before reading this documentation, you should have read the documentation of the version 1.1.0 of \textsf{bidi} package. The \textsf{\XePersian} package automatically loads \textsf{bidi} package with \texttt{RTLdocument} option enabled and hence any commands that \textsf{bidi} package offers, is also available in \textsf{\XePersian} package. Here, in this documentation, we will not repeat any of \textsf{bidi} package's commands.
+\item In previous versions (\(\leq1.0.3\)) of \XePersian, a thesis class provided for typesetting thesis. As of version 1.0.4, I no longer provide this class because I am not familiar with specification of a thesis in Iran and even if I was, the specifications are different from University to University. \XePersian\ is a general package like \LaTeX\ and should not provide any class for typesetting thesis. So if you really want to have a class file for typesetting thesis, then you should ask your University/department to write one for you.
+\item To get help, please explore \url{http://forum.parsilatex.com} and ask your question there.
\end{itemize}
\section{\textsf{\XePersian} Info On The Terminal and In The Log File}
If you use \textsf{\XePersian} package to write any input \TeX\ document, and then run \texttt{xelatex} on your document, in addition to what \textsf{bidi} package writes to the terminal and to the log file, the \XePersian\ package also writes some information about itself to the terminal and to the log file, too. The information is something like:
-\begin{center}
-\colorbox{lightgray}{\begin{minipage}{0.9\textwidth}\ttfamily
-xepersian package (Persian for LaTeX over XeTeX)\\
-Description: The package supports Persian\\
-typesetting, using fonts provided in the distribution.\\
-Copyright © 2008-2010 Vafa Khalighi\\
-\xepersianversion, <\xepersianrevision>, \xepersiandate\\
-License: LaTeX Project Public License, version 1.3c or higher (your choice)\\
-Home: http://xepersian.berlios.de\\
+\begin{lstlisting}[numbers=none,backgroundcolor=\color{skugga}]
+xepersian package (Persian for LaTeX over XeTeX)
+Description: The package supports Persian
+typesetting, using fonts provided in the distribution.
+Copyright © 2008-2010 Vafa Khalighi
+v1.0.6, <commit 18>, 2010/07/25
+License: LaTeX Project Public License, version 1.3c or higher (your choice)
+Home: http://bitbucket.org/vafa/xepersian
Location on CTAN: /macros/xetex/latex/xepersian
-\end{minipage}}
-\end{center}
-\section{PDF Creator of \textsf{\XePersian} Documents}
-If you use \textsf{\XePersian} package to produce a PDF file, the \textsf{\XePersian} package writes itself to the Application field of the PDF file and hyperref would have no effect since this is done at the beggining of the document. Thus if you produce a PDF file using the \textsf{\XePersian} package and then you look at the application field in the properties of the PDF file, you will see this:
-
-\begin{center}
-\colorbox{yellow}{\begin{minipage}{0.8\textwidth}%
-XePersian \xepersianversion\space <\xepersianrevision> Copyright © 2008-2010 Vafa Khalighi
-\end{minipage}}
-\end{center}
-
+\end{lstlisting}
\chapter{Basics\label{basics}}
\section{Loading The Package}
You can load the package in the ordinary way;
@@ -85,17 +75,17 @@ When loading the package, it is important to know that:
If you load \textsf{\XePersian} before any of these packages, then you will get an error saying that you should load \textsf{\XePersian} or \textsf{bidi} as your last package. When it says that you should load \textsf{bidi} package as your last package, it really means that you should load \textsf{\XePersian} as your last package as \textsf{bidi} package is loaded automatically by \textsf{\XePersian} package.
For instance, consider the following minimal example:
-\begin{lstlisting}[caption={Wrong Order Of Loading \textsf{\XePersian} Package},morekeywords={settextfont}]
+\begin{lstlisting}[morekeywords={settextfont}]
\documentclass{minimal}
\usepackage{xepersian}
\usepackage{enumerate}
-\settextfont[Scale=1.5]{Scheherazade}
+\settextfont{XB Niloofar}
\begin{document}
-This is just a test.
+?\parsitext{این فقط یک آزمایش است}?
\end{document}
\end{lstlisting}
Where \textsf{enumerate} is loaded after \textsf{\XePersian}. If you run \texttt{xelatex} on this document, you will get an error which looks like this:
-\begin{lstlisting}[numbers=none]
+\begin{lstlisting}[numbers=none,backgroundcolor=\color{skugga}]
! Package xepersian Error: Oops! you have loaded package enumerate after xepers
ian package. Please load package enumerate before xepersian package, and then t
ry to run xelatex on your document again.
@@ -109,48 +99,24 @@ l.5 \begin{document}
?
\end{lstlisting}
-\item However, there is an exception to the two previous points. You should load \textsf{subfigure} package always after \textsf{\XePersian} package. Indeed, if like the following minimal example, you load \textsf{subfigure} package before \textsf{\XePersian} package:
-\begin{lstlisting}[caption={Wrong Order Of Loading \textsf{subfigure} Package},morekeywords={settextfont}]
-\documentclass{article}
-\usepackage{subfigure}
-\usepackage{xepersian}
-\settextfont[Scale=1.5]{Scheherazade}
-\begin{document}
-This is just a test.
-\end{document}
-\end{lstlisting}
-You will get an error saying that \textsf{subfigure} package should be loaded after \textsf{\XePersian} package. The error message looks like this:
-\begin{lstlisting}[numbers=none]
-! Package xepersian Error: Oops! you have loaded package subfigure before xeper
-sian package. Please load package subfigure after xepersian package, and then t
-ry to run xelatex on your document again.
-
-See the xepersian package documentation for explanation.
-Type H <return> for immediate help.
- ...
-
-l.5 \begin{document}
-
-?
-
-\end{lstlisting}
\end{enumerate}
-\section{Commands for Version, Subversion Revision and Date of The Package}
+\section{Commands for Version number, Mercurial commit number and Date of The Package}
\begin{BDef}
-\Lcs{xepersianversion}\quad\Lcs{xepersianrevision}\quad\Lcs{xepersiandate}
+\Lcs{xepersianversion}\quad\Lcs{xepersiancommit}\quad\Lcs{xepersiandate}
\end{BDef}
\begin{itemize}
\item \Lcs{xepersianversion} gives the current version of the package.
-\item \Lcs{xepersianrevision} gives the current subversion revision of the package.
+\item \Lcs{xepersiancommit} gives the current Mercurial commit number of the package.
\item \Lcs{xepersiandate} gives the current date of the package.
\end{itemize}
-\begin{lstlisting}[morekeywords={xepersianversion,xepersianrevision,xepersiandate,settextfont,XePersian},captionpos=t,caption={Version, SVN Revision and Date Commands}]
+\begin{lstlisting}[morekeywords={settextfont,XePersian,xepersianversion,xepersiancommit,xepersiandate}]
\documentclass{article}
\usepackage{xepersian}
-\settextfont[Scale=1.5]{Scheherazade}
+\settextfont{XB Niloofar}
\begin{document}
\begin{latin}
-This is typeset by \textsf{\XePersian} package, \xepersianversion, \xepersianrevision, \xepersiandate.
+This is typeset by \textsf{\XePersian} package,
+ \xepersianversion, \xepersiancommit, \xepersiandate.
\end{latin}
\end{document}
\end{lstlisting}
@@ -702,30 +668,31 @@ The \TeX\ and \LaTeX\ commands and environments and their Persian equivalents li
\end{center}
\section{A Sample Input \TeX\ File}
-\begin{lstlisting}[morekeywords={settextfont,maketitle,tableofcontents,part,subsection,subsubsection},caption={A Sample Input \TeX\ File}]
+\begin{lstlisting}[morekeywords={settextfont,maketitle,tableofcontents,subsection,subsubsection,part}]
\documentclass{article}
\usepackage{xepersian}
-\settextfont[Scale=1.5]{Scheherazade}
-\title{<title>}
-\author{<author>}
+\settextfont{XB Niloofar}
+\title{?\parsitext{یک سند نمونه}?}
+\author{?\parsitext{نام نویسنده}?}
\begin{document}
\maketitle
\tableofcontents
-\part{<text>}
+\part{?\parsitext{عنوان بخش}?}
...
-\section{<text>}
+\section{?\parsitext{عنوان قسمت}?}
...
-\subsection{<text>}
+\subsection{?\parsitext{عنوان زیرقسمت}?}
...
-\subsubsection{<text>}
+\subsubsection{?\parsitext{عنوان زیر زیرقسمت}?}
...
\end{document}
\end{lstlisting}
\section{Font Commands}
\subsection{Basic Font Commands}
\begin{BDef}
-\Lcs{settextfont}\OptArgs\Largb{\Larga{font name}}\quad\Lcs{setlatintextfont}\OptArgs\Largb{\Larga{font name}}\\
-\Lcs{setdigitfont}\OptArgs\Largb{\Larga{font name}}\quad
+\Lcs{settextfont}\OptArgs\Largb{\Larga{font name}}\\
+\Lcs{setlatintextfont}\OptArgs\Largb{\Larga{font name}}\\
+\Lcs{setdigitfont}\OptArgs\Largb{\Larga{font name}}
\end{BDef}
\begin{itemize}
\item Options in any font command in this documentation are anything that \textsf{fontspec} package provides as the option of loading fonts, except \texttt{Script} and \texttt{Mapping}.
@@ -740,12 +707,12 @@ The \TeX\ and \LaTeX\ commands and environments and their Persian equivalents li
\end{BDef}
\begin{itemize}
\item With \Lcs{defpersianfont}, you can define extra Persian fonts.
-\begin{lstlisting}[morekeywords={defpersianfont,Nastaliq},caption={Example Of Using \Lcs{defpersianfont}}]
+\begin{lstlisting}[numbers=none,morekeywords={defpersianfont,Nastaliq}]
\defpersianfont\Nastaliq[Scale=1]{IranNastaliq}
\end{lstlisting}
In this example, we define \Lcs{Nastaliq} to stand for Nastaliq font.
\item With \Lcs{deflatinfont}, you can define extra Latin fonts.
-\begin{lstlisting}[morekeywords={deflatinfont,junicode},caption={Example Of Using \Lcs{deflatinfont}}]
+\begin{lstlisting}[numbers=none,morekeywords={deflatinfont,junicode}]
\deflatinfont\junicode[Scale=1]{Junicode}
\end{lstlisting}
In this example, we define \Lcs{Junicode} to stand for Junicode font.
@@ -828,7 +795,7 @@ In this example, we define \Lcs{Junicode} to stand for Junicode font.
\begin{itemize}
\item \Lcs{today} typesets current Persian date and \Lcs{latintoday} typesets current Latin date.
\item \Lcs{twocolumnstableofcontents} typesets table of contents in two columns. This requires that you have loaded \textsf{multicol} package before \textsf{\XePersian} package, otherwise an error will be issued.
-\item \Lcs{\XePersian} typesets \XePersian's logo.
+\item \Lcs{XePersian} typesets \XePersian's logo.
\item \Lcs{plq} and \Lcs{prq} typeset Persian left quote and Persian right quote respectively.
\end{itemize}
@@ -848,7 +815,6 @@ If you use \Lcs{setdigitfont}, you should the know that:
\item If you use \Lcs{PersianMathsDigits} anywhere, you will overwrite \XePersian's default behaviour and you will always get Persian digits in math mode.
\item If you use \Lcs{DefaultMathsDigits} anywhere, again you will overwrite \XePersian's default behaviour and you will always get \TeX's default font and digits in math mode.
\end{itemize}
-\item When you use \Lcs{setdigitfont}, you also will change the font used inside \Lcs{mathbf}, \Lcs{mathit} and \ldots, which means both letters and digits inside say \Lcs{mathbf} will be typeset in your chosen font. Please do not contact me, saying this is a bug, this is done on purpose and if I see such email, I will ignore it.
\end{itemize}
\section{Bilingual Captions}
\XePersian\ sets caption bilingually. This means if you are in RTL mode, you get Persian caption and if you are in LTR mode, you get English caption.
@@ -873,14 +839,7 @@ To see an Example, please look at \textsf{enumerate} package documentation.
\section{Index Generation}
For generating index, you are advised to use \textsf{xindy} program, any other program such as \textsf{makeindex} is not recommended.
-With \XePersian\ package, the file \texttt{persian.xdy} comes that should be in \texttt{doc} folder. To generate index, you will need to put \texttt{persian.xdy} file in the current directory and then open a terminal/command prompt and do the following:
-
-\begin{BDef}\ttfamily
-tex2xindy < filename.idx > filename.raw\\ \ttfamily
-xindy -I xindy -M persian.xdy filename.raw
-\end{BDef}
-Please note that this way of generating index with the \textsf{xindy} program is temporary and it will definitely be removed in the next version of \XePersian. We will have Persian support to the main \textsf{xindy} program in the next version of \XePersian. This perfectly means that by the next version of \XePersian's package, we will be able to use \textsf{glossaries} package too for making Persian and Latin glossaries.
\section{Converting Your Farsi\TeX\ Files To \XePersian\ or Unicode}
There is a python program written by Mostafa Vahedi that enables you to convert Farsi\TeX\ files to \XePersian\ or unicode. This program can be found in \textsf{doc} folder with the name \texttt{ftxe-0.11.py}. To convert your Farsi\TeX\ files to \XePersian, put \texttt{ftxe-0.11.py} in the same directory that your Farsi\TeX\ file is, and then open a terminal/command prompt and do the following:
@@ -893,7 +852,7 @@ This will convert your \texttt{file.ftx} (Farsi\TeX\ file) to \texttt{file.tex}
The general syntax syntax of using the python script is as follow:
\begin{BDef}\ttfamily
-python ftxe-0.11 [-r] [-s] [-x] [-u] input-filename1 input-filename2
+python ftxe-0.11.py [-r] [-s] [-x] [-u] input-filename1 input-filename2
\end{BDef}
Where
\begin{description}
@@ -903,7 +862,7 @@ Where
\item[\texttt{-u}] only convert to unicode (and not to \XePersian)
\end{description}
-Please note that the python script will not with versions of python later than 2.6. So you are encouraged to use version 2.6 of python to benefit from this python script.
+Please note that the python script will not work with versions of python later than 2.6. So you are encouraged to use version 2.6 of python to benefit from this python script.
\chapter{Extra Packages And Classes}
\section{Magazine Typesetting}
@@ -1072,7 +1031,8 @@ When creating a magazine, everyone wants to show its own logo instead of \texts
The edition text has to be declared in the preamble of the document. One important thing to know is that \Lcs{author}, \Lcs{date} and \Lcs{title} have no effect inside \textsf{xepersian-magazine} since the magazine date is taken from \Lcs{today} command and the other two are only for the title page (if using \Lcs{maketitle}).
\begin{BDef}
-\Lcs{indexFormat}\quad\Lcs{indexEntryFormat}\quad\Lcs{indexEntryPageTxt}\quad\Lcs{indexEntryPageFormat}\\%
+\Lcs{indexFormat}\quad\Lcs{indexEntryFormat}\quad\Lcs{indexEntryPageTxt}\\
+\Lcs{indexEntryPageFormat}\quad%
\Lcs{indexEntrySeparator}
\end{BDef}
@@ -1095,7 +1055,8 @@ The main article that appear in the front page can change their formats. To obta
Two other elements to configure are the picture captions and the pages or section format in the entire document. To proceed just redefine the macros \Lcs{pictureCaptionFormat} and \Lcs{pagesFormat}.
\subsubsection{Inside The Magazine}
\begin{BDef}
-\Lcs{innerTitleFormat}\quad\Lcs{innerSubtitleFormat}\quad\Lcs{innerAuthorFormat}\quad\Lcs{innerPlaceFormat}
+\Lcs{innerTitleFormat}\quad\Lcs{innerSubtitleFormat}\quad\Lcs{innerAuthorFormat}\\
+\Lcs{innerPlaceFormat}
\end{BDef}
The articles inside \textsf{xepersian-magazine} may have a different format from the ones in the front page. To change their title or subtitle format redefine \Lcs{innerTitleFormat} and \Lcs{innerSubtitleFormat}. The article text format matches the document general definition. When using the \Lcs{authorandplace} command, you might want to change the default style. Just renew \Lcs{innerAuthorFormat} and \Lcs{innerPlaceFormat} to get the results.
@@ -1165,15 +1126,15 @@ The available options are described along the text,
where appropriate.
\subsubsection{Creating Questions}
Here's a simple example demonstrating how to produce a new question:
-\begin{lstlisting}[morekeywords={true,false},caption={Creating Questions With \textsf{xepersian-multiplechoice} Package}]
-\begin{question}{<question>}
-\false <answer1>
-\true <answer2>
-\false <answer3>
-\false <answer4>
+\begin{lstlisting}[morekeywords={false,true}]
+\begin{question}{?\parsitext{سؤال}?}
+\false ?\parsitext{جواب ۱}?
+\true ?\parsitext{جواب ۲}?
+\false ?\parsitext{جواب ۳}?
+\false ?\parsitext{جواب ۴}?
\end{question}
\begin{correction}
-<real answer and reason why it is true>
+?\parsitext{جواب واقعی و علت اینکه این جواب، جواب واقعی هست}?
\end{correction}
\end{lstlisting}
\subsubsection{The \texttt{question} Environment}
@@ -1283,10 +1244,10 @@ arrow are used. You can change these symbols by using the \Lcs{truesymbol} and
\Lcs{falsesymbol} macros. For instance, you could give a fancier look to your correction
by using the \textsf{pifont} package and issuing:
-\begin{verbatim}
+\begin{lstlisting}[numbers=none,morekeywords={truesymbol,ding,falsesymbol}]
\truesymbol{\ding{'063}~}
\falsesymbol{\ding{'067}~}
-\end{verbatim}
+\end{lstlisting}
\begin{BDef}
\Lcs{correctionstyle}