From b847625057328d18cbaff06505599203c8382a17 Mon Sep 17 00:00:00 2001 From: Karl Berry Date: Tue, 13 Nov 2012 00:16:56 +0000 Subject: flowfram 1.14 (12nov12) git-svn-id: svn://tug.org/texlive/trunk@28238 c570f23f-e606-0410-a88d-b1316a301751 --- Master/texmf-dist/doc/latex/flowfram/CHANGES | 89 + Master/texmf-dist/doc/latex/flowfram/README | 6 +- .../texmf-dist/doc/latex/flowfram/ffuserguide.html | 4922 -------------------- .../texmf-dist/doc/latex/flowfram/ffuserguide.pdf | Bin 447019 -> 298953 bytes .../texmf-dist/doc/latex/flowfram/ffuserguide.tex | 505 +- .../doc/latex/flowfram/ffuserguideidx.ist | 3 + Master/texmf-dist/doc/latex/flowfram/flowfram.pdf | Bin 478309 -> 524458 bytes .../doc/latex/flowfram/samples/brochure.pdf | Bin 64325 -> 0 bytes .../doc/latex/flowfram/samples/brochure.tex | 362 -- .../texmf-dist/doc/latex/flowfram/samples/news.pdf | Bin 29456 -> 0 bytes .../texmf-dist/doc/latex/flowfram/samples/news.tex | 204 - .../doc/latex/flowfram/samples/news2.pdf | Bin 35856 -> 0 bytes .../doc/latex/flowfram/samples/news2.tex | 231 - .../doc/latex/flowfram/samples/poster.pdf | Bin 77235 -> 0 bytes .../doc/latex/flowfram/samples/poster.tex | 363 -- .../doc/latex/flowfram/samples/sample-article.pdf | Bin 0 -> 163034 bytes .../doc/latex/flowfram/samples/sample-article.tex | 283 ++ .../doc/latex/flowfram/samples/sample-blanks.tex | 19 + .../doc/latex/flowfram/samples/sample-brochure.pdf | Bin 0 -> 101902 bytes .../doc/latex/flowfram/samples/sample-brochure.tex | 345 ++ .../doc/latex/flowfram/samples/sample-news.pdf | Bin 0 -> 47959 bytes .../doc/latex/flowfram/samples/sample-news.tex | 189 + .../doc/latex/flowfram/samples/sample-news2.pdf | Bin 0 -> 52810 bytes .../doc/latex/flowfram/samples/sample-news2.tex | 217 + .../doc/latex/flowfram/samples/sample-pages.pdf | Bin 0 -> 136327 bytes .../doc/latex/flowfram/samples/sample-pages.tex | 104 + .../doc/latex/flowfram/samples/sample-poster.pdf | Bin 0 -> 91415 bytes .../doc/latex/flowfram/samples/sample-poster.tex | 355 ++ .../doc/latex/flowfram/samples/sample-rot.pdf | Bin 0 -> 54583 bytes .../doc/latex/flowfram/samples/sample-rot.tex | 49 + .../doc/latex/flowfram/samples/sample.pdf | Bin 0 -> 100462 bytes .../doc/latex/flowfram/samples/sample.tex | 379 ++ .../doc/latex/flowfram/samples/sample1.pdf | Bin 0 -> 151242 bytes .../doc/latex/flowfram/samples/sample1.tex | 305 ++ .../doc/latex/flowfram/samples/sample2.pdf | Bin 0 -> 142705 bytes .../doc/latex/flowfram/samples/sample2.tex | 272 ++ .../doc/latex/flowfram/samples/sample3.pdf | Bin 0 -> 46648 bytes .../doc/latex/flowfram/samples/sample3.tex | 65 + .../doc/latex/flowfram/samples/sampleRL.pdf | Bin 0 -> 31645 bytes .../doc/latex/flowfram/samples/sampleRL.tex | 16 + 40 files changed, 3143 insertions(+), 6140 deletions(-) delete mode 100644 Master/texmf-dist/doc/latex/flowfram/ffuserguide.html create mode 100644 Master/texmf-dist/doc/latex/flowfram/ffuserguideidx.ist delete mode 100644 Master/texmf-dist/doc/latex/flowfram/samples/brochure.pdf delete mode 100644 Master/texmf-dist/doc/latex/flowfram/samples/brochure.tex delete mode 100644 Master/texmf-dist/doc/latex/flowfram/samples/news.pdf delete mode 100644 Master/texmf-dist/doc/latex/flowfram/samples/news.tex delete mode 100644 Master/texmf-dist/doc/latex/flowfram/samples/news2.pdf delete mode 100644 Master/texmf-dist/doc/latex/flowfram/samples/news2.tex delete mode 100644 Master/texmf-dist/doc/latex/flowfram/samples/poster.pdf delete mode 100644 Master/texmf-dist/doc/latex/flowfram/samples/poster.tex create mode 100644 Master/texmf-dist/doc/latex/flowfram/samples/sample-article.pdf create mode 100644 Master/texmf-dist/doc/latex/flowfram/samples/sample-article.tex create mode 100644 Master/texmf-dist/doc/latex/flowfram/samples/sample-blanks.tex create mode 100644 Master/texmf-dist/doc/latex/flowfram/samples/sample-brochure.pdf create mode 100644 Master/texmf-dist/doc/latex/flowfram/samples/sample-brochure.tex create mode 100644 Master/texmf-dist/doc/latex/flowfram/samples/sample-news.pdf create mode 100644 Master/texmf-dist/doc/latex/flowfram/samples/sample-news.tex create mode 100644 Master/texmf-dist/doc/latex/flowfram/samples/sample-news2.pdf create mode 100644 Master/texmf-dist/doc/latex/flowfram/samples/sample-news2.tex create mode 100644 Master/texmf-dist/doc/latex/flowfram/samples/sample-pages.pdf create mode 100644 Master/texmf-dist/doc/latex/flowfram/samples/sample-pages.tex create mode 100644 Master/texmf-dist/doc/latex/flowfram/samples/sample-poster.pdf create mode 100644 Master/texmf-dist/doc/latex/flowfram/samples/sample-poster.tex create mode 100644 Master/texmf-dist/doc/latex/flowfram/samples/sample-rot.pdf create mode 100644 Master/texmf-dist/doc/latex/flowfram/samples/sample-rot.tex create mode 100644 Master/texmf-dist/doc/latex/flowfram/samples/sample.pdf create mode 100644 Master/texmf-dist/doc/latex/flowfram/samples/sample.tex create mode 100644 Master/texmf-dist/doc/latex/flowfram/samples/sample1.pdf create mode 100644 Master/texmf-dist/doc/latex/flowfram/samples/sample1.tex create mode 100644 Master/texmf-dist/doc/latex/flowfram/samples/sample2.pdf create mode 100644 Master/texmf-dist/doc/latex/flowfram/samples/sample2.tex create mode 100644 Master/texmf-dist/doc/latex/flowfram/samples/sample3.pdf create mode 100644 Master/texmf-dist/doc/latex/flowfram/samples/sample3.tex create mode 100644 Master/texmf-dist/doc/latex/flowfram/samples/sampleRL.pdf create mode 100644 Master/texmf-dist/doc/latex/flowfram/samples/sampleRL.tex (limited to 'Master/texmf-dist/doc') 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 @@ - - - - - -Creating Flow Frames for Posters, Brochures or Magazines using flowfram.sty v 1.13 - - - - - - - - - - - - - - - -

- -

- -

Creating Flow Frames for Posters, Brochures or -Magazines using flowfram.sty v 1.13

-

Nicola L. C. Talbot

-

Date: 23rd January 2010

-

-

Key words and phrases: LaTeX; text frames; posters; brochures; magazines; newspapers

- -

- -

-Dr Nicola Talbot -
-School of Computing Sciences -
-University of East Anglia -
-Norwich. Norfolk. NR4 7TJ. -
-United Kingdom -
http://theoval.cmp.uea.ac.uk/~nlct/ -

- -

- -
- -

-Contents -

- - - - -

- -

- -

- -

-1. Introduction -

- -

- -This chapter provides a brief overview of the package, -the package options and the various frame types. -

- -

-The flowfram package is a LaTeX2e package designed to -enable you to create text frames in a document such that -the contents of the 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. - -

-The flowfram package provides three types of frame: -flow frames, static frames and dynamic frames with dimensions and -positions specified by the -user1.1. -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 -Modifying Frame -Attributes. Note that -unless otherwise stated, all co-ordinates are relative to the -bottom left hand corner of the typeblock. If you have -a two-sided document, the absolute position of the typeblock may vary depending on the values of \oddsidemargin -and \evensidemargin, and all the frames will shift -accordingly unless otherwise indicated. - -

-Since floats (such as figures and tables) can only go in -flow frames, this package provides -the additional environments: -staticfigure and -statictable which can be used in static frames and dynamic frames. Unlike their figure and -table counterparts, they are fixed in place, and -so do not take an optional placement specifier. The -\caption and \label commands can -be used within staticfigure and statictable as -usual, but remember that if the frame is displayed on multiple -pages, you may end up with multiply defined labels. - -

-The standard figure and table commands will -behave as usual in the flow frames, but their starred versions, -figure* and table* behave no differently -from figure and table1.2. - -

-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 flowfram after hyperref and any -colour package (e.g. color). -

-Top | Index - -

- -

-1.1 Draft Option -

- -

-The flowfram package has the package option draft -which will draw the bounding boxes for -each frame that has been defined. At the bottom right of each -bounding box (except for the bounding box denoting the -typeblock), a marker will be shown in the form: -[T:idn;idl], where T is a single -letter denoting the frame type, idn is the identification number (IDN) for the frame and idl is the identification label (IDL) for that -frame. Values of T are: F (flow frame), -S (static frame) or D (dynamic frame). -Markers of the form: [M:idn] indicate that the -bounding box is the area taken up by the margin for flow frame with IDN idn. Note that even if a frame has been rotated, the bounding box will not be rotated. - -

-If you want to show or hide specific types of bounding -boxes, you can use one of the following commands: - -

- -

-You can see the layout for the current page (irrespective of -whether or not the draft option has been set) using -the command: - -

-\flowframeshowlayout -

- -

-The flowfram package also has the options nocolor -and norotate 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.) -

-Top | Index - -

- -

- -
-1.2 Frame Stacking Order -

- -

-The material on each page is placed in the following order: - -

    -
  1. Each static frame defined for that page in ascending -order of IDN. - -

    -

    2. -
  2. Each flow frame defined for that page in ascending -order of IDN. - -

    -

    3. -
  3. Each dynamic frame defined for that page in ascending -order of IDN. - -

    -

    4. -
  4. Bounding boxes if the draft -package option has been used. -
    5. -
- -

-This ordering can be used to determine if you want something -to overlay or underlay everything else on the page. -Note that the frames 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.1.3 -

-Top | Index - -

- -

-1.3 HTML -

- -

-The flowfram package now comes with a LaTeX2HTML style -file flowfram.perl. However this style file is not meant -to emulate the flowfram package, but is provided to facilitate -creating a plain HTML document from the LaTeX source. All -frame-related information is ignored. By default, the contents -of any static or -dynamic frames are ignored, but this can be changed using -

-\HTMLset{showstaticcontents}{1}
-
-to show the contents of the static frames or -
-\HTMLset{showdynamiccontents}{1}
-
-to show the contents of the dynamic frames (where \HTMLset -is defined in the html 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. -

-Top | Index - -

- -

-2. Defining New Frames -

- -

- -This chapter describes how to define new frames, and how to -identify and set frame contents. See also -Predefined -Layouts. -

- -

-Top | Index - -

- -

-2.1 Flow Frames -

- -

-The flow frame is the principle type of frame. -The text of the 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. To define -a new flow frame use: - -

-\newflowframe[page list]{width}{height}{x}{y}[label] -

-where width is the width of the frame, height is -the height of the frame, (x,y) is the -position of the bottom left hand corner of the frame relative to the bottom left hand corner of the -typeblock2.1. -The first optional argument, page list, indicates the -list of pages for which this frame is defined. - -

-A page list can either be specified by the keywords: -all, odd, even or none, or -by a comma-separated list of either individual page numbers or -page ranges. If page list is -omitted, all is assumed. -A page range can be a closed -range (e.g. 2-8) or an open range (e.g. -<10 or >5). For example: <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 counter2.2, -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). - -

-Each frame has its own unique IDN, -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 IDL to the -frame using the final optional argument label. - -

-You can retrieve the IDL for a given flow frame from its IDN using: - -

-\getflowlabel{idn} -

-Conversely, you can retrieve the IDN for a given flow frame from its IDL using: - -

-\getflowid{cmd}{idl} -

-where cmd is a control sequence which will be used to -store the frame's IDN. -For example: -

-The label for the first flow frame is ``\getflowlabel{1}''.
-The flow frame labelled ``main'' has IDN \getflowid{\myid}{main}\myid.
-
- (See also -Counters.) - -

-Note that \getflowlabel doesn't perform any check to -determine whether the supplied IDN is valid, but -\getflowid will generate an error if the supplied -IDL is undefined. - -

-By default, the flow frame will not have a border, but the -starred form - -

-\newflowframe*[page list]{width}{height}{x}{y}[label] -

-will place a plain border around the flow frame. -(See Modifying frame -attributes if you want a different border.) - -

-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. - -

-In the PDF version of this document, -I used the command -

-\newflowframe{0.6\textwidth}{\textheight}{0pt}{0pt}[main]
-
-to define the main flow frame2.3. -

-Top | Index - -

- -

- -
-2.1.1 Prematurely Ending a Flow Frame -

- -

-You can force text to move immediately to the next defined -flow frame using one of the commands: \newpage, -\pagebreak or \framebreak. -The first two work in an analogous way to the way they -work in standard two column mode. The last one, -\framebreak, 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 \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 \clearpage, -or for two-sided documents, to start on the next odd page -do \cleardoublepage. -

-Top | Index - -

- -

- -
-2.2 Static Frames -

- -

-A static frame is a rectangular area in which text neither -flows into nor flows out of.2.4 -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. - -

-As from version 1.03 it is now possible to have -static frames with non-rectangular contents, see -Non-Rectangular -Frames for further details. - -

-A new static frame is defined using the command: - -

-\newstaticframe[page list]{width}{height}{x}{y}[label] -

-where, as with \newflowframe, width is the width of -the frame, height is the height of the frame, -(x,y) is the position of the bottom left hand -corner of the frame relative to the bottom left hand -corner of the typeblock. The first optional argument, -page list, indicates the page list for which this -static frame should appear, and the final optional argument, -label is a unique textual IDL which you can use to -identify this frame. If no label is specified, you -can refer to this frame by its unique IDN. -The first static frame to be defined has IDN 1, the second -has IDN 2, and so on. - -

-You can retrieve the IDL for a given static frame from its IDN using: - -

-\getstaticlabel{idn} -

-Conversely, you can retrieve the IDN for a given static frame from its IDL using: - -

