summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2010-06-09 00:33:19 +0000
committerKarl Berry <karl@freefriends.org>2010-06-09 00:33:19 +0000
commitf595534d430a668aabd97236789552247427a959 (patch)
tree3067fddcc212eab361feedd6384f25324b278723 /Master/texmf-dist/doc
parent2daec93327bd3cf382b3178e64759af1459e1d69 (diff)
bidi update (8jun10)
git-svn-id: svn://tug.org/texlive/trunk@18834 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc')
-rw-r--r--Master/texmf-dist/doc/latex/bidi/README4
-rw-r--r--Master/texmf-dist/doc/latex/bidi/bidi-doc.pdfbin176205 -> 184958 bytes
-rw-r--r--Master/texmf-dist/doc/latex/bidi/bidi-doc.tex66
-rw-r--r--Master/texmf-dist/doc/latex/bidi/bidi.tex2
4 files changed, 66 insertions, 6 deletions
diff --git a/Master/texmf-dist/doc/latex/bidi/README b/Master/texmf-dist/doc/latex/bidi/README
index 92d46716259..642fa43b666 100644
--- a/Master/texmf-dist/doc/latex/bidi/README
+++ b/Master/texmf-dist/doc/latex/bidi/README
@@ -1,11 +1,11 @@
_________________
The bidi package
-v1.1.1
+v1.1.2
This package provides a convenient interface for typesetting
bidirectional texts in Plain TeX and LaTeX.
-This version fixes all the bugs that were present in v1.1.0.
+This version fixes all the bugs that were present in v1.1.1.
______________
Vafa Khalighi
diff --git a/Master/texmf-dist/doc/latex/bidi/bidi-doc.pdf b/Master/texmf-dist/doc/latex/bidi/bidi-doc.pdf
index dd81b49caab..f4f7932668e 100644
--- a/Master/texmf-dist/doc/latex/bidi/bidi-doc.pdf
+++ b/Master/texmf-dist/doc/latex/bidi/bidi-doc.pdf
Binary files differ
diff --git a/Master/texmf-dist/doc/latex/bidi/bidi-doc.tex b/Master/texmf-dist/doc/latex/bidi/bidi-doc.tex
index ff039be4b5b..92b326fec3b 100644
--- a/Master/texmf-dist/doc/latex/bidi/bidi-doc.tex
+++ b/Master/texmf-dist/doc/latex/bidi/bidi-doc.tex
@@ -19,9 +19,15 @@
\newcommand\XeLaTeX{Xe\LaTeX}
\newcommand\LuaTeX{Lua\TeX}
\newcommand\LuaLaTeX{Lua\LaTeX}
+\makeatletter
+\makeatletter
+\pdfstringdefDisableCommands{%
+\renewcommand\Lcs[1]{\textbackslash#1}
+}
+\makeatother\makeatother
\title{The \textsf{bidi} Package\\ \href{http://bitbucket.org/vafa/bidi}{\texttt{http://bitbucket.org/vafa/bidi}}}
\author{Vafa Khalighi\\ \href{mailto:vafakh84@gmail.com}{\texttt{vafakh84@gmail.com}}}
-\date{Version 1.1.1}
+\date{Version 1.1.2}
\begin{document}
\maketitle
\tableofcontents
@@ -38,7 +44,7 @@ Description: A convenient interface for typesetting bidirectional texts
in plain TeX and LaTeX. The package includes adaptations for use
with many other commonly-used packages.
Copyright (c) 2009-2010 Vafa Khalighi
-v1.1.1, <commit 54>, 2010/07/25
+v1.1.2, <commit 62>, 2010/07/25
License: LaTeX Project Public License, version 1.3c or higher (your choice)
Home: http://bitbucket.org/vafa/bidi
Location on CTAN: /macros/latex/contrib/bidi
@@ -285,6 +291,26 @@ x^2+y^2=z^2
\item The syntax of \Lcs{vboxR} is exatly the same as the syntax of \Lcs{vbox}, but its contents is always typeset RTL.
\item The syntax of \Lcs{vboxL} is exatly the same as the syntax of \Lcs{vbox}, but its contents is always typeset LTR.
\end{itemize}
+\subsection{Something To know about \Lcs{hbox}}
+If you enable RTL typesetting and typeset an horizontal box at the beginning of the document:
+\begin{lstlisting}
+\documentclass{article}
+\usepackage{bidi}
+\setRTL
+\begin{document}
+\hbox{This is a Test}
+\end{document}
+\end{lstlisting}
+You see that even you have used \Lcs{setRTL}, the horizontal box appears LTR (It appears on the left hand side and its content is typeset left to right). This is because when \TeX{} starts, it is in the vertical mode so if you need to have that \Lcs{hbox} appear RTL, then write \Lcs{leavevmode} before \Lcs{hbox}:
+\begin{lstlisting}
+\documentclass{article}
+\usepackage{bidi}
+\setRTL
+\begin{document}
+\leavevmode\hbox{This is a Test}
+\end{document}
+\end{lstlisting}\subsection{\Lcs{bidillap} and \Lcs{bidirlap} Commands}
+In RTL mode, \Lcs{llap} and \Lcs{rlap} do oposite things. Since these two macros are used in a lot of classes and packages, instead modifying these two macros, we have created two new macros \Lcs{bidillap} and \Lcs{bidirlap} which give logical results.
\subsection{\textsf{LTRitems} and \textsf{RTLitems} Environments}
If you typeset an \textsf{itemize}, or an \textsf{enumerate}, or a \textsf{description} environment where all \Lcs{item}s are one directional, you have no problem at all as shown below:
\begin{lstlisting}
@@ -380,7 +406,7 @@ In RTL mode, tabular are typeset RTL and in LTR mode, tabular are typeset LTR.
\subsection{Equation Numbers}
For \texttt{reqno}, equation numbers are on the right hand side and for \texttt{leqno}, equation numbers are on the left hand side, independent on the current mode.
\section{Support For Various Packages and Classes}
-The \textsf{bidi} package supports \textsf{amsmath}, \textsf{amsthm}, \textsf{array}, \textsf{arydshln}, \textsf{breqn}, \textsf{caption}, \textsf{color}, \textsf{colortbl}, \textsf{draftwatermark}, \textsf{fancyhdr}, \textsf{flowfram}, \textsf{graphicx}, \textsf{hyperref}, \textsf{listings}, \textsf{minitoc}, \textsf{multicol}, \textsf{pdfpages}, \textsf{pstricks}, \textsf{ragged2e}, \textsf{stabular}, \textsf{subfig}, \textsf{subfigure}, \textsf{supertabular}, \textsf{xtab}, \textsf{tabls}, \textsf{tabulary}, \textsf{PGF \&\ TIKZ}, \textsf{tocbibind}, \textsf{tocloft}, \textsf{tocstyle}, \textsf{wrapfig}, \textsf{xcolor}, \textsf{xltxtra} packages, \textsf{amsart}, \textsf{amsbook}, \textsf{artikel1}, \textsf{artikel2}, \textsf{artikel3}, \textsf{extarticle}, \textsf{standrad article}, \textsf{boek}, \textsf{boek3}, \textsf{standard book}, \textsf{bookest}, \textsf{extbook}, \textsf{extletter}, \textsf{scrlettr},\textsf{standard letter}, \textsf{memoir}, \textsf{extreport}, \textsf{rapport1}, \textsf{rapport3}, \textsf{refrep}, \textsf{standard report}, \textsf{scartcl}, \textsf{scrbook}, \textsf{scrreprt} classes and any other packages and classes that relies on these packages and classes. This means, you can use all these packages and classes in addition to other packages and classes that rely on these packages and classes and use their functionality fully for your bidirectional documents.
+The \textsf{bidi} package supports \textsf{amsmath}, \textsf{amsthm}, \textsf{array}, \textsf{arydshln}, \textsf{breqn}, \textsf{caption}, \textsf{color}, \textsf{colortbl}, \textsf{draftwatermark}, \textsf{fancyhdr}, \textsf{flowfram}, \textsf{graphicx}, \textsf{hyperref}, \textsf{listings}, \textsf{minitoc}, \textsf{multicol}, \textsf{pdfpages}, \textsf{pstricks}, \textsf{quotchap}, \textsf{ragged2e}, \textsf{stabular}, \textsf{subfig}, \textsf{subfigure}, \textsf{supertabular}, \textsf{xtab}, \textsf{tabls}, \textsf{tabulary}, \textsf{PGF \&\ TIKZ}, \textsf{tocbibind}, \textsf{tocloft}, \textsf{tocstyle}, \textsf{wrapfig}, \textsf{xcolor}, \textsf{xltxtra} packages, \textsf{amsart}, \textsf{amsbook}, \textsf{artikel1}, \textsf{artikel2}, \textsf{artikel3}, \textsf{extarticle}, \textsf{standrad article}, \textsf{boek}, \textsf{boek3}, \textsf{standard book}, \textsf{bookest}, \textsf{extbook}, \textsf{extletter}, \textsf{scrlettr},\textsf{standard letter}, \textsf{memoir}, \textsf{extreport}, \textsf{rapport1}, \textsf{rapport3}, \textsf{refrep}, \textsf{standard report}, \textsf{scartcl}, \textsf{scrbook}, \textsf{scrreprt} classes and any other packages and classes that relies on these packages and classes. This means, you can use all these packages and classes in addition to other packages and classes that rely on these packages and classes and use their functionality fully for your bidirectional documents.
We now give some details that you should know about the supported packages or classes.
\subsection{Color}
@@ -574,4 +600,38 @@ When footnotes are typeset RTL, \Lcs{if@RTL@footnote} is true and when footnotes
\item \Lcs{save@dir}, if the direction of typesetting is RTL, defines \Lcs{saved@@dir} to be RTL and if the direction of typesetting is LTR, defines \Lcs{saved@@dir} to be LTR.
\item \Lcs{reset@dir}, if \Lcs{saved@@dir} is defined as RTL, inserts \Lcs{setRTL} otherwise, if \Lcs{saved@@dir} is defined as LTR, inserts \Lcs{setLTR}, otherwise does nothing.
\end{itemize}
+\part{Implementation}
+In this section, we describe the implementation of bidi package in whole.
+\lstset{firstnumber=last}
+\lstset{language=[LaTeX]Tex,
+ keywordstyle=\color{mygreen},
+ basicstyle=\normalfont\ttfamily,
+ commentstyle=\color{blue}\ttfamily,
+ stringstyle=\rmfamily,
+ numbers=none,
+ numberstyle=\scriptsize,
+ stepnumber=5,
+ numbersep=8pt,
+ showstringspaces=false,
+ breaklines=true,
+ frameround=ftff,
+ frame=none,
+ backgroundcolor=\color{white}
+}
+\lstset{numbers=left,
+ numberstyle=\scriptsize,
+ stepnumber=1,
+ numbersep=8pt
+}
+\lstset{morekeywords={bididate,bidiversion,bidicommit}}
+\section{File \textsf{bidi.sty}}
+\begin{lstlisting}[firstnumber=1]
+\NeedsTeXFormat{LaTeX2e}
+\end{lstlisting}
+Here we define the date, version number and commit number of the package.
+\begin{lstlisting}
+\def\bididate{2010/07/25}
+\def\bidiversion{v1.1.0}
+\def\bidicommit{commit 44}
+\end{lstlisting}
\end{document}
diff --git a/Master/texmf-dist/doc/latex/bidi/bidi.tex b/Master/texmf-dist/doc/latex/bidi/bidi.tex
index d964d1fa2fd..3e994d62e09 100644
--- a/Master/texmf-dist/doc/latex/bidi/bidi.tex
+++ b/Master/texmf-dist/doc/latex/bidi/bidi.tex
@@ -10,7 +10,7 @@
%%
\def\bididate{2010/07/25}
\def\bidiversion{v0.1}
-\def\bidicommit{commit 54}
+\def\bidicommit{commit 64}
\catcode`@=11
\edef\bidiinfo{%
bidi package (Support for bidirectional typesetting in plain TeX and LaTeX)^^J