summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/hvfloat/doc/hvfloat.tex
diff options
context:
space:
mode:
Diffstat (limited to 'macros/latex/contrib/hvfloat/doc/hvfloat.tex')
-rw-r--r--macros/latex/contrib/hvfloat/doc/hvfloat.tex137
1 files changed, 110 insertions, 27 deletions
diff --git a/macros/latex/contrib/hvfloat/doc/hvfloat.tex b/macros/latex/contrib/hvfloat/doc/hvfloat.tex
index 1082bb1334..4d546a3f63 100644
--- a/macros/latex/contrib/hvfloat/doc/hvfloat.tex
+++ b/macros/latex/contrib/hvfloat/doc/hvfloat.tex
@@ -1,4 +1,4 @@
-%% $Id: hvfloat.tex 75 2021-05-04 19:52:22Z herbert $
+%% $Id: hvfloat.tex 86 2021-05-12 19:25:56Z herbert $
\listfiles
\errorcontextlines=100
\documentclass[twoside,paper=a4,]{scrartcl}
@@ -2477,7 +2477,7 @@ rotated and written \emph{over} the object, or if possible, at the right. The us
\end{description}
\subsection{\Lkeyword{doubleFULLPAGE}}
-The scaling of the image is leave to the user. If the proportion of the object doesn't fit 2*paperwidth/paperheight,
+The scaling of the image is left to the user. If the proportion of the object doesn't fit 2*paperwidth/paperheight,
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
find a marginnote where the following full doublepage image is defined. It appears on the the next following
even page and following text will be placed \emph{before} the object.
@@ -2485,8 +2485,6 @@ even page and following text will be placed \emph{before} the object.
\begin{lstlisting}
-\Blindtext
-
\hvFloat[doubleFULLPAGE,capPos=right,capAngle=90]%
{figure}%
{\includegraphics[angle=90,width=2\paperwidth]{images/r+j}}%
@@ -2496,11 +2494,8 @@ even page and following text will be placed \emph{before} the object.
No further text is placed on the pages. A short form is used for the LOF.
The parameter is \texttt{doubleFULLPAGE}}%
{fig:doubleFULLPAGE0}
-
-\Blindtext
\end{lstlisting}
-\Blindtext
\marginnote{Fig.~\ref{fig:doubleFULLPAGE0}}
\hvFloat[doubleFULLPAGE,capPos=right,capAngle=90]%
{figure}%
@@ -2516,10 +2511,45 @@ even page and following text will be placed \emph{before} the object.
\Blindtext
+\Blindtext
+
+
+It is also possible to take a bind correction into account with e.g. \texttt{binCorr=5mm}, which reserves whitespace of 5mm
+in the inner margin on both pages.
+
\begin{lstlisting}
-\Blindtext
+\hvFloat[doubleFULLPAGE,capPos=right,bindCorr=5mm]%
+ {figure}%
+ {\includegraphics[angle=90,width=2\paperwidth]{images/r+j}}%
+ [A doublepage image with a caption on the image.]%
+ {A caption for a double-sided image that will be placed below the right-hand
+ part of the illustration. The illustration begins on the left edge of the paper.
+ No further text is placed on the pages. A short form is used for the LOF.
+ The parameter is \texttt{doubleFULLPAGE}}%
+ {fig:doubleFULLPAGE0a}
+\end{lstlisting}
+\marginnote{Fig.~\ref{fig:doubleFULLPAGE0a}}
+ \hvFloat[doubleFULLPAGE,capPos=right,bindCorr=5mm]%
+ {figure}%
+ {\includegraphics[height=2\paperwidth,angle=90]{images/r+j}}%
+ [A doublepage image with a caption on the image.]%
+ {A caption for a double-sided image that will be placed on the right-hand
+ part of the illustration. The illustration begins on the left edge of the paper.
+ No further text is placed on the pages. A short form is used for the LOF.
+ The parameter is \texttt{doubleFULLPAGE}}%
+ {fig:doubleFULLPAGE0a}
+
+\Blindtext
+
+\Blindtext
+
+%\Blindtext
+
+
+
+\begin{lstlisting}
\hvFloat[doubleFULLPAGE,capPos=right]%
{figure}%
{\includegraphics[height=\paperheight]{images/rheinsberg}}%
@@ -2528,12 +2558,9 @@ even page and following text will be placed \emph{before} the object.
No further text is placed on the pages. A short form is used for the LOF.
The parameter is \texttt{doubleFULLPAGE}}%
{fig:doubleFULLPAGE1}
-
-\Blindtext \Blindtext
\end{lstlisting}
\marginnote{Fig.~\ref{fig:doubleFULLPAGE1}}
-
\hvFloat[doubleFULLPAGE,capPos=right]%
{figure}%
{\includegraphics[height=\paperheight]{images/rheinsberg}}%
@@ -2546,33 +2573,92 @@ even page and following text will be placed \emph{before} the object.
\Blindtext \Blindtext
+Placing the caption on the image itself is not the best solution. With the optional arguments
+\Lkeyval{before} and \Lkeyval{after} for \Lkeyword{capPos}, the caption can be placed on the bottom
+of the preceding or follwing page of the doublepage object. A givel label, e.g. \texttt{foo} will always point to the
+page with the left part of the object. Internally are two additional labels defined: \texttt{foo-cap} points to the
+caption and \texttt{foo-2} points to the right part of the doublepage object.
+
+In the follwoing example~\ref{foo} the caption is on page~\pageref{foo-cap}, the left image part on page~\pageref{foo}
+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}
+and the right part on page~\pageref{bar-2}. All three labels points to the same figure or table number:
+
+\verb/\ref{foo} | \ref{foo-cap} | \ref{foo-2}/ $\rightarrow$ \ref{foo} | \ref{foo-cap} | \ref{foo-2}
+
+
+\begin{lstlisting}
+ \hvFloat[doubleFULLPAGE,capPos=before]%
+ {figure}%
+ {\includegraphics[height=\paperheight,width=2\paperwidth,
+ keepaspectratio=false]{images/rheinsberg}}%
+ {A caption for a double-sided image that will be placed before
+ the image. The image begins on the left edge of the paper.
+ No further text is placed on the pages. A short form is used for the LOF.
+ The parameter is \texttt{doubleFULLPAGE}}%
+ {foo}
+\end{lstlisting}
+
+\marginnote{Fig.~\ref{foo}}
+ \hvFloat[doubleFULLPAGE,capPos=before]%
+ {figure}%
+ {\includegraphics[height=\paperheight,width=2\paperwidth,keepaspectratio=false]{images/rheinsberg}}%
+ {A caption for a double-sided image that will be placed before
+ the image. The image begins on the left edge of the paper.
+ No further text is placed on the pages. A short form is used for the LOF.
+ The parameter is \texttt{doubleFULLPAGE}}%
+ {foo}
+
+\Blindtext \Blindtext
+
+
+\begin{lstlisting}
+ \hvFloat[doubleFULLPAGE,capPos=after]%
+ {figure}%
+ {\includegraphics[height=\paperheight,width=2\paperwidth,
+ keepaspectratio=false]{images/rheinsberg}}%
+ {A caption for a double-sided image that will be placed after
+ the image. The image begins on the left edge of the paper.
+ No further text is placed on the pages. A short form is used for the LOF.
+ The parameter is \texttt{doubleFULLPAGE}}%
+ {foo}
+\end{lstlisting}
+
+\marginnote{Fig.~\ref{bar}}
+ \hvFloat[doubleFULLPAGE,capPos=after]%
+ {figure}%
+ {\includegraphics[height=\paperheight,width=2\paperwidth,keepaspectratio=false]{images/rheinsberg}}%
+ {A caption for a double-sided image that will be placed after
+ the image. The image begins on the left edge of the paper.
+ No further text is placed on the pages. A short form is used for the LOF.
+ The parameter is \texttt{doubleFULLPAGE}}%
+ {bar}
+\Blindtext
+
+\Blindtext
+
+\hvblindtext
\subsection{\Lkeyword{doublePAGE}}
With this option the object also starts at the left paper margin but on the top of the text area.
There will be pagenumbers and a caption can be rotated on the right of the object or under it.
\begin{lstlisting}
-\Blindtext
-
\hvFloat[doublePAGE]%
{figure}%
- {\includegraphics[width=2\paperwidth]{images/seiser}}%
+ {\includegraphics[width=\dimexpr2\textwidth+2in]{images/seiser}}%
[A doublepage image with a caption below the right part.]%
{A caption for a double-sided image that will be placed below the right-hand
part of the illustration. The illustration begins on the left edge of the paper.
No further text is placed on the pages. A short form is used for the LOF.
The parameter is \texttt{doublePAGE}}%
{fig:doublePAGE0}
-
-\Blindtext
\end{lstlisting}
-\blindtext
\marginnote{Fig. \ref{fig:doublePAGE0}}
\hvFloat[doublePAGE]%
{figure}%
- {\includegraphics[width=2\paperwidth]{images/seiser}}%
+ {\includegraphics[width=\dimexpr2\textwidth+2in]{images/seiser}}%
[A doublepage image with a caption below the right part.]%
{A caption for a double-sided image that will be placed below the right-hand
part of the illustration. The illustration begins on the left edge of the paper.
@@ -2580,6 +2666,8 @@ There will be pagenumbers and a caption can be rotated on the right of the objec
The parameter is \texttt{doublePAGE}}%
{fig:doublePAGE0}
+\hvblindtext
+
\Blindtext
@@ -2589,8 +2677,6 @@ There will be pagenumbers and a caption can be rotated on the right of the objec
and the rest of the text area is filled with text.
\begin{lstlisting}
-\Blindtext
-
\hvFloat[doublePage,capWidth=n,capPos=right]%
{figure}%
{\includegraphics[width=2\textwidth]{images/sonne-meer}}%
@@ -2600,11 +2686,8 @@ and the rest of the text area is filled with text.
the paper. A short form is used for the LOF.
The parameter is \texttt{doublePage}}%
{fig:doublePage0}
-
-\Blindtext
\end{lstlisting}
-\Blindtext
\marginnote{Fig. \ref{fig:doublePage0}}
\hvFloat[doublePage,capWidth=n,capPos=right]%
@@ -2619,6 +2702,8 @@ and the rest of the text area is filled with text.
\Blindtext
+\Blindtext
+
\hvblindtext
\subsection{Tabulars}
@@ -2659,6 +2744,8 @@ Artikel gesamt & 2 & 6 & 13 & 8 & 4 & 3 & 5 & 4 & 0 & 6 & 3 & 5 &23 &10 & 8 & 15
\bottomrule
\end{tabular}}
+\Blindtext
+
\hvFloat[doublePage,capWidth=n,capPos=right]%
{table}%
{\usebox\hvOBox}%%%%%%%%%%%%%%
@@ -2668,11 +2755,8 @@ Artikel gesamt & 2 & 6 & 13 & 8 & 4 & 3 & 5 & 4 & 0 & 6 & 3 & 5 &23 &10 & 8 & 15
the paper. A short form is used for the LOF.
The parameter is \texttt{doublePage}}%
{tab:doublePage3}
-
-\Blindtext
\end{lstlisting}
-\Blindtext
\marginpar{Tab.~\ref{tab:doublePage3}}
\global\savebox\hvOBox{%
@@ -2718,7 +2802,6 @@ Artikel gesamt & 2 & 6 & 13 & 8 & 4 & 3 & 5 & 4 & 0 & 6 & 3 & 5 &23 &10 & 8 & 15
-
\section{References to the page}\label{varioref}
%Whith loading package \texttt{hyperref} references to floating objects with a caption left or right of the object
%are no problem in difference to captions below othe object or on another page (using \texttt{fullpage} option).