-\getstaticid{cmd}{idl} -

-where cmd is a control sequence which will be used to -store the frame's IDN. -For example: -

-The label for the first static frame is ``\getstaticlabel{1}''.
-The static frame labelled ``backleft'' has IDN
-\getstaticid{\myid}{backleft}\myid.
-
- -

-Note that \getstaticlabel doesn't perform any check to -determine whether the supplied IDN is valid, but -\getstaticid will generate an error if the supplied -IDL is undefined. - -

-As with \newflowframe, there is a starred version - -

-\newstaticframe*[page list]{width}{height}{x}{y}[label] -

-which will place a border around that static frame. - -

-To set the contents of a particular static frame, you can -either use the staticcontents environment: - -

-\begin{staticcontents}{IDN} -
contents -
\end{staticcontents} -

-where IDN is the unique IDN associated with -that static frame and contents is the contents of the -static frame, or you can use the -command: - -

-\setstaticcontents{IDN}{contents} -

-which will do the same thing. - -

-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: - -

-\begin{staticcontents*}{IDL} -
contents -
\end{staticcontents*} -

-or the equivalent: - -

-\setstaticcontents*{IDL}{contents} -

- -

-In the body of staticcontents or staticcontents*, -or in the second argument of \setstaticcontents -or \setstaticcontents*, you can move onto another -static frame using: - -

-\continueonframe[continuation text]{id} -

-If staticcontents* or \setstaticcontents* are -being used, id refers to the IDL of the next -static frame, otherwise id 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 -

-\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*}
-
-is equivalent to: -
-\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*}
-
-where - -

-\ffcontinuedtextlayout{text} -

-governs how the continuation text should be displayed. The font used -to display the continuation text is given by - -

-\ffcontinuedtextfont{text} -

- -

-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 \continueonframe. For example: -

-\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*}
-
- -

-Top | Index - -

- -

-2.2.1 Important Notes -

- -

- -

- -

-Top | Index - -

- -

- -
-2.3 Dynamic Frames -

- -

-A dynamic frame is similar to a static frame 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.2.5) - -

-As from version 1.03 it is now possible to have -dynamic frames with non-rectangular contents, see -Non-Rectangular -Frames for further details. - -

-To create a new dynamic frame, use the command: - -

-\newdynamicframe[page list]{width}{height}{x}{y}[label] -

-The parameters are exactly the same as for \newflowframe -and \newstaticframe. -Again, each dynamic frame has an associated unique IDN, -starting from 1 for the first dynamic frame to be defined, and -a unique IDL can also be set using the final optional -argument label. - -

-You can retrieve the IDL for a given dynamic frame from its IDN using: - -

-\getdynamiclabel{idn} -

-Conversely, you can retrieve the IDN for a given dynamic frame from its IDL using: - -

-\getdynamicid{cmd}{idl} -

-where cmd is a control sequence which will be used to -store the frame's IDN. - -

-For example: -

-The label for the first dynamic frame is ``\getdynamiclabel{1}''.
-The dynamic frame labelled ``chaphead'' has IDN
-\getdynamicid{\myid}{chaphead}\myid.
-
- -

-Note that \getdynamiclabel doesn't perform any check to -determine whether the supplied IDN is valid, but -\getdynamicid will generate an error if the supplied -IDL is undefined. - -

-As with the other frame types, there is also a starred -version - -

-\newdynamicframe*[page list]{width}{height}{x}{y}[label] -

-which will place a plain border around the dynamic frame. -For example, in the PDF version -of this document I used the command -

-\newdynamicframe{0.38\textwidth}{\textheight}{0.62\textwidth}{0pt}[chaphead]
-
-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 \setdynamicframe -defined in Modifying -Frame Attributes.) - -

-The contents of a dynamic frame are set using the command: - -

-\setdynamiccontents{id}{contents} -

-where id is the unique IDN associated with that -dynamic frame, and contents is the contents of the -dynamic frame. Alternatively, if you have assigned an IDL, -label, to the dynamic frame, you can use the starred -version: - -

-\setdynamiccontents*{label}{contents} -

-As with most LaTeX commands, you can't use verbatim text in -contents. - -

-As from version 1.09, the contents can also be set using the -dynamiccontents environment: - -

-\begin{dynamiccontents}{id} -
contents -
\end{dynamiccontents} -

-or the dynamiccontents* environment: - -

-\begin{dynamiccontents*}{label} -
contents -
\end{dynamiccontents*} -

-Note that you can't use verbatim text within the -dynamiccontents or dynamiccontents* environments. - -

-You can additionally append text to a dynamic frame using -either: - -

-\appenddynamiccontents{id}{contents} -

-or: - -

-\appenddynamiccontents*{label}{contents} -

- -

-If \chapter is defined, you can make the chapter titles -appear in a dynamic frame using the command - -

-\dfchaphead{IDN} -

-where IDN is the IDN of the dynamic frame. There is -also a starred version of this command if you want to -use the IDL instead of the IDN. For example, in -the PDF version of this document, I used the command: -

-\dfchaphead*{chaphead}
-
- -

-The headers and footers can be turned into dynamic frames using the command - -

-\makedfheaderfooter -

-This will create two dynamic frames with IDLs header and footer. The page style will be used as -usual, but you can then move or resize the header and footer using -\setdynamicframe (described later). - -

-In the body of dynamiccontents or dynamiccontents*, -you can move onto another dynamic frame using: - -

-\continueonframe[continuation text]{id} -

-If this command occurs within dynamiccontents*, id -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 -

-\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*}
-
-is equivalent to: -
-\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*}
-
-where - -

-\ffcontinuedtextlayout{text} -

-governs how the continuation text should be displayed. The font used -to display the continuation text is given by - -

-\ffcontinuedtextfont{text} -

- -

-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 \continueonframe. For example: -

-\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*}
-
- -

-Top | Index - -

- -

-2.3.1 Important Notes -

- -

- -

- -

-Top | Index - -

- -

- -
-3. Modifying Frame Attributes -

- -

- -This chapter describes how to modify frame attributes, -such as the size and location. -

- -

-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. - -

-Flow frame attributes are modified using -either the command: - -

-\setflowframe{idn list}{key-val list} -

-or the starred version: - -

-\setflowframe*{label list}{key-val list} -

-or the attributes for all flow frames can be set using: - -

-\setallflowframes{key-val list} -

-Static frame attributes are modified using either the command: - -

-\setstaticframe{idn list}{key-val list} -

-or the starred version: - -

-\setstaticframe*{label list}{key-val list} -

-or the attributes for all static frames can be set using: - -

-\setallstaticframes{key-val list} -

-Dynamic frame attributes are modified using either the command: - -

-\setdynamicframe{idn list}{key-val list} -

-or the starred version: - -

-\setdynamicframe*{label list}{key-val list} -

-or the attributes for all dynamic frames can be set using: - -

-\setalldynamicframes{key-val list} -

- -

-In each of the above, idn list can either be one of the -keywords: all, odd or even (indicating -all frames of that type, frames of that type whose -IDN 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. - -

-For the starred versions, label list should be -a comma-separated list of IDLs. Note that you can't use the -above keywords or have ranges in label list. - -

-The key-val list argument must be a comma-separated -list of key=value pairs, indicating which -attributes to modify. The available values are as follows: - -

-

-
width=length
-
The width of the frame. - -

-

-
height=length
-
The height of the frame. - -

-

-
x=length
-
The x-coordinate of the frame for all pages on which it is defined. - -

-

-
y=length
-
The y-coordinate of the frame for all pages on which it is defined. - -

-

-
evenx=length
-
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. - -

-For example, in the PDF version of -this document, I used the commands -

-\setflowframe*{main}{evenx=0.4\textwidth}
-\setdynamicframe*{chaphead}{evenx=0pt}
-
-to switch the positions of the flow frame and dynamic frame containing the document text and chapter headings, respectively, -on even pages. - -

-You can swap the odd and even values using the commands: - -

-\ffswapoddeven{IDN} -

-(for flow frames) - -

-\sfswapoddeven{IDN} -

-(for static frames) or - -

-\dfswapoddeven{IDN} -

-(for dynamic frames). These -commands all have starred versions which take the frame's -IDL instead of its IDN. - -

-

-
eveny=length
-
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. - -

-

-
oddx=length
-
The x-coordinate of the -frame for all odd pages on which it is defined, if the -document is two-sided. - -

-

-
oddy=length
-
The y-coordinate of the -frame for all odd pages on which it is defined, -if the document is two-sided. - -

-

-
valign=pos
-
Change the vertical alignment -of material inside a static or dynamic frame. The value pos -may be one of: c, t or b. -The default for static frames is c, the default -for dynamic frames is t. -This key is not available for flow frames. - -

-

-
label=text
-
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 Predefined -Layouts. - -

-

-
border=style
-
The style of the border around the -frame, this can take the values: none (no border), -plain (plain border) or the name of a LaTeX -frame making command 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 \fbox, or if you are using the -fancybox package: \doublebox, \ovalbox, -\Ovalbox and \shadowbox.) -The value fbox is equivalent to plain. - -

-For example, to make the first static frame have an oval border: -

-\setstaticframe{1}{border=ovalbox}
-
-Or you can define your own border: -
-\newcommand{\greenyellowbox}[1]{\fcolorbox{green}{yellow}{#1}}
-\setstaticframe{1}{border=greenyellowbox}
-
- -

-This next example uses the tikz package to define a fancy -frame, so you need to use: -

-\usepackage{tikz}
-\usetikzlibrary{snakes}
-
-The border command is defined as follows: -
-\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);
-}}
-
-This makes a bumpy border, but it uses \flowframesep to -determine the gap between the border and the text and uses -\flowframerule to set the line width. This ensures that -the offset (see below) is correctly computed. - -

-This new border can now be applied to a frame: -

-\setstaticframe{1}{border=fancyborder}
-
- -

-

-
offset=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 flowfram -package is able to compute the border for the following -known frame making commands: \fbox, \ovalbox, -\Ovalbox, \doublebox and \shadowbox. -For all other borders, the offset is assumed to be --\flowframesep-\flowframerule. -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. - -

-The above examples can compute their own offsets, however, -if you were to do, for example: -

-\newcommand{\thickgreenyellowbox}[1]{%
-{\setlength{\fboxsep}{5pt}\setlength{\fboxrule}{6pt}%
-\fcolorbox{green}{yellow}{#1}}}
-
-Then you would have to specify the offset. In this example, -the offset is -5pt-6pt=-11pt, -so you would need to do: -
-\setstaticframe{1}{border=thickgreenyellowbox,offset=-11pt}
-
- -

-

-
bordercolor=colour
-
The colour of the border -if you are using a standard frame making command. -The colour can either be specified as, e.g. green, -or including the colour model, e.g. [rgb]{0,1,0}. -For example: -
-\setallflowframes{border=doublebox,bordercolor=[rgb]{1,0,0.5}}
-
- -

-

-
textcolor=colour
-
The text colour for that -frame. Again, the colour can either be specified as, -e.g. green, or including the colour model, -e.g. [rgb]{0,1,0}. - -

-

-
backcolor=colour
-
The background colour for -that frame. Again, the colour can either be specified as, -e.g. green, or including the colour model, -e.g. [rgb]{0,1,0}. 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). - -

-

-
pages=page list
-
The list of -pages for which the frame should appear. This can either have -the values: all, even, odd or 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. -For example: -
-\setdynamicframe{1}{pages=1,5,8-10}
-
- -

-

-
margin=side
-
The side of -the flow frame that its corresponding margin should go on. This -can take the values left, right, -inner or outer. This setting is only available -for flow frames. - -

-

-
clear=boolean
-
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 \setstaticcontents or the -staticcontents environment, or the -\setdynamiccontents, depending on the frame type. -This value is not set by default. This setting is not -available for flow frames. - -

-For example, in the PDF version of this document, I -prevented the chapter heading reappearing on every page using -the command: -

-\setdynamicframe*{chaphead}{clear}
-
- -

-If you want to put \label in a static or dynamic frame, you -should use the clear key to prevent the label from being -multiply defined. - -

-

-
style=cmd
-
This should be -the name of a command without the preceding backslash, -to be applied to the contents of the specified dynamic frame. -The command may either be a declaration, for example: -
-\setalldynamicframes{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: -
-\setalldynamicframes{style=textbf}
-
-which will make the text for all the dynamic frames come out in -bold. To unset a style, do style=none. -This setting is only available for dynamic frames. - -

-

-
angle=n
-
Rotate the contents of the -frame by n degrees (new to -version 1.02). Note that the bounding boxes will not -appear rotated. - -

-

-
shape=shape command
-
Define a shape for -the contents of a static frame or dynamic frame (new -to version 1.03). If shape command is \relax, no -paragraph shape will be applied. See -Non-Rectangular -Frames for further details. -
-
- -

-Top | Index - -

- -

- -
-3.1 Non-Rectangular Frames -

- -

-As from version 1.03, it is now possible to specify -non-rectangular static or -dynamic frames (but not flow frames). Note -that the -bounding box will still appear as a rectangle despite the -frame's shape setting. You may use either TeX's -\parshape command, or the \shapepar -command defined in Donald Arseneau's shapepar -package (if using \shapepar, remember to include -the shapepar package.) - -

-Note that it is better to use \parshape instead -of \shapepar as the latter is more restrictive and -requires more processing. However, \shapepar provides -greater flexibility in the type of shape that can be used. -

-
\parshape
-
With \parshape 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 key for static or dynamic frames, the effects of -\par and the sectioning commands are modified to allow -the paragraph shape to extend beyond a single paragraph, and -to allow sectioning commands (but not \chapter -or \part). - -

-

-
\shapepar
-
With \shapepar 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 \simpar, 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 shapepar documentation for -more details. -
-
- -

-To restore a frame to its default rectangular setting use -shape=\relax. - -

-For those unfamiliar with TeX's \parshape command, -the syntax is as follows: -
-
\parshape=n i1 l1 -i2 l2 ... -in ln -
-
-where n is the number of (ij lj) pairs and -ij specifies the left -indentation for the jth line and -lj specifies the length of -the jth line. - -

-For example, to create a -zigzag shaped static frame (whose IDN is shapedt): - -

-\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
-}}
-
- -

- -

-The syntax for \shapepar is more complicated, see -the shapepar documentation for more details. In general: -
-
\shapepar{shape specs} -
-
-The shapepar package has four predefined shapes: -\squareshape, \diamondshape, -\heartshape and \nutshape. - -

-For example, to assign -a heart shape to the static frame whose IDL is shapedb: -

-\setstaticframe*{shapedb}{shape={\shapepar\heartshape}}
-
-To reset the frame back to its original rectangular shape -do: -
-\setstaticframe*{shapedb}{shape=\relax}
-
- -

- - -

-The 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. -

-Top | Index - -

- -

-4. Locations and Dimensions -

- -

- -This chapter describes some of the commands provided to -determine the locations and dimensions of frames. -

- -

-This chapter describes some of the commands available that can -be used to determine the locations and dimensions of frames. -See the accompanying document flowfram.pdf for more details of -these commands or for other commands not listed here. -

-Top | Index - -

- -

- -
-4.1 Determining the Location of the Typeblock -

- -

-As mentioned earlier, when you create new frames, -you must specify their location relative to the typeblock, but -what if you want to position a frame a set distance from the -edge of the paper? The flowfram package provides the following -commands that compute the distance from the typeblock to the -paper boundary: - -

- -

-\computeleftedgeodd{length} -

-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 -length. - -

- -

-\computeleftedgeeven{length} -

-As above, but for even pages. - -

- -

-\computetopedge{length} -

-This computes the top edge of the page, relative to the bottom of the -typeblock, and stores the result in length. - -

- -

-\computebottomedge{length} -

-This computes the bottom edge of the page, relative to the bottom of the -typeblock, and stores the result in length. - -

- -

-\computerightedgeodd{length} -

-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 length. - -

- -

-\computerightedgeeven{length} -

-As above, but for even pages. - -

-Note that in all cases length must be a LaTeX length -command. - -

-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): -

