summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/lualatex/luapersian/luapersian.ltx
blob: e29453e6dc47c1755b00a2441dac78592a79ef1e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
\documentclass{ltxdoc}
\usepackage{fontspec}
\usepackage{bidicode}
\usepackage{url}
\usepackage{multicol}
\usepackage{hyperref}
\usepackage{calc}
\usepackage{pifont}
\usepackage{bbding}
\setlength\columnseprule{.4pt}
\definecolor{myred}{rgb}{0.65,0.04,0.07}
\hypersetup{pdftitle={The LuaPersian Package (Persian for \LaTeXe{} over LuaTeX)},pdfauthor={Vafa Khalighi <vafa018@gmail.com>},colorlinks=true}
\newcommand\XeTeX{Xe\TeX}
\newcommand\XeLaTeX{Xe\LaTeX}
\newcommand\XePersian{\textsf{XePersian}}
\newcommand\LuaTeX{Lua\TeX}
\newcommand\LuaLaTeX{Lua\LaTeX}
\newcommand\LuaPersian{\textsf{LuaPersian}}
\newcommand\bidi{\textsf{bidi}}
\newcounter{local}
\renewcommand\theenumi{\protect\setcounter{local}%
  {201+\the\value{enumi}}\protect\ding{\value{local}}}
\renewcommand\labelenumi{\theenumi}
\renewcommand\labelitemi{\HandRight}
\renewcommand\labelitemii{\HandRightUp}
\renewcommand\labelitemiii{\HandCuffRight}
\renewcommand\labelitemiv{\HandPencilLeft}
\makeatletter
\renewcommand\tableofcontents{\relax
  \begin{multicols}{2}[\section*{\contentsname}]\small
    \@starttoc{toc}\relax
  \end{multicols}}
\pdfstringdefDisableCommands{%
\renewcommand\Lcs[1]{\textbackslash#1}
}
\makeatother
 \title{The \LuaPersian\ Package\\ \url{http://bitbucket.org/vafa/luapersian}\\[5pt]
 Persian for \LaTeXe{} over \LuaTeX}
 \author{Vafa Khalighi\\
   \url{vafa018@gmail.com}}
 \date{\today\qquad Version 0.1}
\begin{document}
\maketitle
\section{Introduction}
\LuaPersian\ package is the successor to \XePersian\  package. Most of the things that used to work in \XePersian\ and \bidi\ also work in \LuaPersian\ but with few exceptions mentioned later in this document. This does not mean that those features of \XePersian\ package will not be supported by \LuaPersian\ package; but because \LuaPersian\ is under rapid development, those features have not been implemented yet, but they will be implemented in future versions of \LuaPersian\ package.  This means that your \XePersian\ documents with very minor changes will work in \LuaPersian\ as well. 

\XePersian\ package is frozen, obselete and no more development will be done, thus users of \XePersian\ package are encouraged to use \LuaPersian\ package instead.
\section{Things that used to work with \XePersian\, but not supported by the current version of \LuaPersian}
\begin{itemize}
\item There is no \texttt{Kashida} option. 
\item There is no implementation of \textsf{xepersian-magazine} class.
\item There are no \Lcs{setLTR}, \Lcs{setLR}, \Lcs{setRTL}, \Lcs{setRL}, \Lcs{unsetRL}, \Lcs{unsetRTL}, \Lcs{unsetLTR}, \Lcs{LR}, and \Lcs{RL} commands.
\item There is no \texttt{extrafootnotefeatures} option.
\item There is no \Lcs{SepMark} and \Lcs{@SepMark} commands. (not essential at all)
\item There is no \Lcs{rcases} command. (not essential at all)
\item There is no implementation of \textsf{bidimoderncv} class.
\end{itemize}
\section{What has changed?}
\begin{itemize}
\item \Lcs{xepersianversion} and \Lcs{xepersianversion} commands are changed to \Lcs{luapersianversion} and \Lcs{luapersiandate} commands respectively.
\item The name of \textsf{xepersian-multiplechoice} is changed to \textsf{luapersian-multiplechoice}.
\item We decided to not change \Lcs{raggedright} and \Lcs{raggedleft} commands since they are used in many packages and classes. Instead we created \Lcs{bidiraggedleft} and \Lcs{bidiraggedright} which give logical results both in RTL and LTR. However the \textsf{flushright} and \textsf{flushleft} environment give logical result. The same is true for \textsf{ragged2e} package.
\item The name of \textsf{bidiftnxtra} package is changed to \textsf{luapersianftnxtra} package.
\end{itemize}











\end{document}