From 0f69e2fd4a9928663f0cc64b8cac1f0d8baee9d6 Mon Sep 17 00:00:00 2001
From: Norbert Preining <norbert@preining.info>
Date: Tue, 1 Jun 2021 03:00:58 +0000
Subject: CTAN sync 202106010300

---
 macros/latex/contrib/hvfloat/doc/hvfloat.tex | 149 ++++++++++++++-------------
 1 file changed, 78 insertions(+), 71 deletions(-)

(limited to 'macros/latex/contrib/hvfloat/doc/hvfloat.tex')

diff --git a/macros/latex/contrib/hvfloat/doc/hvfloat.tex b/macros/latex/contrib/hvfloat/doc/hvfloat.tex
index 902f9c0754..807a63415e 100644
--- a/macros/latex/contrib/hvfloat/doc/hvfloat.tex
+++ b/macros/latex/contrib/hvfloat/doc/hvfloat.tex
@@ -1,4 +1,4 @@
-%% $Id: hvfloat.tex 90 2021-05-14 09:08:46Z herbert $
+%% $Id: hvfloat.tex 103 2021-05-31 12:37:11Z herbert $
 \listfiles
 \errorcontextlines=100
 \documentclass[twoside,paper=a4,]{scrartcl}
@@ -210,7 +210,8 @@ marginnote \fbox{float} is set into the margin. This is done also only for demon
 \Loption{fbox} & The objects and captions are put into a \Lcs{fbox} command, like in 
 this documentation. This doesn't make real sense and is only for some demonstration useful or for locating
 problems if images seems to have too much whitespace.\\
-\Loption{hyperref} & Load package \Lpack{hyperref}. % and also package \Lpack{hypcap}. 
+\Loption{hyperref} & Load package \Lpack{hyperref}.\\
+\Loption{nostfloats} & do not load package \Lpack{stfloats}.  
 \end{tabularx}
 
 \bigskip
@@ -225,7 +226,7 @@ The following packages are loaded by \Lpack{hvfloat} and the optional argument
 \Lpack{caption}, 
 \Lpack{subcaption},
 \Lpack{atbegshi},
-%\RequirePackage{hyperref}
+\Lpack{stfloats},
 \Lpack{expl3}, \Lpack{multido},
 \Lpack{graphicx},
 \Lpack{xkeyval},
@@ -271,16 +272,18 @@ A label can be put inside the argument or after the command in the usual way, so
 the not existing table~\ref{dummy} is no problem.
 
 {\small\begin{verbatim}
-[...] It is no problem to use the \verb|\tabcaption| command to place a caption anywhere, 
-like here in an  inlined mode: \tabcaption[The Caption without sense ...]{A Caption without any 
-sense and any object}\label{dummy} A label can be put inside the argument or after the command 
-in the usual way, so that a reference to  the not existing table~\ref{dummy} is no problem.
+[...] It is no problem to use the \verb|\tabcaption| 
+command to place a caption anywhere, 
+like here in an  inlined mode: 
+\tabcaption[The Caption without sense ...]%
+{A Caption without any sense and any 
+object}\label{dummy} A label can be put 
+inside the argument or after the command 
+in the usual way, so that a reference to  
+the not existing table~\ref{dummy} is no problem.
 \end{verbatim}}
 
 
-%\hvDefFloatStyle
-%\hvFloatSetDefaults 
-
 With the macro \Lcs{hvDefFloatStyle} one can define a style which can be used instead of 
 the individual setting:
 
@@ -290,10 +293,6 @@ the individual setting:
 
 Internally the style is saved in a macro named \verb|\hv@<name>|.
 