-% 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}
-
- -

-Top | Index - -

- -

-4.2 Determining the Dimensions and Locations of Frames -

- -

-It is possible to determine the dimensions and locations -of a frame using one of the following commands: - -

- -

- -

-For each command, the starred version takes an IDL as the -argument, and the unstarred version takes an IDN as the -argument. Each command stores the relevant information in the -lengths \ffareawidth, \ffareaheight, -\ffareax and \ffareay. - -

-For other related commands, see the section "Determining Dimensions -and Locations" in the accompanying document -flowfram.pdf. -

-Top | Index - -

- -

-4.3 Relative Locations -

- -

-To print the relative location of one frame from another do: - -

-\relativeframelocation{type1}{idn1}{type2}{idn2} -

-where type1 and idn1 indicate the type and IDN of -the first frame, and type2 and idn2 indicate the type -and IDN of the second frame. There is also a starred version: - -

-\relativeframelocation*{type1}{idl1}{type2}{idll} -

-where idl1 and idl2 indicate the IDL of the -first and second frames, respectively. Both the above commands will -print one of the following: - -

- -

- -

-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. - -

-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. - -

-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. - -

-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. - -

-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 -\relativeframelocation may use the wrong page settings if it -is used at the start of the page. - -

-For example, the PDF version of this document defined a -flow frame labelled main and a -dynamic frame labelled chaphead which is -used to display the chapter headings. The following code -

-The dynamic frame is 
-\relativeframelocation*{dynamic}{chaphead}{flow}{main}
-of the flow frame.
-
-produces: -The dynamic frame is -on -the left of the flow frame. - -

-There are some short cut commands for frames of the -same type: - -

-\reldynamicloc{idn1}{idn2} -

-This is equivalent to: -
-
\relativeframelocation{dynamic}{idn1}{dynamic}{idn2} - -

-\relstaticloc{idn1}{idn2} -

-This is equivalent to: -
-
\relativeframelocation{static}{idn1}{static}{idn2} - -

-\relflowloc{idn1}{idn2} -

-This is equivalent to: -
-
\relativeframelocation{flow}{idn1}{flow}{idn2} -
-
-Each of the above commands also has a starred version that uses the -IDL instead of the IDN. - -

-These commands may be used in the optional argument of -\continueonframe for frames that are on the same page. -For example: -

-\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}
-
- -

-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 -flowfram.pdf. -

-Top | Index - -

- -

- -
-5. Predefined Layouts -

- -

- -This chapter describes commands that create frames -arranged in a predefined layout. -

- -

-The flowfram package has a number of commands which -create frames in a predefined layout. These commands -may only be used in the preamble. -

-Top | Index - -

- -

-5.1 Column Styles -

- -

-The standard LaTeX commands \onecolumn and -\twocolumn are redefined to create one or two -flow frames that fill the entire typeblock separated -from each other (in the case of \twocolumn) by a -gap of width \columnsep. 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 \baselineskip. You can switch off this -automatic adjustment using the command: - -

-\ffvadjustfalse -

- -

-The \onecolumn and \twocolumn commands -also take an optional argument which is the page list for which those flow frames are defined. In addition -to \onecolumn and \twocolumn, the -following commands are also defined: - -

- -

-\Ncolumn[pages]{n} -

-This creates n column flow frames each separated by a -distance of \columnsep. - -

- -

-\onecolumninarea[pages]{width}{height}{x}{y} -

-This creates a single flow frame to fill the given area, -adjusting the height so that it is an integer multiple of -\baselineskip. - -

- -

-\twocolumninarea[pages]{width}{height}{x}{y} -

-This creates two column flow frames separated by a distance -of \columnsep filling the entire area specified, again -adjusting the height so that it is an integer multiple of -\baselineskip. The columns are separated by a gap of -\columnsep. - -

- -

-\Ncolumninarea[pages]{n}{width}{height}{x}{y} -

-This is a more general form of \twocolumninarea making -n flow frames instead of two. -

-Top | Index - -

- -

-5.2 Column Styles with an Additional Frame -

- -

-As well as the column-style flow frames defined -above, it is also possible to define -n columns with an additional frame spanning either -above or below them. There will be a vertical gap of -approximately5.1 -\vcolumnsep between the columns -and the extra frame. In each of the following definitions, -the argument pages is the page list for which -the frames are defined, n is the number of -columns required, type is the type of frame to go -above or below the columns (this may be one of: flow, -static or dynamic). The area in which the -new frames should fill is defined by width, height -(the width and height of the area) and x, y -(the position of the bottom left hand corner of the area -relative to the bottom left hand corner of the typeblock.) - -

-The height of the additional frame at the top or bottom of -the columns is given by H. - -

- -

-\onecolumntopinarea[pages]{type}{H}{width}{height}{x}{y} -

-This creates one flow frame with a type frame above it, filling -the area specified. - -

- -

-\twocolumntopinarea[pages]{type}{H}{width}{height}{x}{y} -

-This creates two column-style flow frames with a type frame -above them, filling the area specified. - -

- -

-\Ncolumntopinarea[pages]{type}{n}{H}{width}{height}{x}{y} -

-This creates n column-style flow frames with a type -frame above them, filling the area specified. - -

- -

-\onecolumnbottominarea[pages]{type}{H}{width}{height}{x}{y} -

-This creates one flow frame with a type frame underneath it, -filling the area specified. - -

- -

-\twocolumnbottominarea[pages]{type}{H}{width}{height}{x}{y} -

-This creates two column-style flow frames with a type frame -below them, filling the area specified. - -

- -

-\Ncolumnbottominarea[pages]{type}{n}{H}{width}{height}{x}{y} -

-This creates n column-style flow frames with a type -frame below them, filling the area specified. - -

-The following commands are special cases of the above: - -

- -

-\onecolumnStopinarea[pages]{H}{width}{height}{x}{y} -

-This is equivalent to: -
-\onecolumntopinarea[pages]{static}{H}{width}{height}{x}{y} - -

- -

-\onecolumnDtopinarea[pages]{H}{width}{height}{x}{y} -

-This is equivalent to: -
-\onecolumntopinarea[pages]{dynamic}{H}{width}{height}{x}{y} - -

- -

-\onecolumntop[pages]{type}{H} -

-As \onecolumntopinarea where the area is the entire -typeblock. - -

- -

-\onecolumnStop[pages]{H} -

-This is equivalent to: -\onecolumntop[pages]{static}{H} - -

- -

-\onecolumnDtop[pages]{H} -

-This is equivalent to: -\onecolumntop[pages]{dynamic}{H} - -

- -

-\twocolumnStopinarea[pages]{H}{width}{height}{x}{y} -

-This is equivalent to: -
-\twocolumntopinarea[pages]{static}{H}{width}{height}{x}{y} - -

- -

-\twocolumnDtopinarea[pages]{H}{width}{height}{x}{y} -

-This is equivalent to: -
-\twocolumntopinarea[pages]{dynamic}{H}{width}{height}{x}{y} - -

- -

-\twocolumntop[pages]{type}{H} -

-As \twocolumntopinarea where the area is the entire -typeblock. - -

- -

-\twocolumnStop[pages]{H} -

-This is equivalent to: -\twocolumntop[pages]{static}{H} - -

- -

-\twocolumnDtop[pages]{H} -

-This is equivalent to: -\twocolumntop[pages]{dynamic}{H} - -

- -

-\NcolumnStopinarea[pages]{n}{H}{width}{height}{x}{y} -

-This is equivalent to: -
-\Ncolumntopinarea[pages]{static}{n}{H}{width}{height}{x}{y} - -

- -

-\NcolumnDtopinarea[pages]{n}{H}{width}{height}{x}{y} -

-This is equivalent to: -
-\Ncolumntopinarea[pages]{dynamic}{n}{H}{width}{height}{x}{y} - -

- -

-\Ncolumntop[pages]{type}{n}{H} -

-As \Ncolumntopinarea where the area is the entire -typeblock. - -

- -

-\NcolumnStop[pages]{n}{H} -

-This is equivalent to: -\Ncolumntop[pages]{static}{n}{H} - -

- -

-\NcolumnDtop[pages]{n}{H} -

-This is equivalent to: -\Ncolumntop[pages]{dynamic}{n}{H} - -

- -

-\onecolumnSbottominarea[pages]{H}{width}{height}{x}{y} -

-This is equivalent to: -
-\onecolumnbottominarea[pages]{static}{H}{width}{height}{x}{y} - -

- -

-\onecolumnDbottominarea[pages]{H}{width}{height}{x}{y} -

-This is equivalent to: -
-\onecolumnbottominarea[pages]{dynamic}{H}{width}{height}{x}{y} - -

- -

-\onecolumnbottom[pages]{type}{H} -

-As \onecolumnbottominarea where the area is the entire -typeblock. - -

- -

-\onecolumnSbottom[pages]{H} -

-This is equivalent to: -\onecolumnbottom[pages]{static}{H} - -

- -

-\onecolumnDbottom[pages]{H} -

-This is equivalent to: -\onecolumnbottom[pages]{dynamic}{H} - -

- -

-\twocolumnSbottominarea[pages]{H}{width}{height}{x}{y} -

-This is equivalent to: -
-\twocolumnbottominarea[pages]{static}{H}{width}{height}{x}{y} - -

- -

-\twocolumnDbottominarea[pages]{H}{width}{height}{x}{y} -

-This is equivalent to: -
-\twocolumnbottominarea[pages]{dynamic}{H}{width}{height}{x}{y} - -

- -

-\twocolumnbottom[pages]{type}{H} -

-As \twocolumnbottominarea where the area is the entire -typeblock. - -

- -

-\twocolumnSbottom[pages]{H} -

-This is equivalent to: -\twocolumnbottom[pages]{static}{H} - -

- -

-\twocolumnDbottom[pages]{H} -

-This is equivalent to: -\twocolumnbottom[pages]{dynamic}{H} - -

- -

-\NcolumnSbottominarea[pages]{n}{H}{width}{height}{x}{y} -

-This is equivalent to: -
-\Ncolumnbottominarea[pages]{static}{n}{H}{width}{height}{x}{y} - -

- -

-\NcolumnDbottominarea[pages]{n}{H}{width}{height}{x}{y} -

-This is equivalent to: -
-\Ncolumnbottominarea[pages]{dynamic}{n}{H}{width}{height}{x}{y} - -

- -

-\Ncolumnbottom[pages]{type}{n}{H} -

-As \Ncolumnbottominarea where the area is the entire -typeblock. - -

- -

-\NcolumnSbottom[pages]{n}{H} -

-This is equivalent to: -\Ncolumnbottom[pages]{static}{n}{H} - -

- -

-\NcolumnDbottom[pages]{n}{H} -

-This is equivalent to: -\Ncolumnbottom[pages]{dynamic}{n}{H} - -

-Top | Index - -

- -

-5.3 Right to Left Columns -

- -

-The default behaviour for the commands defined above is -to create the flow frames from left to right. However if you are -typesetting from right to left, you will probably prefer to -define the flow frames in the reverse order. This can be done -via the package option RL. Alternatively you can use the -command: - -

-\lefttorightcolumnsfalse -

-before using commands such as \twocolumn or -\Ncolumn. Two switch back to left-to-right columns use: - -

-\lefttorightcolumnstrue -

- -

- -

-5.4 Backdrop Effects -

- -

-Static frames 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, pages is the page list for -which those static frames are defined (all is the default). -For the vertical strips: -xoffset is the amount by which the frames should be -shifted horizontally (0pt by default), W1 is the width of the first frame, -with colour specified by C1 and IDL L1, -and so on up to Wn the width of the nth frame -with colour specified by Cn and IDL Ln. -For the vertical strips: -yoffset is the amount by which the frames should be -shifted vertically (0pt by default), H1 is the height of the first frame, -with colour specified by C1 and IDL L1, -and so on up to Hn the height of the nth frame -with colour specified by Cn and IDL Ln. - -

-NOTE: unlike the earlier commands, these commands -are all relative to the actual page, not the typeblock. -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. - -

-The colour specification must be completely enclosed in braces, -for example {[rgb]{1,0,1}} not [rgb]{1,0,1}. -

-Top | Index - -

- -

-5.4.1 Vertical stripe effects -

- -

- -

-\vtwotone[pages][xoffset]{W1}{C1}{L1}{W2}{C2}{L2} -

-Defines two static frames 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.) - -

- -

-\vNtone[pages][xoffset]{n}{W1}{C1}{L1}...{Wn}{Cn}{Ln} -

-This is similar to \vtwotone but with n static frames instead of two. - -

- -

-\vtwotonebottom[pages][xoffset]{H}{W1}{C1}{L1}{W2}{C2}{L2} -

-This is similar to \vtwotone but the static frames are only -H high, instead of the entire height of the page. -The frames are aligned along the bottom edge of the page. - -

- -

-\vtwotonetop[pages][xoffset]{H}{W1}{C1}{L1}{W2}{C2} -
{L2} -

-This is similar to \vtwotone but the static frames are only -H 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 \vtwotonetop -commands were used, one for the even pages, and the other -for the odd pages.) - -

- -

-\vNtonebottom[pages][xoffset]{H}{n}{W1}{C1}{L1}... -{Wn}{Cn}{Ln} -

-This is a general version of \vtwotonebottom for -n frames instead of two. - -

- -

-\vNtonetop[pages][xoffset]{H}{n}{W1}{C1}{L1}... -{Wn}{Cn}{Ln} -

-This is a general version of \vtwotonetop for -n frames instead of two. -

-Top | Index - -

- -

-5.4.2 Horizontal stripe effect -

- -

- -

-\htwotone[pages][yoffset]{H1}{C1}{L1}{H2}{C2}{L2} -

-This defines two static frames to create a two tone horizontal strip -effect. - -

- -

-\hNtone[pages][yoffset]{n}{H1}{C1}{L1}... -{Hn}{Cn}{Ln} -

