diff options
author | Karl Berry <karl@freefriends.org> | 2010-10-11 00:15:03 +0000 |
---|---|---|
committer | Karl Berry <karl@freefriends.org> | 2010-10-11 00:15:03 +0000 |
commit | ea0ac2d1bc725a9e159c3709bc8e775d77dc65bd (patch) | |
tree | 3a5d0fc88ff32f76f3c6e0bba488d0251b4213bd /Master/texmf-dist/doc | |
parent | e8dde3fdf371b3f9c7443830b0613ad123cc735b (diff) |
bidi update (10oct10)
git-svn-id: svn://tug.org/texlive/trunk@20046 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc')
-rw-r--r-- | Master/texmf-dist/doc/latex/bidi/README | 79 | ||||
-rw-r--r-- | Master/texmf-dist/doc/latex/bidi/bibitem.pdf | bin | 2936 -> 0 bytes | |||
-rw-r--r-- | Master/texmf-dist/doc/latex/bidi/bidi-doc.pdf | bin | 144521 -> 0 bytes | |||
-rw-r--r-- | Master/texmf-dist/doc/latex/bidi/bidi-doc.tex | 653 | ||||
-rw-r--r-- | Master/texmf-dist/doc/latex/bidi/bidi.pdf | bin | 0 -> 1503004 bytes | |||
-rw-r--r-- | Master/texmf-dist/doc/latex/bidi/bidisample2e.tex | 1 | ||||
-rw-r--r-- | Master/texmf-dist/doc/latex/bidi/bidismall2e.tex | 3 | ||||
-rw-r--r-- | Master/texmf-dist/doc/latex/bidi/presentation-sample.tex | 2 | ||||
-rw-r--r-- | Master/texmf-dist/doc/latex/bidi/test-arydshln.tex | 2 | ||||
-rw-r--r-- | Master/texmf-dist/doc/latex/bidi/test-brochure.tex | 138 | ||||
-rw-r--r-- | Master/texmf-dist/doc/latex/bidi/test-color.tex | 5 | ||||
-rw-r--r-- | Master/texmf-dist/doc/latex/bidi/test3-wrapfig.tex | 2 |
12 files changed, 131 insertions, 754 deletions
diff --git a/Master/texmf-dist/doc/latex/bidi/README b/Master/texmf-dist/doc/latex/bidi/README index cfa28022a4b..07d61a98e39 100644 --- a/Master/texmf-dist/doc/latex/bidi/README +++ b/Master/texmf-dist/doc/latex/bidi/README @@ -1,19 +1,80 @@ -_________________ +___________________ The bidi package -v1.1.4c +v1.1.5a 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.4b. +This version fixes all the bugs that were present in v1.1.4c. -Note: The image ctg.jpg is in public domain (a public domain -artwork from iranpoliticsclub.net) and taken from +Note: The image ctg.jpg is in public domain (a public domain +artwork from iranpoliticsclub.net) and taken from http://iranpoliticsclub.net/culture-language/PIY/images/Cyrus%20The%20Great%20face.jpg -______________ +___________________ Vafa Khalighi -vafakh84@gmail.com +vafakhlgh@gmail.com -Copyright 2007-2010 -Distributed under the LaTeX Project Public License +Copyright © 2007–2010 +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 + +This work is “author-maintained” (as per LPPL maintenance status) +by Vafa Khalighi. + +In addition to the terms of LPPL any distributed version +(unchanged or modified) of bidi has to keep the statement +about the moral obligation for using bidi. In case of major +changes where this would not be appropriate the author of the +changed version should contact the copyright holder. + +Moral obligation for using bidi: +____________________________________ + +Users of bidi who wish to include or use bidi or a modified +version in a proprietary and commercially market product are asked +under certain conditions (see below) for the payment of a license +fee. The size of this fee is to be determined, in each instance, +by the commercial user, depending on his/her judgment of the value of +bidi for his/her product. + +The conditions for this are as follows: + +The producer of a proprietary and commercially market product +that involves typesetting using bidi is asked to determine +the value of a license fee for using bidi if + + - the product is a document and the producer has decided to + include bidi to typeset (parts of) the document or has + directed the author of the document to include bidi (for + example, by providing a class file to be used by the author) + + - the product is a LaTeX class or package that includes bidi + +There is no moral obligation in case + + - the product is a document but producer has not directed + the author to include bidi (in that case the moral obligation + lies with the author of the document) + + - the product does not involve typesetting, e.g., consists, for + example, of distributing bidi and its documentation. + + - the product is not proprietary, i.e., is made available as free + software itself (which doesn't prohibit its commercial marketing) + + - bidi is used for non-commercial purposes + +Determinating a license fee might result in a license fee of zero +(i.e., no payment) in case a producer has determined that the use +of bidi has no enhancing effect on the product. This is a +plausible scenario, i.e., in the above two cases the producer is +only asked to evaluate the value of bidi for the product +not for the payment of a license fee per se (which might or might +not follow from this evaluation). + + The license fee, if any, can be payed to the author of + the program who can be contacted at + + vafakhlgh@gmail.com diff --git a/Master/texmf-dist/doc/latex/bidi/bibitem.pdf b/Master/texmf-dist/doc/latex/bidi/bibitem.pdf Binary files differdeleted file mode 100644 index 49191743021..00000000000 --- a/Master/texmf-dist/doc/latex/bidi/bibitem.pdf +++ /dev/null diff --git a/Master/texmf-dist/doc/latex/bidi/bidi-doc.pdf b/Master/texmf-dist/doc/latex/bidi/bidi-doc.pdf Binary files differdeleted file mode 100644 index 2cabf2e0263..00000000000 --- a/Master/texmf-dist/doc/latex/bidi/bidi-doc.pdf +++ /dev/null diff --git a/Master/texmf-dist/doc/latex/bidi/bidi-doc.tex b/Master/texmf-dist/doc/latex/bidi/bidi-doc.tex deleted file mode 100644 index 7c5a9f76670..00000000000 --- a/Master/texmf-dist/doc/latex/bidi/bidi-doc.tex +++ /dev/null @@ -1,653 +0,0 @@ -\documentclass{artikel3} -\usepackage{graphicx,wrapfig} -\usepackage{calc} -\usepackage{pifont} -\usepackage{bbding} -\usepackage[colorlinks=true,linkcolor=mybrown,urlcolor=mygreen]{hyperref} -\usepackage{bidicode} -\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} -\definecolor{mybrown}{rgb}{.6,0,0} -\definecolor{mygreen}{rgb}{0,.43,0} -\definecolor{Orange}{rgb}{1,.4,.2} -\newcommand\XeTeX{Xe\TeX} -\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.4c} -\begin{document} -\maketitle -\part*{Dedication} -\textit{We dedicate the \textsf{bidi} package to our \textbf{father}, \textbf{Cyrus The Great}.} -\textbf{Cyrus the Great} (c. 600 BC or 576 BC – December 530 BC), also known as \textbf{Cyrus II} or \textbf{Cyrus of Persia}, was the first Zoroastrian Persian emperor. He was the founder of the Persian Empire under the Achaemenid dynasty. - -\begin{wrapfigure}{l}{0.5\textwidth} -\centering -\fbox{\includegraphics{ctg}} - \caption{Portrait of Cyrus The Great} -\end{wrapfigure} - -It was under his own rule that the empire embraced all previous civilized states of the ancient Near East, expanded vastly and eventually conquered most of Southwest Asia and much of Central Asia, from Egypt and the Hellespont in the west to the Indus River in the east, to create the largest empire the world had yet seen. - -The reign of Cyrus lasted 29 to 31 years. Cyrus built his empire by fighting and conquering first the Median Empire, then the Lydian Empire and the Neo-Babylonian Empire. Either before or after Babylon, he led an expedition into central Asia, which resulted in major campaigns that brought ``into subjection every nation without exception." Cyrus did not venture into Egypt, as he himself died in battle, fighting the Massagetae along the Syr Darya in December 530 BC. He was succeeded by his son, Cambyses II, who managed to add to the empire by conquering Egypt, Nubia, and Cyrenaica during his short rule. - -As a military leader, Cyrus left a legacy on the art of leadership and decision making, and he attributed his success to ``Diversity in counsel, unity in command.'' Cyrus the Great respected the customs and religions of the lands he conquered. It is said that in universal history, the role of the Achaemenid empire founded by Cyrus lies in its very successful model for centralized administration and establishing a government working to the advantage and profit of its subjects. In fact, the administration of the empire through satraps and the vital principle of forming a government at Pasargadae were the work of Cyrus. Aside from his own nation, Iran, Cyrus also left a lasting legacy on Jewish religion (through his Edict of Restoration), human rights, politics, and military strategy, as well as on both Eastern and Western civilizations. -\tableofcontents -\part{User Guide} -\section{Introduction} -\textsf{bidi} provides a convenient interface for typesetting bidirectional texts in plain \TeX\ and \LaTeX. - -The \textsf{bidi} package at the moment only works with \XeTeX\ engine, but we will support other \TeX\ engines as well in the future. -\subsection{\textsf{bidi} Info On The Terminal and In The Log File} -If you use \textsf{bidi} package to write any input \TeX\ document, and then run \texttt{xelatex} on your document, \textsf{bidi} writes some information about itself to the terminal and to the log file. The information is something like: -\begin{lstlisting}[numbers=none,backgroundcolor=\color{skugga}] -bidi package (Support for bidirectional typesetting in plain TeX and LaTeX) -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.4c, <commit 80>, 2010/08/01 -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 -\end{lstlisting} -\section{Basics} -\subsection{Loading The Package} -You can load the package in the ordinary way; -\begin{BDef} -\Lcs{usepackage}\OptArgs\Largb{bidi} -\end{BDef} -Where \texttt{options} of the package are explained later in \autoref{options}. - -When loading the package, it is important to know that: -\begin{enumerate} -\item \textsf{bidi} should be the last package that you load, because otherwise you are certainly going to overwrite \textsf{bidi}'s definitions and consequently, you will not get the expected output. -\item In fact, \textsf{bidi} makes sure that some specific packages are loaded before \textsf{bidi}; these are those packages that \textsf{bidi} modifies them for bidirectional typesetting. - -If you load \textsf{bidi} before any of these packages, then you will get an error saying that you should load \textsf{bidi} as your last package. - -For instance, consider the following minimal example: -\begin{lstlisting} -\documentclass{minimal} -\usepackage{bidi} -\usepackage{graphicx} -\begin{document} -This is just a test. -\end{document} -\end{lstlisting} -Where \textsf{graphicx} is loaded after \textsf{bidi}. If you run \texttt{xelatex} on this document, you will get an error which looks like this: -\begin{lstlisting}[numbers=none,backgroundcolor=\color{skugga}] -! Package bidi Error: Oops! you have loaded package graphicx after bidi package -. Please load package graphicx before bidi package, and then try to run xelatex - on your document again. - -See the bidi package documentation for explanation. -Type H <return> for immediate help. - ... - -l.4 \begin{document} - -? - -\end{lstlisting} -\end{enumerate} -\subsection{Commands for Version number, Mercurial commit number and Date of The Package} -\begin{BDef} -\Lcs{bidiversion}\quad\Lcs{bidicommit}\quad\Lcs{bididate} -\end{BDef} -\begin{itemize} -\item \Lcs{bidiversion} gives the current version of the package. -\item \Lcs{bidicommit} gives the current Mercurial commit number of the package. -\item \Lcs{bididate} gives the current date of the package. -\end{itemize} -\begin{lstlisting}[morekeywords={bidiversion,bidicommit,bididate}] -\documentclass{article} -\usepackage{bidi} -\begin{document} -This is typeset by \textsf{bidi} package, \bidiversion, \bidicommit, \bididate. -\end{document} -\end{lstlisting} -\subsection{Options of The Package\label{options}} -There are two options, namely \texttt{RTLdocument} and \texttt{rldocument}, which are essentialy equivalent. If you pass any of these options to the package, you will be typesetting a document containing mainly RTL texts with some LTR texts. These options activate \Lcs{setRTL} (explained in \autoref{PSC}), \Lcs{RTLdblcol} (explained in \autoref{twocolumn}) and \Lcs{autofootnoterule} (explained in \autoref{footnoterule}). - -It is clear that if you do not pass any of these options to the package, you will be typesetting a document containing mainly LTR texts with some RTL texts. -\subsection{Paragraph Switching Commands\label{PSC}} -\begin{BDef} -\Lcs{setLTR}\quad\Lcs{setLR}\quad\Lcs{unsetRL}\quad\Lcs{unsetRTL}\\ -\Lcs{setRTL}\quad\Lcs{setRL}\quad\Lcs{unsetLTR} -\end{BDef} -\begin{itemize} -\item With any of the commands in the first row, you can typeset LTR paragraphs. -\item With any of the commands in the second row, you can typeset RTL paragraphs. -\end{itemize} -\begin{lstlisting} -\documentclass{article} -\usepackage{bidi} -\begin{document} -\setRTL% -Anyone who reads Old and Middle English literary texts will be - familiar with the mid-brown volumes of the EETS, with the symbol - of Alfred's jewel embossed on the front cover. - -\setLTR% Notice the blank line before \setLTR -Anyone who reads Old and Middle English literary texts will be - familiar with the mid-brown volumes of the EETS, with the symbol - of Alfred's jewel embossed on the front cover. -\end{document} -\end{lstlisting} -\subsection{Pargraph Switching Environments} -\begin{BDef} -\LBEG{LTR}\quad\Larga{text}\quad\LEND{LTR}\\ -\LBEG{RTL}\quad\Larga{text}\quad\LEND{RTL} -\end{BDef} -\begin{itemize} -\item With \texttt{LTR} environment, you can typeset LTR paragraphs. -\item With \texttt{RTL} environment, you can typeset RTL paragraphs. -\end{itemize} -\begin{lstlisting} -\documentclass{article} -\usepackage{bidi} -\begin{document} -\begin{RTL} -Anyone who reads Old and Middle English literary texts will be familiar - with the mid-brown volumes of the EETS, with the symbol - of Alfred's jewel embossed on the front cover. -\begin{LTR} -Anyone who reads Old and Middle English literary texts will be familiar - with the mid-brown volumes of the EETS, with the symbol - of Alfred's jewel embossed on the front cover. -\end{LTR} -And we are still typesetting RTL. -\end{RTL} -\end{document} -\end{lstlisting} -\subsection{Typesetting Short LTR and RTL Texts} -\begin{BDef} -\Lcs{LRE}\Largb{\Larga{text}}\quad\Lcs{LR}\Largb{\Larga{text}}\\ -\Lcs{RLE}\Largb{\Larga{text}}\quad\Lcs{RL}\Largb{\Larga{text}} -\end{BDef} -\begin{itemize} -\item With any of the commands in the first row, you can typeset short LTR text inside RTL paragraphs. -\item With any of the commands in the second row, you can typeset short RTL text inside LTR paragraphs. -\end{itemize} -\begin{lstlisting} -\begin{document} -\begin{RTL} -Anyone who reads Old and Middle English \LRE{Short LTR text} literary texts will be familiar - with the mid-brown volumes of the EETS, with the symbol - of Alfred's jewel embossed on the front cover. -\begin{LTR} -Anyone who reads Old and Middle English \RLE{Short RTL text} literary texts will be familiar - with the mid-brown volumes of the EETS, with the symbol - of Alfred's jewel embossed on the front cover. -\end{LTR} -\end{RTL} -\end{document} -\end{lstlisting} -\subsection{Footnotes} -\begin{BDef} -\Lcs{footnote}\OptArg{num}\Largb{\Larga{text}}\quad\Lcs{LTRfootnote}\OptArg{num}\Largb{\Larga{text}}\quad\Lcs{RTLfootnote}\OptArg{num}\Largb{\Larga{text}}\\ -\Lcs{setfootnoteRL}\quad\Lcs{setfootnoteLR}\quad\Lcs{unsetfootnoteRL}\\ -\Lcs{thanks}\Largb{\Larga{text}}\quad\Lcs{LTRthanks}\Largb{\Larga{text}}\quad\Lcs{RTLthanks}\Largb{\Larga{text}} -\end{BDef} -\begin{itemize} -\item \Lcs{footnote} in RTL mode produces an RTL footnote while in LTR mode it produces an LTR footnote. -\item \Lcs{LTRfootnote} will always produce an LTR footnote, independent on the current mode. -\item \Lcs{RTLfootnote} will always produce an RTL footnote, independent on the current mode. -\item Specifying a \Lcs{setfootnoteRL} command anywhere will make \Lcs{footnote} produce an RTL footnote. -\item Specifying either a \Lcs{setfootnoteLR} or an \Lcs{unsetfootnoteRL} command anywhere will make \Lcs{footnote} produce an LTR footnote. -\item \Lcs{thanks} (to be used only inside \Lcs{author} or \Lcs{title} argument) in RTL mode produces an RTL footnote while in LTR mode it produces an LTR footnote. -\item \Lcs{LTRthanks} (to be used only inside \Lcs{author} or \Lcs{title} argument) will always produce an LTR footnote, independent on the current mode. -\item \Lcs{RTLthanks} (to be used only inside \Lcs{author} or \Lcs{title} argument) will always produce an RTL footnote, independent on the current mode. -\end{itemize} -\begin{BDef} -\Lcs{footnotetext}\OptArg{num}\Largb{\Larga{text}}\quad\Lcs{LTRfootnotetext}\OptArg{num}\Largb{\Larga{text}}\\ -\Lcs{RTLfootnotetext}\OptArg{num}\Largb{\Larga{text}} -\end{BDef} -\begin{itemize} -\item \Lcs{footnotetext} used in conjunction with \Lcs{footnotemark}, in RTL mode produces an RTL footnote while in LTR mode it produces an LTR footnote. -\item \Lcs{LTRfootnotetext} used in conjunction with \Lcs{footnotemark}, will always produce an LTR footnote, independent on the current mode. -\item \Lcs{RTLfootnotetext} used in conjunction with \Lcs{footnotemark}, will always produce an RTL footnote, independent on the current mode. -\end{itemize} -\subsubsection{Footnote Rule\label{footnoterule}} -The behavior of footnote rules can also be controlled. -\begin{BDef} -\Lcs{autofootnoterule}\quad\Lcs{rightfootnoterule}\quad\Lcs{leftfootnoterule}\\ -\Lcs{LRfootnoterule}\quad\Lcs{textwidthfootnoterule} -\end{BDef} -\begin{itemize} -\item \Lcs{autofootnoterule} will draw the footnote rule right or left aligned based on the direction of the first footnote following the rule (i.e., put in the current page). -\item \Lcs{rightfootnoterule} will put footnote rule on the right-hand side. -\item \Lcs{leftfootnoterule} or \Lcs{LRfootnoterule} will put footnote rule on the left-hand side. -\item \Lcs{textwidthfootnoterule} will draw the footnote rule with a width equal to \Lcs{textwidth}. -\end{itemize} -\subsection{Two Column Typesetting\label{twocolumn}} -\begin{BDef} -\Lcs{RTLdblcol}\quad\Lcs{LTRdblcol} -\end{BDef} -If you pass the \texttt{twocolumn} option to the class file and if the main direction of the document is RTL, then you get RTL two column and if the main direction of the document is LTR, then you get LTR two column. In addition, \Lcs{RTLdblcol} allows you to have RTL two column typesetting and \Lcs{LTRdblcol} allows you to have LTR two column typesetting as the options of the class file. -\subsection{RTL cases} -\begin{BDef} -\Lcs{rcases}\Largb{\Lcs{text}\Largb{\Larga{brach1}}\Lcs{cr}\Lcs{text}\Largb{\Larga{brach2}}\Lcs{cr}% -\Lcs{text}\Largb{\Larga{brach3}}\ldots}\\ -\Lcs{text}\Largb{\Larga{main}} -\end{BDef} -\Lcs{rcases} is defined in bidi for typesetting RTL cases. \Lcs{text} is defined in \textsf{amsmath} package, so this means that you need to load \textsf{amsmath} package too. -\begin{lstlisting}[morekeywords={rcases,text}] -\documentclass{article} -\usepackage{amsmath} -\usepackage{bidi} -\begin{document} -\setRTL -\[\rcases{\text{men}\cr\text{women}} -\text{Humans Beings} -\] -\end{document} -\end{lstlisting} -\subsection{Typesetting Logos} -\begin{BDef} -\Lcs{XeTeX}\quad\Lcs{XeLaTeX} -\end{BDef} -\textsf{bidi} defines \XeTeX\ and \XeLaTeX\ logos and in addition, it makes sure that logos, \TeX, \LaTeX, \LaTeXe\ are typeset LTR. -\subsection{Separation Mark} -\begin{BDef} -\Lcs{SepMark}\Largb{\Larga{mark}}\quad\Lcs{@SepMark} -\end{BDef} -Generally in Standard \LaTeX, dot is used for separation between section numbers, equation numbers any anything else which needs to be seperated. You can use \Lcs{SepMark} to use any other mark as the seperation mark instead a dot. -\begin{lstlisting}[morekeywords={SepMark,subsection,subsubsection}] -\documentclass{article} -\usepackage{bidi} -\SepMark{-} -\begin{document} -\section{First} -\subsection{Second} -\subsubsection{Third} -\end{document} -\end{lstlisting} - -If you decide to change the numbering of chapters, sections, subsections, equations, figures and \ldots, you should either load \textsf{amsmath} package and use \Lcs{numberwithin} macro to do this or do the ordinary way, but instead dot write \Lcs{@SepMark}. Using dot instead \Lcs{@SepMark} will certainly make trouble. - -\begin{lstlisting}[morekeywords={theequation,thesection,SepMark}] -\documentclass{article} -\usepackage{bidi} -\SepMark{-} -\makeatletter -\renewcommand\theequation{\thesection\@SepMark\@arabic\c@equation} -\makeatother -\begin{document} -\section{First} -\begin{equation} -x^2+y^2=z^2 -\end{equation} -\end{document} -\end{lstlisting} -\subsection{\Lcs{raggedright}, \Lcs{raggedleft} commands, \texttt{flushleft} and \texttt{flushright} Environments} -\Lcs{raggedright} command and \texttt{flushleft} environment put the text on the left hand side and \Lcs{raggedleft} command and \texttt{flushright} environment put the text on the right hand side, independent on the current mode. -\subsection{Primitive-like commands} -\begin{BDef} -\Lcs{hboxR}\quad\Lcs{hboxL}\quad\Lcs{vboxR}\quad\Lcs{vboxL} -\end{BDef} -\begin{itemize} -\item The syntax of \Lcs{hboxR} is exatly the same as the syntax of \Lcs{hbox}, but its contents is always typeset RTL. -\item The syntax of \Lcs{hboxL} is exatly the same as the syntax of \Lcs{hbox}, but its contents is always typeset LTR. -\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} -\documentclass{article} -\begin{document} -Anyone who reads Old and Middle English literary texts will be familiar with the mid-brown volumes of the EETS, with the symbol of Alfred's -\begin{enumerate} -\item Anyone who reads Old and Middle English literary texts will be familiar with the mid-brown volumes of the EETS, with the symbol of Alfred's -\item Anyone who reads Old and Middle English literary texts will be familiar with the mid-brown volumes of the EETS, with the symbol of Alfred's -\end{enumerate} -\end{document} -\end{lstlisting} -However if the above example becomes bidirectional, as shown below: -\begin{lstlisting} -\documentclass{article} -\usepackage{bidi} -\begin{document} -Anyone who reads Old and Middle English literary texts will be familiar with the mid-brown volumes of the EETS, with the symbol of Alfred's -\begin{enumerate} -\item Anyone who reads Old and Middle English literary texts will be familiar with the mid-brown volumes of the EETS, with the symbol of Alfred's -\setRTL -\item Anyone who reads Old and Middle English literary texts will be familiar with the mid-brown volumes of the EETS, with the symbol of Alfred's -\end{enumerate} -\end{document} -\end{lstlisting} -Then some people may argue that this typographically does not look promising. For this purpose, \textsf{RTLitems} environment is provided which has the following syntax: -\begin{BDef} -\LBEG{RTLitems}\OptArg{length}\\ -\quad\Lcs{item} \Larga{text}\\ -\quad\ldots\\ -\LEND{RTLitems} -\end{BDef} -Where \OptArg{length} is optional and if you do not give it, the value of \Lcs{rightskip} will be equal to the value of \Lcs{labelwidth}\(+\)\Lcs{labelsep} by default and if you give this optional length, then the value of \Lcs{rightskip} will be equal to the value of \Lcs{labelwidth}\(+\)\Larg{given length}. Thus by using the \textsf{RTLitems} environment, the previous example will look like the following: -\begin{lstlisting} -\documentclass{article} -\usepackage{bidi} -\begin{document} -Anyone who reads Old and Middle English literary texts will be familiar with the mid-brown volumes of the EETS, with the symbol of Alfred's -\begin{enumerate} -\item Anyone who reads Old and Middle English literary texts will be familiar with the mid-brown volumes of the EETS, with the symbol of Alfred's -\begin{RTLitems} -\item Anyone who reads Old and Middle English literary texts will be familiar with the mid-brown volumes of the EETS, with the symbol of Alfred's -\end{RTLitems} -\end{enumerate} -\end{document} -\end{lstlisting} -Similarly, \textsf{LTRitems} environment is defined which has the following syntax: -\begin{BDef} -\LBEG{LTRitems}\OptArg{length}\\ -\quad\Lcs{item} \Larga{text}\\ -\quad\ldots\\ -\LEND{LTRitems} -\end{BDef} -Where \OptArg{length} is optional and if you do not give it, the value of \Lcs{leftskip} will be equal to the value of \Lcs{labelwidth}\(+\)\Lcs{labelsep} by default and if you give this optional length, then the value of \Lcs{leftskip} will be equal to the value of \Lcs{labelwidth}\(+\)\Larg{given length}. -\subsection{\Lcs{setLTRbibitems}, \Lcs{setRTLbibitems}, and \Lcs{setdefaultbibitems} commands} -\begin{BDef} -\Lcs{setLTRbibitems}\quad\Lcs{setRTLbibitems}\quad\Lcs{setdefaultbibitems} -\end{BDef} -\begin{itemize} -\item If your whole \textsf{thebibliography} environment is inside RTL mode, but all your \Lcs{bibitem}s are LTR and you actually want to have \Lcs{bibname} to appear on the RHS, you can use \Lcs{setLTRbibitems} command before \textsf{thebibliography} environment. -\item If your whole \textsf{thebibliography} environment is inside LTR mode, but all your \Lcs{bibitem}s are RTL and you actually want to have \Lcs{bibname} to appear on the LHS, you can use \Lcs{setRTLbibitems} command before \textsf{thebibliography} environment. -\item \Lcs{setdefaultbibitems} is the default, when your \Lcs{bibitems} are a mixture of LTR and RTL and it does not matter what mode (LTR or RTL) your \textsf{thebibliography} environment is in. Please note that you do not have to use \Lcs{setdefaultbibitems} command in this case at all. - -Consider an example that your \textsf{thebibliography} environment is inside LTR mode and you have, say two \Lcs{bibitem}s. The first \Lcs{bibitem} is LTR and the second \Lcs{bibitem} is RTL. One could typeset this senario as shown below: -\begin{lstlisting} -\documentclass{article} -\usepackage{bidi} -\begin{document} -\begin{thebibliography}{99} -\bibitem This is the first bibitem which is LTR. -\begin{RTLitems} -\bibitem This is the second bibitem which is RTL. -\end{RTLitems} -\end{thebibliography} -\end{document} -\end{lstlisting} -\end{itemize} - -\subsection{Typesetting margin par} -By default, in RTL mode, \Lcs{marginpar} appears on LHS and its content is typeset RTL and in LTR mode, \Lcs{marginpar} appears on RHS and its content is typeset LTR. In addition, the three following commands are provided: -\begin{BDef} -\Lcs{setRTLmarginpar}\quad\Lcs{setLTRmarginpar}\quad\Lcs{setdefaultmarginpar} -\end{BDef} -\begin{itemize} -\item \Lcs{setRTLmarginpar} always makes \Lcs{marginpar} to appear on LHS and the content of \Lcs{marginpar} is typeset RTL (this is independent of the current mode). -\item \Lcs{setLTRmarginpar} always makes \Lcs{marginpar} to appear on RHS and the content of \Lcs{marginpar} is typeset LTR (this is independent of the current mode). -\item \Lcs{setdefaultmarginpar} gives the default behaviour of \Lcs{marginpar} as described above. -\end{itemize} -\subsection{Typesetting of Headers and Footers} -If the main direction of the document is RTL, then headers and footers are typeset RTL and if the main direction of the document is LTR, then headers and footers are typeset LTR. -\subsection{Tabular Typesetting} -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{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} -You can use \textsf{color} and \textsf{xcolor} packages to typeset texts in colours and colour boxes produced by \Lcs{colorbox} and \Lcs{fcolorbox} commands. Please note that your Coloured text should not span more than a line, if your text spans more than a line, you will be in trouble which means your whole document, page or paragraph may be coloured. If your texts spans more than a line, then you should use \textsf{xecolour} package. - -Also if you are going to use \Lcs{color} command to colour the text at the beginning of a paragraph, then you should have \Lcs{leavevmode} before \Lcs{color} command. - -For having coloured tabular, you can use \textsf{colortbl} package. -\subsection{Hyperref} -The \textsf{hyperref} package works fine with bidirectional documents if and only if, your link will not span more than a line. If your link spans more than a line, then your whole document, or page or paragraph may be linked. - - -\subsection{\textsf{flowfram} Package} -You can use \textsf{flowfram} package for your bidirectional documents. Please note that \textsf{flowfram} package provides support for bidirectional column typesetting, for details, see its manual. -\subsection{Multicolumn Typesetting} -In the previous versions of \textsf{bidi} package, it was recommended that you need to use \textsf{fmultico} package instead the original \textsf{multicol} package for RTL multicolumn typesetting. This is not the case any more and you should not use buggy \textsf{fmultico} package any more. Simply load the original \textsf{multicol} package before loading \textsf{bidi}. \textsf{bidi} now supports \textsf{multicol} package and you can typeset bidirectional multi columns. - -In addition, you also can use \textsf{vwcol} package for variable width bidirectional column typesetting. -\section{Extra \textsf{bidi} Packages and Classes} -\subsection{The Issue of Footnote} -In standard \LaTeX\, you can not use footnotes inside \Lcs{chapter}, \Lcs{part}, \Lcs{section}, \Lcs{subsection}, \Lcs{subsection} and any other section-like commands, \Lcs{caption} and tabular environment. - -\textsf{bidi} package provides \textsf{bidiftnxtra} package that solves the issue of footnote in standard \LaTeX. \textsf{bidiftnxtra} package should be loaded after \textsf{bidi} package. -\subsection{Typesetting Poems} -The \textsf{bidi} package provides \textsf{bidipoem} package for typesetting Persian poems. It provides four environments, \texttt{traditionalpoem}, \texttt{modernpoem} and starred version of these. In the starred version of these environments you do not need to type {\ttfamily\symbol{92}\symbol{92}} and that is the only difference with the normal version of the environments. The \texttt{traditionalpoem} environment and its starred version are also useful for typesetting Classic Arabic poetry, in fact this package may also be useful for other RTL languages. - -When using \textsf{bidipoem} package, at least you need to run \texttt{xelatex} twice on your document. In fact, if you run \texttt{xelatex} just once on your document, you get a message saying ``Unjustified poem. Rerun \texttt{XeLaTeX} to get poem right''. - -When you typeset your poems, you might get underfull \Lcs{hbox} messages. This is absolutely normal and if you want to get rid of these underfull \Lcs{hbox} messages, then you would need to use Kashida. - -If you need to change the default distance between two verses, you can do just that by: -\begin{BDef} -\Lcs{renewcommand}\Lcs{poemcolsepskip}\Largb{\Larga{length}} -\end{BDef} -\begin{BDef} -\LBEG{traditionalpoem}\\ -\Larga{verse1}\texttt{\&}\Larga{verse2}{\ttfamily\symbol{92}\symbol{92}}\\ -\Larga{verse3}\texttt{\&}\Larga{verse4}{\ttfamily\symbol{92}\symbol{92}}\\ -\ldots\\ -\LEND{traditionalpoem} -\end{BDef} -\begin{BDef} -\LBEG{traditionalpoem*}\\ -\Larga{verse1}\texttt{\&}\Larga{verse2}\\ -\Larga{verse3}\texttt{\&}\Larga{verse4}\\ -\ldots\\ -\LEND{traditionalpoem*} -\end{BDef} -\subsection{Typesetting Resum\'e} -The \textsf{bidi} package provides \textsf{bidimoderncv}\footnote{This class is the modified version of \textsf{moderncv} class.} class for typesetting resum\'es. There are two examples, namely \texttt{test-casualcv.tex} and \texttt{test-classiccv.tex}, in the \textsf{doc} folder than you can look and learn how you can use it. -\subsection{Print Two Pages On A Single Page} -\textsf{bidi} package provides \textsf{bidi2in1} package for printing two pages on a single (landscape) A4 page. Page numbers appear on the included pages, and not on the landscape 'container' page. - -\subsection{Producing Presentations} -At the moment, there is only one class that you can prepare your presentations -with. - -\subsubsection{\textsf{bidipresentation} Class} -\textsf{bidipresentation} is a simple class for presentations to be shown on -screen or beamer. It is derived from \LaTeX's article class. The “virtual paper -size” of documents produced by this class: width=128mm, height=96mm. -\textsf{bidipresentation} requires that the \textsf{fancyhdr} and \textsf{geometry} packages -are available on the system. Enhancements to the \textsf{bidipresentation} -class are easily made available by other packages, these include slides with -a background from a bitmap (\textsf{eso-pic} package). - -\paragraph{Usage:} -The class is used with -\begin{BDef} -\Lcs{documentclass}\OptArgs\Largb{bidipresentation} -\end{BDef} - Options of the article class are also available to \textsf{bidipresentation}, e. g. - 10pt, 11pt, 12pt for selection of font size. However, not all options of the - article class will be appropriate for a presentation class, e. g. twocolumn. - -A simple example document: -\begin{lstlisting}[morekeywords={AddToShipoutPicture,includegraphics,distance}] - \documentclass[12pt]{bidipresentation} - \usepackage{eso-pic} - \usepackage[RTLdocument]{bidi} - \pagestyle{pres} - \AddToShipoutPicture{ - \includegraphics{gradient2.png} -} - \begin{document} - \begin{titlepage} -\centering - \distance{1} - { -\Huge \bfseries Title of the presentation \par -} - \vspace{1.3ex} \large - Author\\[2ex]Institution - \distance{2} - \end{titlepage} - \begin{plainslide}[Title of Page] -The first page -\end{plainslide} -\begin{rawslide} -The second page - \end{rawslide} -\end{document} -\end{lstlisting} -The title page can be created within the \texttt{titlepage} environment, the \Lcs{maketitle} -command is not available. Slides may be created with the \texttt{plainslide} environment, you may add the title of the slide with the optional parameter. The -contents of the slide are centered vertically. Another environment generating a slide is \texttt{rawslide}: slides are written without title, contents are not -vertically centered. - -The \Lcs{distance}\Largb{\Larga{number}} command allows to introduce vertical space into -slides constructed with the \texttt{rawslide} and \texttt{titlepage} environments. You should -use pairs of \Lcs{distance}\Largb{} commands with numbers indicating the relative -height of empty space, see the titlepage in the example above. - -Pictures can be included with the \Lcs{includegraphics} command of the \textsf{graphicx} package. Please be aware that the dimensions of the pages are 128mm $\times$ -96mm and therefore included graphics are scaled appropriately. - -\paragraph{Enhancements to \textsf{bidipresentation}:} - -\subparagraph{Fill background of a presentation with bitmaps:} -\textsf{eso-pic} package allows you to paint the background with a picture: -\begin{lstlisting}[morekeywords={AddToShipoutPicture,includegraphics}] -\usepackage{eso-pic} -... -\AddToShipoutPicture{ -\includegraphics{gradient2.png} -} -\end{lstlisting} -\Lcs{AddToShipoutPicture}\Largb{} puts the picture on every page, \Lcs{AddToShipoutPicture*}\Largb{} -puts it on to the current page, \Lcs{ClearShipoutPicture} clears the background -beginning with the current page. Details of \textsf{eso-pic}’s commands can be -found in its own documentation. - - - -\section{Some Useful Internal Macros} -There are some useful internal macros that might be helpful for you. This section, explains all these useful internals. -\subsection{RTL Conditional} -\begin{BDef} -\Lcs{if@RTL} -\end{BDef} -\Lcs{if@RTL} conditional is true inside RTL mode and it is false in LTR mode. -\subsection{Main RTL Conditional} -\begin{BDef} -\Lcs{if@RTLmain} -\end{BDef} -If the main direction of the document is RTL, \Lcs{if@RTLmain} is true and if the main direction of the document is LTR, \Lcs{if@RTLmain} is false. -\subsection{Latin Conditional} -\begin{BDef} -\Lcs{if@Latin} -\end{BDef} -\Lcs{if@Latin} inside any environment that uses Latin font is true and inside any environment that uses RTL font is false. -\subsection{Tags Internal Macro} -\begin{BDef} -\Lcs{@iftagsloaded}\Largb{\Larga{tags name}}\Largb{\Larga{do thing(s) if the tag is loaded}}\\ -\Largb{\Larga{do thing(s) if the tag is not loaded}} -\end{BDef} -As you can see, the syntax of \Lcs{@iftagsloaded} is exactly the same as the syntax of \Lcs{@ifpackageloaded} and \Lcs{@ifclassloaded}. By tags, we mean things like \texttt{leqno} or \texttt{reqno}. Please note that in the argument \Larga{tags name}, the extension \texttt{clo} should not be given. -\subsection{Definition File Loaded Internal Macro} -\begin{BDef} -\Lcs{@ifdefinitionfileloaded}\Largb{\Larga{definition file name}}\\ -\Largb{\Larga{do thing(s) if the definition file is loaded}}\\ -\Largb{\Larga{do thing(s) if the definition file is not loaded}} -\end{BDef} -As you can see, the syntax of \Lcs{@ifdefinitionfileloaded} is exactly the same as the syntax of \Lcs{@ifpackageloaded} and \Lcs{@ifclassloaded}. By definition file, we mean things like \texttt{hyperref-bidi.def} or \texttt{wrapfig-bidi.def}. Please note that in the argument \Larga{definition file name}, the extension \texttt{def} should not be given. -\subsection{Tabular Conditional} -\begin{BDef} -\Lcs{if@RTLtab} -\end{BDef} -If the tabular is typeset RTL, \Lcs{if@RTLtab} is true and if the tabular is typeset LTR, \Lcs{if@RTLtab} is false. -\subsection{Footnote Conditional} -\begin{BDef} -\Lcs{if@RTL@footnote} -\end{BDef} -When footnotes are typeset RTL, \Lcs{if@RTL@footnote} is true and when footnotes are typeset LTR, \Lcs{if@RTL@footnote} is false. -\subsection{Direction Ensuring Macros} -\begin{BDef} -\Lcs{@ensure@RTL}\Largb{\Larga{text}}\quad\Lcs{@ensure@RL}\Largb{\Larga{text}}\quad\Lcs{@ensure@LTR}\Largb{\Larga{text}}\\ -\Lcs{@ensure@LR}\Largb{\Larga{text}}\quad -\Lcs{@ensure@dir}\Largb{\Larga{text}}\quad\Lcs{@ensure@maindir}\Largb{\Larga{text}} -\end{BDef} -\begin{itemize} -\item \Lcs{@ensure@RTL} and \Lcs{@ensure@RL} internals make sure that \Larga{text} is always typeset RTL, independent on the current mode. -\item \Lcs{@ensure@LTR} and \Lcs{@ensure@LR} internals make sure that \Larga{text} is always typeset LTR, independent on the current mode. -\item \Lcs{@ensure@dir} and \Lcs{@ensure@maindir} if used in RTL mode, they put \Larga{text} inside \Lcs{RLE} and if used in LTR mode, they put the text as it is. -\end{itemize} -\subsection{Reset Direction Macro} -\begin{BDef} -\Lcs{save@dir}\quad\Lcs{saved@@dir}\quad\Lcs{reset@dir} -\end{BDef} -\begin{itemize} -\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.pdf b/Master/texmf-dist/doc/latex/bidi/bidi.pdf Binary files differnew file mode 100644 index 00000000000..ad0fd2b146d --- /dev/null +++ b/Master/texmf-dist/doc/latex/bidi/bidi.pdf diff --git a/Master/texmf-dist/doc/latex/bidi/bidisample2e.tex b/Master/texmf-dist/doc/latex/bidi/bidisample2e.tex index 4f791ead282..b05e6488567 100644 --- a/Master/texmf-dist/doc/latex/bidi/bidisample2e.tex +++ b/Master/texmf-dist/doc/latex/bidi/bidisample2e.tex @@ -1,4 +1,3 @@ - \documentclass{article} % Specifies the document class \usepackage[RTLdocument]{bidi} % The preamble begins here. diff --git a/Master/texmf-dist/doc/latex/bidi/bidismall2e.tex b/Master/texmf-dist/doc/latex/bidi/bidismall2e.tex index 16a02e49240..ea4c975d485 100644 --- a/Master/texmf-dist/doc/latex/bidi/bidismall2e.tex +++ b/Master/texmf-dist/doc/latex/bidi/bidismall2e.tex @@ -1,6 +1,3 @@ - - - \documentclass{article} % Your input file must contain these two lines \usepackage[RTLdocument]{bidi} \begin{document} % plus the \end{document} command at the end. diff --git a/Master/texmf-dist/doc/latex/bidi/presentation-sample.tex b/Master/texmf-dist/doc/latex/bidi/presentation-sample.tex index e562e9d83e9..c82e05fc44b 100644 --- a/Master/texmf-dist/doc/latex/bidi/presentation-sample.tex +++ b/Master/texmf-dist/doc/latex/bidi/presentation-sample.tex @@ -4,7 +4,6 @@ \usepackage[RTLdocument]{bidi} \pagestyle{pres} - \begin{document} \begin{titlepage} \distance{1} @@ -45,4 +44,3 @@ \end{rawslide} \end{document} - diff --git a/Master/texmf-dist/doc/latex/bidi/test-arydshln.tex b/Master/texmf-dist/doc/latex/bidi/test-arydshln.tex index a19c6994bd1..c6b7cc8029f 100644 --- a/Master/texmf-dist/doc/latex/bidi/test-arydshln.tex +++ b/Master/texmf-dist/doc/latex/bidi/test-arydshln.tex @@ -24,4 +24,4 @@ AAA&BBB&CCC\\\cdashline{1-2}[.4pt/1pt] \end{tabular} \end{center} \end{RTL} -\end{document}
\ No newline at end of file +\end{document} diff --git a/Master/texmf-dist/doc/latex/bidi/test-brochure.tex b/Master/texmf-dist/doc/latex/bidi/test-brochure.tex index 3066e0e4b41..f37b160a726 100644 --- a/Master/texmf-dist/doc/latex/bidi/test-brochure.tex +++ b/Master/texmf-dist/doc/latex/bidi/test-brochure.tex @@ -6,60 +6,43 @@ \usepackage[colorlinks,setpagesize=false]{hyperref} \usepackage[RTLdocument]{bidi} -% adjust \textheight so that it is an integer multiple of -% \baselineskip \adjustheight{\textheight} -% set up pagelayout. One column for title page -% two columns for the rest. \onecolumninarea[1,2]{0.6\textwidth}{\textheight}{0.4\textwidth}{0pt} \twocolumninarea[>2]{0.6\textwidth}{\textheight}{0.4\textwidth}{0pt} -% Set up dynamic frame on the left. This is where -% the headings will go. \newdynamicframe{0.4\textwidth}{\textheight}{0pt}{0pt}[left] -% put the chapter headings in this frame \dfchaphead*{left} -% Modify the default style \renewcommand{\DFchapterstyle}[1]{% \raggedright\Huge\slshape\MakeUppercase{#1}\par} -% Make static frames for background (only for page 1) \vtwotone[1]{0.6\paperwidth}{[cmyk]{0.65,0.13,0,0}}{backleft}% {0.4\paperwidth}{[cmyk]{0.94,0.54,0,0}}{backright} -% Make a border along the top of each page \vtwotonetop{1cm}{0.6\paperwidth}{[cmyk]{0.65,0.13,0,0}}{topleft}% {0.4\paperwidth}{[cmyk]{0.94,0.54,0,0}}{topright} -% make a static frame for the logo \newstaticframe{0.2\textwidth}{0.25\textheight}{0pt}{0pt}[logo] -% empty page style, because I am going to make my own \pagestyle{empty} -% Each new chapter sets \thispagestyle{\chapterfirstpagestyle}, change this empty as well -\renewcommand{\chapterfirstpagestyle}{empty} +\renewcommand{\chapterfirstpagestyle}{empty} -% Now make a frame in which to put my own customized footer \newdynamicframe[>1]{\textwidth}{\headheight}{0pt}{-\footskip}[footer] -% set the contents of the frame: \setdynamiccontents*{footer}{% School of Computing Sciences, University of East Anglia\hfill http://www.cmp.uea.ac.uk/\hfill page \thepage\ of \pageref*{lastpage}} - \newcommand{\env}[1]{\texttt{#1}} \newcommand{\cmdname}[1]{\texttt{\symbol{92}#1}} \newcommand{\meta}[1]{\textnormal{\textless\textit{#1}\textgreater}} \begin{document} -% not a very interesting logo \setstaticcontents*{logo}{\sffamily{\Huge\slshape FLF} Flowfram} {\noindent @@ -68,19 +51,18 @@ page \thepage\ of \pageref*{lastpage}} \noindent\large\MakeUppercase{Nicola Talbot}\\ } - \chapter{Introduction} The \textsl{flowfram} package is designed to enable you to create -frames in a document such that the -contents of the \env{document} environment flow from one -frame to the next in the order that they were defined. +frames in a document such that the +contents of the \env{document} environment flow from one +frame to the next in the order that they were defined. This is useful for creating posters -or magazines or any other form of document that does not +or magazines or any other form of document that does not conform to the standard one or two column layout. This is a modified version of the manual for the \textsl{flowfram} package. -It is intended to illustrated what can be done. See the full +It is intended to illustrated what can be done. See the full manual (ffuserguide.pdf) for a comprehensive description, as some parts of this document may now be out of date. @@ -93,8 +75,8 @@ This is column~\thedisplayedframe. The main type of frame is the flow frame. This is described on column~\ref{flow:flowframe} on page~\pageref{flow:flowframe}. The order used to draw the contents of each frame on the page -is described in column~\ref{flow:stacking} on -page~\pageref{flow:stacking}. Floats are describe in +is described in column~\ref{flow:stacking} on +page~\pageref{flow:stacking}. Floats are describe in column~\ref{flow:floats} on page~\pageref{flow:floats}. \chapter{Setting up Frames} @@ -102,16 +84,16 @@ column~\ref{flow:floats} on page~\pageref{flow:floats}. This is column~\thedisplayedframe. The \textsl{flowfram} package provides three types of frame: -{flow frames}, {static +{flow frames}, {static frames} and {dynamic frames}. \section*{Flow Frames} \labelflow{flow:flowframe} The flow frame is the principle type of frame. -The text of the \env{document} environment will flow from -one frame to the next in order of definition. Each -flow frame has an associated width, height, +The text of the \env{document} environment will flow from +one frame to the next in order of definition. Each +flow frame has an associated width, height, position on the page, and optionally a border. It is recommended that all the flow frames in a document @@ -119,7 +101,7 @@ have the same width, otherwise problems may occur when a paragraph spans to flow frames of unequal widths. This is because \TeX's output routine does not register the change in \cmdname{hsize} until it reaches -a paragraph break. If it is absolutely necessary for +a paragraph break. If it is absolutely necessary for flow frames to have unequal widths, judicious use of \cmdname{framebreak} is required. @@ -128,14 +110,14 @@ flow frames to have unequal widths, judicious use of A static frame is a rectangular area in which text neither flows into, nor flows out of. The contents must be set explicitly, and once set, the contents of the static frame will -remain the same on each page until it is explicitly -changed. Thus, a static frame can be used, for example, to make +remain the same on each page until it is explicitly +changed. Thus, a static frame can be used, for example, to make a company logo appear in the same place on every page. \section*{Dynamic Frames} A dynamic frame is similar to a static frame, but its contents -are re-typeset on each page. (A static frame stores its +are re-typeset on each page. (A static frame stores its contents in a savebox, whereas a dynamic frame stores its contents in a macro). @@ -144,14 +126,14 @@ This is column~\thedisplayedframe. \chapter{Frame Attributes} \label{sec:modattr} -Once you have defined the {flow frames}, {static frames} and -{dynamic frames}, their attributes can be changed. -The three types of frame mostly have the +Once you have defined the {flow frames}, {static frames} and +{dynamic frames}, their attributes can be changed. +The three types of frame mostly have the same set of attributes, but some are specific to a certain type. The available attributes are as follows (\textsuperscript{\textbf{F}} indicates the key is -only available for {flow frames}, -\textsuperscript{\textbf{S}} indicates the key is only available +only available for {flow frames}, +\textsuperscript{\textbf{S}} indicates the key is only available for {static frames} and \textsuperscript{\textbf{D}} indicates the key is only available for {dynamic frames}): @@ -165,40 +147,40 @@ is only available for {dynamic frames}): \item[y=\meta{length}]\mbox{}\par The y-coordinate of the frame. -\item[border=\meta{style}]\mbox{}\par The style of the border around the +\item[border=\meta{style}]\mbox{}\par The style of the border around the frame, this can take the values: \texttt{none} (no border), -\texttt{plain} (plain border) or the name of a \LaTeX\ -frame making command without the preceding backslash. +\texttt{plain} (plain border) or the name of a \LaTeX\ +frame making command without the preceding backslash. The value \texttt{fbox} is equivalent to \texttt{plain}. -\item[offset=\meta{offset}]\mbox{}\par The border offset, if it is a +\item[offset=\meta{offset}]\mbox{}\par The border offset, if it is a user-defined border. This is the distance from the outer edge of the left hand border to the left edge of the bounding box of the text inside the border. The \textsl{flowfram} -package is able to compute the border for -known frame making commands. -If you define your own frame making command, you may need to -specify the offset explicitly, or the frames +package is able to compute the border for +known frame making commands. +If you define your own frame making command, you may need to +specify the offset explicitly, or the frames may end up shifted to the right or left. \item[bordercolor=\meta{colour}]\mbox{}\par The colour of the border if you are using a standard frame making command. The colour can either be specified as, e.g.\ \texttt{green}, -or including the colour model, for example +or including the colour model, for example \verb/[rgb]{0,1,0}/. -\item[textcolor=\meta{colour}]\mbox{}\par The text colour for that -frame. Again, the colour can either be specified as, -e.g.\ \texttt{green}, or including the colour model, +\item[textcolor=\meta{colour}]\mbox{}\par The text colour for that +frame. Again, the colour can either be specified as, +e.g.\ \texttt{green}, or including the colour model, for example \verb/[rgb]{0,1,0}/. -\item[pages=\meta{page list}]\mbox{}\par The {list of +\item[pages=\meta{page list}]\mbox{}\par The {list of pages} for which the frame should appear. This can either have the values: \texttt{all}, -\texttt{even}, \texttt{odd} or \texttt{none} (the latter +\texttt{even}, \texttt{odd} or \texttt{none} (the latter removes the frame from that point on---useful if you -have multiple pages with the same number), or it can be a -comma-separated list of single pages, or +have multiple pages with the same number), or it can be a +comma-separated list of single pages, or {page ranges}. \item[margin=\meta{side}\textsuperscript{F}]\mbox{}\par The side of @@ -210,13 +192,13 @@ is set, the static frame will be cleared at the start of the next page. \item[style=\meta{cmd}\textsuperscript{D}]\mbox{}\par This should be -the name of a command \emph{without} the preceding backslash, -to be applied to the contents of the specified dynamic frame. +the name of a command \emph{without} the preceding backslash, +to be applied to the contents of the specified dynamic frame. The command may either be a declaration, for example \verb/style=large/ which will set the contents of all the dynamic frames in a large font, or it can be a command that takes a single argument, for example \verb/style=textbf/ -which will make the text for all the dynamic frames come out in +which will make the text for all the dynamic frames come out in bold. To unset a style, do \verb/style=none/. \end{description} @@ -228,17 +210,17 @@ bold. To unset a style, do \verb/style=none/. The \textsl{flowfram} package has the package option \texttt{draft} which will draw the {bounding boxes} for each frame defined. At the bottom right of each -bounding box (except for the bounding box denoting the +bounding box (except for the bounding box denoting the typeblock), a marker will be shown to indictate the type of frame, its IDN and its IDL. You can see the layout for the current page (irrespective of whether or not the \texttt{draft} option has been set) using -the command:\newline +the command:\newline \cmdname{flowframeshowlayout} The headers and footers will appear as usual (but will not -be shown in draft mode), according to the format given by +be shown in draft mode), according to the format given by \cmdname{pagestyle}. \section*{Frame Stacking Order} @@ -260,43 +242,43 @@ package option has been used. \end{enumerate} This ordering can be used to determine if you want something -to overlay or underlay everything else on the page. +to overlay or underlay everything else on the page. \section*{Prematurely Ending a Flow Frame} You can force text to move immediately to the next defined flow frame using one of the standard \LaTeX\ page breaking commands which work in an analogous way to the way they -work in standard two column mode. +work in standard two column mode. The command \cmdname{framebreak} is provided for situations where a paragraph spans two flow frames -of different widths, as \TeX's output routine does not -adjust to the new value of \cmdname{hsize} until the last -paragraph of the previous frame has ended. As a +of different widths, as \TeX's output routine does not +adjust to the new value of \cmdname{hsize} until the last +paragraph of the previous frame has ended. As a result, the end of the paragraph at the beginning of the new flow frame retains the width of the previous flow frame. -If you want to start a new page, rather than simply move to the +If you want to start a new page, rather than simply move to the next frame, use the command\newline \cmdname{finishthispage}. \section*{Floats} \labelflow{flow:floats} -Since floats (such as figures and tables) can only go in +Since floats (such as figures and tables) can only go in {flow frames}, this package provides -the additional environments: -\env{staticfigure} and +the additional environments: +\env{staticfigure} and \env{statictable} which can be used in static frames and dynamic frames. Unlike their \env{figure} and \env{table} counterparts, they are fixed in place, and -so do not take an optional placement specifier. The -\cmdname{caption} and \cmdname{label} commands can +so do not take an optional placement specifier. The +\cmdname{caption} and \cmdname{label} commands can be used within \env{staticfigure} and \env{statictable} as usual. -The standard \env{figure} and \env{table} commands will +The standard \env{figure} and \env{table} commands will behave as usual in the flow frames, but their starred versions, \env{figure*} and \env{table*} behave no differently from \env{figure} and \env{table}. @@ -306,13 +288,13 @@ from \env{figure} and \env{table}. The following macros can be changed using\linebreak \cmdname{renewcommand}: \begin{itemize} -\item \cmdname{setffdraftcolor} +\item \cmdname{setffdraftcolor} This sets the colour of the bounding box when it is displayed in draft mode. -\item -\cmdname{setffdrafttypeblockcolor} +\item +\cmdname{setffdrafttypeblockcolor} This sets the colour of the bounding box of the typeblock when it is displayed @@ -320,7 +302,7 @@ in draft mode. \item \cmdname{fflabelfont} -This sets the font size for the bounding box markers in +This sets the font size for the bounding box markers in draft mode. \end{itemize} @@ -337,7 +319,7 @@ bounding box at which to place the bounding box marker. \item \cmdname{flowframesep} This is the gap between the text of the frame and -its border, for the standard border types. +its border, for the standard border types. \item \cmdname{flowframerule} diff --git a/Master/texmf-dist/doc/latex/bidi/test-color.tex b/Master/texmf-dist/doc/latex/bidi/test-color.tex index f2a9dcd7395..a7156706564 100644 --- a/Master/texmf-dist/doc/latex/bidi/test-color.tex +++ b/Master/texmf-dist/doc/latex/bidi/test-color.tex @@ -36,9 +36,4 @@ \bigskip حالا نوبت جعبههای رنگی است یعنی مثلاً \colorbox{red}{{\color{white}سلام}} و \fcolorbox{yellow}{red}{{\color{white}این یک متن داخل جعبه رنگی است که کمی طولانی است}} - - - - - \end{document} diff --git a/Master/texmf-dist/doc/latex/bidi/test3-wrapfig.tex b/Master/texmf-dist/doc/latex/bidi/test3-wrapfig.tex index 4a61ff65f76..8d648fc4b13 100644 --- a/Master/texmf-dist/doc/latex/bidi/test3-wrapfig.tex +++ b/Master/texmf-dist/doc/latex/bidi/test3-wrapfig.tex @@ -7,7 +7,6 @@ \section{LTR} \subsection*{Wrapfig test} - Gulls are birds in the family Laridae. They are most closely related to the terns (family Sternidae), auks and skimmers, and more distantly to the waders. Most gulls belong to the @@ -44,7 +43,6 @@ Others rely on kleptoparasitism to get their food. \setRTL \subsection*{Wrapfig test} - Gulls are birds in the family Laridae. They are most closely related to the terns (family Sternidae), auks and skimmers, and more distantly to the waders. Most gulls belong to the |