-
-%\index{capPos@\texttt {capPos} (keyword)|(}
-
-%\subsection{The Options}
 There are the following keywords:
 
 \begin{xltabular}{\textwidth}{@{} l>{\small\ttfamily}cX @{}}
@@ -307,52 +306,45 @@ There are the following keywords:
 \endfoot
 \bottomrule
 \endlastfoot
+
 \Lkeyword{floatPos} & \texttt{tbp} & This is the same default placement setting like the one from standard \LaTeX, but maybe not always
 the best setting. \\
-\Lkeyword{rotAngle} & 0& The value for the angle if both, the object and the caption should be rotated in the same way.\\
-
-\Lkeyword{capWidth} & n& The width of the caption. Can be »\texttt{n}« like a natural width, 
+\Lkeyword{rotAngle} & 0& The value for the angle if both, the object and the caption, should be rotated together.\\
+\Lkeyword{capWidth} & n& The width of the caption. Can be »\texttt{n}« like a natural width given by the current linewidth, 
  »\texttt{w}« for the width of the object, »\texttt{h}« for the height of the object, or a scale for \verb|\columnwidth|.\\
-
-\Lkeyword{capAngle} & 0 & The value for the angle if the caption should be rotated. Counted anti clockwise.\\
-
+\Lkeyword{capAngle} & 0 & The integer value for the angle if the caption should be rotated. Counted counter clockwise.\\
 \Lkeyword{capPos} & bottom& The position of the caption relative to the object. Possible values are\\ 
                   &       & \Lkeyval{before}: \emph{always} before (left) from the object.\\
                   &       & \Lkeyval{top}: \emph{always} on top of  the object.\\
-                  &       & \Lkeyval{left}: \emph{always} before (left) from the object, but on the \emph{same page} in \Index{twocolumn} mode.\\
+                  &       & \Lkeyval{left}: \emph{always} before (left) from the object, but on the \emph{same page} in twocolumn mode.\\
                   &       & \Lkeyval{after}: \emph{always} after (right) from the object.\\
                   &       & \Lkeyval{bottom}: \emph{always} on the bottom of the object.\\
-                  &       & \Lkeyval{right}: \emph{always} after (right) from the object, but on the \emph{same page} in \Index{twocolumn} mode.\\
-                  &       & \Lkeyval{inner}: in \Index{twoside} mode always typeset at the inner margin.\\
-                  &       & \Lkeyval{outer}: in \Index{twoside} mode always typeset at the outer margin.\\
-                  &       & \Lkeyval{evenPage}: in \Index{twoside} mode with \Index{fullpage} objects always on an even page.\\
-                  &       & \Lkeyval{oddPage}: in \Index{twoside} mode with \Index{fullpage} objects always on an odd page.\\
-
+                  &       & \Lkeyval{right}: \emph{always} after (right) from the object, but on the \emph{same page} in twocolumn mode.\\
+                  &       & \Lkeyval{inner}: in twoside mode always typeset at the inner margin.\\
+                  &       & \Lkeyval{outer}: in twoside mode always typeset at the outer margin.\\
+                  &       & \Lkeyval{evenPage}: in twoside mode with fullpage objects always on an even page.\\
+                  &       & \Lkeyval{oddPage}: in twoside mode with fullpage objects always on an odd page.\\
 \Lkeyword{capVPos}& center& This is only important for \texttt{capPos=left|right}. Only in this case the 
     caption can vertically placed at the \Lkeyval{bottom}, \Lkeyval{center} and \Lkeyval{top}.\\
-
-\Lkeyword{objectPos} & center & The horizontalplacement of the object relative to the document. Possible values are (\textbf{l})eft|(\textbf{c})enter|(\textbf{r})ight.\\
-
-\Lkeyword{objectAngle} & 0 & The value for the angle if the object should be rotated. Counted anti clockwise.\\
-
-\Lkeyword{floatCapSep} & 5pt & The additional width between the object and a left or right placed caption.\\
-
-
+\Lkeyword{objectPos} & center & The horizontal placement of the object relative to the document. 
+Possible values are (\textbf{l})eft|(\textbf{c})enter|(\textbf{r})ight.\\
+\Lkeyword{objectAngle} & 0 & The integer value for the angle if the object should be rotated. Counted counter clockwise.\\
+\Lkeyword{floatCapSep} & 5pt & The additional space between the object and a left or right placed caption.\\
 \Lkeyword{useOBox} & false & Instead of passing the object as parameter to the \Lcs{hvFloat}, the contents maybe saved in the box \texttt{\textbackslash hvOBox} With \texttt{useOBox=true} the contents of this box will be used.\\
-
 \Lkeyword{onlyText} & false & The caption will be printed as normal text and there is no entry in the list of \ldots.\\
-
-\Lkeyword{nonFloat} & false & The object isn't put in a floating environment. It is printed as standard text with an additional caption. The float counters are increased as usual and can be referenced.\\
-
+\Lkeyword{nonFloat} & false & The object isn't put in a floating environment. It is printed as standard text with an additional caption. The float counter is increased as usual and can be referenced.\\
 \Lkeyword{wide} & false & The float can use \Ldim{textwidth}+\Ldim{marginparwidth} as horizontal width.\\
-
 \Lkeyword{objectFrame} & false & put a frame with no separation around the float object.\\
-
 \Lkeyword{style} & --- & Use a defined style\\
-
 \Lkeyword{capFormat} & --- & Define formatting options for \Lcs{caption} (see documentation of package \Lpack{caption}).\\
-
 \Lkeyword{subcapFormat} & --- & Define formatting options for \Lcs{subcaption}.\\
+\Lkeyword{fullpage} & false & Use a complete column in twocolumn mode.\\
+\Lkeyword{FULLPAGE} & false & Use the complete paper width/height for the object.\\
+\Lkeyword{FullPage} & false & Use the complete text area for the object.\\
+\Lkeyword{doublePage} & false &  Use the textarea on a doublepage with additional text.\\
+\Lkeyword{doublePAGE} & false & Use the textarea on a doublepage without additional text.\\
+\Lkeyword{doubleFULLPAGE} & false & Use the paperwidth on a doublepage without additional text.\\
+\Lkeyword{vFill} & false & Put a \Lcs{vfill} between every two objects in a multi- or subfloat.\\
 \end{xltabular} 
 
 
@@ -1717,14 +1709,14 @@ can be mixed:
 
 \begin{lstlisting}
 \captionsetup{singlelinecheck=false}
-\hvFloat[fullpage,capPos=before,multiFloat]%
+\hvFloat[fullpage,capPos=before,multiFloat,vFill]%
   +{figure}{\includegraphics[width=\linewidth]{images/CTAN}}%%                   no 1
    [Short caption A]%
    {A Caption A of a ``fullpage'' object, which follows on the left or
     right column. This can be an even or odd page. And some more text whch has no
     real meaning because it fills only the space for a long caption.}%
    {img:demo0}%
-  +{table}{\begin{tabular}{lrcp{3cm}}\hline                 %             no 2
+  +{table}{\begin{tabular}{lrcp{3cm}}\hline                        %             no 2
             Linksbündig & Rechtsbündig & Zentriert & Parbox\\\hline
             L           & R            & C         & P\\
             left        & right        & center    & Text with possible linebreaks\\
@@ -1802,7 +1794,7 @@ float type entry is ignored.
 
 
 \begin{lstlisting}
-\hvFloat[fullpage,capPos=before,objectFrame,subFloat]%
+\hvFloat[fullpage,capPos=before,objectFrame,subFloat,vFill]%
   +{figure}{}[Short main caption of the objects]%   main short lsi entry
    {The main  caption of a ``fullpage'' object, which follows on the left or
         right column. This can be an even or odd page. And some more text whch has no
@@ -1816,11 +1808,9 @@ float type entry is ignored.
    {A Caption C of a ``fullpage'' object, which follows on the left or right column.}%
    {sub:demo1}
   +{}{\includegraphics[width=\linewidth]{images/CTAN}}%
-   {A Caption D of a ``fullpage'' object}%
-   {sub:demo2}
+   {A Caption D of a ``fullpage'' object}{sub:demo2}
   +{}{\includegraphics[width=\linewidth]{images/CTAN}}%
-   {A Caption E of a ``fullpage'' object}%
-   {sub:demo3}
+   {A Caption E of a ``fullpage'' object}{sub:demo3}
 \end{lstlisting}
 
 
@@ -1830,7 +1820,7 @@ The package \Lpack{subcaption} is loaded by default and should be activated with
 
 
 
-\begin{figure}[p]
+\begin{figure}[!htb]
 \frame{\includegraphics[page=4,width=0.24\linewidth]{examples/sub-default1s1c}}\hfill
 \frame{\includegraphics[page=5,width=0.24\linewidth]{examples/sub-default1s1c}}\hfill
 \frame{\includegraphics[page=6,width=0.24\linewidth]{examples/sub-default1s1c}}\hfill
@@ -1841,7 +1831,9 @@ The package \Lpack{subcaption} is loaded by default and should be activated with
 \frame{\includegraphics[page=10,width=0.24\linewidth]{examples/sub-default1s1c}}\hfill
 \frame{\includegraphics[page=11,width=0.24\linewidth]{examples/sub-default1s1c}}
 \caption{Output of \texttt{sub-default1s1c} (pages 4--11)}\label{sub-default1s1c}
+\end{figure}
 
+\begin{figure}[!htb]
 \frame{\includegraphics[page=4,width=0.24\linewidth]{examples/sub-after1s1c}}\hfill
 \frame{\includegraphics[page=5,width=0.24\linewidth]{examples/sub-after1s1c}}\hfill
 \frame{\includegraphics[page=6,width=0.24\linewidth]{examples/sub-after1s1c}}\hfill
@@ -2277,7 +2269,7 @@ can be mixed:
 
 \begin{lstlisting}
 \captionsetup{singlelinecheck=false}
-\hvFloat[fullpage,multiFloat,capPos=inner]%
+\hvFloat[fullpage,multiFloat,capPos=inner,vFill]%
   +{figure}{\includegraphics[height=0.4\textheight]{images/rose}}%%  no 1
    [Short caption A]%
    {A Caption A of a ``fullpage'' object, which follows on the left or
@@ -2376,7 +2368,7 @@ float type entry is ignored.
 
 \begin{lstlisting}
 \captionsetup[sub]{singlelinecheck}
-\hvFloat[fullpage,capPos=before,objectFrame,subFloat]%
+\hvFloat[fullpage,capPos=before,objectFrame,subFloat,vFill]%
   +{figure}{}[Short main caption of the objects]%   main short lsi entry
    {The main  caption of a ``fullpage'' object, which follows on the left or
         right column. This can be an even or odd page. And some more text whch has no
@@ -2498,7 +2490,7 @@ even page and  following text will be placed \emph{before} the object.
 \marginnote{Fig.~\ref{fig:doubleFULLPAGE0}}
  \hvFloat[doubleFULLPAGE,capPos=right,capAngle=90]%
   {figure}%
-  {\includegraphics[height=2\paperwidth,angle=90]{images/r+j}}%
+  {\includegraphics[angle=90,height=\paperheight]{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. 
@@ -2587,9 +2579,9 @@ and the right part on page~\pageref{bar-2}. All three labels points to the same
 \verb/\pageref{foo} | \pageref{foo-cap} | \pageref{foo-2}/ $\rightarrow$ \pageref{foo} | \pageref{foo-cap} | \pageref{foo-2}
 
 \begin{lstlisting}
- \hvFloat[doubleFULLPAGE,capPos=before]%
+ \hvFloat[doubleFULLPAGE,capPos=after]%
   {figure}%
-  {\includegraphics[height=\paperheight,width=2\paperwidth,
+  {\includegraphics[doubleFULLPAGE,
     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. 
@@ -2598,21 +2590,27 @@ and the right part on page~\pageref{bar-2}. All three labels points to the same
   {foo}
 \end{lstlisting}
 
+\hvFloatSetDefaults
+
 \marginnote{Fig.~\ref{foo}}
- \hvFloat[doubleFULLPAGE,capPos=before]%
+ \hvFloat[doubleFULLPAGE,capPos=after]%
   {figure}%
-  {\includegraphics[height=\paperheight,width=2\paperwidth,keepaspectratio=false]{images/rheinsberg}}%
+  {\includegraphics[doubleFULLPAGE]{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
+\Blindtext %\Blindtext 
 
+\hvblindtext
+
+\hvblindtext
+\hvblindtext
 
 \begin{lstlisting}
- \hvFloat[doubleFULLPAGE,capPos=after]%
+ \hvFloat[doubleFULLPAGE,capPos=before]%
   {figure}%
   {\includegraphics[height=\paperheight,width=2\paperwidth,
     keepaspectratio=false]{images/rheinsberg}}%
@@ -2620,11 +2618,11 @@ and the right part on page~\pageref{bar-2}. All three labels points to the same
    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}
+  {bar}
 \end{lstlisting}
 
 \marginnote{Fig.~\ref{bar}}
- \hvFloat[doubleFULLPAGE,capPos=after]%
+ \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 after 
@@ -2638,6 +2636,9 @@ and the right part on page~\pageref{bar-2}. All three labels points to the same
 \Blindtext
 
 \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.
 There will be pagenumbers and a caption can be rotated on the right of the object or under it.
@@ -2666,10 +2667,11 @@ There will be pagenumbers and a caption can be rotated on the right of the objec
    The parameter is \texttt{doublePAGE}}%
   {fig:doublePAGE0}
 
-\hvblindtext
+%\hvblindtext
 
 \Blindtext
 
+\Blindtext
 
 \subsection{\Lkeyword{doublePage}}
 With this option the object also starts at the left top of the text area.
@@ -2689,6 +2691,8 @@ and the rest of the text area is filled with text.
 \end{lstlisting}
 
 
+%\hvFloatSetDefaults
+
 \marginnote{Fig. \ref{fig:doublePage0}}
 \hvFloat[doublePage,capWidth=n,capPos=right]%
   {figure}%
@@ -2746,7 +2750,7 @@ Artikel gesamt & 2 & 6 & 13 & 8 & 4 & 3 & 5 & 4 & 0 & 6 & 3 & 5 &23 &10 & 8 & 15
 
 \Blindtext
 
-\hvFloat[doublePage,capWidth=n,capPos=right]%
+\hvFloat[doublePage,capWidth=n,capPos=right,capVPos=top]%
   {table}%
   {\usebox\hvOBox}%%%%%%%%%%%%%%
   [A doublepage tabular with a caption on the right side of the right part.]%
@@ -2786,6 +2790,7 @@ Artikel gesamt & 2 & 6 & 13 & 8 & 4 & 3 & 5 & 4 & 0 & 6 & 3 & 5 &23 &10 & 8 & 15
 \bottomrule
 \end{tabular}}
 
+
 \hvFloat[doublePage,capWidth=n,capPos=right]%
   {table}%
   {\usebox\hvOBox}%%%%%%%%%%%%%%
@@ -2801,7 +2806,6 @@ Artikel gesamt & 2 & 6 & 13 & 8 & 4 & 3 & 5 & 4 & 0 & 6 & 3 & 5 &23 &10 & 8 & 15
 \Blindtext
 
 
-
 \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).
@@ -2838,7 +2842,7 @@ With package \Lpack{varioref} it is:
 \begin{verbatim}
 Whith the package \Lpack{varioref} (\url{https://ctan.org/pkg/varioref}) 
 one can get something like: see figure~\vref{demo:fullpage}, which uses a 
-correct page number of the floatinmg object and not the caption 
+^correct page number of the floatinmg object and not the caption 
 page number which is~\vpageref{demo:fullpage-cap}.
 The figure~\ref{demo:fullpage} is on page~\pageref{demo:fullpage}
 and the caption on page~\pageref{demo:fullpage-cap}
@@ -2852,7 +2856,7 @@ The figure~\ref{demo:fullpage} is on page~\pageref{demo:fullpage}
 and the caption on page~\pageref{demo:fullpage-cap}
 
 
-\FloatBarrier
+%\FloatBarrier
 
 \section{Defining a style}
 
@@ -2876,16 +2880,16 @@ For example:
 
 
 \hvFloatSetDefaults
-\hvDefFloatStyle{RightCaption}{floatPos=htb, capWidth=0.5, capPos=after, capVPos=bottom, objectPos=center}
-
+\hvDefFloatStyle{RightCaption}{capWidth=0.5, capPos=after, capVPos=bottom, objectPos=center}
 
 \hvFloat[style=RightCaption]{figure}{\includegraphics{images/rose}}%
   {Caption at bottom right beside the float with a caption width of 
    \texttt{0.5\textbackslash columnwidth}.}{fig:style}
 
 
-\hvblindtext
+\Blindtext
 
+\Blindtext
 
 
 \section{Global float setting}
@@ -2908,6 +2912,8 @@ optional package options to set the global placement:
 
 \Blindtext
 
+\Blindtext
+
 %\hvFloatSetDefaults
 \hvFloat[FULLPAGE]{figure}%
   {\includegraphics[FULLPAGE]{tiger}}%
@@ -2919,8 +2925,9 @@ optional package options to set the global placement:
 
 \Blindtext
 
-\printindex
+\Blindtext
 
+\printindex
 
 \clearpage
 
-- 
cgit v1.2.3