-This is similar to \htwotone but with n static frames instead of two. - -

- -

-\htwotoneleft[pages][yoffset]{W}{H1}{C1}{L1}{H2}{C2}{L2} -

-This is similar to \htwotone but the static frames are only -W wide, instead of the entire width of the page. -The frames are aligned along the left edge of the page. - -

- -

-\htwotoneright[pages][yoffset]{W}{H1}{C1}{L1}{H2}{C2}{L2} -

-This is similar to \htwotone but the static frames are only -W wide, instead of the entire width of the page. -The frames are aligned along the right edge of the page. - -

- -

-\hNtoneleft[pages][yoffset]{W}{n}{H1}{C1}{L1}... -{Hn}{Cn}{Ln} -

-This is a general version of \htwotoneleft for -n frames instead of two. - -

- -

-\hNtoneright[pages][yoffset]{W}{n}{H1}{C1}{L1}... -{Hn}{Cn}{Ln} -

-This is a general version of \htwotoneright for -n frames instead of two. -

-Top | Index - -

- -

-5.4.3 Background Frame -

- -

-To make a single static frame covering the entire page, use: - -

-\makebackgroundframe[pages][IDL] -

-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. -

-Top | Index - -

- -

- -
-5.4.4 Vertical and Horizontal Rules -

- -

-You can create vertical or horizontal rules between two -frames using the commands: - -

- -

-\insertvrule[y top][y bottom]{T1}{IDN1}{T2}{IDN2} -

-This creates a new static frame which fits between T1 -frame with IDN IDN1 and T2 frame with IDN IDN2, 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 y top (default 0pt) extends the rule by that -much above the highest point, and the second optional argument -y bottom (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 - -

-\ffcolumnseprule -

-Note that this has changed as from version 1.09: versions -prior to 1.09 used \columnseprule. - -

-The vertical rule drawn by \insertvrule is created using -the command: - -

-\ffvrule{offset}{width}{height} -

-This can be redefined if a more ornate rule is required -(see below). - -

- -

-\inserthrule[x left][x right]{T1}{IDN1}{T2}{IDN2} -

-This creates a new static frame which fits between T1 -frame with IDN IDN1 and T2 frame with IDN IDN2, 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 x left (default 0pt) extends the rule by that -much before the leftmost point, and the second optional argument -x right (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 - -

-\ffcolumnseprule -

- -

-The horizontal rule drawn by \inserthrule is created using -the command: - -

-\ffhrule{offset}{width}{height} -

-This can be redefined if a more ornate rule is required (see below). - -

-The default value for \ffcolumnseprule is 2pt. Both -\insertvrule and \inserthrule have starred versions -which allow you to identify the frame by IDL instead of -IDN. The frame types, T1 and T2 can be one -of the following keywords: flow, static or -dynamic. - -

-The command - -

-\ffruledeclarations -

-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: -

-\twocolumnStop{2in}
-
-\renewcommand{\ffruledeclarations}{\color{red}}
-\insertvrule{flow}{1}{flow}{2}
-
-\renewcommand{\ffruledeclarations}{\color{blue}}
-\inserthrule{static}{1}{flow}{1}
-
-This will create a layout with two columns (flow frames 1 and 2) -with a static frame 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.) - -

-In the following example, the rules have been redefined -to use a zigzag pattern (which is obtained using the tikz -package): -

-\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}
-
- -

-Top | Index - -

- -

-6. Thumbtabs and Minitocs -

- -

- -This chapter describes how to create thumbtabs and minitocs, -such as those used in the PDF version of this document. -

- -

- -

-6.1 Thumbtabs -

- -

-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: ttbtitle (show -title--default), ttbnotitle (don't show the title), -ttbnum (show the number) and ttbnonum -(don't show the number--default). - -

-If you want thumbtabs in your document, you need to use -the command - -

-\makethumbtabs[y offset]{height}[section type] -

-in the document -preamble. By default, the topmost thumbtab is level with the -top of the typeblock, but can be shifted vertically -using the first optional argument y offset. Each -thumbtab will be height high, and will correspond to the -sectioning type section type. If section type -is omitted, chapters will be used if the \chapter -command is defined, otherwise sections will be used. -The width of the thumbtabs is given by the length - -

-\thumbtabwidth -

-which is 1cm by default. -The command - -

-\thumbtabindex -

-will display the thumbtab index (all thumbtabs) on the current page. -You then need to use - -

-\enablethumbtabs -

-to start the individual thumbtabs and - -

-\disablethumbtabs -

-to make them go away. -You can align the table of contents with the thumbtabs6.1 using -the command - -

-\tocandthumbtabindex -

-instead of -the commands \tableofcontents and -\thumbtabindex. If you are using the hyperref -package, the text on the thumbtab index will be a hyperlink -to the corresponding part of the document. Note that when using -\tocandthumbtabindex you may -need to shift the thumbtabs vertically up or down to make -sure that they align correctly with the table of contents. - -

-The format of the text on the thumbtabs is given by the command - -

-\thumbtabindexformat -

-for the thumbtab index entries, and - -

-\thumbtabformat -

-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 -norotate 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. - -

-The thumbtab attributes can be changed using - -

-\setthumbtab{n}{key value list} -

-where n is the thumbtab number starting -from 1 (for the top thumbtab) to the value given by the counter -maxthumbtabs -(for the bottom thumbtab). Note that these numbers are not -related to the associated frame IDN. You may also use -the keyword all instead of n to indicate that the -new attributes should apply to all thumbtabs. - -

-To just change the settings for the thumbtab index, use - -

-\setthumbtabindex{n}{key value list} -

-The key value list for both these commands is the same as that -for \setdynamicframe. Again n may either be the -thumbtab index or the keyword all. - -

-By default, the thumbtabs have a grey background. In the PDF -version of this document, I used: -

-\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}}
-
-to change the thumbtab background colour to shades of blue. - -

-I also changed the style of the thumbtab text using: -

