diff options
| author | Karl Berry <karl@freefriends.org> | 2012-11-13 00:16:56 +0000 |
|---|---|---|
| committer | Karl Berry <karl@freefriends.org> | 2012-11-13 00:16:56 +0000 |
| commit | b847625057328d18cbaff06505599203c8382a17 (patch) | |
| tree | b040c624881b1af975180256f90173d440d284d7 /Master/texmf-dist/doc/latex/flowfram | |
| parent | f5c4d1df6475f098e051b5c8a71ce506a2c0d802 (diff) | |
flowfram 1.14 (12nov12)
git-svn-id: svn://tug.org/texlive/trunk@28238 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/flowfram')
36 files changed, 2178 insertions, 5175 deletions
diff --git a/Master/texmf-dist/doc/latex/flowfram/CHANGES b/Master/texmf-dist/doc/latex/flowfram/CHANGES index ab0e4aca1c3..9b2069d7880 100644 --- a/Master/texmf-dist/doc/latex/flowfram/CHANGES +++ b/Master/texmf-dist/doc/latex/flowfram/CHANGES @@ -1,5 +1,94 @@ flowfram change log +1.14 (2012/11/10) : + + * Now loads xkeyval rather than keyval + + * Now loads xfor and etoolbox + + * Added new package options: + + - verbose (mainly for debugging messages) + + - thumbtabs (key=value option replacing options "ttbtitle", + "ttbnotitle", "ttbnum" and "ttbnonum") + + - pages + + * Changed the following package options to boolean key=value + (missing value assumed "true", providing backward compatibility): + + - rotate + + - color + + * Made \usedframebreaktrue global in definition of \framebreak + + * Added \usedframebreaktrue to definition of \newpage + + * New counter: "absolutepage" (keeps track of physical page rather + than page number given by \c@page). + + * Added pre-chapter hook \ffprechapterhook + + * Added page exclusion list. + + * New commands to set page list and page exclusion list: + + - \flowsetpagelist + - \flowsetexclusion + - \flowaddexclusion + - \dynamicsetpagelist + - \dynamicsetexclusion + - \dynamicaddexclusion + - \staticsetpagelist + - \staticsetexclusion + - \staticaddexclusion + + * New commands to make it easier to switch frames on and off + on-the-fly: + + - \flowswitchonnext + - \flowswitchoffnext + - \flowswitchonnextonly + - \flowswitchoffnextonly + - \flowswitchonnextodd + - \flowswitchoffnextodd + - \flowswitchonnextoddonly + - \flowswitchoffnextoddonly + + - \dynamicswitchonnext + - \dynamicswitchoffnext + - \dynamicswitchonnextonly + - \dynamicswitchoffnextonly + - \dynamicswitchonnextodd + - \dynamicswitchoffnextodd + - \dynamicswitchonnextoddonly + - \dynamicswitchoffnextoddonly + + - \staticswitchonnext + - \staticswitchoffnext + - \staticswitchonnextonly + - \staticswitchoffnextonly + - \staticswitchonnextodd + - \staticswitchoffnextodd + - \staticswitchonnextoddonly + - \staticswitchoffnextoddonly + + - \ffaddtoadjustframeshook + + * Added \fftolerance (now only warns about moving to unequal width + frame if width difference is greater than tolerance). + + * Added optional argument to \@sf@chckifthispg and + \@df@chckifthispg + + * Bug fixes: + + - removed unwanted spaces caused by eol character + + - added check for non-void boxes. + 1.13 (2010/01/23) : * Fixed 'undefined \ffareaevenx' bug. diff --git a/Master/texmf-dist/doc/latex/flowfram/README b/Master/texmf-dist/doc/latex/flowfram/README index b67134a19de..6850d26118c 100644 --- a/Master/texmf-dist/doc/latex/flowfram/README +++ b/Master/texmf-dist/doc/latex/flowfram/README @@ -1,6 +1,6 @@ -LaTeX Package : flowfram v 1.13 +LaTeX Package : flowfram v1.14 -Last Modified : 23rd January 2010 +Last Modified : 2012-11-10 Author : Nicola Talbot @@ -46,5 +46,5 @@ frames unless other packages (such as frames.perl) are used. This material is subject to the LaTeX Project Public License. See http://www.ctan.org/tex-archive/help/Catalogue/licenses.lppl.html for the details of that license. -http://theoval.cmp.uea.ac.uk/~nlct/ +http://www.dickimaw-books.com/ diff --git a/Master/texmf-dist/doc/latex/flowfram/ffuserguide.html b/Master/texmf-dist/doc/latex/flowfram/ffuserguide.html deleted file mode 100644 index cc817a62f25..00000000000 --- a/Master/texmf-dist/doc/latex/flowfram/ffuserguide.html +++ /dev/null @@ -1,4922 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN"> - -<!--Converted with LaTeX2HTML 2002 (1.67) -original version by: Nikos Drakos, CBLU, University of Leeds -* revised and updated by: Marcus Hennecke, Ross Moore, Herb Swan -* with significant contributions from: - Jens Lippmann, Marek Rouchal, Martin Wilck and others --> -<HTML> -<HEAD> -<TITLE>Creating Flow Frames for Posters, Brochures or Magazines using flowfram.sty v 1.13</TITLE> -<META NAME="description" CONTENT="Creating Flow Frames for Posters, Brochures or Magazines using flowfram.sty v 1.13"> -<META NAME="keywords" CONTENT="LaTeX; text frames; posters; brochures; magazines; newspapers"> -<META NAME="resource-type" CONTENT="document"> -<META NAME="distribution" CONTENT="global"> - -<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=iso-8859-1"> -<META NAME="Generator" CONTENT="LaTeX2HTML v2002"> -<META HTTP-EQUIV="Content-Style-Type" CONTENT="text/css"> - - -</HEAD> - -<BODY > -<A NAME="top"></A> - -<P> - -<P> - -<H1 ALIGN=CENTER>Creating Flow Frames for Posters, Brochures or -Magazines using flowfram.sty v 1.13</H1> -<P ALIGN=CENTER><STRONG>Nicola L. C. Talbot</STRONG></P> -<BR><P ALIGN=CENTER><I>Date:</I> 23rd January 2010</P> -<P ALIGN=LEFT></P> -<BR><P><P ALIGN=LEFT><FONT SIZE=-1>Key words and phrases: LaTeX; text frames; posters; brochures; magazines; newspapers</FONT></P> - -<P> - -<P> -Dr Nicola Talbot -<BR> -School of Computing Sciences -<BR> -University of East Anglia -<BR> -Norwich. Norfolk. NR4 7TJ. -<BR> -United Kingdom -<BR><TT><A NAME="tex2html1" - HREF="http://theoval.cmp.uea.ac.uk/~nlct/">http://theoval.cmp.uea.ac.uk/~nlct/</A></TT> -<P> - -<P> - -<BR> - -<H2><A NAME="SECTION0010000000000000000000"> -Contents</A> -</H2> -<!--Table of Contents--> - -<UL> -<LI><A NAME="tex2html271" - HREF="ffuserguide.html#SECTION0020000000000000000000">1. Introduction</A> -<UL> -<LI><A NAME="tex2html272" - HREF="ffuserguide.html#SECTION0021000000000000000000">1.1 Draft Option</A> -<LI><A NAME="tex2html273" - HREF="ffuserguide.html#SECTION0022000000000000000000">1.2 Frame Stacking Order</A> -<LI><A NAME="tex2html274" - HREF="ffuserguide.html#SECTION0023000000000000000000">1.3 HTML</A> -</UL> -<BR> -<LI><A NAME="tex2html275" - HREF="ffuserguide.html#SECTION0030000000000000000000">2. Defining New Frames</A> -<UL> -<LI><A NAME="tex2html276" - HREF="ffuserguide.html#SECTION0031000000000000000000">2.1 Flow Frames</A> -<UL> -<LI><A NAME="tex2html277" - HREF="ffuserguide.html#SECTION0031100000000000000000">2.1.1 Prematurely Ending a Flow Frame</A> -</UL> -<LI><A NAME="tex2html278" - HREF="ffuserguide.html#SECTION0032000000000000000000">2.2 Static Frames</A> -<UL> -<LI><A NAME="tex2html279" - HREF="ffuserguide.html#SECTION0032100000000000000000">2.2.1 Important Notes</A> -</UL> -<LI><A NAME="tex2html280" - HREF="ffuserguide.html#SECTION0033000000000000000000">2.3 Dynamic Frames</A> -<UL> -<LI><A NAME="tex2html281" - HREF="ffuserguide.html#SECTION0033100000000000000000">2.3.1 Important Notes</A> -</UL> -</UL> -<BR> -<LI><A NAME="tex2html282" - HREF="ffuserguide.html#SECTION0040000000000000000000">3. Modifying Frame Attributes</A> -<UL> -<LI><A NAME="tex2html283" - HREF="ffuserguide.html#SECTION0041000000000000000000">3.1 Non-Rectangular Frames</A> -</UL> -<BR> -<LI><A NAME="tex2html284" - HREF="ffuserguide.html#SECTION0050000000000000000000">4. Locations and Dimensions</A> -<UL> -<LI><A NAME="tex2html285" - HREF="ffuserguide.html#SECTION0051000000000000000000">4.1 Determining the Location of the Typeblock</A> -<LI><A NAME="tex2html286" - HREF="ffuserguide.html#SECTION0052000000000000000000">4.2 Determining the Dimensions and Locations of Frames</A> -<LI><A NAME="tex2html287" - HREF="ffuserguide.html#SECTION0053000000000000000000">4.3 Relative Locations</A> -</UL> -<BR> -<LI><A NAME="tex2html288" - HREF="ffuserguide.html#SECTION0060000000000000000000">5. Predefined Layouts</A> -<UL> -<LI><A NAME="tex2html289" - HREF="ffuserguide.html#SECTION0061000000000000000000">5.1 Column Styles</A> -<LI><A NAME="tex2html290" - HREF="ffuserguide.html#SECTION0062000000000000000000">5.2 Column Styles with an Additional Frame</A> -<LI><A NAME="tex2html291" - HREF="ffuserguide.html#SECTION0063000000000000000000">5.3 Right to Left Columns</A> -<LI><A NAME="tex2html292" - HREF="ffuserguide.html#SECTION0064000000000000000000">5.4 Backdrop Effects</A> -<UL> -<LI><A NAME="tex2html293" - HREF="ffuserguide.html#SECTION0064100000000000000000">5.4.1 Vertical stripe effects</A> -<LI><A NAME="tex2html294" - HREF="ffuserguide.html#SECTION0064200000000000000000">5.4.2 Horizontal stripe effect</A> -<LI><A NAME="tex2html295" - HREF="ffuserguide.html#SECTION0064300000000000000000">5.4.3 Background Frame</A> -<LI><A NAME="tex2html296" - HREF="ffuserguide.html#SECTION0064400000000000000000">5.4.4 Vertical and Horizontal Rules</A> -</UL> -</UL> -<BR> -<LI><A NAME="tex2html297" - HREF="ffuserguide.html#SECTION0070000000000000000000">6. Thumbtabs and Minitocs</A> -<UL> -<LI><A NAME="tex2html298" - HREF="ffuserguide.html#SECTION0071000000000000000000">6.1 Thumbtabs</A> -<LI><A NAME="tex2html299" - HREF="ffuserguide.html#SECTION0072000000000000000000">6.2 Minitocs</A> -</UL> -<BR> -<LI><A NAME="tex2html300" - HREF="ffuserguide.html#SECTION0080000000000000000000">7. Global Settings</A> -<UL> -<LI><A NAME="tex2html301" - HREF="ffuserguide.html#SECTION0081000000000000000000">7.1 Macros</A> -<LI><A NAME="tex2html302" - HREF="ffuserguide.html#SECTION0082000000000000000000">7.2 Lengths</A> -<LI><A NAME="tex2html303" - HREF="ffuserguide.html#SECTION0083000000000000000000">7.3 Counters</A> -</UL> -<BR> -<LI><A NAME="tex2html304" - HREF="ffuserguide.html#SECTION0090000000000000000000">8. Troubleshooting</A> -<UL> -<LI><A NAME="tex2html305" - HREF="ffuserguide.html#SECTION0091000000000000000000">8.1 General Queries</A> -<LI><A NAME="tex2html306" - HREF="ffuserguide.html#SECTION0092000000000000000000">8.2 Unexpected Output</A> -<LI><A NAME="tex2html307" - HREF="ffuserguide.html#SECTION0093000000000000000000">8.3 Error Messages</A> -</UL> -<BR> -<LI><A NAME="tex2html308" - HREF="ffuserguide.html#SECTION00100000000000000000000">Glossary</A> -<LI><A NAME="tex2html309" - HREF="ffuserguide.html#SECTION00110000000000000000000">Index</A> -</UL> -<!--End of Table of Contents--> -<P> - -<P> - -<P> - -<H1><A NAME="SECTION0020000000000000000000"> -1. Introduction</A> -</H1> - -<P> - -<I>This chapter provides a brief overview of the package, -the package options and the various frame types.</I> -<P> - -<P> -The <TT>flowfram</TT> package is a LaTeX2e package designed to -enable you to create text <A HREF=ffuserguide.html#gls:frame NAME="11452">frames</A> in a document such that -the contents of the <TT>document</TT><A NAME="3586"></A> 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 -conform to the standard one or two column layout. - -<P> -The <TT>flowfram</TT> package provides three types of frame: -<A HREF=ffuserguide.html#gls:flow NAME="11467">flow frames</A>, <A HREF=ffuserguide.html#gls:static NAME="11474">static frames</A> and <A HREF=ffuserguide.html#gls:dynamic NAME="11481">dynamic frames</A> with dimensions and -positions specified by the -user<A NAME="tex2html2" - HREF="#foot3519"><SUP>1.1</SUP></A>. -The main contents of the document environment flow from -one flow frame to the next in the order of definition, -whereas the contents of the static and dynamic frames -are set explicitly using commands described in -<A HREF="ffuserguide.html#sec:modattr">Modifying Frame -Attributes</A>. Note that -unless otherwise stated, all co-ordinates are relative to the -bottom left hand corner of the <A HREF=ffuserguide.html#gls:typeblock NAME="11492">typeblock</A>. If you have -a two-sided document, the absolute position of the typeblock may vary depending on the values of <TT>\oddsidemargin</TT><A NAME="3589"></A> -and <TT>\evensidemargin</TT><A NAME="3594"></A>, and all the frames will shift -accordingly unless otherwise indicated. - -<P> -Since floats (such as figures and tables) can only go in -flow frames, this package provides -the additional environments: -<TT>staticfigure</TT><A NAME="3599"></A> and -<TT>statictable</TT><A NAME="3602"></A> which can be used in static frames and dynamic frames. Unlike their <TT>figure</TT><A NAME="3605"></A> and -<TT>table</TT><A NAME="3608"></A> counterparts, they are fixed in place, and -so do not take an optional placement specifier. The -<TT>\caption</TT><A NAME="3611"></A> and <TT>\label</TT><A NAME="3616"></A> commands can -be used within <TT>staticfigure</TT><A NAME="3621"></A> and <TT>statictable</TT><A NAME="3624"></A> as -usual, but remember that if the frame is displayed on multiple -pages, you may end up with multiply defined labels. - -<P> -The standard <TT>figure</TT><A NAME="3627"></A> and <TT>table</TT><A NAME="3630"></A> commands will -behave as usual in the flow frames, but their starred versions, -<TT>figure*</TT><A NAME="3633"></A> and <TT>table*</TT><A NAME="3636"></A> behave no differently -from <TT>figure</TT><A NAME="3639"></A> and <TT>table</TT><A NAME="3642"></A><A NAME="tex2html3" - HREF="#foot405"><SUP>1.2</SUP></A>. - -<P> -This package has only been tested with a limited number of -class files and packages. Since it modifies the output routine, -it is likely to conflict with any other package which also -does this. - -<P> -You should load <TT>flowfram</TT> <I>after</I> <TT>hyperref</TT><A NAME="3645"></A> and any -colour package (e.g. <TT>color</TT><A NAME="3648"></A>). -<P> -<A HREF="ffuserguide.html#top">Top</A> | <A HREF="ffuserguide.html#index">Index</A> - -<P> - -<H1><A NAME="SECTION0021000000000000000000"> -1.1 Draft Option</A> -</H1> - -<P> -The <TT>flowfram</TT> package has the package option <TT>draft</TT><A NAME="3655"></A> -which will draw the <A HREF=ffuserguide.html#gls:bbox NAME="11562">bounding boxes</A> for -each <A HREF=ffuserguide.html#gls:frame NAME="11569">frame</A> that has been defined. At the bottom right of each -bounding box (except for the bounding box denoting the -<A HREF=ffuserguide.html#gls:typeblock NAME="11584">typeblock</A>), a marker will be shown in the form: -[<I>T</I>:<I>idn</I>;<I>idl</I>], where <I>T</I> is a single -letter denoting the frame type, <I>idn</I> is the <A HREF=ffuserguide.html#gls:idn NAME="11595">identification number (IDN)</A> for the frame and <I>idl</I> is the <A HREF=ffuserguide.html#gls:idl NAME="11606">identification label (IDL)</A> for that -frame. Values of <I>T</I> are: <TT>F</TT> (<A HREF=ffuserguide.html#gls:flow NAME="11617">flow frame</A>), -<TT>S</TT> (<A HREF=ffuserguide.html#gls:static NAME="11624">static frame</A>) or <TT>D</TT> (<A HREF=ffuserguide.html#gls:dynamic NAME="11631">dynamic frame</A>). -Markers of the form: [M:<I>idn</I>] indicate that the -bounding box is the area taken up by the margin for flow frame with IDN <I>idn</I>. Note that even if a frame has been rotated, the bounding box will not be rotated. - -<P> -If you want to show or hide specific types of bounding -boxes, you can use one of the following commands: - -<UL> -<LI><TT>\showtypeblocktrue</TT><A NAME="3658"></A> Display the bounding box for the typeblock. - -<P> -</LI> -<LI><TT>\showtypeblockfalse</TT><A NAME="3663"></A> Do not display the bounding box for the typeblock. - -<P> -</LI> -<LI><TT>\showmarginstrue</TT><A NAME="3668"></A> Display the bounding box for the margins. - -<P> -</LI> -<LI><TT>\showmarginsfalse</TT><A NAME="3673"></A> Do not display the bounding box for the margins. - -<P> -</LI> -<LI><TT>\showframebboxtrue</TT><A NAME="3678"></A> Display the bounding box for the frames. - -<P> -</LI> -<LI><TT>\showframebboxfalse</TT><A NAME="3683"></A> Do not display the bounding box for the frames. - -<P> -</LI> -</UL> - -<P> -You can see the layout for the current page (irrespective of -whether or not the <TT>draft</TT><A NAME="3688"></A> option has been set) using -the command: - -<P> -<TT>\flowframeshowlayout</TT><A NAME="3691"></A> -<P> - -<P> -The <TT>flowfram</TT> package also has the options <TT>nocolor</TT><A NAME="3696"></A> -and <TT>norotate</TT><A NAME="3699"></A> for previewers that can not process -colour or rotating specials. (Otherwise you may end up with -large black rectangles obscuring your text, instead of -the pale background colour you were hoping for.) -<P> -<A HREF="ffuserguide.html#top">Top</A> | <A HREF="ffuserguide.html#index">Index</A> - -<P> - -<H1><A NAME="SECTION0022000000000000000000"></A> -<A NAME="sec:stacking"></A> -<BR> -1.2 Frame Stacking Order -</H1> - -<P> -The material on each page is placed in the following order: - -<OL> -<LI>Each <A HREF=ffuserguide.html#gls:static NAME="11705">static frame</A> defined for that page in ascending -order of <A HREF=ffuserguide.html#gls:idn NAME="11712">IDN</A>. - -<P> -</LI> -<LI>Each <A HREF=ffuserguide.html#gls:flow NAME="11719">flow frame</A> defined for that page in ascending -order of <A HREF=ffuserguide.html#gls:idn NAME="11726">IDN</A>. - -<P> -</LI> -<LI>Each <A HREF=ffuserguide.html#gls:dynamic NAME="11733">dynamic frame</A> defined for that page in ascending -order of <A HREF=ffuserguide.html#gls:idn NAME="11740">IDN</A>. - -<P> -</LI> -<LI><A HREF=ffuserguide.html#gls:bbox NAME="11747">Bounding boxes</A> if the <TT>draft</TT><A NAME="3706"></A> -package option has been used. -</LI> -</OL> - -<P> -This ordering can be used to determine if you want something -to overlay or underlay everything else on the page. -Note that the <A HREF=ffuserguide.html#gls:frame NAME="11754">frames</A> do not interact with each other. If -you have two or more overlapping frames, the text in each -frame will not attempt to wrap around the other -frames, but will simply overwrite -them.<A NAME="tex2html17" - HREF="#foot3520"><SUP>1.3</SUP></A> -<P> -<A HREF="ffuserguide.html#top">Top</A> | <A HREF="ffuserguide.html#index">Index</A> - -<P> - -<H1><A NAME="SECTION0023000000000000000000"> -1.3 HTML</A> -</H1> - -<P> -The <TT>flowfram</TT> package now comes with a LaTeX2HTML style -file <TT>flowfram.perl</TT>. However this style file is not meant -to emulate the <TT>flowfram</TT> package, but is provided to facilitate -creating a plain HTML document from the LaTeX source. All -<A HREF=ffuserguide.html#gls:frame NAME="11782">frame</A>-related information is ignored. By default, the contents -of any <A HREF=ffuserguide.html#gls:static NAME="11785">static</A> or -<A HREF=ffuserguide.html#gls:dynamic NAME="11788">dynamic</A> frames are ignored, but this can be changed using -<PRE> -\HTMLset{showstaticcontents}{1} -</PRE> -to show the contents of the static frames or -<PRE> -\HTMLset{showdynamiccontents}{1} -</PRE> -to show the contents of the dynamic frames (where <code>\HTMLset</code> -is defined in the <TT>html</TT><A NAME="3717"></A> package). Note that this places the -text at the point in the document where the contents are set. -This style file does not create HTML frames. It can therefore be -used to create an accessible version of the PDF document -such as this document. -<P> -<A HREF="ffuserguide.html#top">Top</A> | <A HREF="ffuserguide.html#index">Index</A> - -<P> - -<H1><A NAME="SECTION0030000000000000000000"> -2. Defining New Frames</A> -</H1> - -<P> - -<I>This chapter describes how to define new frames, and how to -identify and set frame contents. See also -<A HREF="ffuserguide.html#sec:layouts">Predefined -Layouts</A>.</I> -<P> - -<P> -<A HREF="ffuserguide.html#top">Top</A> | <A HREF="ffuserguide.html#index">Index</A> - -<P> - -<H1><A NAME="SECTION0031000000000000000000"> -2.1 Flow Frames</A> -</H1> - -<P> -The <A HREF=ffuserguide.html#gls:flow NAME="11865">flow frame</A> is the principle type of <A HREF=ffuserguide.html#gls:frame NAME="11872">frame</A>. -The text of the <TT>document</TT><A NAME="3728"></A> 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. To define -a new flow frame use: - -<P> -<TT>\newflowframe</TT><A NAME="3731"></A><TT>[<I>page list</I>]{<I>width</I>}{<I>height</I>}{<I>x</I>}{<I>y</I>}[<I>label</I>]</TT> -<P> -where <I>width</I> is the width of the frame, <I>height</I> is -the height of the frame, (<I>x</I>,<I>y</I>) is the -position of the bottom left hand corner of the frame relative to the bottom left hand corner of the -<A HREF=ffuserguide.html#gls:typeblock NAME="11903">typeblock</A><A NAME="tex2html29" - HREF="#foot3522"><SUP>2.1</SUP></A>. -The first optional argument, <I>page list</I>, indicates the -list of pages for which this frame is defined. - -<P> -A <A HREF=ffuserguide.html#gls:pglist NAME="11914">page list</A> can either be specified by the keywords: -<TT>all</TT>, <TT>odd</TT>, <TT>even</TT> or <TT>none</TT>, or -by a comma-separated list of either individual page numbers or -<A HREF=ffuserguide.html#gls:pgrange NAME="11921">page ranges</A>. If <I>page list</I> is -omitted, <TT>all</TT> is assumed. -A page range can be a closed -range (e.g. <code>2-8</code>) or an open range (e.g. -<code><10</code> or <code>>5</code>). For example: <code><3,5,7-11,>15</code> -indicates pages 1, 2, 5, 7, 8, 9, 10, 11 and all pages -greater than page 15. These page numbers refer to the value of -the page counter<A NAME="tex2html30" - HREF="#foot3523"><SUP>2.2</SUP></A>, -so if you have a page i and a page 1, they -will both have the same layout (unless you change the -page list setting somewhere between the two pages). - -<P> -Each frame has its own unique <A HREF=ffuserguide.html#gls:idn NAME="11936">IDN</A>, -corresponding to the order in which it was defined. So the first -flow frame to be defined has IDN 1, -the second has IDN 2, and so on. This number can then -be used to identify the frame when you want to modify its -settings. Alternatively, you can assign a unique <A HREF=ffuserguide.html#gls:idl NAME="11959">IDL</A> to the -frame using the final optional argument <I>label</I>. - -<P> -You can retrieve the IDL for a given flow frame from its IDN using: - -<P> -<TT>\getflowlabel</TT><A NAME="3748"></A><TT>{<I>idn</I>}</TT> -<P> -Conversely, you can retrieve the IDN for a given flow frame from its IDL using: - -<P> -<TT>\getflowid</TT><A NAME="3755"></A><TT>{<I>cmd</I>}{<I>idl</I>}</TT> -<P> -where <I>cmd</I> is a control sequence which will be used to -store the frame's IDN. -For example: -<PRE> -The label for the first flow frame is ``\getflowlabel{1}''. -The flow frame labelled ``main'' has IDN \getflowid{\myid}{main}\myid. -</PRE> - (See also -<A HREF="ffuserguide.html#sec:counters">Counters</A>.) - -<P> -Note that <TT>\getflowlabel</TT><A NAME="3764"></A> doesn't perform any check to -determine whether the supplied IDN is valid, but -<TT>\getflowid</TT><A NAME="3769"></A> will generate an error if the supplied -IDL is undefined. - -<P> -By default, the flow frame will not have a border, but the -starred form - -<P> -<TT>\newflowframe*</TT><A NAME="3774"></A><TT>[<I>page list</I>]{<I>width</I>}{<I>height</I>}{<I>x</I>}{<I>y</I>}[<I>label</I>]</TT> -<P> -will place a plain border around the flow frame. -(See <A HREF="ffuserguide.html#sec:modattr">Modifying frame -attributes</A> if you want a different border.) - -<P> -Note that if the document continues beyond the last -defined flow frame (for example, the flow frames have only -been defined on pages 1 to 10, but the document contains 11 -pages) then a single flow frame will be defined, -emulating one column mode for all subsequent pages. - -<P> -In the PDF version of this document, -I used the command -<PRE> -\newflowframe{0.6\textwidth}{\textheight}{0pt}{0pt}[main] -</PRE> -to define the main flow frame<A NAME="tex2html31" - HREF="#foot3524"><SUP>2.3</SUP></A>. -<P> -<A HREF="ffuserguide.html#top">Top</A> | <A HREF="ffuserguide.html#index">Index</A> - -<P> - -<H2><A NAME="SECTION0031100000000000000000"></A> -<A NAME="sec:framebreak"></A> -<BR> -2.1.1 Prematurely Ending a Flow Frame -</H2> - -<P> -You can force text to move immediately to the next defined -<A HREF=ffuserguide.html#gls:flow NAME="12031">flow frame</A> using one of the commands: <TT>\newpage</TT><A NAME="3800"></A>, -<TT>\pagebreak</TT><A NAME="3805"></A> or <TT>\framebreak</TT><A NAME="3810"></A>. -The first two work in an analogous way to the way they -work in standard two column mode. The last one, -<TT>\framebreak</TT><A NAME="3815"></A>, is required -when a paragraph spans two flow frames of different widths, as TeX's output routine does not -adjust to the new value of <TT>\hsize</TT><A NAME="3820"></A> until the last -paragraph of the previous <A HREF=ffuserguide.html#gls:frame NAME="12042">frame</A> 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. - -<P> -If you want to start a new page, rather than simply move to the -next frame, use the command <TT>\clearpage</TT><A NAME="3825"></A>, -or for two-sided documents, to start on the next odd page -do <TT>\cleardoublepage</TT><A NAME="3830"></A>. -<P> -<A HREF="ffuserguide.html#top">Top</A> | <A HREF="ffuserguide.html#index">Index</A> - -<P> - -<H1><A NAME="SECTION0032000000000000000000"></A> -<A NAME="sec:static"></A> -<BR> -2.2 Static Frames -</H1> - -<P> -A <A HREF=ffuserguide.html#gls:static NAME="12156">static frame</A> is a rectangular area in which text neither -flows into nor flows out of.<A NAME="tex2html41" - HREF="#foot2894"><SUP>2.4</SUP></A> -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 a company logo appear in the same place on every -page. - -<P> -As from version 1.03 it is now possible to have -static frames with non-rectangular contents, see -<A HREF="ffuserguide.html#sec:parshape">Non-Rectangular -Frames</A> for further details. - -<P> -A new static frame is defined using the command: - -<P> -<TT>\newstaticframe</TT><A NAME="3839"></A><TT>[<I>page list</I>]{<I>width</I>}{<I>height</I>}{<I>x</I>}{<I>y</I>}[<I>label</I>]</TT> -<P> -where, as with <TT>\newflowframe</TT><A NAME="3856"></A>, <I>width</I> is the width of -the frame, <I>height</I> is the height of the frame, -(<I>x</I>,<I>y</I>) is the position of the bottom left hand -corner of the frame relative to the bottom left hand -corner of the <A HREF=ffuserguide.html#gls:typeblock NAME="12191">typeblock</A>. The first optional argument, -<I>page list</I>, indicates the <A HREF=ffuserguide.html#gls:pglist NAME="12198">page list</A> for which this -static frame should appear, and the final optional argument, -<I>label</I> is a unique textual <A HREF=ffuserguide.html#gls:idl NAME="12209">IDL</A> which you can use to -identify this frame. If no label is specified, you -can refer to this frame by its unique <A HREF=ffuserguide.html#gls:idn NAME="12224">IDN</A>. -The first static frame to be defined has IDN 1, the second -has IDN 2, and so on. - -<P> -You can retrieve the IDL for a given static frame from its IDN using: - -<P> -<TT>\getstaticlabel</TT><A NAME="3861"></A><TT>{<I>idn</I>}</TT> -<P> -Conversely, you can retrieve the IDN for a given static frame from its IDL using: - -<P> -<TT>\getstaticid</TT><A NAME="3868"></A><TT>{<I>cmd</I>}{<I>idl</I>}</TT> -<P> -where <I>cmd</I> is a control sequence which will be used to -store the frame's IDN. -For example: -<PRE> -The label for the first static frame is ``\getstaticlabel{1}''. -The static frame labelled ``backleft'' has IDN -\getstaticid{\myid}{backleft}\myid. -</PRE> - -<P> -Note that <TT>\getstaticlabel</TT><A NAME="3877"></A> doesn't perform any check to -determine whether the supplied IDN is valid, but -<TT>\getstaticid</TT><A NAME="3882"></A> will generate an error if the supplied -IDL is undefined. - -<P> -As with <TT>\newflowframe</TT><A NAME="3887"></A>, there is a starred version - -<P> -<TT>\newstaticframe*</TT><A NAME="3892"></A><TT>[<I>page list</I>]{<I>width</I>}{<I>height</I>}{<I>x</I>}{<I>y</I>}[<I>label</I>]</TT> -<P> -which will place a border around that static frame. - -<P> -To set the contents of a particular static frame, you can -either use the <TT>staticcontents</TT><A NAME="3909"></A> environment: - -<P> -<code>\begin{staticcontents}</code><TT>{<I>IDN</I>}</TT> -<BR><I>contents</I> -<BR><code>\end{staticcontents}</code> -<P> -where <I>IDN</I> is the unique IDN associated with -that static frame and <I>contents</I> is the contents of the -static frame, or you can use the -command: - -<P> -<TT>\setstaticcontents</TT><A NAME="3914"></A><TT>{<I>IDN</I>}{<I>contents</I>}</TT> -<P> -which will do the same thing. - -<P> -There are starred versions available for both the environment -and the command to enable you to identify the static frame by its associated IDL rather than its IDN: - -<P> -<code>\begin{staticcontents*}</code><TT>{<I>IDL</I>}</TT> -<BR><I>contents</I> -<BR><code>\end{staticcontents*}</code> -<P> -or the equivalent: - -<P> -<TT>\setstaticcontents*</TT><A NAME="3925"></A><TT>{<I>IDL</I>}{<I>contents</I>}</TT> -<P> - -<P> -In the body of <TT>staticcontents</TT><A NAME="3934"></A> or <TT>staticcontents*</TT><A NAME="3937"></A>, -or in the second argument of <TT>\setstaticcontents</TT><A NAME="3940"></A> -or <TT>\setstaticcontents*</TT><A NAME="3945"></A>, you can move onto another -static frame using: - -<P> -<TT>\continueonframe</TT><A NAME="3950"></A><TT>[<I>continuation text</I>]{<I>id</I>}</TT> -<P> -If <TT>staticcontents*</TT><A NAME="3959"></A> or <TT>\setstaticcontents*</TT><A NAME="3962"></A> are -being used, <I>id</I> refers to the IDL of the next -static frame, otherwise <I>id</I> refers to the IDN of the -next static frame. -The optional argument specifies some continuation text to place -at the end of the first static frame. For example, suppose I have -defined two static frames labelled "frame1" and "frame2", then -<PRE> -\begin{staticcontents*}{frame1} -Some text in the first frame. (Let's -assume this frame is somewhere on the -left half of the page.) -\continueonframe[Continued on the right]{frame2} -This is some text in the second frame. (Let's -assume this frame is somewhere on the -right half of the same page.) -\end{staticcontents*} -</PRE> -is equivalent to: -<PRE> -\begin{staticcontents*}{frame1} -Some text in the first frame. (Let's -assume this frame is somewhere on the -left half of the page.) -\ffcontinuedtextlayout{Continued on the right} -\end{staticcontents*} -\begin{staticcontents*}{frame2}\par\noindent -This is some text in the second frame. (Let's -assume this frame is somewhere on the -right half of the same page.) -\end{staticcontents*} -</PRE> -where - -<P> -<TT>\ffcontinuedtextlayout</TT><A NAME="3967"></A><TT>{<I>text</I>}</TT> -<P> -governs how the continuation text should be displayed. The font used -to display the continuation text is given by - -<P> -<TT>\ffcontinuedtextfont</TT><A NAME="3974"></A><TT>{<I>text</I>}</TT> -<P> - -<P> -Note that this assumes that it should appear that no paragraph -break occurs in the transition between the two frames. If you -want a paragraph break you need to explicitly put one before -and after <TT>\continueonframe</TT><A NAME="3981"></A>. For example: -<PRE> -\begin{staticcontents*}{frame1} -Some text in the first frame. (Let's -assume this frame is somewhere on the -left half of the page.) - -\continueonframe[Continued on the right]{frame2} - -This is some text in the second frame. (Let's -assume this frame is somewhere on the -right half of the same page.) -\end{staticcontents*} -</PRE> - -<P> -<A HREF="ffuserguide.html#top">Top</A> | <A HREF="ffuserguide.html#index">Index</A> - -<P> - -<H2><A NAME="SECTION0032100000000000000000"> -2.2.1 Important Notes</A> -</H2> - -<P> - -<UL> -<LI>When you set the contents of a <A HREF=ffuserguide.html#gls:static NAME="12344">static frame</A>, the contents are -immediately typeset and stored in a box until it is time to put -the contents on the page. This means that if you use any information -that varies throughout the document (such as the page number) the -value that is current when you set the static frame's contents -will be the value used. - -<P> -</LI> -<LI>However, if <TT>\label</TT><A NAME="3990"></A> is used inside a static frame, -the label information will be written to the auxiliary file each -time the static frame is displayed until the contents of that -frame have been changed. This means that you may -end up with multiply defined labels. -</LI> -</UL> - -<P> -<A HREF="ffuserguide.html#top">Top</A> | <A HREF="ffuserguide.html#index">Index</A> - -<P> - -<H1><A NAME="SECTION0033000000000000000000"></A> -<A NAME="sec:dynamic"></A> -<BR> -2.3 Dynamic Frames -</H1> - -<P> -A <A HREF=ffuserguide.html#gls:dynamic NAME="12478">dynamic frame</A> is similar to a <A HREF=ffuserguide.html#gls:static NAME="12485">static frame</A> except that its contents -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.<A NAME="tex2html48" - HREF="#foot3525"><SUP>2.5</SUP></A>) - -<P> -As from version 1.03 it is now possible to have -dynamic frames with non-rectangular contents, see -<A HREF="ffuserguide.html#sec:parshape">Non-Rectangular -Frames</A> for further details. - -<P> -To create a new dynamic frame, use the command: - -<P> -<TT>\newdynamicframe</TT><A NAME="4006"></A><TT>[<I>page list</I>]{<I>width</I>}{<I>height</I>}{<I>x</I>}{<I>y</I>}[<I>label</I>]</TT> -<P> -The parameters are exactly the same as for <TT>\newflowframe</TT><A NAME="4023"></A> -and <TT>\newstaticframe</TT><A NAME="4028"></A>. -Again, each dynamic frame has an associated unique <A HREF=ffuserguide.html#gls:idn NAME="12512">IDN</A>, -starting from 1 for the first dynamic frame to be defined, and -a unique <A HREF=ffuserguide.html#gls:idl NAME="12523">IDL</A> can also be set using the final optional -argument <I>label</I>. - -<P> -You can retrieve the IDL for a given dynamic frame from its IDN using: - -<P> -<TT>\getdynamiclabel</TT><A NAME="4033"></A><TT>{<I>idn</I>}</TT> -<P> -Conversely, you can retrieve the IDN for a given dynamic frame from its IDL using: - -<P> -<TT>\getdynamicid</TT><A NAME="4040"></A><TT>{<I>cmd</I>}{<I>idl</I>}</TT> -<P> -where <I>cmd</I> is a control sequence which will be used to -store the frame's IDN. - -<P> -For example: -<PRE> -The label for the first dynamic frame is ``\getdynamiclabel{1}''. -The dynamic frame labelled ``chaphead'' has IDN -\getdynamicid{\myid}{chaphead}\myid. -</PRE> - -<P> -Note that <TT>\getdynamiclabel</TT><A NAME="4049"></A> doesn't perform any check to -determine whether the supplied IDN is valid, but -<TT>\getdynamicid</TT><A NAME="4054"></A> will generate an error if the supplied -IDL is undefined. - -<P> -As with the other <A HREF=ffuserguide.html#gls:frame NAME="12566">frame</A> types, there is also a starred -version - -<P> -<TT>\newdynamicframe*</TT><A NAME="4059"></A><TT>[<I>page list</I>]{<I>width</I>}{<I>height</I>}{<I>x</I>}{<I>y</I>}[<I>label</I>]</TT> -<P> -which will place a plain border around the dynamic frame. -For example, in the PDF version -of this document I used the command -<PRE> -\newdynamicframe{0.38\textwidth}{\textheight}{0.62\textwidth}{0pt}[chaphead] -</PRE> -which created a frame on the -right on odd pages and on the left on even pages. (The -position for the even pages is set using <TT>\setdynamicframe</TT><A NAME="4076"></A> -defined in <A HREF="ffuserguide.html#sec:modattr">Modifying -Frame Attributes</A>.) - -<P> -The contents of a dynamic frame are set using the command: - -<P> -<TT>\setdynamiccontents</TT><A NAME="4081"></A><TT>{<I>id</I>}{<I>contents</I>}</TT> -<P> -where <I>id</I> is the unique IDN associated with that -dynamic frame, and <I>contents</I> is the contents of the -dynamic frame. Alternatively, if you have assigned an IDL, -<I>label</I>, to the dynamic frame, you can use the starred -version: - -<P> -<TT>\setdynamiccontents*</TT><A NAME="4090"></A><TT>{<I>label</I>}{<I>contents</I>}</TT> -<P> -As with most LaTeX commands, you can't use verbatim text<A NAME="4098"></A> in -<I>contents</I>. - -<P> -As from version 1.09, the contents can also be set using the -<TT>dynamiccontents</TT><A NAME="4100"></A> environment: - -<P> -<code>\begin{dynamiccontents}</code><TT>{<I>id</I>}</TT> -<BR><I>contents</I> -<BR><code>\end{dynamiccontents}</code> -<P> -or the <TT>dynamiccontents*</TT><A NAME="4105"></A> environment: - -<P> -<code>\begin{dynamiccontents*}</code><TT>{label}</TT> -<BR><I>contents</I> -<BR><code>\end{dynamiccontents*}</code> -<P> -<A NAME="pg:verb"></A>Note that you can't use verbatim text<A NAME="4108"></A> within the -<TT>dynamiccontents</TT><A NAME="4110"></A> or <TT>dynamiccontents*</TT><A NAME="4113"></A> environments. - -<P> -You can additionally append text to a dynamic frame using -either: - -<P> -<TT>\appenddynamiccontents</TT><A NAME="4116"></A><TT>{<I>id</I>}{<I>contents</I>}</TT> -<P> -or: - -<P> -<TT>\appenddynamiccontents*</TT><A NAME="4125"></A><TT>{<I>label</I>}{<I>contents</I>}</TT> -<P> - -<P> -If <TT>\chapter</TT><A NAME="4134"></A> is defined, you can make the chapter titles -appear in a dynamic frame using the command - -<P> -<TT>\dfchaphead</TT><A NAME="4139"></A><TT>{<I>IDN</I>}</TT> -<P> -where <I>IDN</I> is the <A HREF=ffuserguide.html#gls:idn NAME="12609">IDN</A> of the dynamic frame. There is -also a starred version of this command if you want to -use the <A HREF=ffuserguide.html#gls:idl NAME="12616">IDL</A> instead of the IDN. For example, in -the PDF version of this document, I used the command: -<PRE> -\dfchaphead*{chaphead} -</PRE> - -<P> -The headers and footers can be turned into dynamic frames using the command - -<P> -<TT>\makedfheaderfooter</TT><A NAME="4146"></A> -<P> -This will create two dynamic frames with IDLs <TT>header</TT> and <TT>footer</TT>. The page style will be used as -usual, but you can then move or resize the header and footer using -<TT>\setdynamicframe</TT><A NAME="4151"></A> (described <A HREF="ffuserguide.html#sec:modattr">later</A>). - -<P> -In the body of <TT>dynamiccontents</TT><A NAME="4156"></A> or <TT>dynamiccontents*</TT><A NAME="4159"></A>, -you can move onto another dynamic frame using: - -<P> -<TT>\continueonframe</TT><A NAME="4162"></A><TT>[<I>continuation text</I>]{id}</TT> -<P> -If this command occurs within <TT>dynamiccontents*</TT><A NAME="4170"></A>, <I>id</I> -refers to the IDL of the new frame, otherwise it refers -to the IDN of the new frame. -The optional argument specifies some continuation text to place -at the end of the first dynamic frame. For example, suppose I have -defined two dynamic frames labelled "frame1" and "frame2", then -<PRE> -\begin{dynamiccontents*}{frame1} -Some text in the first frame. (Let's -assume this frame is somewhere on the -left half of the page.) -\continueonframe[Continued on the right]{frame2} -This is some text in the second frame. (Let's -assume this frame is somewhere on the -right half of the same page.) -\end{dynamiccontents*} -</PRE> -is equivalent to: -<PRE> -\begin{dynamiccontents*}{frame1} -Some text in the first frame. (Let's -assume this frame is somewhere on the -left half of the page.) -\ffcontinuedtextlayout{Continued on the right} -\end{dynamiccontents*} -\begin{dynamiccontents*}{frame2}\par\noindent -This is some text in the second frame. (Let's -assume this frame is somewhere on the -right half of the same page.) -\end{dynamiccontents*} -</PRE> -where - -<P> -<TT>\ffcontinuedtextlayout</TT><A NAME="4173"></A><TT>{<I>text</I>}</TT> -<P> -governs how the continuation text should be displayed. The font used -to display the continuation text is given by - -<P> -<TT>\ffcontinuedtextfont</TT><A NAME="4180"></A><TT>{<I>text</I>}</TT> -<P> - -<P> -Note that this assumes that it should appear that no paragraph -break occurs in the transition between the two frames. If you -want a paragraph break you need to explicitly put one before -and after <TT>\continueonframe</TT><A NAME="4187"></A>. For example: -<PRE> -\begin{dynamiccontents*}{frame1} -Some text in the first frame. (Let's -assume this frame is somewhere on the -left half of the page.) - -\continueonframe[Continued on the right]{frame2} - -This is some text in the second frame. (Let's -assume this frame is somewhere on the -right half of the same page.) -\end{dynamiccontents*} -</PRE> - -<P> -<A HREF="ffuserguide.html#top">Top</A> | <A HREF="ffuserguide.html#index">Index</A> - -<P> - -<H2><A NAME="SECTION0033100000000000000000"> -2.3.1 Important Notes</A> -</H2> - -<P> - -<UL> -<LI>Verbatim text<A NAME="961"></A> can't be used in a -<A HREF=ffuserguide.html#gls:dynamic NAME="12668">dynamic frame</A>. This includes -the body of the <TT>dynamiccontents</TT><A NAME="4196"></A> and <TT>dynamiccontents*</TT><A NAME="4199"></A> -environments. - -<P> -</LI> -<LI><TT>\continueonframe</TT><A NAME="4202"></A> can't be used in the -argument of any of the commands that set the contents of a -dynamic frame, such as <TT>\setdynamiccontents</TT><A NAME="4207"></A>. - -<P> -</LI> -<LI>Dynamic frames are painted on the page after all the -static and flow <A HREF=ffuserguide.html#gls:frame NAME="12683">frames</A>. If the location of a dynamic frame overlaps the location of any static or flow frames, the contents -of the dynamic frame will obscure the contents of the overlapping -frames. -</LI> -</UL> - -<P> -<A HREF="ffuserguide.html#top">Top</A> | <A HREF="ffuserguide.html#index">Index</A> - -<P> - -<H1><A NAME="SECTION0040000000000000000000"></A> -<A NAME="sec:modattr"></A> -<BR> -3. Modifying Frame Attributes -</H1> - -<P> - -<I>This chapter describes how to modify frame attributes, -such as the size and location.</I> -<P> - -<P> -Once you have defined the <A HREF=ffuserguide.html#gls:flow NAME="12832">flow frames</A>, <A HREF=ffuserguide.html#gls:static NAME="12839">static frames</A> and -<A HREF=ffuserguide.html#gls:dynamic NAME="12846">dynamic frames</A>, their attributes can be changed. The three types of -<A HREF=ffuserguide.html#gls:frame NAME="12853">frame</A> mostly have the same set of attributes, but some are -specific to a certain type. - -<P> -Flow frame attributes are modified using -either the command: - -<P> -<TT>\setflowframe</TT><A NAME="4216"></A><TT>{<I>idn list</I>}{<I>key-val list</I>}</TT> -<P> -or the starred version: - -<P> -<TT>\setflowframe*</TT><A NAME="4225"></A><TT>{<I>label list</I>}{<I>key-val list</I>}</TT> -<P> -or the attributes for all flow frames can be set using: - -<P> -<TT>\setallflowframes</TT><A NAME="4234"></A><TT>{<I>key-val list</I>}</TT> -<P> -Static frame attributes are modified using either the command: - -<P> -<TT>\setstaticframe</TT><A NAME="4241"></A><TT>{<I>idn list</I>}{<I>key-val list</I>}</TT> -<P> -or the starred version: - -<P> -<TT>\setstaticframe*</TT><A NAME="4250"></A><TT>{<I>label list</I>}{<I>key-val list</I>}</TT> -<P> -or the attributes for all static frames can be set using: - -<P> -<TT>\setallstaticframes</TT><A NAME="4259"></A><TT>{<I>key-val list</I>}</TT> -<P> -Dynamic frame attributes are modified using either the command: - -<P> -<TT>\setdynamicframe</TT><A NAME="4266"></A><TT>{<I>idn list</I>}{<I>key-val list</I>}</TT> -<P> -or the starred version: - -<P> -<TT>\setdynamicframe*</TT><A NAME="4275"></A><TT>{<I>label list</I>}{<I>key-val list</I>}</TT> -<P> -or the attributes for all dynamic frames can be set using: - -<P> -<TT>\setalldynamicframes</TT><A NAME="4284"></A><TT>{<I>key-val list</I>}</TT> -<P> - -<P> -In each of the above, <I>idn list</I> can either be one of the -keywords: <TT>all</TT>, <TT>odd</TT> or <TT>even</TT> (indicating -all frames of that type, frames of that type whose -<A HREF=ffuserguide.html#gls:idn NAME="12892">IDN</A> is odd or frames of that type whose IDN is even) or it can be a comma-separated list of ID numbers, or -IDN ranges. - -<P> -For the starred versions, <I>label list</I> should be -a comma-separated list of <A HREF=ffuserguide.html#gls:idl NAME="12911">IDLs</A>. Note that you can't use the -above keywords or have ranges in <I>label list</I>. - -<P> -The <I>key-val list</I> argument must be a comma-separated -list of <I>key</I>=<I>value</I> pairs, indicating which -attributes to modify. The available values are as follows: - -<P> -<DL> -<DT><STRONG>width<A NAME="4290"></A>=<I>length</I></STRONG></DT> -<DD>The width of the frame. - -<P> -</DD> -<DT><STRONG>height<A NAME="4291"></A>=<I>length</I></STRONG></DT> -<DD>The height of the frame. - -<P> -</DD> -<DT><STRONG>x<A NAME="4292"></A>=<I>length</I></STRONG></DT> -<DD>The x-coordinate of the frame for all pages on which it is defined. - -<P> -</DD> -<DT><STRONG>y<A NAME="4293"></A>=<I>length</I></STRONG></DT> -<DD>The y-coordinate of the frame for all pages on which it is defined. - -<P> -</DD> -<DT><STRONG>evenx<A NAME="4294"></A>=<I>length</I></STRONG></DT> -<DD>The x-coordinate of the -frame for all even pages on which it is defined, but only if -the document is a two-sided document. - -<P> -For example, in the PDF version of -this document, I used the commands -<PRE> -\setflowframe*{main}{evenx=0.4\textwidth} -\setdynamicframe*{chaphead}{evenx=0pt} -</PRE> -to switch the positions of the flow frame and dynamic frame containing the document text and chapter headings, respectively, -on even pages. - -<P> -You can swap the odd and even values using the commands: - -<P> -<TT>\ffswapoddeven</TT><A NAME="4296"></A><TT>{<I>IDN</I>}</TT> -<P> -(for flow frames) - -<P> -<TT>\sfswapoddeven</TT><A NAME="4303"></A><TT>{<I>IDN</I>}</TT> -<P> -(for static frames) or - -<P> -<TT>\dfswapoddeven</TT><A NAME="4310"></A><TT>{<I>IDN</I>}</TT> -<P> -(for dynamic frames). These -commands all have starred versions which take the frame's -IDL instead of its IDN. - -<P> -</DD> -<DT><STRONG>eveny<A NAME="4316"></A>=<I>length</I></STRONG></DT> -<DD>The y-coordinate of the -frame for all even pages on which it is defined, but only if -the document is a two-sided document. - -<P> -</DD> -<DT><STRONG>oddx<A NAME="4317"></A>=<I>length</I></STRONG></DT> -<DD>The x-coordinate of the -frame for all odd pages on which it is defined, if the -document is two-sided. - -<P> -</DD> -<DT><STRONG>oddy<A NAME="4318"></A>=<I>length</I></STRONG></DT> -<DD>The y-coordinate of the -frame for all odd pages on which it is defined, -if the document is two-sided. - -<P> -</DD> -<DT><STRONG>valign<A NAME="4319"></A>=<I>pos</I></STRONG></DT> -<DD>Change the vertical alignment -of material inside a static or dynamic frame. The value <I>pos</I> -may be one of: <TT>c</TT>, <TT>t</TT> or <TT>b</TT>. -The default for static frames is <TT>c</TT>, the default -for dynamic frames is <TT>t</TT>. -This key is not available for flow frames. - -<P> -</DD> -<DT><STRONG>label<A NAME="4320"></A>=<I>text</I></STRONG></DT> -<DD>Assign an IDL to the frame. -(If you do not specify a label when you first define a frame it will be given a label identical to its IDN.) This key is -provided to allow the user to label frames that have been -generated by certain predefined layout commands described -in <A HREF="ffuserguide.html#sec:layouts">Predefined -Layouts</A>. - -<P> -</DD> -<DT><STRONG>border<A NAME="4321"></A>=<I>style</I></STRONG></DT> -<DD>The style of the border around the -frame, this can take the values: <TT>none</TT> (no border), -<TT>plain</TT> (plain border) or the name of a LaTeX -<A HREF=ffuserguide.html#gls:fcmd NAME="13010">frame making command</A> without the preceding backslash. (I admit -the notation is a little confusing, a frame making command is a command that places some kind of border around its -argument, such as <TT>\fbox</TT><A NAME="4323"></A>, or if you are using the -<TT>fancybox</TT><A NAME="4328"></A> package: <TT>\doublebox</TT><A NAME="4331"></A>, <TT>\ovalbox</TT><A NAME="4336"></A>, -<TT>\Ovalbox</TT><A NAME="4341"></A> and <TT>\shadowbox</TT><A NAME="4346"></A>.) -The value <TT>fbox</TT> is equivalent to <TT>plain</TT>. - -<P> -For example, to make the first static frame have an oval border: -<PRE> -\setstaticframe{1}{border=ovalbox} -</PRE> -Or you can define your own border: -<PRE> -\newcommand{\greenyellowbox}[1]{\fcolorbox{green}{yellow}{#1}} -\setstaticframe{1}{border=greenyellowbox} -</PRE> - -<P> -This next example uses the <TT>tikz</TT><A NAME="4351"></A> package to define a fancy -frame, so you need to use: -<PRE> -\usepackage{tikz} -\usetikzlibrary{snakes} -</PRE> -The border command is defined as follows: -<PRE> -\newlength\fancywidth -\newlength\fancyheight -\newlength\fancydepth - -\newcommand{\fancyborder}[1]{% -\settowidth{\fancywidth}{#1}% -\settoheight{\fancyheight}{#1}% -\settodepth{\fancydepth}{#1}% -\addtolength{\fancyheight}{\fancydepth}% -\hspace{-\flowframesep}% -\tikz[baseline=0pt]{% -\draw[snake=bumps,raise snake=\flowframesep, - line width=\flowframerule] - (0pt,0pt) rectangle (\fancywidth,\fancyheight); -}} -</PRE> -This makes a bumpy border, but it uses <TT>\flowframesep</TT><A NAME="4354"></A> to -determine the gap between the border and the text and uses -<TT>\flowframerule</TT><A NAME="4359"></A> to set the line width. This ensures that -the offset (see below) is correctly computed. - -<P> -This new border can now be applied to a frame: -<PRE> -\setstaticframe{1}{border=fancyborder} -</PRE> - -<P> -</DD> -<DT><STRONG>offset<A NAME="4363"></A>=<I>offset</I></STRONG></DT> -<DD>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 -<A HREF=ffuserguide.html#gls:bbox NAME="13025">bounding box</A> of the text inside the border. The <TT>flowfram</TT> -package is able to compute the border for the following -known frame making commands: <TT>\fbox</TT><A NAME="4365"></A>, <TT>\ovalbox</TT><A NAME="4370"></A>, -<TT>\Ovalbox</TT><A NAME="4375"></A>, <TT>\doublebox</TT><A NAME="4380"></A> and <TT>\shadowbox</TT><A NAME="4385"></A>. -For all other borders, the offset is assumed to be -<TT>-\flowframesep-\flowframerule</TT>. -If you define your own frame making command, you may need to -specify the offset explicitly, or the flow/static/dynamic frames -may end up shifted to the right or left. - -<P> -The above examples can compute their own offsets, however, -if you were to do, for example: -<PRE> -\newcommand{\thickgreenyellowbox}[1]{% -{\setlength{\fboxsep}{5pt}\setlength{\fboxrule}{6pt}% -\fcolorbox{green}{yellow}{#1}}} -</PRE> -Then you would have to specify the offset. In this example, -the offset is -5pt-6pt=-11pt, -so you would need to do: -<PRE> -\setstaticframe{1}{border=thickgreenyellowbox,offset=-11pt} -</PRE> - -<P> -</DD> -<DT><STRONG>bordercolor<A NAME="4389"></A>=<I>colour</I></STRONG></DT> -<DD>The colour of the border -if you are using a standard frame making command. -The colour can either be specified as, e.g. <TT>green</TT>, -or including the colour model, e.g. <code>[rgb]{0,1,0}</code>. -For example: -<PRE> -\setallflowframes{border=doublebox,bordercolor=[rgb]{1,0,0.5}} -</PRE> - -<P> -</DD> -<DT><STRONG>textcolor<A NAME="4390"></A>=<I>colour</I></STRONG></DT> -<DD>The text colour for that -frame. Again, the colour can either be specified as, -e.g. <TT>green</TT>, or including the colour model, -e.g. <code>[rgb]{0,1,0}</code>. - -<P> -</DD> -<DT><STRONG>backcolor<A NAME="4391"></A>=<I>colour</I></STRONG></DT> -<DD>The background colour for -that frame. Again, the colour can either be specified as, -e.g. <TT>green</TT>, or including the colour model, -e.g. <code>[rgb]{0,1,0}</code>. Note that the background colour -only extends as far as the bounding box, not the border. -If you want it to extend as far as the border, you -will need to define your own border type (see above). - -<P> -</DD> -<DT><STRONG>pages<A NAME="4392"></A>=<I>page list</I></STRONG></DT> -<DD>The <A HREF=ffuserguide.html#gls:pglist NAME="13052">list of -pages</A> for which the frame should appear. This can either have -the values: <TT>all</TT>, <TT>even</TT>, <TT>odd</TT> or <TT>none</TT> -(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 -<A HREF=ffuserguide.html#gls:pgrange NAME="13067">page ranges</A>. -For example: -<PRE> -\setdynamicframe{1}{pages=1,5,8-10} -</PRE> - -<P> -</DD> -<DT><STRONG>margin<A NAME="4393"></A>=<I>side</I></STRONG></DT> -<DD>The side of -the flow frame that its corresponding margin should go on. This -can take the values <TT>left</TT>, <TT>right</TT>, -<TT>inner</TT> or <TT>outer</TT>. This setting is only available -for flow frames. - -<P> -</DD> -<DT><STRONG>clear<A NAME="4394"></A>=<I>boolean</I></STRONG></DT> -<DD>If this value is set, the static or dynamic frame will be -cleared at the start of the -next page, otherwise it will only be cleared on the next -occurrence of <TT>\setstaticcontents</TT><A NAME="4396"></A> or the -<TT>staticcontents</TT><A NAME="4401"></A> environment, or the -<TT>\setdynamiccontents</TT><A NAME="4404"></A>, depending on the frame type. -This value is not set by default. This setting is not -available for flow frames. - -<P> -For example, in the PDF version of this document, I -prevented the chapter heading reappearing on every page using -the command: -<PRE> -\setdynamicframe*{chaphead}{clear} -</PRE> - -<P> -If you want to put <TT>\label</TT><A NAME="4409"></A> in a static or dynamic frame, you -should use the clear<A NAME="4413"></A> key to prevent the label from being -multiply defined. - -<P> -</DD> -<DT><STRONG>style<A NAME="4414"></A>=<I>cmd</I></STRONG></DT> -<DD>This should be -the name of a command <I>without</I> the preceding backslash, -to be applied to the contents of the specified dynamic frame. -The command may either be a declaration, for example: -<PRE> -\setalldynamicframes{style=large} -</PRE> -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: -<PRE> -\setalldynamicframes{style=textbf} -</PRE> -which will make the text for all the dynamic frames come out in -bold. To unset a style, do <code>style=none</code>. -This setting is only available for dynamic frames. - -<P> -</DD> -<DT><STRONG>angle<A NAME="4415"></A>=<I>n</I></STRONG></DT> -<DD>Rotate the contents of the -frame by <I>n</I> degrees (new to -version 1.02). Note that the <A HREF=ffuserguide.html#gls:bbox NAME="13106">bounding boxes</A> will not -appear rotated. - -<P> -</DD> -<DT><STRONG>shape<A NAME="4416"></A>=<I>shape command</I></STRONG></DT> -<DD>Define a shape for -the contents of a static frame or dynamic frame (new -to version 1.03). If <I>shape command</I> is <TT>\relax</TT><A NAME="4418"></A>, no -paragraph shape will be applied. See -<A HREF="ffuserguide.html#sec:parshape">Non-Rectangular -Frames</A> for further details. -</DD> -</DL> - -<P> -<A HREF="ffuserguide.html#top">Top</A> | <A HREF="ffuserguide.html#index">Index</A> - -<P> - -<H1><A NAME="SECTION0041000000000000000000"></A> -<A NAME="sec:parshape"></A> -<BR> -3.1 Non-Rectangular Frames -</H1> - -<P> -As from version 1.03, it is now possible to specify -non-rectangular <A HREF=ffuserguide.html#gls:static NAME="13178">static</A> or -<A HREF=ffuserguide.html#gls:dynamic NAME="13181">dynamic</A> frames (but not <A HREF=ffuserguide.html#gls:flow NAME="13188">flow frames</A>). Note -that the -<A HREF=ffuserguide.html#gls:bbox NAME="13195">bounding box</A> will still appear as a rectangle despite the -<A HREF=ffuserguide.html#gls:frame NAME="13202">frame's</A> shape setting. You may use either TeX's -<TT>\parshape</TT><A NAME="4431"></A> command, or the <TT>\shapepar</TT><A NAME="4436"></A> -command defined in Donald Arseneau's <TT>shapepar</TT><A NAME="4441"></A> -package (if using <TT>\shapepar</TT><A NAME="4444"></A>, remember to include -the <TT>shapepar</TT><A NAME="4449"></A> package.) - -<P> -Note that it is better to use <TT>\parshape</TT><A NAME="4452"></A> instead -of <TT>\shapepar</TT><A NAME="4457"></A> as the latter is more restrictive and -requires more processing. However, <TT>\shapepar</TT><A NAME="4462"></A> provides -greater flexibility in the type of shape that can be used. -<DL> -<DT><STRONG><TT>\parshape</TT><A NAME="4467"></A></STRONG></DT> -<DD>With <TT>\parshape</TT><A NAME="4472"></A> you can not have cut-outs in the middle, -top or bottom of a frame, however it is possible to have cut-outs -in the left or right side of the frame. When used with the -shape<A NAME="4476"></A> key for static or dynamic frames, the effects of -<TT>\par</TT><A NAME="4478"></A> and the sectioning commands are modified to allow -the paragraph shape to extend beyond a single paragraph, and -to allow sectioning commands (but not <TT>\chapter</TT><A NAME="4483"></A> -or <TT>\part</TT><A NAME="4488"></A>). - -<P> -</DD> -<DT><STRONG><TT>\shapepar</TT><A NAME="4493"></A></STRONG></DT> -<DD>With <TT>\shapepar</TT><A NAME="4498"></A> you may -have cut-outs, but you may not have any sectioning commands, -paragraph breaks, vertical spacing or mathematics. You can -simulate a paragraph break using <TT>\simpar</TT><A NAME="4503"></A>, but this -is not recommended. The size of the shape depends on the -amount of text, so the shape will expand or contract as you -add or delete text. See the <TT>shapepar</TT><A NAME="4508"></A> documentation for -more details. -</DD> -</DL> - -<P> -To restore a frame to its default rectangular setting use -shape<A NAME="4510"></A>=<TT>\relax</TT><A NAME="4512"></A>. - -<P> -For those unfamiliar with TeX's <TT>\parshape</TT><A NAME="4517"></A> command, -the syntax is as follows: -<BR> -<BR><TT>\parshape</TT><A NAME="4522"></A>=<I>n</I> <I>i<SUB>1</SUB></I> <I>l<SUB>1</SUB></I> -<I>i<SUB>2</SUB></I> <I>l<SUB>2</SUB></I> ... -<I>i<SUB>n</SUB></I> <I>l<SUB>n</SUB></I> -<BR> -<BR> -where <I>n</I> is the number of (<I>i<SUB>j</SUB></I> <I>l<SUB>j</SUB></I>) pairs and -<I>i<SUB>j</SUB></I> specifies the left -indentation for the jth line and -<I>l<SUB>j</SUB></I> specifies the length of -the jth line. - -<P> -For example, to create a -zigzag shaped static frame (whose IDN is <TT>shapedt</TT>): - -<PRE> -\setstaticframe*{shapedt}{shape={\parshape=20 -0.6\linewidth 0.4\linewidth 0.5\linewidth 0.4\linewidth -0.4\linewidth 0.4\linewidth 0.3\linewidth 0.4\linewidth -0.2\linewidth 0.4\linewidth 0.1\linewidth 0.4\linewidth -0pt 0.4\linewidth 0.1\linewidth 0.4\linewidth -0.2\linewidth 0.4\linewidth 0.3\linewidth 0.4\linewidth -0.4\linewidth 0.4\linewidth 0.5\linewidth 0.4\linewidth -0.6\linewidth 0.4\linewidth 0.5\linewidth 0.4\linewidth -0.4\linewidth 0.4\linewidth 0.3\linewidth 0.4\linewidth -0.2\linewidth 0.4\linewidth 0.1\linewidth 0.4\linewidth -0pt 0.4\linewidth 0.1\linewidth 0.4\linewidth -}} -</PRE> - -<P> - -<P> -The syntax for <TT>\shapepar</TT><A NAME="4547"></A> is more complicated, see -the <TT>shapepar</TT><A NAME="4552"></A> documentation for more details. In general: -<BR> -<BR><TT>\shapepar</TT><A NAME="4555"></A>{<I>shape specs</I>} -<BR> -<BR> -The <TT>shapepar</TT><A NAME="4560"></A> package has four predefined shapes: -<TT>\squareshape</TT><A NAME="4563"></A>, <TT>\diamondshape</TT><A NAME="4568"></A>, -<TT>\heartshape</TT><A NAME="4573"></A> and <TT>\nutshape</TT><A NAME="4578"></A>. - -<P> -For example, to assign -a heart shape to the static frame whose IDL is <TT>shapedb</TT>: -<PRE> -\setstaticframe*{shapedb}{shape={\shapepar\heartshape}} -</PRE> -To reset the frame back to its original rectangular shape -do: -<PRE> -\setstaticframe*{shapedb}{shape=\relax} -</PRE> - -<P> - - -<P> -The <TT>flowfram</TT> package currently does not support any other -paragraph shape making commands. Any other commands would -have to be used explicitly within the contents of the frame. -<P> -<A HREF="ffuserguide.html#top">Top</A> | <A HREF="ffuserguide.html#index">Index</A> - -<P> - -<H1><A NAME="SECTION0050000000000000000000"> -4. Locations and Dimensions</A> -</H1> - -<P> - -<I>This chapter describes some of the commands provided to -determine the locations and dimensions of frames.</I> -<P> - -<P> -This chapter describes some of the commands available that can -be used to determine the locations and dimensions of <A HREF=ffuserguide.html#gls:frame NAME="13228">frames</A>. -See the accompanying document <TT>flowfram.pdf</TT> for more details of -these commands or for other commands not listed here. -<P> -<A HREF="ffuserguide.html#top">Top</A> | <A HREF="ffuserguide.html#index">Index</A> - -<P> - -<H1><A NAME="SECTION0051000000000000000000"></A> -<A NAME="sec:typeblockloc"></A> -<BR> -4.1 Determining the Location of the Typeblock -</H1> - -<P> -As mentioned earlier, when you create new <A HREF=ffuserguide.html#gls:frame NAME="13260">frames</A>, -you must specify their location relative to the <A HREF=ffuserguide.html#gls:typeblock NAME="13267">typeblock</A>, but -what if you want to position a frame a set distance from the -edge of the paper? The <TT>flowfram</TT> package provides the following -commands that compute the distance from the typeblock to the -paper boundary: - -<P> - -<P> -<TT>\computeleftedgeodd</TT><A NAME="4609"></A><TT>{<I>length</I>}</TT> -<P> -This computes the position of the left edge of the (odd) page, relative -to the left side of the typeblock, and stores the result in -<I>length</I>. - -<P> - -<P> -<TT>\computeleftedgeeven</TT><A NAME="4616"></A><TT>{<I>length</I>}</TT> -<P> -As above, but for even pages. - -<P> - -<P> -<TT>\computetopedge</TT><A NAME="4623"></A><TT>{<I>length</I>}</TT> -<P> -This computes the top edge of the page, relative to the bottom of the -typeblock, and stores the result in <I>length</I>. - -<P> - -<P> -<TT>\computebottomedge</TT><A NAME="4630"></A><TT>{<I>length</I>}</TT> -<P> -This computes the bottom edge of the page, relative to the bottom of the -typeblock, and stores the result in <I>length</I>. - -<P> - -<P> -<TT>\computerightedgeodd</TT><A NAME="4637"></A><TT>{<I>length</I>}</TT> -<P> -This computes the position of the right edge of the (odd) page, -relative to the left side of the typeblock, and store the result -in <I>length</I>. - -<P> - -<P> -<TT>\computerightedgeeven</TT><A NAME="4644"></A><TT>{<I>length</I>}</TT> -<P> -As above, but for even pages. - -<P> -Note that in all cases <I>length</I> must be a LaTeX length -command. - -<P> -For example, if you want to create a frame whose bottom -left corner is one inch from the left edge of the page -and half an inch from the bottom edge of the page (this -assumes odd and even pages have the same margins): -<PRE> -% define two new lengths to represent the x and y coords -\newlength{\myX} -\newlength{\myY} -% compute the distance from the typeblock to the paper edge -\computeleftedgeodd{\myX} -\computebottomedge{\myY} -% Add the absolute co-ordinates to get co-ordinates -% relative to the typeblock -\addtolength{\myX}{1in} -\addtolength{\myY}{0.5in} -</PRE> - -<P> -<A HREF="ffuserguide.html#top">Top</A> | <A HREF="ffuserguide.html#index">Index</A> - -<P> - -<H1><A NAME="SECTION0052000000000000000000"> -4.2 Determining the Dimensions and Locations of Frames</A> -</H1> - -<P> -It is possible to determine the dimensions and locations -of a <A HREF=ffuserguide.html#gls:frame NAME="13311">frame</A> using one of the following commands: - -<P> - -<UL> -<LI><TT>\getstaticbounds</TT><A NAME="4655"></A><TT>{<I>IDN</I>}</TT> -</LI> -<LI><TT>\getstaticbounds*</TT><A NAME="4662"></A><TT>{<I>IDL</I>}</TT> -</LI> -<LI><TT>\getflowbounds</TT><A NAME="4669"></A><TT>{<I>IDN</I>}</TT> -</LI> -<LI><TT>\getflowbounds*</TT><A NAME="4676"></A><TT>{<I>IDL</I>}</TT> -</LI> -<LI><TT>\getdynamicbounds</TT><A NAME="4683"></A><TT>{<I>IDN</I>}</TT> -</LI> -<LI><TT>\getdynamicbounds*</TT><A NAME="4690"></A><TT>{<I>IDL</I>}</TT> -</LI> -</UL> - -<P> -For each command, the starred version takes an <A HREF=ffuserguide.html#gls:idl NAME="13318">IDL</A> as the -argument, and the unstarred version takes an <A HREF=ffuserguide.html#gls:idn NAME="13325">IDN</A> as the -argument. Each command stores the relevant information in the -lengths <TT>\ffareawidth</TT><A NAME="4697"></A>, <TT>\ffareaheight</TT><A NAME="4702"></A>, -<TT>\ffareax</TT><A NAME="4707"></A> and <TT>\ffareay</TT><A NAME="4712"></A>. - -<P> -For other related commands, see the section "Determining Dimensions -and Locations" in the accompanying document -<TT>flowfram.pdf</TT>. -<P> -<A HREF="ffuserguide.html#top">Top</A> | <A HREF="ffuserguide.html#index">Index</A> - -<P> - -<H1><A NAME="SECTION0053000000000000000000"> -4.3 Relative Locations</A> -</H1> - -<P> -To print the relative location of one <A HREF=ffuserguide.html#gls:frame NAME="13385">frame</A> from another do: - -<P> -<TT>\relativeframelocation</TT><A NAME="4721"></A><TT>{<I>type1</I>}{<I>idn1</I>}{<I>type2</I>}{<I>idn2</I>}</TT> -<P> -where <I>type1</I> and <I>idn1</I> indicate the type and <A HREF=ffuserguide.html#gls:idn NAME="13392">IDN</A> of -the first frame, and <I>type2</I> and <I>idn2</I> indicate the type -and <A HREF=ffuserguide.html#gls:idn NAME="13399">IDN</A> of the second frame. There is also a starred version: - -<P> -<TT>\relativeframelocation*</TT><A NAME="4734"></A><TT>{<I>type1</I>}{<I>idl1</I>}{<I>type2</I>}{<I>idll</I>}</TT> -<P> -where <I>idl1</I> and <I>idl2</I> indicate the <A HREF=ffuserguide.html#gls:idl NAME="13406">IDL</A> of the -first and second frames, respectively. Both the above commands will -print one of the following: - -<P> - -<UL> -<LI><TT>\FFaboveleft</TT><A NAME="4747"></A> if the first frame is above left of the -second frame. - -<P> -</LI> -<LI><TT>\FFaboveright</TT><A NAME="4752"></A> if the first frame is above right of the -second frame. - -<P> -</LI> -<LI><TT>\FFabove</TT><A NAME="4757"></A> if the first frame is above the second frame. - -<P> -</LI> -<LI><TT>\FFbelowleft</TT><A NAME="4762"></A> if the first frame is below left of the -second frame. - -<P> -</LI> -<LI><TT>\FFbelowright</TT><A NAME="4767"></A> if the first frame is below right of the -second frame. - -<P> -</LI> -<LI><TT>\FFbelow</TT><A NAME="4772"></A> if the first frame is below the second frame. - -<P> -</LI> -<LI><TT>\FFleft</TT><A NAME="4777"></A> if the first frame is to the left of the -second frame. - -<P> -</LI> -<LI><TT>\FFright</TT><A NAME="4782"></A> if the first frame is to the right of the -second frame. - -<P> -</LI> -<LI><TT>\FFoverlap</TT><A NAME="4787"></A> if both frames overlap. -</LI> -</UL> - -<P> -A frame is considered to be above another frame if the bottom edge -of the first frame is higher than the top edge of the second frame. - -<P> -A frame is considered to be below another frame if the top edge -of the first frame is lower than the bottom edge of the second frame. - -<P> -A frame is considered to be to the left of another frame if the right -edge of the first frame is to the left of the left edge of the second -frame. - -<P> -A frame is considered to be to the right of another frame if the left -edge of the first frame is to the right of the right edge of the -second frame. - -<P> -Note that the relative locations are taken for the current page, -regardless of whether either of the two frames are displayed on that -page. If the current page is odd, then the frame settings for odd pages -will be compared, otherwise the frame settings for even pages will -be compared. However remember that the first paragraph of each page -retains the settings in place at the start of the paragraph, so if the -frames have different locations for odd and even pages, then -<TT>\relativeframelocation</TT><A NAME="4792"></A> may use the wrong page settings if it -is used at the start of the page. - -<P> -For example, the PDF version of this document defined a -<A HREF=ffuserguide.html#gls:flow NAME="13413">flow frame</A> labelled <TT>main</TT> and a -<A HREF=ffuserguide.html#gls:dynamic NAME="13420">dynamic frame</A> labelled <TT>chaphead</TT> which is -used to display the chapter headings. The following code -<PRE> -The dynamic frame is -\relativeframelocation*{dynamic}{chaphead}{flow}{main} -of the flow frame. -</PRE> -produces: -The dynamic frame is -on -the left of the flow frame. - -<P> -There are some short cut commands for frames of the -same type: - -<P> -<TT>\reldynamicloc</TT><A NAME="4797"></A><TT>{<I>idn1</I>}{<I>idn2</I>}</TT> -<P> -This is equivalent to: -<BR> -<BR><TT>\relativeframelocation</TT><A NAME="4806"></A><TT>{dynamic}{<I>idn1</I>}{dynamic}{<I>idn2</I>}</TT> - -<P> -<TT>\relstaticloc</TT><A NAME="4817"></A><TT>{<I>idn1</I>}{<I>idn2</I>}</TT> -<P> -This is equivalent to: -<BR> -<BR><TT>\relativeframelocation</TT><A NAME="4826"></A><TT>{static}{<I>idn1</I>}{static}{<I>idn2</I>}</TT> - -<P> -<TT>\relflowloc</TT><A NAME="4837"></A><TT>{<I>idn1</I>}{<I>idn2</I>}</TT> -<P> -This is equivalent to: -<BR> -<BR><TT>\relativeframelocation</TT><A NAME="4846"></A><TT>{flow}{<I>idn1</I>}{flow}{<I>idn2</I>}</TT> -<BR> -<BR> -Each of the above commands also has a starred version that uses the -<A HREF=ffuserguide.html#gls:idl NAME="13431">IDL</A> instead of the <A HREF=ffuserguide.html#gls:idn NAME="13438">IDN</A>. - -<P> -These commands may be used in the optional argument of -<TT>\continueonframe</TT><A NAME="4857"></A> for frames that are on the same page. -For example: -<PRE> -\begin{dynamiccontents}{1} -Some text in the first dynamic frame that goes on for -quite a bit longer than this example. -\continueonframe[continued \reldynamicloc{2}{1}]{2} -This text is in the second dynamic frame which is -somewhere on the same page. -\end{dynamiccontents} -</PRE> - -<P> -For additional commands that determine the relative location of one -frame from another, see the section "Determining the relative -location of one frame from another" in the accompanying document -<TT>flowfram.pdf</TT>. -<P> -<A HREF="ffuserguide.html#top">Top</A> | <A HREF="ffuserguide.html#index">Index</A> - -<P> - -<H1><A NAME="SECTION0060000000000000000000"></A> -<A NAME="sec:layouts"></A> -<BR> -5. Predefined Layouts -</H1> - -<P> - -<I>This chapter describes commands that create frames -arranged in a predefined layout.</I> -<P> - -<P> -The <TT>flowfram</TT> package has a number of commands which -create <A HREF=ffuserguide.html#gls:frame NAME="13450">frames</A> in a predefined layout. These commands -may only be used in the preamble. -<P> -<A HREF="ffuserguide.html#top">Top</A> | <A HREF="ffuserguide.html#index">Index</A> - -<P> - -<H1><A NAME="SECTION0061000000000000000000"> -5.1 Column Styles</A> -</H1> - -<P> -The standard LaTeX commands <TT>\onecolumn</TT><A NAME="4870"></A> and -<TT>\twocolumn</TT><A NAME="4875"></A> are redefined to create one or two -<A HREF=ffuserguide.html#gls:flow NAME="13498">flow frames</A> that fill the entire <A HREF=ffuserguide.html#gls:typeblock NAME="13505">typeblock</A> separated -from each other (in the case of <TT>\twocolumn</TT><A NAME="4880"></A>) by a -gap of width <TT>\columnsep</TT><A NAME="4885"></A>. The height of these -flow frames may not be exactly as high as the typeblock, -as their height is adjusted to make them an integer -multiple of <TT>\baselineskip</TT><A NAME="4890"></A>. You can switch off this -automatic adjustment using the command: - -<P> -<TT>\ffvadjustfalse</TT><A NAME="4895"></A> -<P> - -<P> -The <TT>\onecolumn</TT><A NAME="4900"></A> and <TT>\twocolumn</TT><A NAME="4905"></A> commands -also take an optional argument which is the <A HREF=ffuserguide.html#gls:pglist NAME="13520">page list</A> for which those flow frames are defined. In addition -to <TT>\onecolumn</TT><A NAME="4910"></A> and <TT>\twocolumn</TT><A NAME="4915"></A>, the -following commands are also defined: - -<P> - -<P> -<TT>\Ncolumn</TT><A NAME="4920"></A><TT>[<I>pages</I>]{<I>n</I>}</TT> -<P> -This creates <I>n</I> column flow frames each separated by a -distance of <TT>\columnsep</TT><A NAME="4929"></A>. - -<P> - -<P> -<TT>\onecolumninarea</TT><A NAME="4934"></A><TT>[<I>pages</I>]{<I>width</I>}{<I>height</I>}{<I>x</I>}{<I>y</I>}</TT> -<P> -This creates a single flow frame to fill the given area, -adjusting the height so that it is an integer multiple of -<TT>\baselineskip</TT><A NAME="4949"></A>. - -<P> - -<P> -<TT>\twocolumninarea</TT><A NAME="4954"></A><TT>[<I>pages</I>]{<I>width</I>}{<I>height</I>}{<I>x</I>}{<I>y</I>}</TT> -<P> -This creates two column flow frames separated by a distance -of <TT>\columnsep</TT><A NAME="4969"></A> filling the entire area specified, again -adjusting the height so that it is an integer multiple of -<TT>\baselineskip</TT><A NAME="4974"></A>. The columns are separated by a gap of -<TT>\columnsep</TT><A NAME="4979"></A>. - -<P> - -<P> -<TT>\Ncolumninarea</TT><A NAME="4984"></A><TT>[<I>pages</I>]{<I>n</I>}{<I>width</I>}{<I>height</I>}{<I>x</I>}{<I>y</I>}</TT> -<P> -This is a more general form of <TT>\twocolumninarea</TT><A NAME="5001"></A> making -<I>n</I> flow frames instead of two. -<P> -<A HREF="ffuserguide.html#top">Top</A> | <A HREF="ffuserguide.html#index">Index</A> - -<P> - -<H1><A NAME="SECTION0062000000000000000000"> -5.2 Column Styles with an Additional Frame</A> -</H1> - -<P> -As well as the column-style <A HREF=ffuserguide.html#gls:flow NAME="14132">flow frames</A> defined -above, it is also possible to define -<I>n</I> columns with an additional <A HREF=ffuserguide.html#gls:frame NAME="14139">frame</A> spanning either -above or below them. There will be a vertical gap of -approximately<A NAME="tex2html92" - HREF="#foot3053"><SUP>5.1</SUP></A> -<TT>\vcolumnsep</TT><A NAME="5015"></A> between the columns -and the extra frame. In each of the following definitions, -the argument <I>pages</I> is the <A HREF=ffuserguide.html#gls:pglist NAME="14146">page list</A> for which -the frames are defined, <I>n</I> is the number of -columns required, <I>type</I> is the type of frame to go -above or below the columns (this may be one of: <TT>flow</TT>, -<TT>static</TT> or <TT>dynamic</TT>). The area in which the -new frames should fill is defined by <I>width</I>, <I>height</I> -(the width and height of the area) and <I>x</I>, <I>y</I> -(the position of the bottom left hand corner of the area -relative to the bottom left hand corner of the <A HREF=ffuserguide.html#gls:typeblock NAME="14157">typeblock</A>.) - -<P> -The height of the additional frame at the top or bottom of -the columns is given by <I>H</I>. - -<P> - -<P> -<TT>\onecolumntopinarea</TT><A NAME="5020"></A><TT>[<I>pages</I>]{<I>type</I>}{<I>H</I>}{<I>width</I>}{<I>height</I>}{<I>x</I>}{<I>y</I>}</TT> -<P> -This creates one flow frame with a <I>type</I> frame above it, filling -the area specified. - -<P> - -<P> -<TT>\twocolumntopinarea</TT><A NAME="5039"></A><TT>[<I>pages</I>]{<I>type</I>}{<I>H</I>}{<I>width</I>}{<I>height</I>}{<I>x</I>}{<I>y</I>}</TT> -<P> -This creates two column-style flow frames with a <I>type</I> frame -above them, filling the area specified. - -<P> - -<P> -<TT>\Ncolumntopinarea</TT><A NAME="5058"></A><TT>[<I>pages</I>]{<I>type</I>}{<I>n</I>}{<I>H</I>}{<I>width</I>}{<I>height</I>}{<I>x</I>}{<I>y</I>}</TT> -<P> -This creates <I>n</I> column-style flow frames with a <I>type</I> -frame above them, filling the area specified. - -<P> - -<P> -<TT>\onecolumnbottominarea</TT><A NAME="5079"></A><TT>[<I>pages</I>]{<I>type</I>}{<I>H</I>}{<I>width</I>}{<I>height</I>}{<I>x</I>}{<I>y</I>}</TT> -<P> -This creates one flow frame with a <I>type</I> frame underneath it, -filling the area specified. - -<P> - -<P> -<TT>\twocolumnbottominarea</TT><A NAME="5098"></A><TT>[<I>pages</I>]{<I>type</I>}{<I>H</I>}{<I>width</I>}{<I>height</I>}{<I>x</I>}{<I>y</I>}</TT> -<P> -This creates two column-style flow frames with a <I>type</I> frame -below them, filling the area specified. - -<P> - -<P> -<TT>\Ncolumnbottominarea</TT><A NAME="5117"></A><TT>[<I>pages</I>]{<I>type</I>}{<I>n</I>}{<I>H</I>}{<I>width</I>}{<I>height</I>}{<I>x</I>}{<I>y</I>}</TT> -<P> -This creates <I>n</I> column-style flow frames with a <I>type</I> -frame below them, filling the area specified. - -<P> -The following commands are special cases of the above: - -<P> - -<P> -<TT>\onecolumnStopinarea</TT><A NAME="5138"></A><TT>[<I>pages</I>]{<I>H</I>}{<I>width</I>}{<I>height</I>}{<I>x</I>}{<I>y</I>}</TT> -<P> -This is equivalent to: -<BR> -<TT>\onecolumntopinarea</TT><A NAME="5155"></A><TT>[<I>pages</I>]{static}{<I>H</I>}{<I>width</I>}{<I>height</I>}{<I>x</I>}{<I>y</I>}</TT> - -<P> - -<P> -<TT>\onecolumnDtopinarea</TT><A NAME="5173"></A><TT>[<I>pages</I>]{<I>H</I>}{<I>width</I>}{<I>height</I>}{<I>x</I>}{<I>y</I>}</TT> -<P> -This is equivalent to: -<BR> -<TT>\onecolumntopinarea</TT><A NAME="5190"></A><TT>[<I>pages</I>]{dynamic}{<I>H</I>}{<I>width</I>}{<I>height</I>}{<I>x</I>}{<I>y</I>}</TT> - -<P> - -<P> -<TT>\onecolumntop</TT><A NAME="5208"></A><TT>[<I>pages</I>]{<I>type</I>}{<I>H</I>}</TT> -<P> -As <TT>\onecolumntopinarea</TT><A NAME="5219"></A> where the area is the entire -typeblock. - -<P> - -<P> -<TT>\onecolumnStop</TT><A NAME="5224"></A><TT>[<I>pages</I>]{<I>H</I>}</TT> -<P> -This is equivalent to: -<TT>\onecolumntop</TT><A NAME="5233"></A><TT>[<I>pages</I>]{static}{<I>H</I>}</TT> - -<P> - -<P> -<TT>\onecolumnDtop</TT><A NAME="5243"></A><TT>[<I>pages</I>]{<I>H</I>}</TT> -<P> -This is equivalent to: -<TT>\onecolumntop</TT><A NAME="5252"></A><TT>[<I>pages</I>]{dynamic}{<I>H</I>}</TT> - -<P> - -<P> -<TT>\twocolumnStopinarea</TT><A NAME="5262"></A><TT>[<I>pages</I>]{<I>H</I>}{<I>width</I>}{<I>height</I>}{<I>x</I>}{<I>y</I>}</TT> -<P> -This is equivalent to: -<BR> -<TT>\twocolumntopinarea</TT><A NAME="5279"></A><TT>[<I>pages</I>]{static}{<I>H</I>}{<I>width</I>}{<I>height</I>}{<I>x</I>}{<I>y</I>}</TT> - -<P> - -<P> -<TT>\twocolumnDtopinarea</TT><A NAME="5297"></A><TT>[<I>pages</I>]{<I>H</I>}{<I>width</I>}{<I>height</I>}{<I>x</I>}{<I>y</I>}</TT> -<P> -This is equivalent to: -<BR> -<TT>\twocolumntopinarea</TT><A NAME="5314"></A><TT>[<I>pages</I>]{dynamic}{<I>H</I>}{<I>width</I>}{<I>height</I>}{<I>x</I>}{<I>y</I>}</TT> - -<P> - -<P> -<TT>\twocolumntop</TT><A NAME="5332"></A><TT>[<I>pages</I>]{<I>type</I>}{<I>H</I>}</TT> -<P> -As <TT>\twocolumntopinarea</TT><A NAME="5343"></A> where the area is the entire -typeblock. - -<P> - -<P> -<TT>\twocolumnStop</TT><A NAME="5348"></A><TT>[<I>pages</I>]{<I>H</I>}</TT> -<P> -This is equivalent to: -<TT>\twocolumntop</TT><A NAME="5357"></A><TT>[<I>pages</I>]{static}{<I>H</I>}</TT> - -<P> - -<P> -<TT>\twocolumnDtop</TT><A NAME="5367"></A><TT>[<I>pages</I>]{<I>H</I>}</TT> -<P> -This is equivalent to: -<TT>\twocolumntop</TT><A NAME="5376"></A><TT>[<I>pages</I>]{dynamic}{<I>H</I>}</TT> - -<P> - -<P> -<TT>\NcolumnStopinarea</TT><A NAME="5386"></A><TT>[<I>pages</I>]{<I>n</I>}{<I>H</I>}{<I>width</I>}{<I>height</I>}{<I>x</I>}{<I>y</I>}</TT> -<P> -This is equivalent to: -<BR> -<TT>\Ncolumntopinarea</TT><A NAME="5405"></A><TT>[<I>pages</I>]{static}{<I>n</I>}{<I>H</I>}{<I>width</I>}{<I>height</I>}{<I>x</I>}{<I>y</I>}</TT> - -<P> - -<P> -<TT>\NcolumnDtopinarea</TT><A NAME="5425"></A><TT>[<I>pages</I>]{<I>n</I>}{<I>H</I>}{<I>width</I>}{<I>height</I>}{<I>x</I>}{<I>y</I>}</TT> -<P> -This is equivalent to: -<BR> -<TT>\Ncolumntopinarea</TT><A NAME="5444"></A><TT>[<I>pages</I>]{dynamic}{<I>n</I>}{<I>H</I>}{<I>width</I>}{<I>height</I>}{<I>x</I>}{<I>y</I>}</TT> - -<P> - -<P> -<TT>\Ncolumntop</TT><A NAME="5464"></A><TT>[<I>pages</I>]{<I>type</I>}{<I>n</I>}{<I>H</I>}</TT> -<P> -As <TT>\Ncolumntopinarea</TT><A NAME="5477"></A> where the area is the entire -typeblock. - -<P> - -<P> -<TT>\NcolumnStop</TT><A NAME="5482"></A><TT>[<I>pages</I>]{<I>n</I>}{<I>H</I>}</TT> -<P> -This is equivalent to: -<TT>\Ncolumntop</TT><A NAME="5493"></A><TT>[<I>pages</I>]{static}{<I>n</I>}{<I>H</I>}</TT> - -<P> - -<P> -<TT>\NcolumnDtop</TT><A NAME="5505"></A><TT>[<I>pages</I>]{<I>n</I>}{<I>H</I>}</TT> -<P> -This is equivalent to: -<TT>\Ncolumntop</TT><A NAME="5516"></A><TT>[<I>pages</I>]{dynamic}{<I>n</I>}{<I>H</I>}</TT> - -<P> - -<P> -<TT>\onecolumnSbottominarea</TT><A NAME="5528"></A><TT>[<I>pages</I>]{<I>H</I>}{<I>width</I>}{<I>height</I>}{<I>x</I>}{<I>y</I>}</TT> -<P> -This is equivalent to: -<BR> -<TT>\onecolumnbottominarea</TT><A NAME="5545"></A><TT>[<I>pages</I>]{static}{<I>H</I>}{<I>width</I>}{<I>height</I>}{<I>x</I>}{<I>y</I>}</TT> - -<P> - -<P> -<TT>\onecolumnDbottominarea</TT><A NAME="5563"></A><TT>[<I>pages</I>]{<I>H</I>}{<I>width</I>}{<I>height</I>}{<I>x</I>}{<I>y</I>}</TT> -<P> -This is equivalent to: -<BR> -<TT>\onecolumnbottominarea</TT><A NAME="5580"></A><TT>[<I>pages</I>]{dynamic}{<I>H</I>}{<I>width</I>}{<I>height</I>}{<I>x</I>}{<I>y</I>}</TT> - -<P> - -<P> -<TT>\onecolumnbottom</TT><A NAME="5598"></A><TT>[<I>pages</I>]{<I>type</I>}{<I>H</I>}</TT> -<P> -As <TT>\onecolumnbottominarea</TT><A NAME="5609"></A> where the area is the entire -typeblock. - -<P> - -<P> -<TT>\onecolumnSbottom</TT><A NAME="5614"></A><TT>[<I>pages</I>]{<I>H</I>}</TT> -<P> -This is equivalent to: -<TT>\onecolumnbottom</TT><A NAME="5623"></A><TT>[<I>pages</I>]{static}{<I>H</I>}</TT> - -<P> - -<P> -<TT>\onecolumnDbottom</TT><A NAME="5633"></A><TT>[<I>pages</I>]{<I>H</I>}</TT> -<P> -This is equivalent to: -<TT>\onecolumnbottom</TT><A NAME="5642"></A><TT>[<I>pages</I>]{dynamic}{<I>H</I>}</TT> - -<P> - -<P> -<TT>\twocolumnSbottominarea</TT><A NAME="5652"></A><TT>[<I>pages</I>]{<I>H</I>}{<I>width</I>}{<I>height</I>}{<I>x</I>}{<I>y</I>}</TT> -<P> -This is equivalent to: -<BR> -<TT>\twocolumnbottominarea</TT><A NAME="5669"></A><TT>[<I>pages</I>]{static}{<I>H</I>}{<I>width</I>}{<I>height</I>}{<I>x</I>}{<I>y</I>}</TT> - -<P> - -<P> -<TT>\twocolumnDbottominarea</TT><A NAME="5687"></A><TT>[<I>pages</I>]{<I>H</I>}{<I>width</I>}{<I>height</I>}{<I>x</I>}{<I>y</I>}</TT> -<P> -This is equivalent to: -<BR> -<TT>\twocolumnbottominarea</TT><A NAME="5704"></A><TT>[<I>pages</I>]{dynamic}{<I>H</I>}{<I>width</I>}{<I>height</I>}{<I>x</I>}{<I>y</I>}</TT> - -<P> - -<P> -<TT>\twocolumnbottom</TT><A NAME="5722"></A><TT>[<I>pages</I>]{<I>type</I>}{<I>H</I>}</TT> -<P> -As <TT>\twocolumnbottominarea</TT><A NAME="5733"></A> where the area is the entire -typeblock. - -<P> - -<P> -<TT>\twocolumnSbottom</TT><A NAME="5738"></A><TT>[<I>pages</I>]{<I>H</I>}</TT> -<P> -This is equivalent to: -<TT>\twocolumnbottom</TT><A NAME="5747"></A><TT>[<I>pages</I>]{static}{<I>H</I>}</TT> - -<P> - -<P> -<TT>\twocolumnDbottom</TT><A NAME="5757"></A><TT>[<I>pages</I>]{<I>H</I>}</TT> -<P> -This is equivalent to: -<TT>\twocolumnbottom</TT><A NAME="5766"></A><TT>[<I>pages</I>]{dynamic}{<I>H</I>}</TT> - -<P> - -<P> -<TT>\NcolumnSbottominarea</TT><A NAME="5776"></A><TT>[<I>pages</I>]{<I>n</I>}{<I>H</I>}{<I>width</I>}{<I>height</I>}{<I>x</I>}{<I>y</I>}</TT> -<P> -This is equivalent to: -<BR> -<TT>\Ncolumnbottominarea</TT><A NAME="5795"></A><TT>[<I>pages</I>]{static}{<I>n</I>}{<I>H</I>}{<I>width</I>}{<I>height</I>}{<I>x</I>}{<I>y</I>}</TT> - -<P> - -<P> -<TT>\NcolumnDbottominarea</TT><A NAME="5815"></A><TT>[<I>pages</I>]{<I>n</I>}{<I>H</I>}{<I>width</I>}{<I>height</I>}{<I>x</I>}{<I>y</I>}</TT> -<P> -This is equivalent to: -<BR> -<TT>\Ncolumnbottominarea</TT><A NAME="5834"></A><TT>[<I>pages</I>]{dynamic}{<I>n</I>}{<I>H</I>}{<I>width</I>}{<I>height</I>}{<I>x</I>}{<I>y</I>}</TT> - -<P> - -<P> -<TT>\Ncolumnbottom</TT><A NAME="5854"></A><TT>[<I>pages</I>]{<I>type</I>}{<I>n</I>}{<I>H</I>}</TT> -<P> -As <TT>\Ncolumnbottominarea</TT><A NAME="5867"></A> where the area is the entire -typeblock. - -<P> - -<P> -<TT>\NcolumnSbottom</TT><A NAME="5872"></A><TT>[<I>pages</I>]{<I>n</I>}{<I>H</I>}</TT> -<P> -This is equivalent to: -<TT>\Ncolumnbottom</TT><A NAME="5883"></A><TT>[<I>pages</I>]{static}{<I>n</I>}{<I>H</I>}</TT> - -<P> - -<P> -<TT>\NcolumnDbottom</TT><A NAME="5895"></A><TT>[<I>pages</I>]{<I>n</I>}{<I>H</I>}</TT> -<P> -This is equivalent to: -<TT>\Ncolumnbottom</TT><A NAME="5906"></A><TT>[<I>pages</I>]{dynamic}{<I>n</I>}{<I>H</I>}</TT> - -<P> -<A HREF="ffuserguide.html#top">Top</A> | <A HREF="ffuserguide.html#index">Index</A> - -<P> - -<H1><A NAME="SECTION0063000000000000000000"> -5.3 Right to Left Columns</A> -</H1> - -<P> -The default behaviour for the commands defined above is -to create the <A HREF=ffuserguide.html#gls:flow NAME="14217">flow frames</A> from left to right. However if you are -typesetting from right to left, you will probably prefer to -define the <A HREF=ffuserguide.html#gls:flow NAME="14224">flow frames</A> in the reverse order. This can be done -via the package option <TT>RL</TT><A NAME="5922"></A>. Alternatively you can use the -command: - -<P> -<TT>\lefttorightcolumnsfalse</TT><A NAME="5925"></A> -<P> -before using commands such as <TT>\twocolumn</TT><A NAME="5930"></A> or -<TT>\Ncolumn</TT><A NAME="5935"></A>. Two switch back to left-to-right columns use: - -<P> -<TT>\lefttorightcolumnstrue</TT><A NAME="5940"></A> -<P> - -<P> - -<H1><A NAME="SECTION0064000000000000000000"> -5.4 Backdrop Effects</A> -</H1> - -<P> -<A HREF=ffuserguide.html#gls:static NAME="14266">Static frames</A> can be used to produce a -backdrop. There are a number of commands which create -static frames that can be used as a backdrop. In the -following definitions, <I>pages</I> is the <A HREF=ffuserguide.html#gls:pglist NAME="14277">page list</A> for -which those static frames are defined (<TT>all</TT> is the default). -For the vertical strips: -<I>xoffset</I> is the amount by which the frames should be -shifted horizontally (0pt by default), <I>W1</I> is the width of the first frame, -with colour specified by <I>C1</I> and <A HREF=ffuserguide.html#gls:idl NAME="14288">IDL</A> <I>L1</I>, -and so on up to <I>Wn</I> the width of the <I>n</I>th frame -with colour specified by <I>Cn</I> and IDL <I>Ln</I>. -For the vertical strips: -<I>yoffset</I> is the amount by which the frames should be -shifted vertically (0pt by default), <I>H1</I> is the height of the first frame, -with colour specified by <I>C1</I> and IDL <I>L1</I>, -and so on up to <I>Hn</I> the height of the <I>n</I>th frame -with colour specified by <I>Cn</I> and IDL <I>Ln</I>. - -<P> -<B>NOTE:</B> unlike the earlier commands, these commands -are all relative to the actual page, not the <A HREF=ffuserguide.html#gls:typeblock NAME="14307">typeblock</A>. -So an x offset of 0pt indicates the first vertical -frame is flush with the left hand edge of the page, and a -y offset of 0pt indicates the first horizontal frame -is flush with the bottom edge of the page. This is because backdrops -tend to span the entire page, not just the typeblock. - -<P> -The colour specification must be completely enclosed in braces, -for example <code>{[rgb]{1,0,1}}</code> not <code>[rgb]{1,0,1}</code>. -<P> -<A HREF="ffuserguide.html#top">Top</A> | <A HREF="ffuserguide.html#index">Index</A> - -<P> - -<H2><A NAME="SECTION0064100000000000000000"> -5.4.1 Vertical stripe effects</A> -</H2> - -<P> - -<P> -<TT>\vtwotone</TT><A NAME="5949"></A><TT>[<I>pages</I>][<I>xoffset</I>]{<I>W1</I>}{<I>C1</I>}{<I>L1</I>}{<I>W2</I>}{<I>C2</I>}{<I>L2</I>}</TT> -<P> -Defines two <A HREF=ffuserguide.html#gls:static NAME="14439">static frames</A> to create a two tone vertical strip effect. -(This command was -used to create the coloured background on the title page -of the PDF version of this document.) - -<P> - -<P> -<TT>\vNtone</TT><A NAME="5970"></A><TT>[<I>pages</I>][<I>xoffset</I>]{<I>n</I>}{<I>W1</I>}{<I>C1</I>}{<I>L1</I>}</TT>...<TT>{<I>Wn</I>}{<I>Cn</I>}{<I>Ln</I>}</TT> -<P> -This is similar to <TT>\vtwotone</TT><A NAME="5993"></A> but with <I>n</I> static frames instead of two. - -<P> - -<P> -<TT>\vtwotonebottom</TT><A NAME="5998"></A><TT>[<I>pages</I>][<I>xoffset</I>]{<I>H</I>}{<I>W1</I>}{<I>C1</I>}{<I>L1</I>}{<I>W2</I>}{<I>C2</I>}{<I>L2</I>}</TT> -<P> -This is similar to <TT>\vtwotone</TT><A NAME="6021"></A> but the static frames are only -<I>H</I> high, instead of the entire height of the page. -The frames are aligned along the bottom edge of the page. - -<P> - -<P> -<TT>\vtwotonetop</TT><A NAME="6026"></A><TT>[<I>pages</I>][<I>xoffset</I>]{<I>H</I>}{<I>W1</I>}{<I>C1</I>}{<I>L1</I>}{<I>W2</I>}{<I>C2</I>}</TT> -<BR><TT>{<I>L2</I>}</TT> -<P> -This is similar to <TT>\vtwotone</TT><A NAME="6049"></A> but the static frames are only -<I>H</I> high, instead of the entire height of the page. -The frames are aligned along the top edge of the page. -(This command was used to create the border effect along -the top of every page in the PDF version of this document. -Two <TT>\vtwotonetop</TT><A NAME="6054"></A> -commands were used, one for the even pages, and the other -for the odd pages.) - -<P> - -<P> -<TT>\vNtonebottom</TT><A NAME="6059"></A><TT>[<I>pages</I>][<I>xoffset</I>]{<I>H</I>}{<I>n</I>}{<I>W1</I>}{<I>C1</I>}{<I>L1</I>}</TT>... -<TT>{<I>Wn</I>}{<I>Cn</I>}{<I>Ln</I>}</TT> -<P> -This is a general version of <TT>\vtwotonebottom</TT><A NAME="6084"></A> for -<I>n</I> frames instead of two. - -<P> - -<P> -<TT>\vNtonetop</TT><A NAME="6089"></A><TT>[<I>pages</I>][<I>xoffset</I>]{<I>H</I>}{<I>n</I>}{<I>W1</I>}{<I>C1</I>}{<I>L1</I>}</TT>... -<TT>{<I>Wn</I>}{<I>Cn</I>}{<I>Ln</I>}</TT> -<P> -This is a general version of <TT>\vtwotonetop</TT><A NAME="6114"></A> for -<I>n</I> frames instead of two. -<P> -<A HREF="ffuserguide.html#top">Top</A> | <A HREF="ffuserguide.html#index">Index</A> - -<P> - -<H2><A NAME="SECTION0064200000000000000000"> -5.4.2 Horizontal stripe effect</A> -</H2> - -<P> - -<P> -<TT>\htwotone</TT><A NAME="6123"></A><TT>[<I>pages</I>][<I>yoffset</I>]{<I>H1</I>}{<I>C1</I>}{<I>L1</I>}{<I>H2</I>}{<I>C2</I>}{<I>L2</I>}</TT> -<P> -This defines two <A HREF=ffuserguide.html#gls:static NAME="14579">static frames</A> to create a two tone horizontal strip -effect. - -<P> - -<P> -<TT>\hNtone</TT><A NAME="6144"></A><TT>[<I>pages</I>][<I>yoffset</I>]{<I>n</I>}{<I>H1</I>}{<I>C1</I>}{<I>L1</I>}</TT>... -<TT>{<I>Hn</I>}{<I>Cn</I>}{<I>Ln</I>}</TT> -<P> -This is similar to <TT>\htwotone</TT><A NAME="6167"></A> but with <I>n</I> static frames instead of two. - -<P> - -<P> -<TT>\htwotoneleft</TT><A NAME="6172"></A><TT>[<I>pages</I>][<I>yoffset</I>]{<I>W</I>}{<I>H1</I>}{<I>C1</I>}{<I>L1</I>}{<I>H2</I>}{<I>C2</I>}{<I>L2</I>}</TT> -<P> -This is similar to <TT>\htwotone</TT><A NAME="6195"></A> but the static frames are only -<I>W</I> wide, instead of the entire width of the page. -The frames are aligned along the left edge of the page. - -<P> - -<P> -<TT>\htwotoneright</TT><A NAME="6200"></A><TT>[<I>pages</I>][<I>yoffset</I>]{<I>W</I>}{<I>H1</I>}{<I>C1</I>}{<I>L1</I>}{<I>H2</I>}{<I>C2</I>}{<I>L2</I>}</TT> -<P> -This is similar to <TT>\htwotone</TT><A NAME="6223"></A> but the static frames are only -<I>W</I> wide, instead of the entire width of the page. -The frames are aligned along the right edge of the page. - -<P> - -<P> -<TT>\hNtoneleft</TT><A NAME="6228"></A><TT>[<I>pages</I>][<I>yoffset</I>]{<I>W</I>}{<I>n</I>}{<I>H1</I>}{<I>C1</I>}{<I>L1</I>}</TT>... -<TT>{<I>Hn</I>}{<I>Cn</I>}{<I>Ln</I>}</TT> -<P> -This is a general version of <TT>\htwotoneleft</TT><A NAME="6253"></A> for -<I>n</I> frames instead of two. - -<P> - -<P> -<TT>\hNtoneright</TT><A NAME="6258"></A><TT>[<I>pages</I>][<I>yoffset</I>]{<I>W</I>}{<I>n</I>}{<I>H1</I>}{<I>C1</I>}{<I>L1</I>}</TT>... -<TT>{<I>Hn</I>}{<I>Cn</I>}{<I>Ln</I>}</TT> -<P> -This is a general version of <TT>\htwotoneright</TT><A NAME="6283"></A> for -<I>n</I> frames instead of two. -<P> -<A HREF="ffuserguide.html#top">Top</A> | <A HREF="ffuserguide.html#index">Index</A> - -<P> - -<H2><A NAME="SECTION0064300000000000000000"> -5.4.3 Background Frame</A> -</H2> - -<P> -To make a single <A HREF=ffuserguide.html#gls:static NAME="14603">static frame</A> covering the entire page, use: - -<P> -<TT>\makebackgroundframe</TT><A NAME="6292"></A><TT>[<I>pages</I>][<I>IDL</I>]</TT> -<P> -Note that this frame should be created before any other -static frame as it will obscure all other static frames created -before it if it is given a background colour. -<P> -<A HREF="ffuserguide.html#top">Top</A> | <A HREF="ffuserguide.html#index">Index</A> - -<P> - -<H2><A NAME="SECTION0064400000000000000000"></A> -<A NAME="sec:insertrule"></A> -<BR> -5.4.4 Vertical and Horizontal Rules -</H2> - -<P> -You can create vertical or horizontal rules between two -<A HREF=ffuserguide.html#gls:frame NAME="14679">frames</A> using the commands: - -<P> - -<P> -<TT>\insertvrule</TT><A NAME="6305"></A><TT>[<I>y top</I>][<I>y bottom</I>]{<I>T1</I>}{<I>IDN1</I>}{<I>T2</I>}{<I>IDN2</I>}</TT> -<P> -This creates a new <A HREF=ffuserguide.html#gls:static NAME="14686">static frame</A> which fits between <I>T1</I> -frame with <A HREF=ffuserguide.html#gls:idn NAME="14697">IDN</A> <I>IDN1</I> and <I>T2</I> frame with IDN <I>IDN2</I>, and places a vertical rule in it -extending from the highest point of the highest frame to -the lowest point of the lowest frame. The first optional -argument <I>y top</I> (default 0pt) extends the rule by that -much above the highest point, and the second optional argument -<I>y bottom</I> (default 0pt) extends the rule by that much -below the lowest point. If either of the optional arguments -are negative, the rule will be shortened instead of extended. -The width of the rule is given by - -<P> -<TT>\ffcolumnseprule</TT><A NAME="6322"></A> -<P> -<B>Note</B> that this has changed as from version 1.09: versions -prior to 1.09 used <TT>\columnseprule</TT><A NAME="6327"></A>. - -<P> -The vertical rule drawn by <TT>\insertvrule</TT><A NAME="6332"></A> is created using -the command: - -<P> -<TT>\ffvrule</TT><A NAME="6337"></A><TT>{offset}{width}{height}</TT> -<P> -This can be redefined if a more ornate rule is required -(see below). - -<P> - -<P> -<TT>\inserthrule</TT><A NAME="6345"></A><TT>[<I>x left</I>][<I>x right</I>]{<I>T1</I>}{<I>IDN1</I>}{<I>T2</I>}{<I>IDN2</I>}</TT> -<P> -This creates a new <A HREF=ffuserguide.html#gls:static NAME="14712">static frame</A> which fits between <I>T1</I> -frame with <A HREF=ffuserguide.html#gls:idn NAME="14723">IDN</A> <I>IDN1</I> and <I>T2</I> frame with IDN <I>IDN2</I>, and places a horizontal rule in it -extending from the leftmost point of the left frame to -the rightmost point of the right frame. The first optional -argument <I>x left</I> (default 0pt) extends the rule by that -much before the leftmost point, and the second optional argument -<I>x right</I> (default 0pt) extends the rule by that much -beyond the rightmost point. If either of the optional arguments -are negative, the rule will be shortened instead of extended. -The height of the rule is given by - -<P> -<TT>\ffcolumnseprule</TT><A NAME="6362"></A> -<P> - -<P> -The horizontal rule drawn by <TT>\inserthrule</TT><A NAME="6367"></A> is created using -the command: - -<P> -<TT>\ffhrule</TT><A NAME="6372"></A><TT>{offset}{width}{height}</TT> -<P> -This can be redefined if a more ornate rule is required (see below). - -<P> -The default value for <TT>\ffcolumnseprule</TT><A NAME="6380"></A> is 2pt. Both -<TT>\insertvrule</TT><A NAME="6385"></A> and <TT>\inserthrule</TT><A NAME="6390"></A> have starred versions -which allow you to identify the frame by <A HREF=ffuserguide.html#gls:idl NAME="14742">IDL</A> instead of -IDN. The frame types, <I>T1</I> and <I>T2</I> can be one -of the following keywords: <TT>flow</TT>, <TT>static</TT> or -<TT>dynamic</TT>. - -<P> -The command - -<P> -<TT>\ffruledeclarations</TT><A NAME="6395"></A> -<P> -can be redefined to set declarations that affect how the rule is drawn. -The most likely use of this command is to set the rule colour. -For example: -<PRE> -\twocolumnStop{2in} - -\renewcommand{\ffruledeclarations}{\color{red}} -\insertvrule{flow}{1}{flow}{2} - -\renewcommand{\ffruledeclarations}{\color{blue}} -\inserthrule{static}{1}{flow}{1} -</PRE> -This will create a layout with two columns (<A HREF=ffuserguide.html#gls:flow NAME="14757">flow frames</A> 1 and 2) -with a <A HREF=ffuserguide.html#gls:static NAME="14764">static frame</A> above. A red vertical rule is placed in a -static frame between flow frames 1 and 2, and a blue horizontal -rule is placed between the static frame and the first -flow frame. (However the horizontal rule will span both -flow frames since that is the width of the static frame.) - -<P> -In the following example, the rules have been redefined -to use a zigzag pattern (which is obtained using the <TT>tikz</TT><A NAME="6400"></A> -package): -<PRE> -\usepackage{flowfram} -\usepackage{tikz} -\usetikzlibrary{snakes} - -\twocolumnStop - -\renewcommand{\ffvrule}[3]{% -\hfill -\tikz{\draw[snake=zigzag,line width=#2,yshift=-#1] (0,0) -- (0pt,#3);}% -\hfill\mbox{}} - -\insertvrule{flow}{1}{flow}{2} - -\renewcommand{\ffhrule}[3]{% -\tikz{\draw[snake=zigzag,line width=#3,xshift=-#1] (0,0) -- (#2,0pt);}} - -\inserthrule{static}{1}{flow}{1} -</PRE> - -<P> -<A HREF="ffuserguide.html#top">Top</A> | <A HREF="ffuserguide.html#index">Index</A> - -<P> - -<H1><A NAME="SECTION0070000000000000000000"> -6. Thumbtabs and Minitocs</A> -</H1> - -<P> - -<I>This chapter describes how to create thumbtabs and minitocs, -such as those used in the PDF version of this document.</I> -<P> - -<P> - -<H1><A NAME="SECTION0071000000000000000000"> -6.1 Thumbtabs</A> -</H1> - -<P> -On the right hand side of the odd pages -and on the left hand side of the even pages in the -PDF version of this document, there is a blue rectangle -with the chapter number in it. This is a thumbtab, and it gives -you a rough idea whereabouts in the document you are when you -quickly flick through the pages. Each thumbtab is in fact -a dynamic frame, and you can control whether to make the -number and/or title appear in the thumbtab by using one or -more of the package options: <TT>ttbtitle</TT><A NAME="6407"></A> (show -title--default), <TT>ttbnotitle</TT><A NAME="6410"></A> (don't show the title), -<TT>ttbnum</TT><A NAME="6413"></A> (show the number) and <TT>ttbnonum</TT><A NAME="6416"></A> -(don't show the number--default). - -<P> -If you want thumbtabs in your document, you need to use -the command - -<P> -<TT>\makethumbtabs</TT><A NAME="6419"></A><TT>[<I>y offset</I>]{<I>height</I>}[<I>section type</I>]</TT> -<P> -in the document -preamble. By default, the topmost thumbtab is level with the -top of the <A HREF=ffuserguide.html#gls:typeblock NAME="14865">typeblock</A>, but can be shifted vertically -using the first optional argument <I>y offset</I>. Each -thumbtab will be <I>height</I> high, and will correspond to the -sectioning type <I>section type</I>. If <I>section type</I> -is omitted, chapters will be used if the <TT>\chapter</TT><A NAME="6430"></A> -command is defined, otherwise sections will be used. -The width of the thumbtabs is given by the length - -<P> -<TT>\thumbtabwidth</TT><A NAME="6435"></A> -<P> -which is 1cm by default. -The command - -<P> -<TT>\thumbtabindex</TT><A NAME="6440"></A> -<P> -will display the thumbtab index (all thumbtabs) on the current page. -You then need to use - -<P> -<TT>\enablethumbtabs</TT><A NAME="6445"></A> -<P> -to start the individual thumbtabs and - -<P> -<TT>\disablethumbtabs</TT><A NAME="6450"></A> -<P> -to make them go away. -You can align the table of contents with the thumbtabs<A NAME="tex2html114" - HREF="#foot2404"><SUP>6.1</SUP></A> using -the command - -<P> -<TT>\tocandthumbtabindex</TT><A NAME="6455"></A> -<P> -instead of -the commands <TT>\tableofcontents</TT><A NAME="6460"></A> and -<TT>\thumbtabindex</TT><A NAME="6465"></A>. If you are using the <TT>hyperref</TT><A NAME="6470"></A> -package, the text on the thumbtab index will be a hyperlink -to the corresponding part of the document. Note that when using -<TT>\tocandthumbtabindex</TT><A NAME="6473"></A> you may -need to shift the thumbtabs vertically up or down to make -sure that they align correctly with the table of contents. - -<P> -The format of the text on the thumbtabs is given by the command - -<P> -<TT>\thumbtabindexformat</TT><A NAME="6478"></A> -<P> -for the thumbtab index entries, and - -<P> -<TT>\thumbtabformat</TT><A NAME="6483"></A> -<P> -for the individual thumbtabs. By -default the text on the thumbtabs will be rotated, but as -rotating is not implemented by some previewers, the package option -<TT>norotate</TT><A NAME="6488"></A> is provided, which will stack the letters -vertically. This does not look as good as the rotated text. -Note also that some previewers do not put the hyperlink in the -correct place when the link has been rotated, so this may -also cause a problem. - -<P> -The thumbtab attributes can be changed using - -<P> -<TT>\setthumbtab</TT><A NAME="6491"></A><TT>{<I>n</I>}{<I>key value list</I>}</TT> -<P> -where <I>n</I> is the thumbtab number starting -from 1 (for the top thumbtab) to the value given by the counter -<TT>maxthumbtabs</TT><A NAME="6500"></A> -(for the bottom thumbtab). Note that these numbers are not -related to the associated frame <A HREF=ffuserguide.html#gls:idn NAME="14876">IDN</A>. You may also use -the keyword <TT>all</TT> instead of <I>n</I> to indicate that the -new attributes should apply to all thumbtabs. - -<P> -To just change the settings for the thumbtab index, use - -<P> -<TT>\setthumbtabindex</TT><A NAME="6503"></A><TT>{<I>n</I>}{<I>key value list</I>}</TT> -<P> -The <I>key value list</I> for both these commands is the same as that -for <TT>\setdynamicframe</TT><A NAME="6512"></A>. Again <I>n</I> may either be the -thumbtab index or the keyword <TT>all</TT>. - -<P> -By default, the thumbtabs have a grey background. In the PDF -version of this document, I used: -<PRE> -\setthumbtab{1}{backcolor=[rgb]{0.15,0.15,1}} -\setthumbtab{2}{backcolor=[rgb]{0.2,0.2,1}} -\setthumbtab{3}{backcolor=[rgb]{0.25,0.25,1}} -\setthumbtab{4}{backcolor=[rgb]{0.3,0.3,1}} -\setthumbtab{5}{backcolor=[rgb]{0.35,0.35,1}} -\setthumbtab{6}{backcolor=[rgb]{0.4,0.4,1}} -\setthumbtab{7}{backcolor=[rgb]{0.45,0.45,1}} -\setthumbtab{8}{backcolor=[rgb]{0.5,0.5,1}} -</PRE> -to change the thumbtab background colour to shades of blue. - -<P> -I also changed the style of the thumbtab text using: -<PRE> -\newcommand{\thumbtabstyle}[1]{{\hypersetup{linkcolor=white}% -\textbf{\large\sffamily #1}}} -\setthumbtab{all}{style=thumbtabstyle,textcolor=white} -</PRE> -Note that the style uses <TT>\hypersetup</TT><A NAME="6517"></A><A NAME="tex2html115" - HREF="#foot3458"><SUP>6.2</SUP></A> to change the colour of the hyperlink text, -since the hyperlink overrides the text colour. -<P> -<A HREF="ffuserguide.html#top">Top</A> | <A HREF="ffuserguide.html#index">Index</A> - -<P> - -<H1><A NAME="SECTION0072000000000000000000"> -6.2 Minitocs</A> -</H1> - -<P> -In the PDF version of this document, after each chapter heading, -there is a mini table of contents for that chapter. To enable minitocs, -use the command - -<P> -<TT>\enableminitoc</TT><A NAME="6529"></A><TT>[<I>section type</I>]</TT> -<P> -The default <I>section type</I> is the same as that used by -the thumbtabs. - -<P> -If you want the minitocs to appear in a <A HREF=ffuserguide.html#gls:dynamic NAME="14894">dynamic frame</A>, you -can use - -<P> -<TT>\appenddfminitoc</TT><A NAME="6536"></A><TT>{<I>IDN</I>}</TT> -<P> -where <I>IDN</I> is the <A HREF=ffuserguide.html#gls:idn NAME="14901">IDN</A> of the appropriate dynamic frame. -There is also a starred version available if you want to -use the <A HREF=ffuserguide.html#gls:idl NAME="14912">IDL</A> instead of the IDN. - -<P> -For example, in the PDF version of this document I -used the command: -<PRE> -\appenddfminitoc*{chaphead} -</PRE> -in the preamble, which appended the minitocs to the -dynamic frame with IDL <TT>chaphead</TT>. - -<P> -The style of the minitoc text is given by the command - -<P> -<TT>\minitocstyle</TT><A NAME="6543"></A><TT>{<I>contents</I>}</TT> -<P> -where the argument is the contents -of the minitoc. This command may be redefined if you want -to change the minitoc style. The gap before the minitoc -is given by the length - -<P> -<TT>\beforeminitocskip</TT><A NAME="6550"></A> -<P> -and the gap after the minitoc is given by the length - -<P> -<TT>\afterminitocskip</TT><A NAME="6555"></A> -<P> -These lengths may be changed using <TT>\setlength</TT><A NAME="6560"></A>. -<P> -<A HREF="ffuserguide.html#top">Top</A> | <A HREF="ffuserguide.html#index">Index</A> - -<P> - -<H1><A NAME="SECTION0080000000000000000000"> -7. Global Settings</A> -</H1> - -<P> - -<I>This section describes style macros, lengths and counters used -by the <TT>flowfram</TT> package.</I> -<P> - -<P> - -<H1><A NAME="SECTION0081000000000000000000"> -7.1 Macros</A> -</H1> -The following macros can be changed using <TT>\renewcommand</TT><A NAME="6569"></A>: - -<P> - -<UL> -<LI><TT>\setffdraftcolor</TT><A NAME="6574"></A> - -<P> -This sets the colour of the <A HREF=ffuserguide.html#gls:bbox NAME="14944">bounding box</A> when it is displayed in draft mode. The default value is: -<code>\color[gray]{0.8}</code>. For example, if you want a darker grey, -do: -<PRE> -\renewcommand{\setffdraftcolor}{\color[gray]{0.3}} -</PRE> - -<P> -</LI> -<LI><TT>\setffdrafttypeblockcolor</TT><A NAME="6579"></A> - -<P> -This sets the colour of -the <A HREF=ffuserguide.html#gls:bbox NAME="14951">bounding box</A> of the <A HREF=ffuserguide.html#gls:typeblock NAME="14958">typeblock</A> when it is displayed -in draft mode. The default value is: <code>\color[gray]{0.9}</code>. -For example, if you want a medium grey, do: -<PRE> -\renewcommand{\setffdrafttypeblockcolor}{\color[gray]{0.5}} -</PRE> - -<P> -</LI> -<LI><TT>\fflabelfont</TT><A NAME="6584"></A> - -<P> -This sets the font size for the <A HREF=ffuserguide.html#gls:bbox NAME="14965">bounding box</A> markers in -draft mode. The default value is: <code>\small\sffamily</code>. -For example, if you want a larger font, do: -<PRE> -\renewcommand{\fflabelfont}{\large\sffamily} -</PRE> - -<P> -</LI> -<LI><TT>\ffruledeclarations</TT><A NAME="6589"></A> - -<P> -This sets the declarations that affect the rules created using -<TT>\insertvrule</TT><A NAME="6594"></A> and <TT>\inserthrule</TT><A NAME="6599"></A>. The default -definition does nothing. -See <A HREF="ffuserguide.html#sec:insertrule">Vertical and -Horizontal Rules</A> for further details. - -<P> -</LI> -<LI><TT>\ffcontinuedtextfont</TT><A NAME="6604"></A><TT>{<I>text</I>}</TT> - -<P> -This sets <I>text</I> in the continuation font. The default definition -does <code>\emph{\small </code><I>text</I><code>}</code>. See -<A HREF="ffuserguide.html#sec:static">Static Frames</A> -and <A HREF="ffuserguide.html#sec:dynamic">Dynamic -Frames</A> for further details. - -<P> -</LI> -</UL> - -<P> -<A HREF="ffuserguide.html#top">Top</A> | <A HREF="ffuserguide.html#index">Index</A> - -<P> - -<H1><A NAME="SECTION0082000000000000000000"> -7.2 Lengths</A> -</H1> -The following are lengths, which can be changed using -<TT>\setlength</TT><A NAME="6615"></A>: - -<P> - -<UL> -<LI><TT>\fflabelsep</TT><A NAME="6620"></A> - -<P> -This is the distance from the right hand side of the -<A HREF=ffuserguide.html#gls:bbox NAME="14973">bounding box</A> at which to place the <A HREF=ffuserguide.html#gls:bbox NAME="14980">bounding box</A> marker. The -default value is: <TT>1pt</TT> - -<P> -</LI> -<LI><TT>\flowframesep</TT><A NAME="6625"></A> - -<P> -This is the gap between the text of the <A HREF=ffuserguide.html#gls:frame NAME="14987">frame</A> and -its border, for the standard border types. - -<P> -</LI> -<LI><TT>\flowframerule</TT><A NAME="6630"></A> - -<P> -This is the width of the <A HREF=ffuserguide.html#gls:frame NAME="14994">frame's</A> border, if using -a border given by a <A HREF=ffuserguide.html#gls:fcmd NAME="15001">frame making command</A> that uses <TT>\fboxsep</TT><A NAME="6635"></A> -to set its border width (e.g. <TT>\fbox</TT><A NAME="6640"></A>). - -<P> -</LI> -<LI><TT>\sdfparindent</TT><A NAME="6645"></A> - -<P> -This is the paragraph indentation within <A HREF=ffuserguide.html#gls:static NAME="15004">static</A> or -<A HREF=ffuserguide.html#gls:dynamic NAME="15007">dynamic</A> frames. -The default value is 0pt. - -<P> -</LI> -<LI><TT>\vcolumnsep</TT><A NAME="6654"></A> - -<P> -This is the approximate vertical distance between the top frame -and the column frames when using <TT>\Ncolumntop</TT><A NAME="6659"></A> etc. -(The height of the <A HREF=ffuserguide.html#gls:flow NAME="15014">flow frame</A> may be adjusted to make it -an integer multiple of <TT>\baselineskip</TT><A NAME="6664"></A>.) - -<P> -</LI> -<LI><TT>\columnsep</TT><A NAME="6669"></A> - -<P> -This is the horizontal distance between the column frames -when using <TT>\Ncolumn</TT><A NAME="6674"></A> or <TT>\Ncolumntop</TT><A NAME="6679"></A> etc - -<P> -</LI> -<LI><TT>\ffcolumnseprule</TT><A NAME="6684"></A> - -<P> -This is the width of vertical rules created using -<TT>\insertvrule</TT><A NAME="6689"></A> or the height of horizontal rules created -using <TT>\inserthrule</TT><A NAME="6694"></A>. - -<P> -</LI> -<LI><TT>\beforeminitocskip</TT><A NAME="6699"></A> - -<P> -This is the vertical distance before the minitoc. - -<P> -</LI> -<LI><TT>\afterminitocskip</TT><A NAME="6704"></A> - -<P> -This is the vertical distance after the minitoc. -</LI> -</UL> - -<P> -<A HREF="ffuserguide.html#top">Top</A> | <A HREF="ffuserguide.html#index">Index</A> - -<P> - -<H1><A NAME="SECTION0083000000000000000000"></A> -<A NAME="sec:counters"></A> -<BR> -7.3 Counters -</H1> -The following are counters that can be accessed via -<TT>\value</TT><A NAME="6713"></A><TT>{<I>counter name</I>}</TT> or via -<code>\the</code><I>counter name</I>. However the value of these counters -should not be modified. - -<P> -<DL> -<DT><STRONG><TT>maxflow</TT><A NAME="6720"></A></STRONG></DT> -<DD>The total number of <A HREF=ffuserguide.html#gls:flow NAME="15064">flow frames</A> that have -been defined so far. - -<P> -</DD> -<DT><STRONG><TT>thisframe</TT><A NAME="6723"></A></STRONG></DT> -<DD>Stores the <A HREF=ffuserguide.html#gls:idn NAME="15071">IDN</A> of the current -flow frame. You can label and reference the <A HREF=ffuserguide.html#gls:idn NAME="15082">IDN</A> using - -<P> -<TT>\labelflowid</TT><A NAME="6726"></A><TT>{<I>label</I>}</TT> -<P> -This is analogous to the standard <TT>\label</TT><A NAME="6733"></A> command, but will -always refer to the IDN of the current flow frame. It can -then be referenced using <TT>\ref</TT><A NAME="6738"></A><TT>{<I>label</I>}</TT>. Note that -this will always refer to the current flow frame even when used -in the contents of a <A HREF=ffuserguide.html#gls:static NAME="15097">static</A> or -<A HREF=ffuserguide.html#gls:dynamic NAME="15100">dynamic</A> frame. - -<P> -Don't use more than one instance of <TT>\labelflowid</TT><A NAME="6749"></A> in a given -flow frame for a given page or you will get a "multiply defined -references" warning. - -<P> -</DD> -<DT><STRONG><TT>displayedframe</TT><A NAME="6754"></A></STRONG></DT> -<DD>Stores the index of the currently -displayed <A HREF=ffuserguide.html#gls:flow NAME="15111">flow frame</A>. This will be the same as the <A HREF=ffuserguide.html#gls:idn NAME="15118">IDN</A> if all -flow frames are displayed on the current page, but if some are -hidden, the values may be different. You can label this counter -using - -<P> -<TT>\labelflow</TT><A NAME="6757"></A><TT>{<I>label</I>}</TT> -<P> -and reference it elsewhere in the document using -<TT>\ref</TT><A NAME="6764"></A><TT>{<I>label</I>}</TT>. For example, if you are using -a column layout, you might want to do something like: -<PRE> -This text is about hippos\labelflow{hippos}. - -% Somewhere else in the document -See column~\ref{hippos} on page~\pageref{hippos} -for information on hippos. -</PRE> -Don't use more than one instance of <TT>\labelflow</TT><A NAME="6771"></A> in a given -flow frame for a given page or you will get a "multiply defined -references" warning. Note that -<TT>\labelflow</TT><A NAME="6776"></A> will always refer to the current flow frame even when used in the contents of a static or dynamic <A HREF=ffuserguide.html#gls:frame NAME="15137">frame</A>. - -<P> -</DD> -<DT><STRONG><TT>maxstatic</TT><A NAME="6781"></A></STRONG></DT> -<DD>The total number of <A HREF=ffuserguide.html#gls:static NAME="15144">static frames</A> that have -been defined so far. - -<P> -</DD> -<DT><STRONG><TT>maxdynamic</TT><A NAME="6784"></A></STRONG></DT> -<DD>The total number of <A HREF=ffuserguide.html#gls:dynamic NAME="15151">dynamic frames</A> that -have been defined so far. - -<P> -</DD> -<DT><STRONG><TT>maxthumbtabs</TT><A NAME="6787"></A></STRONG></DT> -<DD>The total number of thumbtabs. -</DD> -</DL> - -<P> -<A HREF="ffuserguide.html#top">Top</A> | <A HREF="ffuserguide.html#index">Index</A> - -<P> - -<H1><A NAME="SECTION0090000000000000000000"> -8. Troubleshooting</A> -</H1> - -<P> - -<I>This chapter should be consulted if you experience any -problems using the <TT>flowfram</TT> package.</I> -<P> - -<P> -For an up-to-date list of frequently asked questions, see -the <A NAME="tex2html143" - HREF="http://theoval.cmp.uea.ac.uk/~nlct/latex/packages/faq/flowframfaq.html">flowfram FAQ</A>. -If you have a query that is not addressed here, please try there -before contacting me. -<P> -<A HREF="ffuserguide.html#top">Top</A> | <A HREF="ffuserguide.html#index">Index</A> - -<P> - -<H1><A NAME="SECTION0091000000000000000000"> -8.1 General Queries</A> -</H1> - -<P> - -<OL> -<LI>If all my <A HREF=ffuserguide.html#gls:flow NAME="15175">flow frames</A> are only defined on, say, -pages 1-10, what happens if I then add some extra text so that -the document exceeds 10 pages? - -<P> -The output routine will create a new <A HREF=ffuserguide.html#gls:flow NAME="15182">flow frame</A> the size -of the <A HREF=ffuserguide.html#gls:typeblock NAME="15189">typeblock</A> and use that. - -<P> -</LI> -<LI>Can I use the formatted page number in <A HREF=ffuserguide.html#gls:pglist NAME="15196">page lists</A>? - -<P> -No. - -<P> -</LI> -<LI><A NAME="itm:whynot"></A> Why not? - -<P> -When the output routine finishes with one <A HREF=ffuserguide.html#gls:flow NAME="15203">flow frame</A> it looks for the -next <A HREF=ffuserguide.html#gls:flow NAME="15210">flow frame</A> defined on that page. If there are none left, it then -searches through the <A HREF=ffuserguide.html#gls:pglist NAME="15217">page list</A> of all the defined <A HREF=ffuserguide.html#gls:flow NAME="15224">flow frames</A> to -see if the next page lies in that range. If there are none defined on -that page, it ships out that page, and tries the next page. This gives -rise to two problems: - -<P> - -<OL> -<LI>LaTeX is not clairvoyant. If it is currently -on page 14, and on the next page the page numbering changes -to A, it has no way of knowing this until it has reached -that point, which it hasn't yet. So it is looking for a -<A HREF=ffuserguide.html#gls:flow NAME="15231">flow frame</A> defined on page 15, not on page A. - -<P> -</LI> -<LI>How does LaTeX tell if page C lies between -pages A and D? It would require an algorithm that can convert -from a formatted number back to an integer. Given that there -are many different ways of formatting the value of a counter -(besides the standard Roman and alphabetical formats) it -would be impossible to write an algorithm to do this -for some arbitrary format. -</LI> -</OL> - -<P> -</LI> -<LI>Can I have an arbitrarily shaped <A HREF=ffuserguide.html#gls:frame NAME="15238">frame</A>? -<A NAME="itm:parshape"></A> -<P> -You can assign certain irregular shapes to <A HREF=ffuserguide.html#gls:static NAME="15241">static</A> or -<A HREF=ffuserguide.html#gls:dynamic NAME="15244">dynamic</A> frames, -using the shape<A NAME="6801"></A> key (see -<A HREF="ffuserguide.html#sec:parshape">Non-Rectangular -Frames</A>). -Note that the <A HREF=ffuserguide.html#gls:bbox NAME="15251">bounding box</A> will still appear as a rectangle with -the dimensions of the given <A HREF=ffuserguide.html#gls:frame NAME="15258">frame</A> which may not correspond -to the assigned shape. -This function is not available for <A HREF=ffuserguide.html#gls:flow NAME="15265">flow frames</A>. - -<P> -</LI> -<LI>Why has the text from my <A HREF=ffuserguide.html#gls:flow NAME="15272">flow frame</A> appeared in a -<A HREF=ffuserguide.html#gls:static NAME="15279">static frame</A> or <A HREF=ffuserguide.html#gls:dynamic NAME="15286">dynamic frame</A>? - -<P> -Assuming you haven't inadvertently set that text as the contents -of the <A HREF=ffuserguide.html#gls:static NAME="15289">static</A> or -<A HREF=ffuserguide.html#gls:dynamic NAME="15292">dynamic</A> frame, the frames are most likely -overlapping (see <A HREF="ffuserguide.html#sec:stacking">Frame -Stacking Order</A>). -In an attempt to clarify what's going on, suppose you have -defined a <A HREF=ffuserguide.html#gls:static NAME="15299">static frame</A>, a <A HREF=ffuserguide.html#gls:dynamic NAME="15306">dynamic frame</A> and two <A HREF=ffuserguide.html#gls:flow NAME="15313">flow frames</A>. The -following is an approximate<A NAME="tex2html144" - HREF="#foot2635"><SUP>8.1</SUP></A> analogy: TeX has a sheet of -paper on the table, and has pencilled<A NAME="tex2html145" - HREF="#foot2636"><SUP>8.2</SUP></A> in a -rectangle denoting the <A HREF=ffuserguide.html#gls:typeblock NAME="15320">typeblock</A>. The paper is put to one -side for now. TeX also has four rectangular sheets -of transparent paper. The first (which I shall call sheet 1) -represents the <A HREF=ffuserguide.html#gls:static NAME="15327">static frame</A>, the next two (which I shall call -sheets 2 and 3) represent the <A HREF=ffuserguide.html#gls:flow NAME="15334">flow frames</A>, and the last one -(which I shall call sheet 4) represents the <A HREF=ffuserguide.html#gls:dynamic NAME="15341">dynamic frame</A>. -TeX starts work on filling sheet 2 with the document text. -Once it has put as much text on that sheet as it considers -possible (according to its views on aesthetics), it puts sheet 2 -into the "in tray", and then continues on sheet 3. While it's -filling in sheets 2 and 3, if it encounters a command or -environment that tells it what to put in the <A HREF=ffuserguide.html#gls:static NAME="15348">static frame</A>, -it fills in sheet 1 and then puts sheet 1 into the "in tray" and -resumes where it left off on sheet 2 or 3. Similarly, if -it encounters a command that tells it what to put in the -<A HREF=ffuserguide.html#gls:dynamic NAME="15355">dynamic frame</A>, it stops what it's doing, fills in sheet 4, then -puts sheet 4 into the "in tray", and resumes where it left off. -Only when it has finished sheet 3 (the last <A HREF=ffuserguide.html#gls:flow NAME="15362">flow frame</A> defined -on that page), will it gather together all -the transparent sheets, and fix them onto the page starting -with sheet 1 through to sheet 4, measuring the bottom left hand -corner of each transparent sheet relative to the bottom left hand -corner of the <A HREF=ffuserguide.html#gls:typeblock NAME="15369">typeblock</A>. TeX will then put that page -aside, and start work on the next page. If two or more of the -transparent sheets overlap, you will see through the top one into -the one below (unless of course the top one has been painted -over, either by setting a background colour, or by adding an -image that has a non-transparent background.) - -<P> -Note that it's also possible that the overlap is caused by an -overfull hbox that's causing the text to poke out the side of the -<A HREF=ffuserguide.html#gls:flow NAME="15376">flow frame</A> into a neighbouring <A HREF=ffuserguide.html#gls:frame NAME="15383">frame</A>. Check the log file for -warnings or use the <TT>draft</TT> option to the document class -which will place a filled rectangle on the end of overfull lines. - -<P> -</LI> -<LI>Why do I get lots of overfull hbox messages? - -<P> -Probably because you have narrow <A HREF=ffuserguide.html#gls:frame NAME="15390">frames</A>. It's better to use -ragged right formatting when the frames are narrow. - -<P> -</LI> -<LI>Why do I keep getting multiply-defined warnings? - -<P> -Probably because you have used <TT>\label</TT><A NAME="6807"></A> in a <A HREF=ffuserguide.html#gls:static NAME="15393">static</A> or -<A HREF=ffuserguide.html#gls:dynamic NAME="15396">dynamic</A> frame that is displayed on more than one page. Try using the clear<A NAME="6815"></A> -key to ensure that the frame is always cleared at the end of each -page. - -<P> -</LI> -<LI>What happens if I use a command or environment -that switches to two-column mode (e.g. <TT>theindex</TT><A NAME="6817"></A>)? - -<P> -As from version 1.01, any <TT>\onecolumn</TT><A NAME="6820"></A> or -<TT>\twocolumn</TT><A NAME="6825"></A> commands that occur outside of the -preamble will print the contents of the optional argument, -and issue a warning. It is recommended that you set up -your own frames for use in the index. See the source code of this -document, <TT>ffuserguide.tex</TT>, for an example. - -<P> -</LI> -<LI>How do I change the vertical alignment -of material inside a <A HREF=ffuserguide.html#gls:static NAME="15399">static</A> or -<A HREF=ffuserguide.html#gls:dynamic NAME="15402">dynamic</A> frame? - -<P> -Use the valign<A NAME="6833"></A> key in <TT>\setstaticframe</TT><A NAME="6835"></A> or -<TT>\setdynamicframe</TT><A NAME="6840"></A> (new to version 1.03). - -<P> -</LI> -<LI><A NAME="itm:absval"></A> How do I compute the distance from the edge -of the page instead of the <A HREF=ffuserguide.html#gls:typeblock NAME="15409">typeblock</A>? - -<P> -See <A HREF="ffuserguide.html#sec:typeblockloc">Determining the -Location of the Typeblock</A>. - -<P> -</LI> -<LI>Is there a GUI I can use to make it easier to create the -<A HREF=ffuserguide.html#gls:frame NAME="15416">frames</A>? - -<P> -Yes, Jpgfdraw which can be downloaded from: -<TT><A NAME="tex2html146" - HREF="http://theoval.cmp.uea.ac.uk/~nlct/jpgfdraw/">http://theoval.cmp.uea.ac.uk/~nlct/jpgfdraw/</A></TT> -</LI> -</OL> - -<P> -<A HREF="ffuserguide.html#top">Top</A> | <A HREF="ffuserguide.html#index">Index</A> - -<P> - -<H1><A NAME="SECTION0092000000000000000000"> -8.2 Unexpected Output</A> -</H1> - -<P> - -<OL> -<LI>The lines at the beginning of my <A HREF=ffuserguide.html#gls:flow NAME="15426">flow frames</A> are the -wrong width. - -<P> -This is a problem that will occur if you have <A HREF=ffuserguide.html#gls:flow NAME="15433">flow frames</A> with different widths, as the change in <TT>\hsize</TT><A NAME="6849"></A> -does not come into effect until a paragraph break. So if -you have a paragraph that spans two <A HREF=ffuserguide.html#gls:flow NAME="15440">flow frames</A>, the end -of the paragraph at the beginning of the second <A HREF=ffuserguide.html#gls:flow NAME="15447">flow frame</A> will retain the width it had at the start of the -paragraph at the bottom of the previous <A HREF=ffuserguide.html#gls:flow NAME="15454">flow frame</A>. You can -fix the problem by inserting <TT>\framebreak</TT><A NAME="6854"></A> at the -point where the <A HREF=ffuserguide.html#gls:frame NAME="15461">frame</A> break occurs -(see <A HREF="ffuserguide.html#sec:framebreak">Prematurely Ending a -Flow Frame</A>). - -<P> -</LI> -<LI>My <A HREF=ffuserguide.html#gls:frame NAME="15468">frames</A> shift to the right when I add a border. - -<P> -This may occur if you use a border that is not recognised -by the <TT>flowfram</TT> package. You will need to set the -offset using the <TT>offset</TT> key (see -<A HREF="ffuserguide.html#sec:modattr">Modifying Frame -Attributes</A>). - -<P> -</LI> -<LI>I have a vertical white strip along the right hand side -of every page. - -<P> -This can happen if you have, say, an A4 document, and -<TT>ghostscript</TT><A NAME="6859"></A> has letter as the default paper size. You can -change the default paper size by editing the file <code>gs_init.ps</code>. -Change: -<PRE> -% Optionally choose a default paper size other than U.S. letter. -% (a4) -</PRE> -to: -<PRE> -% Optionally choose a default paper size other than U.S. letter. -(a4) -</PRE> - -<P> -</LI> -<LI>I don't have any output. - -<P> -All your <A HREF=ffuserguide.html#gls:flow NAME="15475">flow frames</A> are empty. TeX doesn't put the -frames onto the page until it has finished putting text -into the flow frames. So if there is no text to go in the -flow frames it won't output the page. If you only want the -<A HREF=ffuserguide.html#gls:static NAME="15490">static frames</A> or <A HREF=ffuserguide.html#gls:dynamic NAME="15497">dynamic frames</A> filled in, and nothing -outside of them, just do <code>\mbox{}\clearpage</code>. -This will put -an invisible something with zero area into your -flow frame, but it's enough to convince TeX that the -document contains some text. - -<P> -</LI> -<LI>The last page hasn't appeared. - -<P> -See the previous answer. - -<P> -</LI> -<LI>There is no paragraph indentation inside my -<A HREF=ffuserguide.html#gls:static NAME="15504">static</A> or -<A HREF=ffuserguide.html#gls:dynamic NAME="15507">dynamic</A> frames. - -<P> -The paragraph indentation in <A HREF=ffuserguide.html#gls:static NAME="15510">static</A> or -<A HREF=ffuserguide.html#gls:dynamic NAME="15513">dynamic</A> frames is governed -by the length <TT>\sdfparindent</TT><A NAME="6870"></A> which is set to 0pt by -default. To make the indentation the same as that used by -<A HREF=ffuserguide.html#gls:flow NAME="15520">flow frames</A> place the following in the preamble: -<PRE> -\setlength{\sdfparindent}{\parindent} -</PRE> - -<P> -</LI> -<LI>My section numbering is in the wrong order. - -<P> -Remember that the contents of the <A HREF=ffuserguide.html#gls:dynamic NAME="15527">dynamic frames</A> are not set -until the page is shipped out, and the contents will be set -in the order of <A HREF=ffuserguide.html#gls:idn NAME="15534">IDN</A>, so if you have any sectioning commands -occuring within dynamic frames, they may not be set in the same -order as they are in your input file. - -<P> -</LI> -<LI>The contents of my <A HREF=ffuserguide.html#gls:static NAME="15541">static</A> or -<A HREF=ffuserguide.html#gls:dynamic NAME="15544">dynamic</A> frame have shifted -to the left when I used <TT>\parshape</TT><A NAME="6879"></A>. - -<P> -This will happen if your <TT>\parshape</TT><A NAME="6884"></A> specification -exceeds the linewidth. For example: -<PRE> -\parshape=1 0.4\linewidth 0.7\linewidth -</PRE> -This specifies a line with overall length -<code>1.1\linewidth</code> which is too long. - -<P> -</LI> -</OL> - -<P> -<A HREF="ffuserguide.html#top">Top</A> | <A HREF="ffuserguide.html#index">Index</A> - -<P> - -<H1><A NAME="SECTION0093000000000000000000"> -8.3 Error Messages</A> -</H1> - -<P> - -<OL> -<LI><code>Illegal unit of measure (pt inserted)</code> - -<P> -All lengths must have units. Remember to include the -units when defining new <A HREF=ffuserguide.html#gls:frame NAME="15586">frames</A>. The following -keys require lengths: <TT>width</TT>, <TT>height</TT>, -<TT>x</TT>, <TT>y</TT> and <TT>offset</TT><A NAME="tex2html206" - HREF="#foot3488"><SUP>8.3</SUP></A>. - -<P> -</LI> -<LI><code>Missing number, treated as zero</code> - -<P> -LaTeX is expecting a number. There are a number of -possible causes: - -<P> - -<OL> -<LI>You have used an <A HREF=ffuserguide.html#gls:idl NAME="15593">IDL</A> instead of an <A HREF=ffuserguide.html#gls:idn NAME="15600">IDN</A>. If you -want to refer to a frame by its label, you need to remember -to use the starred versions of the -<code>\set</code><I>type</I><code>frame</code> commands, or when setting -the contents of <A HREF=ffuserguide.html#gls:static NAME="15607">static frames</A> or <A HREF=ffuserguide.html#gls:dynamic NAME="15614">dynamic frames</A>. - -<P> -</LI> -<LI>When specifying page lists, you have mixed keywords -with page ranges. For example: <TT>1,even</TT> is invalid. -</LI> -</OL> - -<P> -</LI> -<LI><code>Flow frame IDL '</code><I>label</I><code>' already defined</code> - -<P> -All <A HREF=ffuserguide.html#gls:idl NAME="15621">IDLs</A> within each <A HREF=ffuserguide.html#gls:frame NAME="15628">frame</A> type must be -unique. There are similar error messages for duplicate -IDLs for <A HREF=ffuserguide.html#gls:static NAME="15639">static frames</A> and <A HREF=ffuserguide.html#gls:dynamic NAME="15646">dynamic frames</A>. - -<P> -</LI> -<LI><code>Can't find flow frame id</code> - -<P> -You have specified a non-existent flow frame <A HREF=ffuserguide.html#gls:idl NAME="15657">IDL</A>. There are -similar error messages for <A HREF=ffuserguide.html#gls:static NAME="15664">static frames</A> and <A HREF=ffuserguide.html#gls:dynamic NAME="15671">dynamic frames</A>. -Check to make sure you have spelt the label correctly, and -check you are using the correct <A HREF=ffuserguide.html#gls:frame NAME="15678">frame</A> type command. -(For example, if a static frame has the IDL <TT>mylabel</TT>, -and you attempt to do -<TT>\setflowframe*</TT><A NAME="6893"></A><TT>{mylabel}{<I>options</I>}</TT>, -then you will get this error, because <TT>mylabel</TT> refers -to a static frame not a <A HREF=ffuserguide.html#gls:flow NAME="15697">flow frame</A>.) - -<P> -</LI> -<LI><code>Key 'clear' is boolean</code> - -<P> -The <TT>clear</TT> key can only have the values <TT>true</TT> -or <TT>false</TT>. - -<P> -</LI> -<LI><code>Key 'clear' not available</code> - -<P> -The <TT>clear</TT> key is only available for <A HREF=ffuserguide.html#gls:static NAME="15700">static</A> or -<A HREF=ffuserguide.html#gls:dynamic NAME="15703">dynamic</A> frames. - -<P> -</LI> -<LI><code>Key 'style' not available</code> - -<P> -The <TT>style</TT> key is only available for <A HREF=ffuserguide.html#gls:dynamic NAME="15710">dynamic frames</A>. - -<P> -</LI> -<LI><code>Key 'margin' not available</code> - -<P> -The <TT>margin</TT> key is only available for <A HREF=ffuserguide.html#gls:flow NAME="15717">flow frames</A>. - -<P> -</LI> -<LI><code>Key 'shape' not available</code> - -<P> -The <TT>shape</TT> key is only available for <A HREF=ffuserguide.html#gls:static NAME="15720">static</A> or -<A HREF=ffuserguide.html#gls:dynamic NAME="15723">dynamic</A> frames. - -<P> -</LI> -<LI><code>Dynamic frame style '</code><I>style</I><code>' not defined</code> - -<P> -The specified style <I>style</I> must be the name of a command -without the preceding backslash. It is possible that you have -mis-spelt the name, or you have forgotten to define the command. - -<P> -</LI> -<LI><code>Argument of \fbox has an extra }</code> - -<P> -This error will occur if you do, say, <code>border=\fbox</code> -instead of <code>border=fbox</code>. Remember not to include -the initial backslash. - -<P> -</LI> -<LI><code>Not in outer par mode</code> - -<P> -You can not have floats (such as figures, tables or marginal -notes) in <A HREF=ffuserguide.html#gls:static NAME="15726">static</A> or -<A HREF=ffuserguide.html#gls:dynamic NAME="15729">dynamic</A> frames. If you want -a figure or table within a <A HREF=ffuserguide.html#gls:static NAME="15732">static</A> or -<A HREF=ffuserguide.html#gls:dynamic NAME="15735">dynamic</A> frame -use <TT>staticfigure</TT><A NAME="6917"></A> or <TT>statictable</TT><A NAME="6920"></A>. - -<P> -</LI> -<LI><code>Somethings wrong---maybe missing \item</code> - -<P> -Assuming that all your list type of environments start -with <TT>\item</TT><A NAME="6923"></A>, this may be caused by something going -wrong with the toc (table of contents), ttb (thumbtab) -or aux (auxiliary) files in the previous run. Try deleting -them, and try again. - -<P> -</LI> -<LI><code>No room for a new \skip</code> - -<P> -You have exceeded TeX's 256 register limit. Use the <TT>etex</TT><A NAME="6928"></A> -package. - -<P> -</LI> -<LI><code>\verb illegal in command argument</code> - -<P> -As a general rule, you can't use verbatim text<A NAME="6930"></A> in a command -argument. -This rule applies to all the commands defined by the <TT>flowfram</TT> -package. See also below. - -<P> -</LI> -<LI>I get <code>\verb illegal in command argument</code> when using -verbatim text<A NAME="6931"></A> inside the <TT>dynamiccontents</TT><A NAME="6933"></A> environment. - -<P> -You can not use verbatim text<A NAME="6935"></A> inside either the starred or -unstarred version of the <TT>dynamiccontents</TT><A NAME="6937"></A> environment. -(See <A HREF="ffuserguide.html#pg:verb">earlier</A>.) - -<P> -<A HREF="ffuserguide.html#top">Top</A> | <A HREF="ffuserguide.html#index">Index</A> - -<P> -</LI> -</OL> - -<P> -<BR> - -<H2><A NAME="SECTION00100000000000000000000"> -Glossary</A> -</H2> -<DL COMPACT> -<DT><A NAME="gls:bbox"><B>bounding box</B></A><DD>The bounding box of a frame is the area allocated for the -contents of that frame. However the text may not completely fill that -area, and it is possible that the text may overflow that area. <A NAME="tex2html9" - HREF="ffuserguide.html#11562"> 1.1 Draft Option</A> -, <A NAME="tex2html24" - HREF="ffuserguide.html#11747"> 1.2 Frame Stacking Order</A> -, <A NAME="tex2html65" - HREF="ffuserguide.html#13025"> 3. Modifying Frame Attributes</A> -, <A NAME="tex2html68" - HREF="ffuserguide.html#13106"> 3. Modifying Frame Attributes</A> -, <A NAME="tex2html72" - HREF="ffuserguide.html#13195"> 3.1 Non-Rectangular Frames</A> -, <A NAME="tex2html121" - HREF="ffuserguide.html#14944"> 7.1 Macros</A> -, <A NAME="tex2html122" - HREF="ffuserguide.html#14951"> 7.1 Macros</A> -, <A NAME="tex2html124" - HREF="ffuserguide.html#14965"> 7.1 Macros</A> -, <A NAME="tex2html125" - HREF="ffuserguide.html#14973"> 7.2 Lengths</A> -, <A NAME="tex2html126" - HREF="ffuserguide.html#14980"> 7.2 Lengths</A> -, <A NAME="tex2html159" - HREF="ffuserguide.html#15251"> 8.1 General Queries</A> -<DT><A NAME="gls:dynamic"><B>dynamic frame</B></A><DD>Frames -in which text is fixed in place, but the contents are re-typeset -each time the frame is displayed. <A NAME="tex2html7" - HREF="ffuserguide.html#11481"> 1. Introduction</A> -, <A NAME="tex2html16" - HREF="ffuserguide.html#11631"> 1.1 Draft Option</A> -, <A NAME="tex2html22" - HREF="ffuserguide.html#11733"> 1.2 Frame Stacking Order</A> -, <A NAME="tex2html28" - HREF="ffuserguide.html#11788"> 1.3 HTML</A> -, <A NAME="tex2html49" - HREF="ffuserguide.html#12478"> 2.3 Dynamic Frames</A> -, <A NAME="tex2html56" - HREF="ffuserguide.html#12668"> 2.3.1 Important Notes</A> -, <A NAME="tex2html60" - HREF="ffuserguide.html#12846"> 3. Modifying Frame Attributes</A> -, <A NAME="tex2html70" - HREF="ffuserguide.html#13181"> 3.1 Non-Rectangular Frames</A> -, <A NAME="tex2html85" - HREF="ffuserguide.html#13420"> 4.3 Relative Locations</A> -, <A NAME="tex2html118" - HREF="ffuserguide.html#14894"> 6.2 Minitocs</A> -, <A NAME="tex2html131" - HREF="ffuserguide.html#15007"> 7.2 Lengths</A> -, <A NAME="tex2html137" - HREF="ffuserguide.html#15100"> 7.3 Counters</A> -, <A NAME="tex2html142" - HREF="ffuserguide.html#15151"> 7.3 Counters</A> -, <A NAME="tex2html158" - HREF="ffuserguide.html#15244"> 8.1 General Queries</A> -, <A NAME="tex2html164" - HREF="ffuserguide.html#15286"> 8.1 General Queries</A> -, <A NAME="tex2html166" - HREF="ffuserguide.html#15292"> 8.1 General Queries</A> -, <A NAME="tex2html168" - HREF="ffuserguide.html#15306"> 8.1 General Queries</A> -, <A NAME="tex2html173" - HREF="ffuserguide.html#15341"> 8.1 General Queries</A> -, <A NAME="tex2html175" - HREF="ffuserguide.html#15355"> 8.1 General Queries</A> -, <A NAME="tex2html182" - HREF="ffuserguide.html#15396"> 8.1 General Queries</A> -, <A NAME="tex2html184" - HREF="ffuserguide.html#15402"> 8.1 General Queries</A> -, <A NAME="tex2html196" - HREF="ffuserguide.html#15497"> 8.2 Unexpected Output</A> -, <A NAME="tex2html198" - HREF="ffuserguide.html#15507"> 8.2 Unexpected Output</A> -, <A NAME="tex2html200" - HREF="ffuserguide.html#15513"> 8.2 Unexpected Output</A> -, <A NAME="tex2html202" - HREF="ffuserguide.html#15527"> 8.2 Unexpected Output</A> -, <A NAME="tex2html205" - HREF="ffuserguide.html#15544"> 8.2 Unexpected Output</A> -, <A NAME="tex2html211" - HREF="ffuserguide.html#15614"> 8.3 Error Messages</A> -, <A NAME="tex2html215" - HREF="ffuserguide.html#15646"> 8.3 Error Messages</A> -, <A NAME="tex2html218" - HREF="ffuserguide.html#15671"> 8.3 Error Messages</A> -, <A NAME="tex2html222" - HREF="ffuserguide.html#15703"> 8.3 Error Messages</A> -, <A NAME="tex2html223" - HREF="ffuserguide.html#15710"> 8.3 Error Messages</A> -, <A NAME="tex2html226" - HREF="ffuserguide.html#15723"> 8.3 Error Messages</A> -, <A NAME="tex2html228" - HREF="ffuserguide.html#15729"> 8.3 Error Messages</A> -, <A NAME="tex2html230" - HREF="ffuserguide.html#15735"> 8.3 Error Messages</A> -<DT><A NAME="gls:flow"><B>flow frame</B></A><DD>The frames in a document such that the contents of the -<TT>document</TT><A NAME="3559"></A> environment flow from one frame to the next in -the order that they were defined. There must be at least one flow frame -on every page. <A NAME="tex2html5" - HREF="ffuserguide.html#11467"> 1. Introduction</A> -, <A NAME="tex2html14" - HREF="ffuserguide.html#11617"> 1.1 Draft Option</A> -, <A NAME="tex2html20" - HREF="ffuserguide.html#11719"> 1.2 Frame Stacking Order</A> -, <A NAME="tex2html32" - HREF="ffuserguide.html#11865"> 2.1 Flow Frames</A> -, <A NAME="tex2html39" - HREF="ffuserguide.html#12031"> 2.1.1 Prematurely Ending a Flow Frame</A> -, <A NAME="tex2html58" - HREF="ffuserguide.html#12832"> 3. Modifying Frame Attributes</A> -, <A NAME="tex2html71" - HREF="ffuserguide.html#13188"> 3.1 Non-Rectangular Frames</A> -, <A NAME="tex2html84" - HREF="ffuserguide.html#13413"> 4.3 Relative Locations</A> -, <A NAME="tex2html89" - HREF="ffuserguide.html#13498"> 5.1 Column Styles</A> -, <A NAME="tex2html93" - HREF="ffuserguide.html#14132"> 5.2 Column Styles with an Additional Frame</A> -, <A NAME="tex2html97" - HREF="ffuserguide.html#14217"> 5.3 Right to Left Columns</A> -, <A NAME="tex2html98" - HREF="ffuserguide.html#14224"> 5.3 Right to Left Columns</A> -, <A NAME="tex2html112" - HREF="ffuserguide.html#14757"> 5.4.4 Vertical and Horizontal Rules</A> -, <A NAME="tex2html132" - HREF="ffuserguide.html#15014"> 7.2 Lengths</A> -, <A NAME="tex2html133" - HREF="ffuserguide.html#15064"> 7.3 Counters</A> -, <A NAME="tex2html138" - HREF="ffuserguide.html#15111"> 7.3 Counters</A> -, <A NAME="tex2html147" - HREF="ffuserguide.html#15175"> 8.1 General Queries</A> -, <A NAME="tex2html148" - HREF="ffuserguide.html#15182"> 8.1 General Queries</A> -, <A NAME="tex2html151" - HREF="ffuserguide.html#15203"> 8.1 General Queries</A> -, <A NAME="tex2html152" - HREF="ffuserguide.html#15210"> 8.1 General Queries</A> -, <A NAME="tex2html154" - HREF="ffuserguide.html#15224"> 8.1 General Queries</A> -, <A NAME="tex2html155" - HREF="ffuserguide.html#15231"> 8.1 General Queries</A> -, <A NAME="tex2html161" - HREF="ffuserguide.html#15265"> 8.1 General Queries</A> -, <A NAME="tex2html162" - HREF="ffuserguide.html#15272"> 8.1 General Queries</A> -, <A NAME="tex2html169" - HREF="ffuserguide.html#15313"> 8.1 General Queries</A> -, <A NAME="tex2html172" - HREF="ffuserguide.html#15334"> 8.1 General Queries</A> -, <A NAME="tex2html176" - HREF="ffuserguide.html#15362"> 8.1 General Queries</A> -, <A NAME="tex2html178" - HREF="ffuserguide.html#15376"> 8.1 General Queries</A> -, <A NAME="tex2html187" - HREF="ffuserguide.html#15426"> 8.2 Unexpected Output</A> -, <A NAME="tex2html188" - HREF="ffuserguide.html#15433"> 8.2 Unexpected Output</A> -, <A NAME="tex2html189" - HREF="ffuserguide.html#15440"> 8.2 Unexpected Output</A> -, <A NAME="tex2html190" - HREF="ffuserguide.html#15447"> 8.2 Unexpected Output</A> -, <A NAME="tex2html191" - HREF="ffuserguide.html#15454"> 8.2 Unexpected Output</A> -, <A NAME="tex2html194" - HREF="ffuserguide.html#15475"> 8.2 Unexpected Output</A> -, <A NAME="tex2html201" - HREF="ffuserguide.html#15520"> 8.2 Unexpected Output</A> -, <A NAME="tex2html220" - HREF="ffuserguide.html#15697"> 8.3 Error Messages</A> -, <A NAME="tex2html224" - HREF="ffuserguide.html#15717"> 8.3 Error Messages</A> -<DT><A NAME="gls:frame"><B>frame</B></A><DD>A rectangular -area of the page in which text can be placed (not to be -confused with a frame making command). There are three types: -flow, static and dynamic. <A NAME="tex2html4" - HREF="ffuserguide.html#11452"> 1. Introduction</A> -, <A NAME="tex2html10" - HREF="ffuserguide.html#11569"> 1.1 Draft Option</A> -, <A NAME="tex2html25" - HREF="ffuserguide.html#11754"> 1.2 Frame Stacking Order</A> -, <A NAME="tex2html26" - HREF="ffuserguide.html#11782"> 1.3 HTML</A> -, <A NAME="tex2html33" - HREF="ffuserguide.html#11872"> 2.1 Flow Frames</A> -, <A NAME="tex2html40" - HREF="ffuserguide.html#12042"> 2.1.1 Prematurely Ending a Flow Frame</A> -, <A NAME="tex2html53" - HREF="ffuserguide.html#12566"> 2.3 Dynamic Frames</A> -, <A NAME="tex2html57" - HREF="ffuserguide.html#12683"> 2.3.1 Important Notes</A> -, <A NAME="tex2html61" - HREF="ffuserguide.html#12853"> 3. Modifying Frame Attributes</A> -, <A NAME="tex2html73" - HREF="ffuserguide.html#13202"> 3.1 Non-Rectangular Frames</A> -, <A NAME="tex2html74" - HREF="ffuserguide.html#13228"> 4. Locations and Dimensions</A> -, <A NAME="tex2html75" - HREF="ffuserguide.html#13260"> 4.1 Determining the Location of the Typeblock</A> -, <A NAME="tex2html77" - HREF="ffuserguide.html#13311"> 4.2 Determining the Dimensions and Locations of Frames</A> -, <A NAME="tex2html80" - HREF="ffuserguide.html#13385"> 4.3 Relative Locations</A> -, <A NAME="tex2html88" - HREF="ffuserguide.html#13450"> 5. Predefined Layouts</A> -, <A NAME="tex2html94" - HREF="ffuserguide.html#14139"> 5.2 Column Styles with an Additional Frame</A> -, <A NAME="tex2html106" - HREF="ffuserguide.html#14679"> 5.4.4 Vertical and Horizontal Rules</A> -, <A NAME="tex2html127" - HREF="ffuserguide.html#14987"> 7.2 Lengths</A> -, <A NAME="tex2html128" - HREF="ffuserguide.html#14994"> 7.2 Lengths</A> -, <A NAME="tex2html140" - HREF="ffuserguide.html#15137"> 7.3 Counters</A> -, <A NAME="tex2html156" - HREF="ffuserguide.html#15238"> 8.1 General Queries</A> -, <A NAME="tex2html160" - HREF="ffuserguide.html#15258"> 8.1 General Queries</A> -, <A NAME="tex2html179" - HREF="ffuserguide.html#15383"> 8.1 General Queries</A> -, <A NAME="tex2html180" - HREF="ffuserguide.html#15390"> 8.1 General Queries</A> -, <A NAME="tex2html186" - HREF="ffuserguide.html#15416"> 8.1 General Queries</A> -, <A NAME="tex2html192" - HREF="ffuserguide.html#15461"> 8.2 Unexpected Output</A> -, <A NAME="tex2html193" - HREF="ffuserguide.html#15468"> 8.2 Unexpected Output</A> -, <A NAME="tex2html207" - HREF="ffuserguide.html#15586"> 8.3 Error Messages</A> -, <A NAME="tex2html213" - HREF="ffuserguide.html#15628"> 8.3 Error Messages</A> -, <A NAME="tex2html219" - HREF="ffuserguide.html#15678"> 8.3 Error Messages</A> -<DT><A NAME="gls:fcmd"><B>frame making command</B></A><DD>A -LaTeX command which places some kind of border around its -argument. For example: <TT>\fbox</TT><A NAME="3572"></A>. <A NAME="tex2html64" - HREF="ffuserguide.html#13010"> 3. Modifying Frame Attributes</A> -, <A NAME="tex2html129" - HREF="ffuserguide.html#15001"> 7.2 Lengths</A> -<DT><A NAME="gls:idl"><B>identification label -(IDL)</B></A><DD>A unique -label which can be assigned to a frame, enabling you to -refer to the frame by label instead of by its -IDN. <A NAME="tex2html13" - HREF="ffuserguide.html#11606"> 1.1 Draft Option</A> -, <A NAME="tex2html38" - HREF="ffuserguide.html#11959"> 2.1 Flow Frames</A> -, <A NAME="tex2html45" - HREF="ffuserguide.html#12209"> 2.2 Static Frames</A> -, <A NAME="tex2html52" - HREF="ffuserguide.html#12523"> 2.3 Dynamic Frames</A> -, <A NAME="tex2html55" - HREF="ffuserguide.html#12616"> 2.3 Dynamic Frames</A> -, <A NAME="tex2html63" - HREF="ffuserguide.html#12911"> 3. Modifying Frame Attributes</A> -, <A NAME="tex2html78" - HREF="ffuserguide.html#13318"> 4.2 Determining the Dimensions and Locations of Frames</A> -, <A NAME="tex2html83" - HREF="ffuserguide.html#13406"> 4.3 Relative Locations</A> -, <A NAME="tex2html86" - HREF="ffuserguide.html#13431"> 4.3 Relative Locations</A> -, <A NAME="tex2html101" - HREF="ffuserguide.html#14288"> 5.4 Backdrop Effects</A> -, <A NAME="tex2html111" - HREF="ffuserguide.html#14742"> 5.4.4 Vertical and Horizontal Rules</A> -, <A NAME="tex2html120" - HREF="ffuserguide.html#14912"> 6.2 Minitocs</A> -, <A NAME="tex2html208" - HREF="ffuserguide.html#15593"> 8.3 Error Messages</A> -, <A NAME="tex2html212" - HREF="ffuserguide.html#15621"> 8.3 Error Messages</A> -, <A NAME="tex2html216" - HREF="ffuserguide.html#15657"> 8.3 Error Messages</A> -<DT><A NAME="gls:idn"><B>identification number -(IDN)</B></A><DD>A unique -number assigned to each frame, which you can use to identify -the frame when modifying its appearance. Example: if you -have defined 3 flow frames, 2 static frames and 1 dynamic -frame, the flow frames will have IDNs 1, 2 and 3, the static -frames will have IDNs 1 and 2, and the dynamic frame will -have IDN 1. <A NAME="tex2html12" - HREF="ffuserguide.html#11595"> 1.1 Draft Option</A> -, <A NAME="tex2html19" - HREF="ffuserguide.html#11712"> 1.2 Frame Stacking Order</A> -, <A NAME="tex2html21" - HREF="ffuserguide.html#11726"> 1.2 Frame Stacking Order</A> -, <A NAME="tex2html23" - HREF="ffuserguide.html#11740"> 1.2 Frame Stacking Order</A> -, <A NAME="tex2html37" - HREF="ffuserguide.html#11936"> 2.1 Flow Frames</A> -, <A NAME="tex2html46" - HREF="ffuserguide.html#12224"> 2.2 Static Frames</A> -, <A NAME="tex2html51" - HREF="ffuserguide.html#12512"> 2.3 Dynamic Frames</A> -, <A NAME="tex2html54" - HREF="ffuserguide.html#12609"> 2.3 Dynamic Frames</A> -, <A NAME="tex2html62" - HREF="ffuserguide.html#12892"> 3. Modifying Frame Attributes</A> -, <A NAME="tex2html79" - HREF="ffuserguide.html#13325"> 4.2 Determining the Dimensions and Locations of Frames</A> -, <A NAME="tex2html81" - HREF="ffuserguide.html#13392"> 4.3 Relative Locations</A> -, <A NAME="tex2html82" - HREF="ffuserguide.html#13399"> 4.3 Relative Locations</A> -, <A NAME="tex2html87" - HREF="ffuserguide.html#13438"> 4.3 Relative Locations</A> -, <A NAME="tex2html108" - HREF="ffuserguide.html#14697"> 5.4.4 Vertical and Horizontal Rules</A> -, <A NAME="tex2html110" - HREF="ffuserguide.html#14723"> 5.4.4 Vertical and Horizontal Rules</A> -, <A NAME="tex2html117" - HREF="ffuserguide.html#14876"> 6.1 Thumbtabs</A> -, <A NAME="tex2html119" - HREF="ffuserguide.html#14901"> 6.2 Minitocs</A> -, <A NAME="tex2html134" - HREF="ffuserguide.html#15071"> 7.3 Counters</A> -, <A NAME="tex2html135" - HREF="ffuserguide.html#15082"> 7.3 Counters</A> -, <A NAME="tex2html139" - HREF="ffuserguide.html#15118"> 7.3 Counters</A> -, <A NAME="tex2html203" - HREF="ffuserguide.html#15534"> 8.2 Unexpected Output</A> -, <A NAME="tex2html209" - HREF="ffuserguide.html#15600"> 8.3 Error Messages</A> -<DT><A NAME="gls:pglist"><B>page list</B></A><DD>A list of -pages. This can either be a single keyword: <TT>all</TT>, -<TT>odd</TT>, <TT>even</TT> or <TT>none</TT>, or it can -be a comma-separated list of individual page numbers or -page ranges. For example: <TT><3,5,7-11,>15</TT> -indicates pages 1,2,5,7,8,9,10,11 and all pages after page 15. -Note that these numbers refer to the actual value of the -page counter, not the absolute physical page number. <A NAME="tex2html35" - HREF="ffuserguide.html#11914"> 2.1 Flow Frames</A> -, <A NAME="tex2html44" - HREF="ffuserguide.html#12198"> 2.2 Static Frames</A> -, <A NAME="tex2html66" - HREF="ffuserguide.html#13052"> 3. Modifying Frame Attributes</A> -, <A NAME="tex2html91" - HREF="ffuserguide.html#13520"> 5.1 Column Styles</A> -, <A NAME="tex2html95" - HREF="ffuserguide.html#14146"> 5.2 Column Styles with an Additional Frame</A> -, <A NAME="tex2html100" - HREF="ffuserguide.html#14277"> 5.4 Backdrop Effects</A> -, <A NAME="tex2html150" - HREF="ffuserguide.html#15196"> 8.1 General Queries</A> -, <A NAME="tex2html153" - HREF="ffuserguide.html#15217"> 8.1 General Queries</A> -<DT><A NAME="gls:pgrange"><B>page range</B></A><DD>Page -ranges can be closed, e.g. <TT>5-10</TT>, or open, e.g. -<TT><7</TT> or <TT>>9</TT>. <A NAME="tex2html36" - HREF="ffuserguide.html#11921"> 2.1 Flow Frames</A> -, <A NAME="tex2html67" - HREF="ffuserguide.html#13067"> 3. Modifying Frame Attributes</A> -<DT><A NAME="gls:static"><B>static frame</B></A><DD>Frames in which text is fixed in place. The contents are fixed until -explicitly changed or cleared via the <TT>\clear</TT><A NAME="3562"></A> key -in <TT>\setstaticcontents</TT><A NAME="3567"></A>. <A NAME="tex2html6" - HREF="ffuserguide.html#11474"> 1. Introduction</A> -, <A NAME="tex2html15" - HREF="ffuserguide.html#11624"> 1.1 Draft Option</A> -, <A NAME="tex2html18" - HREF="ffuserguide.html#11705"> 1.2 Frame Stacking Order</A> -, <A NAME="tex2html27" - HREF="ffuserguide.html#11785"> 1.3 HTML</A> -, <A NAME="tex2html42" - HREF="ffuserguide.html#12156"> 2.2 Static Frames</A> -, <A NAME="tex2html47" - HREF="ffuserguide.html#12344"> 2.2.1 Important Notes</A> -, <A NAME="tex2html50" - HREF="ffuserguide.html#12485"> 2.3 Dynamic Frames</A> -, <A NAME="tex2html59" - HREF="ffuserguide.html#12839"> 3. Modifying Frame Attributes</A> -, <A NAME="tex2html69" - HREF="ffuserguide.html#13178"> 3.1 Non-Rectangular Frames</A> -, <A NAME="tex2html99" - HREF="ffuserguide.html#14266"> 5.4 Backdrop Effects</A> -, <A NAME="tex2html103" - HREF="ffuserguide.html#14439"> 5.4.1 Vertical stripe effects</A> -, <A NAME="tex2html104" - HREF="ffuserguide.html#14579"> 5.4.2 Horizontal stripe effect</A> -, <A NAME="tex2html105" - HREF="ffuserguide.html#14603"> 5.4.3 Background Frame</A> -, <A NAME="tex2html107" - HREF="ffuserguide.html#14686"> 5.4.4 Vertical and Horizontal Rules</A> -, <A NAME="tex2html109" - HREF="ffuserguide.html#14712"> 5.4.4 Vertical and Horizontal Rules</A> -, <A NAME="tex2html113" - HREF="ffuserguide.html#14764"> 5.4.4 Vertical and Horizontal Rules</A> -, <A NAME="tex2html130" - HREF="ffuserguide.html#15004"> 7.2 Lengths</A> -, <A NAME="tex2html136" - HREF="ffuserguide.html#15097"> 7.3 Counters</A> -, <A NAME="tex2html141" - HREF="ffuserguide.html#15144"> 7.3 Counters</A> -, <A NAME="tex2html157" - HREF="ffuserguide.html#15241"> 8.1 General Queries</A> -, <A NAME="tex2html163" - HREF="ffuserguide.html#15279"> 8.1 General Queries</A> -, <A NAME="tex2html165" - HREF="ffuserguide.html#15289"> 8.1 General Queries</A> -, <A NAME="tex2html167" - HREF="ffuserguide.html#15299"> 8.1 General Queries</A> -, <A NAME="tex2html171" - HREF="ffuserguide.html#15327"> 8.1 General Queries</A> -, <A NAME="tex2html174" - HREF="ffuserguide.html#15348"> 8.1 General Queries</A> -, <A NAME="tex2html181" - HREF="ffuserguide.html#15393"> 8.1 General Queries</A> -, <A NAME="tex2html183" - HREF="ffuserguide.html#15399"> 8.1 General Queries</A> -, <A NAME="tex2html195" - HREF="ffuserguide.html#15490"> 8.2 Unexpected Output</A> -, <A NAME="tex2html197" - HREF="ffuserguide.html#15504"> 8.2 Unexpected Output</A> -, <A NAME="tex2html199" - HREF="ffuserguide.html#15510"> 8.2 Unexpected Output</A> -, <A NAME="tex2html204" - HREF="ffuserguide.html#15541"> 8.2 Unexpected Output</A> -, <A NAME="tex2html210" - HREF="ffuserguide.html#15607"> 8.3 Error Messages</A> -, <A NAME="tex2html214" - HREF="ffuserguide.html#15639"> 8.3 Error Messages</A> -, <A NAME="tex2html217" - HREF="ffuserguide.html#15664"> 8.3 Error Messages</A> -, <A NAME="tex2html221" - HREF="ffuserguide.html#15700"> 8.3 Error Messages</A> -, <A NAME="tex2html225" - HREF="ffuserguide.html#15720"> 8.3 Error Messages</A> -, <A NAME="tex2html227" - HREF="ffuserguide.html#15726"> 8.3 Error Messages</A> -, <A NAME="tex2html229" - HREF="ffuserguide.html#15732"> 8.3 Error Messages</A> -<DT><A NAME="gls:typeblock"><B>typeblock</B></A><DD>The area of the page where the main body of the text goes. -The width and height of this area are given by -<TT>\textwidth</TT><A NAME="3549"></A> and <TT>\textheight</TT><A NAME="3554"></A>. <A NAME="tex2html8" - HREF="ffuserguide.html#11492"> 1. Introduction</A> -, <A NAME="tex2html11" - HREF="ffuserguide.html#11584"> 1.1 Draft Option</A> -, <A NAME="tex2html34" - HREF="ffuserguide.html#11903"> 2.1 Flow Frames</A> -, <A NAME="tex2html43" - HREF="ffuserguide.html#12191"> 2.2 Static Frames</A> -, <A NAME="tex2html76" - HREF="ffuserguide.html#13267"> 4.1 Determining the Location of the Typeblock</A> -, <A NAME="tex2html90" - HREF="ffuserguide.html#13505"> 5.1 Column Styles</A> -, <A NAME="tex2html96" - HREF="ffuserguide.html#14157"> 5.2 Column Styles with an Additional Frame</A> -, <A NAME="tex2html102" - HREF="ffuserguide.html#14307"> 5.4 Backdrop Effects</A> -, <A NAME="tex2html116" - HREF="ffuserguide.html#14865"> 6.1 Thumbtabs</A> -, <A NAME="tex2html123" - HREF="ffuserguide.html#14958"> 7.1 Macros</A> -, <A NAME="tex2html149" - HREF="ffuserguide.html#15189"> 8.1 General Queries</A> -, <A NAME="tex2html170" - HREF="ffuserguide.html#15320"> 8.1 General Queries</A> -, <A NAME="tex2html177" - HREF="ffuserguide.html#15369"> 8.1 General Queries</A> -, <A NAME="tex2html185" - HREF="ffuserguide.html#15409"> 8.1 General Queries</A> -</DL> - -<P> -<A HREF="ffuserguide.html#top">Top</A> | <A HREF="ffuserguide.html#index">Index</A> - -<P> -<A NAME="index"></A> -<BR> - -<H2><A NAME="SECTION00110000000000000000000"> -Index</A> -</H2><DL COMPACT> -<DT><STRONG><TT>\afterminitocskip</TT></STRONG> -<DD><A HREF="ffuserguide.html#6555">6.2</A> - | <A HREF="ffuserguide.html#6704">7.2</A> -<DT><STRONG><TT>\appenddfminitoc</TT></STRONG> -<DD><A HREF="ffuserguide.html#6536">6.2</A> -<DT><STRONG><TT>\appenddynamiccontents</TT></STRONG> -<DD><A HREF="ffuserguide.html#4116">2.3</A> -<DT><STRONG><TT>\appenddynamiccontents*</TT></STRONG> -<DD><A HREF="ffuserguide.html#4125">2.3</A> -<DT><STRONG><TT>\baselineskip</TT></STRONG> -<DD><A HREF="ffuserguide.html#4890">5.1</A> - | <A HREF="ffuserguide.html#4949">5.1</A> - | <A HREF="ffuserguide.html#4974">5.1</A> - | <A HREF="ffuserguide.html#5010">5.2</A> - | <A HREF="ffuserguide.html#6664">7.2</A> -<DT><STRONG><TT>\beforeminitocskip</TT></STRONG> -<DD><A HREF="ffuserguide.html#6550">6.2</A> - | <A HREF="ffuserguide.html#6699">7.2</A> -<DT><STRONG><TT>\caption</TT></STRONG> -<DD><A HREF="ffuserguide.html#3611">1.</A> -<DT><STRONG><TT>\chapter</TT></STRONG> -<DD><A HREF="ffuserguide.html#4134">2.3</A> - | <A HREF="ffuserguide.html#4483">3.1</A> - | <A HREF="ffuserguide.html#6430">6.1</A> -<DT><STRONG><TT>\clear</TT></STRONG> -<DD><A HREF="ffuserguide.html#3562">ffuserguide</A> -<DT><STRONG><TT>\cleardoublepage</TT></STRONG> -<DD><A HREF="ffuserguide.html#3830">2.1.1</A> -<DT><STRONG><TT>\clearpage</TT></STRONG> -<DD><A HREF="ffuserguide.html#3825">2.1.1</A> -<DT><STRONG><TT>color</TT> package</STRONG> -<DD><A HREF="ffuserguide.html#3648">1.</A> -<DT><STRONG><TT>\columnsep</TT></STRONG> -<DD><A HREF="ffuserguide.html#4885">5.1</A> - | <A HREF="ffuserguide.html#4929">5.1</A> - | <A HREF="ffuserguide.html#4969">5.1</A> - | <A HREF="ffuserguide.html#4979">5.1</A> - | <A HREF="ffuserguide.html#6669">7.2</A> -<DT><STRONG><TT>\columnseprule</TT></STRONG> -<DD><A HREF="ffuserguide.html#6327">5.4.4</A> -<DT><STRONG><TT>\computebottomedge</TT></STRONG> -<DD><A HREF="ffuserguide.html#4630">4.1</A> -<DT><STRONG><TT>\computeleftedgeeven</TT></STRONG> -<DD><A HREF="ffuserguide.html#4616">4.1</A> -<DT><STRONG><TT>\computeleftedgeodd</TT></STRONG> -<DD><A HREF="ffuserguide.html#4609">4.1</A> -<DT><STRONG><TT>\computerightedgeeven</TT></STRONG> -<DD><A HREF="ffuserguide.html#4644">4.1</A> -<DT><STRONG><TT>\computerightedgeodd</TT></STRONG> -<DD><A HREF="ffuserguide.html#4637">4.1</A> -<DT><STRONG><TT>\computetopedge</TT></STRONG> -<DD><A HREF="ffuserguide.html#4623">4.1</A> -<DT><STRONG><TT>\continueonframe</TT></STRONG> -<DD><A HREF="ffuserguide.html#3950">2.2</A> - | <A HREF="ffuserguide.html#3981">2.2</A> - | <A HREF="ffuserguide.html#4162">2.3</A> - | <A HREF="ffuserguide.html#4187">2.3</A> - | <A HREF="ffuserguide.html#4202">2.3.1</A> - | <A HREF="ffuserguide.html#4857">4.3</A> -<DT><STRONG><TT>\dfchaphead</TT></STRONG> -<DD><A HREF="ffuserguide.html#4139">2.3</A> -<DT><STRONG><TT>\dfswapoddeven</TT></STRONG> -<DD><A HREF="ffuserguide.html#4310">3.</A> -<DT><STRONG><TT>\diamondshape</TT></STRONG> -<DD><A HREF="ffuserguide.html#4568">3.1</A> -<DT><STRONG><TT>\disablethumbtabs</TT></STRONG> -<DD><A HREF="ffuserguide.html#6450">6.1</A> -<DT><STRONG><TT>displayedframe</TT> counter</STRONG> -<DD><A HREF="ffuserguide.html#6754">7.3</A> -<DT><STRONG><TT>document</TT> environment</STRONG> -<DD><A HREF="ffuserguide.html#3559">ffuserguide</A> - | <A HREF="ffuserguide.html#3586">1.</A> - | <A HREF="ffuserguide.html#3728">2.1</A> -<DT><STRONG><TT>\doublebox</TT></STRONG> -<DD><A HREF="ffuserguide.html#4331">3.</A> - | <A HREF="ffuserguide.html#4380">3.</A> -<DT><STRONG><TT>draft</TT> option</STRONG> -<DD><A HREF="ffuserguide.html#3655">1.1</A> - | <A HREF="ffuserguide.html#3688">1.1</A> - | <A HREF="ffuserguide.html#3706">1.2</A> -<DT><STRONG><TT>dynamiccontents</TT> environment</STRONG> -<DD><A HREF="ffuserguide.html#4003">2.3</A> - | <A HREF="ffuserguide.html#4100">2.3</A> - | <A HREF="ffuserguide.html#4110">2.3</A> - | <A HREF="ffuserguide.html#4156">2.3</A> - | <A HREF="ffuserguide.html#4196">2.3.1</A> - | <A HREF="ffuserguide.html#6933">8.3</A> - | <A HREF="ffuserguide.html#6937">8.3</A> -<DT><STRONG><TT>dynamiccontents*</TT> environment</STRONG> -<DD><A HREF="ffuserguide.html#4105">2.3</A> - | <A HREF="ffuserguide.html#4113">2.3</A> - | <A HREF="ffuserguide.html#4159">2.3</A> - | <A HREF="ffuserguide.html#4170">2.3</A> - | <A HREF="ffuserguide.html#4199">2.3.1</A> -<DT><STRONG><TT>\enableminitoc</TT></STRONG> -<DD><A HREF="ffuserguide.html#6529">6.2</A> -<DT><STRONG><TT>\enablethumbtabs</TT></STRONG> -<DD><A HREF="ffuserguide.html#6445">6.1</A> -<DT><STRONG><TT>etex</TT> package</STRONG> -<DD><A HREF="ffuserguide.html#6928">8.3</A> -<DT><STRONG><TT>\evensidemargin</TT></STRONG> -<DD><A HREF="ffuserguide.html#3594">1.</A> -<DT><STRONG><TT>fancybox</TT> package</STRONG> -<DD><A HREF="ffuserguide.html#4328">3.</A> -<DT><STRONG><TT>\fbox</TT></STRONG> -<DD><A HREF="ffuserguide.html#3572">ffuserguide</A> - | <A HREF="ffuserguide.html#4323">3.</A> - | <A HREF="ffuserguide.html#4365">3.</A> - | <A HREF="ffuserguide.html#6640">7.2</A> -<DT><STRONG><TT>\fboxsep</TT></STRONG> -<DD><A HREF="ffuserguide.html#6635">7.2</A> -<DT><STRONG><TT>\FFabove</TT></STRONG> -<DD><A HREF="ffuserguide.html#4757">4.3</A> -<DT><STRONG><TT>\FFaboveleft</TT></STRONG> -<DD><A HREF="ffuserguide.html#4747">4.3</A> -<DT><STRONG><TT>\FFaboveright</TT></STRONG> -<DD><A HREF="ffuserguide.html#4752">4.3</A> -<DT><STRONG><TT>\ffareaheight</TT></STRONG> -<DD><A HREF="ffuserguide.html#4702">4.2</A> -<DT><STRONG><TT>\ffareawidth</TT></STRONG> -<DD><A HREF="ffuserguide.html#4697">4.2</A> -<DT><STRONG><TT>\ffareax</TT></STRONG> -<DD><A HREF="ffuserguide.html#4707">4.2</A> -<DT><STRONG><TT>\ffareay</TT></STRONG> -<DD><A HREF="ffuserguide.html#4712">4.2</A> -<DT><STRONG><TT>\FFbelow</TT></STRONG> -<DD><A HREF="ffuserguide.html#4772">4.3</A> -<DT><STRONG><TT>\FFbelowleft</TT></STRONG> -<DD><A HREF="ffuserguide.html#4762">4.3</A> -<DT><STRONG><TT>\FFbelowright</TT></STRONG> -<DD><A HREF="ffuserguide.html#4767">4.3</A> -<DT><STRONG><TT>\ffcolumnseprule</TT></STRONG> -<DD><A HREF="ffuserguide.html#6322">5.4.4</A> - | <A HREF="ffuserguide.html#6362">5.4.4</A> - | <A HREF="ffuserguide.html#6380">5.4.4</A> - | <A HREF="ffuserguide.html#6684">7.2</A> -<DT><STRONG><TT>\ffcontinuedtextfont</TT></STRONG> -<DD><A HREF="ffuserguide.html#3974">2.2</A> - | <A HREF="ffuserguide.html#4180">2.3</A> - | <A HREF="ffuserguide.html#6604">7.1</A> -<DT><STRONG><TT>\ffcontinuedtextlayout</TT></STRONG> -<DD><A HREF="ffuserguide.html#3967">2.2</A> - | <A HREF="ffuserguide.html#4173">2.3</A> -<DT><STRONG><TT>\ffhrule</TT></STRONG> -<DD><A HREF="ffuserguide.html#6372">5.4.4</A> -<DT><STRONG><TT>\fflabelfont</TT></STRONG> -<DD><A HREF="ffuserguide.html#6584">7.1</A> -<DT><STRONG><TT>\fflabelsep</TT></STRONG> -<DD><A HREF="ffuserguide.html#6620">7.2</A> -<DT><STRONG><TT>\FFleft</TT></STRONG> -<DD><A HREF="ffuserguide.html#4777">4.3</A> -<DT><STRONG><TT>\FFoverlap</TT></STRONG> -<DD><A HREF="ffuserguide.html#4787">4.3</A> -<DT><STRONG><TT>\FFright</TT></STRONG> -<DD><A HREF="ffuserguide.html#4782">4.3</A> -<DT><STRONG><TT>\ffruledeclarations</TT></STRONG> -<DD><A HREF="ffuserguide.html#6395">5.4.4</A> - | <A HREF="ffuserguide.html#6589">7.1</A> -<DT><STRONG><TT>\ffswapoddeven</TT></STRONG> -<DD><A HREF="ffuserguide.html#4296">3.</A> -<DT><STRONG><TT>\ffvadjustfalse</TT></STRONG> -<DD><A HREF="ffuserguide.html#4895">5.1</A> -<DT><STRONG><TT>\ffvrule</TT></STRONG> -<DD><A HREF="ffuserguide.html#6337">5.4.4</A> -<DT><STRONG><TT>figure</TT> environment</STRONG> -<DD><A HREF="ffuserguide.html#3605">1.</A> - | <A HREF="ffuserguide.html#3627">1.</A> - | <A HREF="ffuserguide.html#3639">1.</A> -<DT><STRONG><TT>figure*</TT> environment</STRONG> -<DD><A HREF="ffuserguide.html#3633">1.</A> -<DT><STRONG><TT>\flowframerule</TT></STRONG> -<DD><A HREF="ffuserguide.html#4359">3.</A> - | <A HREF="ffuserguide.html#6630">7.2</A> -<DT><STRONG><TT>\flowframesep</TT></STRONG> -<DD><A HREF="ffuserguide.html#4354">3.</A> - | <A HREF="ffuserguide.html#6625">7.2</A> -<DT><STRONG><TT>\flowframeshowlayout</TT></STRONG> -<DD><A HREF="ffuserguide.html#3691">1.1</A> -<DT><STRONG>frame settings</STRONG> -<DD><DL COMPACT> -<DT><STRONG>angle</STRONG> -<DD><A HREF="ffuserguide.html#4415">3.</A> -<DT><STRONG>backcolor</STRONG> -<DD><A HREF="ffuserguide.html#4391">3.</A> -<DT><STRONG>border</STRONG> -<DD><A HREF="ffuserguide.html#4321">3.</A> -<DT><STRONG>bordercolor</STRONG> -<DD><A HREF="ffuserguide.html#4389">3.</A> -<DT><STRONG>clear</STRONG> -<DD><A HREF="ffuserguide.html#4394">3.</A> - | <A HREF="ffuserguide.html#4413">3.</A> - | <A HREF="ffuserguide.html#6815">8.1</A> -<DT><STRONG>evenx</STRONG> -<DD><A HREF="ffuserguide.html#4294">3.</A> -<DT><STRONG>eveny</STRONG> -<DD><A HREF="ffuserguide.html#4316">3.</A> -<DT><STRONG>height</STRONG> -<DD><A HREF="ffuserguide.html#4291">3.</A> -<DT><STRONG>label</STRONG> -<DD><A HREF="ffuserguide.html#4320">3.</A> -<DT><STRONG>margin</STRONG> -<DD><A HREF="ffuserguide.html#4393">3.</A> -<DT><STRONG>oddx</STRONG> -<DD><A HREF="ffuserguide.html#4317">3.</A> -<DT><STRONG>oddy</STRONG> -<DD><A HREF="ffuserguide.html#4318">3.</A> -<DT><STRONG>offset</STRONG> -<DD><A HREF="ffuserguide.html#4363">3.</A> -<DT><STRONG>pages</STRONG> -<DD><A HREF="ffuserguide.html#4392">3.</A> -<DT><STRONG>shape</STRONG> -<DD><A HREF="ffuserguide.html#4416">3.</A> - | <A HREF="ffuserguide.html#4476">3.1</A> - | <A HREF="ffuserguide.html#4510">3.1</A> - | <A HREF="ffuserguide.html#6801">8.1</A> -<DT><STRONG>style</STRONG> -<DD><A HREF="ffuserguide.html#4414">3.</A> -<DT><STRONG>textcolor</STRONG> -<DD><A HREF="ffuserguide.html#4390">3.</A> -<DT><STRONG>valign</STRONG> -<DD><A HREF="ffuserguide.html#4319">3.</A> - | <A HREF="ffuserguide.html#6833">8.1</A> -<DT><STRONG>width</STRONG> -<DD><A HREF="ffuserguide.html#4290">3.</A> -<DT><STRONG>x</STRONG> -<DD><A HREF="ffuserguide.html#4292">3.</A> -<DT><STRONG>y</STRONG> -<DD><A HREF="ffuserguide.html#4293">3.</A> -</DL> -<DT><STRONG><TT>\framebreak</TT></STRONG> -<DD><A HREF="ffuserguide.html#3810">2.1.1</A> - | <A HREF="ffuserguide.html#3815">2.1.1</A> - | <A HREF="ffuserguide.html#6854">8.2</A> -<DT><STRONG><TT>\getdynamicbounds</TT></STRONG> -<DD><A HREF="ffuserguide.html#4683">4.2</A> -<DT><STRONG><TT>\getdynamicbounds*</TT></STRONG> -<DD><A HREF="ffuserguide.html#4690">4.2</A> -<DT><STRONG><TT>\getdynamicid</TT></STRONG> -<DD><A HREF="ffuserguide.html#4040">2.3</A> - | <A HREF="ffuserguide.html#4054">2.3</A> -<DT><STRONG><TT>\getdynamiclabel</TT></STRONG> -<DD><A HREF="ffuserguide.html#4033">2.3</A> - | <A HREF="ffuserguide.html#4049">2.3</A> -<DT><STRONG><TT>\getflowbounds</TT></STRONG> -<DD><A HREF="ffuserguide.html#4669">4.2</A> -<DT><STRONG><TT>\getflowbounds*</TT></STRONG> -<DD><A HREF="ffuserguide.html#4676">4.2</A> -<DT><STRONG><TT>\getflowid</TT></STRONG> -<DD><A HREF="ffuserguide.html#3755">2.1</A> - | <A HREF="ffuserguide.html#3769">2.1</A> -<DT><STRONG><TT>\getflowlabel</TT></STRONG> -<DD><A HREF="ffuserguide.html#3748">2.1</A> - | <A HREF="ffuserguide.html#3764">2.1</A> -<DT><STRONG><TT>\getstaticbounds</TT></STRONG> -<DD><A HREF="ffuserguide.html#4655">4.2</A> -<DT><STRONG><TT>\getstaticbounds*</TT></STRONG> -<DD><A HREF="ffuserguide.html#4662">4.2</A> -<DT><STRONG><TT>\getstaticid</TT></STRONG> -<DD><A HREF="ffuserguide.html#3868">2.2</A> - | <A HREF="ffuserguide.html#3882">2.2</A> -<DT><STRONG><TT>\getstaticlabel</TT></STRONG> -<DD><A HREF="ffuserguide.html#3861">2.2</A> - | <A HREF="ffuserguide.html#3877">2.2</A> -<DT><STRONG><TT>ghostscript</TT></STRONG> -<DD><A HREF="ffuserguide.html#6859">8.2</A> -<DT><STRONG><TT>\heartshape</TT></STRONG> -<DD><A HREF="ffuserguide.html#4573">3.1</A> -<DT><STRONG><TT>\hNtone</TT></STRONG> -<DD><A HREF="ffuserguide.html#6144">5.4.2</A> -<DT><STRONG><TT>\hNtoneleft</TT></STRONG> -<DD><A HREF="ffuserguide.html#6228">5.4.2</A> -<DT><STRONG><TT>\hNtoneright</TT></STRONG> -<DD><A HREF="ffuserguide.html#6258">5.4.2</A> -<DT><STRONG><TT>\hsize</TT></STRONG> -<DD><A HREF="ffuserguide.html#3820">2.1.1</A> - | <A HREF="ffuserguide.html#6849">8.2</A> -<DT><STRONG><TT>html</TT> package</STRONG> -<DD><A HREF="ffuserguide.html#3717">1.3</A> -<DT><STRONG><TT>\htwotone</TT></STRONG> -<DD><A HREF="ffuserguide.html#6123">5.4.2</A> - | <A HREF="ffuserguide.html#6167">5.4.2</A> - | <A HREF="ffuserguide.html#6195">5.4.2</A> - | <A HREF="ffuserguide.html#6223">5.4.2</A> -<DT><STRONG><TT>\htwotoneleft</TT></STRONG> -<DD><A HREF="ffuserguide.html#6172">5.4.2</A> - | <A HREF="ffuserguide.html#6253">5.4.2</A> -<DT><STRONG><TT>\htwotoneright</TT></STRONG> -<DD><A HREF="ffuserguide.html#6200">5.4.2</A> - | <A HREF="ffuserguide.html#6283">5.4.2</A> -<DT><STRONG><TT>hyperref</TT> package</STRONG> -<DD><A HREF="ffuserguide.html#3645">1.</A> - | <A HREF="ffuserguide.html#6522">6.1</A> - | <A HREF="ffuserguide.html#6470">6.1</A> -<DT><STRONG><TT>\hypersetup</TT></STRONG> -<DD><A HREF="ffuserguide.html#6517">6.1</A> -<DT><STRONG><TT>\inserthrule</TT></STRONG> -<DD><A HREF="ffuserguide.html#6345">5.4.4</A> - | <A HREF="ffuserguide.html#6367">5.4.4</A> - | <A HREF="ffuserguide.html#6390">5.4.4</A> - | <A HREF="ffuserguide.html#6599">7.1</A> - | <A HREF="ffuserguide.html#6694">7.2</A> -<DT><STRONG><TT>\insertvrule</TT></STRONG> -<DD><A HREF="ffuserguide.html#6305">5.4.4</A> - | <A HREF="ffuserguide.html#6332">5.4.4</A> - | <A HREF="ffuserguide.html#6385">5.4.4</A> - | <A HREF="ffuserguide.html#6594">7.1</A> - | <A HREF="ffuserguide.html#6689">7.2</A> -<DT><STRONG><TT>\item</TT></STRONG> -<DD><A HREF="ffuserguide.html#6923">8.3</A> -<DT><STRONG><TT>\label</TT></STRONG> -<DD><A HREF="ffuserguide.html#3616">1.</A> - | <A HREF="ffuserguide.html#3990">2.2.1</A> - | <A HREF="ffuserguide.html#4409">3.</A> - | <A HREF="ffuserguide.html#6733">7.3</A> - | <A HREF="ffuserguide.html#6807">8.1</A> -<DT><STRONG><TT>\labelflow</TT></STRONG> -<DD><A HREF="ffuserguide.html#6757">7.3</A> - | <A HREF="ffuserguide.html#6771">7.3</A> - | <A HREF="ffuserguide.html#6776">7.3</A> -<DT><STRONG><TT>\labelflowid</TT></STRONG> -<DD><A HREF="ffuserguide.html#6726">7.3</A> - | <A HREF="ffuserguide.html#6749">7.3</A> -<DT><STRONG><TT>\lefttorightcolumnsfalse</TT></STRONG> -<DD><A HREF="ffuserguide.html#5925">5.3</A> -<DT><STRONG><TT>\lefttorightcolumnstrue</TT></STRONG> -<DD><A HREF="ffuserguide.html#5940">5.3</A> -<DT><STRONG><TT>\makebackgroundframe</TT></STRONG> -<DD><A HREF="ffuserguide.html#6292">5.4.3</A> -<DT><STRONG><TT>\makedfheaderfooter</TT></STRONG> -<DD><A HREF="ffuserguide.html#4146">2.3</A> -<DT><STRONG><TT>\makethumbtabs</TT></STRONG> -<DD><A HREF="ffuserguide.html#6419">6.1</A> -<DT><STRONG><TT>maxdynamic</TT> counter</STRONG> -<DD><A HREF="ffuserguide.html#6784">7.3</A> -<DT><STRONG><TT>maxflow</TT> counter</STRONG> -<DD><A HREF="ffuserguide.html#6720">7.3</A> -<DT><STRONG><TT>maxstatic</TT> counter</STRONG> -<DD><A HREF="ffuserguide.html#6781">7.3</A> -<DT><STRONG><TT>maxthumbtabs</TT> counter</STRONG> -<DD><A HREF="ffuserguide.html#6500">6.1</A> - | <A HREF="ffuserguide.html#6787">7.3</A> -<DT><STRONG><TT>\minitocstyle</TT></STRONG> -<DD><A HREF="ffuserguide.html#6543">6.2</A> -<DT><STRONG><TT>\Ncolumn</TT></STRONG> -<DD><A HREF="ffuserguide.html#4920">5.1</A> - | <A HREF="ffuserguide.html#5935">5.3</A> - | <A HREF="ffuserguide.html#6674">7.2</A> -<DT><STRONG><TT>\Ncolumnbottom</TT></STRONG> -<DD><A HREF="ffuserguide.html#5854">5.2</A> - | <A HREF="ffuserguide.html#5883">5.2</A> - | <A HREF="ffuserguide.html#5906">5.2</A> -<DT><STRONG><TT>\Ncolumnbottominarea</TT></STRONG> -<DD><A HREF="ffuserguide.html#5117">5.2</A> - | <A HREF="ffuserguide.html#5795">5.2</A> - | <A HREF="ffuserguide.html#5834">5.2</A> - | <A HREF="ffuserguide.html#5867">5.2</A> -<DT><STRONG><TT>\NcolumnDbottom</TT></STRONG> -<DD><A HREF="ffuserguide.html#5895">5.2</A> -<DT><STRONG><TT>\NcolumnDbottominarea</TT></STRONG> -<DD><A HREF="ffuserguide.html#5815">5.2</A> -<DT><STRONG><TT>\NcolumnDtop</TT></STRONG> -<DD><A HREF="ffuserguide.html#5505">5.2</A> -<DT><STRONG><TT>\NcolumnDtopinarea</TT></STRONG> -<DD><A HREF="ffuserguide.html#5425">5.2</A> -<DT><STRONG><TT>\Ncolumninarea</TT></STRONG> -<DD><A HREF="ffuserguide.html#4984">5.1</A> -<DT><STRONG><TT>\NcolumnSbottom</TT></STRONG> -<DD><A HREF="ffuserguide.html#5872">5.2</A> -<DT><STRONG><TT>\NcolumnSbottominarea</TT></STRONG> -<DD><A HREF="ffuserguide.html#5776">5.2</A> -<DT><STRONG><TT>\NcolumnStop</TT></STRONG> -<DD><A HREF="ffuserguide.html#5482">5.2</A> -<DT><STRONG><TT>\NcolumnStopinarea</TT></STRONG> -<DD><A HREF="ffuserguide.html#5386">5.2</A> -<DT><STRONG><TT>\Ncolumntop</TT></STRONG> -<DD><A HREF="ffuserguide.html#5464">5.2</A> - | <A HREF="ffuserguide.html#5493">5.2</A> - | <A HREF="ffuserguide.html#5516">5.2</A> - | <A HREF="ffuserguide.html#6659">7.2</A> - | <A HREF="ffuserguide.html#6679">7.2</A> -<DT><STRONG><TT>\Ncolumntopinarea</TT></STRONG> -<DD><A HREF="ffuserguide.html#5058">5.2</A> - | <A HREF="ffuserguide.html#5405">5.2</A> - | <A HREF="ffuserguide.html#5444">5.2</A> - | <A HREF="ffuserguide.html#5477">5.2</A> -<DT><STRONG><TT>\newdynamicframe</TT></STRONG> -<DD><A HREF="ffuserguide.html#4006">2.3</A> -<DT><STRONG><TT>\newdynamicframe*</TT></STRONG> -<DD><A HREF="ffuserguide.html#4059">2.3</A> -<DT><STRONG><TT>\newflowframe</TT></STRONG> -<DD><A HREF="ffuserguide.html#3731">2.1</A> - | <A HREF="ffuserguide.html#3856">2.2</A> - | <A HREF="ffuserguide.html#3887">2.2</A> - | <A HREF="ffuserguide.html#4023">2.3</A> -<DT><STRONG><TT>\newflowframe*</TT></STRONG> -<DD><A HREF="ffuserguide.html#3774">2.1</A> -<DT><STRONG><TT>\newpage</TT></STRONG> -<DD><A HREF="ffuserguide.html#3800">2.1.1</A> -<DT><STRONG><TT>\newstaticframe</TT></STRONG> -<DD><A HREF="ffuserguide.html#3839">2.2</A> - | <A HREF="ffuserguide.html#4028">2.3</A> -<DT><STRONG><TT>\newstaticframe*</TT></STRONG> -<DD><A HREF="ffuserguide.html#3892">2.2</A> -<DT><STRONG><TT>nocolor</TT> option</STRONG> -<DD><A HREF="ffuserguide.html#3696">1.1</A> -<DT><STRONG><TT>norotate</TT> option</STRONG> -<DD><A HREF="ffuserguide.html#3699">1.1</A> - | <A HREF="ffuserguide.html#6488">6.1</A> -<DT><STRONG><TT>\nutshape</TT></STRONG> -<DD><A HREF="ffuserguide.html#4578">3.1</A> -<DT><STRONG><TT>\oddsidemargin</TT></STRONG> -<DD><A HREF="ffuserguide.html#3589">1.</A> -<DT><STRONG><TT>\onecolumn</TT></STRONG> -<DD><A HREF="ffuserguide.html#4870">5.1</A> - | <A HREF="ffuserguide.html#4900">5.1</A> - | <A HREF="ffuserguide.html#4910">5.1</A> - | <A HREF="ffuserguide.html#6820">8.1</A> -<DT><STRONG><TT>\onecolumnbottom</TT></STRONG> -<DD><A HREF="ffuserguide.html#5598">5.2</A> - | <A HREF="ffuserguide.html#5623">5.2</A> - | <A HREF="ffuserguide.html#5642">5.2</A> -<DT><STRONG><TT>\onecolumnbottominarea</TT></STRONG> -<DD><A HREF="ffuserguide.html#5079">5.2</A> - | <A HREF="ffuserguide.html#5545">5.2</A> - | <A HREF="ffuserguide.html#5580">5.2</A> - | <A HREF="ffuserguide.html#5609">5.2</A> -<DT><STRONG><TT>\onecolumnDbottom</TT></STRONG> -<DD><A HREF="ffuserguide.html#5633">5.2</A> -<DT><STRONG><TT>\onecolumnDbottominarea</TT></STRONG> -<DD><A HREF="ffuserguide.html#5563">5.2</A> -<DT><STRONG><TT>\onecolumnDtop</TT></STRONG> -<DD><A HREF="ffuserguide.html#5243">5.2</A> -<DT><STRONG><TT>\onecolumnDtopinarea</TT></STRONG> -<DD><A HREF="ffuserguide.html#5173">5.2</A> -<DT><STRONG><TT>\onecolumninarea</TT></STRONG> -<DD><A HREF="ffuserguide.html#4934">5.1</A> -<DT><STRONG><TT>\onecolumnSbottom</TT></STRONG> -<DD><A HREF="ffuserguide.html#5614">5.2</A> -<DT><STRONG><TT>\onecolumnSbottominarea</TT></STRONG> -<DD><A HREF="ffuserguide.html#5528">5.2</A> -<DT><STRONG><TT>\onecolumnStop</TT></STRONG> -<DD><A HREF="ffuserguide.html#5224">5.2</A> -<DT><STRONG><TT>\onecolumnStopinarea</TT></STRONG> -<DD><A HREF="ffuserguide.html#5138">5.2</A> -<DT><STRONG><TT>\onecolumntop</TT></STRONG> -<DD><A HREF="ffuserguide.html#5208">5.2</A> - | <A HREF="ffuserguide.html#5233">5.2</A> - | <A HREF="ffuserguide.html#5252">5.2</A> -<DT><STRONG><TT>\onecolumntopinarea</TT></STRONG> -<DD><A HREF="ffuserguide.html#5020">5.2</A> - | <A HREF="ffuserguide.html#5155">5.2</A> - | <A HREF="ffuserguide.html#5190">5.2</A> - | <A HREF="ffuserguide.html#5219">5.2</A> -<DT><STRONG><TT>\Ovalbox</TT></STRONG> -<DD><A HREF="ffuserguide.html#4336">3.</A> - | <A HREF="ffuserguide.html#4341">3.</A> - | <A HREF="ffuserguide.html#4370">3.</A> - | <A HREF="ffuserguide.html#4375">3.</A> -<DT><STRONG><TT>\pagebreak</TT></STRONG> -<DD><A HREF="ffuserguide.html#3805">2.1.1</A> -<DT><STRONG><TT>\par</TT></STRONG> -<DD><A HREF="ffuserguide.html#4478">3.1</A> -<DT><STRONG><TT>\parshape</TT></STRONG> -<DD><A HREF="ffuserguide.html#4467">3.1</A> - | <A HREF="ffuserguide.html#4431">3.1</A> - | <A HREF="ffuserguide.html#4452">3.1</A> - | <A HREF="ffuserguide.html#4472">3.1</A> - | <A HREF="ffuserguide.html#4517">3.1</A> - | <A HREF="ffuserguide.html#4522">3.1</A> - | <A HREF="ffuserguide.html#6879">8.2</A> - | <A HREF="ffuserguide.html#6884">8.2</A> -<DT><STRONG><TT>\part</TT></STRONG> -<DD><A HREF="ffuserguide.html#4488">3.1</A> -<DT><STRONG><TT>\ref</TT></STRONG> -<DD><A HREF="ffuserguide.html#6738">7.3</A> - | <A HREF="ffuserguide.html#6764">7.3</A> -<DT><STRONG><TT>\relativeframelocation</TT></STRONG> -<DD><A HREF="ffuserguide.html#4721">4.3</A> - | <A HREF="ffuserguide.html#4792">4.3</A> - | <A HREF="ffuserguide.html#4806">4.3</A> - | <A HREF="ffuserguide.html#4826">4.3</A> - | <A HREF="ffuserguide.html#4846">4.3</A> -<DT><STRONG><TT>\relativeframelocation*</TT></STRONG> -<DD><A HREF="ffuserguide.html#4734">4.3</A> -<DT><STRONG><TT>\relax</TT></STRONG> -<DD><A HREF="ffuserguide.html#4418">3.</A> - | <A HREF="ffuserguide.html#4512">3.1</A> -<DT><STRONG><TT>\reldynamicloc</TT></STRONG> -<DD><A HREF="ffuserguide.html#4797">4.3</A> -<DT><STRONG><TT>\relflowloc</TT></STRONG> -<DD><A HREF="ffuserguide.html#4837">4.3</A> -<DT><STRONG><TT>\relstaticloc</TT></STRONG> -<DD><A HREF="ffuserguide.html#4817">4.3</A> -<DT><STRONG><TT>\renewcommand</TT></STRONG> -<DD><A HREF="ffuserguide.html#6569">7.1</A> -<DT><STRONG><TT>RL</TT> option</STRONG> -<DD><A HREF="ffuserguide.html#5922">5.3</A> -<DT><STRONG><TT>\sdfparindent</TT></STRONG> -<DD><A HREF="ffuserguide.html#6645">7.2</A> - | <A HREF="ffuserguide.html#6870">8.2</A> -<DT><STRONG><TT>\setalldynamicframes</TT></STRONG> -<DD><A HREF="ffuserguide.html#4284">3.</A> -<DT><STRONG><TT>\setallflowframes</TT></STRONG> -<DD><A HREF="ffuserguide.html#4234">3.</A> -<DT><STRONG><TT>\setallstaticframes</TT></STRONG> -<DD><A HREF="ffuserguide.html#4259">3.</A> -<DT><STRONG><TT>\setdynamiccontents</TT></STRONG> -<DD><A HREF="ffuserguide.html#4081">2.3</A> - | <A HREF="ffuserguide.html#4207">2.3.1</A> - | <A HREF="ffuserguide.html#4404">3.</A> -<DT><STRONG><TT>\setdynamiccontents*</TT></STRONG> -<DD><A HREF="ffuserguide.html#4090">2.3</A> -<DT><STRONG><TT>\setdynamicframe</TT></STRONG> -<DD><A HREF="ffuserguide.html#4076">2.3</A> - | <A HREF="ffuserguide.html#4151">2.3</A> - | <A HREF="ffuserguide.html#4266">3.</A> - | <A HREF="ffuserguide.html#6512">6.1</A> - | <A HREF="ffuserguide.html#6840">8.1</A> -<DT><STRONG><TT>\setdynamicframe*</TT></STRONG> -<DD><A HREF="ffuserguide.html#4275">3.</A> -<DT><STRONG><TT>\setffdraftcolor</TT></STRONG> -<DD><A HREF="ffuserguide.html#6574">7.1</A> -<DT><STRONG><TT>\setffdrafttypeblockcolor</TT></STRONG> -<DD><A HREF="ffuserguide.html#6579">7.1</A> -<DT><STRONG><TT>\setflowframe</TT></STRONG> -<DD><A HREF="ffuserguide.html#3791">2.1</A> - | <A HREF="ffuserguide.html#4216">3.</A> -<DT><STRONG><TT>\setflowframe*</TT></STRONG> -<DD><A HREF="ffuserguide.html#4225">3.</A> - | <A HREF="ffuserguide.html#6893">8.3</A> -<DT><STRONG><TT>\setlength</TT></STRONG> -<DD><A HREF="ffuserguide.html#6560">6.2</A> - | <A HREF="ffuserguide.html#6615">7.2</A> -<DT><STRONG><TT>\setstaticcontents</TT></STRONG> -<DD><A HREF="ffuserguide.html#3567">ffuserguide</A> - | <A HREF="ffuserguide.html#3914">2.2</A> - | <A HREF="ffuserguide.html#3940">2.2</A> - | <A HREF="ffuserguide.html#4396">3.</A> -<DT><STRONG><TT>\setstaticcontents*</TT></STRONG> -<DD><A HREF="ffuserguide.html#3925">2.2</A> - | <A HREF="ffuserguide.html#3945">2.2</A> - | <A HREF="ffuserguide.html#3962">2.2</A> -<DT><STRONG><TT>\setstaticframe</TT></STRONG> -<DD><A HREF="ffuserguide.html#4241">3.</A> - | <A HREF="ffuserguide.html#6835">8.1</A> -<DT><STRONG><TT>\setstaticframe*</TT></STRONG> -<DD><A HREF="ffuserguide.html#4250">3.</A> -<DT><STRONG><TT>\setthumbtab</TT></STRONG> -<DD><A HREF="ffuserguide.html#6491">6.1</A> -<DT><STRONG><TT>\setthumbtabindex</TT></STRONG> -<DD><A HREF="ffuserguide.html#6503">6.1</A> -<DT><STRONG><TT>\sfswapoddeven</TT></STRONG> -<DD><A HREF="ffuserguide.html#4303">3.</A> -<DT><STRONG><TT>\shadowbox</TT></STRONG> -<DD><A HREF="ffuserguide.html#4346">3.</A> - | <A HREF="ffuserguide.html#4385">3.</A> -<DT><STRONG><TT>shapepar</TT> package</STRONG> -<DD><A HREF="ffuserguide.html#4493">3.1</A> - | <A HREF="ffuserguide.html#4436">3.1</A> - | <A HREF="ffuserguide.html#4441">3.1</A> - | <A HREF="ffuserguide.html#4444">3.1</A> - | <A HREF="ffuserguide.html#4449">3.1</A> - | <A HREF="ffuserguide.html#4457">3.1</A> - | <A HREF="ffuserguide.html#4462">3.1</A> - | <A HREF="ffuserguide.html#4498">3.1</A> - | <A HREF="ffuserguide.html#4508">3.1</A> - | <A HREF="ffuserguide.html#4547">3.1</A> - | <A HREF="ffuserguide.html#4552">3.1</A> - | <A HREF="ffuserguide.html#4555">3.1</A> - | <A HREF="ffuserguide.html#4560">3.1</A> -<DT><STRONG><TT>\showframebboxfalse</TT></STRONG> -<DD><A HREF="ffuserguide.html#3683">1.1</A> -<DT><STRONG><TT>\showframebboxtrue</TT></STRONG> -<DD><A HREF="ffuserguide.html#3678">1.1</A> -<DT><STRONG><TT>\showmarginsfalse</TT></STRONG> -<DD><A HREF="ffuserguide.html#3673">1.1</A> -<DT><STRONG><TT>\showmarginstrue</TT></STRONG> -<DD><A HREF="ffuserguide.html#3668">1.1</A> -<DT><STRONG><TT>\showtypeblockfalse</TT></STRONG> -<DD><A HREF="ffuserguide.html#3663">1.1</A> -<DT><STRONG><TT>\showtypeblocktrue</TT></STRONG> -<DD><A HREF="ffuserguide.html#3658">1.1</A> -<DT><STRONG><TT>\simpar</TT></STRONG> -<DD><A HREF="ffuserguide.html#4503">3.1</A> -<DT><STRONG><TT>\squareshape</TT></STRONG> -<DD><A HREF="ffuserguide.html#4563">3.1</A> -<DT><STRONG><TT>staticcontents</TT> environment</STRONG> -<DD><A HREF="ffuserguide.html#3909">2.2</A> - | <A HREF="ffuserguide.html#3934">2.2</A> - | <A HREF="ffuserguide.html#4000">2.3</A> - | <A HREF="ffuserguide.html#4401">3.</A> -<DT><STRONG><TT>staticcontents*</TT> environment</STRONG> -<DD><A HREF="ffuserguide.html#3937">2.2</A> - | <A HREF="ffuserguide.html#3959">2.2</A> -<DT><STRONG><TT>staticfigure</TT> environment</STRONG> -<DD><A HREF="ffuserguide.html#3599">1.</A> - | <A HREF="ffuserguide.html#3621">1.</A> - | <A HREF="ffuserguide.html#6917">8.3</A> -<DT><STRONG><TT>statictable</TT> environment</STRONG> -<DD><A HREF="ffuserguide.html#3602">1.</A> - | <A HREF="ffuserguide.html#3624">1.</A> - | <A HREF="ffuserguide.html#6920">8.3</A> -<DT><STRONG><TT>table</TT> environment</STRONG> -<DD><A HREF="ffuserguide.html#3608">1.</A> - | <A HREF="ffuserguide.html#3630">1.</A> - | <A HREF="ffuserguide.html#3642">1.</A> -<DT><STRONG><TT>table*</TT> environment</STRONG> -<DD><A HREF="ffuserguide.html#3636">1.</A> -<DT><STRONG><TT>\tableofcontents</TT></STRONG> -<DD><A HREF="ffuserguide.html#6460">6.1</A> -<DT><STRONG><TT>\textheight</TT></STRONG> -<DD><A HREF="ffuserguide.html#3554">ffuserguide</A> -<DT><STRONG><TT>\textwidth</TT></STRONG> -<DD><A HREF="ffuserguide.html#3549">ffuserguide</A> -<DT><STRONG><TT>theindex</TT> environment</STRONG> -<DD><A HREF="ffuserguide.html#6817">8.1</A> -<DT><STRONG><TT>thisframe</TT> counter</STRONG> -<DD><A HREF="ffuserguide.html#6723">7.3</A> -<DT><STRONG><TT>\thumbtabformat</TT></STRONG> -<DD><A HREF="ffuserguide.html#6483">6.1</A> -<DT><STRONG><TT>\thumbtabindex</TT></STRONG> -<DD><A HREF="ffuserguide.html#6440">6.1</A> - | <A HREF="ffuserguide.html#6465">6.1</A> -<DT><STRONG><TT>\thumbtabindexformat</TT></STRONG> -<DD><A HREF="ffuserguide.html#6478">6.1</A> -<DT><STRONG><TT>\thumbtabwidth</TT></STRONG> -<DD><A HREF="ffuserguide.html#6435">6.1</A> -<DT><STRONG><TT>tikz</TT> package</STRONG> -<DD><A HREF="ffuserguide.html#4351">3.</A> - | <A HREF="ffuserguide.html#6400">5.4.4</A> -<DT><STRONG><TT>\tocandthumbtabindex</TT></STRONG> -<DD><A HREF="ffuserguide.html#6455">6.1</A> - | <A HREF="ffuserguide.html#6473">6.1</A> -<DT><STRONG><TT>ttbnonum</TT> option</STRONG> -<DD><A HREF="ffuserguide.html#6416">6.1</A> -<DT><STRONG><TT>ttbnotitle</TT> option</STRONG> -<DD><A HREF="ffuserguide.html#6410">6.1</A> -<DT><STRONG><TT>ttbnum</TT> option</STRONG> -<DD><A HREF="ffuserguide.html#6413">6.1</A> -<DT><STRONG><TT>ttbtitle</TT> option</STRONG> -<DD><A HREF="ffuserguide.html#6407">6.1</A> -<DT><STRONG><TT>\twocolumn</TT></STRONG> -<DD><A HREF="ffuserguide.html#4875">5.1</A> - | <A HREF="ffuserguide.html#4880">5.1</A> - | <A HREF="ffuserguide.html#4905">5.1</A> - | <A HREF="ffuserguide.html#4915">5.1</A> - | <A HREF="ffuserguide.html#5930">5.3</A> - | <A HREF="ffuserguide.html#6825">8.1</A> -<DT><STRONG><TT>\twocolumnbottom</TT></STRONG> -<DD><A HREF="ffuserguide.html#5722">5.2</A> - | <A HREF="ffuserguide.html#5747">5.2</A> - | <A HREF="ffuserguide.html#5766">5.2</A> -<DT><STRONG><TT>\twocolumnbottominarea</TT></STRONG> -<DD><A HREF="ffuserguide.html#5098">5.2</A> - | <A HREF="ffuserguide.html#5669">5.2</A> - | <A HREF="ffuserguide.html#5704">5.2</A> - | <A HREF="ffuserguide.html#5733">5.2</A> -<DT><STRONG><TT>\twocolumnDbottom</TT></STRONG> -<DD><A HREF="ffuserguide.html#5757">5.2</A> -<DT><STRONG><TT>\twocolumnDbottominarea</TT></STRONG> -<DD><A HREF="ffuserguide.html#5687">5.2</A> -<DT><STRONG><TT>\twocolumnDtop</TT></STRONG> -<DD><A HREF="ffuserguide.html#5367">5.2</A> -<DT><STRONG><TT>\twocolumnDtopinarea</TT></STRONG> -<DD><A HREF="ffuserguide.html#5297">5.2</A> -<DT><STRONG><TT>\twocolumninarea</TT></STRONG> -<DD><A HREF="ffuserguide.html#4954">5.1</A> - | <A HREF="ffuserguide.html#5001">5.1</A> -<DT><STRONG><TT>\twocolumnSbottom</TT></STRONG> -<DD><A HREF="ffuserguide.html#5738">5.2</A> -<DT><STRONG><TT>\twocolumnSbottominarea</TT></STRONG> -<DD><A HREF="ffuserguide.html#5652">5.2</A> -<DT><STRONG><TT>\twocolumnStop</TT></STRONG> -<DD><A HREF="ffuserguide.html#5348">5.2</A> -<DT><STRONG><TT>\twocolumnStopinarea</TT></STRONG> -<DD><A HREF="ffuserguide.html#5262">5.2</A> -<DT><STRONG><TT>\twocolumntop</TT></STRONG> -<DD><A HREF="ffuserguide.html#5332">5.2</A> - | <A HREF="ffuserguide.html#5357">5.2</A> - | <A HREF="ffuserguide.html#5376">5.2</A> -<DT><STRONG><TT>\twocolumntopinarea</TT></STRONG> -<DD><A HREF="ffuserguide.html#5039">5.2</A> - | <A HREF="ffuserguide.html#5279">5.2</A> - | <A HREF="ffuserguide.html#5314">5.2</A> - | <A HREF="ffuserguide.html#5343">5.2</A> -<DT><STRONG><TT>\value</TT></STRONG> -<DD><A HREF="ffuserguide.html#6713">7.3</A> -<DT><STRONG><TT>\vcolumnsep</TT></STRONG> -<DD><A HREF="ffuserguide.html#5015">5.2</A> - | <A HREF="ffuserguide.html#6654">7.2</A> -<DT><STRONG>verbatim text</STRONG> -<DD><A HREF="ffuserguide.html#3998">2.3</A> - | <A HREF="ffuserguide.html#4098">2.3</A> - | <A HREF="ffuserguide.html#4108">2.3</A> - | <A HREF="ffuserguide.html#961">2.3.1</A> - | <A HREF="ffuserguide.html#6930">8.3</A> - | <A HREF="ffuserguide.html#6931">8.3</A> - | <A HREF="ffuserguide.html#6935">8.3</A> -<DT><STRONG><TT>\vNtone</TT></STRONG> -<DD><A HREF="ffuserguide.html#5970">5.4.1</A> -<DT><STRONG><TT>\vNtonebottom</TT></STRONG> -<DD><A HREF="ffuserguide.html#6059">5.4.1</A> -<DT><STRONG><TT>\vNtonetop</TT></STRONG> -<DD><A HREF="ffuserguide.html#6089">5.4.1</A> -<DT><STRONG><TT>\vtwotone</TT></STRONG> -<DD><A HREF="ffuserguide.html#5949">5.4.1</A> - | <A HREF="ffuserguide.html#5993">5.4.1</A> - | <A HREF="ffuserguide.html#6021">5.4.1</A> - | <A HREF="ffuserguide.html#6049">5.4.1</A> -<DT><STRONG><TT>\vtwotonebottom</TT></STRONG> -<DD><A HREF="ffuserguide.html#5998">5.4.1</A> - | <A HREF="ffuserguide.html#6084">5.4.1</A> -<DT><STRONG><TT>\vtwotonetop</TT></STRONG> -<DD><A HREF="ffuserguide.html#6026">5.4.1</A> - | <A HREF="ffuserguide.html#6054">5.4.1</A> - | <A HREF="ffuserguide.html#6114">5.4.1</A> - -</DL> - -<P> - -<P> -<A HREF="ffuserguide.html#top">Top</A> | <A HREF="ffuserguide.html#index">Index</A> - -<P> - -<BR><HR><H4>Footnotes</H4> -<DL> -<DT><A NAME="foot3519">... -user</A><A - HREF="ffuserguide.html#tex2html2"><SUP>1.1</SUP></A></DT> -<DD>Can I have arbitrary shaped frames? See -<A HREF="ffuserguide.html#sec:parshape">Non-Rectangular Frames</A> - -</DD> -<DT><A NAME="foot405">... environment</A><A - HREF="ffuserguide.html#tex2html3"><SUP>1.2</SUP></A></DT> -<DD>This is because -of the arbitrary layout of the flow frames. - -</DD> -<DT><A NAME="foot3520">... -them.</A><A - HREF="ffuserguide.html#tex2html17"><SUP>1.3</SUP></A></DT> -<DD>Can I have arbitrary -shaped frames? See -<A HREF="ffuserguide.html#sec:parshape">Non-Rectangular -Frames</A>. - -</DD> -<DT><A NAME="foot3522">...typeblock</A><A - HREF="ffuserguide.html#tex2html29"><SUP>2.1</SUP></A></DT> -<DD>See <A HREF="ffuserguide.html#itm:absval">converting from absolute to relative page -co-ordinates</A> - -</DD> -<DT><A NAME="foot3523">... counter</A><A - HREF="ffuserguide.html#tex2html30"><SUP>2.2</SUP></A></DT> -<DD>why can't I use the page number format? -See query <A HREF="ffuserguide.html#itm:whynot">3</A> - -</DD> -<DT><A NAME="foot3524">...flow</A><A - HREF="ffuserguide.html#tex2html31"><SUP>2.3</SUP></A></DT> -<DD>the -position for the even pages is set using <TT>\setflowframe</TT><A NAME="3791"></A> -defined in <A HREF="ffuserguide.html#sec:modattr">Modifying -Frame Attributes</A> - -</DD> -<DT><A NAME="foot2894">... of.</A><A - HREF="ffuserguide.html#tex2html41"><SUP>2.4</SUP></A></DT> -<DD>By "neither flows into nor -flows out of" I mean you have to explicitly set the contents of -this frame. Note that it may appear to contain text if another -frame overlaps it, but this text belongs to the other frame. - -</DD> -<DT><A NAME="foot3525">... macro.</A><A - HREF="ffuserguide.html#tex2html48"><SUP>2.5</SUP></A></DT> -<DD>which means that you can have -verbatim text<A NAME="3998"></A> in the body of the <TT>staticcontents</TT><A NAME="4000"></A> environment -but not in the body of the <TT>dynamiccontents</TT><A NAME="4003"></A> environment - -</DD> -<DT><A NAME="foot3053">... -approximately</A><A - HREF="ffuserguide.html#tex2html92"><SUP>5.1</SUP></A></DT> -<DD>It may not be exact, as the flow frames are adjusted so that their height is an integer multiple -of <TT>\baselineskip</TT><A NAME="5010"></A>, which may increase the gap. - -</DD> -<DT><A NAME="foot2404">... thumbtabs</A><A - HREF="ffuserguide.html#tex2html114"><SUP>6.1</SUP></A></DT> -<DD>but -only do this if there is enough room on the page! - -</DD> -<DT><A NAME="foot3458">...hypersetup@<TT>\hypersetup</TT></A><A - HREF="ffuserguide.html#tex2html115"><SUP>6.2</SUP></A></DT> -<DD>defined by the -<TT>hyperref</TT><A NAME="6522"></A> package - -</DD> -<DT><A NAME="foot2635">... approximate</A><A - HREF="ffuserguide.html#tex2html144"><SUP>8.1</SUP></A></DT> -<DD>The pedantic may point out -that TeX may make several attempts to fill in the flow frames -depending on penalties and so on. - -</DD> -<DT><A NAME="foot2636">... pencilled</A><A - HREF="ffuserguide.html#tex2html145"><SUP>8.2</SUP></A></DT> -<DD>actually it hasn't -drawn anything really, but it has in its mind's eye. - -</DD> -<DT><A NAME="foot3488">...offset</A><A - HREF="ffuserguide.html#tex2html206"><SUP>8.3</SUP></A></DT> -<DD><TT>offset</TT> can also have the value <TT>compute</TT> - -</DD> -</DL> -<BR><HR> - -</BODY> -</HTML> diff --git a/Master/texmf-dist/doc/latex/flowfram/ffuserguide.pdf b/Master/texmf-dist/doc/latex/flowfram/ffuserguide.pdf Binary files differindex 595c0cfbbab..49ef7001861 100644 --- a/Master/texmf-dist/doc/latex/flowfram/ffuserguide.pdf +++ b/Master/texmf-dist/doc/latex/flowfram/ffuserguide.pdf diff --git a/Master/texmf-dist/doc/latex/flowfram/ffuserguide.tex b/Master/texmf-dist/doc/latex/flowfram/ffuserguide.tex index 37aacadebbc..20059639d4d 100644 --- a/Master/texmf-dist/doc/latex/flowfram/ffuserguide.tex +++ b/Master/texmf-dist/doc/latex/flowfram/ffuserguide.tex @@ -1,5 +1,6 @@ \documentclass[a4paper,twoside]{book} +\usepackage{etoolbox} \usepackage{etex} \usepackage{mathptmx} \usepackage{courier} @@ -35,7 +36,20 @@ \newcommand{\marg}[1]{\texttt{\char`\{#1\char`\}}} \newcommand{\oarg}[1]{\texttt{[#1]}} \newcommand{\appname}[1]{\texttt{#1}\index{#1@\texttt{#1}}} -\newcommand{\pkgopt}[1]{\pkgoptni{#1}\index{#1@\pkgoptni{#1} option}} + +\newcommand{\pkgopt}[2][]{% + \ifstrempty{#1}% + {% + \pkgoptni{#2}\index{#2@\pkgoptni{#2} option}% + }% + {% + \pkgoptni{#2}=\pkgoptni{#1}\index{#2@\pkgoptni{#2} +option!#1@\pkgoptni{#1}}% + }% +} + +\newcommand{\pkgoptval}[2]{\pkgoptni{#2}\index{#1@\pkgoptni{#1} option!#2@\pkgoptni{#2}}} + \newcommand{\key}[1]{#1\index{frame settings!#1}} \newcommand{\dq}[1]{``#1''} \newcommand*{\Index}[1]{#1\index{#1}} @@ -58,8 +72,9 @@ \vskip10pt\noindent\ignorespacesafterend} \newcommand{\chapdesc}[1]{% -\appenddynamiccontents*{chaphead}{\par -\emph{#1}}} + \appenddynamiccontents*{chaphead}{\par + \normalfont\emph{#1}}% +} \newcommand*{\glsindex}[1]{\protect\index{#1}} @@ -105,7 +120,7 @@ on every page}} \newglossaryentry{static}{name=static frame\glsindex{frame!static},% description={Frames in which text is fixed in place. The contents are fixed until -explicitly changed or cleared via the \protect\cmdname{clear} key +explicitly changed or cleared via the \protect\key{clear} key in \protect\cmdname{setstaticcontents}}} \newglossaryentry{dynamic}{name=dynamic frame\glsindex{frame!dynamic},% @@ -134,8 +149,9 @@ pages. This can either be a single keyword: \texttt{all}, be a comma-separated list of individual page numbers or page ranges. For example: \texttt{\textless3,5,7-11,\textgreater15} indicates pages 1,2,5,7,8,9,10,11 and all pages after page 15. -Note that these numbers refer to the actual value of the -page counter, not the absolute physical page number}} +These numbers refer to the decimal value of the page counter by +default. To make them refer to the absolute physical page number use +the package option \pkgopt[absolute]{pages}}} \newglossaryentry{pgrange}{name=page range\glsindex{page range},% description={Page @@ -348,9 +364,9 @@ backcolor=blue,textcolor=white,style=footstyle,pages=none} \begin{document}\label{top} \title{Creating Flow Frames for Posters, Brochures or -Magazines using flowfram.sty v 1.13} +Magazines using flowfram.sty version 1.14} \author{Nicola L. C. Talbot} -\date{23rd January 2010} +\date{2012-11-10} % swap frames around for title page \ffswapoddeven*{main} @@ -365,11 +381,8 @@ Magazines using flowfram.sty v 1.13} \noindent Dr Nicola Talbot\\ -School of Computing Sciences\\ -University of East Anglia\\ -Norwich. Norfolk. NR4 7TJ.\\ -United Kingdom\\ -\url{http://theoval.cmp.uea.ac.uk/~nlct/} +Dickimaw Books\\ +\url{http://www.dickimaw-books.com/} \frontmatter % swap frames back again @@ -391,6 +404,14 @@ United Kingdom\\ \chapdesc{This chapter provides a brief overview of the package, the package options and the various frame types.} +This document is the user manual for the \styni{flowfram} package. +Advanced users wanting further details of the package should read +the documented code \texttt{flowfram.pdf}. Sample files are provided +in the directory \meta{TEXMF}\texttt{/doc/latex/flowfram/samples/} +where \meta{TEXMF} indicates the root \TeX\ installation directory +for this package. (This document is located in +\meta{TEXMF}\texttt{/doc/latex/flowfram/}.) + The \styni{flowfram} package is a \LaTeXe\ package designed to enable you to create text \glspl{frame} in a document such that the contents of the \env{document} environment flow from one @@ -399,6 +420,11 @@ This is useful for creating posters or magazines or any other form of document that does not conform to the standard one or two column layout. +\textbf{The \styni{flowfram} package tries to make \TeX\ do +something it wasn't originally designed to do. It modifies the +output routine and may not always perform as desired. Caveat +emptor---or `you get what you pay for'.} + The \styni{flowfram} package provides three types of \gls*{frame}: \glspl{flow}, \glspl{static} and \glspl{dynamic} with dimensions and positions specified by the @@ -417,10 +443,69 @@ may vary depending on the values of \cmdname{oddsidemargin} and \cmdname{evensidemargin}, and all the \glspl*{frame} will shift accordingly unless otherwise indicated. -Since floats (such as figures and tables) can only go in -\glspl*{flow}, this package provides -the additional environments: -\env{staticfigure} and +This package has only been tested with a limited number of +class files and packages. Since it modifies the output routine, +it is likely to conflict with any other package which also +does this (such as \sty{longtable}). + +You should load \styni{flowfram} \emph{after} \sty{hyperref} and any +colour package (e.g.\ \sty{color}).\htmlnav + +\section{Package Options} + +\begin{description} + + \item[\pkgopt{pages}] Determines whether the \gls{pglist} refers to + the page number as given by the page counter (\pkgopt[relative]{pages}) + or the absolute page number (\pkgopt[absolute]{pages}). The + default is \pkgoptval{pages}{relative} to ensure backward compatibility, + but if you have a document where the page counter is reset it's + best to use \pkgopt[absolute]{pages}. + + \item[\pkgopt{draft}] Switch on draft mode (see + \latexhtml{\autoref{sec:draft}}{\htmlref{Draft Option}{sec:draft}}). + + \item[\pkgopt{final}] Switch off draft mode (default). + + \item[\pkgopt{thumbtabs}] Controls thumbtab contents. See + \latexhtml{\autoref{sec:thumbtabs}}{\htmlref{Thumbtabs}{sec:thumbtabs}} + for details. + + \item[\pkgopt{LR}] When using the column style layouts described in + \latexhtml{\autoref{sec:Ncolumn}}{\htmlref{Column + Styles}{sec:Ncolumn}}, define the \glspl{flow} from left to right. + (Default.) + + \item[\pkgopt{RL}] When using the column style layouts described in + \latexhtml{\autoref{sec:Ncolumn}}{\htmlref{Column + Styles}{sec:Ncolumn}}, define the \glspl{flow} from right to left. + + \item[\pkgopt{rotate}] May have the value \pkgoptval{rotate}{true} + (rotate text in thumbtabs) or \pkgoptval{rotate}{false} + (stack text in thumbtabs). (Default is \pkgoptval{rotate}{true}.) + + \item[\pkgopt{color}] May have the value \pkgoptval{color}{true} + (allow frames to have colour settings) or \pkgoptval{color}{false} + (disable colour in frame settings). The default is \pkgoptval{color}{true}. + + \item[\pkgopt{verbose}] May have the value \pkgoptval{verbose}{true} or + \pkgoptval{verbose}{false}. (Default is \pkgoptval{verbose}{false}.) + Provided to assist debugging. + +\end{description} + +\section{Floats} +\label{sec:floats} + +The standard \env{figure} and \env{table} commands will +behave as usual in the \glspl*{flow}, but their starred versions, +\env{figure*} and \env{table*} behave no differently +from \env{figure} and \env{table}\footnote{This is because +of the arbitrary layout of the flow frames.}. + +Floats (such as figures and tables) can only go in +\glspl*{flow}. However, this package provides +the additional environments: \env{staticfigure} and \env{statictable} which can be used in \glspl*{static} and \glspl*{dynamic}. Unlike their \env{figure} and \env{table} counterparts, they are fixed in place, and @@ -429,22 +514,10 @@ so do not take an optional placement specifier. The be used within \env{staticfigure} and \env{statictable} as usual, but remember that if the frame is displayed on multiple pages, you may end up with multiply defined labels. - -The standard \env{figure} and \env{table} commands will -behave as usual in the \glspl*{flow}, but their starred versions, -\env{figure*} and \env{table*} behave no differently -from \env{figure} and \env{table}\footnote{This is because -of the arbitrary layout of the flow frames.}. - -This package has only been tested with a limited number of -class files and packages. Since it modifies the output routine, -it is likely to conflict with any other package which also -does this. - -You should load \styni{flowfram} \emph{after} \sty{hyperref} and any -colour package (e.g.\ \sty{color}).\htmlnav +\htmlnav \section{Draft Option} +\label{sec:draft} The \styni{flowfram} package has the package option \pkgopt{draft} which will draw the \glspl{bbox} for @@ -497,12 +570,32 @@ the command: \cmdname{flowframeshowlayout} \end{definition} -The \styni{flowfram} package also has the options \pkgopt{nocolor} -and \pkgopt{norotate} for previewers that can not process +The \styni{flowfram} package also has the options \pkgopt[false]{color} +and \pkgopt[false]{rotate} for previewers that can not process colour or rotating specials. (Otherwise you may end up with large black rectangles obscuring your text, instead of the pale background colour you were hoping for.)\htmlnav +\section{Chapters} + +If the \cmdname{chapter} command has been defined, the \styni{flowfram} +package will modify its definition so that it sets the page style to +\cmdname{chapterfirstpagestyle} for the first page of each chapter. This +command defaults to \texttt{plain}, which is the usual page style +for the first page of a chapter. If you want to use a different +style, you will need to redefine \cmdname{chapterfirstpagestyle} to the +name of the relevant page style. A hook +\begin{definition} +\cmdname{ffprechapterhook} +\end{definition} +is used at the start of \cmdname{chapter} definition \emph{before +\cmdname{clearpage} or \cmdname{cleardoublepage} is called.} + +Chapter titles can be placed in a \gls{dynamic} (as in \html{the PDF version of }this document). See +\latexhtml{\autoref{sec:dfchaphead}}{\htmlref{Putting Chapter Titles +in a Dynamic Frame}{sec:dfchaphead}} for further details. +\htmlnav + \section{Frame Stacking Order} \label{sec:stacking} @@ -598,13 +691,19 @@ A \gls*{pgrange} can be a closed range (e.g.\ \verb+2-8+) or an open range (e.g.\ \verb+<10+ or \verb/>5/). For example: \verb'<3,5,7-11,>15' indicates pages 1, 2, 5, 7, 8, 9, 10, 11 and all pages -greater than page 15. These page numbers refer to the value of -the page counter\footnote{why can't I use the page number format? -See query~\ref{itm:whynot}\latex{ on page~\pageref{itm:whynot}}}, -so if you have a page~i and a page~1, they +greater than page 15. These page numbers refer to the integer value of +the page counter\footnote{Why can't I use the page number format? +See query~\ref{itm:whynot}\latex{ on page~\pageref{itm:whynot}}.}\ +by default, so if you have a page~i and a page~1, they will both have the same layout (unless you change the page list setting somewhere between the two pages). +As from version 1.4, if you use the package option +\pkgopt[absolute]{pages} then the numbers in the page list refer to +the absolute page number. In which case page~1 refers to the first +page of the document only, regardless of whether there is another +page~1 or page~i later in the document. + Each \gls*{frame} has its own unique \gls{idn}, corresponding to the order in which it was defined. So the first \gls*{flow} to be defined has \gls*{idn}~1, @@ -687,6 +786,18 @@ paragraph of the previous \gls{frame} has ended. As a result, the end of the paragraph at the beginning of the new \gls*{flow} retains the width of the previous \gls*{flow}. +If a paragraph does span two \glspl*{flow} of unequal width without +using \cmdname{framebreak} a warning will be issued. If a subtle +difference in frame widths is caused by rounding errors (for +example, if the frames were created using Jpgfdraw) you can adjust +the tolerance to suppress these warnings. The default tolerance is +2pt. To change this, set the length register \cmdname{fftolerance} +to the required tolerance. For example, to suppress warnings where +the difference in width is less than 3pt, do +\begin{verbatim} +\setlength{\fftolerance}{3pt} +\end{verbatim} + If you want to start a new page, rather than simply move to the next \gls*{frame}, use the command \cmdname{clearpage}, or for two-sided documents, to start on the next odd page @@ -915,7 +1026,7 @@ To create a new \gls*{dynamic}, use the command: The parameters are exactly the same as for \cmdname{newflowframe} and \cmdname{newstaticframe}. Again, each \gls*{dynamic} has an associated unique \gls{idn}, -starting from 1 for the first \gls*{dynamic} to be defined, and +starting from~1 for the first \gls*{dynamic} to be defined, and a unique \gls{idl}\ can also be set using the final optional argument \meta{label}. @@ -1011,6 +1122,9 @@ or: \cmdname{appenddynamiccontents*}\marg{\meta{label}}\marg{\meta{contents}} \end{definition} +\subsection{Putting Chapter Titles in a Dynamic Frame} +\label{sec:dfchaphead} + If \cmdname{chapter} is defined, you can make the chapter titles appear in a dynamic frame using the command \begin{definition} @@ -1024,6 +1138,36 @@ use the \gls{idl}\ instead of the \gls*{idn}. For example, in \dfchaphead*{chaphead} \end{verbatim} +If you use \cmdname{dfchaphead}, you can adjust the format of the +chapter headings by redefining +\begin{definition} +\cmdname{DFchapterstyle}\marg{\meta{title}} +\end{definition} +for the numbered chapters and +\begin{definition} +\cmdname{DFschapterstyle}\marg{\meta{title}} +\end{definition} +for the unnumbered chapters. For example, this document redefined +those commands as follows: +\begin{verbatim} +\renewcommand{\DFchapterstyle}[1]{% + {\raggedright\sffamily\bfseries\Huge + \color{blue}\thechapter. #1\par + }% +} + +\renewcommand{\DFschapterstyle}[1]{% + {\raggedright\sffamily\bfseries\Huge + \color{blue} #1\par + }% +} +\end{verbatim} +There is no facility for placing other sectional types in a +\gls{dynamic}. +\htmlnav + +\subsection{Putting Headers and Footers in a Dynamic Frame} + The headers and footers can be turned into \glspl*{dynamic} using the command \begin{definition} @@ -1034,6 +1178,9 @@ This will create two \glspl*{dynamic} with \glspl*{idl} usual, but you can then move or resize the header and footer using \cmdname{setdynamicframe} (described \latexhtml{in \autoref{sec:modattr}}{\htmlref{later}{sec:modattr}}). +\htmlnav + +\subsection{Continued Text} In the body of \env{dynamiccontents} or \env{dynamiccontents*}, you can move onto another \gls*{dynamic} using: @@ -1182,7 +1329,9 @@ above keywords or have ranges in \meta{label list}. The \meta{key-val list} argument must be a comma-separated list of \meta{key}=\meta{value} pairs, indicating which -attributes to modify. The available values are as follows: +attributes to modify. \textbf{Make sure you group \meta{value} +if it contains one or more commas or equal signs.} +The available values are as follows: \begin{description} \item[\key{width}=\meta{length}] The width of the \gls*{frame}. @@ -1367,8 +1516,63 @@ comma-separated list of single pages, or \glspl{pgrange}. For example: \begin{verbatim} -\setdynamicframe{1}{pages=1,5,8-10} +\setdynamicframe{1}{pages={1,5,8-10}} +\end{verbatim} +Recall that the numbers in the list either refer to the integer +value of the page counter +(when used with the package option \pkgopt[relative]{pages}) +or the absolute page number (when used with the package option +\pkgopt[absolute]{pages}). + +As from version 1.14, there is also a quick way of setting the page +list that doesn't have the overhead of parsing the +\meta{key}=\meta{value} format of commands such as +\cmdname{setflowframe}: +\begin{definition} +\cmdname{flowsetpagelist}\marg{\meta{idn}}\marg{\meta{page +list}}\newline +\cmdname{dynamicsetpagelist}\marg{\meta{idn}}\marg{\meta{page +list}}\newline +\cmdname{staticsetpagelist}\marg{\meta{idn}}\marg{\meta{page list}} +\end{definition} +\textbf{Note that these commands don't have starred variants. The +first argument must be a single \gls{idn}.} + +See also \latexhtml{\autoref{sec:switch}}{\htmlref{Switching Frames +On and Off On-The-Fly}{sec:switch}}. + +\item[\key{excludepages}=\meta{list}] (New to version~1.14.) +A comma-separated list of page +numbers where the frame should not appear. Note that this overrides +any page given by the \key{pages} key. For this key, \meta{list} may +only contain comma-separated numbers. Ranges are not permitted. For +example: +\begin{verbatim} +\setdynamicframe{1}{excludepages={7}} +\setdynamicframe{1}{pages={1-10}} \end{verbatim} +This will make the dynamic frame appear on pages~1 to~6 and~8 to~10. + +Again, there is also a quick way of setting the exclusion +list that doesn't have the overhead of parsing the +\meta{key}=\meta{value} format of commands such as +\cmdname{setflowframe}: +\begin{definition} +\cmdname{flowsetexclusion}\marg{\meta{idn}}\marg{\meta{list}}\newline +\cmdname{dynamicsetexclusion}\marg{\meta{idn}}\marg{\meta{list}}\newline +\cmdname{staticsetexclusion}\marg{\meta{idn}}\marg{\meta{list}} +\end{definition} +or you can add to an exclusion list using: +\begin{definition} +\cmdname{flowaddexclusion}\marg{\meta{idn}}\marg{\meta{list}}\newline +\cmdname{dynamicaddexclusion}\marg{\meta{idn}}\marg{\meta{list}}\newline +\cmdname{staticaddexclusion}\marg{\meta{idn}}\marg{\meta{list}} +\end{definition} +\textbf{Note that these commands don't have starred variants. The +first argument must be a single \gls{idn}.} + +See also \latexhtml{\autoref{sec:switch}}{\htmlref{Switching Frames +On and Off On-The-Fly}{sec:switch}}. \item[\key{margin}=\meta{side}] The side of the \gls*{flow} that its corresponding margin should go on. This @@ -1483,7 +1687,7 @@ indentation for the \latexhtml{$j$th}{jth} line and the \latexhtml{$j$th}{jth} line. \latexhtml{The \gls*{static} on the top -\ifthenelse{\isodd{page}}{left}{right} +\ifthenelse{\isodd{page}}{right}{left} was assigned a zigzag shape using:}{For example, to create a zigzag shaped static frame (whose \gls*{idn} is \texttt{shapedt}):} \setstaticframe*{shapedb,shapedt}{pages=all} @@ -1548,7 +1752,7 @@ The \sty{shapepar} package has four predefined shapes: \cmdname{heartshape} and \cmdname{nutshape}. \latexhtml{The \gls{static} on the bottom -\ifthenelse{\isodd{page}}{left}{right} +\ifthenelse{\isodd{page}}{right} {left} was assigned a heart shape using the command:}{For example, to assign a heart shape to the static frame whose \gls*{idl} is \texttt{shapedb}:} \begin{verbatim} @@ -1576,6 +1780,173 @@ The \styni{flowfram} package currently does not support any other paragraph shape making commands. Any other commands would have to be used explicitly within the contents of the frame.\htmlnav +\section{Switching Frames On and Off On-The-Fly} +\label{sec:switch} + +Modifying the \gls{pglist} (or the page exclusion list) within the +\env{document} environment is a risky business. This list must +be up-to-date before the output routine looks for the next frame. +To make this a little easier, as from version~1.14 there are +commands that help you do this. \textbf{If you want to use these +commands, it's best to use the package option \pkgopt[absolute]{pages}.} + +The commands described in this section update the \glspl{pglist} +(and possibly the exclusion list) \emph{when the output routine is +next used}. They are designed to switch frames on or off either on +the next page or on the next odd page. You therefore need to take +care where you place these commands. For example, if you have a +two-sided document and you do: +\begin{verbatim} +\dynamicswitchonnextodd{1} +\mainmatter +\chapter{Introduction} +\end{verbatim} +This will set the dynamic frame whose \gls{idn} is~1 to be visible for +the first page of chapter~1. However, if you do +\begin{verbatim} +\mainmatter +\dynamicswitchonnextodd{1} +\chapter{Introduction} +\end{verbatim} +This will have a different effect as \cmdname{mainmatter} issues a +\cmdname{cleardoublepage} so the command to switch on the dynamic +frame is on the same page as the start of chapter~1. This means that +the dynamic frame won't appear until the following odd page +(page~3). + +These commands all have the same syntax with one argument that may +be a comma-separated list. The starred version uses +\glspl{idl} and the unstarred version uses \glspl{idn}. + +\begin{definition} +\cmdname{flowswitchonnext}\marg{\meta{IDN list}}\\ +\cmdname{flowswitchonnext*}\marg{\meta{IDL list}} +\end{definition}% +Switch on the listed \glspl{flow} from the following page onwards. +\begin{definition} +\cmdname{flowswitchoffnext}\marg{\meta{IDN list}}\\ +\cmdname{flowswitchoffnext*}\marg{\meta{IDL list}} +\end{definition}% +Switch off the listed \glspl{flow} from the following page onwards. +\begin{definition} +\cmdname{flowswitchonnextodd}\marg{\meta{IDN list}}\\ +\cmdname{flowswitchonnextodd*}\marg{\meta{IDL list}} +\end{definition}% +Switch on the listed \glspl{flow} from the next odd page onwards. +\begin{definition} +\cmdname{flowswitchoffnextodd}\marg{\meta{IDN list}}\\ +\cmdname{flowswitchoffnextodd*}\marg{\meta{IDL list}} +\end{definition}% +Switch off the listed \glspl{flow} from the next odd page onwards. + +\begin{definition} +\cmdname{flowswitchonnextonly}\marg{\meta{IDN list}}\\ +\cmdname{flowswitchonnextonly*}\marg{\meta{IDL list}} +\end{definition}% +Switch on the listed \glspl{flow} just for the following page. +\begin{definition} +\cmdname{flowswitchoffnextonly}\marg{\meta{IDN list}}\\ +\cmdname{flowswitchoffnextonly*}\marg{\meta{IDL list}} +\end{definition}% +Switch off the listed \glspl{flow} just for the following page. +\begin{definition} +\cmdname{flowswitchonnextoddonly}\marg{\meta{IDN list}}\\ +\cmdname{flowswitchonnextoddonly*}\marg{\meta{IDL list}} +\end{definition}% +Switch on the listed \glspl{flow} just for the next odd page. +\begin{definition} +\cmdname{flowswitchoffnextoddonly}\marg{\meta{IDN list}}\\ +\cmdname{flowswitchoffnextoddonly*}\marg{\meta{IDL list}} +\end{definition}% +Switch off the listed \glspl{flow} just for the next odd page. + +\begin{definition} +\cmdname{dynamicswitchonnext}\marg{\meta{IDN list}}\\ +\cmdname{dynamicswitchonnext*}\marg{\meta{IDL list}} +\end{definition}% +Switch on the listed \glspl{dynamic} from the following page onwards. +\begin{definition} +\cmdname{dynamicswitchoffnext}\marg{\meta{IDN list}}\\ +\cmdname{dynamicswitchoffnext*}\marg{\meta{IDL list}} +\end{definition}% +Switch off the listed \glspl{dynamic} from the following page onwards. +\begin{definition} +\cmdname{dynamicswitchonnextodd}\marg{\meta{IDN list}}\\ +\cmdname{dynamicswitchonnextodd*}\marg{\meta{IDL list}} +\end{definition}% +Switch on the listed \glspl{dynamic} from the next odd page onwards. +\begin{definition} +\cmdname{dynamicswitchoffnextodd}\marg{\meta{IDN list}}\\ +\cmdname{dynamicswitchoffnextodd*}\marg{\meta{IDL list}} +\end{definition}% +Switch off the listed \glspl{dynamic} from the next odd page onwards. + +\begin{definition} +\cmdname{dynamicswitchonnextonly}\marg{\meta{IDN list}}\\ +\cmdname{dynamicswitchonnextonly*}\marg{\meta{IDL list}} +\end{definition}% +Switch on the listed \glspl{dynamic} just for the following page. +\begin{definition} +\cmdname{dynamicswitchoffnextonly}\marg{\meta{IDN list}}\\ +\cmdname{dynamicswitchoffnextonly*}\marg{\meta{IDL list}} +\end{definition}% +Switch off the listed \glspl{dynamic} just for the following page. +\begin{definition} +\cmdname{dynamicswitchonnextoddonly}\marg{\meta{IDN list}}\\ +\cmdname{dynamicswitchonnextoddonly*}\marg{\meta{IDL list}} +\end{definition}% +Switch on the listed \glspl{dynamic} just for the next odd page. +\begin{definition} +\cmdname{dynamicswitchoffnextoddonly}\marg{\meta{IDN list}}\\ +\cmdname{dynamicswitchoffnextoddonly*}\marg{\meta{IDL list}} +\end{definition}% +Switch off the listed \glspl{dynamic} just for the next odd page. + +\begin{definition} +\cmdname{staticswitchonnext}\marg{\meta{IDN list}}\\ +\cmdname{staticswitchonnext*}\marg{\meta{IDL list}} +\end{definition}% +Switch on the listed \glspl{static} from the following page onwards. +\begin{definition} +\cmdname{staticswitchoffnext}\marg{\meta{IDN list}}\\ +\cmdname{staticswitchoffnext*}\marg{\meta{IDL list}} +\end{definition}% +Switch off the listed \glspl{static} from the following page onwards. +\begin{definition} +\cmdname{staticswitchonnextodd}\marg{\meta{IDN list}}\\ +\cmdname{staticswitchonnextodd*}\marg{\meta{IDL list}} +\end{definition}% +Switch on the listed \glspl{static} from the next odd page onwards. +\begin{definition} +\cmdname{staticswitchoffnextodd}\marg{\meta{IDN list}}\\ +\cmdname{staticswitchoffnextodd*}\marg{\meta{IDL list}} +\end{definition}% +Switch off the listed \glspl{static} from the next odd page onwards. + +\begin{definition} +\cmdname{staticswitchonnextonly}\marg{\meta{IDN list}}\\ +\cmdname{staticswitchonnextonly*}\marg{\meta{IDL list}} +\end{definition}% +Switch on the listed \glspl{static} just for the following page. +\begin{definition} +\cmdname{staticswitchoffnextonly}\marg{\meta{IDN list}}\\ +\cmdname{staticswitchoffnextonly*}\marg{\meta{IDL list}} +\end{definition}% +Switch off the listed \glspl{static} just for the following page. +\begin{definition} +\cmdname{staticswitchonnextoddonly}\marg{\meta{IDN list}}\\ +\cmdname{staticswitchonnextoddonly*}\marg{\meta{IDL list}} +\end{definition}% +Switch on the listed \glspl{static} just for the next odd page. +\begin{definition} +\cmdname{staticswitchoffnextoddonly}\marg{\meta{IDN list}}\\ +\cmdname{staticswitchoffnextoddonly*}\marg{\meta{IDL list}} +\end{definition}% +Switch off the listed \glspl{static} just for the next odd page. + +The \styni{flowfram} package comes with a sample file +\texttt{sample-pages.tex} that uses some of these commands. + \chapter{Locations and Dimensions} \chapdesc{This chapter describes some of the commands provided to determine the locations and dimensions of frames.} @@ -1805,6 +2176,7 @@ create \glspl{frame} in a predefined layout. These commands may only be used in the preamble.\htmlnav \section{Column Styles} +\label{sec:Ncolumn} The standard \LaTeX\ commands \cmdname{onecolumn} and \cmdname{twocolumn} are redefined to create one or two @@ -2167,6 +2539,7 @@ This is equivalent to: \htmlnav \section{Right to Left Columns} +\label{sec:RL} The default behaviour for the commands defined above is to create the \glspl{flow} from left to right. However if you are @@ -2467,6 +2840,7 @@ package): such as those used in \html{the PDF version of }this document.} \section{Thumbtabs} +\label{sec:thumbtabs} On the right hand side of \latexhtml{this page}{the odd pages and on the left hand side of the even pages in the @@ -2475,11 +2849,13 @@ with the chapter number in it. This is a thumbtab, and it gives you a rough idea whereabouts in the document you are when you quickly flick through the pages. Each thumbtab is in fact a dynamic frame, and you can control whether to make the -number and/or title appear in the thumbtab by using one or -more of the package options: \pkgopt{ttbtitle} (show -title---default), \pkgopt{ttbnotitle} (don't show the title), -\pkgopt{ttbnum} (show the number) and \pkgopt{ttbnonum} -(don't show the number---default). +number and/or title appear in the thumbtab by using +the package option \pkgopt{thumbtabs}. This is a key=value option, +where the value may be one of \pkgoptval{thumbtabs}{title} +(show the title but not the number---default), +\pkgoptval{thumbtabs}{number} (show the number but not the title), +\pkgoptval{thumbtabs}{both} (show the number and the title) +and \pkgoptval{thumbtabs}{none} (don't show the number or title). If you want thumbtabs in your document, you need to use the command @@ -2743,6 +3119,12 @@ This is the vertical distance before the minitoc. \item \cmdname{afterminitocskip} This is the vertical distance after the minitoc. + +\item \cmdname{fftolerance} + +The output routine will issue a warning when a paragraph spans two +\glspl{flow} of unequal width, unless the difference in width is +less than the value of \cmdname{fftolerance}. \end{itemize} \htmlnav @@ -2751,7 +3133,7 @@ This is the vertical distance after the minitoc. The following are counters that can be accessed via \cmdname{value}\marg{\meta{counter name}} or via \verb|\the|\meta{counter name}. However the value of these counters -should not be modified. +\emph{should not be modified}. \begin{description} \item[\ctr{maxflow}] The total number of \glspl{flow} that have @@ -2803,6 +3185,8 @@ been defined so far. have been defined so far. \item[\ctr{maxthumbtabs}] The total number of thumbtabs. + +\item[\ctr{absolutepage}] The absolute page number. \end{description} \htmlnav @@ -2812,9 +3196,20 @@ problems using the \styni{flowfram} package.} For an up-to-date list of frequently asked questions, see \latexhtml{% -\url{http://theoval.cmp.uea.ac.uk/~nlct/latex/packages/faq/flowframfaq.html}}{the \htmladdnormallink{flowfram FAQ}{http://theoval.cmp.uea.ac.uk/~nlct/latex/packages/faq/flowframfaq.html}}. -If you have a query that is not addressed here, please try there -before contacting me.\htmlnav +\url{http://www.dickimaw-books.com/faqs/flowframfaq.html}}{the +\htmladdnormallink{flowfram +FAQ}{http://www.dickimaw-books.com/faqs/flowframfaq.html}}. If you +have a query that is not addressed here, please try there first. If +that doesn't answer your query, try posting a message to the \LaTeX\ +Community Forum (\url{http://latex-community.org/forum/}), \TeX\ on +StackExchange (\url{http://tex.stackexchange.com/}) or the +\texttt{comp.text.tex} newsgroup. I generally answer questions in +those places much quicker than queries that are emailed to me. + +Bugs can be reported using the \latexhtml{form at +\url{http://www.dickimaw-books.com/bug-report.html}}{\htmladdnormallink{bug +report form}{http://www.dickimaw-books.com/bug-report.html}} +\htmlnav \section{General Queries} @@ -2847,7 +3242,7 @@ that point, which it hasn't yet. So it is looking for a \gls{flow} defined on page~15, not on page~A. \item How does \LaTeX\ tell if page C lies between -pages A and D? It would require an algorithm that can convert +pages A and D\@? It would require an algorithm that can convert from a formatted number back to an integer. Given that there are many different ways of formatting the value of a counter (besides the standard Roman and alphabetical formats) it @@ -2954,7 +3349,7 @@ Location of the Typeblock}{sec:typeblockloc}}. \glspl{frame}? Yes, Jpgfdraw which can be downloaded from: -\url{http://theoval.cmp.uea.ac.uk/~nlct/jpgfdraw/} +\url{http://www.dickimaw-books.com/apps/jpgfdraw/} \end{enumerate} \htmlnav @@ -3175,9 +3570,9 @@ unstarred version of the \env{dynamiccontents} environment. \htmlnav -\clearpage +\ifthenelse{\isodd{page}}{}{\clearpage\mbox{}} % have a backcover: \setdynamicframe*{footer}{pages=none} \setstaticframe*{lastbackleft,lastbackright}{pages=even} -\mbox{}\clearpage +\clearpage\mbox{} \end{document} diff --git a/Master/texmf-dist/doc/latex/flowfram/ffuserguideidx.ist b/Master/texmf-dist/doc/latex/flowfram/ffuserguideidx.ist new file mode 100644 index 00000000000..1ed1dadb531 --- /dev/null +++ b/Master/texmf-dist/doc/latex/flowfram/ffuserguideidx.ist @@ -0,0 +1,3 @@ +headings_flag 1 +heading_prefix "\\idxgroupheading\{" +heading_suffix "\}" diff --git a/Master/texmf-dist/doc/latex/flowfram/flowfram.pdf b/Master/texmf-dist/doc/latex/flowfram/flowfram.pdf Binary files differindex b4ebe1d54cf..67085cab743 100644 --- a/Master/texmf-dist/doc/latex/flowfram/flowfram.pdf +++ b/Master/texmf-dist/doc/latex/flowfram/flowfram.pdf diff --git a/Master/texmf-dist/doc/latex/flowfram/samples/brochure.pdf b/Master/texmf-dist/doc/latex/flowfram/samples/brochure.pdf Binary files differdeleted file mode 100644 index 4e37ce2e49b..00000000000 --- a/Master/texmf-dist/doc/latex/flowfram/samples/brochure.pdf +++ /dev/null diff --git a/Master/texmf-dist/doc/latex/flowfram/samples/news.pdf b/Master/texmf-dist/doc/latex/flowfram/samples/news.pdf Binary files differdeleted file mode 100644 index d36d46ddccd..00000000000 --- a/Master/texmf-dist/doc/latex/flowfram/samples/news.pdf +++ /dev/null diff --git a/Master/texmf-dist/doc/latex/flowfram/samples/news2.pdf b/Master/texmf-dist/doc/latex/flowfram/samples/news2.pdf Binary files differdeleted file mode 100644 index 62df0e2b448..00000000000 --- a/Master/texmf-dist/doc/latex/flowfram/samples/news2.pdf +++ /dev/null diff --git a/Master/texmf-dist/doc/latex/flowfram/samples/poster.pdf b/Master/texmf-dist/doc/latex/flowfram/samples/poster.pdf Binary files differdeleted file mode 100644 index ea499d7b56f..00000000000 --- a/Master/texmf-dist/doc/latex/flowfram/samples/poster.pdf +++ /dev/null diff --git a/Master/texmf-dist/doc/latex/flowfram/samples/sample-article.pdf b/Master/texmf-dist/doc/latex/flowfram/samples/sample-article.pdf Binary files differnew file mode 100644 index 00000000000..02743025742 --- /dev/null +++ b/Master/texmf-dist/doc/latex/flowfram/samples/sample-article.pdf diff --git a/Master/texmf-dist/doc/latex/flowfram/samples/sample-article.tex b/Master/texmf-dist/doc/latex/flowfram/samples/sample-article.tex new file mode 100644 index 00000000000..ba165bd9bee --- /dev/null +++ b/Master/texmf-dist/doc/latex/flowfram/samples/sample-article.tex @@ -0,0 +1,283 @@ + % This file is public domain. + +\documentclass[a4paper]{article} + +\usepackage[margin=1in,top=1in,bottom=1in]{geometry} +\usepackage{url} +\usepackage{color} +\usepackage{flowfram} + +\newcommand{\sty}[1]{\textsf{#1}} +\newcommand{\env}[1]{\textsf{#1}} +\newcommand{\cmdname}[1]{\texttt{\symbol{92}#1}} +\newcommand{\meta}[1]{\textnormal{\textless\textit{#1}\textgreater}} + + +\twocolumnStop[1]{2in} +\setstaticframe{1}{label=title} + +\twocolumn[>1] + +\begin{document} +\begin{staticcontents*}{title} +\title{Creating Flow Frames for Posters or Magazines} +\author{Nicola L. C. Talbot\\[1cm]\url{http://www.dickimaw-books.com/}} +\date{} +\maketitle +\end{staticcontents*} + +This document is a sample document, see \linebreak +\texttt{ffuserguide.pdf} for +an up-to-date guide on how to use the \sty{flowfram} package. + +\section{Introduction} + +The \sty{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. +This is useful for creating posters\marginpar{A marginal note} +or magazines or any other form of document that does not +conform to the standard one or two column layout. + +\subsection{Setting up Frames} + +The \sty{flowfram} package provides three types of frame: +{flow frames}, {static +frames} and {dynamic frames}. + +\subsubsection{Flow Frames} + +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, +position on the page, and optionally a border\footnote{A +footnote!}. + +\subsubsection{Static Frames} + +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 +a company logo appear in the same place on every page. + +\subsubsection{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 +contents in a savebox, whereas a dynamic frame stores its +contents in a macro). + +\section{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 +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 +for {static frames} +and \textsuperscript{\textbf{D}} indicates the key +is only available for {dynamic frames}): + +\begin{description} +\item[width=\meta{length}] The width of the frame. + +\item[height=\meta{length}] The height of the frame. + +\item[x=\meta{length}] The x-coordinate of the frame. + +\item[y=\meta{length}] The y-coordinate of the frame. + +\item[border=\meta{style}] 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. +The value \texttt{fbox} is equivalent to \texttt{plain}. + +\item[offset=\meta{offset}] 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 \sty{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 +may end up shifted to the right or left. + +\item[bordercolor=\meta{colour}] 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, e.g. \verb/[rgb]{0,1,0}/. + +\item[textcolor=\meta{colour}] The text colour for that +frame. Again, the colour can either be specified as, +e.g.\ \texttt{green}, or including the colour model, +e.g. \verb/[rgb]{0,1,0}/. + +\item[pages=\meta{page list}] 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 +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 +{page ranges}. + +\item[margin=\meta{side}\textsuperscript{F}] The side of +the flow frame that its corresponding margin should go on. This +can take the values \texttt{left} or \texttt{right}. + +\item[clear=\meta{boolean}\textsuperscript{S}] If this value +is set, the static frame will be cleared at the start of the +next page. + +\item[style=\meta{cmd}\textsuperscript{D}] 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 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 +bold. To unset a style, do \verb/style=none/. + +\end{description} + +\section{Miscellaneous} + +\subsection{Page Layout} + +The \sty{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 +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 +\cmdname{flowframeshowlayout} + +The headers and footers will appear as usual (but will not +be shown in draft mode), according to the format given by +\cmdname{pagestyle}. + +\subsection{Frame Stacking Order} + +The material on each page is placed in the following order: +\begin{enumerate} +\item Each static frame defined for that page in ascending +order of IDN. + +\item Each flow frame defined for that page in ascending +order of IDN. + +\item Each dynamic frame defined for that page in ascending +order of IDN. + +\item {Bounding boxes} if the \texttt{draft} +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. + +\subsection{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. + +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 +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 +next frame, use the command\newline +\cmdname{finishthispage}. + +\subsection{Floats} + +Since floats (such as figures and tables) can only go in +{flow frames}, this package provides +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 +be used within \env{staticfigure} and \env{statictable} as +usual. + +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}. + +\subsection{Global Values} + +The following macros can be changed using \cmdname{renewcommand}: + +\begin{itemize} +\item \cmdname{setffdraftcolor} + +This sets the colour of the bounding box +when it is displayed in draft mode. + +\item +\cmdname{setffdrafttypeblockcolor} + +This sets the colour of +the bounding box of the typeblock when it is displayed +in draft mode. + +\item \cmdname{fflabelfont} + +This sets the font size for the bounding box markers in +draft mode. + +\end{itemize} + +The following are lengths, which can be changed using +\cmdname{setlength}: +\marginpar{Another marginal note} + +\begin{itemize} +\item \cmdname{fflabelsep} + +This is the distance from the right hand side of the +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. + +\item \cmdname{flowframerule} + +This is the width of the frame's border, if using +a border given by a frame making command that uses \cmdname{fboxsep} +to set its border width. +\end{itemize} + +\section*{Contact Details} + +Dr Nicola Talbot\\ +Dickimaw Books\\ +\url{http://www.dickimaw-books.com/} + +\end{document} diff --git a/Master/texmf-dist/doc/latex/flowfram/samples/sample-blanks.tex b/Master/texmf-dist/doc/latex/flowfram/samples/sample-blanks.tex new file mode 100644 index 00000000000..6296b14f576 --- /dev/null +++ b/Master/texmf-dist/doc/latex/flowfram/samples/sample-blanks.tex @@ -0,0 +1,19 @@ + % This file is public domain. + +\documentclass{article} + +\usepackage{lipsum} +\usepackage[draft]{flowfram} + +\onecolumn[odd] + +\newdynamicframe{1in}{1in}{-1in}{-1in} +\setdynamiccontents{1}{\arabic{absolutepage}-\arabic{page}} + +\begin{document} + +\lipsum[1-4] + +\lipsum[1-4] + +\end{document} diff --git a/Master/texmf-dist/doc/latex/flowfram/samples/sample-brochure.pdf b/Master/texmf-dist/doc/latex/flowfram/samples/sample-brochure.pdf Binary files differnew file mode 100644 index 00000000000..f94e4e2451a --- /dev/null +++ b/Master/texmf-dist/doc/latex/flowfram/samples/sample-brochure.pdf diff --git a/Master/texmf-dist/doc/latex/flowfram/samples/brochure.tex b/Master/texmf-dist/doc/latex/flowfram/samples/sample-brochure.tex index d0434139854..c1b499a0248 100644 --- a/Master/texmf-dist/doc/latex/flowfram/samples/brochure.tex +++ b/Master/texmf-dist/doc/latex/flowfram/samples/sample-brochure.tex @@ -1,3 +1,5 @@ + % This file is public domain. + \documentclass[a4paper]{report} \usepackage[landscape,margin=1in]{geometry} @@ -5,63 +7,45 @@ \usepackage{flowfram} \usepackage[colorlinks]{hyperref} -% Use sans-serif font as default font \renewcommand{\familydefault}{cmss} -% 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 @@ -70,19 +54,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. @@ -95,8 +78,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} @@ -104,16 +87,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 @@ -121,7 +104,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. @@ -130,14 +113,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). @@ -146,14 +129,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}): @@ -167,40 +150,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 @@ -212,13 +195,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} @@ -230,17 +213,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} @@ -262,43 +245,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}. @@ -308,13 +291,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 @@ -322,7 +305,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} @@ -339,7 +322,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/flowfram/samples/sample-news.pdf b/Master/texmf-dist/doc/latex/flowfram/samples/sample-news.pdf Binary files differnew file mode 100644 index 00000000000..bfbd33ee0d2 --- /dev/null +++ b/Master/texmf-dist/doc/latex/flowfram/samples/sample-news.pdf diff --git a/Master/texmf-dist/doc/latex/flowfram/samples/news.tex b/Master/texmf-dist/doc/latex/flowfram/samples/sample-news.tex index a8ff83b3922..d3f98184ff9 100644 --- a/Master/texmf-dist/doc/latex/flowfram/samples/news.tex +++ b/Master/texmf-dist/doc/latex/flowfram/samples/sample-news.tex @@ -1,3 +1,5 @@ + % This file is public domain. + \documentclass{article} \usepackage{color} @@ -5,7 +7,6 @@ \usepackage[a5paper,top=10mm,bottom=10mm,margin=10mm]{geometry} \usepackage{graphicx} -% define lengths to help compute positions \newlength\leftX \newlength\leftY \newlength\leftH @@ -16,14 +17,12 @@ \newlength\rightH \newlength\rightW -% Create a static frame to put title in \setlength{\leftH}{2cm} \setlength{\leftY}{\textheight} \addtolength{\leftY}{-\leftH} \newstaticframe[1]{\textwidth}{\leftH}{0pt}{\leftY}[title] -% First flow frame. \setlength{\leftH}{7cm} \adjustheight{\leftH} @@ -35,7 +34,6 @@ \setlength{\rightH}{\leftH} \setlength{\rightY}{\leftY} -% Second flow frame \setlength{\leftH}{3.5cm} \adjustheight{\leftH} @@ -43,7 +41,6 @@ \newflowframe[1]{\textwidth}{\leftH}{0pt}{\leftY} -% Right hand flow frame \setlength{\rightX}{\leftW} \addtolength{\rightX}{\columnsep} @@ -52,19 +49,14 @@ \newflowframe[1]{\rightW}{\rightH}{\rightX}{\rightY} -% insert vertical line between left and right flow frames \insertvrule{flow}{1}{flow}{3} -% insert horizontal line between flow frames 2 and 3 -% don't want it to go under frame 1 so shift the starting -% position \addtolength{\rightX}{-0.5\columnsep} \addtolength{\rightX}{-0.5\columnseprule} \inserthrule[-\rightX]{flow}{3}{flow}{2} -% egg picture \addtolength{\rightY}{\rightH} \addtolength{\rightY}{-10mm} @@ -75,20 +67,16 @@ \addtolength{\rightX}{-\rightW} \newstaticframe[1]{\rightW}{\rightH}{\rightX}{\rightY}[egg] -% set contents \setstaticcontents*{egg}{\includegraphics[scale=0.75]{egg}} -% middle heading \setlength{\leftH}{2cm} \addtolength{\leftY}{-\leftH} \newstaticframe[1]{\textwidth}{\leftH}{0pt}{\leftY}[midhead] -% insert horizontal line \inserthrule*{flow}{2}{static}{midhead} -% bottom left flow frame \setlength{\leftH}{\leftY} \adjustheight{\leftH} @@ -96,7 +84,6 @@ \newflowframe[1]{\leftW}{\leftH}{0pt}{0pt} -% bottom right flow frame \setlength{\rightX}{\leftW} \addtolength{\rightX}{\columnsep} @@ -105,11 +92,9 @@ \newflowframe[1]{\rightW}{\leftH}{\rightX}{0pt} -% static frame for sheep picture \newstaticframe[1]{0.8in}{0.8in}{0pt}{0pt}[sheep] -% set contents \setstaticcontents*{sheep}{\includegraphics[scale=0.75]{sheep}} \onecolumn[>1] % for any text that falls off the last page @@ -159,7 +144,7 @@ people to keep their doors securely fastened at all times. {\parshape=6 0pt 13em 0pt 13em 0pt 11em 0pt 11em 0pt 13em 0pt 17em -An egg person tragically fell from a six foot wall yesterday +An egg person tragically fell from a six foot wall yesterday afternoon and was smash\-ed to pieces. The king's cavalry rushed to the scene, but regretted that they were unable to help him. \par} @@ -189,12 +174,12 @@ as they did indeed come home. Eye witnesses reported that their tails were wagging behind them. ``I'm just so happy they've come home,'' Little Bo Peep said in a press conference yesterday\framebreak}afternoon. -The sheep themselves made no comment, and police are still +The sheep themselves made no comment, and police are still trying to determine what happened to them. \noindent\hrulefill -This is a sample document illustrating the +This is a sample document illustrating the flowfram package. It uses \TeX's \verb|\parshape| command to create irregularly shaped paragraphs. diff --git a/Master/texmf-dist/doc/latex/flowfram/samples/sample-news2.pdf b/Master/texmf-dist/doc/latex/flowfram/samples/sample-news2.pdf Binary files differnew file mode 100644 index 00000000000..792b51492a1 --- /dev/null +++ b/Master/texmf-dist/doc/latex/flowfram/samples/sample-news2.pdf diff --git a/Master/texmf-dist/doc/latex/flowfram/samples/news2.tex b/Master/texmf-dist/doc/latex/flowfram/samples/sample-news2.tex index 125d5d3cd58..8752e95a771 100644 --- a/Master/texmf-dist/doc/latex/flowfram/samples/news2.tex +++ b/Master/texmf-dist/doc/latex/flowfram/samples/sample-news2.tex @@ -1,3 +1,5 @@ + % This file is public domain. + \documentclass[12pt]{article} \usepackage{graphicx} @@ -5,25 +7,22 @@ \usepackage{flowfram} \usepackage[a4paper,margin=20mm]{geometry} -% define lengths to help compute positions \newlength\leftX \newlength\leftY \newlength\leftH \newlength\leftW - + \newlength\rightX \newlength\rightY \newlength\rightH \newlength\rightW -% Create a static frame to put title in \setlength{\leftH}{3cm} \setlength{\leftY}{\textheight} \addtolength{\leftY}{-\leftH} - + \newstaticframe[1]{\textwidth}{\leftH}{0pt}{\leftY}[title] -% Create left hand frame. This will have an L shape \setlength{\leftH}{13cm} \adjustheight{\leftH} @@ -57,7 +56,6 @@ 0pt \linewidth }} -% egg picture \addtolength{\rightY}{\leftY} \addtolength{\rightY}{73mm} @@ -67,10 +65,8 @@ \addtolength{\rightX}{-\rightW} \newstaticframe[1]{\rightW}{\rightH}{\rightX}{\rightY}[egg] -% set contents \setstaticcontents*{egg}{\includegraphics[scale=0.9]{egg}} -% Right hand static frame \setlength{\rightX}{0.5\textwidth} \addtolength{\rightX}{\columnsep} @@ -101,32 +97,24 @@ 0pt \linewidth }} -% insert vertical and horizontal rules, can't use -% \insertrule as left hand -% frame is actually the width of the typeblock \addtolength{\rightX}{-0.5\columnsep} \newstaticframe[1]{0pt}{\rightH}{\rightX}{\rightY}[Lrule] \setstaticcontents*{Lrule}{\makebox[0pt][l]{% \rule{\columnseprule}{\rightH}\rule{\rightW}{\columnseprule}}} -% middle heading \setlength{\leftH}{2cm} \addtolength{\leftY}{-\leftH} \newstaticframe[1]{\textwidth}{\leftH}{0pt}{\leftY}[midhead] -% insert horizontal rule \inserthrule*{static}{L}{static}{midhead} -% flow frames \twocolumninarea{\textwidth}{\leftY}{0pt}{0pt} -% static frame for sheep picture \newstaticframe[1]{1.6in}{1.6in}{0pt}{0pt}[sheep] -% set contents \setstaticcontents*{sheep}{\includegraphics[scale=1.2]{sheep}} \setcounter{secnumdepth}{0} @@ -143,12 +131,12 @@ Fairy Tale Times \begin{staticcontents*}{L} \section{Killer Wolf on the Loose} - + The authorites are warning of a killer wolf on the loose. He has so far devoured an old grandmother and two pig brothers. He is described as being furry with big eyes and big teeth. - + On Monday this week he broke into a house, and devoured an old lady. He then disguised himself as the old lady in order to deceive her granddaughter. Luckily for the little @@ -161,9 +149,9 @@ pig brothers who had most incautiously made their dwellings on the cheap using inadequate materials. The wolf also made an attempt on the third pig brother, but was unable to break into his house. - + Police are appealing to the public for witnesses and remind -people to keep their doors securely fastened at all times. +people to keep their doors securely fastened at all times. ``Always ask to see identification,'' said one police advisor, ``and invest in improving the general security of your property.'' \end{staticcontents*} @@ -181,8 +169,6 @@ those vulnerable members of the population suffering from eggshell syndrome. \small\em -%Wall related incidents this year: page 3 -% Exclusive interview with one of the King's men on page 6 \end{staticcontents*} @@ -196,7 +182,7 @@ for more than a week. ``I just didn't know where to find them,'' the shepherdess stated, ``but I was told to leave them alone and they'd come -home.'' +home.'' \parshape=8 0pt \linewidth @@ -219,7 +205,7 @@ The big bad wolf is reportedly helping them with their inquiries. \noindent\hrulefill -This is a sample document illustrating the +This is a sample document illustrating the flowfram package. It uses \TeX's \verb|\parshape| command to create irregularly shaped paragraphs. This can be a complicated and somewhat tiresome task, and is generally not recommended. diff --git a/Master/texmf-dist/doc/latex/flowfram/samples/sample-pages.pdf b/Master/texmf-dist/doc/latex/flowfram/samples/sample-pages.pdf Binary files differnew file mode 100644 index 00000000000..4e8532796e9 --- /dev/null +++ b/Master/texmf-dist/doc/latex/flowfram/samples/sample-pages.pdf diff --git a/Master/texmf-dist/doc/latex/flowfram/samples/sample-pages.tex b/Master/texmf-dist/doc/latex/flowfram/samples/sample-pages.tex new file mode 100644 index 00000000000..38e52856a4c --- /dev/null +++ b/Master/texmf-dist/doc/latex/flowfram/samples/sample-pages.tex @@ -0,0 +1,104 @@ + % This file is public domain. + +\documentclass{book} + +\usepackage[demo]{graphicx} +\usepackage{lipsum} +\usepackage{color} +\usepackage[ + draft, + verbose, + pages=absolute + ]{flowfram} + +\onecolumn + +\setflowframe{1}{label=single} + +\twocolumnDtop[none]{2in} + +\setdynamicframe{1}{label=title} +\setflowframe{2}{label=shortleft} +\setflowframe{3}{label=shortright} + +\twocolumn[none] + +\setflowframe{4}{label=left} +\setflowframe{5}{label=right} + +\newdynamicframe[none]{\textwidth}{\textheight}{0pt}{0pt}[image] + +\setdynamicframe*{image}{valign=c} + +\title{Sample Document} +\author{A.N. Other} + +\begin{document}\raggedright +\maketitle + +\frontmatter +\tableofcontents +\chapter{Acknowledgements} + +\lipsum[1] + +\flowswitchoffnextodd*{single}% +\flowswitchonnextoddonly*{shortleft,shortright}% +\dynamicswitchonnextoddonly*{title}% +\dfchaphead*{title} + +\mainmatter +\chapter{Sample} + +\flowswitchonnext*{left,right}% +\renewcommand{\ffprechapterhook}{% + \flowswitchoffnextoddonly*{left,right}% + \flowswitchonnextoddonly*{shortleft,shortright}% + \dynamicswitchonnextoddonly*{title}% +} + +\lipsum + +\lipsum + +\chapter{Another Sample Chapter} + +\lipsum[1-20] + + +\flowswitchoffnextonly*{left,right} +\flowswitchonnextonly*{single} + +\clearpage + +\begin{figure}[p] +\centering + \includegraphics{image1} +\caption{A Sample Figure} +\label{fig:sample} +\end{figure} + +\clearpage + +\lipsum[21-30] + +\chapter{Here's Another Chapter} + +\lipsum[1-20] + + +\flowswitchoffnextonly*{left,right} +\dynamicswitchonnextonly*{image} + +\setdynamiccontents*{image}{% + \begin{staticfigure} + \centering + \includegraphics{image2} + \caption{Another Sample Figure} + \label{fig:sample2} + \end{staticfigure} +} + +\lipsum[21-40] + +\end{document} diff --git a/Master/texmf-dist/doc/latex/flowfram/samples/sample-poster.pdf b/Master/texmf-dist/doc/latex/flowfram/samples/sample-poster.pdf Binary files differnew file mode 100644 index 00000000000..9097577037b --- /dev/null +++ b/Master/texmf-dist/doc/latex/flowfram/samples/sample-poster.pdf diff --git a/Master/texmf-dist/doc/latex/flowfram/samples/poster.tex b/Master/texmf-dist/doc/latex/flowfram/samples/sample-poster.tex index 05fe2131f7d..c8d2784525e 100644 --- a/Master/texmf-dist/doc/latex/flowfram/samples/poster.tex +++ b/Master/texmf-dist/doc/latex/flowfram/samples/sample-poster.tex @@ -1,34 +1,28 @@ + % This file is public domain. + \documentclass[a0]{a0poster} \usepackage{color} -\usepackage{times} +\usepackage{mathptmx} \usepackage{courier} -\usepackage{helvet} +\usepackage[scaled=0.92]{helvet} +\usepackage{url} \usepackage{flowfram} -% set up frames \setlength{\columnsep}{2cm} -% Base the page layout on 4 column with static header. -% The static frame has height = 0.2\textheight \NcolumnStop{4}{0.2\textheight} -% give the static frame a label to make it easier to keep track of \setstaticframe{\value{maxstatic}}{label={title},backcolor=[cmyk]{0.64,0,0.95,0.40},textcolor=white} -% Insert a vertical line between flow frames 2 and 3: \insertvrule{flow}{2}{flow}{3} -% On the first page, replace last two columns with -% 2 columns and a static underneath \setflowframe{3,4}{pages={>1}} \computeflowframearea{3,4} \twocolumnSbottominarea[1]{0.5\ffareaheight}{\ffareawidth}{\ffareaheight}{\ffareax}{\ffareay} \setstaticframe{\value{maxstatic}}{label={info},backcolor=[cmyk]{0.26,0,0.76,0},clear} -% insert a horizontal rule between flow frame 5 and static -% frame 5 \inserthrule*[0.5\columnsep]{flow}{5}{static}{info} \setallflowframes{backcolor=[cmyk]{0.15,0,0.69,0}} @@ -38,8 +32,6 @@ \newcommand{\cmdname}[1]{\texttt{\symbol{92}#1}} \newcommand{\meta}[1]{\textnormal{\textless\textit{#1}\textgreater}} -%\raggedright -%\setlength{\parindent}{15pt} \begin{document} \begin{staticcontents*}{title} @@ -48,7 +40,7 @@ \vskip1cm \huge Nicola L. C. Talbot \vskip2ex -\normalsize \verb"http://theoval.cmp.uea.ac.uk/~nlct/" +\normalsize \url{http://www.dickimaw-books.com/} \end{center} \end{staticcontents*} @@ -74,7 +66,7 @@ % The area taken up by the 3rd and 4th columns is given by \computeflowframearea{3,4} - + % Set up new frames in this area \twocolumnSbottominarea[1]{0.5}{\ffareawidth}{\ffareaheight}{\ffareax}{\ffareay} @@ -90,8 +82,8 @@ \end{staticfigure} \end{staticcontents*} -This is a modified version of the manual for the \sty{flowfram} -package. It is intended to illustrated what can be done. See the +This is a modified version of the manual for the \sty{flowfram} +package. It is intended to illustrated what can be done. See the full manual (ffuserguide.pdf) for a comprehensive description, as this may now be out of date. The commands used to define the frames for this document are shown in Figure~\ref{fig:thisdoc}. @@ -102,25 +94,25 @@ problem working out the line breaks. \section{Introduction} The \sty{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. \section{Setting up Frames} The \sty{flowfram} package provides three types of frame: -{flow frames}, {static +{flow frames}, {static frames} and {dynamic frames}. \subsection{Flow Frames} 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 @@ -128,7 +120,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. @@ -137,28 +129,28 @@ 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. \subsection{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). \section{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}): @@ -172,20 +164,20 @@ is only available for {dynamic frames}): \item[y=\meta{length}] The y-coordinate of the frame. -\item[border=\meta{style}] The style of the border around the +\item[border=\meta{style}] 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}] The border offset, if it is a +\item[offset=\meta{offset}] 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 \sty{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}] The colour of the border @@ -193,18 +185,18 @@ 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, e.g. \verb/[rgb]{0,1,0}/. -\item[textcolor=\meta{colour}] 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}] The text colour for that +frame. Again, the colour can either be specified as, +e.g.\ \texttt{green}, or including the colour model, e.g. \verb/[rgb]{0,1,0}/. -\item[pages=\meta{page list}] The {list of +\item[pages=\meta{page list}] 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}] The side of @@ -216,13 +208,13 @@ is set, the static frame will be cleared at the start of the next page. \item[style=\meta{cmd}\textsuperscript{D}] 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} @@ -234,17 +226,17 @@ bold. To unset a style, do \verb/style=none/. The \sty{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}. \subsection{Frame Stacking Order} @@ -265,42 +257,42 @@ 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. \subsection{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}. \subsection{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}. @@ -310,13 +302,13 @@ from \env{figure} and \env{table}. The following macros can be changed using \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 @@ -324,7 +316,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} @@ -341,7 +333,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/flowfram/samples/sample-rot.pdf b/Master/texmf-dist/doc/latex/flowfram/samples/sample-rot.pdf Binary files differnew file mode 100644 index 00000000000..88dc5e0b92e --- /dev/null +++ b/Master/texmf-dist/doc/latex/flowfram/samples/sample-rot.pdf diff --git a/Master/texmf-dist/doc/latex/flowfram/samples/sample-rot.tex b/Master/texmf-dist/doc/latex/flowfram/samples/sample-rot.tex new file mode 100644 index 00000000000..f62944db3ae --- /dev/null +++ b/Master/texmf-dist/doc/latex/flowfram/samples/sample-rot.tex @@ -0,0 +1,49 @@ + % This file is public domain. + +\documentclass[a4paper]{article} + +\usepackage[draft]{flowfram} +\usepackage{supertabular} + +\newflowframe{0.3\textwidth}{0.25\textheight}{0.5\textwidth}{0.5\textheight} + +\newflowframe{0.3\textwidth}{0.2\textheight}{0pt}{0.1\textheight} + +\newflowframe{0.3\textwidth}{0.2\textheight}{0.5\textwidth}{0.1\textheight} + +\setflowframe{1}{angle=45} +\setflowframe{3}{angle=90} + +\begin{document} + +This is a sample document illustrating the use of the +flowfram package. The first flow frame has been rotated +by an angle of 45 degrees. There is an asterisk in the +margin\marginpar{*}. There is also a +footnote\footnote{down here.}. + +\framebreak +\begin{supertabular}{rl} +1 & A\\ +2 & B\\ +3 & C\\ +4 & D\\ +5 & E\\ +6 & F\\ +7 & G\\ +8 & H\\ +9 & I\\ +10 & J\\ +11 & K\\ +12 & L\\ +13 & M\\ +14 & N\\ +15 & O\\ +16 & P\\ +17 & Q\\ +18 & R\\ +19 & S\\ +20 & T\\ +\end{supertabular} + +\end{document} diff --git a/Master/texmf-dist/doc/latex/flowfram/samples/sample.pdf b/Master/texmf-dist/doc/latex/flowfram/samples/sample.pdf Binary files differnew file mode 100644 index 00000000000..4a47a3bedb5 --- /dev/null +++ b/Master/texmf-dist/doc/latex/flowfram/samples/sample.pdf diff --git a/Master/texmf-dist/doc/latex/flowfram/samples/sample.tex b/Master/texmf-dist/doc/latex/flowfram/samples/sample.tex new file mode 100644 index 00000000000..1bf6ccf6293 --- /dev/null +++ b/Master/texmf-dist/doc/latex/flowfram/samples/sample.tex @@ -0,0 +1,379 @@ + % This file is public domain. + +\documentclass[a4paper,twoside]{book} + +\usepackage{times} +\usepackage{courier} +\usepackage{helvet} +\usepackage[margin=1in,top=1in,bottom=1in]{geometry} +\usepackage[colorlinks, + linkcolor=black, + urlcolor=black, + plainpages=false, + pdfpagelabels=true]{hyperref} +\usepackage{fancybox} +\usepackage{color} +\usepackage{flowfram} + +\newcommand{\sty}[1]{\textsf{#1}} +\newcommand{\env}[1]{\textsf{#1}} +\newcommand{\cmdname}[1]{\texttt{\symbol{92}#1}} +\newcommand{\meta}[1]{\textnormal{\textless\textit{#1}\textgreater}} + +\newlength{\leftwidth} +\newlength{\rightwidth} + +\computeleftedgeodd{\leftwidth} +\setlength{\leftwidth}{-\leftwidth} +\addtolength{\leftwidth}{0.4\textwidth} +\setlength{\rightwidth}{\paperwidth} +\addtolength{\rightwidth}{-\leftwidth} +\vtwotone[1]{\leftwidth}{magenta}{backleft}{\rightwidth}{[cmyk]{0,0.48,0,0}}{backright} + +\vtwotone[none]{\rightwidth}{[cmyk]{0,0.48,0,0}}{lastbackright}{\leftwidth}{magenta}{lastbackleft} + +\vtwotonetop[odd]{1cm}{\leftwidth}{magenta}{oddtopleft}{\rightwidth}{[cmyk]{0,0.48,0,0}}{oddtopright} +\vtwotonetop[even]{1cm}{\rightwidth}{[cmyk]{0,0.48,0,0}}{eventopleft}{\leftwidth}{magenta}{eventopright} + +\setlength{\marginparwidth}{2cm} + +\newflowframe{0.6\textwidth}{\textheight}{0pt}{0pt}[main] +\newdynamicframe{0.38\textwidth}{\textheight}{0.62\textwidth}{0pt}[chaphead] + +\setflowframe*{main}{evenx=0.4\textwidth} +\setdynamicframe*{chaphead}{evenx=0pt} + +\setflowframe*{main}{margin=inner} + +\dfchaphead*{chaphead} + +\appenddfminitoc*{chaphead} + + +\renewcommand{\DFchapterstyle}[1]{% +\raggedright\sffamily\bfseries\Huge\color{blue}#1\par +} + +\renewcommand{\DFschapterstyle}[1]{\raggedright\sffamily\bfseries\Huge\color{blue} #1\par +} + + +\makethumbtabs{2in} +\enableminitoc + +\setthumbtab{1}{backcolor=[rgb]{0.15,0.15,1}} +\setthumbtab{2}{backcolor=[rgb]{0.2,0.2,1}} +\setthumbtab{3}{backcolor=[rgb]{0.25,0.25,1}} +\setthumbtab{4}{backcolor=[rgb]{0.3,0.3,1}} + +\newcommand{\thumbtabstyle}[1]{\textsc{\sffamily #1}} +\setthumbtab{all}{style=thumbtabstyle,textcolor=white} + + +\pagestyle{plain} + +\makedfheaderfooter + +\newlength{\xoffset} +\computerightedgeodd{\xoffset} +\addtolength{\xoffset}{-2cm} +\newlength{\yoffset} +\computebottomedge{\yoffset} + +\newcommand{\footstyle}[1]{\bfseries\LARGE #1} + + +\setdynamicframe*{footer}{oddx=\xoffset,y=\yoffset,width=2cm,height=2cm, +backcolor=blue,textcolor=white,style=footstyle,pages=none} + + +\computeleftedgeeven{\xoffset} +\setdynamicframe*{footer}{evenx=\xoffset} + +\begin{document} +\ffswapoddeven*{main}% swap odd and even position of frame for the title page +\dfswapoddeven*{chaphead} +\title{Creating Flow Frames for Posters or Magazines} +\author{Nicola L. C. Talbot\\[1cm]\url{http://www.dickimaw-books.com/}} +\date{} +\pagenumbering{alph} +\maketitle + +\cleardoublepage +\setstaticframe*{backleft}{pages=none} +\setstaticframe*{backright}{pages=none} + +\frontmatter +\tocandthumbtabindex +\setdynamicframe*{footer}{pages=all} + +\clearpage +\dfswapoddeven*{chaphead} +\ffswapoddeven*{main}% swap back again + +\mainmatter +\chapter{Introduction} +\enablethumbtabs +\pagenumbering{arabic} + +The \sty{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. +This is useful for creating posters\marginpar{A marginal note} +or magazines or any other form of document that does not +conform to the standard one or two column layout. + +This document has \themaxflow\ flow +\ifthenelse{\value{maxflow}=1}{frame}{frames}, \themaxstatic\ static +\ifthenelse{\value{maxstatic}=1}{frame}{frames} and +\themaxdynamic\ dynamic \ifthenelse{\value{maxdynamic}=1}{frame}{frames}. + +\chapter{Setting up Frames} + +The \sty{flowfram} package provides three types of frame: +{flow frames}, {static +frames} and {dynamic frames}. + +\section{Flow Frames} + +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, +position on the page, and optionally a border\footnote{A +footnote!}. + +\section{Static Frames} + +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 +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 +contents in a savebox, whereas a dynamic frame stores its +contents in a macro). + +\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 +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 +for {static frames} +and \textsuperscript{\textbf{D}} indicates the key +is only available for {dynamic frames}): + +\begin{description} +\item[width=\meta{length}] The width of the frame. + +\item[height=\meta{length}] The height of the frame. + +\item[x=\meta{length}] The x-coordinate of the frame. + +\item[y=\meta{length}] The y-coordinate of the frame. + +\item[border=\meta{style}] 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. +The value \texttt{fbox} is equivalent to \texttt{plain}. + +\item[offset=\meta{offset}] 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 \sty{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 +may end up shifted to the right or left. + +\item[bordercolor=\meta{colour}] 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, e.g. \verb/[rgb]{0,1,0}/. + +\item[textcolor=\meta{colour}] The text colour for that +frame. Again, the colour can either be specified as, +e.g.\ \texttt{green}, or including the colour model, +e.g. \verb/[rgb]{0,1,0}/. + +\item[pages=\meta{page list}] 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 +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 +{page ranges}. + +\item[margin=\meta{side}\textsuperscript{F}] The side of +the flow frame that its corresponding margin should go on. This +can take the values \texttt{left} or \texttt{right}. + +\item[clear=\meta{boolean}\textsuperscript{S}] If this value +is set, the static frame will be cleared at the start of the +next page. + +\item[style=\meta{cmd}\textsuperscript{D}] 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 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 +bold. To unset a style, do \verb/style=none/. + +\end{description} + +\chapter{Miscellaneous} + +\section{Page Layout} + +The \sty{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 +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 +\cmdname{flowframeshowlayout} + +The headers and footers will appear as usual (but will not +be shown in draft mode), according to the format given by +\cmdname{pagestyle}. + +\section{Frame Stacking Order} + +The material on each page is placed in the following order: +\begin{enumerate} +\item Each static frame defined for that page in ascending +order of IDN. + +\item Each flow frame defined for that page in ascending +order of IDN. + +\item Each dynamic frame defined for that page in ascending +order of IDN. + +\item {Bounding boxes} if the \texttt{draft} +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. + +\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. + +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 +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 +next frame, use the command\newline +\cmdname{finishthispage}. + +\section{Floats} + +Since floats (such as figures and tables) can only go in +{flow frames}, this package provides +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 +be used within \env{staticfigure} and \env{statictable} as +usual. + +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}. + +\section{Global Values} + +The following macros can be changed using \cmdname{renewcommand}: + +\begin{itemize} +\item \cmdname{setffdraftcolor} + +This sets the colour of the bounding box +when it is displayed in draft mode. + +\item +\cmdname{setffdrafttypeblockcolor} + +This sets the colour of +the bounding box of the typeblock when it is displayed +in draft mode. + +\item \cmdname{fflabelfont} + +This sets the font size for the bounding box markers in +draft mode. + +\end{itemize} + +The following are lengths, which can be changed using +\cmdname{setlength}: +\marginpar{Another marginal note} + +\begin{itemize} +\item \cmdname{fflabelsep} + +This is the distance from the right hand side of the +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. + +\item \cmdname{flowframerule} + +This is the width of the frame's border, if using +a border given by a frame making command that uses \cmdname{fboxsep} +to set its border width. +\end{itemize} + +\chapter*{Contact Details} +\disablethumbtabs + +Dr Nicola Talbot\\ +School of Computing Sciences\\ +University of East Anglia\\ +Norwich. Norfolk. NR4 7TJ. UK\\ +\url{http://theoval.cmp.uea.ac.uk/~nlct/} + +\finishthispage\mbox{} +\setdynamiccontents*{chaphead}{} +\setdynamicframe*{footer}{pages=none} +\setstaticframe*{lastbackleft,lastbackright}{pages=even} +\end{document} diff --git a/Master/texmf-dist/doc/latex/flowfram/samples/sample1.pdf b/Master/texmf-dist/doc/latex/flowfram/samples/sample1.pdf Binary files differnew file mode 100644 index 00000000000..f1798b9c6a6 --- /dev/null +++ b/Master/texmf-dist/doc/latex/flowfram/samples/sample1.pdf diff --git a/Master/texmf-dist/doc/latex/flowfram/samples/sample1.tex b/Master/texmf-dist/doc/latex/flowfram/samples/sample1.tex new file mode 100644 index 00000000000..6fd4d999fc4 --- /dev/null +++ b/Master/texmf-dist/doc/latex/flowfram/samples/sample1.tex @@ -0,0 +1,305 @@ + % This file is public domain. + +\documentclass[a4paper]{article} + +\usepackage[a4paper,landscape,margin=1in]{geometry} +\usepackage{fancybox} +\usepackage{color} +\usepackage{flowfram} + +\showframebboxtrue +\showtypeblocktrue + + +\NcolumnStop{4}{1in} + +\setflowframe{3,4}{pages={>1}} +\twocolumnSbottominarea[1]{1in}{0.5\textwidth}{\flowframeheight{3}}{0.5\textwidth}{0pt} + +\begin{staticcontents}{2} +The page layout for this document was obtained with +the following commands: +\begin{verbatim} +\NcolumnStop{4}{1in} +\setflowframe{3,4}{pages={>1}} +\twocolumnSbottominarea[1]{1in}{0.5\textwidth}{flowframeheight{3}} +{0.5\textwidth}{0pt} +\end{verbatim} +\end{staticcontents} + +\newcommand{\sty}[1]{\textsf{#1}} +\newcommand{\env}[1]{\textsf{#1}} +\newcommand{\cmdname}[1]{\texttt{\symbol{92}#1}} +\newcommand{\meta}[1]{\textnormal{\textless\textit{#1}\textgreater}} + +\raggedright + +\begin{document} + +\begin{staticcontents}{1} +\title{Creating Flow Frames for Posters or Magazines} +\author{Nicola L. C. Talbot} +\date{} +\maketitle +\end{staticcontents} + +This is a modified version of the manual for the \sty{flowfram} package. +It is intended to illustrated what can be done. See the full manual for +a comprehensive description. + +If the columns are very narrow, it may be better to +use \cmdname{raggedright}, otherwise \TeX\ may have a +problem working out the line breaks. + +\section{Introduction} + +The \sty{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. +This is useful for creating posters +or magazines or any other form of document that does not +conform to the standard one or two column layout. + +\section{Setting up Frames} + +The \sty{flowfram} package provides three types of frame: +{flow frames}, {static +frames} and {dynamic frames}. + +\subsection{Flow Frames} + +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, +position on the page, and optionally a border. + +It is recommended that all the flow frames in a document +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 +flow frames to have unequal widths, judicious use of +\cmdname{framebreak} is required. + +\subsection{Static Frames} + +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 +a company logo appear in the same place on every page. + +\subsection{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 +contents in a savebox, whereas a dynamic frame stores its +contents in a macro). + +\section{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 +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 +for {static frames} +and \textsuperscript{\textbf{D}} indicates the key +is only available for {dynamic frames}): + +\begin{description} +\item[width=\meta{length}] The width of the frame. + +\item[height=\meta{length}] The height of the frame. + +\item[x=\meta{length}] The x-coordinate of the frame. + +\item[y=\meta{length}] The y-coordinate of the frame. + +\item[border=\meta{style}] 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. +The value \texttt{fbox} is equivalent to \texttt{plain}. + +\item[offset=\meta{offset}] 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 \sty{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 +may end up shifted to the right or left. + +\item[bordercolor=\meta{colour}] 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, e.g. \verb/[rgb]{0,1,0}/. + +\item[textcolor=\meta{colour}] The text colour for that +frame. Again, the colour can either be specified as, +e.g.\ \texttt{green}, or including the colour model, +e.g. \verb/[rgb]{0,1,0}/. + +\item[pages=\meta{page list}] 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 +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 +{page ranges}. + +\item[margin=\meta{side}\textsuperscript{F}] The side of +the flow frame that its corresponding margin should go on. This +can take the values \texttt{left} or \texttt{right}. + +\item[clear=\meta{boolean}\textsuperscript{S}] If this value +is set, the static frame will be cleared at the start of the +next page. + +\item[style=\meta{cmd}\textsuperscript{D}] 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 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 +bold. To unset a style, do \verb/style=none/. + +\end{description} + +\section{Miscellaneous} + +\subsection{Page Layout} + +The \sty{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 +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 +\cmdname{flowframeshowlayout} + +The headers and footers will appear as usual (but will not +be shown in draft mode), according to the format given by +\cmdname{pagestyle}. + +\subsection{Frame Stacking Order} + +The material on each page is placed in the following order: +\begin{enumerate} +\item Each static frame defined for that page in ascending +order of IDN. + +\item Each flow frame defined for that page in ascending +order of IDN. + +\item Each dynamic frame defined for that page in ascending +order of IDN. + +\item {Bounding boxes} if the \texttt{draft} +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. + +\subsection{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. + +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 +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 +next frame, use the command\newline +\cmdname{finishthispage}. + +\subsection{Floats} + +Since floats (such as figures and tables) can only go in +{flow frames}, this package provides +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 +be used within \env{staticfigure} and \env{statictable} as +usual. + +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}. + +\subsection{Global Values} + +The following macros can be changed using \cmdname{renewcommand}: + +\begin{itemize} +\item \cmdname{setffdraftcolor} + +This sets the colour of the bounding box +when it is displayed in draft mode. + +\item +\cmdname{setffdrafttypeblockcolor} + +This sets the colour of +the bounding box of the typeblock when it is displayed +in draft mode. + +\item \cmdname{fflabelfont} + +This sets the font size for the bounding box markers in +draft mode. + +\end{itemize} + +The following are lengths, which can be changed using +\cmdname{setlength}: + +\begin{itemize} +\item \cmdname{fflabelsep} + +This is the distance from the right hand side of the +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. + +\item \cmdname{flowframerule} + +This is the width of the frame's border, if using +a border given by a frame making command that uses \cmdname{fboxsep} +to set its border width. +\end{itemize} + +\end{document} diff --git a/Master/texmf-dist/doc/latex/flowfram/samples/sample2.pdf b/Master/texmf-dist/doc/latex/flowfram/samples/sample2.pdf Binary files differnew file mode 100644 index 00000000000..06633932a57 --- /dev/null +++ b/Master/texmf-dist/doc/latex/flowfram/samples/sample2.pdf diff --git a/Master/texmf-dist/doc/latex/flowfram/samples/sample2.tex b/Master/texmf-dist/doc/latex/flowfram/samples/sample2.tex new file mode 100644 index 00000000000..d1ca0992234 --- /dev/null +++ b/Master/texmf-dist/doc/latex/flowfram/samples/sample2.tex @@ -0,0 +1,272 @@ + % This file is public domain. + +\documentclass[a4paper,twoside]{report} + +\usepackage{url} + +\newcommand{\cmdname}[1]{\texttt{\char`\\#1}} +\newcommand{\sty}[1]{\texttt{#1}} +\newcommand{\env}[1]{\texttt{#1}} +\newcommand{\meta}[1]{$\langle$\emph{#1}$\rangle$} + +\begin{document} + +\title{Creating Flow Frames for Posters or Magazines} +\author{Nicola L. C. Talbot\\[1cm]\url{http://www.dickimaw-books.com/}} +\date{} +\pagenumbering{alph} +\maketitle + +\pagenumbering{roman} +\tableofcontents + +\chapter{Introduction} +\pagenumbering{arabic} + +The \sty{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. +This is useful for creating posters +or magazines or any other form of document that does not +conform to the standard one or two column layout. + +\chapter{Setting up Frames} + +The \sty{flowfram} package provides three types of frame: +{flow frames}, {static +frames} and {dynamic frames}. + +\section{Flow Frames} + +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, +position on the page, and optionally a border. + +\section{Static Frames} + +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 +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 +contents in a savebox, whereas a dynamic frame stores its +contents in a macro). + +\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 +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 +for {static frames} +and \textsuperscript{\textbf{D}} indicates the key +is only available for {dynamic frames}): + +\begin{description} +\item[width=\meta{length}] The width of the frame. + +\item[height=\meta{length}] The height of the frame. + +\item[x=\meta{length}] The x-coordinate of the frame. + +\item[y=\meta{length}] The y-coordinate of the frame. + +\item[border=\meta{style}] 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. +The value \texttt{fbox} is equivalent to \texttt{plain}. + +\item[offset=\meta{offset}] 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 \sty{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 +may end up shifted to the right or left. + +\item[bordercolor=\meta{colour}] 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, e.g. \verb/[rgb]{0,1,0}/. + +\item[textcolor=\meta{colour}] The text colour for that +frame. Again, the colour can either be specified as, +e.g.\ \texttt{green}, or including the colour model, +e.g. \verb/[rgb]{0,1,0}/. + +\item[pages=\meta{page list}] 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 +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 +{page ranges}. + +\item[margin=\meta{side}\textsuperscript{F}] The side of +the flow frame that its corresponding margin should go on. This +can take the values \texttt{left} or \texttt{right}. + +\item[clear=\meta{boolean}\textsuperscript{S}] If this value +is set, the static frame will be cleared at the start of the +next page. + +\item[style=\meta{cmd}\textsuperscript{D}] 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 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 +bold. To unset a style, do \verb/style=none/. + +\end{description} + +\chapter{Miscellaneous} + +\section{Page Layout} + +The \sty{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 +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 +\cmdname{flowframeshowlayout} + +The headers and footers will appear as usual (but will not +be shown in draft mode), according to the format given by +\cmdname{pagestyle}. + +\section{Frame Stacking Order} + +The material on each page is placed in the following order: +\begin{enumerate} +\item Each static frame defined for that page in ascending +order of IDN. + +\item Each flow frame defined for that page in ascending +order of IDN. + +\item Each dynamic frame defined for that page in ascending +order of IDN. + +\item {Bounding boxes} if the \texttt{draft} +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. + +\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. + +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 +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 +next frame, use the command\newline +\cmdname{finishthispage}. + +\section{Floats} + +Since floats (such as figures and tables) can only go in +{flow frames}, this package provides +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 +be used within \env{staticfigure} and \env{statictable} as +usual. + +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}. + +\section{Global Values} + +The following macros can be changed using \cmdname{renewcommand}: + +\begin{itemize} +\item \cmdname{setffdraftcolor} + +This sets the colour of the bounding box +when it is displayed in draft mode. + +\item +\cmdname{setffdrafttypeblockcolor} + +This sets the colour of +the bounding box of the typeblock when it is displayed +in draft mode. + +\item \cmdname{fflabelfont} + +This sets the font size for the bounding box markers in +draft mode. + +\end{itemize} + +The following are lengths, which can be changed using +\cmdname{setlength}: + +\begin{itemize} +\item \cmdname{fflabelsep} + +This is the distance from the right hand side of the +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. + +\item \cmdname{flowframerule} + +This is the width of the frame's border, if using +a border given by a frame making command that uses \cmdname{fboxsep} +to set its border width. +\end{itemize} + +\chapter*{Contact Details} + +Dr Nicola Talbot\\ +Dickimaw Books\\ +\url{http://www.dickimaw-books.com/} + +\end{document} diff --git a/Master/texmf-dist/doc/latex/flowfram/samples/sample3.pdf b/Master/texmf-dist/doc/latex/flowfram/samples/sample3.pdf Binary files differnew file mode 100644 index 00000000000..f22dd7c2af4 --- /dev/null +++ b/Master/texmf-dist/doc/latex/flowfram/samples/sample3.pdf diff --git a/Master/texmf-dist/doc/latex/flowfram/samples/sample3.tex b/Master/texmf-dist/doc/latex/flowfram/samples/sample3.tex new file mode 100644 index 00000000000..56bfcf79813 --- /dev/null +++ b/Master/texmf-dist/doc/latex/flowfram/samples/sample3.tex @@ -0,0 +1,65 @@ + % This file is public domain. + +\documentclass{article} + +\usepackage{color} +\usepackage[draft]{flowfram} +\usepackage{tikz} +\usetikzlibrary{snakes} + +\newstaticframe[1,2]{3in}{3in}{0pt}{0pt}[sf1] +\newdynamicframe[1,3]{2in}{3in}{0.5\textwidth}{0.5\textheight}[df1] + +\newstaticframe[2]{3in}{3in}{0.5\textwidth}{0.5\textheight}[sf2] + +\newdynamicframe[3]{2in}{2in}{0.5\textwidth}{0pt}[df2] + +\setlength{\sdfparindent}{\parindent} + +\onecolumn + +\newlength\fancywidth +\newlength\fancyheight +\newlength\fancydepth + +\newcommand{\fancyframe}[1]{% +\settowidth{\fancywidth}{#1}% +\settoheight{\fancyheight}{#1}% +\settodepth{\fancydepth}{#1}% +\addtolength{\fancyheight}{\fancydepth}% +\hspace{-\flowframesep}% +\tikz[baseline=0pt]{% +\draw[snake=bumps,raise snake=\flowframesep,line width=\flowframerule] + (0pt,0pt) + rectangle (\fancywidth,\fancyheight); +}} + +\begin{document} +\setstaticframe{1,2}{valign=t} +\setstaticframe{1}{border=fancyframe} +\setstaticcontents{1}{Top\par +\vfill +Bottom} + + +\mbox{} + +\newpage\mbox{} + +\begin{staticcontents*}{sf1} +Some text on the left static frame. +\continueonframe[continued \relativeframelocation{static}{2}{static}{1}]{sf2} +Some more text on the right static frame, and +some more text to pad it out a bit. +\end{staticcontents*} + +\newpage\mbox{} + +\begin{dynamiccontents}{1} +Some text in the first dynamic frame. +\continueonframe[continued \reldynamicloc*{df2}{df1}]{2} +Some more text in the second dynamic frame, and +some more text to pad it out a bit. +\end{dynamiccontents} + +\end{document} diff --git a/Master/texmf-dist/doc/latex/flowfram/samples/sampleRL.pdf b/Master/texmf-dist/doc/latex/flowfram/samples/sampleRL.pdf Binary files differnew file mode 100644 index 00000000000..079ae70299e --- /dev/null +++ b/Master/texmf-dist/doc/latex/flowfram/samples/sampleRL.pdf diff --git a/Master/texmf-dist/doc/latex/flowfram/samples/sampleRL.tex b/Master/texmf-dist/doc/latex/flowfram/samples/sampleRL.tex new file mode 100644 index 00000000000..48f4f5e615d --- /dev/null +++ b/Master/texmf-dist/doc/latex/flowfram/samples/sampleRL.tex @@ -0,0 +1,16 @@ + % This file is public domain. + +\documentclass{article} + +\usepackage{lipsum} +\usepackage[RL,draft]{flowfram} + +\twocolumn + +\begin{document} +This is the start of the text. + +\lipsum + +This is the end of the text. +\end{document} |