Debian Codegraph @

texmf-dist/doc/latex/hvfloat/hvfloat.tex

raw
1 %% $Id: hvfloat.tex 1221 2025-12-29 08:57:17Z herbert $
2 %\listfiles
3 \errorcontextlines=100
4 \documentclass[twoside,paper=a4,usegeometry,index=totoc]{scrartcl}
5 \usepackage{fontspec}
6 \usepackage[silent]{libertinus-otf}
7 %\usepackage[scaled=0.85]{beramono}
8 \setmonofont[Scale=MatchLowercase,FakeStretch=0.9]{DejaVu Sans Mono}
9
10 \usepackage{microtype}
11 \usepackage[english]{babel}
12
13 \usepackage[marginparwidth=3cm,bottom=2cm,top=1cm,includeheadfoot%,showframe
14 ]{geometry}
15
16 %\let\Section\section
17 %\def\section{\clearpage\Section}
18
19
20 \usepackage[automark]{scrlayer-scrpage}
21 \pagestyle{scrheadings}
22
23 \usepackage{listings}
24 %
25 \lstset{%
26 language=[LaTeX]TeX,%
27 showstringspaces=false,%
28 tabsize=5,%
29 backgroundcolor=\color{black!15},
30 % frame={tb},%
31 lineskip=-1pt,%
32 extendedchars=true,%
33 basicstyle={\small\ttfamily},%
34 numbers=left,%
35 stepnumber=1,%
36 numberstyle=\tiny,%
37 xleftmargin=2em,%
38 breaklines=true,
39 }
40 %
41
42 \usepackage{graphicx}
43 \usepackage{placeins}
44 \usepackage{ragged2e}
45 \usepackage{xcolor}
46 \usepackage{url}
47 \usepackage{booktabs,xltabular}
48 \usepackage{lscape}
49 \usepackage{varioref}
50 \usepackage{multicol}
51 \usepackage{blindtext}
52
53 \let\hvBlindtext\Blindtext
54 \def\Blindtext{\par\color{black!40}\hvBlindtext\par\normalcolor}
55 \makeatletter
56 \def\hvblindtext{\textcolor{black!40}{\blindtext@text}}
57
58 \let\hvBlinddocument\blinddocument
59 \def\blinddocument{\par\color{black!30}\hvBlinddocument\par\normalcolor}
60
61 \makeatother
62 \usepackage{marginnote}
63
64 %\usepackage{imakeidx}
65 \usepackage{xindex}
66 \makeindex
67
68 \usepackage{hvindex}
69 \usepackage[all=!htb]{hvfloat-fps}
70 \usepackage[fbox,hyperref]{hvfloat}
71
72
73 \captionsetup{format=plain,font=sf,labelfont={sf,bf}}
74 \captionsetup[sub]{format=plain,font=sf,labelfont={sf,bf}}
75
76 \hypersetup{urlcolor=blue, linktocpage, colorlinks=true}
77 %
78 \makeatletter
79
80 \def\Lfile#1{\texttt{#1}\index{#1@\texttt{#1} (file)}}
81 \def\Lext#1{\texttt{.#1}\index{#1@\texttt{.#1} (file extension)}}
82 \def\Ldim#1{\texttt{\textbackslash#1}\index{#1@\texttt{\textbackslash#1} (length)}}
83 \def\Lcs#1{\texttt{\textbackslash#1}\index{#1@\texttt{\textbackslash#1}}}
84 \def\nxLcs#1{\texttt{\textbackslash#1}}
85 \def\Lenv#1{\texttt{#1}\index{#1@\texttt{#1} (environment)}}
86 \def\Lpack#1{\texttt{#1}\index{#1@\texttt{#1} (package)}}
87 \def\Lprog#1{\texttt{#1}\index{#1@\texttt{#1} (program)}}
88 \def\Loption#1{\texttt{#1}\index{#1@\texttt{#1} (package option)}}
89 \def\Lkeyword#1{\texttt{#1}\index{#1@\texttt{#1} (keyword)}}
90 \def\Lkeyval#1{\texttt{#1}\index{#1@\texttt{#1} (value)}}
91 \def\Lskip#1{\texttt{\textbackslash#1}\index{#1@\texttt{\textbackslash#1} (skip)}}
92 \def\Lkeyset#1{\expandafter\Lkeyset@i#1\@nil}
93 \def\Lkeyset@i#1=#2\@nil{\texttt{#1=#2}%
94 \index{#1@\texttt{#1} (keyword)}\index{Keyword!#1@\texttt{#1}}
95 \index{#2@\texttt{#2} (value)}\index{Value!#2@\texttt{#2}}}
96
97 \newsavebox\boxdef
98 \newenvironment{BDef}
99 {\begin{lrbox}{\boxdef}
100 \def\arraystretch{1.0}
101 \begin{tabular}{@{}l@{}l@{}l@{}}}
102 {\end{tabular}\end{lrbox}
103 %
104 % braces around next block are needed to stop the list env checking for blank lines
105 % and the \aftergroups then for making sure no indentation happens ... as i said
106 % urg
107 %
108 {\BCmd\fbox{\usebox\boxdef}\endBCmd}
109 \aftergroup\@afterindentfalse\aftergroup\@afterheading
110 }
111
112 \newskip\BDefaboveskip
113 \newskip\BDefbelowskip
114 \newskip\BDefinlineskip
115 \setlength\BDefaboveskip{0pt plus 2pt}% first-level list topsep
116 \setlength\BDefbelowskip{10pt}
117 \setlength\BDefinlineskip{6pt}
118
119 \newenvironment{BCmd}{
120 \@beginparpenalty-\@lowpenalty
121 \topsep\BDefaboveskip
122 \fboxsep3pt
123 \flushleft}
124 {\@endparpenalty\@M
125 \@topsepadd\BDefbelowskip
126 \endflushleft}
127
128 \newenvironment{BCmd*}{
129 \@beginparpenalty\@M
130 \topsep\BDefinlineskip
131 \fboxsep3pt
132 \flushleft}
133 {\@endparpenalty5000
134 \endflushleft}
135
136
137 \def\OptArgs{\colorbox{black!20}{\texttt{[Options]}}\kern1pt}
138 \def\OptArg{\@ifnextchar*\OptArg@i{\OptArg@ii*}}% star version without braces
139 \def\OptArg@i*#1{\colorbox{black!20}{\texttt{#1}}\kern1pt}
140 \def\OptArg@ii*#1{\colorbox{black!20}{\texttt{[#1]}}\kern1pt}
141 \def\DBS{{\ttfamily\textbackslash\textbackslash}}
142
143
144
145 \def\MarginNote#1{%
146 \expandafter\marginnote\expandafter{#1\\\checkoddpage\ifoddpage oddpage\else evenpage\fi\\
147 \if@twocolumn
148 2col,
149 \if@firstcolumn
150 1.col
151 \else
152 2.col
153 \fi
154 \else
155 1col,
156 \fi}}
157
158 \makeatother
159
160 \newcommand\Larg [1]{{\normalfont\itshape#1\/}}
161 \newcommand\Larga[1]{$\langle$\Larg{#1}$\rangle$}% angles
162 \newcommand\Largb[1]{\lcb\Larg{#1}\rcb} % curly brace
163 \newcommand\Largs[1]{\lsb\Larg{#1}\rsb} % square brackets
164 \newcommand\Largr[1]{\lrb\Larg{#1}\rrb} % round brackets
165 \newcommand\LBEG[1]{{\normalfont\ttfamily\bs{}begin\lcb#1\rcb}\xLenv{#1}}
166 \newcommand\LmBEG[1]{{\normalfont\ttfamily\bs{}begin\lcb#1\rcb}\xLmenv{#1}}
167 \newcommand\LEND[1]{{\normalfont\ttfamily\bs{}end\lcb#1\rcb}\xLenv{#1}}
168 \newcommand\LmEND[1]{{\normalfont\ttfamily\bs{}end\lcb#1\rcb}\xLmenv{#1}}
169
170 \DeclareRobustCommand\bs{{\normalfont\ttfamily\textbackslash}} % \let\bslash=\bs
171 \DeclareRobustCommand\lcb{{\normalfont\ttfamily\textbraceleft}}
172 \DeclareRobustCommand\rcb{{\normalfont\ttfamily\textbraceright}}
173 \DeclareRobustCommand\lsb{{\normalfont\ttfamily[}}
174 \DeclareRobustCommand\rsb{{\normalfont\ttfamily]}}
175 \DeclareRobustCommand\lrb{{\normalfont\ttfamily(}}
176 \DeclareRobustCommand\rrb{{\normalfont\ttfamily)}}
177 \DeclareRobustCommand\false{{\ttfamily false}}
178 \DeclareRobustCommand\true{{\ttfamily true}}
179
180 \let\CMD\Lcs
181 \let\ENV\Lenv
182
183 \newdimen\normalparindent
184 \normalparindent=20pt
185 \def\NormalParIndent{\global\parindent=\normalparindent}
186 \NormalParIndent
187
188
189
190 \newcommand\Float[1][]{\ifx\relax#1\relax\marginnote{\fbox{float}}\else
191 \marginnote{\fbox{\shortstack{float\\#1}}}\fi
192 }
193
194 \graphicspath{{images/}}
195
196 \begin{document}
197 \title{Package \texttt{hvfloat}\\
198 Controlling captions, fullpage and doublepage floats\\ver \hvFloatFileVersion}
199 \author{Herbert Voß\thanks{\protect\url{[email protected]}\newline
200 Thanks to Karl Berry, Frank Mittelbach, Rolf Niepraschk,
201 Yves Roggeman, Benedikt Wilde}}
202 \date{\today}
203 \maketitle
204
205
206
207 \begin{abstract}
208 The package \texttt{hvfloat} defines a macro to place objects and captions of floats in different
209 positions with different rotating angles.
210
211 All objects and captions are framed on the first pages, which is only for some demonstration here and
212 has no additional sense!
213
214 To compare the place of the definition of the floating objects in the source and the output a
215 marginnote \fbox{float} is set into the margin. This is done also only for demonstration!
216 \end{abstract}
217 \vfill
218
219 \hvFloat[%
220 nonFloat=true,
221 capWidth=0.5,
222 capPos=right,
223 objectAngle=120,
224 capAngle=-210,
225 objectPos=center
226 objectFrame,
227 ]{figure}{\includegraphics[scale=0.9]{images/rose}}
228 {\protect\fbox{What a nice Caption :-)}}
229 {fig:title}
230
231 \vspace*{\fill}
232
233 \clearpage
234
235
236 \tableofcontents
237
238 \clearpage
239
240 \listoftables
241 \listoffigures
242
243
244 \clearpage
245 \section{The package options}
246
247 \noindent\begin{tabularx}{\textwidth}{lX}
248 \Loption{fbox} & The objects and captions are put into a \Lcs{fbox} command, like in
249 this documentation. This doesn't make real sense and is only for some demonstration useful or for locating
250 problems if images seems to have too much whitespace.\\
251 \Loption{hyperref} & Load package \Lpack{hyperref}.\\
252 \Loption{nostfloats} & do not load package \Lpack{stfloats}.
253 \end{tabularx}
254
255 \bigskip
256
257 The length \Lskip{belowcaptionskip} is set by \LaTeX{} to 0pt and changed in \Lpack{hvfloat} to the
258 same value than \Lskip{abovecaptionskip}. This length can be changed to another value in the usual
259 way with \Lcs{setlength} or \Lcs{addtolength}.
260
261 The following packages are loaded by \Lpack{hvfloat}:
262
263 \Lpack{fbox},
264 \Lpack{caption},
265 \Lpack{subcaption},
266 \Lpack{atbegshi},
267 \Lpack{stfloats},
268 \Lpack{floatpag},
269 \Lpack{expl3}, \Lpack{multido},
270 \Lpack{graphicx},
271 \Lpack{xkeyval},
272 \Lpack{ifoddpage}, and
273 \Lpack{afterpage}.
274
275 The optional argument
276 \Loption{hypcap}\texttt{=false} is passed to the packages
277 \Lpack{caption} and \Lpack{subcaption} and can be overwritten by using
278 the optional argument \Loption{capFormat} or \Loption{subcapFormat}.
279
280 \begin{verbatim}
281 \capFormat={hypcap=true,...}
282 \subcapFormat={hypcap=true,...}
283 \end{verbatim}
284
285
286
287 \section{The Macros and optional arguments}
288 The syntax for the macros and \Lcs{hvFloatSetDefaults}, \Lcs{hvFloatSet}, and \CMD{hvFloat} is
289
290 \begin{BDef}
291 \Lcs{hvFloatSet}\Largb{key=value list}\\
292 \Lcs{hvFloatSetDefaults}\\
293 \Lcs{hvFloat}\OptArg*{*}\OptArgs\OptArg*{+}\Largb{float type}\Largb{floating object}\OptArg{short caption}\Largb{long caption}\Largb{label}
294 \end{BDef}
295
296 The star version is explained in section~\vref{star-version0} and \vref{star-version} and
297 the optional \OptArg*{+} is explained in section~\vref{sec:multifloats}.
298
299 \Lcs{hvFloatSet} allows the global setting of keywords and \Lcs{hvFloatSetDefaults} sets all keywords to
300 its default value as shown in Table~\vref{tab:options}.
301
302 If \Lcs{hvFloat} has an empty second parameter \texttt{<float type>}, then \Lcs{hvFloat} switches by default to
303 a nonfloat (see table~\ref{tab:options}) object, which is not important for the user. All other parameters
304 may also be empty and the short caption as second optional parameter missing. This one is as usual the
305 caption for the \Lcs{listoffigures}.
306
307 There are some more macros defined, more or less for internally use in \Lpack{hvfloat}, but they can
308 be used for own purposes.
309
310
311 \begin{BDef}
312 \Lcs{figcaption}\OptArg{short caption text}\Largb{caption text}\\
313 \Lcs{tabcaption}\OptArg{short caption text}\Largb{caption text}\\
314 \Lcs{tabcaptionbelow}\OptArg{short caption text}\Largb{caption text}\\
315 \end{BDef}
316
317 They are used for the \Lkeyword{nonFloat} keyword, where these macros write captions in the same way but outside of
318 a float environment. The default caption cannot be used here. It is no problem to use the \CMD{tabcaption}
319 command to place a caption anywhere, like here in an inlined mode:
320 \tabcaption[The Caption without sense ...]{A Caption without any sense and any object}\label{dummy}
321 A label can be put inside the argument or after the command in the usual way, so that a reference to
322 the not existing table~\ref{dummy} is no problem.
323
324 {\small\begin{verbatim}
325 [...] It is no problem to use the \verb|\tabcaption|
326 command to place a caption anywhere,
327 like here in an inlined mode:
328 \tabcaption[The Caption without sense ...]%
329 {A Caption without any sense and any
330 object}\label{dummy} A label can be put
331 inside the argument or after the command
332 in the usual way, so that a reference to
333 the not existing table~\ref{dummy} is no problem.
334 \end{verbatim}}
335
336
337 With the macro \Lcs{hvDefFloatStyle} one can define a style which can be used instead of
338 the individual setting:
339
340 \begin{BDef}
341 \Lcs{hvDefFloatStyle}\Largb{name}\Largb{setting}
342 \end{BDef}
343
344 Internally the style is saved in a macro named \verb|\hv@<name>|.
345
346 There are the following keywords:
347
348 %\begin{lrbox}\hvOBox
349 \begingroup
350 \small
351 \def\rowvsp{\rule{0pt}{9pt}}%
352 \def\rowhsp{\hspace*{\normalparindent}}%
353 \def\rownl{\newline\rowhsp}%
354 \def\none{{\itshape none}}%
355 \def\arraystretch{0.96}%
356 \begin{xltabular}{\textwidth}{@{} l>{\small\ttfamily}cX @{}}
357 \caption{The optional keywords for the macro \nxLcs{hvFloat}}\label{tab:options}\\\toprule
358 \emph{K\kern-.1em eyword} & \rmfamily\emph{Default} & \emph{Description}\\\midrule
359 \endfirsthead
360 \midrule
361 \emph{K\kern-.1em eyword} & \rmfamily\emph{Default} & \emph{Description}\\\midrule
362 \endhead
363 \midrule
364 \endfoot
365 \bottomrule
366 \endlastfoot
367
368 \Lkeyword{floatPos} & \texttt{tbp} & This is the same default placement
369 setting as in standard \LaTeX; maybe not always the best setting.\\
370 \Lkeyword{rotAngle} & 0& \rowvsp The value for the angle if both the object and
371 the caption should be rotated together.\\
372 \Lkeyword{capWidth} & n& \rowvsp The width of the caption. Can be \texttt{n}
373 for a natural width given by the current linewidth,
374 \texttt{w} for the width of the object,
375 \rownl\texttt{h} for the height of the object,
376 or a scale factor for \Lcs{columnwidth}.\\
377 \Lkeyword{capAngle} & 0 & \rowvsp The integer value for the angle if the caption
378 should be rotated. Positive is counter-clockwise.\\
379 %
380 \Lkeyword{capPos} & bottom& \rowvsp The position of the caption relative to the
381 object. Possible values:\\
382 & & \rowhsp\Lkeyval{before}: \emph{always} before (left) from the object.\\
383 & & \rowhsp\Lkeyval{top}: \emph{always} on top of the object.\\
384 & & \rowhsp\Lkeyval{left}: \emph{always} before (left) from the object,
385 but on the same page in twocolumn mode.\\
386 & & \rowhsp\Lkeyval{after}: \emph{always} after (right) from the object.\\
387 & & \rowhsp\Lkeyval{bottom}: \emph{always} on the bottom of the object.\\
388 & & \rowhsp\Lkeyval{right}: \emph{always} after (right) from the
389 object, but on the same page in twocolumn mode.\\
390 & & \rowhsp\Lkeyval{inner}: in twoside mode always typeset at the inner
391 margin.\\
392 & & \rowhsp\Lkeyval{outer}: in twoside mode always typeset at the outer
393 margin.\\
394 & & \rowhsp\Lkeyval{evenPage}: in twoside mode with fullpage objects
395 always on an even page.\\
396 & & \rowhsp\Lkeyval{oddPage}: in twoside mode with fullpage objects
397 always on an odd page.\\
398 %
399 \Lkeyword{capVPos}& center& \rowvsp Only used when
400 \texttt{capPos=left$\,|\,$right}; in these cases, the caption can
401 be vertically placed at the \Lkeyval{bottom}, \Lkeyval{center} or
402 \Lkeyval{top}.\\
403 \Lkeyword{objectPos} & center & \rowvsp Horizontal placement of the object
404 relative to the document. Possible values are
405 (\textbf{l})eft, (\textbf{c})enter, (\textbf{r})ight.\\
406 \Lkeyword{objectAngle} & 0 & \rowvsp Integer value for the angle if
407 the object should be rotated. Positive is counter-clockwise.\\
408 \Lkeyword{floatCapSep} & 5pt & \rowvsp Additional space between the
409 object and a left- or right-placed caption.\\
410 \Lkeyword{useOBox} & false & \rowvsp Instead of passing the object as a
411 parameter to \Lcs{hvFloat}, with \texttt{useOBox=true} the contents
412 of the predefined box \texttt{\textbackslash hvOBox} is used.\\
413 \Lkeyword{onlyText} & false & \rowvsp The caption is printed as normal
414 text with no entry in any list of \ldots\\
415 \Lkeyword{nonFloat} & false & \rowvsp The object isn't put in a floating
416 environment, but printed as standard text with an additional caption.
417 \rownl The float counter is increased as usual and can be referenced.\\
418 \Lkeyword{nonFloatTopSkip} & 2pt & Skip between text and object with caption below for nonFloat objects.\\
419 \Lkeyword{wide} & false & \rowvsp The float can use
420 \Ldim{textwidth}$\,+\,$\Ldim{marginparwidth} as horizontal width.\\
421 \Lkeyword{inMargin} & false & \rowvsp Put object and frame into the margin.\\
422 \Lkeyword{objectFrame} & false & \rowvsp Put a frame with no separation
423 around the float object.\\
424 \Lkeyword{fboxLines} & ltrb & \rowvsp Lines around the box l)eft, t)op, r)ight, b)ottom\\
425 \Lkeyword{fboxSep} & 0pt & \rowvsp Additional box separation (like \Ldim{fboxsep})\\
426 \Lkeyword{style} & \none & \rowvsp Use a defined style.\\
427 \Lkeyword{capFormat} & \none & \rowvsp Define formatting options for
428 \Lcs{caption}; see documentation of package \Lpack{caption}.\\
429 \Lkeyword{subcapFormat} & \none & \rowvsp Define formatting options for
430 \Lcs{subcaption}.\\
431 \Lkeyword{fullpage} & false & \rowvsp Use a complete column in twocolumn mode.\\
432 \Lkeyword{FullPage} & false & \rowvsp Use the full text area for the object.\\
433 \Lkeyword{FULLPAGE} & false & \rowvsp Use the full paper width/height for the object.\\
434 \Lkeyword{doublePage} & false & \rowvsp Use the text area on a doublepage with additional text.\\
435 \Lkeyword{doublePAGE} & false & \rowvsp Use the text area on a doublepage without additional text.\\
436 \Lkeyword{doubleFullPage} & false & \rowvsp Use the paperwidth on a doublepage with additional text.\\
437 \Lkeyword{doubleFULLPAGE} & false & \rowvsp Use the paperwidth on a doublepage without additional text.\\
438 \Lkeyword{forceLeft} & false & \rowvsp In some cases a doublepage float starts on an odd page. With \Lkeyword{forceLeft} it
439 uses only one \Lcs{afterpage} instead of two to force a start on an even page. \\
440 \Lkeyword{vFill} & false & \rowvsp Put a \Lcs{vfill} between every two objects in a multi- or subfloat.\\
441 \Lkeyword{sameHeight} & false & \rowvsp use the same text height on both pages for a \Lkeyword{doublePage} object.\\
442 \end{xltabular}
443 %\end{lrbox}
444 \endgroup
445
446 %\hvFloat*[floatPos=p,rotAngle=90,capPos=top,capWidth=w,useOBox=true]
447 % {table}
448 % {}
449 % [The optional keywords for the \newline\Lcs{hvFloat} macro]
450 % {The optional keywords for the \protect\Lcs{hvFloat} macro.}
451 % {tab:options}
452
453
454
455
456
457
458 \section{The default use of floating environments}
459 In this case there is no essential difference to the well known \Lenv{figure}
460 or \Lenv{table} environment, f.ex.:
461
462
463 \small\begin{verbatim}
464 \begin{figure}
465 ... object ...
466 \caption{...}% caption below the object
467 \end{figure}
468 \end{verbatim}
469
470
471 \normalsize
472 \MarginNote{Fig.~\ref{fig:0}}
473 \hvFloat{figure}{\includegraphics{images/rose}}{Without any keywords (only the \texttt{fbox} package option)}{fig:0}
474
475 Code for figure \ref{fig:0}:
476 \begin{lstlisting}
477 \hvFloat{figure}{\includegraphics{images/rose}}{Without any keywords (only the \texttt{fbox} package option)}{fig:0}
478 \end{lstlisting}
479
480
481 \savebox\hvOBox{%
482 \begin{tabularx}{\textwidth}{l|l|X}
483 \rmfamily Name & Type & Description\\\hline
484 \CMD{hvFloat} & command & places object and caption in different ways\\
485 \Lenv{hvFloatEnv} & environment & places object and caption exactly Here\\
486 \CMD{figcaption} & command & writes a figure caption in a non floating environment\\
487 \CMD{tabcaption} & command & writes a table caption in a non floating environment\\
488 \CMD{hvFloatSetDefaults} & command & sets all options to the defaults\\
489 \CMD{hvDefFloatStyle} & command & define a user style
490 \end{tabularx}}
491
492 \MarginNote{Tab.~\ref{tab:0}}
493 \hvFloat[capPos=top,useOBox]{table}{}
494 {With the only Option \texttt{capPos=top} to place the caption on
495 top of the table, which is often the default.}
496 {tab:0}
497
498 Code for table \ref{tab:0}:
499 \begin{lstlisting}
500 \savebox\hvOBox{%
501 \begin{tabularx}{\textwidth}{l|l|X}
502 \rmfamily Name & Type & Description\\\hline
503 \CMD{hvFloat} & command & places object and caption in different ways\\
504 \Lenv{hvFloatEnv} & environment & places object and caption exactly Here\\
505 \CMD{figcaption} & command & writes a figure caption in a non floating environment\\
506 \CMD{tabcaption} & command & writes a table caption in a non floating environment\\
507 \CMD{hvFloatSetDefaults} & command & sets all options to the defaults\\
508 \CMD{hvDefFloatStyle} & command & define a user style
509 \end{tabularx}}
510 \hvFloat[capPos=top,useOBox]{table}{}
511 {With the only Option \texttt{capPos=top} to place the caption on
512 top of the table, which is often the default.}
513 {tab:0}
514 \end{lstlisting}
515
516 See section~\ref{sec:tables} for some more informations about tabulars as objects.
517
518
519
520 \section{Caption width}
521 %\Lkeyword{capWidth} & 0.8& The width of the caption.
522 %Can be "\texttt{w}" for the width of the object or
523 %"\texttt{h}" for the height of the object
524 %or a scale for \verb|\columnwidth|.\\
525
526 \subsection{Default -- natural width}
527
528 The default setting is the natural width of a paragraph with respect to the current linewidth or columnwidth
529 for a caption below or above an object. It behaves in the same way as a caption set by one of the default
530 floating environments like \Lenv{figure} or \Lenv{table}:
531
532
533 \begin{lstlisting}
534 \hvFloat[floatPos=!htb]{figure}{\includegraphics{images/rose}}%
535 {Default caption width setting, which is the natural width with respect to the current linewidth.}{fig:width0}
536 \end{lstlisting}
537
538 \MarginNote{Fig.~\ref{fig:width0}}
539 \hvFloat[floatPos=!htb]{figure}{\includegraphics{images/rose}}%
540 {Default caption width setting, which is the natural width with respect to the current linewidth.}{fig:width0}
541
542
543 For\marginnote{!!} the following examples the package option \texttt{fbox} is disabled. All
544 frames are now set with the macro \Lcs{frame} or the optional keyword \Lkeyword{objectFrame}.
545
546
547
548 For a caption beside an object, the \emph{natural} caption width (without the optional argument \Lkeyword{wide})
549 is given by the current linewidth
550 minus the width of the object and the space between object and caption, which is set by
551 \Lkeyword{floatCapSep} (see Table~\vref{tab:options}).
552
553 \makeatletter
554 \hv@fboxfalse
555 \makeatother
556
557 \begin{lstlisting}
558 \hvFloat[floatPos=!htb,capPos=after,objectFrame]{figure}{\includegraphics[scale=1.5]{images/rose}}%
559 {Caption right beside with a \emph{natural} width, which is given by the width of the object,
560 the separation between object and caption, and the current linewidth.}{fig:width1}
561 \end{lstlisting}
562
563 \MarginNote{Fig.~\ref{fig:width1}}
564 \hvFloat[floatPos=!htb,capPos=after,objectFrame]{figure}{\includegraphics[scale=1.5]{images/rose}}%
565 {Caption right beside with a \emph{natural} width, which is given by the width of the object,
566 the separation between object and caption, and the current linewidth.}{fig:width1}
567
568
569 The same with box lines only on the left and right:
570
571 \begin{lstlisting}
572 \hvFloat[floatPos=!htb,capPos=after,objectFrame,
573 fboxLines=lr,fboxSep=0pt]{figure}{\includegraphics[scale=1.5]{images/rose}}%
574 {Caption right beside with a \emph{natural} width, which is given by the width of the object,
575 the separation between object and caption, and the current linewidth.}{fig:width1A}
576 \end{lstlisting}
577
578 \MarginNote{Fig.~\ref{fig:width1A}}
579 \hvFloat[floatPos=!htb,capPos=after,objectFrame,
580 fboxLines=lr,fboxSep=0pt]{figure}{\includegraphics[scale=1.5]{images/rose}}%
581 {Caption right beside with a \emph{natural} width, which is given by the width of the object,
582 the separation between object and caption, and the current linewidth.}{fig:width1A}
583
584
585
586 \subsection{Relative linewidth}
587
588 With \Lkeyword{capWidth}\texttt{=<number>} the caption width is set to \texttt{<number>}\Ldim{columnwidth}.
589 For captions at the bottom or on top of objects the setting is not checked if \texttt{<number>}
590 is greater than 1.
591
592 % If the given scale (0.8 in the
593 %following example) leads to a
594 %greater caption width than this maximal caption width, it will automatically set to the maximal width:
595
596 \begin{lstlisting}
597 \hvFloat[floatPos=!htb,capWidth=0.9]{figure}{\includegraphics{images/rose}}%
598 {Caption below with a width of 0.9 of the current line width (column width), which is
599 in this special case \the\linewidth. Divide it by 28.82 to get cm.}{fig:width2}
600 \end{lstlisting}
601
602 \MarginNote{Fig.~\ref{fig:width2}}
603 \hvFloat[floatPos=!htb,capWidth=0.9]{figure}{\includegraphics{images/rose}}%
604 {Caption below with a width of 0.9 of the current line width (column width), which is
605 in this special case \the\linewidth. Divide it by 28.82 to get cm.}{fig:width2}
606
607
608
609 If such a value like 0.9\Ldim{linewidth} is used for a caption beside an object, then
610 the macro does a test if the space beside the object is less equal the defined caption width.
611 If not then the width is set to the possible value between object and margin:
612
613
614
615 \begin{lstlisting}
616 \hvFloat[floatPos=!htb,
617 capPos=after,
618 capWidth=0.9]{figure}{\includegraphics[scale=1.5]{images/rose}}%
619 {Caption right beside with a width setting of \texttt{0.9\textbackslash linewidth}
620 which is too big for this example and therefore corrected
621 by the macro to the maximal width.}{fig:width3}
622 \end{lstlisting}
623
624 \MarginNote{Fig.~\ref{fig:width3}}
625 \hvFloat[floatPos=!htb,capPos=after,capWidth=0.9]{figure}{\includegraphics[scale=1.5]{images/rose}}%
626 {Caption right beside with a width setting of \texttt{0.9\textbackslash linewidth}
627 which is too big for this example and therefore corrected by the macro to the maximal width.}{fig:width3}
628
629
630 \subsection{Identical object and caption width}
631
632 With \Lkeyset{capWidth=w} the caption width is like the object width which makes only
633 real sense if you have a lot of identical images with respect to its widths.
634
635 \begin{lstlisting}
636 \hvFloat[floatPos=!htb,capWidth=w]{figure}{\includegraphics[width=0.5\linewidth]{images/CTAN}}%
637 {Caption below with a width of the given object which may be a problem
638 if it is a very small object.}{fig:width4}
639 \end{lstlisting}
640
641 \hvFloat[floatPos=!htb,capWidth=w]{figure}{\includegraphics[width=0.5\linewidth]{images/CTAN}}%
642 {Caption below with a width of the given object which may be a problem
643 if it is a very small object.}{fig:width4}
644
645
646 \subsection{caption width to height of the object}
647
648 With \Lkeyset{capWidth=h} the caption width is like the object height which makes only
649 real sense if you want to put a rotated caption beside the object.
650
651 \begin{lstlisting}
652 \hvFloat[floatPos=!htb,capPos=after,capWidth=h,capAngle=90,objectFrame]{figure}{\includegraphics{images/rose}}%
653 {Caption beside with a width of the given object height which may be a problem
654 if it is a very small object.}{fig:width5}
655 \end{lstlisting}
656
657 \MarginNote{Fig.~\ref{fig:width5}}
658 \hvFloat[floatPos=!htb,capPos=after,capWidth=h,capAngle=90,objectFrame]{figure}{\includegraphics{images/rose}}%
659 {Caption beside with a width of the given object height which may be a problem
660 if it is a very small object.}{fig:width5}
661
662
663
664 \section{Caption left or right of the object}
665 By default the caption is set on the left side of the object. If the caption and the object are set side by side, then
666 the keyvalue \Lkeyval{before} is identical to the setting \Lkeyval{left}.
667
668 \subsection{Caption right with specific length}
669 Code for figure \ref{fig:1}:
670 \begin{lstlisting}
671 \hvFloat%
672 [floatPos=htb,
673 capPos=right,
674 objectFrame,
675 objectPos=c]{figure}{\includegraphics[scale=0.9]{images/rose}}%
676 [Caption beside object and vertically centered]%
677 {Caption vertically centered right beside the float with a natural caption width
678 (the default). \blindtext}%
679 {fig:1}
680 \end{lstlisting}
681
682 \MarginNote{Fig.~\ref{fig:1}}
683 \Float[capPos=right]
684 \hvFloat%
685 [floatPos=htb,
686 capPos=right,
687 objectFrame,
688 objectPos=c]{figure}{\includegraphics[scale=0.9]{images/rose}}%
689 [Caption beside object and vertically centered]%
690 {Caption vertically centered right beside the float with a natural caption width
691 (the default). \hvblindtext}%
692 {fig:1}
693
694
695 \subsection{Caption left and rotated}
696
697 Code for figure \ref{fig:2}:
698 \begin{lstlisting}
699 \hvFloat%
700 [floatPos=htb,
701 capPos=left,
702 capWidth=h,% of \columnwidth
703 capAngle=90,
704 objectFrame
705 ]{figure}{\includegraphics{images/rose}}%
706 [Centered Caption beside Object]%
707 {Caption vertically centered left beside the float with a caption width
708 of \texttt{capWidth=h}, which is the height of the object.}{fig:2}
709 \end{lstlisting}
710
711 \MarginNote{Fig.~\ref{fig:2}}
712 \hvFloat%
713 [floatPos=htb,
714 capPos=left,
715 capWidth=h,% of \columnwidth
716 capAngle=90,
717 objectFrame
718 ]{figure}{\includegraphics{images/rose}}%
719 [Centered Caption beside Object]%
720 {Caption vertically centered left beside the float with a caption width
721 of \texttt{capWidth=h}, which is the height of the object.}{fig:2}
722
723 It is no problem to rotate the object, too. But with a different angle value than for the caption.
724 Do not ask for the sense, it is only a demonstration of what is possible \ldots\ The object (image)
725 is rotated by $-30$ degrees with the macro \Lcs{rotatebox}. Without any definition the caption will be
726 placed vertically centered to the object. Important for the height of the object is the surrounding
727 orthogonal rectangle.
728
729
730 \hvblindtext
731
732 Code for figure \ref{fig:3}:
733 \begin{lstlisting}
734 \hvFloat[%
735 capWidth=h,
736 capPos=after,
737 capAngle=180,
738 objectAngle=90,
739 capVPos=center,
740 objectPos=center]{figure}{\frame{\includegraphics{images/rose}}}%
741 [Centered Caption beside Object]{%
742 {Caption vertically centered right beside the float with a caption width of the height
743 of the image and a rotation of the caption and the object.}{fig:3}
744 \end{lstlisting}
745
746 \MarginNote{Fig.~\ref{fig:3}}
747 \hvFloat[%
748 capWidth=h,% of \columnwidth
749 capPos=after,
750 capAngle=180,
751 objectAngle=90,
752 capVPos=center,
753 objectPos=center]{figure}{\frame{\includegraphics{images/rose}}}%
754 {Caption vertically centered right beside the float with a caption width of the height of the image and
755 a rotation of the caption and the object.}{fig:3}
756
757
758 \section{Caption inner or outer}
759 Setting the caption position to \emph{inner} or \emph{outer} makes only sense for a document in \Index{twoside} mode.
760 For a oneside document \emph{inner} is the same as \emph{left} and \emph{outer} is
761 the same as \emph{right}. We show only the code for the first image with the setting \Lkeyset{capPos=inner},
762 whereas the second one
763 chooses only \Lkeyset{capPos=outer}.
764
765
766 Code for figure~\ref{fig:20}:
767 \begin{lstlisting}
768 \hvFloat[capPos=inner]{figure}{\includegraphics{images/rose}}%
769 [Centered Caption on the inner side]{%
770 Caption set with the parameter setting \texttt{capPos=inner}, which will be
771 a caption on the right side for an even page and on the left side for
772 an odd page.}{fig:20}
773 \end{lstlisting}
774
775 \MarginNote{Fig.~\ref{fig:20}}
776 \hvFloat[capPos=inner]{figure}{\includegraphics{images/rose}}%
777 [Centered Caption on the inner side]{%
778 Caption set with the parameter setting \texttt{capPos=inner}, which will be
779 a caption on the right side for an even page and on the left side for
780 an odd page.}{fig:20}
781
782 \hvblindtext
783
784
785 \label{page:1}\checkoddpage
786 Now the same Image with \Lkeyset{capPos=outer}. The current pagenumber is~\pageref{page:1}, an \ifoddpage odd \else
787 even \fi page. We now set a pagebreak at the end of the second image to see if it works with
788 \emph{inner}/\emph{outer}.
789
790
791
792
793 \begin{lstlisting}
794 \hvFloat[capPos=outer]{figure}{\includegraphics{images/rose}}%
795 [Centered Caption on the inner side]{%
796 Caption set with the parameter setting \texttt{capPos=outer}, which will be
797 a caption on the right side for an even page and on the left side for
798 an odd page.}{fig:20b}
799 \end{lstlisting}
800
801 \MarginNote{Fig.~\ref{fig:20b}}
802 \hvFloat[capPos=outer]{figure}{\includegraphics{images/rose}}%
803 [Centered Caption on the inner side]{%
804 Caption set with the parameter setting \texttt{capPos=outer}, which will be
805 a caption on the right side for an even page and on the left side for
806 an odd page.}{fig:20b}
807
808
809
810 \MarginNote{Fig.~\ref{fig:21}}
811 \hvFloat[%
812 capWidth=0.5,% of \columnwidth
813 capPos=outer,
814 capAngle=0,%
815 capVPos=bottom,%
816 objectPos=center]{figure}{\includegraphics{images/rose}}%
817 [Centered Caption beside Object]{%
818 Caption at the bottom right beside the float with a caption width
819 of \texttt{0.5\textbackslash columnwidth} and and \texttt{capPos=outer}.}{fig:21}
820
821 We have an \checkoddpage
822 \ifoddpage odd \else
823 even \fi page, the reason why figure~\ref{fig:20b} has the caption for \emph{inner} on the left side
824 and figure~\ref{fig:21} for \emph{outer} on the right side.
825
826
827 \hvblindtext
828
829 \label{page:2}
830 Code for figure \ref{fig:22}:
831 \begin{lstlisting}
832 \hvFloat[%
833 capWidth=0.5,% of \columnwidth
834 capPos=inner,% ====> INNER
835 capAngle=0,
836 capVPos=bottom,
837 objectPos=center]{figure}{\includegraphics{images/rose}}%
838 [Centered Caption beside Object]{%
839 Caption vertically centered right beside the float with a caption
840 width of \texttt{0.5\textbackslash columnwidth} and \texttt{capPos=outer} }{fig:22}
841 \end{lstlisting}
842
843 \MarginNote{Fig.~\ref{fig:22}}
844 \hvFloat[%
845 capWidth=0.5,% of \columnwidth
846 capPos=inner,
847 capAngle=0,%
848 capVPos=center,%
849 objectPos=center]{figure}{\includegraphics{images/rose}}%
850 [Centered Caption beside Object]{%
851 Caption vertically centered right beside the float with a caption
852 width of \texttt{0.5\textbackslash columnwidth} and \texttt{capPos=outer}}{fig:22}
853
854
855
856 We have an \checkoddpage
857 \ifoddpage odd \else
858 even \fi page, the reason why figure~\ref{fig:20} has the caption for \emph{inner} on the right side
859 and figure~\ref{fig:21} for \emph{outer} on the left side.
860
861
862 \section{Vertical Position of the Caption}
863 The caption can be placed beside the object in the positions
864 \begin{verbatim}
865 (c)enter|(b)ottom|(t)op
866 \end{verbatim}
867
868 The code for figure \ref{fig:4}:
869 \begin{lstlisting}
870 \hvFloat[%
871 floatPos=htb,%
872 capWidth=0.25,%
873 capPos=right,%
874 capVPos=bottom,%
875 ]{figure}{\frame{\includegraphics{images/rose}}}{Caption at bottom right beside the float}{fig:4}
876 \end{lstlisting}
877
878
879 \MarginNote{Fig.~\ref{fig:4}}
880 \hvFloat[%
881 floatPos=htb,%
882 capWidth=0.25,%
883 capPos=right,%
884 capVPos=bottom,%
885 ]{figure}{\frame{\includegraphics{images/rose}}}{Caption at bottom right beside the float}{fig:4}
886
887
888
889 The code for figure \ref{fig:5}:
890 \begin{lstlisting}
891 \hvFloat[%
892 floatPos=htb,
893 capWidth=0.25,
894 capPos=right,
895 capVPos=top,
896 ]{figure}{\frame{\includegraphics{images/rose}}}{Caption at top left beside the float}{fig:5}
897 \end{lstlisting}
898
899
900 \MarginNote{Fig.~\ref{fig:5}}
901 \hvFloat[%
902 floatPos=htb,%
903 capWidth=0.25,%
904 capPos=before,%
905 capVPos=top,%
906 ]{figure}{\frame{\includegraphics{images/rose}}}{Caption at top left beside the float}{fig:5}
907
908
909 The code for figure \ref{fig:6}:
910 \begin{lstlisting}
911 \hvFloat[%
912 capWidth=0.25,%
913 capPos=right,%
914 capVPos=center,% the default
915 ]{figure}{\frame{\includegraphics{images/rose}}
916 \frame{\includegraphics[origin=c,angle=180]{images/rose}}}%
917 {Caption centered right beside the float}{fig:6}
918 \end{lstlisting}
919
920
921 \MarginNote{Fig.~\ref{fig:6}}
922 \hvFloat[%
923 capWidth=0.25,%
924 capPos=right,%
925 capVPos=center,% the default
926 ]{figure}{\frame{\includegraphics{images/rose}}
927 \frame{\includegraphics[origin=c,angle=180]{images/rose}}}%
928 {Caption centered right beside the float}{fig:6}
929
930
931 \section{Caption format}
932 The \Lcs{caption} and \Lcs{subcaption} macros are fully under the control of the package \Lpack{caption}.
933 The formatting can be set with the macros \Lcs{captionsetup}, \Lcs{subcaptionsetup}, or via the optional
934 argument setting of \Lcs{hvFloat} with the keywords \Lkeyword{capFormat} and \Lkeyword{subcapFormat}.
935 The argument itself will then be used internally by \Lcs{captionsetup} and/or \Lcs{subcaptionsetup}
936 in a minipage, the reason why it will be local to the current image..
937
938 \begin{lstlisting}
939 \hvFloat[%
940 capPos=right,
941 capFormat={labelsep=newline,justification=RaggedRight,font={small,it},labelfont=bf}
942 ]{figure}{\frame{\includegraphics{images/rose}}}{\blindtext}{fig:66}
943 \end{lstlisting}
944
945 \MarginNote{Fig.~\ref{fig:66}}
946 \hvFloat[%
947 capPos=right,
948 capFormat={labelsep=newline,justification=RaggedRight,font={small,it},labelfont=bf}
949 ]{figure}{\frame{\includegraphics{images/rose}}}{\hvblindtext}{fig:66}
950
951
952 \section{Horizontal Position of the Float}
953
954 The caption is always near the object, only divided by the length \Ldim{floatCapSep}
955 which can be set by the keyword of the same name \Lkeyword{floatCapSep}. It accepts only
956 a value with any allowed unit. %The default unit is \texttt{pt} and cannot be changed.
957 The keyword \Lkeyword{objectPos} refers always to the complete floating object: caption
958 \emph{and} object. The meaning of \Lkeyset{objectPos=left} is: Put the object as far as possible to the
959 left margin. If \Lkeyset{capPos=left} is also used, then the caption is at the left margin followed by
960 the object (see Figure~\vref{fig:700}).
961
962 The code for figure \ref{fig:7}:
963 \begin{lstlisting}
964 \hvFloat[%
965 capWidth=0.25,
966 capPos=right,
967 capVPos=top,
968 objectPos=left,
969 objectFrame,
970 ]{figure}{\includegraphics{images/rose}}{%
971 Caption at top right beside the float and object position left}{fig:7}
972 \end{lstlisting}
973
974
975 \MarginNote{Fig.~\ref{fig:7}}
976 \hvFloat[%
977 capWidth=0.25,%
978 capPos=right,%
979 capVPos=top,%
980 objectPos=left,%
981 objectFrame,
982 ]{figure}{\includegraphics{images/rose}}{%
983 Caption at top right beside the float and object position left}{fig:7}
984
985 \hvblindtext
986
987
988 The same with \Lkeyset{capPos=left}:
989
990
991 \MarginNote{Fig.~\ref{fig:700}}
992 \hvFloat[%
993 capWidth=0.25,%
994 capPos=left,%
995 capVPos=top,%
996 objectPos=left,%
997 objectFrame,
998 ]{figure}{\includegraphics{images/rose}}{%
999 Caption at top right beside the float and object position left}{fig:700}
1000
1001 \hvblindtext
1002
1003
1004 The code for figure \ref{fig:8}:
1005 \begin{lstlisting}
1006 \hvFloat[%
1007 capWidth=0.25,
1008 capPos=before,
1009 capVPos=top,
1010 objectPos=right,
1011 objectFrame,
1012 ]{figure}{\includegraphics{images/rose}}{%
1013 Caption at top leftt beside the float and object position right}{fig:8}
1014 \end{lstlisting}
1015
1016
1017 \MarginNote{Fig.~\ref{fig:8}}
1018 \hvFloat[%
1019 capWidth=0.25,%
1020 capPos=before,%
1021 capVPos=top,%
1022 objectPos=right,%
1023 objectFrame,
1024 ]{figure}{\includegraphics{images/rose}}{%
1025 Caption at top left beside the float and object position right}{fig:8}
1026
1027 \hvblindtext
1028
1029
1030 \section{Wide floats}
1031
1032 With the optional argument \Lkeyword{wide} the width of the defined \Ldim{marginparwidth} is
1033 added to the allowed horizontal width of the float.
1034
1035 The code for figure \ref{fig:70}:
1036 \begin{lstlisting}
1037 \hvFloat[wide,
1038 capPos=right,
1039 capVPos=top,
1040 objectPos=left,
1041 ]{figure}{\includegraphics[width=0.75\linewidth]{images/CTAN}}{%
1042 Caption at top right beside the float and object position left and
1043 the option \texttt{wide}.}{fig:70}
1044 \end{lstlisting}
1045
1046 \MarginNote{Fig.~\ref{fig:70}}
1047 \hvFloat[%
1048 wide,
1049 capPos=right,%
1050 capVPos=top,%
1051 objectPos=left,%
1052 ]{figure}{\includegraphics[width=0.75\linewidth]{images/CTAN}}{%
1053 Caption at top right beside the float and object position left and
1054 the option \texttt{wide}.}{fig:70}
1055
1056 %\hvblindtext
1057
1058
1059 The code for figure \ref{fig:80}:
1060 \begin{lstlisting}
1061 \hvFloat[wide,
1062 capPos=left,
1063 capVPos=top,
1064 objectPos=right,
1065 ]{figure}{\includegraphics[width=0.75\linewidth]{images/CTAN}}%
1066 {Caption at top left beside the object and object position left and
1067 the option \texttt{wide}.}{fig:80}
1068 \end{lstlisting}
1069
1070
1071 \MarginNote{Fig.~\ref{fig:80}}
1072 \hvFloat[wide,
1073 capPos=left,%
1074 capVPos=top,%
1075 ]{figure}{\includegraphics[width=0.75\linewidth]{images/CTAN}}%
1076 {Caption at top left beside the object and object position left and
1077 the option \texttt{wide}.}{fig:80}
1078
1079
1080 For a twosided document it will place the object always in the margin.
1081
1082 \hvblindtext
1083
1084 \begin{lstlisting}
1085 \hvFloat[wide,
1086 capPos=inner,
1087 capVPos=top,
1088 ]{figure}{\includegraphics[width=0.75\linewidth]{images/CTAN}}{%
1089 Caption at top and inner beside the float and object position right and
1090 the option \texttt{wide}.}{fig:81}
1091 \end{lstlisting}
1092
1093 \MarginNote{Fig.~\ref{fig:81}}
1094 \hvFloat[wide,
1095 capPos=inner,
1096 capVPos=top,
1097 ]{figure}{\includegraphics[width=0.75\linewidth]{images/CTAN}}{%
1098 Caption at top and inner beside the float and object position right and
1099 the option \texttt{wide}.}{fig:81}
1100
1101 Now we set the same image with the same setting on the next page. The caption will
1102 change its side due to the setting \Lkeyset{capPos=outer}.
1103
1104 \hvblindtext
1105
1106 \begin{lstlisting}
1107 \hvFloat[wide,
1108 capPos=inner,
1109 capVPos=top,
1110 ]{figure}{\includegraphics[width=0.75\linewidth]{images/CTAN}}{%
1111 Caption at top inner beside the float and object position right and
1112 the option \texttt{wide}.}{fig:811}
1113 \end{lstlisting}
1114
1115
1116 \MarginNote{Fig.~\ref{fig:811}}
1117 \hvFloat[wide,
1118 capPos=inner,
1119 capVPos=top,
1120 ]{figure}{\includegraphics[width=0.75\linewidth]{images/CTAN}}{%
1121 Caption at top inner beside the float and object position right and
1122 the option \texttt{wide}.}{fig:811}
1123
1124 The caption can be typeset completely into the margin with:
1125
1126 \begin{lstlisting}
1127 \captionsetup{justification=RaggedRight}
1128 \hvFloat[wide,
1129 capPos=outer,
1130 capVPos=top,
1131 floatCapSep=\marginparsep,
1132 ]{figure}{\includegraphics[width=\linewidth]{images/CTAN}}{%
1133 Caption at top inner beside the float and object position right and
1134 the option \texttt{wide}.}{fig:812}
1135 \end{lstlisting}
1136
1137 %\Float[capPos=outer]
1138
1139 \begingroup
1140 \MarginNote{Fig.~\ref{fig:812}}
1141 \captionsetup{justification=RaggedRight}
1142 \hvFloat[wide,
1143 capPos=outer,
1144 capVPos=top,
1145 floatCapSep=\marginparsep,
1146 ]{figure}{\includegraphics[width=\linewidth]{images/CTAN}}{%
1147 Caption at top inner beside the float and object position right and
1148 the option \texttt{wide}.}{fig:812}
1149 \endgroup
1150
1151
1152 With the optional argument \Lkeyset{capWidth=l} the caption can be terminated
1153 to the current line width. With the optional argument \Lkeyset{capHPos=right} one cat set
1154 the caption to the left, center, or right of the full width which is linewidth and margin width.
1155
1156
1157 \begin{lstlisting}
1158 \hvFloat[capPos=bottom,capWidth=l,wide,capHPos=right]{figure}
1159 {\includegraphics[width=0.49\hvWideWidth]{images/CTAN}\quad
1160 \includegraphics[width=0.49\hvWideWidth]{images/CTAN}}
1161 {\hvblindtext}
1162 {label}
1163 \end{lstlisting}
1164
1165
1166 \MarginNote{Fig.~\ref{label}}
1167 \hvFloat[capPos=bottom,capWidth=l,wide,capHPos=right]{figure}
1168 {\includegraphics[width=0.49\hvWideWidth]{images/CTAN}\quad
1169 \includegraphics[width=0.49\hvWideWidth]{images/CTAN}}
1170 {\hvblindtext}
1171 {label}
1172
1173
1174 %\hvblindtext
1175
1176 \clearpage
1177
1178 \section{Margin floats}
1179
1180 With the optional argument \Lkeyword{inMargin} the opject and the caption can be placed into
1181 the margin. This is done internally with the command \Lcs{marginnote} from the package of the same name.
1182
1183
1184
1185 %\marginnote{Fig.~\ref{rose2}}
1186 \hvFloat[inMargin]{figure}{\includegraphics[width=\marginparwidth]{images/rose2}}
1187 {An image in the margin of the document.}
1188 {rose2}
1189
1190 \begin{lstlisting}
1191 \hvFloat[inMargin]{figure}{\includegraphics[width=\marginparwidth]{images/rose2}}
1192 {An image in the margin of the document.}
1193 {rose2}
1194 ...
1195 \savebox\hvOBox{\small\begin{tabular}{@{}
1196 ccc@{}}\hline Mon& Di& Mi\\ frei & Dienst & frei\\
1197 Dienst & Dienst & Frei\\\hline \end{tabular}}
1198 \hvFloat[inMargin,useOBox]{table}{}
1199 {A tabular in the margin just like the image.}
1200 {rose2}
1201 \end{lstlisting}
1202
1203
1204 \hvblindtext
1205
1206
1207 \savebox\hvOBox{%
1208 \small\begin{tabular}{@{}ccc@{}}\hline
1209 Mon& Di& Mi\\ frei & Dienst & frei\\
1210 Dienst & Dienst & Frei\\\hline \end{tabular}%
1211 }
1212 %\marginnote{Fig.~\ref{thea2}}
1213 \hvFloat[inMargin,useOBox]{table}{}
1214 {A tabular in the margin just like the image.}
1215 {rose2}
1216
1217 The same is possible with a short tabular, dependent to the width of the margin.
1218
1219 \hvblindtext
1220
1221
1222 \section{The star version \Lcs{hvFloat*}}\label{star-version0}
1223 In the \Index{twocolumn} mode the floating environment can be set over both
1224 columns with the star version \Lcs{hvFloat*}. The floating environment will
1225 not be on the bottom of the page. The code for
1226 the following example (Figure~\vref{default1s2c}) is:
1227
1228 \begin{lstlisting}
1229 \hvFloat*[capPos=right]{figure}%
1230 {\includegraphics{images/frose}}%
1231 [A float with the default caption setting]%
1232 {A default caption of a ``'' object with the default setting, which
1233 is a ``left'' caption which means that it always appears before the object.
1234 This can be an even or odd page. And some more text which has no
1235 real meaning because it fills only the space for a long caption.}%
1236 {fig:0}
1237 \end{lstlisting}
1238
1239 The example shows on page 3 the star version and on page 4 the same without using the star.
1240
1241
1242 \begin{figure}[!h]
1243 \frame{\includegraphics[page=2,width=0.24\linewidth]{examples/default1s2c}}\hfill
1244 \frame{\includegraphics[page=3,width=0.24\linewidth]{examples/default1s2c}}\hfill
1245 \frame{\includegraphics[page=4,width=0.24\linewidth]{examples/default1s2c}}\hfill
1246 \frame{\includegraphics[page=5,width=0.24\linewidth]{examples/default1s2c}}
1247 \caption{Output of \texttt{default1s2c} (pages 2 --5)}\label{default1s2c}
1248 \end{figure}
1249
1250
1251
1252
1253 \section{Full Page Width in Landscape Mode}
1254
1255 If you do not want to load the package \Lpack{lscape} (or \Lpack{pdflscape}) you can use the \Lkeyset{floatPos=p}
1256 option to put the image on an own page and rotated by 90 degrees (figure~\ref{fig:9}).
1257
1258
1259
1260
1261 Code for figure \ref{fig:9}:
1262 \begin{lstlisting}
1263 \hvFloat[%
1264 floatPos=p,
1265 capPos=bottom,
1266 rotAngle=90,
1267 objectPos=center,
1268 ]{figure}{\includegraphics[width=0.9\textheight]{images/CTAN}}%
1269 [Object and Caption in landscape mode]{%
1270 Caption and object in landscape mode. \blindtext}{fig:9}
1271 \end{lstlisting}
1272
1273 The float can also be put to the left or to the right (above/below in landscape)
1274 with the \Lkeyset{objectPos=l} parameter
1275
1276 \MarginNote{Fig.~\ref{fig:9}}
1277 \hvFloat[%
1278 floatPos=p,
1279 capPos=bottom,
1280 rotAngle=90,
1281 objectPos=center,
1282 ]{figure}{\includegraphics[width=0.9\textheight]{images/CTAN}}%
1283 [Object and Caption in landscape mode]{%
1284 Caption and object in landscape mode. \hvblindtext}{fig:9}
1285
1286
1287 \hvblindtext
1288
1289
1290 The code for figure \ref{fig:10}:
1291 \begin{lstlisting}
1292 \hvFloat[%
1293 floatPos=p,
1294 capWidth=h,
1295 capPos=right,
1296 objectAngle=90,
1297 capAngle=-90,
1298 objectPos=left,
1299 ]{figure}{\includegraphics[width=\textheight]{images/CTAN}}%
1300 [Rotated Caption in Landscape]{%
1301 Caption right beside the float and object position left. The caption rotated by $-90$
1302 degrees.\blindtext}{fig:10}
1303 \end{lstlisting}
1304
1305 \MarginNote{Fig.~\ref{fig:10}}
1306 \hvFloat[%
1307 floatPos=p,%
1308 capWidth=h,%
1309 capPos=right,%
1310 objectAngle=90,%
1311 capAngle=-90,%
1312 objectPos=left%
1313 ]{figure}{\includegraphics[width=\textheight]{images/CTAN}}%
1314 [Rotated Caption in Landscape]{%
1315 Caption right beside the float and object position left. The caption rotated by $-90$ degrees.
1316 \hvblindtext}{fig:10}
1317
1318
1319
1320 \hvblindtext
1321
1322 \hvblindtext
1323
1324
1325
1326 \section{The \Lkeyword{nonFloat} Option}
1327 Sometimes it is better to put a ``float'' in a specific position of the page. This is possible
1328 with the \Lpack{nonfloat} package and the keyword \Lkeyword{nonFloat}.
1329
1330 \begin{lstlisting}
1331 Some nonsense text before the following \emph{non floating} object.
1332
1333 \hvFloat[%
1334 nonFloat,
1335 capWidth=0.25,
1336 capPos=right,
1337 capVPos=bottom,
1338 objectPos=center,
1339 objectFrame,
1340 ]{figure}{\includegraphics[scale=1.5]{images/rose}}%
1341 [Nonfloat Captions]{%
1342 Caption of a ``nonfloat'' Object, using the \texttt{nonfloat} Package}{fig:11}
1343
1344 Some nonsense text after the preceding \emph{non floating} object.
1345 \end{lstlisting}
1346
1347 Some nonsense text before the following \emph{non floating} object.
1348
1349 \MarginNote{Fig.~\ref{fig:11}}
1350 \hvFloat[%
1351 nonFloat,%
1352 capWidth=0.25,%
1353 capPos=right,%
1354 capVPos=bottom,%
1355 objectPos=center,%
1356 objectFrame,
1357 ]{figure}{\includegraphics[scale=1.5]{images/rose}}%
1358 [Nonfloat Captions]{%
1359 Caption of a ``nonfloat'' Object, using the \texttt{nonfloat} Package}{fig:11}
1360
1361 Some nonsense text after the preceding \emph{non floating} object.
1362
1363 \bigskip
1364 The image \ref{fig:11} is exactly placed where the command \Lcs{hvFloat} appears.
1365 There are only commands for \Lenv{figure} and \Lenv{table} environments:
1366
1367 \begin{verbatim}
1368 \newcommand{\figcaption}{\def\@captype{figure}\caption}
1369 \newcommand{\tabcaption}{\def\@captype{table}\caption}
1370 \end{verbatim}
1371
1372 But it is no problem, to define more \texttt{xxxcaption} commands to support other with the
1373 \Lpack{float} package defined new floats.
1374
1375
1376
1377
1378
1379 \section{Tabulars as Objects}\label{sec:tables}
1380 The object has to be passed as an parameter to the \Lcs{hvFloat} macro. This is no
1381 problem with images but maybe with tables, so it is easier to use the box \Lcs{hvOBox}
1382 to save the table in this box and pass it then to \Lcs{hvFloat} with the \Lkeyword{useOBox} option.
1383 For example see table~\ref{table:1} and \ref{table:2}:
1384
1385 \savebox{\hvOBox}{%
1386 \begin{tabular}{>{\small\ttfamily}l|l|l}\hline
1387 \rmfamily Name & Type & Description\\\hline
1388 \CMD{hvFloat} & command & places object and caption in different ways\\
1389 hvFloatEnv & environment & places object and caption exactly Here\\
1390 \CMD{figcaption} & command & writes a figure caption in a non floating environment\\
1391 \CMD{tabcaption} & command & writes a table caption in a non floating environment\\
1392 \CMD{hvFloatSetDefaults} & command & sets all options to the defaults\\\hline
1393 \end{tabular}%
1394 }
1395
1396 \hvblindtext
1397
1398 %[xrightmargin=-8em,xleftmargin=-1em]
1399 \begin{lstlisting}
1400 \savebox{\hvOBox}{%
1401 \begin{tabular}{>{\small\ttfamily}l|l|l}\hline
1402 \rmfamily Name & Type & Description\\\hline
1403 \CMD{hvFloat} & command & places object and caption in different ways\\
1404 hvFloatEnv & environment & places object and caption exactly Here\\
1405 \CMD{figcaption} & command & writes a figure caption in a non floating environment\\
1406 \CMD{tabcaption} & command & writes a table caption in a non floating environment\\
1407 \CMD{hvFloatSetDefaults} & command & sets all options to the defaults\\\hline
1408 \end{tabular}%
1409 }
1410 \end{lstlisting}
1411
1412 The code for table \ref{table:1} and \ref{table:2} is:
1413
1414 %[xrightmargin=-7em,xleftmargin=-3em]
1415 \begin{lstlisting}
1416 \hvFloat[%
1417 floatPos=!hb,
1418 capPos=top,
1419 useOBox]{table}{}{Demonstration of the \texttt{useOBox} Parameter}{table:1}
1420
1421 \hvblindtext
1422
1423 \MarginNote{Tab.~\ref{table:2}}
1424 \hvFloat[%
1425 floatPos=hb,
1426 useOBox=true,
1427 objectAngle=90,
1428 capPos=right,
1429 capVPos=top,
1430 capWidth=0.3]{table}{}{Another demonstration of the \texttt{useOBox} Parameter}{table:2}
1431 \end{lstlisting}
1432
1433 In this case leave the third parameter empty.
1434
1435 \MarginNote{Tab.~\ref{table:1}}
1436 \hvFloat[%
1437 floatPos=!hb,
1438 capPos=top,
1439 useOBox]{table}{}{Demonstration of the \texttt{useOBox} Parameter}{table:1}
1440
1441
1442
1443 \MarginNote{Tab.~\ref{table:2}}
1444 \hvFloat[%
1445 floatPos=!htb,%
1446 useOBox,%
1447 objectAngle=90,%
1448 capPos=right,%
1449 capVPos=top,%
1450 capWidth=0.3]{table}{}{Demonstration of the \texttt{useOBox} Parameter}{table:2}
1451
1452
1453 \section{Text and objects}\label{sec:text}
1454
1455 With the \Lkeyword{onlyText} keyword it is no problem to put some text beside an image without
1456 getting the caption title Figure/Table. The object still can be a floating one or a nonfloating
1457 if the \Lkeyword{nonfloat} keyword is used.
1458
1459 The code for figure \ref{fig:text}:
1460
1461 \begin{lstlisting}
1462 \hvFloat[%
1463 onlyText=true,
1464 capAngle=90,
1465 capPos=right,
1466 capVPos=top,
1467 objectFrame,
1468 capWidth=h]{}{\includegraphics{images/rose}}%
1469 [``\texttt{onlyText}'' Caption]{%
1470 Demonstration of the \texttt{onlyText} Parameter, which makes it
1471 possible to put some text beside a floating object without getting
1472 a starting \texttt{Figure:} or \texttt{Table:}}{fig:text}
1473 \end{lstlisting}
1474
1475
1476 \MarginNote{Fig.~\ref{fig:text}}
1477 \hvFloat[%
1478 onlyText=true,%
1479 capAngle=90,%
1480 capPos=right,%
1481 capVPos=top,%
1482 objectFrame,
1483 capWidth=h]{}{\includegraphics{images/rose}}%
1484 [``\texttt{onlyText}'' Caption]{%
1485 Demonstration of the \texttt{onlyText} Parameter, which makes it
1486 possible to put some text beside a floating object without getting
1487 a starting \texttt{Figure:} or \texttt{Table:}}{fig:text}
1488
1489 \bigskip
1490 %\hvblindtext
1491
1492 %\hvblindtext
1493
1494 \section{Environment \texttt{hvFloatEnv}}\label{sec:env}
1495
1496 With the environment \Lenv{hvFloatEnv} one can place an object exactly on that position where the
1497 environment is defined. For captions the use of \Lcs{captionof} is recommended:
1498
1499 \begin{lstlisting}
1500 \begin{hvFloatEnv}
1501 \captionof{table}{A caption for a nice table}
1502 \begin{tabular}{@{} l c r @{}}\hline
1503 left & center & right \\
1504 L & C & R \\\hline
1505 \end{tabular}
1506 \end{hvFloatEnv}
1507 \end{lstlisting}
1508
1509 \begin{hvFloatEnv}
1510 \captionof{table}{A caption for a nice table}
1511 \begin{tabular}{@{} l c r @{}}\hline
1512 left & center & right \\
1513 L & C & R \\\hline
1514 \end{tabular}
1515 \end{hvFloatEnv}
1516
1517
1518 \bigskip
1519 The environment has an optional argument for setting the line width which is preset to \Ldim{textwidth}.
1520 The object is always centered.
1521
1522
1523 \begin{lstlisting}
1524 \begin{hvFloatEnv}[0.5\textwidth]
1525 \captionof{table}{A caption for a nice table}
1526 \begin{tabular}{@{} l c r @{}}\hline
1527 left & center & right \\
1528 L & C & R \\\hline
1529 \end{tabular}
1530 \end{hvFloatEnv}
1531 \end{lstlisting}
1532
1533
1534 \begin{hvFloatEnv}[0.5\textwidth]
1535 \captionof{table}{A caption for a nice table}
1536 \begin{tabular}{@{} l c r @{}}\hline
1537 left & center & right \\
1538 L & C & R \\\hline
1539 \end{tabular}
1540 \end{hvFloatEnv}
1541
1542 %\bigskip
1543 %\hvblindtext
1544
1545 %\hvblindtext
1546
1547
1548 \section{Full page objects in onecolumn mode}
1549 For an image or table which needs the whole space of a page the caption can be
1550 printed at the bottom of the preceeding or following page. It is possible in
1551 oneside and twoside mode, but makes only real sense in the twoside mode.
1552 %
1553 \Lpack{hvfloat} defines three additional optional arguments for placing
1554 images in a complete column, page or paper:
1555
1556 \noindent
1557 \minipage[t]{0.49\linewidth}
1558 \begin{verbatim}
1559 \define@key{Gin}{fullpage}[true]{%
1560 \def\Gin@ewidth{\columnwidth}%
1561 \def\Gin@eheight{\textheight}%
1562 \Gin@boolkey{false}{iso}%
1563 }
1564 \define@key{Gin}{FULLPAGE}[true]{%
1565 \def\Gin@ewidth{\paperwidth}%
1566 \def\Gin@eheight{\paperheight}%
1567 \Gin@boolkey{false}{iso}%
1568 }
1569 \end{verbatim}
1570 \endminipage\hfill
1571 \minipage[t]{0.49\linewidth}
1572 \begin{verbatim}
1573 \define@key{Gin}{FullPage}[true]{%
1574 \def\Gin@ewidth{\textwidth}%
1575 \def\Gin@eheight{\textheight}%
1576 \Gin@boolkey{false}{iso}%
1577 }
1578 \end{verbatim}
1579 \endminipage
1580
1581 Figure~\vref{fig:fullpage60} shows the meaning of the optional arguments \Lkeyword{fullpage},
1582 \Lkeyword{FullPage}, and \Lkeyword{FULLPAGE} for \Lcs{inclugegraphics}\OptArg{...}\Largb{tiger}.
1583
1584 \begin{figure}[!h]
1585 \frame{\includegraphics[page=1,width=0.24\linewidth]{examples/fullpage1s2c}}\hfill
1586 \frame{\includegraphics[page=2,width=0.24\linewidth]{examples/fullpage1s2c}}\hfill
1587 \frame{\includegraphics[page=3,width=0.24\linewidth]{examples/fullpage1s2c}}\hfill
1588 \frame{\includegraphics[page=4,width=0.24\linewidth]{examples/fullpage1s2c}}
1589
1590 \frame{\includegraphics[page=5,width=0.24\linewidth]{examples/fullpage1s2c}}\hfill
1591 \frame{\includegraphics[page=6,width=0.24\linewidth]{examples/fullpage1s2c}}\hfill
1592 \frame{\includegraphics[page=7,width=0.24\linewidth]{examples/fullpage1s2c}}\hfill
1593 \frame{\includegraphics[page=8,width=0.24\linewidth]{examples/fullpage1s2c}}
1594 \caption{Output of \texttt{fullpage1s2c} (pages 1--8)}\label{fig:fullpage60}
1595 \end{figure}
1596
1597
1598
1599
1600
1601 \subsection{Using the textarea}
1602
1603 The setting \Lkeyset{capPos=evenPage} (even) or \Lkeyset{capPos=oddPage} (odd) page for
1604 a document in \Index{twocolumn} mode makes no real sense. For a twosided document a
1605 setting like \Lkeyset{capPos=inner} for inner or \Lkeyset{capPos=outer} for outer
1606 margin makes more sense.
1607 %
1608 For an image or table which needs the whole space of a page the caption can be
1609 printed at the bottom of the preceeding or following page. It is possible in
1610 oneside and twoside mode, but makes only real sense in the twoside mode.
1611 Without any additional argument the caption is set first and the object on the follwing page:
1612
1613
1614
1615 \subsubsection{Using the default or \Lkeyset{capPos=before}}
1616
1617 Without any additional argument the caption is set first (left) at the bottom of the current page
1618 and the object on the following page. This is the same setting like \Lkeyset{capPos=left} for a onecolumn document.
1619 For the \Loption{twocolumn} option it makes more sense to use the setting \Lkeyset{capPos=before} if the
1620 caption and object can appear on different pages.
1621
1622
1623
1624
1625 \begin{lstlisting}
1626 \hvFloat[fullpage]%
1627 {figure}%
1628 {\includegraphics[fullpage]{images/frose}}%
1629 [A fullpage float with the default caption setting]%
1630 {A default caption of a ``fullpage'' object with the default setting, which
1631 is a ``left'' caption which means that it always appears ``before'' the object.
1632 This can be an even or odd page. And some more text which has no
1633 real meaning because it fills only the space for a long caption.}%
1634 {fig:fullpage0}
1635 \end{lstlisting}
1636
1637
1638
1639
1640
1641
1642 \begin{table}[!h]
1643 \caption{Valid optional arguments for a full page object.}\label{tab:fullpage}
1644 \centering
1645 \begin{tabularx}{\linewidth}{>{\small\ttfamily}l|>{\small\ttfamily}l|X}\toprule
1646 \rmfamily Name & \rmfamily Type & Description\\\midrule
1647 \Lkeyword{fullpage} & true|false & Put the caption on the bottom of the preceding or following page and the object alone a page.\\
1648
1649 %\Lkeyword{FullPage} & true|false & The same for \Index{twocolumn} mode with object over both columns.\\
1650
1651 \Lkeyword{FULLPAGE} & true|false & The same for full papersize objects over one or two columns.
1652 The pagestyle is set to \texttt{empty}\\
1653
1654 \Lkeyword{multiFloat} & true|false & For multiple objects with captions for every object. See section~\vref{sec:multifloats}.\\
1655
1656 \Lkeyword{subFloat} & true|false & For multiple objects with one main and more subcaptions. See section~\vref{sec:subfloats}.\\
1657
1658 \Lkeyword{separatorLine} & true & Put a line with a predefined width of 0.4pt between
1659 the text and the caption. Only valid for the keyword \Lkeyword{fullpage}.\\
1660 \Lkeyword{capPos} & value
1661 & caption \Lkeyval{before}, \Lkeyval{after} an object or on an
1662 \Lkeyval{evenPage} or \Lkeyval{oddPage}.\\
1663 \bottomrule
1664 \end{tabularx}%
1665 \end{table}
1666
1667
1668
1669
1670 With this setting the caption is always placed \textit{before} the following object.
1671 This maybe sufficient for a \Index{oneside} document but not the best solution if
1672 this document is printed on a duplex machine. In such a case
1673 it may make sense to have the captions always on an even (left) page, even though the
1674 socument is typeset in a oneside mode. Figure~\vref{fig:fullpage0} shows the output
1675 for a oneside document with a setting \Lkeyset{capPos=before}.
1676
1677
1678
1679 Depending to the
1680 used documentclass it can be a problem, if the caption should be placed on the first page.
1681 In such a case use one of the other setting.
1682 Table~\vref{tab:fullpage} shows the valid optional arguments for a full page floating object.
1683
1684
1685
1686
1687 \begin{figure}[!h]
1688 \frame{\includegraphics[page=2,width=0.24\linewidth]{examples/default1s1c}}\hfill
1689 \frame{\includegraphics[page=3,width=0.24\linewidth]{examples/default1s1c}}\hfill
1690 \frame{\includegraphics[page=4,width=0.24\linewidth]{examples/default1s1c}}\hfill
1691 \frame{\includegraphics[page=5,width=0.24\linewidth]{examples/default1s1c}}
1692
1693 \frame{\includegraphics[page=6,width=0.24\linewidth]{examples/default1s1c}}\hfill
1694 \frame{\includegraphics[page=7,width=0.24\linewidth]{examples/default1s1c}}\hfill
1695 \frame{\includegraphics[page=8,width=0.24\linewidth]{examples/default1s1c}}\hfill
1696 \frame{\includegraphics[page=9,width=0.24\linewidth]{examples/default1s1c}}
1697 \caption{Output of \texttt{default1s1c} (pages 2--9)}\label{fig:fullpage0}
1698 \end{figure}
1699
1700
1701
1702
1703
1704
1705 %\FloatBarrier
1706
1707 \clearpage
1708
1709 \subsubsection{Using \Lkeyset{capPos=after}}
1710
1711 The caption will be printed always on the right side which is the same as \textit{after} the full page object.
1712 The object appers immediately on the next page and the caption of the next following page at the bottom. There
1713 is no check for an even or odd page. This behaviour makes only sense for a oneside document.
1714
1715 \begin{lstlisting}
1716 \hvFloat[fullpage, capPos=after]%
1717 {figure}%
1718 {\includegraphics[fullpage]{images/frose}}%
1719 [A float which needs the complete page width and height.]%
1720 {A Caption of a ``fullpage'' object, which follows on the next page.
1721 This can be an even or odd page. And some more text which has no
1722 real meaning because it fills only the space for a long caption.}
1723 {fig:fullpage1}
1724 \end{lstlisting}
1725
1726
1727
1728 \begin{figure}[!h]
1729 \frame{\includegraphics[page=2,width=0.24\linewidth]{examples/after1s1c}}\hfill
1730 \frame{\includegraphics[page=3,width=0.24\linewidth]{examples/after1s1c}}\hfill
1731 \frame{\includegraphics[page=4,width=0.24\linewidth]{examples/after1s1c}}\hfill
1732 \frame{\includegraphics[page=5,width=0.24\linewidth]{examples/after1s1c}}
1733
1734 \frame{\includegraphics[page=6,width=0.24\linewidth]{examples/after1s1c}}\hfill
1735 \frame{\includegraphics[page=7,width=0.24\linewidth]{examples/after1s1c}}\hfill
1736 \frame{\includegraphics[page=8,width=0.24\linewidth]{examples/after1s1c}}\hfill
1737 \frame{\includegraphics[page=9,width=0.24\linewidth]{examples/after1s1c}}
1738 \caption{Output of \texttt{after1s1c} (pages 2--9)}\label{after1s1c}
1739 \end{figure}
1740
1741
1742 %\FloatBarrier
1743
1744 \clearpage
1745
1746 \subsubsection{Using \Lkeyset{capPos=evenPage} --- caption on an even page}
1747
1748 With \Lkeyset{capPos=evenPage} the caption will be printed on an even (left) page,
1749 the object will always be on an odd (right) page.
1750 This option makes only real sense for The \Loption{twoside} mode!
1751
1752
1753 \begin{lstlisting}
1754 \hvFloat[fullpage, capPos=evenPage]%
1755 {figure}%
1756 {\includegraphics[fullpage]{images/frose}}%
1757 [A float whith a caption on an even page (left)]%
1758 {A caption on an even (left) page of a ``fullpage'' object.. \blindtext}
1759 {fig:fullpage3}
1760 \end{lstlisting}
1761
1762
1763 \begin{figure}[!h]
1764 \frame{\includegraphics[page=2,width=0.24\linewidth]{examples/even1s1c}}\hfill
1765 \frame{\includegraphics[page=3,width=0.24\linewidth]{examples/even1s1c}}\hfill
1766 \frame{\includegraphics[page=4,width=0.24\linewidth]{examples/even1s1c}}\hfill
1767 \frame{\includegraphics[page=5,width=0.24\linewidth]{examples/even1s1c}}
1768
1769 \frame{\includegraphics[page=6,width=0.24\linewidth]{examples/even1s1c}}\hfill
1770 \frame{\includegraphics[page=7,width=0.24\linewidth]{examples/even1s1c}}\hfill
1771 \frame{\includegraphics[page=8,width=0.24\linewidth]{examples/even1s1c}}\hfill
1772 \frame{\includegraphics[page=9,width=0.24\linewidth]{examples/even1s1c}}
1773 \caption{Output of \texttt{even1s1c} (pages 2--9)}\label{fig:fullpage6}
1774
1775 \end{figure}
1776
1777
1778 %\FloatBarrier
1779 \clearpage
1780
1781
1782 \subsubsection{Using \Lkeyset{capPos=oddPage} --- caption on an odd page}
1783
1784 With \Lkeyset{capPos=oddPage} the caption will be printed on an odd (right) page, the object will always be on an even (left) page,
1785 which is before the caption.
1786 %This option makes only sense for The \Loption{twoside} mode!
1787
1788
1789 \begin{lstlisting}
1790 \hvFloat[fullpage, capPos=oddPage]%
1791 {figure}%
1792 {\includegraphics[fullpage]{images/frose}}%
1793 [A float which needs the complete page width and height.]%
1794 {A Caption on an odd page of a ``fullpage'' object, which follows on the next page.
1795 This can be an even or odd page. And some more text which has no
1796 real meaning because it fills only the space for a long caption.}
1797 {fig:fullpage2}
1798 \end{lstlisting}
1799
1800
1801
1802 \begin{figure}[!h]
1803 \frame{\includegraphics[page=2,width=0.24\linewidth]{examples/odd1s1c}}\hfill
1804 \frame{\includegraphics[page=3,width=0.24\linewidth]{examples/odd1s1c}}\hfill
1805 \frame{\includegraphics[page=4,width=0.24\linewidth]{examples/odd1s1c}}\hfill
1806 \frame{\includegraphics[page=5,width=0.24\linewidth]{examples/odd1s1c}}
1807
1808 \frame{\includegraphics[page=6,width=0.24\linewidth]{examples/odd1s1c}}\hfill
1809 \frame{\includegraphics[page=7,width=0.24\linewidth]{examples/odd1s1c}}\hfill
1810 \frame{\includegraphics[page=8,width=0.24\linewidth]{examples/odd1s1c}}\hfill
1811 \frame{\includegraphics[page=9,width=0.24\linewidth]{examples/odd1s1c}}
1812 \caption{Output of \texttt{odd1s1c} (pages 2--9)}\label{fig:fullpage10}
1813 \end{figure}
1814
1815 \iffalse
1816 \begin{figure}
1817 \frame{\includegraphics[page=4,width=0.24\linewidth]{examples/odd2s1c}}\hfill
1818 \frame{\includegraphics[page=5,width=0.24\linewidth]{examples/odd2s1c}}\hfill
1819 \frame{\includegraphics[page=6,width=0.24\linewidth]{examples/odd2s1c}}\hfill
1820 \frame{\includegraphics[page=7,width=0.24\linewidth]{examples/odd2s1c}}
1821
1822 \frame{\includegraphics[page=8,width=0.24\linewidth]{examples/odd2s1c}}\hfill
1823 \frame{\includegraphics[page=9,width=0.24\linewidth]{examples/odd2s1c}}\hfill
1824 \frame{\includegraphics[page=10,width=0.24\linewidth]{examples/odd2s1c}}\hfill
1825 \frame{\includegraphics[page=11,width=0.24\linewidth]{examples/odd2s1c}}
1826 \caption{Output of \texttt{odd2s1c} (pages 4--11)}\label{fig:fullpage12}
1827 \end{figure}
1828 \fi
1829
1830
1831
1832
1833 \FloatBarrier
1834
1835
1836 \subsubsection{Using \Lkeyset{capPos=inner} or \Lkeyset{capPos=outer}--- caption on the inner or outer side}
1837
1838 These settings make no sense in \Index{onecolumn} mode.
1839
1840
1841 \clearpage
1842
1843
1844
1845
1846 \subsection{Using the paper size}
1847
1848 It belongs to the user to create an object which fills the complete page. However, with the
1849 keyword \Lkeyword{FULLPAGE} which is valis for \Lcs{hvfloat} \emph{and}
1850 for the macro \Lcs{includegraphics} an image will be scaled to
1851 the paper dimensions \Ldim{paperwidth} and
1852 \Ldim{paperheight}. It can be used in one- and twocolumn mode!
1853
1854 \begin{lstlisting}
1855 \hvFloat[FULLPAGE]%
1856 {figure}%
1857 {\includegraphics[FULLPAGE]{frose.png}}%
1858 [A fullpage float with the default caption setting]%
1859 {A default caption of a ``fullpage'' object with the default setting, which
1860 is a ``left'' caption which means that it always appears before the object.
1861 This can be an even or odd page. And some more text which has no
1862 real meaning because it fills only the space for a long caption.}%
1863 {fig:fullpage0}
1864 \end{lstlisting}
1865
1866
1867
1868 \begin{figure}[!h]
1869 \frame{\includegraphics[page=2,width=0.24\linewidth]{examples/paper-default1s1c}}\hfill
1870 \frame{\includegraphics[page=3,width=0.24\linewidth]{examples/paper-default1s1c}}\hfill
1871 \frame{\includegraphics[page=4,width=0.24\linewidth]{examples/paper-default1s1c}}\hfill
1872 \frame{\includegraphics[page=5,width=0.24\linewidth]{examples/paper-default1s1c}}
1873
1874 \frame{\includegraphics[page=6,width=0.24\linewidth]{examples/paper-default1s1c}}\hfill
1875 \frame{\includegraphics[page=7,width=0.24\linewidth]{examples/paper-default1s1c}}\hfill
1876 \frame{\includegraphics[page=8,width=0.24\linewidth]{examples/paper-default1s1c}}\hfill
1877 \frame{\includegraphics[page=9,width=0.24\linewidth]{examples/paper-default1s1c}}
1878 %\frame{\includegraphics[page=10,width=0.24\linewidth]{examples/paper-default1s1c}}
1879 \caption{Output of \texttt{paper-default1s1c} (pages 2--9)}\label{paper-default1s1c}
1880 \end{figure}
1881
1882 \begin{figure}[!h]
1883 \frame{\includegraphics[page=2,width=0.24\linewidth]{examples/paper-after1s1c}}\hfill
1884 \frame{\includegraphics[page=3,width=0.24\linewidth]{examples/paper-after1s1c}}\hfill
1885 \frame{\includegraphics[page=4,width=0.24\linewidth]{examples/paper-after1s1c}}\hfill
1886 \frame{\includegraphics[page=5,width=0.24\linewidth]{examples/paper-after1s1c}}
1887
1888 \frame{\includegraphics[page=6,width=0.24\linewidth]{examples/paper-after1s1c}}\hfill
1889 \frame{\includegraphics[page=7,width=0.24\linewidth]{examples/paper-after1s1c}}\hfill
1890 \frame{\includegraphics[page=8,width=0.24\linewidth]{examples/paper-after1s1c}}\hfill
1891 \frame{\includegraphics[page=9,width=0.24\linewidth]{examples/paper-after1s1c}}
1892 %\frame{\includegraphics[page=10,width=0.24\linewidth]{examples/paper-after1s1c}}
1893 \caption{Output of \texttt{paper-after1s1c} (pages 2--9)}\label{paper-after1s1c}
1894 \end{figure}
1895
1896
1897 \FloatBarrier
1898
1899
1900 \clearpage
1901
1902
1903 \subsection{Multifloats}\label{sec:multifloats}
1904 Multifloats is the name for more than one image and/or tabular in \emph{one} floating
1905 environment. Every image and/or tabular has its own caption, which is different to
1906 a subcaption. The syntax for multiple floats is
1907
1908 \begin{BDef}
1909 \Lcs{hvFloat}\OptArgs&+\Largb{float type}\Largb{floating object}\OptArg{short caption}\Largb{long caption}\Largb{label}\\
1910 &+\Largb{float type}\Largb{floating object}\OptArg{short caption}\Largb{long caption}\Largb{label}\\
1911 &+\ldots\\
1912 &+\Largb{float type}\Largb{floating object}\OptArg{short caption}\Largb{long caption}\Largb{label}
1913 \end{BDef}
1914
1915 The + symbol defines an additional Object which will be part of the same floating environment.
1916 It's up too the user to be sure that one page or one column can hold all defined objects.
1917 Every object gets its own caption which is the reason why figures and tabulars and \ldots\
1918 can be mixed:
1919
1920 \begin{lstlisting}
1921 \captionsetup{singlelinecheck=false}
1922 \hvFloat[fullpage,capPos=before,multiFloat,vFill]%
1923 +{figure}{\includegraphics[width=\linewidth]{images/CTAN}}%% no 1
1924 [Short caption A]%
1925 {A Caption A of a ``fullpage'' object, which follows on the left or
1926 right column. This can be an even or odd page. And some more text which has no
1927 real meaning because it fills only the space for a long caption.}%
1928 {img:demo0}%
1929 +{table}{\begin{tabular}{lrcp{3cm}}\hline % no 2
1930 Linksbündig & Rechtsbündig & Zentriert & Parbox\\\hline
1931 L & R & C & P\\
1932 left & right & center & Text with possible linebreaks\\
1933 \multicolumn{4}{c}{Multicolumn over all columns}\\\hline
1934 \end{tabular}}%
1935 [Short Caption B]%
1936 {A Caption B of a ``fullpage'' object, which follows on the left or
1937 right column. This can be an even or odd page.}{}%
1938 +{figure}{\includegraphics[width=\linewidth]{images/CTAN}}%% no 3
1939 {A Caption C of a ``fullpage'' object, which follows on the left or
1940 right column.}%
1941 {img:demo1}
1942 +{figure}{\includegraphics[width=\linewidth]{images/CTAN}}%% no 4
1943 {A Caption C of a ``fullpage'' object, which follows on the left or
1944 right column.}%
1945 {img:demo2}
1946 \end{lstlisting}
1947
1948
1949 \begin{figure}[!h]
1950 \frame{\includegraphics[page=4,width=0.24\linewidth]{examples/multi-default1s1c}}\hfill
1951 \frame{\includegraphics[page=5,width=0.24\linewidth]{examples/multi-default1s1c}}\hfill
1952 \frame{\includegraphics[page=6,width=0.24\linewidth]{examples/multi-default1s1c}}\hfill
1953 \frame{\includegraphics[page=7,width=0.24\linewidth]{examples/multi-default1s1c}}
1954
1955 \frame{\includegraphics[page=8,width=0.24\linewidth]{examples/multi-default1s1c}}\hfill
1956 \frame{\includegraphics[page=9,width=0.24\linewidth]{examples/multi-default1s1c}}\hfill
1957 \frame{\includegraphics[page=10,width=0.24\linewidth]{examples/multi-default1s1c}}\hfill
1958 \frame{\includegraphics[page=11,width=0.24\linewidth]{examples/multi-default1s1c}}
1959 \caption{Output of \texttt{multi-default1s1c} (pages 4--11)}\label{multi-default1s1c}
1960 \end{figure}
1961
1962 \begin{figure}[!h]
1963 \frame{\includegraphics[page=4,width=0.24\linewidth]{examples/multi-after1s1c}}\hfill
1964 \frame{\includegraphics[page=5,width=0.24\linewidth]{examples/multi-after1s1c}}\hfill
1965 \frame{\includegraphics[page=6,width=0.24\linewidth]{examples/multi-after1s1c}}\hfill
1966 \frame{\includegraphics[page=7,width=0.24\linewidth]{examples/multi-after1s1c}}
1967
1968 \frame{\includegraphics[page=8,width=0.24\linewidth]{examples/multi-after1s1c}}\hfill
1969 \frame{\includegraphics[page=9,width=0.24\linewidth]{examples/multi-after1s1c}}\hfill
1970 \frame{\includegraphics[page=10,width=0.24\linewidth]{examples/multi-after1s1c}}\hfill
1971 \frame{\includegraphics[page=11,width=0.24\linewidth]{examples/multi-after1s1c}}
1972 %\frame{\includegraphics[page=10,width=0.24\linewidth]{examples/odd1s2c}}
1973 \caption{Output of \texttt{multi-after1s1c} (pages 4--11)}\label{multi-after1s1c}
1974 \end{figure}
1975
1976
1977
1978
1979
1980 The page with the objects has no additional informations it holds only the figures and/or tabulars.
1981 If you want it like subfigures or subtabulars then go to section~\vref{sec:subfloats}. The setting
1982 \Lcs{captionsetup}\Largb{\Lkeyset{singlelinecheck=false}} is needed if you want the captions always
1983 left aligned.
1984
1985
1986 \FloatBarrier
1987
1988
1989 \section{Subfloat page}\label{sec:subfloats}
1990 A subfloat page can have only one type of floats which will have one main caption and
1991 individual subcaptions. The syntax is similiar to the one for a multifloat page:
1992
1993
1994 \begin{BDef}
1995 \Lcs{hvFloat}\OptArgs&+\Largb{float type}\Largb{<empty>}\OptArg{short caption}\Largb{long caption}\Largb{label}\\
1996 &+\Largb{<empty>}\Largb{floating object}\OptArg{short caption}\Largb{long caption}\Largb{label}\\
1997 &+\ldots\\
1998 &+\Largb{<empty>}\Largb{floating object}\OptArg{short caption}\Largb{long caption}\Largb{label}
1999 \end{BDef}
2000
2001 Some arguments are ignored for a subfloat, one can leave them empty. The first line defines only the type and the main caption,
2002 the object entry is ignored! All aditional lines will have the same float type, the reason why the
2003 float type entry is ignored.
2004
2005
2006 \begin{lstlisting}
2007 \hvFloat[fullpage,capPos=before,objectFrame,subFloat,vFill]%
2008 +{figure}{}[Short main caption of the objects]% main short lsi entry
2009 {The main caption of a ``fullpage'' object, which follows on the left or
2010 right column. This can be an even or odd page. And some more text which has no
2011 real meaning because it fills only the space for a long caption.}% main caption
2012 {sub:demo0}%
2013 +{}{\includegraphics[width=\linewidth]{images/CTAN}}%
2014 [Short caption B]%
2015 {A Caption B of a ``fullpage'' sub object.}% subcaption
2016 {}%
2017 +{}{\includegraphics[width=\linewidth]{images/CTAN}}%
2018 {A Caption C of a ``fullpage'' object, which follows on the left or right column.}%
2019 {sub:demo1}
2020 +{}{\includegraphics[width=\linewidth]{images/CTAN}}%
2021 {A Caption D of a ``fullpage'' object}{sub:demo2}
2022 +{}{\includegraphics[width=\linewidth]{images/CTAN}}%
2023 {A Caption E of a ``fullpage'' object}{sub:demo3}
2024 \end{lstlisting}
2025
2026
2027 The keyword \Lkeyword{subFloat} defines the images or tabulars as subfloats.
2028 The package \Lpack{subcaption} is loaded by default and should be activated with
2029 \Lcs{captionsetup}\Largs{sub}\Largs{\Lkeyword{singlelinecheck}}.
2030
2031
2032
2033 \begin{figure}[!htb]
2034 \frame{\includegraphics[page=4,width=0.24\linewidth]{examples/sub-default1s1c}}\hfill
2035 \frame{\includegraphics[page=5,width=0.24\linewidth]{examples/sub-default1s1c}}\hfill
2036 \frame{\includegraphics[page=6,width=0.24\linewidth]{examples/sub-default1s1c}}\hfill
2037 \frame{\includegraphics[page=7,width=0.24\linewidth]{examples/sub-default1s1c}}
2038
2039 \frame{\includegraphics[page=8,width=0.24\linewidth]{examples/sub-default1s1c}}\hfill
2040 \frame{\includegraphics[page=9,width=0.24\linewidth]{examples/sub-default1s1c}}\hfill
2041 \frame{\includegraphics[page=10,width=0.24\linewidth]{examples/sub-default1s1c}}\hfill
2042 \frame{\includegraphics[page=11,width=0.24\linewidth]{examples/sub-default1s1c}}
2043 \caption{Output of \texttt{sub-default1s1c} (pages 4--11)}\label{sub-default1s1c}
2044 \end{figure}
2045
2046 \begin{figure}[!htb]
2047 \frame{\includegraphics[page=4,width=0.24\linewidth]{examples/sub-after1s1c}}\hfill
2048 \frame{\includegraphics[page=5,width=0.24\linewidth]{examples/sub-after1s1c}}\hfill
2049 \frame{\includegraphics[page=6,width=0.24\linewidth]{examples/sub-after1s1c}}\hfill
2050 \frame{\includegraphics[page=7,width=0.24\linewidth]{examples/sub-after1s1c}}
2051
2052 \frame{\includegraphics[page=8,width=0.24\linewidth]{examples/sub-after1s1c}}\hfill
2053 \frame{\includegraphics[page=9,width=0.24\linewidth]{examples/sub-after1s1c}}\hfill
2054 \frame{\includegraphics[page=10,width=0.24\linewidth]{examples/sub-after1s1c}}\hfill
2055 \frame{\includegraphics[page=11,width=0.24\linewidth]{examples/sub-after1s1c}}
2056 %\frame{\includegraphics[page=10,width=0.24\linewidth]{examples/odd1s2c}}
2057 \caption{Output of \texttt{sub-after1s1c} (pages 4--11)}\label{sub-after1s1c}
2058 \end{figure}
2059
2060
2061
2062 \FloatBarrier
2063
2064
2065
2066 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2067
2068
2069 %\twocolumn[
2070 \section{Full page objects in twocolumn mode}%]
2071
2072 The filenames always have a ``2c'' for two columns in its names, e.g. \texttt{left2s2c}
2073 indicates \Lkeyset{capPos=before} and the documentclass setting \Loption{twoside} and \Loption{twocolumn}.
2074 Depending to the
2075 used documentclass it can be a problem, if the caption should be placed on the first page of the whole document.
2076 In such a case use one of the other setting.
2077 Table~\vref{tab:fullpage} shows the valid optional arguments for a full page floating object.
2078 %In the following we use some blind text to show the other setting for full page objects.
2079 %Such text has no meaning here.
2080
2081
2082
2083 \subsection{Default setting}
2084
2085 For the \Index{twocolumn} mode the caption can be in the left (first) or right (second) column.
2086 With the default setting (without using the keyword \Lkeyword{capPos})
2087 it is equivalent to the setting \Lkeyset{capPos=before}, the caption is always placed \emph{before} (left of)
2088 the object. This can be the first or the second column and both can be on different pages.
2089 With \Lkeyset{capPos=before} (uppercase L) it is possible to get the caption and the object in the twocolumn mode always on one page.
2090 This is then the left (first) column for the caption (see figure~\vref{default2s2c}).
2091
2092
2093
2094
2095 \begin{figure}[!h]
2096 %\frame{\includegraphics[page=1,width=0.24\linewidth]{examples/default2s2c}}\hfill
2097 \frame{\includegraphics[page=2,width=0.24\linewidth]{examples/default2s2c}}\hfill
2098 \frame{\includegraphics[page=3,width=0.24\linewidth]{examples/default2s2c}}\hfill
2099 \frame{\includegraphics[page=4,width=0.24\linewidth]{examples/default2s2c}}\hfill
2100 \frame{\includegraphics[page=5,width=0.24\linewidth]{examples/default2s2c}}
2101
2102 \frame{\includegraphics[page=6,width=0.24\linewidth]{examples/default2s2c}}\hfill
2103 \frame{\includegraphics[page=7,width=0.24\linewidth]{examples/default2s2c}}\hfill
2104 \frame{\includegraphics[page=8,width=0.24\linewidth]{examples/default2s2c}}\hfill
2105 \frame{\includegraphics[page=9,width=0.24\linewidth]{examples/default2s2c}}
2106 \caption{Output of \texttt{default2s2c} (pages 2--9)}\label{default2s2c}
2107 \end{figure}
2108
2109
2110 \FloatBarrier
2111
2112
2113 \begin{lstlisting}
2114 \hvFloat[fullpage]{figure}%
2115 {\includegraphics[width=\columnwidth,height=0.9\textheight]{images/frose}}%
2116 [A float which needs the complete column width and height.]%
2117 {A Caption of a ``fullpage'' object, which follows on the next column.
2118 This is always the right column on an even or odd page. And some more
2119 text which has no real meaning because it fills only the space for a long
2120 caption.}%
2121 {fig:fullpage0-2}
2122 \end{lstlisting}
2123
2124
2125
2126 The example~\vref{default2s2c} shows that the caption and the object can be on different
2127 pages. If you do not like this behaviour, then use the setting \Lkeyset{capPos=left}, which puts
2128 the caption before the object, but always on the \emph{same page} (see Figure~\vref{left2s2c}).
2129
2130
2131 \begin{figure}[!h]
2132 %\frame{\includegraphics[page=1,width=0.24\linewidth]{examples/right2s2c}}\hfill
2133 \frame{\includegraphics[page=2,width=0.24\linewidth]{examples/left2s2c}}\hfill
2134 \frame{\includegraphics[page=3,width=0.24\linewidth]{examples/left2s2c}}\hfill
2135 \frame{\includegraphics[page=4,width=0.24\linewidth]{examples/left2s2c}}\hfill
2136 \frame{\includegraphics[page=5,width=0.24\linewidth]{examples/left2s2c}}
2137
2138 \frame{\includegraphics[page=6,width=0.24\linewidth]{examples/left2s2c}}\hfill
2139 \frame{\includegraphics[page=7,width=0.24\linewidth]{examples/left2s2c}}\hfill
2140 \frame{\includegraphics[page=8,width=0.24\linewidth]{examples/left2s2c}}\hfill
2141 \frame{\includegraphics[page=9,width=0.24\linewidth]{examples/left2s2c}}
2142 \caption{Output of \texttt{left2s2c} (pages 2--9)}\label{left2s2c}
2143 \end{figure}
2144
2145
2146
2147
2148 \subsubsection{Using \Lkeyset{capPos=after}}
2149
2150 The caption will be printed always right of the object which is the same as \textit{after} the full page object.
2151 With \Lkeyset{capPos=after} it is possible to get the caption in the twocolumn mode always in
2152 the right (second) column (see figure~\vref{right2s2c})
2153
2154 \begin{lstlisting}
2155 \hvFloat[fullpage, capPos=after]{figure}%
2156 {\includegraphics[fullpage]{images/rose}}%
2157 [A float which needs the complete column width and height.]%
2158 {A Caption of a ``fullpage'' object, which is on the left column.
2159 This is always the right column on an even or odd page. And some more
2160 text which has no real meaning because it fills only the space for a long
2161 caption.}%
2162 {fig:fullpage1-2}
2163 \end{lstlisting}
2164
2165
2166 \begin{figure}[!h]
2167 %\frame{\includegraphics[page=1,width=0.24\linewidth]{examples/after2s2c}}\hfill
2168 \frame{\includegraphics[page=2,width=0.24\linewidth]{examples/after2s2c}}\hfill
2169 \frame{\includegraphics[page=3,width=0.24\linewidth]{examples/after2s2c}}\hfill
2170 \frame{\includegraphics[page=4,width=0.24\linewidth]{examples/after2s2c}}\hfill
2171 \frame{\includegraphics[page=5,width=0.24\linewidth]{examples/after2s2c}}
2172
2173 \frame{\includegraphics[page=6,width=0.24\linewidth]{examples/after2s2c}}\hfill
2174 \frame{\includegraphics[page=7,width=0.24\linewidth]{examples/after2s2c}}\hfill
2175 \frame{\includegraphics[page=8,width=0.24\linewidth]{examples/after2s2c}}\hfill
2176 \frame{\includegraphics[page=9,width=0.24\linewidth]{examples/after2s2c}}
2177 \caption{Output of \texttt{after2s2c} (pages 2--9)}\label{after2s2c}
2178 \end{figure}
2179
2180
2181 The caption and the object can be on different pages (Figure~\vref{after2s2c}).
2182 If you do not like this behaviour, then use the setting \Lkeyset{capPos=right} instead
2183 of \Lkeyset{capPos=after}. Figure~{right2s2c} shows that caption and object in this case
2184 are always on the same page.
2185
2186 \begin{figure}[!h]
2187 %\frame{\includegraphics[page=1,width=0.24\linewidth]{examples/right2s2c}}\hfill
2188 \frame{\includegraphics[page=2,width=0.24\linewidth]{examples/right2s2c}}\hfill
2189 \frame{\includegraphics[page=3,width=0.24\linewidth]{examples/right2s2c}}\hfill
2190 \frame{\includegraphics[page=4,width=0.24\linewidth]{examples/right2s2c}}\hfill
2191 \frame{\includegraphics[page=5,width=0.24\linewidth]{examples/right2s2c}}
2192
2193 \frame{\includegraphics[page=6,width=0.24\linewidth]{examples/right2s2c}}\hfill
2194 \frame{\includegraphics[page=7,width=0.24\linewidth]{examples/right2s2c}}\hfill
2195 \frame{\includegraphics[page=8,width=0.24\linewidth]{examples/right2s2c}}\hfill
2196 \frame{\includegraphics[page=9,width=0.24\linewidth]{examples/right2s2c}}
2197 \caption{Output of \texttt{right2s2c} (pages 2--9)}\label{right2s2c}
2198 \end{figure}
2199
2200 %\FloatBarrier
2201
2202 \clearpage%%%%%%%%%%%%%%%%%%%%%%%%%
2203
2204
2205 \subsubsection{Using \Lkeyset{capPos=evenPage} --- caption on an even page}
2206
2207 There can be a problem if there is not enough space on the bottom of the
2208 even page. Then the caption will be on the next page which is an odd one.
2209 In such a case use a manually \Lcs{clearpage} or wait for an update
2210 of \Lpack{hvfloat}.
2211
2212
2213 \iffalse
2214 \begin{figure}[p]
2215 \frame{\includegraphics[page=2,width=0.24\linewidth]{examples/even1s2c}}\hfill
2216 \frame{\includegraphics[page=3,width=0.24\linewidth]{examples/even1s2c}}\hfill
2217 \frame{\includegraphics[page=4,width=0.24\linewidth]{examples/even1s2c}}\hfill
2218 \frame{\includegraphics[page=5,width=0.24\linewidth]{examples/even1s2c}}
2219
2220 \frame{\includegraphics[page=6,width=0.24\linewidth]{examples/even1s2c}}\hfill
2221 \frame{\includegraphics[page=7,width=0.24\linewidth]{examples/even1s2c}}\hfill
2222 \frame{\includegraphics[page=8,width=0.24\linewidth]{examples/even1s2c}}\hfill
2223 \frame{\includegraphics[page=9,width=0.24\linewidth]{examples/even1s2c}}
2224 %\frame{\includegraphics[page=10,width=0.24\linewidth]{examples/even1s2c}}
2225 \caption{Output of \texttt{even1s2c} (pages 2--9)}\label{even1s2c}
2226 \fi
2227
2228 \begin{figure}
2229 \frame{\includegraphics[page=2,width=0.24\linewidth]{examples/even2s2c}}\hfill
2230 \frame{\includegraphics[page=3,width=0.24\linewidth]{examples/even2s2c}}\hfill
2231 \frame{\includegraphics[page=4,width=0.24\linewidth]{examples/even2s2c}}\hfill
2232 \frame{\includegraphics[page=5,width=0.24\linewidth]{examples/even2s2c}}
2233
2234 \frame{\includegraphics[page=6,width=0.24\linewidth]{examples/even2s2c}}\hfill
2235 \frame{\includegraphics[page=7,width=0.24\linewidth]{examples/even2s2c}}\hfill
2236 \frame{\includegraphics[page=8,width=0.24\linewidth]{examples/even2s2c}}\hfill
2237 \frame{\includegraphics[page=9,width=0.24\linewidth]{examples/even2s2c}}
2238 %\frame{\includegraphics[page=10,width=0.24\linewidth]{examples/even1s2c}}
2239 \caption{Output of \texttt{even2s2c} (pages 2--9)}\label{even2s2c}
2240 \end{figure}
2241
2242 %\FloatBarrier
2243
2244
2245 \clearpage
2246
2247
2248 \subsubsection{Using \Lkeyset{capPos=oddPage} --- caption on an odd page}
2249
2250 There can be a problem if there is not enough space on the bottom of the
2251 even page. Then the caption will be on the next page which is an odd one.
2252 In such a case use a manually \Lcs{clearpage} or wait for an update
2253 of \Lpack{hvfloat}.
2254
2255
2256 \iffalse
2257 \begin{figure}[p]
2258 \frame{\includegraphics[page=2,width=0.24\linewidth]{examples/odd1s2c}}\hfill
2259 \frame{\includegraphics[page=3,width=0.24\linewidth]{examples/odd1s2c}}\hfill
2260 \frame{\includegraphics[page=4,width=0.24\linewidth]{examples/odd1s2c}}\hfill
2261 \frame{\includegraphics[page=5,width=0.24\linewidth]{examples/odd1s2c}}
2262
2263 \frame{\includegraphics[page=6,width=0.24\linewidth]{examples/odd1s2c}}\hfill
2264 \frame{\includegraphics[page=7,width=0.24\linewidth]{examples/odd1s2c}}\hfill
2265 \frame{\includegraphics[page=8,width=0.24\linewidth]{examples/odd1s2c}}\hfill
2266 \frame{\includegraphics[page=9,width=0.24\linewidth]{examples/odd1s2c}}
2267 %\frame{\includegraphics[page=10,width=0.24\linewidth]{examples/odd1s2c}}
2268 \caption{Output of \texttt{odd1s2c} (pages 2--9)}\label{odd1sc2}
2269 \fi
2270
2271 \begin{figure}
2272 \frame{\includegraphics[page=2,width=0.24\linewidth]{examples/odd2s2c}}\hfill
2273 \frame{\includegraphics[page=3,width=0.24\linewidth]{examples/odd2s2c}}\hfill
2274 \frame{\includegraphics[page=4,width=0.24\linewidth]{examples/odd2s2c}}\hfill
2275 \frame{\includegraphics[page=5,width=0.24\linewidth]{examples/odd2s2c}}
2276
2277 \frame{\includegraphics[page=6,width=0.24\linewidth]{examples/odd2s2c}}\hfill
2278 \frame{\includegraphics[page=7,width=0.24\linewidth]{examples/odd2s2c}}\hfill
2279 \frame{\includegraphics[page=8,width=0.24\linewidth]{examples/odd2s2c}}\hfill
2280 \frame{\includegraphics[page=9,width=0.24\linewidth]{examples/odd2s2c}}
2281 %\frame{\includegraphics[page=10,width=0.24\linewidth]{examples/odd1s2c}}
2282 \caption{Output of \texttt{odd2s2c} (pages 2--9)}\label{odd2s2c}
2283 \end{figure}
2284
2285
2286
2287
2288 %\FloatBarrier
2289 \clearpage
2290
2291
2292 \subsubsection{Using \Lkeyset{capPos=inner} --- caption in the inner column}
2293
2294 The caption will be printed in the right column for an even page and
2295 in the left column for an odd page.
2296
2297
2298 \begin{lstlisting}
2299 \hvFloat[fullpage,capPos=inner]{figure}{\includegraphics[fullpage]{images/rose}}%
2300 [A float which needs the complete column width and height.]%
2301 {A Caption of a ``fullpage'' object, which follows on the left or right column.
2302 This can be an even or odd page. And some more text which has no
2303 real meaning because it fills only the space for a long caption.}{fig:fullpage3-2}
2304 \end{lstlisting}
2305
2306 \iffalse
2307 \Float[capPos=inner]
2308 \hvFloat[fullpage,capPos=inner]{figure}%
2309 {\includegraphics[fullpage]{images/rose}}%
2310 [A float which needs the complete column width and height.]%
2311 {A Caption of a ``fullpage'' object, which follows on the left or
2312 right column.
2313 This can be an even or odd page. And some more text which has no
2314 real meaning because it fills only the space for a long caption.}{fig:fullpage3-2}
2315 \fi
2316
2317
2318 \begin{figure}
2319 %\frame{\includegraphics[page=2,width=0.24\linewidth]{examples/inner1s2c}}\hfill
2320 %\frame{\includegraphics[page=3,width=0.24\linewidth]{examples/inner1s2c}}\hfill
2321 %\frame{\includegraphics[page=4,width=0.24\linewidth]{examples/inner1s2c}}\hfill
2322 %\frame{\includegraphics[page=5,width=0.24\linewidth]{examples/inner1s2c}}
2323
2324 %\frame{\includegraphics[page=6,width=0.24\linewidth]{examples/inner1s2c}}\hfill
2325 %\frame{\includegraphics[page=7,width=0.24\linewidth]{examples/inner1s2c}}\hfill
2326 %\frame{\includegraphics[page=8,width=0.24\linewidth]{examples/inner1s2c}}\hfill
2327 %\frame{\includegraphics[page=9,width=0.24\linewidth]{examples/inner1s2c}}
2328 %\frame{\includegraphics[page=10,width=0.24\linewidth]{examples/inner1s2c}}
2329 %\caption{Output of \texttt{inner1s2c} (pages 2--9)}\label{inner1s2c}
2330
2331 \frame{\includegraphics[page=2,width=0.24\linewidth]{examples/inner2s2c}}\hfill
2332 \frame{\includegraphics[page=3,width=0.24\linewidth]{examples/inner2s2c}}\hfill
2333 \frame{\includegraphics[page=4,width=0.24\linewidth]{examples/inner2s2c}}\hfill
2334 \frame{\includegraphics[page=5,width=0.24\linewidth]{examples/inner2s2c}}
2335
2336 \frame{\includegraphics[page=6,width=0.24\linewidth]{examples/inner2s2c}}\hfill
2337 \frame{\includegraphics[page=7,width=0.24\linewidth]{examples/inner2s2c}}\hfill
2338 \frame{\includegraphics[page=8,width=0.24\linewidth]{examples/inner2s2c}}\hfill
2339 \frame{\includegraphics[page=9,width=0.24\linewidth]{examples/inner2s2c}}
2340 %\frame{\includegraphics[page=10,width=0.24\linewidth]{examples/inner1s2c}}
2341 \caption{Output of \texttt{inner2s2c} (pages 2--9)}\label{inner2s2c}
2342 \end{figure}
2343
2344
2345 %\FloatBarrier
2346 \clearpage
2347
2348
2349 \subsubsection{Using \Lkeyset{capPos=outer} --- caption on the outer column}
2350
2351 The caption will be printed on the left column an odd page, the object can appear before
2352 or after this caption.
2353
2354
2355 \begin{lstlisting}
2356 \hvFloat[fullpage, capPos=outer]{figure}%
2357 {\includegraphics[fullpage]{images/rose}}%
2358 [A float which needs the complete page width and height with \texttt{capPos=outer}.]%
2359 {A Caption of a ``fullpage'' object, which has the caption position in the
2360 outer page. This can be an even or odd page. And some more text which has no
2361 real meaning because it fills only the space for a long caption.}{fig:fullpage2-2a}
2362 \end{lstlisting}
2363
2364 \iffalse
2365 \Float[capPos=outer]
2366 \hvFloat[fullpage, capPos=outer]{figure}%
2367 {\includegraphics[fullpage]{images/rose}}%
2368 [A float which needs the complete page width and height with \texttt{capPos=outer}.]%
2369 {A Caption of a ``fullpage'' object, which has the caption position in the
2370 outer page. This can be an even or odd page. And some more text which has no
2371 real meaning because it fills only the space for a long caption.}{fig:fullpage2-2a}
2372 \fi
2373
2374
2375
2376
2377 \begin{figure}
2378 %\frame{\includegraphics[page=2,width=0.24\linewidth]{examples/outer1s2c}}\hfill
2379 %\frame{\includegraphics[page=3,width=0.24\linewidth]{examples/outer1s2c}}\hfill
2380 %\frame{\includegraphics[page=4,width=0.24\linewidth]{examples/outer1s2c}}\hfill
2381 %\frame{\includegraphics[page=5,width=0.24\linewidth]{examples/outer1s2c}}
2382 %
2383 %\frame{\includegraphics[page=6,width=0.24\linewidth]{examples/outer1s2c}}\hfill
2384 %\frame{\includegraphics[page=7,width=0.24\linewidth]{examples/outer1s2c}}\hfill
2385 %\frame{\includegraphics[page=8,width=0.24\linewidth]{examples/outer1s2c}}\hfill
2386 %\frame{\includegraphics[page=9,width=0.24\linewidth]{examples/outer1s2c}}
2387 %\frame{\includegraphics[page=10,width=0.24\linewidth]{examples/outer1s2c}}
2388 %\caption{Output of \texttt{outer1s2c} (pages 2--9)}\label{outer1s2c}
2389
2390
2391 \frame{\includegraphics[page=2,width=0.24\linewidth]{examples/outer2s2c}}\hfill
2392 \frame{\includegraphics[page=3,width=0.24\linewidth]{examples/outer2s2c}}\hfill
2393 \frame{\includegraphics[page=4,width=0.24\linewidth]{examples/outer2s2c}}\hfill
2394 \frame{\includegraphics[page=5,width=0.24\linewidth]{examples/outer2s2c}}
2395
2396 \frame{\includegraphics[page=6,width=0.24\linewidth]{examples/outer2s2c}}\hfill
2397 \frame{\includegraphics[page=7,width=0.24\linewidth]{examples/outer2s2c}}\hfill
2398 \frame{\includegraphics[page=8,width=0.24\linewidth]{examples/outer2s2c}}\hfill
2399 \frame{\includegraphics[page=9,width=0.24\linewidth]{examples/outer2s2c}}
2400 %\frame{\includegraphics[page=10,width=0.24\linewidth]{examples/outer1s2c}}
2401 \caption{Output of \texttt{outer2s2c} (pages 2--9)}\label{outer2s2c}
2402 \end{figure}
2403
2404
2405 \FloatBarrier
2406
2407
2408 \clearpage
2409
2410
2411 \subsection{Using full page in twocolumn mode}\label{star-version}
2412
2413 With the star version of \Lcs{hvfloat} The object ist placed over both columns, the whole page.
2414 In such a case the only useful caption position is \Lkeyset{capPos=inner} for \emph{inner}.
2415
2416
2417 \begin{lstlisting}
2418 \hvFloat*[fullpage, capPos=inner]{figure}%
2419 {\includegraphics[FullPage]{images/rose}}%
2420 [A float which needs the complete page width and height with \texttt{capPos=outer}.]%
2421 {A caption of a ``fullpage'' object in twocolumn mode: It uses the star version
2422 of \textbackslash hvFloat. The object goes over both columns.}{fig:two}
2423 \end{lstlisting}
2424
2425 \iffalse
2426 \Float[capPos=inner]
2427 \hvFloat*[fullpage, capPos=inner]{figure}%
2428 {\includegraphics[FullPage]{images/rose}}%
2429 [Star version with \texttt{capPos=outer}.]%
2430 {A caption of a ``fullpage'' object in twocolumn mode: It uses the star version
2431 of \textbackslash hvFloat. The object goes over both columns.}{fig:two}
2432
2433 \fi
2434
2435
2436 \begin{figure}
2437 \frame{\includegraphics[page=2,width=0.24\linewidth]{examples/paper-default2s2c}}\hfill
2438 \frame{\includegraphics[page=3,width=0.24\linewidth]{examples/paper-default2s2c}}\hfill
2439 \frame{\includegraphics[page=4,width=0.24\linewidth]{examples/paper-default2s2c}}\hfill
2440 \frame{\includegraphics[page=5,width=0.24\linewidth]{examples/paper-default2s2c}}
2441
2442 \frame{\includegraphics[page=6,width=0.24\linewidth]{examples/paper-default2s2c}}\hfill
2443 \frame{\includegraphics[page=7,width=0.24\linewidth]{examples/paper-default2s2c}}\hfill
2444 \frame{\includegraphics[page=8,width=0.24\linewidth]{examples/paper-default2s2c}}\hfill
2445 \frame{\includegraphics[page=9,width=0.24\linewidth]{examples/paper-default2s2c}}
2446
2447 %\frame{\includegraphics[page=9,width=0.24\linewidth]{examples/paper-default2s2c}}
2448 \caption{Output of \texttt{paper-default2s2c} (pages 2--9)}\label{paper-default2s2c}
2449 \end{figure}
2450
2451
2452 \begin{figure}
2453 \frame{\includegraphics[page=2,width=0.24\linewidth]{examples/paper-inner2s2c}}\hfill
2454 \frame{\includegraphics[page=3,width=0.24\linewidth]{examples/paper-inner2s2c}}\hfill
2455 \frame{\includegraphics[page=4,width=0.24\linewidth]{examples/paper-inner2s2c}}\hfill
2456 \frame{\includegraphics[page=5,width=0.24\linewidth]{examples/paper-inner2s2c}}
2457
2458 \frame{\includegraphics[page=6,width=0.24\linewidth]{examples/paper-inner2s2c}}\hfill
2459 \frame{\includegraphics[page=7,width=0.24\linewidth]{examples/paper-inner2s2c}}\hfill
2460 \frame{\includegraphics[page=8,width=0.24\linewidth]{examples/paper-inner2s2c}}\hfill
2461 \frame{\includegraphics[page=9,width=0.24\linewidth]{examples/paper-inner2s2c}}
2462
2463 %\frame{\includegraphics[page=9,width=0.24\linewidth]{examples/paper-inner1s2c}}
2464 \caption{Output of \texttt{paper-inner2s2c} (pages 2--9)}\label{paper-inner2s2c}
2465 \end{figure}
2466
2467
2468 \FloatBarrier
2469
2470
2471 \subsection{Multifloats}
2472 Multifloats is the name for more than one image and/or tabular in \emph{one} floating
2473 environment. Every image and/or tabular has its own caption, which is different to
2474 a subcaption.
2475 The + symbol defines an additional Object which will be part of the same floating environment.
2476 It's up too the user to be sure that one page or one column can hold all defined objects.
2477 Every object gets its own caption which is the reason why figures and tabulars and \ldots\
2478 can be mixed:
2479
2480 \begin{lstlisting}
2481 \captionsetup{singlelinecheck=false}
2482 \hvFloat[fullpage,multiFloat,capPos=inner,vFill]%
2483 +{figure}{\includegraphics[height=0.4\textheight]{images/rose}}%% no 1
2484 [Short caption A]%
2485 {A Caption A of a ``fullpage'' object, which follows on the left or
2486 right column. This can be an even or odd page. And some more text which has no
2487 real meaning because it fills only the space for a long caption.}%
2488 {multi:demo0}%
2489 +{table}{\begin{tabular}{lr}\hline % no 2
2490 Linksbündig & Rechtsbündig\\
2491 L & R \\
2492 left & right \\
2493 \multicolumn{2}{c}{Multicolumn}\\\hline
2494 \end{tabular}}%
2495 [Short Caption B]%
2496 {A Caption B of a ``fullpage'' object, which follows on the left or
2497 right column. This can be an even or odd page.}%
2498 {}%
2499 +{figure}{\includegraphics[height=0.4\textheight]{images/rose}}%% no 3
2500 {A Caption C of a ``fullpage'' object, which follows on the left or
2501 right column.}%
2502 {multi:demo1}
2503 \end{lstlisting}
2504
2505
2506
2507 \iffalse
2508 \Float[Multi]
2509 \captionsetup{singlelinecheck=false}
2510 \hvFloat[fullpage,multiFloat,capPos=inner]%
2511 +{figure}{\includegraphics[height=0.4\textheight]{images/rose}}%% no 1
2512 [Short caption A]%
2513 {A Caption A of a ``fullpage'' object, which follows on the left or
2514 right column. This can be an even or odd page. And some more text which has no
2515 real meaning because it fills only the space for a long caption.}%
2516 {multi:demo0}%
2517 +{table}{\begin{tabular}{lr}\hline % no 2
2518 Linksbündig & Rechtsbündig\\
2519 L & R \\
2520 left & right \\
2521 \multicolumn{2}{c}{Multicolumn}\\\hline
2522 \end{tabular}}%
2523 [Short Caption B]%
2524 {A Caption B of a ``fullpage'' object, which follows on the left or
2525 right column. This can be an even or odd page.}{}%
2526 +{figure}{\includegraphics[height=0.4\textheight]{images/rose}}%% no 3
2527 {A Caption C of a ``fullpage'' object, which follows on the left or
2528 right column.}%
2529 {multi:demo1}
2530 \fi
2531
2532
2533 The page with the objects has no additional informations it holds only the figures and/or tabulars.
2534 If you want it like subfigures or subtabulars then go to section~\vref{sec:subfloats}. The setting
2535 \Lcs{captionsetup}\Largb{\Lkeyset{singlelinecheck=false}} is needed if you want the captions always
2536 left aligned.
2537
2538
2539
2540 \begin{figure}[!h]
2541 \frame{\includegraphics[page=2,width=0.24\linewidth]{examples/multi-default2s2c}}\hfill
2542 \frame{\includegraphics[page=3,width=0.24\linewidth]{examples/multi-default2s2c}}\hfill
2543 \frame{\includegraphics[page=4,width=0.24\linewidth]{examples/multi-default2s2c}}\hfill
2544 \frame{\includegraphics[page=5,width=0.24\linewidth]{examples/multi-default2s2c}}
2545
2546 \frame{\includegraphics[page=6,width=0.24\linewidth]{examples/multi-default2s2c}}\hfill
2547 \frame{\includegraphics[page=7,width=0.24\linewidth]{examples/multi-default2s2c}}\hfill
2548 \frame{\includegraphics[page=8,width=0.24\linewidth]{examples/multi-default2s2c}}\hfill
2549 \frame{\includegraphics[page=9,width=0.24\linewidth]{examples/multi-default2s2c}}
2550 %\frame{\includegraphics[page=9,width=0.24\linewidth]{examples/multi-default2s2c}}
2551 \caption{Output of \texttt{multi-default2s2c} (pages 2-9)}\label{multi-defaults2s2c}
2552 \end{figure}
2553
2554 \begin{figure}[!h]
2555 \frame{\includegraphics[page=2,width=0.24\linewidth]{examples/multi-inner2s2c}}\hfill
2556 \frame{\includegraphics[page=3,width=0.24\linewidth]{examples/multi-inner2s2c}}\hfill
2557 \frame{\includegraphics[page=4,width=0.24\linewidth]{examples/multi-inner2s2c}}\hfill
2558 \frame{\includegraphics[page=5,width=0.24\linewidth]{examples/multi-inner2s2c}}%%
2559
2560 \frame{\includegraphics[page=6,width=0.24\linewidth]{examples/multi-inner2s2c}}\hfill
2561 \frame{\includegraphics[page=7,width=0.24\linewidth]{examples/multi-inner2s2c}}\hfill
2562 \frame{\includegraphics[page=8,width=0.24\linewidth]{examples/multi-inner2s2c}}\hfill
2563 \frame{\includegraphics[page=9,width=0.24\linewidth]{examples/multi-inner2s2c}}
2564 %\frame{\includegraphics[page=9,width=0.24\linewidth]{examples/multi-inner2s2c}}
2565 \caption{Output of \texttt{multi-inner2s2c} (pages 2-9)}\label{multi-inners2s2c}
2566 \end{figure}
2567
2568
2569
2570 \section{Subfloat page}
2571 A subfloat page can have only one type of floats which will have one main caption and
2572 individual subcaptions.
2573 Some arguments are ignored for a subfloat, one can leave them empty. The first line defines only the type and the main caption,
2574 the object entry is ignored! All aditional lines will have the same float type, the reason why the
2575 float type entry is ignored.
2576
2577 \enlargethispage{\normalbaselineskip}
2578
2579 \begin{lstlisting}
2580 \captionsetup[sub]{singlelinecheck}
2581 \hvFloat[fullpage,capPos=before,objectFrame,subFloat,vFill]%
2582 +{figure}{}[Short main caption of the objects]% main short lsi entry
2583 {The main caption of a ``fullpage'' object, which follows on the left or
2584 right column. This can be an even or odd page. And some more text which has no
2585 real meaning because it fills only the space for a long caption.}% main caption
2586 {sub:demo00}%
2587 +{}{\includegraphics[height=0.28\textheight]{images/rose}}%
2588 [Short caption B]%
2589 {A Caption B of a ``fullpage'' sub object.}% subcaption
2590 {}%
2591 +{}{\includegraphics[height=0.28\textheight]{images/rose}}%
2592 {A Caption C of a ``fullpage'' object, which follows on the left or right column.}%
2593 {sub:demo10}
2594 +{}{\includegraphics[height=0.28\textheight]{images/rose}}%
2595 {A Caption D of a ``fullpage'' object}%
2596 {sub:demo20}
2597 \end{lstlisting}
2598
2599
2600 The keyword \Lkeyword{subFloat} defines the images or tabulars as subfloats.
2601 The package \Lpack{subcaption} is loaded by default. For the subcaptions the \Lkeyword{singlelinecheck}
2602 should be true (see listing).
2603
2604 \iffalse
2605 \captionsetup[sub]{singlelinecheck}
2606 \Float[subFloat]
2607 \hvFloat[fullpage,capPos=before,objectFrame,subFloat]%
2608 +{figure}{}[Short main caption of the objects]%
2609 {The main caption of a ``fullpage'' object, which follows on the left or
2610 right column. This can be an even or odd page. And some more text which has no
2611 real meaning because it fills only the space for a long caption.}%
2612 {sub:demo00}%
2613 +{}{\includegraphics[height=0.28\textheight]{images/rose}}%
2614 [Short caption B]%
2615 {A Caption B of a ``fullpage'' sub object.}%
2616 {}%
2617 +{}{\includegraphics[height=0.28\textheight]{images/rose}}%
2618 {A Caption C of a ``fullpage'' object, which follows on the left or
2619 right column.}%
2620 {sub:demo10}
2621 +{}{\includegraphics[height=0.28\textheight]{images/rose}}%
2622 {A Caption D of a ``fullpage'' object}%
2623 {sub:demo20}
2624 \fi
2625
2626
2627
2628 \begin{figure}[p]
2629 \frame{\includegraphics[page=2,width=0.24\linewidth]{examples/sub-default2s2c}}\hfill
2630 \frame{\includegraphics[page=3,width=0.24\linewidth]{examples/sub-default2s2c}}\hfill
2631 \frame{\includegraphics[page=4,width=0.24\linewidth]{examples/sub-default2s2c}}\hfill
2632 \frame{\includegraphics[page=5,width=0.24\linewidth]{examples/sub-default2s2c}}
2633
2634 \frame{\includegraphics[page=6,width=0.24\linewidth]{examples/sub-default2s2c}}\hfill
2635 \frame{\includegraphics[page=7,width=0.24\linewidth]{examples/sub-default2s2c}}\hfill
2636 \frame{\includegraphics[page=8,width=0.24\linewidth]{examples/sub-default2s2c}}\hfill
2637 \frame{\includegraphics[page=9,width=0.24\linewidth]{examples/sub-default2s2c}}
2638 \caption{Output of \texttt{sub-default2s2c} (pages 2--9)}\label{sub-default2s2c}
2639
2640 \frame{\includegraphics[page=2,width=0.24\linewidth]{examples/sub-after2s2c}}\hfill
2641 \frame{\includegraphics[page=3,width=0.24\linewidth]{examples/sub-after2s2c}}\hfill
2642 \frame{\includegraphics[page=4,width=0.24\linewidth]{examples/sub-after2s2c}}\hfill
2643 \frame{\includegraphics[page=5,width=0.24\linewidth]{examples/sub-after2s2c}}
2644
2645 \frame{\includegraphics[page=6,width=0.24\linewidth]{examples/sub-after2s2c}}\hfill
2646 \frame{\includegraphics[page=7,width=0.24\linewidth]{examples/sub-after2s2c}}\hfill
2647 \frame{\includegraphics[page=8,width=0.24\linewidth]{examples/sub-after2s2c}}\hfill
2648 \frame{\includegraphics[page=9,width=0.24\linewidth]{examples/sub-after2s2c}}
2649 %\frame{\includegraphics[page=10,width=0.24\linewidth]{examples/odd2s2c}}
2650 \caption{Output of \texttt{sub-after2s2c} (pages 2--9)}\label{sub-after2s2c}
2651 \end{figure}
2652
2653
2654
2655 \FloatBarrier
2656
2657 %\index{capPos@\texttt {capPos} (keyword)|)}
2658
2659 \section{Doublepage objects -- images and/or tabulars}
2660 If an image or a tabular or any other object is too big for one page, it can be split over two pages (left -- right).
2661 It is obvious that this makes only sense for twoside documents.
2662 There are three optional arguments:
2663
2664 \begin{description}
2665 \item[\Lkeyword{doublePage}] A splitted object with or without a caption on top of a double page, beginning in the left top text area.
2666 The user has to scale the image to be sure that the object will not be greater than \verb|2\paperwidth-4\margin|. The caption can be rotated
2667 on the right side of the right object part or under the right part.
2668
2669 \item[\Lkeyword{doublePAGE}] A splitted object with or without a caption on top of a double page, beginning at the left side
2670 of the paper area and top of the text area.
2671 The user has to scale the image to be sure that the object will not be greater than \verb|2\paperwidth|. The caption can only be
2672 under the right part of the object. The will be \emph{no additional text} on the double page.
2673
2674 \item[\Lkeyword{doubleFullPage}] A splitted object with or without a caption on the left or right below of a double page
2675 image. The object can
2676 fill the complete double page.
2677 The user has to scale the image to be sure that the object will not be greater than \verb|2\paperwidth|.
2678
2679 \item[\Lkeyword{doubleFULLPAGE}] A splitted object with or without a caption on the right or below of a double page. The object can
2680 fill the complete double page.
2681 The user has to scale the image to be sure that the object will not be greater than \verb|2\paperwidth|. A caption will be
2682 rotated and written \emph{over} the object, or if possible, at the right. The user has to take care for a correct text color.
2683 \end{description}
2684
2685
2686
2687
2688
2689 \subsection{\Lkeyword{doubleFULLPAGE}}
2690 The scaling of the image is left to the user. If the proportion of the object doesn't fit 2*paperwidth/paperheight,
2691 then there can be a white part on the top or bottom of the object. A pagenumber will not be printed. In this documentation you'll
2692 find a marginnote where the following full doublepage image is defined. It appears on the the next following
2693 even page and following text will be placed \emph{before} the object.
2694
2695
2696
2697 \begin{lstlisting}
2698 \hvFloat[doubleFULLPAGE,capPos=right,capAngle=90]%
2699 {figure}%
2700 {\includegraphics[width=2\paperwidth]{images/stavanger0}}%
2701 [A doublepage image with a caption on the image.]%
2702 {A caption for a double-sided image that will be placed below the right-hand
2703 part of the illustration. The illustration begins on the left edge of the paper.
2704 No further text is placed on the pages. A short form is used for the LOF.
2705 The parameter is \texttt{doubleFULLPAGE}}%
2706 {fig:doubleFULLPAGE0}
2707 \end{lstlisting}
2708
2709 \MarginNote{Fig.~\ref{fig:doubleFULLPAGE0}}
2710 \hvFloat[doubleFULLPAGE,capPos=right,capAngle=90]%
2711 {figure}%
2712 {\includegraphics[height=\paperheight]{images/stavanger0}}%
2713 [A doublepage image with a caption on the image.]%
2714 {A caption for a double-sided image that will be placed on the right-hand
2715 part of the illustration. The illustration begins on the left edge of the paper.
2716 No further text is placed on the pages. A short form is used for the LOF.
2717 The parameter is \texttt{doubleFULLPAGE}}%
2718 {fig:doubleFULLPAGE0}
2719
2720 \hvBlindtext
2721
2722 \hvBlindtext
2723
2724 \hvBlindtext
2725
2726
2727 It is also possible to take a bind correction into account with e.g.
2728 \texttt{binCorr=5mm}, which reserves whitespace of 5mm
2729 in the inner margin on both pages.
2730
2731
2732 \begin{lstlisting}
2733 \hvFloat[doubleFULLPAGE,capPos=after,bindCorr=5mm]%
2734 {figure}%
2735 {\includegraphics[width=2\paperwidth]{images/aida0}}%
2736 [A doublepage image with a caption on the image.]%
2737 {A caption for a double-sided image that will be placed below the right-hand
2738 part of the illustration. The illustration begins on the left edge of the paper.
2739 No further text is placed on the pages. A short form is used for the LOF.
2740 The parameter is \texttt{doubleFULLPAGE}}%
2741 {fig:doubleFULLPAGE0a}
2742 \end{lstlisting}
2743
2744 \MarginNote{Fig.~\ref{fig:doubleFULLPAGE0a}}
2745 \hvFloat[doubleFULLPAGE,capPos=after,bindCorr=5mm]%
2746 {figure}%
2747 {\includegraphics[height=2\paperwidth]{images/aida0}}%
2748 [A doublepage image with a caption on the image.]%
2749 {A caption for a double-sided image that will be placed on the right-hand
2750 part of the illustration. The illustration begins on the left edge of the paper.
2751 No further text is placed on the pages. A short form is used for the LOF.
2752 The parameter is \texttt{doubleFULLPAGE}}%
2753 {fig:doubleFULLPAGE0a}
2754
2755 \hvBlindtext
2756
2757 \hvBlindtext
2758
2759 \hvBlindtext
2760
2761
2762
2763 \begin{lstlisting}
2764 \hvFloat[doubleFULLPAGE,capPos=right]%
2765 {figure}%
2766 {\includegraphics[height=\paperheight]{images/aida1}}%
2767 {A caption for a double-sided image that will be placed on the right-hand
2768 part of the illustration. The illustration begins on the left edge of the paper.
2769 No further text is placed on the pages. A short form is used for the LOF.
2770 The parameter is \texttt{doubleFULLPAGE}}%
2771 {fig:doubleFULLPAGE1}
2772 \end{lstlisting}
2773
2774 \MarginNote{Fig.~\ref{fig:doubleFULLPAGE1}}
2775 \hvFloat[doubleFULLPAGE,capPos=right]%
2776 {figure}%
2777 {\includegraphics[height=\paperheight]{images/aida1}}%
2778 {A caption for a double-sided image that will be placed on the right-hand
2779 part of the illustration. The illustration begins on the left edge of the paper.
2780 No further text is placed on the pages. A short form is used for the LOF.
2781 The parameter is \texttt{doubleFULLPAGE}}%
2782 {fig:doubleFULLPAGE1}
2783
2784 \hvBlindtext \hvBlindtext
2785
2786
2787 Placing the caption on the image itself is not the best solution. With the optional arguments
2788 \Lkeyval{before} and \Lkeyval{after} for \Lkeyword{capPos}, the caption can be placed on the bottom
2789 of the preceding or following page of the doublepage object. A givel label, e.g. \texttt{foo} will always point to the
2790 page with the left part of the object. Internally are two additional labels defined: \texttt{foo-cap} points to the
2791 caption and \texttt{foo-2} points to the right part of the doublepage object.
2792
2793 In the follwoing example~\ref{foo} the caption is on page~\pageref{foo-cap}, the left image part on
2794 page~\pageref{foo}
2795 and the right part on page~\pageref{foo-2}. In the follwoing example~\ref{bar} the caption is on page~\pageref{bar-cap}, the left image part on page~\pageref{bar}
2796 and the right part on page~\pageref{bar-2}. All three labels points to the same figure or table number:
2797
2798 \verb/\ref{foo} | \ref{foo-cap} | \ref{foo-2}/ $\rightarrow$ Figure~\ref{foo} | Figure~\ref{foo-cap} | Figure~\ref{foo-2}
2799
2800 \verb/\pageref{foo} | \pageref{foo-cap} | \pageref{foo-2}/ $\rightarrow$ Page~\pageref{foo} | Page~\pageref{foo-cap} | Page~\pageref{foo-2}
2801
2802 \begin{lstlisting}
2803 \hvFloat[doubleFULLPAGE,capPos=after]%
2804 {figure}%
2805 {\includegraphics[doubleFULLPAGE,
2806 keepaspectratio=false]{images/aida1}}%
2807 {A caption for a double-sided image that will be placed \textbf{after}
2808 the image. The image begins on the left edge of the paper.
2809 No further text is placed on the pages. A short form is used for the LOF.
2810 The parameter is \texttt{doubleFULLPAGE}}%
2811 {foo}
2812 \end{lstlisting}
2813
2814 \hvFloatSetDefaults
2815
2816 \MarginNote{Fig.~\ref{foo}}
2817 \hvFloat[doubleFULLPAGE,capPos=after]%
2818 {figure}%
2819 {\includegraphics[doubleFULLPAGE]{images/aida1}}%
2820 {A caption for a double-sided image that will be placed \textbf{after}
2821 the image. The image begins on the left edge of the paper.
2822 No further text is placed on the pages. A short form is used for the LOF.
2823 The parameter is \texttt{doubleFULLPAGE}}%
2824 {foo}
2825
2826 \hvBlindtext %\hvBlindtext
2827
2828 \hvblindtext
2829
2830 \hvblindtext
2831
2832 \hvBlindtext
2833
2834 \hvBlindtext
2835
2836 \setDefaults
2837
2838 \begin{lstlisting}
2839 \hvFloat[doubleFULLPAGE,capPos=before]%
2840 {figure}%
2841 {\includegraphics[height=\paperheight,width=2\paperwidth,
2842 keepaspectratio=false]{images/aida1}}%
2843 {A caption for a double-sided image that will be placed \textbf{before}
2844 the image. The image begins on the left edge of the paper.
2845 No further text is placed on the pages. A short form is used for the LOF.
2846 The parameter is \texttt{doubleFULLPAGE}}%
2847 {bar}
2848 \end{lstlisting}
2849
2850 \MarginNote{Fig.~\ref{bar}}
2851 \hvFloat[doubleFULLPAGE,capPos=before]%
2852 {figure}%
2853 {\includegraphics[height=\paperheight,width=2\paperwidth,keepaspectratio=false]{images/aida1}}%
2854 {A caption for a double-sided image that will be placed \textbf{before}
2855 the image. The image begins on the left edge of the paper.
2856 No further text is placed on the pages. A short form is used for the LOF.
2857 The parameter is \texttt{doubleFULLPAGE}}%
2858 {bar}
2859
2860 \hvBlindtext
2861
2862 \hvBlindtext
2863
2864 %\hvBlindtext
2865
2866 \hvblindtext
2867
2868 \subsection{\Lkeyword{doublePAGE}}
2869 With this option the object also starts at the left paper margin but on the top of the text area.
2870 There will be pagenumbers and a caption can be rotated on the right of the object or under it.
2871
2872 \begin{lstlisting}
2873 \hvFloat[doublePAGE]%
2874 {figure}%
2875 {\includegraphics[width=\dimexpr2\textwidth+2in]{images/seiser}}%
2876 [A doublepage image with a caption below the right part.]%
2877 {A caption for a double-sided image that will be placed below the right-hand
2878 part of the illustration. The illustration begins on the left edge of the paper.
2879 No further text is placed on the pages. A short form is used for the LOF.
2880 The parameter is \texttt{doublePAGE}}%
2881 {fig:doublePAGE0}
2882 \end{lstlisting}
2883
2884
2885 \MarginNote{Fig. \ref{fig:doublePAGE0}}
2886 \hvFloat[doublePAGE]%
2887 {figure}%
2888 {\includegraphics[width=\dimexpr2\textwidth+2in]{images/seiser}}%
2889 [A doublepage image with a caption below the right part.]%
2890 {A caption for a double-sided image that will be placed below the right-hand
2891 part of the illustration. The illustration begins on the left edge of the paper.
2892 No further text is placed on the pages. A short form is used for the LOF.
2893 The parameter is \texttt{doublePAGE}}%
2894 {fig:doublePAGE0}
2895
2896 \hvblindtext
2897
2898 \hvblindtext
2899
2900 \hvBlindtext
2901
2902 \hvBlindtext
2903
2904 \subsection{\Lkeyword{doublePage}}
2905 With this option the object also starts at the left top of the text area.
2906 There will be pagenumbers and a caption can be rotated on the right of the object or under it
2907 and the rest of the text area is filled with text.
2908
2909 \begin{lstlisting}
2910 \hvFloat[doublePage,sameHeight]%
2911 {figure}%
2912 {\includegraphics[doublefullPage]{images/sonne-meer}}%
2913 [A doublepage image with a caption on the right side of the right part.]%
2914 {A caption for a double-sided image that will be placed on the right side of the
2915 right-hand part of the illustration. The illustration begins on the left edge of
2916 the paper. A short form is used for the LOF.
2917 The parameter is \texttt{doublePage}}%
2918 {fig:doublePage0sH}
2919 \end{lstlisting}
2920
2921
2922 \hvFloatSetDefaults
2923
2924 \MarginNote{Fig. \ref{fig:doublePage0sH}}
2925 \hvFloat[doublePage,sameHeight]%
2926 {figure}%
2927 {\includegraphics[doublefullPage]{images/sonne-meer}}%
2928 [A doublepage image with a caption on the right side of the right part.]%
2929 {A caption for a double-sided image that will be placed on the right side of the
2930 right-hand part of the illustration. The illustration begins on the left edge of
2931 the paper. A short form is used for the LOF.
2932 The parameter is \texttt{doublePage}}%
2933 {fig:doublePage0sH}
2934
2935 \hvBlindtext
2936
2937 \hvBlindtext
2938
2939 \hvblindtext
2940
2941 %\hvBlindtext
2942
2943 \hvblindtext
2944
2945
2946 \begin{lstlisting}
2947 \hvFloat[doublePage,capPos=right,capVPos=top]%
2948 {figure}%
2949 {\includegraphics[width=2\textwidth]{images/sonne-meer}}%
2950 [A doublepage image with a caption on the right side of the right part.]%
2951 {A caption for a double-sided image that will be placed on the right side of the
2952 right-hand part of the illustration. The illustration begins on the left edge of
2953 the paper. A short form is used for the LOF.
2954 The parameter is \texttt{doublePage}}%
2955 {fig:doublePage1}
2956 \end{lstlisting}
2957
2958
2959 \hvFloatSetDefaults
2960
2961 \MarginNote{Fig. \ref{fig:doublePage1}}
2962 \hvFloat[doublePage,capPos=right,capVPos=top]%
2963 {figure}%
2964 {\includegraphics[width=2\textwidth]{images/sonne-meer}}%
2965 [A doublepage image with a caption on the right side of the right part.]%
2966 {A caption for a double-sided image that will be placed on the right side of the
2967 right-hand part of the illustration. The illustration begins on the left edge of
2968 the paper. A short form is used for the LOF.
2969 The parameter is \texttt{doublePage}}%
2970 {fig:doublePage1}
2971
2972 \hvBlindtext
2973
2974 \hvBlindtext
2975
2976 \hvBlindtext
2977
2978 \hvBlindtext
2979
2980
2981
2982
2983 \begin{lstlisting}
2984 \hvFloat[doublePage,bindCorr=inner]%
2985 {figure}%
2986 {\includegraphics[width=2\textwidth]{images/sonne-meer}}%
2987 [A doublepage image with a caption on the right side of the right part.]%
2988 {A caption for a double-sided image that will be placed on the right side of the
2989 right-hand part of the illustration. The illustration begins on the left edge of
2990 the paper. A short form is used for the LOF.
2991 The parameter is \texttt{doublePage}}%
2992 {fig:doublePage0sH2}
2993 \end{lstlisting}
2994
2995
2996 \hvFloatSetDefaults
2997
2998 \MarginNote{Fig. \ref{fig:doublePage0sH2}}
2999 \hvFloat[doublePage,bindCorr=inner
3000 ]%
3001 {figure}%
3002 {\includegraphics[width=2\textwidth]{images/sonne-meer}}%
3003 [A doublepage image with a caption on the right side of the right part.]%
3004 {A caption for a double-sided image that will be placed on the right side of the
3005 right-hand part of the illustration. The illustration begins on the left edge of
3006 the paper. A short form is used for the LOF.
3007 The parameter is \texttt{doublePage}}%
3008 {fig:doublePage0sH2}
3009
3010 \hvBlindtext
3011
3012 \hvBlindtext
3013
3014 \hvBlindtext
3015
3016
3017
3018
3019
3020 \hvBlindtext
3021
3022 %\hvBlindtext
3023
3024 \subsection{\Lkeyword{doubleFullPage}}
3025 This places an image over the complete width of two pages (2\Ldim{paperwidth}) without
3026 modifying the height of the object. The caption can be placed on the the left or right side
3027 of the object.
3028
3029
3030 \begin{lstlisting}
3031 \hvFloat[doubleFullPage,capWidth=n,capPos=left]%
3032 {figure}%
3033 {\includegraphics[doubleFullPage]{images/sonne-meer}}%
3034 [A doublepage image with a caption on the left side.]%
3035 {A caption for a double-sided image that will be placed on the left side of the
3036 doublepage part of the illustration. The illustration begins on the left edge of
3037 the paper. A short form is used for the LOF.
3038 The parameter is \texttt{doublePage}}%
3039 {fig:doublePage000}
3040 \end{lstlisting}
3041
3042
3043 \MarginNote{Fig. \ref{fig:doublePage000}}
3044 \hvFloat[doubleFullPage,capWidth=n,capPos=left]%
3045 {figure}%
3046 {\includegraphics[doubleFullPage]{images/sonne-meer}}%
3047 [A doublepage image with a caption on the left side.]%
3048 {A caption for a double-sided image that will be placed on the left side of the
3049 doublepage part of the illustration. The illustration begins on the left edge of
3050 the paper. A short form is used for the LOF.
3051 The parameter is \texttt{doublePage}}%
3052 {fig:doublePage000}
3053
3054 \hvBlindtext
3055
3056 \hvBlindtext
3057
3058 \hvBlindtext
3059
3060 \hvblindtext
3061
3062 %\hvBlindtext
3063
3064 \vfill
3065 \begin{lstlisting}
3066 \hvFloat[doubleFullPage,capWidth=n,sameHeight,capPos=right]%
3067 {figure}%
3068 {\includegraphics[doubleFullPage]{images/sonne-meer}}%
3069 [A doublepage image with a caption on the right side of the right part.]%
3070 {A caption for a double-sided image that will be placed on the right side of the
3071 right-hand part of the illustration. The illustration begins on the left edge of
3072 the paper. A short form is used for the LOF.
3073 The parameter is \texttt{doublePage}}%
3074 {fig:doublePage001}
3075 \end{lstlisting}
3076
3077 Now a pagebreak follows so that the following doublepage object should
3078 immediately placed on the next page.
3079 \newpage
3080
3081
3082 \MarginNote{Fig. \ref{fig:doublePage001}}
3083 \hvFloat[doubleFullPage,capWidth=n,sameHeight,capPos=left]%
3084 {figure}%
3085 {\includegraphics[doubleFullPage]{images/sonne-meer}}%
3086 [A doublepage image with a caption on the right side of the right part.]%
3087 {A caption for a double-sided image that will be placed on the right side of the
3088 right-hand part of the illustration. The illustration begins on the left edge of
3089 the paper. A short form is used for the LOF.
3090 The parameter is \texttt{doublePage}}%
3091 {fig:doublePage001}
3092
3093 \hvBlindtext
3094
3095 \hvBlindtext
3096 \hvBlindtext
3097 \hvBlindtext
3098
3099 \hvBlindtext
3100
3101 \hvBlindtext
3102
3103
3104
3105
3106
3107 \subsection{Tabulars}
3108
3109 In General there is no difference in an imgage or tabular or simple text. The object will be saved in a box and
3110 then clipped. If the object is a tabular one might modify the tabular if it will be split in the middle of a
3111 column. In such a case one can insert some additional horizontal space for this coloumn.
3112
3113 The tabular itself can be saved into the internal box \Lcs{hvOBox} or put directly as parameter into the
3114 macro.
3115
3116
3117 \begin{lstlisting}[basicstyle=\footnotesize\ttfamily]
3118 \global\savebox\hvOBox{%
3119 \begin{tabular}{l*{18}r} \toprule
3120 & \textbf{1972} & \textbf{1973} & \textbf{1974} & \textbf{1975} & \textbf{1976}
3121 & \textbf{1977} & \textbf{1978} & \textbf{1979} & \textbf{1980} & \textbf{1981} & \textbf{1982} & \textbf{1983} & \textbf{1984} & \textbf{1985}
3122 & \textbf{1986} & \textbf{1987} & \textbf{1988} & \textbf{1989}
3123 \\\midrule
3124 \addlinespace[3pt]
3125 Zeile 1 & 1 & 3 & 1 & 1 & 1 & 0 & 1 & 1 & 0 & 0 & 0 & 0 &20 & 0 & 2 & 2 & 2 & 1\\\addlinespace[3pt]
3126 Zeile 2 & 1 & 1 & 3 & 1 & 0 & 0 & 0 & 0 & 0 & 0 & 2 & 1 & 3 & 4 & 4 & 6 & 4 & 2\\\addlinespace[3pt]
3127 Zeile 3 & 2 & 1 & 2 & 1 & 0 & 0 & 0 & 0 & 0 & 0 & 0 & 1 & 5 & 3 & 1 & 7 & 7 & 3\\\addlinespace[3pt]
3128 Zeile 4 & 1 & 0 & 5 & 1 & 2 & 0 & 0 & 0 & 0 & 2 & 1 & 0 & 1 & 0 & 3 & 7 & 2 & 1\\\addlinespace[3pt]
3129 Zeile 6 & 2 & 1 & 1 & 0 & 0 & 0 & 0 & 0 & 0 & 1 & 2 & 0 & 5 & 2 & 2 & 5 & 4 & 2\\\addlinespace[3pt]
3130 Zeile 5 & 0 & 0 & 4 & 2 & 1 & 2 & 2 & 1 & 0 & 0 & 0 & 1 & 1 & 0 & 2 & 5 & 4 & 3\\\addlinespace[3pt]
3131 Zeile 8 & 0 & 1 & 1 & 0 & 0 & 0 & 1 & 1 & 0 & 3 & 2 & 1 & 2 & 1 & 3 & 5 & 3 & 4\\\addlinespace[3pt]
3132 Zeile 9 & 0 & 0 & 0 & 0 & 0 & 1 & 2 & 1 & 0 & 0 & 0 & 0 & 4 & 2 & 1 & 4 & 5 & 2\\\addlinespace[3pt]
3133 Zeile10 & 0 & 1 & 3 & 0 & 1 & 0 & 1 & 0 & 0 & 1 & 1 & 0 & 1 & 1 & 1 & 4 & 4 & 1\\\addlinespace[3pt]
3134 Zeile11 & 0 & 2 & 2 & 1 & 1 & 0 & 1 & 0 & 0 & 0 & 0 & 2 & 6 & 1 & 0 & 2 & 1 & 1 \\\addlinespace[3pt]
3135 Zeile12 & 2 & 0 & 2 & 4 & 1 & 0 & 4 & 0 & 0 & 0 & 0 & 0 & 0 & 0 & 0 & 1 & 0 & 3\\\addlinespace[3pt]
3136 Lärm & 2 & 3 & 0 & 0 & 0 & 0 & 0 & 0 & 0 & 0 & 1 & 0 & 2 & 0 & 0 & 2 & 2 & 2\\\addlinespace[3pt]
3137 Zeile13 & 0 & 1 & 0 & 0 & 1 & 0 & 3 & 0 & 0 & 0 & 0 & 0 & 2 & 0 & 1 & 3 & 0 & 2\\\addlinespace[3pt]
3138 Zeile14 & 0 & 1 & 0 & 0 & 0 & 0 & 0 & 0 & 0 & 0 & 0 & 0 & 3 & 3 & 2 & 1 & 1 & 0\\\addlinespace[3pt]
3139 Zeile15 & 0 & 0 & 0 & 0 & 0 & 0 & 0 & 0 & 0 & 1 & 0 & 0 & 4 & 0 & 0 & 3 & 1 & 1\\\addlinespace[3pt]
3140 Zeile16 & 0 & 0 & 0 & 0 & 0 & 1 & 0 & 0 & 0 & 0 & 0 & 0 & 0 & 0 & 3 & 5 & 0 & 1\\\addlinespace[3pt]\midrule
3141 Artikel gesamt & 2 & 6 & 13 & 8 & 4 & 3 & 5 & 4 & 0 & 6 & 3 & 5 &23 &10 & 8 & 15 & 13 &1 \\
3142 \bottomrule
3143 \end{tabular}}
3144
3145 \hvBlindtext
3146
3147 \hvFloat[doublePage,capPos=right,capVPos=top,floatCapSep=12pt,useOBox]%
3148 {table}%
3149 {}%%%%%%%%%%%%%%
3150 [A doublepage tabular with a caption on the right side of the right part.]%
3151 {A caption for a double-sided tabular that will be placed on the right side of the
3152 right-hand part of the illustration. The illustration begins on the left edge of
3153 the paper. A short form is used for the LOF. The parameter is \texttt{doublePage}}%
3154 {tab:doublePage3}
3155 \end{lstlisting}
3156
3157
3158 \savebox\hvOBox{%
3159 \begin{tabular}{l*{18}r} \toprule
3160 & \textbf{1972} & \textbf{1973} & \textbf{1974} & \textbf{1975} & \textbf{1976}
3161 & \textbf{1977} & \textbf{1978} & \textbf{1979} & \textbf{1980} & \textbf{1981} & \textbf{1982} & \textbf{1983} & \textbf{1984} & \textbf{1985}
3162 & \textbf{1986} & \textbf{1987} & \textbf{1988} & \textbf{1989}
3163 \\\midrule
3164 \addlinespace[3pt]
3165 Zeile 1 & 1 & 3 & 1 & 1 & 1 & 0 & 1 & 1 & 0 & 0 & 0 & 0 &20 & 0 & 2 & 2 & 2 & 1\\\addlinespace[3pt]
3166 Zeile 2 & 1 & 1 & 3 & 1 & 0 & 0 & 0 & 0 & 0 & 0 & 2 & 1 & 3 & 4 & 4 & 6 & 4 & 2\\\addlinespace[3pt]
3167 Zeile 3 & 2 & 1 & 2 & 1 & 0 & 0 & 0 & 0 & 0 & 0 & 0 & 1 & 5 & 3 & 1 & 7 & 7 & 3\\\addlinespace[3pt]
3168 Zeile 4 & 1 & 0 & 5 & 1 & 2 & 0 & 0 & 0 & 0 & 2 & 1 & 0 & 1 & 0 & 3 & 7 & 2 & 1\\\addlinespace[3pt]
3169 Zeile 6 & 2 & 1 & 1 & 0 & 0 & 0 & 0 & 0 & 0 & 1 & 2 & 0 & 5 & 2 & 2 & 5 & 4 & 2\\\addlinespace[3pt]
3170 Zeile 5 & 0 & 0 & 4 & 2 & 1 & 2 & 2 & 1 & 0 & 0 & 0 & 1 & 1 & 0 & 2 & 5 & 4 & 3\\\addlinespace[3pt]
3171 Zeile 8 & 0 & 1 & 1 & 0 & 0 & 0 & 1 & 1 & 0 & 3 & 2 & 1 & 2 & 1 & 3 & 5 & 3 & 4\\\addlinespace[3pt]
3172 Zeile 9 & 0 & 0 & 0 & 0 & 0 & 1 & 2 & 1 & 0 & 0 & 0 & 0 & 4 & 2 & 1 & 4 & 5 & 2\\\addlinespace[3pt]
3173 Zeile10 & 0 & 1 & 3 & 0 & 1 & 0 & 1 & 0 & 0 & 1 & 1 & 0 & 1 & 1 & 1 & 4 & 4 & 1\\\addlinespace[3pt]
3174 Zeile11 & 0 & 2 & 2 & 1 & 1 & 0 & 1 & 0 & 0 & 0 & 0 & 2 & 6 & 1 & 0 & 2 & 1 & 1 \\\addlinespace[3pt]
3175 Zeile12 & 2 & 0 & 2 & 4 & 1 & 0 & 4 & 0 & 0 & 0 & 0 & 0 & 0 & 0 & 0 & 1 & 0 & 3\\\addlinespace[3pt]
3176 Lärm & 2 & 3 & 0 & 0 & 0 & 0 & 0 & 0 & 0 & 0 & 1 & 0 & 2 & 0 & 0 & 2 & 2 & 2\\\addlinespace[3pt]
3177 Zeile13 & 0 & 1 & 0 & 0 & 1 & 0 & 3 & 0 & 0 & 0 & 0 & 0 & 2 & 0 & 1 & 3 & 0 & 2\\\addlinespace[3pt]
3178 Zeile14 & 0 & 1 & 0 & 0 & 0 & 0 & 0 & 0 & 0 & 0 & 0 & 0 & 3 & 3 & 2 & 1 & 1 & 0\\\addlinespace[3pt]
3179 Zeile15 & 0 & 0 & 0 & 0 & 0 & 0 & 0 & 0 & 0 & 1 & 0 & 0 & 4 & 0 & 0 & 3 & 1 & 1\\\addlinespace[3pt]
3180 Zeile16 & 0 & 0 & 0 & 0 & 0 & 1 & 0 & 0 & 0 & 0 & 0 & 0 & 0 & 0 & 3 & 5 & 0 & 1\\\addlinespace[3pt]\midrule
3181 Artikel gesamt & 2 & 6 & 13 & 8 & 4 & 3 & 5 & 4 & 0 & 6 & 3 & 5 &23 &10 & 8 & 15 & 13 &1 \\
3182 \bottomrule
3183 \end{tabular}}
3184
3185
3186 \marginpar{Tab.~\ref{tab:doublePage3}}%
3187 \hvFloat[doublePage,capPos=right,capVPos=top,floatCapSep=12pt]%
3188 {table}%
3189 {\begin{tabular}{l*{18}r} \toprule
3190 & \textbf{1972} & \textbf{1973} & \textbf{1974} & \textbf{1975} & \textbf{1976}
3191 & \textbf{1977} & \textbf{1978} & \textbf{1979} & \textbf{1980} & \textbf{1981} & \textbf{1982} & \textbf{1983} & \textbf{1984} & \textbf{1985}
3192 & \textbf{1986} & \textbf{1987} & \textbf{1988} & \textbf{1989}
3193 \\\midrule
3194 \addlinespace[3pt]
3195 Zeile 1 & 1 & 3 & 1 & 1 & 1 & 0 & 1 & 1 & 0 & 0 & 0 & 0 &20 & 0 & 2 & 2 & 2 & 1\\\addlinespace[3pt]
3196 Zeile 2 & 1 & 1 & 3 & 1 & 0 & 0 & 0 & 0 & 0 & 0 & 2 & 1 & 3 & 4 & 4 & 6 & 4 & 2\\\addlinespace[3pt]
3197 Zeile 3 & 2 & 1 & 2 & 1 & 0 & 0 & 0 & 0 & 0 & 0 & 0 & 1 & 5 & 3 & 1 & 7 & 7 & 3\\\addlinespace[3pt]
3198 Zeile 4 & 1 & 0 & 5 & 1 & 2 & 0 & 0 & 0 & 0 & 2 & 1 & 0 & 1 & 0 & 3 & 7 & 2 & 1\\\addlinespace[3pt]
3199 Zeile 6 & 2 & 1 & 1 & 0 & 0 & 0 & 0 & 0 & 0 & 1 & 2 & 0 & 5 & 2 & 2 & 5 & 4 & 2\\\addlinespace[3pt]
3200 Zeile 5 & 0 & 0 & 4 & 2 & 1 & 2 & 2 & 1 & 0 & 0 & 0 & 1 & 1 & 0 & 2 & 5 & 4 & 3\\\addlinespace[3pt]
3201 Zeile 8 & 0 & 1 & 1 & 0 & 0 & 0 & 1 & 1 & 0 & 3 & 2 & 1 & 2 & 1 & 3 & 5 & 3 & 4\\\addlinespace[3pt]
3202 Zeile 9 & 0 & 0 & 0 & 0 & 0 & 1 & 2 & 1 & 0 & 0 & 0 & 0 & 4 & 2 & 1 & 4 & 5 & 2\\\addlinespace[3pt]
3203 Zeile10 & 0 & 1 & 3 & 0 & 1 & 0 & 1 & 0 & 0 & 1 & 1 & 0 & 1 & 1 & 1 & 4 & 4 & 1\\\addlinespace[3pt]
3204 Zeile11 & 0 & 2 & 2 & 1 & 1 & 0 & 1 & 0 & 0 & 0 & 0 & 2 & 6 & 1 & 0 & 2 & 1 & 1 \\\addlinespace[3pt]
3205 Zeile12 & 2 & 0 & 2 & 4 & 1 & 0 & 4 & 0 & 0 & 0 & 0 & 0 & 0 & 0 & 0 & 1 & 0 & 3\\\addlinespace[3pt]
3206 Lärm & 2 & 3 & 0 & 0 & 0 & 0 & 0 & 0 & 0 & 0 & 1 & 0 & 2 & 0 & 0 & 2 & 2 & 2\\\addlinespace[3pt]
3207 Zeile13 & 0 & 1 & 0 & 0 & 1 & 0 & 3 & 0 & 0 & 0 & 0 & 0 & 2 & 0 & 1 & 3 & 0 & 2\\\addlinespace[3pt]
3208 Zeile14 & 0 & 1 & 0 & 0 & 0 & 0 & 0 & 0 & 0 & 0 & 0 & 0 & 3 & 3 & 2 & 1 & 1 & 0\\\addlinespace[3pt]
3209 Zeile15 & 0 & 0 & 0 & 0 & 0 & 0 & 0 & 0 & 0 & 1 & 0 & 0 & 4 & 0 & 0 & 3 & 1 & 1\\\addlinespace[3pt]
3210 Zeile16 & 0 & 0 & 0 & 0 & 0 & 1 & 0 & 0 & 0 & 0 & 0 & 0 & 0 & 0 & 3 & 5 & 0 & 1\\\addlinespace[3pt]\midrule
3211 Artikel gesamt & 2 & 6 & 13 & 8 & 4 & 3 & 5 & 4 & 0 & 6 & 3 & 5 &23 &10 & 8 & 15 & 13 &1 \\
3212 \bottomrule
3213 \end{tabular}}%%%%%%%%%%%%%%
3214 [A doublepage tabular with a caption on the right side of the right part.]%
3215 {A caption for a double-sided tabular that will be placed on the right side of the
3216 right-hand part of the illustration. The illustration begins on the left edge of
3217 the paper. A short form is used for the LOF.
3218 The parameter is \texttt{doublePage}}%
3219 {tab:doublePage3}
3220
3221
3222 Here comes some snonsense Text to show the output for a \Lcs{hvFloat} which appears
3223 exactly on top of a new even page. This should be detectted by the command so that the
3224 tabular is placed directly on the following double page, starting with the even pagenumber.
3225
3226
3227 \hvBlindtext
3228
3229 \hvBlindtext
3230
3231 \hvBlindtext
3232
3233
3234 \section{References to the page}\label{varioref}
3235 %Whith loading package \texttt{hyperref} references to floating objects with a caption left or right of the object
3236 %are no problem in difference to captions below othe object or on another page (using \texttt{fullpage} option).
3237 %With loading package \texttt{hypcap}
3238 With the command \CMD{pageref} one can have a reference to the page number of a caption. For the
3239 \Lkeyword{fullpage} option this can be the wrong page if someone wants a refence to the page where
3240 the object is set. Let's assume that we use something like
3241
3242 \begin{verbatim}
3243 \hvFloatSetDefaults
3244 \hvFloat[fullpage,capPos=evenPage]{figure}%
3245 {\IncludeGraphics{images/frose}}%
3246 [A float which needs the complete paper width and height.]%
3247 {A Caption of a ``fullpage'' object, which follows on the next page.
3248 This can be an even or odd page. The object uses the complete paper dimensions}%
3249 {demo:fullpage}
3250 \end{verbatim}
3251
3252 The label \texttt{demo:fullpage} is used for the \emph{image} and not for the caption! Internally another label
3253 called \texttt{demo:fullpage-cap} is set on the caption page which can be before or
3254 behind the object (depending to the optional argument of \Lkeyword{capPos}).
3255 For example:
3256
3257 \begin{verbatim}
3258 The caption of figure~\ref{demo:fullpage-cap} is on page~\pageref{demo:fullpage-cap}, but
3259 the image itself is on page~\pageref{demo:fullpage}.
3260 \end{verbatim}
3261
3262
3263 The caption of figure~\ref{demo:fullpage-cap} is on page~\pageref{demo:fullpage-cap}, but
3264 the image itself is on page~\pageref{demo:fullpage}.
3265 With package \Lpack{varioref} it is:
3266
3267 \begin{verbatim}
3268 Whith the package \Lpack{varioref} (\url{https://ctan.org/pkg/varioref})
3269 one can get something like: see figure~\vref{demo:fullpage}, which uses a
3270 ^correct page number of the floatinmg object and not the caption
3271 page number which is~\vpageref{demo:fullpage-cap}.
3272 The figure~\ref{demo:fullpage} is on page~\pageref{demo:fullpage}
3273 and the caption on page~\pageref{demo:fullpage-cap}
3274 \end{verbatim}
3275
3276 Whith the package \Lpack{varioref} (\url{https://ctan.org/pkg/varioref})
3277 one can get something like: see figure~\vref{demo:fullpage}, which uses a
3278 correct page number of the floating object and not the caption
3279 pagenumber which is~\vpageref{demo:fullpage-cap}.
3280 The figure~\ref{demo:fullpage} is on page~\pageref{demo:fullpage}
3281 and the caption on page~\pageref{demo:fullpage-cap}
3282
3283
3284 %\FloatBarrier
3285
3286 \section{Defining a style}
3287
3288 With \Lcs{hvDefFloatStyle} one can define a special style to get rid of the individual setting:
3289
3290 \begin{BDef}
3291 \Lcs{hvDefFloatStyle}\Largb{name}\Largb{setting}
3292 \end{BDef}
3293
3294 For example:
3295 \begin{lstlisting}
3296 \hvDefFloatStyle{RightCaption}{floatPos=htb, capWidth=0.5, capPos=after,
3297 capVPos=bottom, objectPos=center}
3298
3299 \hvFloat[style=RightCaption]{figure}{\includegraphics{images/rose}}%
3300 {Caption vertically centered right beside the float with a caption width of
3301 \texttt{0.5\textbackslash columnwidth}.}{fig:style}
3302 \end{lstlisting}
3303
3304
3305 \hvFloatSetDefaults
3306 \hvDefFloatStyle{RightCaption}{capWidth=0.5, capPos=after, capVPos=bottom, objectPos=center}
3307
3308 \hvFloat[style=RightCaption]{figure}{\includegraphics{images/rose}}%
3309 {Caption at bottom right beside the float with a caption width of
3310 \texttt{0.5\textbackslash columnwidth}.}{fig:style}
3311
3312
3313
3314 \section{Global float setting}
3315 Instead of writing the following sequence into the preamble:
3316
3317 \begin{verbatim}
3318 \makeatletter
3319 \renewcommand\fps@figure{tb}
3320 \renewcommand\fps@table{t}
3321 \makeatother
3322 \end{verbatim}
3323
3324 you can change the global setting of floats by loading the package \Lpack{hvfloat-fps}. It allows
3325 optional package options to set the global placement:
3326
3327
3328 \begin{verbatim}
3329 \usepackage[figure=tb,table=t]{hvfloat-fps}
3330 \end{verbatim}
3331
3332 %\hvBlindtext
3333
3334 \hvBlindtext
3335
3336 %\hvFloatSetDefaults
3337 \hvFloat[FULLPAGE]{figure}%
3338 {\includegraphics[FULLPAGE]{tiger}}%
3339 [A float which needs the complete paper width and height.]%
3340 {A Caption of a ``fullpage'' object, which follows on the next page.
3341 This can be an even or odd page. The object uses the complete paper dimensions}%
3342 {demo:fullpage}
3343
3344
3345 \hvBlindtext
3346
3347 \hvBlindtext
3348
3349 \hvBlindtext
3350
3351
3352 \clearpage
3353
3354 \printindex
3355
3356
3357 %\appendix
3358 %\section{Problems}
3359 %\begin{itemize}
3360 %\item[] With the \texttt{nonfloat} option all objects are left aligned, \verb|\centering| doesn't work here. Only God knows why ...\hfill \textbf{solved!}
3361 %\end{itemize}
3362
3363
3364 %\section{The Package Source}
3365 %\lstinputlisting[basicstyle=\ttfamily\footnotesize,tabsize=3,numbers=left,numberstyle=\tiny]{hvfloat.sty}
3366
3367
3368 \end{document}
3369