-\newcommand{\thumbtabstyle}[1]{{\hypersetup{linkcolor=white}%
-\textbf{\large\sffamily #1}}}
-\setthumbtab{all}{style=thumbtabstyle,textcolor=white}
-
-Note that the style uses \hypersetup6.2 to change the colour of the hyperlink text, -since the hyperlink overrides the text colour. -

-Top | Index - -

- -

-6.2 Minitocs -

- -

-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 - -

-\enableminitoc[section type] -

-The default section type is the same as that used by -the thumbtabs. - -

-If you want the minitocs to appear in a dynamic frame, you -can use - -

-\appenddfminitoc{IDN} -

-where IDN is the IDN of the appropriate dynamic frame. -There is also a starred version available if you want to -use the IDL instead of the IDN. - -

-For example, in the PDF version of this document I -used the command: -

-\appenddfminitoc*{chaphead}
-
-in the preamble, which appended the minitocs to the -dynamic frame with IDL chaphead. - -

-The style of the minitoc text is given by the command - -

-\minitocstyle{contents} -

-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 - -

-\beforeminitocskip -

-and the gap after the minitoc is given by the length - -

-\afterminitocskip -

-These lengths may be changed using \setlength. -

-Top | Index - -

- -

-7. Global Settings -

- -

- -This section describes style macros, lengths and counters used -by the flowfram package. -

- -

- -

-7.1 Macros -

-The following macros can be changed using \renewcommand: - -

- -

- -

-Top | Index - -

- -

-7.2 Lengths -

-The following are lengths, which can be changed using -\setlength: - -

- -

- -

-Top | Index - -

- -

- -
-7.3 Counters -

-The following are counters that can be accessed via -\value{counter name} or via -\thecounter name. However the value of these counters -should not be modified. - -

-

-
maxflow
-
The total number of flow frames that have -been defined so far. - -

-

-
thisframe
-
Stores the IDN of the current -flow frame. You can label and reference the IDN using - -

-\labelflowid{label} -

-This is analogous to the standard \label command, but will -always refer to the IDN of the current flow frame. It can -then be referenced using \ref{label}. Note that -this will always refer to the current flow frame even when used -in the contents of a static or -dynamic frame. - -

-Don't use more than one instance of \labelflowid in a given -flow frame for a given page or you will get a "multiply defined -references" warning. - -

-

-
displayedframe
-
Stores the index of the currently -displayed flow frame. This will be the same as the IDN 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 - -

-\labelflow{label} -

-and reference it elsewhere in the document using -\ref{label}. For example, if you are using -a column layout, you might want to do something like: -

-This text is about hippos\labelflow{hippos}.
-
-% Somewhere else in the document
-See column~\ref{hippos} on page~\pageref{hippos}
-for information on hippos.
-
-Don't use more than one instance of \labelflow in a given -flow frame for a given page or you will get a "multiply defined -references" warning. Note that -\labelflow will always refer to the current flow frame even when used in the contents of a static or dynamic frame. - -

-

-
maxstatic
-
The total number of static frames that have -been defined so far. - -

-

-
maxdynamic
-
The total number of dynamic frames that -have been defined so far. - -

-

-
maxthumbtabs
-
The total number of thumbtabs. -
-
- -

-Top | Index - -

- -

-8. Troubleshooting -

- -

- -This chapter should be consulted if you experience any -problems using the flowfram package. -

- -

-For an up-to-date list of frequently asked questions, see -the flowfram FAQ. -If you have a query that is not addressed here, please try there -before contacting me. -

-Top | Index - -

- -

-8.1 General Queries -

- -

- -

    -
  1. If all my flow frames are only defined on, say, -pages 1-10, what happens if I then add some extra text so that -the document exceeds 10 pages? - -

    -The output routine will create a new flow frame the size -of the typeblock and use that. - -

    -

    2. -
  2. Can I use the formatted page number in page lists? - -

    -No. - -

    -

    3. -
  3. Why not? - -

    -When the output routine finishes with one flow frame it looks for the -next flow frame defined on that page. If there are none left, it then -searches through the page list of all the defined flow frames 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: - -

    - -

      -
    1. 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 -flow frame defined on page 15, not on page A. - -

      -

      2. -
    2. 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. -
      3. -
    - -

    -

    4. -
  4. Can I have an arbitrarily shaped frame? - -

    -You can assign certain irregular shapes to static or -dynamic frames, -using the shape key (see -Non-Rectangular -Frames). -Note that the bounding box will still appear as a rectangle with -the dimensions of the given frame which may not correspond -to the assigned shape. -This function is not available for flow frames. - -

    -

    5. -
  5. Why has the text from my flow frame appeared in a -static frame or dynamic frame? - -

    -Assuming you haven't inadvertently set that text as the contents -of the static or -dynamic frame, the frames are most likely -overlapping (see Frame -Stacking Order). -In an attempt to clarify what's going on, suppose you have -defined a static frame, a dynamic frame and two flow frames. The -following is an approximate8.1 analogy: TeX has a sheet of -paper on the table, and has pencilled8.2 in a -rectangle denoting the typeblock. 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 static frame, the next two (which I shall call -sheets 2 and 3) represent the flow frames, and the last one -(which I shall call sheet 4) represents the dynamic frame. -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 static frame, -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 -dynamic frame, 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 flow frame 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 typeblock. 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.) - -

    -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 -flow frame into a neighbouring frame. Check the log file for -warnings or use the draft option to the document class -which will place a filled rectangle on the end of overfull lines. - -

    -

    6. -
  6. Why do I get lots of overfull hbox messages? - -

    -Probably because you have narrow frames. It's better to use -ragged right formatting when the frames are narrow. - -

    -

    7. -
  7. Why do I keep getting multiply-defined warnings? - -

    -Probably because you have used \label in a static or -dynamic frame that is displayed on more than one page. Try using the clear -key to ensure that the frame is always cleared at the end of each -page. - -

    -

    8. -
  8. What happens if I use a command or environment -that switches to two-column mode (e.g. theindex)? - -

    -As from version 1.01, any \onecolumn or -\twocolumn 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, ffuserguide.tex, for an example. - -

    -

    9. -
  9. How do I change the vertical alignment -of material inside a static or -dynamic frame? - -

    -Use the valign key in \setstaticframe or -\setdynamicframe (new to version 1.03). - -

    -

    10. -
  10. How do I compute the distance from the edge -of the page instead of the typeblock? - -

    -See Determining the -Location of the Typeblock. - -

    -

    11. -
  11. Is there a GUI I can use to make it easier to create the -frames? - -

    -Yes, Jpgfdraw which can be downloaded from: -http://theoval.cmp.uea.ac.uk/~nlct/jpgfdraw/ -

    12. -
- -

-Top | Index - -

- -

-8.2 Unexpected Output -

- -

- -

    -
  1. The lines at the beginning of my flow frames are the -wrong width. - -

    -This is a problem that will occur if you have flow frames with different widths, as the change in \hsize -does not come into effect until a paragraph break. So if -you have a paragraph that spans two flow frames, the end -of the paragraph at the beginning of the second flow frame will retain the width it had at the start of the -paragraph at the bottom of the previous flow frame. You can -fix the problem by inserting \framebreak at the -point where the frame break occurs -(see Prematurely Ending a -Flow Frame). - -

    -

    2. -
  2. My frames shift to the right when I add a border. - -

    -This may occur if you use a border that is not recognised -by the flowfram package. You will need to set the -offset using the offset key (see -Modifying Frame -Attributes). - -

    -

    3. -
  3. I have a vertical white strip along the right hand side -of every page. - -

    -This can happen if you have, say, an A4 document, and -ghostscript has letter as the default paper size. You can -change the default paper size by editing the file gs_init.ps. -Change: -

    -% Optionally choose a default paper size other than U.S. letter.
-% (a4)
-
    -to: -
    -% Optionally choose a default paper size other than U.S. letter.
-(a4)
-
    - -

    -

    4. -
  4. I don't have any output. - -

    -All your flow frames 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 -static frames or dynamic frames filled in, and nothing -outside of them, just do \mbox{}\clearpage. -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. - -

    -

    5. -
  5. The last page hasn't appeared. - -

    -See the previous answer. - -

    -

    6. -
  6. There is no paragraph indentation inside my -static or -dynamic frames. - -

    -The paragraph indentation in static or -dynamic frames is governed -by the length \sdfparindent which is set to 0pt by -default. To make the indentation the same as that used by -flow frames place the following in the preamble: -

    -\setlength{\sdfparindent}{\parindent}
-
    - -

    -

    7. -
  7. My section numbering is in the wrong order. - -

    -Remember that the contents of the dynamic frames are not set -until the page is shipped out, and the contents will be set -in the order of IDN, 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. - -

    -

    8. -
  8. The contents of my static or -dynamic frame have shifted -to the left when I used \parshape. - -

    -This will happen if your \parshape specification -exceeds the linewidth. For example: -

    -\parshape=1 0.4\linewidth 0.7\linewidth
-
    -This specifies a line with overall length -1.1\linewidth which is too long. - -

    -

    9. -
- -

-Top | Index - -

- -

-8.3 Error Messages -

- -

- -

    -
  1. Illegal unit of measure (pt inserted) - -

    -All lengths must have units. Remember to include the -units when defining new frames. The following -keys require lengths: width, height, -x, y and offset8.3. - -

    -

    2. -
  2. Missing number, treated as zero - -

    -LaTeX is expecting a number. There are a number of -possible causes: - -

    - -

      -
    1. You have used an IDL instead of an IDN. If you -want to refer to a frame by its label, you need to remember -to use the starred versions of the -\settypeframe commands, or when setting -the contents of static frames or dynamic frames. - -

      -

      2. -
    2. When specifying page lists, you have mixed keywords -with page ranges. For example: 1,even is invalid. -
      3. -
    - -

    -

    3. -
  3. Flow frame IDL 'label' already defined - -

    -All IDLs within each frame type must be -unique. There are similar error messages for duplicate -IDLs for static frames and dynamic frames. - -

    -

    4. -
  4. Can't find flow frame id - -

    -You have specified a non-existent flow frame IDL. There are -similar error messages for static frames and dynamic frames. -Check to make sure you have spelt the label correctly, and -check you are using the correct frame type command. -(For example, if a static frame has the IDL mylabel, -and you attempt to do -\setflowframe*{mylabel}{options}, -then you will get this error, because mylabel refers -to a static frame not a flow frame.) - -

    -

    5. -
  5. Key 'clear' is boolean - -

    -The clear key can only have the values true -or false. - -

    -

    6. -
  6. Key 'clear' not available - -

    -The clear key is only available for static or -dynamic frames. - -

    -

    7. -
  7. Key 'style' not available - -

    -The style key is only available for dynamic frames. - -

    -

    8. -
  8. Key 'margin' not available - -

    -The margin key is only available for flow frames. - -

    -

    9. -
  9. Key 'shape' not available - -

    -The shape key is only available for static or -dynamic frames. - -

    -

    10. -
  10. Dynamic frame style 'style' not defined - -

    -The specified style style 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. - -

    -

    11. -
  11. Argument of \fbox has an extra } - -

    -This error will occur if you do, say, border=\fbox -instead of border=fbox. Remember not to include -the initial backslash. - -

    -

    12. -
  12. Not in outer par mode - -

    -You can not have floats (such as figures, tables or marginal -notes) in static or -dynamic frames. If you want -a figure or table within a static or -dynamic frame -use staticfigure or statictable. - -

    -

    13. -
  13. Somethings wrong---maybe missing \item - -

    -Assuming that all your list type of environments start -with \item, 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. - -

    -

    14. -
  14. No room for a new \skip - -

    -You have exceeded TeX's 256 register limit. Use the etex -package. - -

    -

    15. -
  15. \verb illegal in command argument - -

    -As a general rule, you can't use verbatim text in a command -argument. -This rule applies to all the commands defined by the flowfram -package. See also below. - -

    -

    16. -
  16. I get \verb illegal in command argument when using -verbatim text inside the dynamiccontents environment. - -

    -You can not use verbatim text inside either the starred or -unstarred version of the dynamiccontents environment. -(See earlier.) - -

    -Top | Index - -

    -

    17. -
- -

-
- -

-Glossary -

-
-
bounding box
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. 1.1 Draft Option -, 1.2 Frame Stacking Order -, 3. Modifying Frame Attributes -, 3. Modifying Frame Attributes -, 3.1 Non-Rectangular Frames -, 7.1 Macros -, 7.1 Macros -, 7.1 Macros -, 7.2 Lengths -, 7.2 Lengths -, 8.1 General Queries -
dynamic frame
Frames -in which text is fixed in place, but the contents are re-typeset -each time the frame is displayed. 1. Introduction -, 1.1 Draft Option -, 1.2 Frame Stacking Order -, 1.3 HTML -, 2.3 Dynamic Frames -, 2.3.1 Important Notes -, 3. Modifying Frame Attributes -, 3.1 Non-Rectangular Frames -, 4.3 Relative Locations -, 6.2 Minitocs -, 7.2 Lengths -, 7.3 Counters -, 7.3 Counters -, 8.1 General Queries -, 8.1 General Queries -, 8.1 General Queries -, 8.1 General Queries -, 8.1 General Queries -, 8.1 General Queries -, 8.1 General Queries -, 8.1 General Queries -, 8.2 Unexpected Output -, 8.2 Unexpected Output -, 8.2 Unexpected Output -, 8.2 Unexpected Output -, 8.2 Unexpected Output -, 8.3 Error Messages -, 8.3 Error Messages -, 8.3 Error Messages -, 8.3 Error Messages -, 8.3 Error Messages -, 8.3 Error Messages -, 8.3 Error Messages -, 8.3 Error Messages -
flow frame
The frames in a document such that the contents of the -document 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. 1. Introduction -, 1.1 Draft Option -, 1.2 Frame Stacking Order -, 2.1 Flow Frames -, 2.1.1 Prematurely Ending a Flow Frame -, 3. Modifying Frame Attributes -, 3.1 Non-Rectangular Frames -, 4.3 Relative Locations -, 5.1 Column Styles -, 5.2 Column Styles with an Additional Frame -, 5.3 Right to Left Columns -, 5.3 Right to Left Columns -, 5.4.4 Vertical and Horizontal Rules -, 7.2 Lengths -, 7.3 Counters -, 7.3 Counters -, 8.1 General Queries -, 8.1 General Queries -, 8.1 General Queries -, 8.1 General Queries -, 8.1 General Queries -, 8.1 General Queries -, 8.1 General Queries -, 8.1 General Queries -, 8.1 General Queries -, 8.1 General Queries -, 8.1 General Queries -, 8.1 General Queries -, 8.2 Unexpected Output -, 8.2 Unexpected Output -, 8.2 Unexpected Output -, 8.2 Unexpected Output -, 8.2 Unexpected Output -, 8.2 Unexpected Output -, 8.2 Unexpected Output -, 8.3 Error Messages -, 8.3 Error Messages -
frame
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. 1. Introduction -, 1.1 Draft Option -, 1.2 Frame Stacking Order -, 1.3 HTML -, 2.1 Flow Frames -, 2.1.1 Prematurely Ending a Flow Frame -, 2.3 Dynamic Frames -, 2.3.1 Important Notes -, 3. Modifying Frame Attributes -, 3.1 Non-Rectangular Frames -, 4. Locations and Dimensions -, 4.1 Determining the Location of the Typeblock -, 4.2 Determining the Dimensions and Locations of Frames -, 4.3 Relative Locations -, 5. Predefined Layouts -, 5.2 Column Styles with an Additional Frame -, 5.4.4 Vertical and Horizontal Rules -, 7.2 Lengths -, 7.2 Lengths -, 7.3 Counters -, 8.1 General Queries -, 8.1 General Queries -, 8.1 General Queries -, 8.1 General Queries -, 8.1 General Queries -, 8.2 Unexpected Output -, 8.2 Unexpected Output -, 8.3 Error Messages -, 8.3 Error Messages -, 8.3 Error Messages -
frame making command
A -LaTeX command which places some kind of border around its -argument. For example: \fbox. 3. Modifying Frame Attributes -, 7.2 Lengths -
identification label -(IDL)
A unique -label which can be assigned to a frame, enabling you to -refer to the frame by label instead of by its -IDN. 1.1 Draft Option -, 2.1 Flow Frames -, 2.2 Static Frames -, 2.3 Dynamic Frames -, 2.3 Dynamic Frames -, 3. Modifying Frame Attributes -, 4.2 Determining the Dimensions and Locations of Frames -, 4.3 Relative Locations -, 4.3 Relative Locations -, 5.4 Backdrop Effects -, 5.4.4 Vertical and Horizontal Rules -, 6.2 Minitocs -, 8.3 Error Messages -, 8.3 Error Messages -, 8.3 Error Messages -
identification number -(IDN)
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. 1.1 Draft Option -, 1.2 Frame Stacking Order -, 1.2 Frame Stacking Order -, 1.2 Frame Stacking Order -, 2.1 Flow Frames -, 2.2 Static Frames -, 2.3 Dynamic Frames -, 2.3 Dynamic Frames -, 3. Modifying Frame Attributes -, 4.2 Determining the Dimensions and Locations of Frames -, 4.3 Relative Locations -, 4.3 Relative Locations -, 4.3 Relative Locations -, 5.4.4 Vertical and Horizontal Rules -, 5.4.4 Vertical and Horizontal Rules -, 6.1 Thumbtabs -, 6.2 Minitocs -, 7.3 Counters -, 7.3 Counters -, 7.3 Counters -, 8.2 Unexpected Output -, 8.3 Error Messages -
page list
A list of -pages. This can either be a single keyword: all, -odd, even or none, or it can -be a comma-separated list of individual page numbers or -page ranges. For example: <3,5,7-11,>15 -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. 2.1 Flow Frames -, 2.2 Static Frames -, 3. Modifying Frame Attributes -, 5.1 Column Styles -, 5.2 Column Styles with an Additional Frame -, 5.4 Backdrop Effects -, 8.1 General Queries -, 8.1 General Queries -
page range
Page -ranges can be closed, e.g. 5-10, or open, e.g. -<7 or >9. 2.1 Flow Frames -, 3. Modifying Frame Attributes -
static frame
Frames in which text is fixed in place. The contents are fixed until -explicitly changed or cleared via the \clear key -in \setstaticcontents. 1. Introduction -, 1.1 Draft Option -, 1.2 Frame Stacking Order -, 1.3 HTML -, 2.2 Static Frames -, 2.2.1 Important Notes -, 2.3 Dynamic Frames -, 3. Modifying Frame Attributes -, 3.1 Non-Rectangular Frames -, 5.4 Backdrop Effects -, 5.4.1 Vertical stripe effects -, 5.4.2 Horizontal stripe effect -, 5.4.3 Background Frame -, 5.4.4 Vertical and Horizontal Rules -, 5.4.4 Vertical and Horizontal Rules -, 5.4.4 Vertical and Horizontal Rules -, 7.2 Lengths -, 7.3 Counters -, 7.3 Counters -, 8.1 General Queries -, 8.1 General Queries -, 8.1 General Queries -, 8.1 General Queries -, 8.1 General Queries -, 8.1 General Queries -, 8.1 General Queries -, 8.1 General Queries -, 8.2 Unexpected Output -, 8.2 Unexpected Output -, 8.2 Unexpected Output -, 8.2 Unexpected Output -, 8.3 Error Messages -, 8.3 Error Messages -, 8.3 Error Messages -, 8.3 Error Messages -, 8.3 Error Messages -, 8.3 Error Messages -, 8.3 Error Messages -
typeblock
The area of the page where the main body of the text goes. -The width and height of this area are given by -\textwidth and \textheight. 1. Introduction -, 1.1 Draft Option -, 2.1 Flow Frames -, 2.2 Static Frames -, 4.1 Determining the Location of the Typeblock -, 5.1 Column Styles -, 5.2 Column Styles with an Additional Frame -, 5.4 Backdrop Effects -, 6.1 Thumbtabs -, 7.1 Macros -, 8.1 General Queries -, 8.1 General Queries -, 8.1 General Queries -, 8.1 General Queries -
- -

-Top | Index - -

- -
- -

-Index -

-
\afterminitocskip -
6.2 - | 7.2 -
\appenddfminitoc -
6.2 -
\appenddynamiccontents -
2.3 -
\appenddynamiccontents* -
2.3 -
\baselineskip -
5.1 - | 5.1 - | 5.1 - | 5.2 - | 7.2 -
\beforeminitocskip -
6.2 - | 7.2 -
\caption -
1. -
\chapter -
2.3 - | 3.1 - | 6.1 -
\clear -
ffuserguide -
\cleardoublepage -
2.1.1 -
\clearpage -
2.1.1 -
color package -
1. -
\columnsep -
5.1 - | 5.1 - | 5.1 - | 5.1 - | 7.2 -
\columnseprule -
5.4.4 -
\computebottomedge -
4.1 -
\computeleftedgeeven -
4.1 -
\computeleftedgeodd -
4.1 -
\computerightedgeeven -
4.1 -
\computerightedgeodd -
4.1 -
\computetopedge -
4.1 -
\continueonframe -
2.2 - | 2.2 - | 2.3 - | 2.3 - | 2.3.1 - | 4.3 -
\dfchaphead -
2.3 -
\dfswapoddeven -
3. -
\diamondshape -
3.1 -
\disablethumbtabs -
6.1 -
displayedframe counter -
7.3 -
document environment -
ffuserguide - | 1. - | 2.1 -
\doublebox -
3. - | 3. -
draft option -
1.1 - | 1.1 - | 1.2 -
dynamiccontents environment -
2.3 - | 2.3 - | 2.3 - | 2.3 - | 2.3.1 - | 8.3 - | 8.3 -
dynamiccontents* environment -
2.3 - | 2.3 - | 2.3 - | 2.3 - | 2.3.1 -
\enableminitoc -
6.2 -
\enablethumbtabs -
6.1 -
etex package -
8.3 -
\evensidemargin -
1. -
fancybox package -
3. -
\fbox -
ffuserguide - | 3. - | 3. - | 7.2 -
\fboxsep -
7.2 -
\FFabove -
4.3 -
\FFaboveleft -
4.3 -
\FFaboveright -
4.3 -
\ffareaheight -
4.2 -
\ffareawidth -
4.2 -
\ffareax -
4.2 -
\ffareay -
4.2 -
\FFbelow -
4.3 -
\FFbelowleft -
4.3 -
\FFbelowright -
4.3 -
\ffcolumnseprule -
5.4.4 - | 5.4.4 - | 5.4.4 - | 7.2 -
\ffcontinuedtextfont -
2.2 - | 2.3 - | 7.1 -
\ffcontinuedtextlayout -
2.2 - | 2.3 -
\ffhrule -
5.4.4 -
\fflabelfont -
7.1 -
\fflabelsep -
7.2 -
\FFleft -
4.3 -
\FFoverlap -
4.3 -
\FFright -
4.3 -
\ffruledeclarations -
5.4.4 - | 7.1 -
\ffswapoddeven -
3. -
\ffvadjustfalse -
5.1 -
\ffvrule -
5.4.4 -
figure environment -
1. - | 1. - | 1. -
figure* environment -
1. -
\flowframerule -
3. - | 7.2 -
\flowframesep -
3. - | 7.2 -
\flowframeshowlayout -
1.1 -
frame settings -
-
angle -
3. -
backcolor -
3. -
border -
3. -
bordercolor -
3. -
clear -
3. - | 3. - | 8.1 -
evenx -
3. -
eveny -
3. -
height -
3. -
label -
3. -
margin -
3. -
oddx -
3. -
oddy -
3. -
offset -
3. -
pages -
3. -
shape -
3. - | 3.1 - | 3.1 - | 8.1 -
style -
3. -
textcolor -
3. -
valign -
3. - | 8.1 -
width -
3. -
x -
3. -
y -
3. -
-
\framebreak -
2.1.1 - | 2.1.1 - | 8.2 -
\getdynamicbounds -
4.2 -
\getdynamicbounds* -
4.2 -
\getdynamicid -
2.3 - | 2.3 -
\getdynamiclabel -
2.3 - | 2.3 -
\getflowbounds -
4.2 -
\getflowbounds* -
4.2 -
\getflowid -
2.1 - | 2.1 -
\getflowlabel -
2.1 - | 2.1 -
\getstaticbounds -
4.2 -
\getstaticbounds* -
4.2 -
\getstaticid -
2.2 - | 2.2 -
\getstaticlabel -
2.2 - | 2.2 -
ghostscript -
8.2 -
\heartshape -
3.1 -
\hNtone -
5.4.2 -
\hNtoneleft -
5.4.2 -
\hNtoneright -
5.4.2 -
\hsize -
2.1.1 - | 8.2 -
html package -
1.3 -
\htwotone -
5.4.2 - | 5.4.2 - | 5.4.2 - | 5.4.2 -
\htwotoneleft -
5.4.2 - | 5.4.2 -
\htwotoneright -
5.4.2 - | 5.4.2 -
hyperref package -
1. - | 6.1 - | 6.1 -
\hypersetup -
6.1 -
\inserthrule -
5.4.4 - | 5.4.4 - | 5.4.4 - | 7.1 - | 7.2 -
\insertvrule -
5.4.4 - | 5.4.4 - | 5.4.4 - | 7.1 - | 7.2 -
\item -
8.3 -
\label -
1. - | 2.2.1 - | 3. - | 7.3 - | 8.1 -
\labelflow -
7.3 - | 7.3 - | 7.3 -
\labelflowid -
7.3 - | 7.3 -
\lefttorightcolumnsfalse -
5.3 -
\lefttorightcolumnstrue -
5.3 -
\makebackgroundframe -
5.4.3 -
\makedfheaderfooter -
2.3 -
\makethumbtabs -
6.1 -
maxdynamic counter -
7.3 -
maxflow counter -
7.3 -
maxstatic counter -
7.3 -
maxthumbtabs counter -
6.1 - | 7.3 -
\minitocstyle -
6.2 -
\Ncolumn -
5.1 - | 5.3 - | 7.2 -
\Ncolumnbottom -
5.2 - | 5.2 - | 5.2 -
\Ncolumnbottominarea -
5.2 - | 5.2 - | 5.2 - | 5.2 -
\NcolumnDbottom -
5.2 -
\NcolumnDbottominarea -
5.2 -
\NcolumnDtop -
5.2 -
\NcolumnDtopinarea -
5.2 -
\Ncolumninarea -
5.1 -
\NcolumnSbottom -
5.2 -
\NcolumnSbottominarea -
5.2 -
\NcolumnStop -
5.2 -
\NcolumnStopinarea -
5.2 -
\Ncolumntop -
5.2 - | 5.2 - | 5.2 - | 7.2 - | 7.2 -
\Ncolumntopinarea -
5.2 - | 5.2 - | 5.2 - | 5.2 -
\newdynamicframe -
2.3 -
\newdynamicframe* -
2.3 -
\newflowframe -
2.1 - | 2.2 - | 2.2 - | 2.3 -
\newflowframe* -
2.1 -
\newpage -
2.1.1 -
\newstaticframe -
2.2 - | 2.3 -
\newstaticframe* -
2.2 -
nocolor option -
1.1 -
norotate option -
1.1 - | 6.1 -
\nutshape -
3.1 -
\oddsidemargin -
1. -
\onecolumn -
5.1 - | 5.1 - | 5.1 - | 8.1 -
\onecolumnbottom -
5.2 - | 5.2 - | 5.2 -
\onecolumnbottominarea -
5.2 - | 5.2 - | 5.2 - | 5.2 -
\onecolumnDbottom -
5.2 -
\onecolumnDbottominarea -
5.2 -
\onecolumnDtop -
5.2 -
\onecolumnDtopinarea -
5.2 -
\onecolumninarea -
5.1 -
\onecolumnSbottom -
5.2 -
\onecolumnSbottominarea -
5.2 -
\onecolumnStop -
5.2 -
\onecolumnStopinarea -
5.2 -
\onecolumntop -
5.2 - | 5.2 - | 5.2 -
\onecolumntopinarea -
5.2 - | 5.2 - | 5.2 - | 5.2 -
\Ovalbox -
3. - | 3. - | 3. - | 3. -
\pagebreak -
2.1.1 -
\par -
3.1 -
\parshape -
3.1 - | 3.1 - | 3.1 - | 3.1 - | 3.1 - | 3.1 - | 8.2 - | 8.2 -
\part -
3.1 -
\ref -
7.3 - | 7.3 -
\relativeframelocation -
4.3 - | 4.3 - | 4.3 - | 4.3 - | 4.3 -
\relativeframelocation* -
4.3 -
\relax -
3. - | 3.1 -
\reldynamicloc -
4.3 -
\relflowloc -
4.3 -
\relstaticloc -
4.3 -
\renewcommand -
7.1 -
RL option -
5.3 -
\sdfparindent -
7.2 - | 8.2 -
\setalldynamicframes -
3. -
\setallflowframes -
3. -
\setallstaticframes -
3. -
\setdynamiccontents -
2.3 - | 2.3.1 - | 3. -
\setdynamiccontents* -
2.3 -
\setdynamicframe -
2.3 - | 2.3 - | 3. - | 6.1 - | 8.1 -
\setdynamicframe* -
3. -
\setffdraftcolor -
7.1 -
\setffdrafttypeblockcolor -
7.1 -
\setflowframe -
2.1 - | 3. -
\setflowframe* -
3. - | 8.3 -
\setlength -
6.2 - | 7.2 -
\setstaticcontents -
ffuserguide - | 2.2 - | 2.2 - | 3. -
\setstaticcontents* -
2.2 - | 2.2 - | 2.2 -
\setstaticframe -
3. - | 8.1 -
\setstaticframe* -
3. -
\setthumbtab -
6.1 -
\setthumbtabindex -
6.1 -
\sfswapoddeven -
3. -
\shadowbox -
3. - | 3. -
shapepar package -
3.1 - | 3.1 - | 3.1 - | 3.1 - | 3.1 - | 3.1 - | 3.1 - | 3.1 - | 3.1 - | 3.1 - | 3.1 - | 3.1 - | 3.1 -
\showframebboxfalse -
1.1 -
\showframebboxtrue -
1.1 -
\showmarginsfalse -
1.1 -
\showmarginstrue -
1.1 -
\showtypeblockfalse -
1.1 -
\showtypeblocktrue -
1.1 -
\simpar -
3.1 -
\squareshape -
3.1 -
staticcontents environment -
2.2 - | 2.2 - | 2.3 - | 3. -
staticcontents* environment -
2.2 - | 2.2 -
staticfigure environment -
1. - | 1. - | 8.3 -
statictable environment -
1. - | 1. - | 8.3 -
table environment -
1. - | 1. - | 1. -
table* environment -
1. -
\tableofcontents -
6.1 -
\textheight -
ffuserguide -
\textwidth -
ffuserguide -
theindex environment -
8.1 -
thisframe counter -
7.3 -
\thumbtabformat -
6.1 -
\thumbtabindex -
6.1 - | 6.1 -
\thumbtabindexformat -
6.1 -
\thumbtabwidth -
6.1 -
tikz package -
3. - | 5.4.4 -
\tocandthumbtabindex -
6.1 - | 6.1 -
ttbnonum option -
6.1 -
ttbnotitle option -
6.1 -
ttbnum option -
6.1 -
ttbtitle option -
6.1 -
\twocolumn -
5.1 - | 5.1 - | 5.1 - | 5.1 - | 5.3 - | 8.1 -
\twocolumnbottom -
5.2 - | 5.2 - | 5.2 -
\twocolumnbottominarea -
5.2 - | 5.2 - | 5.2 - | 5.2 -
\twocolumnDbottom -
5.2 -
\twocolumnDbottominarea -
5.2 -
\twocolumnDtop -
5.2 -
\twocolumnDtopinarea -
5.2 -
\twocolumninarea -
5.1 - | 5.1 -
\twocolumnSbottom -
5.2 -
\twocolumnSbottominarea -
5.2 -
\twocolumnStop -
5.2 -
\twocolumnStopinarea -
5.2 -
\twocolumntop -
5.2 - | 5.2 - | 5.2 -
\twocolumntopinarea -
5.2 - | 5.2 - | 5.2 - | 5.2 -
\value -
7.3 -
\vcolumnsep -
5.2 - | 7.2 -
verbatim text -
2.3 - | 2.3 - | 2.3 - | 2.3.1 - | 8.3 - | 8.3 - | 8.3 -
\vNtone -
5.4.1 -
\vNtonebottom -
5.4.1 -
\vNtonetop -
5.4.1 -
\vtwotone -
5.4.1 - | 5.4.1 - | 5.4.1 - | 5.4.1 -
\vtwotonebottom -
5.4.1 - | 5.4.1 -
\vtwotonetop -
5.4.1 - | 5.4.1 - | 5.4.1 - -
- -

- -

-Top | Index - -

- -

Footnotes

-
-
... -user1.1
-
Can I have arbitrary shaped frames? See -Non-Rectangular Frames - -
-
... environment1.2
-
This is because -of the arbitrary layout of the flow frames. - -
-
... -them.1.3
-
Can I have arbitrary -shaped frames? See -Non-Rectangular -Frames. - -
-
...typeblock2.1
-
See converting from absolute to relative page -co-ordinates - -
-
... counter2.2
-
why can't I use the page number format? -See query 3 - -
-
...flow2.3
-
the -position for the even pages is set using \setflowframe -defined in Modifying -Frame Attributes - -
-
... of.2.4
-
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. - -
-
... macro.2.5
-
which means that you can have -verbatim text in the body of the staticcontents environment -but not in the body of the dynamiccontents environment - -
-
... -approximately5.1
-
It may not be exact, as the flow frames are adjusted so that their height is an integer multiple -of \baselineskip, which may increase the gap. - -
-
... thumbtabs6.1
-
but -only do this if there is enough room on the page! - -
-
...hypersetup@\hypersetup6.2
-
defined by the -hyperref package - -
-
... approximate8.1
-
The pedantic may point out -that TeX may make several attempts to fill in the flow frames -depending on penalties and so on. - -
-
... pencilled8.2
-
actually it hasn't -drawn anything really, but it has in its mind's eye. - -
-
...offset8.3
-
offset can also have the value compute - -
-
-
- - - diff --git a/Master/texmf-dist/doc/latex/flowfram/ffuserguide.pdf b/Master/texmf-dist/doc/latex/flowfram/ffuserguide.pdf index 595c0cfbbab..49ef7001861 100644 Binary files a/Master/texmf-dist/doc/latex/flowfram/ffuserguide.pdf and b/Master/texmf-dist/doc/latex/flowfram/ffuserguide.pdf differ 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 index b4ebe1d54cf..67085cab743 100644 Binary files a/Master/texmf-dist/doc/latex/flowfram/flowfram.pdf and b/Master/texmf-dist/doc/latex/flowfram/flowfram.pdf differ diff --git a/Master/texmf-dist/doc/latex/flowfram/samples/brochure.pdf b/Master/texmf-dist/doc/latex/flowfram/samples/brochure.pdf deleted file mode 100644 index 4e37ce2e49b..00000000000 Binary files a/Master/texmf-dist/doc/latex/flowfram/samples/brochure.pdf and /dev/null differ diff --git a/Master/texmf-dist/doc/latex/flowfram/samples/brochure.tex b/Master/texmf-dist/doc/latex/flowfram/samples/brochure.tex deleted file mode 100644 index d0434139854..00000000000 --- a/Master/texmf-dist/doc/latex/flowfram/samples/brochure.tex +++ /dev/null @@ -1,362 +0,0 @@ -\documentclass[a4paper]{report} - -\usepackage[landscape,margin=1in]{geometry} -\usepackage{color} -\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} - -% 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 -\slshape\Huge\MakeUppercase{A Sample Brochure}\par -\vskip0.5in -\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. -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. - -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 -manual (ffuserguide.pdf) for -a comprehensive description, as some parts of this document -may now be out of date. -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. - -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 -column~\ref{flow:floats} on page~\pageref{flow:floats}. - -\chapter{Setting up Frames} - -This is column~\thedisplayedframe. - -The \textsl{flowfram} package provides three types of frame: -{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, -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. - -\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). - -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 -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}]\mbox{}\par The width of the frame. - -\item[height=\meta{length}]\mbox{}\par The height of the frame. - -\item[x=\meta{length}]\mbox{}\par The x-coordinate of the frame. - -\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 -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}]\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 -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 -\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, -for example \verb/[rgb]{0,1,0}/. - -\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 -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}]\mbox{}\par 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}]\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 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 \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 -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} - -\labelflow{flow:stacking} -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} - -\labelflow{flow: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\linebreak \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. - -\item \cmdname{columnsep} - -This is the horizontal distance between flow frames when using one of the -\cmdname{Ncolumn} type of commands - -\item \cmdname{vcolumnsep} - -This is the vertical distance between the flow frames and the static or -dynamic frame when using one of the \cmdname{Ncolumntop} type of commands. -\end{itemize} - -\label{lastpage} -\end{document} diff --git a/Master/texmf-dist/doc/latex/flowfram/samples/news.pdf b/Master/texmf-dist/doc/latex/flowfram/samples/news.pdf deleted file mode 100644 index d36d46ddccd..00000000000 Binary files a/Master/texmf-dist/doc/latex/flowfram/samples/news.pdf and /dev/null differ diff --git a/Master/texmf-dist/doc/latex/flowfram/samples/news.tex b/Master/texmf-dist/doc/latex/flowfram/samples/news.tex deleted file mode 100644 index a8ff83b3922..00000000000 --- a/Master/texmf-dist/doc/latex/flowfram/samples/news.tex +++ /dev/null @@ -1,204 +0,0 @@ -\documentclass{article} - -\usepackage{color} -\usepackage{flowfram} -\usepackage[a5paper,top=10mm,bottom=10mm,margin=10mm]{geometry} -\usepackage{graphicx} - -% 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}{2cm} -\setlength{\leftY}{\textheight} -\addtolength{\leftY}{-\leftH} - -\newstaticframe[1]{\textwidth}{\leftH}{0pt}{\leftY}[title] - -% First flow frame. - -\setlength{\leftH}{7cm} -\adjustheight{\leftH} -\addtolength{\leftY}{-\leftH} -\setlength{\leftW}{0.5\textwidth} - -\newflowframe[1]{\leftW}{\leftH}{0pt}{\leftY} - -\setlength{\rightH}{\leftH} -\setlength{\rightY}{\leftY} - -% Second flow frame - -\setlength{\leftH}{3.5cm} -\adjustheight{\leftH} -\addtolength{\leftY}{-\leftH} - -\newflowframe[1]{\textwidth}{\leftH}{0pt}{\leftY} - -% Right hand flow frame - -\setlength{\rightX}{\leftW} -\addtolength{\rightX}{\columnsep} -\setlength{\rightW}{\textwidth} -\addtolength{\rightW}{-\rightX} - -\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} -\setlength{\rightW}{0.75in} -\setlength{\rightH}{0.8in} -\addtolength{\rightY}{-\rightH} -\setlength{\rightX}{\textwidth} -\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} -\setlength{\leftW}{0.6\textwidth} - -\newflowframe[1]{\leftW}{\leftH}{0pt}{0pt} - -% bottom right flow frame - -\setlength{\rightX}{\leftW} -\addtolength{\rightX}{\columnsep} -\setlength{\rightW}{\textwidth} -\addtolength{\rightW}{-\rightX} - -\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 - -\setcounter{secnumdepth}{0} -\pagestyle{empty} - -\begin{document} - -\begin{staticcontents*}{title} -\begin{center} -\bfseries\Huge -Fairy Tale Times -\end{center} -\hfill Issue 1. 20 November 2005. -\end{staticcontents*} - -\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 -girl a woodsman arrived in time to rescue her. Parents are -being cautioned not to let their children wander about on -their own, and to remind them not to talk to strangers.\par -\framebreak - -The next day the wolf struck again, this time targeting two -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. - -``Always ask to see identification,'' said one police advisor, -``and invest in improving the general security of your property.'' - -\framebreak -\section{Tragic Wall Accident} - -{\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 -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} - -Humpty Dumpty was believed to be sitting -on the wall when he fell. Police have ruled out foul play, but -are advising people not to play on high walls, particularly -those vulnerable members of the population suffering from -eggshell syndrome. - -\begin{staticcontents*}{midhead} -\section{Relief as Missing Sheep Finally Return Home} -\end{staticcontents*} - -\framebreak -There was much celebration yesterday morning when Little Bo -Peep's sheep finally returned home. They had been missing -for more than a week. - -{\parshape=8 0pt \linewidth 0pt \linewidth 0pt \linewidth -0pt \linewidth 40pt 180pt 36pt 184pt 29pt 191pt -0pt \linewidth -``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.'' Unusual advice perhaps, but it seems to have worked -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 -trying to determine what happened to them. - -\noindent\hrulefill - -This is a sample document illustrating the -flowfram package. It uses \TeX's \verb|\parshape| command -to create irregularly shaped paragraphs. - -\hfill Nicola Talbot -\framebreak - -\end{document} diff --git a/Master/texmf-dist/doc/latex/flowfram/samples/news2.pdf b/Master/texmf-dist/doc/latex/flowfram/samples/news2.pdf deleted file mode 100644 index 62df0e2b448..00000000000 Binary files a/Master/texmf-dist/doc/latex/flowfram/samples/news2.pdf and /dev/null differ diff --git a/Master/texmf-dist/doc/latex/flowfram/samples/news2.tex b/Master/texmf-dist/doc/latex/flowfram/samples/news2.tex deleted file mode 100644 index 125d5d3cd58..00000000000 --- a/Master/texmf-dist/doc/latex/flowfram/samples/news2.tex +++ /dev/null @@ -1,231 +0,0 @@ -\documentclass[12pt]{article} - -\usepackage{graphicx} -\usepackage{color} -\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} -\addtolength{\leftY}{-\leftH} - -\newstaticframe[1]{\textwidth}{\leftH}{0pt}{\leftY}[L] -\setstaticframe*{L}{shape={\parshape=24 -0pt 0.5\linewidth -0pt 0.5\linewidth -0pt 0.5\linewidth -0pt 0.5\linewidth -0pt 0.5\linewidth -0pt 0.5\linewidth -0pt 0.5\linewidth -0pt 0.5\linewidth -0pt 0.5\linewidth -0pt 0.5\linewidth -0pt 0.5\linewidth -0pt 0.5\linewidth -0pt 0.5\linewidth -0pt 0.5\linewidth -0pt 0.5\linewidth -0pt 0.5\linewidth -0pt 0.5\linewidth -0pt \linewidth -0pt \linewidth -0pt \linewidth -0pt \linewidth -0pt \linewidth -0pt \linewidth -0pt \linewidth -}} - -% egg picture - -\addtolength{\rightY}{\leftY} -\addtolength{\rightY}{73mm} -\setlength{\rightW}{0.9in} -\setlength{\rightH}{1.5in} -\setlength{\rightX}{\textwidth} -\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} -\setlength{\rightW}{\textwidth} -\addtolength{\rightW}{-\rightX} -\setlength{\rightY}{\leftY} -\addtolength{\rightY}{2.8cm} -\setlength{\rightH}{\leftH} -\addtolength{\rightH}{-2.8cm} - -\newstaticframe[1]{\rightW}{\rightH}{\rightX}{\rightY}[right] - -\setstaticframe*{right}{shape={\parshape=15 -0pt \linewidth -0pt \linewidth -0pt \linewidth -0pt 0.75\linewidth -0pt 0.65\linewidth -0pt 0.75\linewidth -0pt 0.8\linewidth -0pt 0.8\linewidth -0pt \linewidth -0pt \linewidth -0pt \linewidth -0pt \linewidth -0pt \linewidth -0pt \linewidth -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} -\setlength{\sdfparindent}{\parindent} - -\begin{document} -\begin{staticcontents*}{title} -\begin{center} -\bfseries\Huge -Fairy Tale Times -\end{center} -\hfill Issue 2. 7 December 2005. -\end{staticcontents*} - -\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 -girl a woodsman arrived in time to rescue her. Parents are -being cautioned not to let their children wander about on -their own, and to remind them not to talk to strangers. - -The next day the wolf struck again, this time targeting two -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. -``Always ask to see identification,'' said one police advisor, -``and invest in improving the general security of your property.'' -\end{staticcontents*} - -\begin{staticcontents*}{right} -\section{Tragic Wall Accident} - -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. - -Humpty Dumpty was believed to be sitting on the wall when he fell. Police have ruled out foul play, but -are advising people not to play on high walls, particularly -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*} - -\begin{staticcontents*}{midhead} -\section{Relief as Missing Sheep Finally Return Home} -\end{staticcontents*} - -There was much celebration yesterday morning when Little Bo -Peep's sheep finally returned home. They had been missing -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.'' - -\parshape=8 -0pt \linewidth -0pt \linewidth -0.3\linewidth 0.7\linewidth -0.3\linewidth 0.7\linewidth -0.25\linewidth 0.75\linewidth -0.25\linewidth 0.75\linewidth -0pt \linewidth -0pt \linewidth -Unusual advice perhaps, but it seems to have worked -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 afternoon. -The sheep themselves made no comment, and police are% -\framebreak\parshape=0 -still trying to determine what happened to them. -The big bad wolf is reportedly helping them with their inquiries. - -\noindent\hrulefill - -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. -Using the shapepar package provides you with more intricate -shapes, but as its documentation says, it is not intended -for use in large documents. - -\hfill Nicola Talbot -\end{document} diff --git a/Master/texmf-dist/doc/latex/flowfram/samples/poster.pdf b/Master/texmf-dist/doc/latex/flowfram/samples/poster.pdf deleted file mode 100644 index ea499d7b56f..00000000000 Binary files a/Master/texmf-dist/doc/latex/flowfram/samples/poster.pdf and /dev/null differ diff --git a/Master/texmf-dist/doc/latex/flowfram/samples/poster.tex b/Master/texmf-dist/doc/latex/flowfram/samples/poster.tex deleted file mode 100644 index 05fe2131f7d..00000000000 --- a/Master/texmf-dist/doc/latex/flowfram/samples/poster.tex +++ /dev/null @@ -1,363 +0,0 @@ -\documentclass[a0]{a0poster} - -\usepackage{color} -\usepackage{times} -\usepackage{courier} -\usepackage{helvet} -\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}} - -\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 -%\setlength{\parindent}{15pt} - -\begin{document} -\begin{staticcontents*}{title} -\begin{center} -\bfseries\veryHuge flowframe.sty : Creating Posters, Magazines or Brochures in \LaTeX -\vskip1cm -\huge Nicola L. C. Talbot -\vskip2ex -\normalsize \verb"http://theoval.cmp.uea.ac.uk/~nlct/" -\end{center} -\end{staticcontents*} - -\pagestyle{empty} - -\begin{staticcontents*}{info} -\begin{staticfigure} - -\begin{verbatim} - % Make the distance between columns = 1.5cm - \setlength{\columnsep}{2cm} - - % Make a 4 column layout with a static frame on top. - % 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} - - % On the first page, replace the 3rd and 4th columns - % with two shorter columns with a static frame underneath - \setflowframe{3,4}{pages={>1}} - - % 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} - - % Assign a label to the last static frame to be created, and set background colour - \setstaticframe{\value{maxstatic}}{label={info},backcolor=[cmyk]{0.26,0,0.76,0}} - - % Set the background colour for all flow frames - \setallflowframes{backcolor=[cmyk]{0.15,0,0.69,0}} -\end{verbatim} - -\caption{The commands used to define the frames for this document} -\protect\label{fig:thisdoc} -\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 -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}. -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. - -\item \cmdname{columnsep} - -This is the horizontal distance between flow frames when using one of the -\cmdname{Ncolumn} type of commands - -\item \cmdname{vcolumnsep} - -This is the vertical distance between the flow frames and the static or -dynamic frame when using one of the \cmdname{Ncolumntop} type of commands. -\end{itemize} - -\end{document} diff --git a/Master/texmf-dist/doc/latex/flowfram/samples/sample-article.pdf b/Master/texmf-dist/doc/latex/flowfram/samples/sample-article.pdf new file mode 100644 index 00000000000..02743025742 Binary files /dev/null and b/Master/texmf-dist/doc/latex/flowfram/samples/sample-article.pdf differ 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 new file mode 100644 index 00000000000..f94e4e2451a Binary files /dev/null and b/Master/texmf-dist/doc/latex/flowfram/samples/sample-brochure.pdf differ diff --git a/Master/texmf-dist/doc/latex/flowfram/samples/sample-brochure.tex b/Master/texmf-dist/doc/latex/flowfram/samples/sample-brochure.tex new file mode 100644 index 00000000000..c1b499a0248 --- /dev/null +++ b/Master/texmf-dist/doc/latex/flowfram/samples/sample-brochure.tex @@ -0,0 +1,345 @@ + % This file is public domain. + +\documentclass[a4paper]{report} + +\usepackage[landscape,margin=1in]{geometry} +\usepackage{color} +\usepackage{flowfram} +\usepackage[colorlinks]{hyperref} + +\renewcommand{\familydefault}{cmss} + +\adjustheight{\textheight} + +\onecolumninarea[1,2]{0.6\textwidth}{\textheight}{0.4\textwidth}{0pt} +\twocolumninarea[>2]{0.6\textwidth}{\textheight}{0.4\textwidth}{0pt} + + +\newdynamicframe{0.4\textwidth}{\textheight}{0pt}{0pt}[left] + +\dfchaphead*{left} +\renewcommand{\DFchapterstyle}[1]{% +\raggedright\Huge\slshape\MakeUppercase{#1}\par} + +\vtwotone[1]{0.6\paperwidth}{[cmyk]{0.65,0.13,0,0}}{backleft}% +{0.4\paperwidth}{[cmyk]{0.94,0.54,0,0}}{backright} + +\vtwotonetop{1cm}{0.6\paperwidth}{[cmyk]{0.65,0.13,0,0}}{topleft}% +{0.4\paperwidth}{[cmyk]{0.94,0.54,0,0}}{topright} + +\newstaticframe{0.2\textwidth}{0.25\textheight}{0pt}{0pt}[logo] + +\pagestyle{empty} + +\renewcommand{\chapterfirstpagestyle}{empty} + +\newdynamicframe[>1]{\textwidth}{\headheight}{0pt}{-\footskip}[footer] + +\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} + +\setstaticcontents*{logo}{\sffamily{\Huge\slshape FLF} Flowfram} + +{\noindent +\slshape\Huge\MakeUppercase{A Sample Brochure}\par +\vskip0.5in +\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. +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. + +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 +manual (ffuserguide.pdf) for +a comprehensive description, as some parts of this document +may now be out of date. +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. + +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 +column~\ref{flow:floats} on page~\pageref{flow:floats}. + +\chapter{Setting up Frames} + +This is column~\thedisplayedframe. + +The \textsl{flowfram} package provides three types of frame: +{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, +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. + +\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). + +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 +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}]\mbox{}\par The width of the frame. + +\item[height=\meta{length}]\mbox{}\par The height of the frame. + +\item[x=\meta{length}]\mbox{}\par The x-coordinate of the frame. + +\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 +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}]\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 +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 +\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, +for example \verb/[rgb]{0,1,0}/. + +\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 +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}]\mbox{}\par 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}]\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 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 \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 +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} + +\labelflow{flow:stacking} +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} + +\labelflow{flow: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\linebreak \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. + +\item \cmdname{columnsep} + +This is the horizontal distance between flow frames when using one of the +\cmdname{Ncolumn} type of commands + +\item \cmdname{vcolumnsep} + +This is the vertical distance between the flow frames and the static or +dynamic frame when using one of the \cmdname{Ncolumntop} type of commands. +\end{itemize} + +\label{lastpage} +\end{document} diff --git a/Master/texmf-dist/doc/latex/flowfram/samples/sample-news.pdf b/Master/texmf-dist/doc/latex/flowfram/samples/sample-news.pdf new file mode 100644 index 00000000000..bfbd33ee0d2 Binary files /dev/null and b/Master/texmf-dist/doc/latex/flowfram/samples/sample-news.pdf differ diff --git a/Master/texmf-dist/doc/latex/flowfram/samples/sample-news.tex b/Master/texmf-dist/doc/latex/flowfram/samples/sample-news.tex new file mode 100644 index 00000000000..d3f98184ff9 --- /dev/null +++ b/Master/texmf-dist/doc/latex/flowfram/samples/sample-news.tex @@ -0,0 +1,189 @@ + % This file is public domain. + +\documentclass{article} + +\usepackage{color} +\usepackage{flowfram} +\usepackage[a5paper,top=10mm,bottom=10mm,margin=10mm]{geometry} +\usepackage{graphicx} + +\newlength\leftX +\newlength\leftY +\newlength\leftH +\newlength\leftW + +\newlength\rightX +\newlength\rightY +\newlength\rightH +\newlength\rightW + +\setlength{\leftH}{2cm} +\setlength{\leftY}{\textheight} +\addtolength{\leftY}{-\leftH} + +\newstaticframe[1]{\textwidth}{\leftH}{0pt}{\leftY}[title] + + +\setlength{\leftH}{7cm} +\adjustheight{\leftH} +\addtolength{\leftY}{-\leftH} +\setlength{\leftW}{0.5\textwidth} + +\newflowframe[1]{\leftW}{\leftH}{0pt}{\leftY} + +\setlength{\rightH}{\leftH} +\setlength{\rightY}{\leftY} + + +\setlength{\leftH}{3.5cm} +\adjustheight{\leftH} +\addtolength{\leftY}{-\leftH} + +\newflowframe[1]{\textwidth}{\leftH}{0pt}{\leftY} + + +\setlength{\rightX}{\leftW} +\addtolength{\rightX}{\columnsep} +\setlength{\rightW}{\textwidth} +\addtolength{\rightW}{-\rightX} + +\newflowframe[1]{\rightW}{\rightH}{\rightX}{\rightY} + + +\insertvrule{flow}{1}{flow}{3} + + +\addtolength{\rightX}{-0.5\columnsep} +\addtolength{\rightX}{-0.5\columnseprule} +\inserthrule[-\rightX]{flow}{3}{flow}{2} + + +\addtolength{\rightY}{\rightH} +\addtolength{\rightY}{-10mm} +\setlength{\rightW}{0.75in} +\setlength{\rightH}{0.8in} +\addtolength{\rightY}{-\rightH} +\setlength{\rightX}{\textwidth} +\addtolength{\rightX}{-\rightW} +\newstaticframe[1]{\rightW}{\rightH}{\rightX}{\rightY}[egg] + +\setstaticcontents*{egg}{\includegraphics[scale=0.75]{egg}} + + +\setlength{\leftH}{2cm} +\addtolength{\leftY}{-\leftH} + +\newstaticframe[1]{\textwidth}{\leftH}{0pt}{\leftY}[midhead] + +\inserthrule*{flow}{2}{static}{midhead} + + +\setlength{\leftH}{\leftY} +\adjustheight{\leftH} +\setlength{\leftW}{0.6\textwidth} + +\newflowframe[1]{\leftW}{\leftH}{0pt}{0pt} + + +\setlength{\rightX}{\leftW} +\addtolength{\rightX}{\columnsep} +\setlength{\rightW}{\textwidth} +\addtolength{\rightW}{-\rightX} + +\newflowframe[1]{\rightW}{\leftH}{\rightX}{0pt} + + +\newstaticframe[1]{0.8in}{0.8in}{0pt}{0pt}[sheep] + +\setstaticcontents*{sheep}{\includegraphics[scale=0.75]{sheep}} + +\onecolumn[>1] % for any text that falls off the last page + +\setcounter{secnumdepth}{0} +\pagestyle{empty} + +\begin{document} + +\begin{staticcontents*}{title} +\begin{center} +\bfseries\Huge +Fairy Tale Times +\end{center} +\hfill Issue 1. 20 November 2005. +\end{staticcontents*} + +\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 +girl a woodsman arrived in time to rescue her. Parents are +being cautioned not to let their children wander about on +their own, and to remind them not to talk to strangers.\par +\framebreak + +The next day the wolf struck again, this time targeting two +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. + +``Always ask to see identification,'' said one police advisor, +``and invest in improving the general security of your property.'' + +\framebreak +\section{Tragic Wall Accident} + +{\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 +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} + +Humpty Dumpty was believed to be sitting +on the wall when he fell. Police have ruled out foul play, but +are advising people not to play on high walls, particularly +those vulnerable members of the population suffering from +eggshell syndrome. + +\begin{staticcontents*}{midhead} +\section{Relief as Missing Sheep Finally Return Home} +\end{staticcontents*} + +\framebreak +There was much celebration yesterday morning when Little Bo +Peep's sheep finally returned home. They had been missing +for more than a week. + +{\parshape=8 0pt \linewidth 0pt \linewidth 0pt \linewidth +0pt \linewidth 40pt 180pt 36pt 184pt 29pt 191pt +0pt \linewidth +``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.'' Unusual advice perhaps, but it seems to have worked +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 +trying to determine what happened to them. + +\noindent\hrulefill + +This is a sample document illustrating the +flowfram package. It uses \TeX's \verb|\parshape| command +to create irregularly shaped paragraphs. + +\hfill Nicola Talbot +\framebreak + +\end{document} diff --git a/Master/texmf-dist/doc/latex/flowfram/samples/sample-news2.pdf b/Master/texmf-dist/doc/latex/flowfram/samples/sample-news2.pdf new file mode 100644 index 00000000000..792b51492a1 Binary files /dev/null and b/Master/texmf-dist/doc/latex/flowfram/samples/sample-news2.pdf differ diff --git a/Master/texmf-dist/doc/latex/flowfram/samples/sample-news2.tex b/Master/texmf-dist/doc/latex/flowfram/samples/sample-news2.tex new file mode 100644 index 00000000000..8752e95a771 --- /dev/null +++ b/Master/texmf-dist/doc/latex/flowfram/samples/sample-news2.tex @@ -0,0 +1,217 @@ + % This file is public domain. + +\documentclass[12pt]{article} + +\usepackage{graphicx} +\usepackage{color} +\usepackage{flowfram} +\usepackage[a4paper,margin=20mm]{geometry} + +\newlength\leftX +\newlength\leftY +\newlength\leftH +\newlength\leftW + +\newlength\rightX +\newlength\rightY +\newlength\rightH +\newlength\rightW + +\setlength{\leftH}{3cm} +\setlength{\leftY}{\textheight} +\addtolength{\leftY}{-\leftH} + +\newstaticframe[1]{\textwidth}{\leftH}{0pt}{\leftY}[title] + + +\setlength{\leftH}{13cm} +\adjustheight{\leftH} +\addtolength{\leftY}{-\leftH} + +\newstaticframe[1]{\textwidth}{\leftH}{0pt}{\leftY}[L] +\setstaticframe*{L}{shape={\parshape=24 +0pt 0.5\linewidth +0pt 0.5\linewidth +0pt 0.5\linewidth +0pt 0.5\linewidth +0pt 0.5\linewidth +0pt 0.5\linewidth +0pt 0.5\linewidth +0pt 0.5\linewidth +0pt 0.5\linewidth +0pt 0.5\linewidth +0pt 0.5\linewidth +0pt 0.5\linewidth +0pt 0.5\linewidth +0pt 0.5\linewidth +0pt 0.5\linewidth +0pt 0.5\linewidth +0pt 0.5\linewidth +0pt \linewidth +0pt \linewidth +0pt \linewidth +0pt \linewidth +0pt \linewidth +0pt \linewidth +0pt \linewidth +}} + + +\addtolength{\rightY}{\leftY} +\addtolength{\rightY}{73mm} +\setlength{\rightW}{0.9in} +\setlength{\rightH}{1.5in} +\setlength{\rightX}{\textwidth} +\addtolength{\rightX}{-\rightW} +\newstaticframe[1]{\rightW}{\rightH}{\rightX}{\rightY}[egg] + +\setstaticcontents*{egg}{\includegraphics[scale=0.9]{egg}} + + +\setlength{\rightX}{0.5\textwidth} +\addtolength{\rightX}{\columnsep} +\setlength{\rightW}{\textwidth} +\addtolength{\rightW}{-\rightX} +\setlength{\rightY}{\leftY} +\addtolength{\rightY}{2.8cm} +\setlength{\rightH}{\leftH} +\addtolength{\rightH}{-2.8cm} + +\newstaticframe[1]{\rightW}{\rightH}{\rightX}{\rightY}[right] + +\setstaticframe*{right}{shape={\parshape=15 +0pt \linewidth +0pt \linewidth +0pt \linewidth +0pt 0.75\linewidth +0pt 0.65\linewidth +0pt 0.75\linewidth +0pt 0.8\linewidth +0pt 0.8\linewidth +0pt \linewidth +0pt \linewidth +0pt \linewidth +0pt \linewidth +0pt \linewidth +0pt \linewidth +0pt \linewidth +}} + +\addtolength{\rightX}{-0.5\columnsep} +\newstaticframe[1]{0pt}{\rightH}{\rightX}{\rightY}[Lrule] +\setstaticcontents*{Lrule}{\makebox[0pt][l]{% +\rule{\columnseprule}{\rightH}\rule{\rightW}{\columnseprule}}} + + +\setlength{\leftH}{2cm} +\addtolength{\leftY}{-\leftH} + +\newstaticframe[1]{\textwidth}{\leftH}{0pt}{\leftY}[midhead] + +\inserthrule*{static}{L}{static}{midhead} + +\twocolumninarea{\textwidth}{\leftY}{0pt}{0pt} + + +\newstaticframe[1]{1.6in}{1.6in}{0pt}{0pt}[sheep] + +\setstaticcontents*{sheep}{\includegraphics[scale=1.2]{sheep}} + +\setcounter{secnumdepth}{0} +\setlength{\sdfparindent}{\parindent} + +\begin{document} +\begin{staticcontents*}{title} +\begin{center} +\bfseries\Huge +Fairy Tale Times +\end{center} +\hfill Issue 2. 7 December 2005. +\end{staticcontents*} + +\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 +girl a woodsman arrived in time to rescue her. Parents are +being cautioned not to let their children wander about on +their own, and to remind them not to talk to strangers. + +The next day the wolf struck again, this time targeting two +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. +``Always ask to see identification,'' said one police advisor, +``and invest in improving the general security of your property.'' +\end{staticcontents*} + +\begin{staticcontents*}{right} +\section{Tragic Wall Accident} + +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. + +Humpty Dumpty was believed to be sitting on the wall when he fell. Police have ruled out foul play, but +are advising people not to play on high walls, particularly +those vulnerable members of the population suffering from +eggshell syndrome. + +\small\em +Exclusive interview with one of the King's men on page 6 +\end{staticcontents*} + +\begin{staticcontents*}{midhead} +\section{Relief as Missing Sheep Finally Return Home} +\end{staticcontents*} + +There was much celebration yesterday morning when Little Bo +Peep's sheep finally returned home. They had been missing +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.'' + +\parshape=8 +0pt \linewidth +0pt \linewidth +0.3\linewidth 0.7\linewidth +0.3\linewidth 0.7\linewidth +0.25\linewidth 0.75\linewidth +0.25\linewidth 0.75\linewidth +0pt \linewidth +0pt \linewidth +Unusual advice perhaps, but it seems to have worked +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 afternoon. +The sheep themselves made no comment, and police are% +\framebreak\parshape=0 +still trying to determine what happened to them. +The big bad wolf is reportedly helping them with their inquiries. + +\noindent\hrulefill + +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. +Using the shapepar package provides you with more intricate +shapes, but as its documentation says, it is not intended +for use in large documents. + +\hfill Nicola Talbot +\end{document} diff --git a/Master/texmf-dist/doc/latex/flowfram/samples/sample-pages.pdf b/Master/texmf-dist/doc/latex/flowfram/samples/sample-pages.pdf new file mode 100644 index 00000000000..4e8532796e9 Binary files /dev/null and b/Master/texmf-dist/doc/latex/flowfram/samples/sample-pages.pdf differ 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 new file mode 100644 index 00000000000..9097577037b Binary files /dev/null and b/Master/texmf-dist/doc/latex/flowfram/samples/sample-poster.pdf differ diff --git a/Master/texmf-dist/doc/latex/flowfram/samples/sample-poster.tex b/Master/texmf-dist/doc/latex/flowfram/samples/sample-poster.tex new file mode 100644 index 00000000000..c8d2784525e --- /dev/null +++ b/Master/texmf-dist/doc/latex/flowfram/samples/sample-poster.tex @@ -0,0 +1,355 @@ + % This file is public domain. + +\documentclass[a0]{a0poster} + +\usepackage{color} +\usepackage{mathptmx} +\usepackage{courier} +\usepackage[scaled=0.92]{helvet} +\usepackage{url} +\usepackage{flowfram} + + +\setlength{\columnsep}{2cm} + +\NcolumnStop{4}{0.2\textheight} +\setstaticframe{\value{maxstatic}}{label={title},backcolor=[cmyk]{0.64,0,0.95,0.40},textcolor=white} + +\insertvrule{flow}{2}{flow}{3} + +\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} + +\inserthrule*[0.5\columnsep]{flow}{5}{static}{info} + +\setallflowframes{backcolor=[cmyk]{0.15,0,0.69,0}} + +\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}} + + +\begin{document} +\begin{staticcontents*}{title} +\begin{center} +\bfseries\veryHuge flowframe.sty : Creating Posters, Magazines or Brochures in \LaTeX +\vskip1cm +\huge Nicola L. C. Talbot +\vskip2ex +\normalsize \url{http://www.dickimaw-books.com/} +\end{center} +\end{staticcontents*} + +\pagestyle{empty} + +\begin{staticcontents*}{info} +\begin{staticfigure} + +\begin{verbatim} + % Make the distance between columns = 1.5cm + \setlength{\columnsep}{2cm} + + % Make a 4 column layout with a static frame on top. + % 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} + + % On the first page, replace the 3rd and 4th columns + % with two shorter columns with a static frame underneath + \setflowframe{3,4}{pages={>1}} + + % 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} + + % Assign a label to the last static frame to be created, and set background colour + \setstaticframe{\value{maxstatic}}{label={info},backcolor=[cmyk]{0.26,0,0.76,0}} + + % Set the background colour for all flow frames + \setallflowframes{backcolor=[cmyk]{0.15,0,0.69,0}} +\end{verbatim} + +\caption{The commands used to define the frames for this document} +\protect\label{fig:thisdoc} +\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 +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}. +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. + +\item \cmdname{columnsep} + +This is the horizontal distance between flow frames when using one of the +\cmdname{Ncolumn} type of commands + +\item \cmdname{vcolumnsep} + +This is the vertical distance between the flow frames and the static or +dynamic frame when using one of the \cmdname{Ncolumntop} type of commands. +\end{itemize} + +\end{document} diff --git a/Master/texmf-dist/doc/latex/flowfram/samples/sample-rot.pdf b/Master/texmf-dist/doc/latex/flowfram/samples/sample-rot.pdf new file mode 100644 index 00000000000..88dc5e0b92e Binary files /dev/null and b/Master/texmf-dist/doc/latex/flowfram/samples/sample-rot.pdf differ 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 new file mode 100644 index 00000000000..4a47a3bedb5 Binary files /dev/null and b/Master/texmf-dist/doc/latex/flowfram/samples/sample.pdf differ 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 new file mode 100644 index 00000000000..f1798b9c6a6 Binary files /dev/null and b/Master/texmf-dist/doc/latex/flowfram/samples/sample1.pdf differ 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 new file mode 100644 index 00000000000..06633932a57 Binary files /dev/null and b/Master/texmf-dist/doc/latex/flowfram/samples/sample2.pdf differ 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 new file mode 100644 index 00000000000..f22dd7c2af4 Binary files /dev/null and b/Master/texmf-dist/doc/latex/flowfram/samples/sample3.pdf differ 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 new file mode 100644 index 00000000000..079ae70299e Binary files /dev/null and b/Master/texmf-dist/doc/latex/flowfram/samples/sampleRL.pdf differ 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} -- cgit v1.2.3