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.tex68
1 files changed, 56 insertions, 12 deletions
diff --git a/macros/latex/contrib/hvfloat/doc/hvfloat.tex b/macros/latex/contrib/hvfloat/doc/hvfloat.tex
index 1ab2adddaa..40bb098819 100644
--- a/macros/latex/contrib/hvfloat/doc/hvfloat.tex
+++ b/macros/latex/contrib/hvfloat/doc/hvfloat.tex
@@ -1,7 +1,7 @@
-%% $Id: hvfloat.tex 774 2023-10-16 13:44:29Z herbert $
-\listfiles
+%% $Id: hvfloat.tex 876 2024-03-03 14:04:56Z herbert $
+%\listfiles
\errorcontextlines=100
-\documentclass[twoside,paper=a4,usegeometry]{scrartcl}
+\documentclass[twoside,paper=a4,usegeometry,index=totoc]{scrartcl}
\usepackage{fontspec}
\usepackage[silent]{libertinus-otf}
%\usepackage[scaled=0.85]{beramono}
@@ -251,6 +251,7 @@ way with \Lcs{setlength} or \Lcs{addtolength}.
The following packages are loaded by \Lpack{hvfloat} and the optional argument
\Loption{hypcap} is passed to the packages \Lpack{caption} and \Lpack{subcaption}:
+\Lpack{fbox},
\Lpack{caption},
\Lpack{subcaption},
\Lpack{atbegshi},
@@ -400,6 +401,8 @@ There are the following keywords:
\Lkeyword{inMargin} & false & \rowvsp Put object and frame into the margin.\\
\Lkeyword{objectFrame} & false & \rowvsp Put a frame with no separation
around the float object.\\
+\Lkeyword{fboxLines} & ltrb & \rowvsp Lines around the box l)eft, t)op, r)ight, b)ottom\\
+\Lkeyword{fboxSep} & 0pt & \rowvsp Additional box separation (like \Ldim{fboxsep})\\
\Lkeyword{style} & \none & \rowvsp Use a defined style.\\
\Lkeyword{capFormat} & \none & \rowvsp Define formatting options for
\Lcs{caption}; see documentation of package \Lpack{caption}.\\
@@ -537,6 +540,23 @@ minus the width of the object and the space between object and caption, which is
the separation between object and caption, and the current linewidth.}{fig:width1}
+The same with box lines only on the left and right:
+
+\begin{lstlisting}
+\hvFloat[floatPos=!htb,capPos=after,objectFrame,
+ fboxLines=lr,fboxSep=0pt]{figure}{\includegraphics[scale=1.5]{images/rose}}%
+ {Caption right beside with a \emph{natural} width, which is given by the width of the object,
+ the separation between object and caption, and the current linewidth.}{fig:width1A}
+\end{lstlisting}
+
+\MarginNote{Fig.~\ref{fig:width1A}}
+\hvFloat[floatPos=!htb,capPos=after,objectFrame,
+ fboxLines=lr,fboxSep=0pt]{figure}{\includegraphics[scale=1.5]{images/rose}}%
+ {Caption right beside with a \emph{natural} width, which is given by the width of the object,
+ the separation between object and caption, and the current linewidth.}{fig:width1A}
+
+
+
\subsection{Relative linewidth}
With \Lkeyword{capWidth}\texttt{=<number>} the caption width is set to \texttt{<number>}\Ldim{columnwidth}.
@@ -2742,9 +2762,9 @@ 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}
+\verb/\ref{foo} | \ref{foo-cap} | \ref{foo-2}/ $\rightarrow$ Figure~\ref{foo} | Figure~\ref{foo-cap} | Figure~\ref{foo-2}
-\verb/\pageref{foo} | \pageref{foo-cap} | \pageref{foo-2}/ $\rightarrow$ \pageref{foo} | \pageref{foo-cap} | \pageref{foo-2}
+\verb/\pageref{foo} | \pageref{foo-cap} | \pageref{foo-2}/ $\rightarrow$ Page~\pageref{foo} | Page~\pageref{foo-cap} | Page~\pageref{foo-2}
\begin{lstlisting}
\hvFloat[doubleFULLPAGE,capPos=after]%
@@ -2806,9 +2826,9 @@ and the right part on page~\pageref{bar-2}. All three labels points to the same
\hvBlindtext
-\hvblindtext
+\hvBlindtext
-%\hvblindtext
+\hvblindtext
\subsection{\Lkeyword{doublePAGE}}
With this option the object also starts at the left paper margin but on the top of the text area.
@@ -3001,9 +3021,11 @@ of the object.
\hvBlindtext
-\hvBlindtext
+%\hvBlindtext
\hvBlindtext
+
+\vfill
\begin{lstlisting}
\hvFloat[doubleFullPage,capWidth=n,sameHeight,capPos=right]%
{figure}%
@@ -3016,9 +3038,13 @@ of the object.
{fig:doublePage001}
\end{lstlisting}
+Now a pagebreak follows so that the following doublepage object should
+immediately placed on the next page.
+\newpage
+
\MarginNote{Fig. \ref{fig:doublePage001}}
-\hvFloat[doubleFullPage,capWidth=n,sameHeight,capPos=right]%
+\hvFloat[doubleFullPage,capWidth=n,sameHeight,capPos=left]%
{figure}%
{\includegraphics[doubleFullPage]{images/sonne-meer}}%
[A doublepage image with a caption on the right side of the right part.]%
@@ -3035,6 +3061,17 @@ of the object.
\hvBlindtext
\hvBlindtext
+\hvblindtext
+\hvblindtext
+
+\hvblindtext
+\hvblindtext
+
+%\hvBlindtext
+%\hvBlindtext
+\hvBlindtext
+
+\hvBlindtext
@@ -3086,13 +3123,11 @@ Artikel gesamt & 2 & 6 & 13 & 8 & 4 & 3 & 5 & 4 & 0 & 6 & 3 & 5 &23 &10 & 8 & 15
[A doublepage tabular with a caption on the right side of the right part.]%
{A caption for a double-sided tabular that will be placed on the right side of the
right-hand part of the illustration. The illustration begins on the left edge of
- the paper. A short form is used for the LOF.
- The parameter is \texttt{doublePage}}%
+ the paper. A short form is used for the LOF. The parameter is \texttt{doublePage}}%
{tab:doublePage3}
\end{lstlisting}
-\marginpar{Tab.~\ref{tab:doublePage3}}
\global\savebox\hvOBox{%
\begin{tabular}{l*{18}r} \toprule
& \textbf{1972} & \textbf{1973} & \textbf{1974} & \textbf{1975} & \textbf{1976}
@@ -3121,6 +3156,7 @@ Artikel gesamt & 2 & 6 & 13 & 8 & 4 & 3 & 5 & 4 & 0 & 6 & 3 & 5 &23 &10 & 8 & 15
\end{tabular}}
+\marginpar{Tab.~\ref{tab:doublePage3}}%
\hvFloat[doublePage,capPos=right,capVPos=top,floatCapSep=12pt]%
{table}%
{\usebox\hvOBox}%%%%%%%%%%%%%%
@@ -3131,6 +3167,14 @@ Artikel gesamt & 2 & 6 & 13 & 8 & 4 & 3 & 5 & 4 & 0 & 6 & 3 & 5 &23 &10 & 8 & 15
The parameter is \texttt{doublePage}}%
{tab:doublePage3}
+
+Here comes some snonsense Text to show the output for a \Lcs{hvFloat} which appears
+exactly on top of a new even page. This should be detectted by the command so that the
+tabular is placed directly on the following double page, starting with the even pagenumber.
+
+
+\hvBlindtext
+
\hvBlindtext
\hvBlindtext