diff options
Diffstat (limited to 'Master/texmf-dist/doc/latex/bidi/test-brochure.tex')
-rw-r--r-- | Master/texmf-dist/doc/latex/bidi/test-brochure.tex | 138 |
1 files changed, 60 insertions, 78 deletions
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} |