summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/hvfloat/doc
diff options
context:
space:
mode:
authorNorbert Preining <norbert@preining.info>2021-05-04 03:01:16 +0000
committerNorbert Preining <norbert@preining.info>2021-05-04 03:01:16 +0000
commit342f2e1be699f5ec70b5b1c35d9cd59798d37304 (patch)
treeb0e2ca800047194391139c36c6f3e3dc3b3d2094 /macros/latex/contrib/hvfloat/doc
parentbf393e635d1fb55b009da7ade3001c104c7deb48 (diff)
CTAN sync 202105040301
Diffstat (limited to 'macros/latex/contrib/hvfloat/doc')
-rw-r--r--macros/latex/contrib/hvfloat/doc/hvfloat.pdfbin18344774 -> 18366111 bytes
-rw-r--r--macros/latex/contrib/hvfloat/doc/hvfloat.tex33
-rw-r--r--macros/latex/contrib/hvfloat/doc/images/missing.txt3
3 files changed, 22 insertions, 14 deletions
diff --git a/macros/latex/contrib/hvfloat/doc/hvfloat.pdf b/macros/latex/contrib/hvfloat/doc/hvfloat.pdf
index 50b449eb45..b174232b47 100644
--- a/macros/latex/contrib/hvfloat/doc/hvfloat.pdf
+++ b/macros/latex/contrib/hvfloat/doc/hvfloat.pdf
Binary files differ
diff --git a/macros/latex/contrib/hvfloat/doc/hvfloat.tex b/macros/latex/contrib/hvfloat/doc/hvfloat.tex
index 18d4d56527..18c0898a59 100644
--- a/macros/latex/contrib/hvfloat/doc/hvfloat.tex
+++ b/macros/latex/contrib/hvfloat/doc/hvfloat.tex
@@ -1,7 +1,7 @@
-%% $Id: hvfloat.tex 56 2021-03-15 07:20:37Z herbert $
+%% $Id: hvfloat.tex 73 2021-05-03 07:38:13Z herbert $
\listfiles
\errorcontextlines=100
-\documentclass[twoside,paper=a4]{scrartcl}
+\documentclass[twoside,paper=a4,]{scrartcl}
\usepackage{fontspec}
\usepackage{libertinus}
%\usepackage[scaled=0.85]{beramono}
@@ -305,7 +305,8 @@ There are the following keywords:
\endfoot
\bottomrule
\endlastfoot
-\Lkeyword{floatPos} & \texttt{htb} & This is \emph{not} the same default placement setting like the one from the floats.\\
+\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,
@@ -313,17 +314,19 @@ There are the following keywords:
\Lkeyword{capAngle} & 0 & The value for the angle if the caption should be rotated. Counted anti clockwise.\\
-\Lkeyword{capPos} & before& The position of the caption relative to the object. Possible values are\\
+\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{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.\\
-\Lkeyword{capVPos}& c& This is only important for \texttt{capPos=left|right}. Only in this case the
+\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.\\
@@ -335,6 +338,8 @@ There are the following keywords:
\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{wide} & false & The float can use \Ldim{textwidth}+\Ldim{marginparwidth} as horizontal width.\\
@@ -2479,7 +2484,7 @@ even page and following text will be placed \emph{before} the object.
\begin{lstlisting}
\Blindtext
-\hvFloat[doubleFULLPAGE,capPos=r,capAngle=90]%
+\hvFloat[doubleFULLPAGE,capPos=right,capAngle=90]%
{figure}%
{\includegraphics[angle=90,width=2\paperwidth]{images/r+j}}%
[Eine doppelseitige Abbildung mit Caption auf der Abbildung]%
@@ -2495,7 +2500,7 @@ even page and following text will be placed \emph{before} the object.
\Blindtext
\marginnote{Fig.~\ref{fig:doubleFULLPAGE0}}
- \hvFloat[doubleFULLPAGE,capPos=r,capAngle=90]%
+ \hvFloat[doubleFULLPAGE,capPos=right,capAngle=90]%
{figure}%
{\includegraphics[height=2\paperwidth,angle=90]{images/r+j}}%
[Eine doppelseitige Abbildung mit Caption auf der Abbildung]%
@@ -2514,7 +2519,7 @@ even page and following text will be placed \emph{before} the object.
\begin{lstlisting}
\Blindtext
- \hvFloat[doubleFULLPAGE,capPos=r]%
+ \hvFloat[doubleFULLPAGE,capPos=right]%
{figure}%
{\includegraphics[height=\paperheight]{images/rheinsberg}}%
{Eine Beschriftung einer doppelseitigen Abbildung, die ÜBER den rechten
@@ -2529,7 +2534,7 @@ even page and following text will be placed \emph{before} the object.
\marginnote{Fig.~\ref{fig:doubleFULLPAGE1}}
- \hvFloat[doubleFULLPAGE,capPos=r]%
+ \hvFloat[doubleFULLPAGE,capPos=right]%
{figure}%
{\includegraphics[height=\paperheight]{images/rheinsberg}}%
{Eine Beschriftung einer doppelseitigen Abbildung, die ÜBER den rechten
@@ -2589,7 +2594,7 @@ and the rest of the text area is filled with text.
\begin{lstlisting}
\Blindtext
-\hvFloat[doublePage,capWidth=n,capPos=r]%
+\hvFloat[doublePage,capWidth=n,capPos=right]%
{figure}%
{\includegraphics[width=2\textwidth]{images/sonne-meer}}%
[Eine doppelseitige Abbildung mit rechtsseitiger Caption unterhalb]%
@@ -2606,7 +2611,7 @@ and the rest of the text area is filled with text.
\Blindtext
\marginnote{Fig. \ref{fig:doublePage0}}
-\hvFloat[doublePage,capWidth=n,capPos=r]%
+\hvFloat[doublePage,capWidth=n,capPos=right]%
{figure}%
{\includegraphics[width=2\textwidth]{images/sonne-meer}}%
[Eine doppelseitige Abbildung mit rechtsseitiger Caption unterhalb]%
@@ -2659,7 +2664,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=r]%
+\hvFloat[doublePage,capWidth=n,capPos=right]%
{table}%
{\usebox\hvOBox}%%%%%%%%%%%%%%
[Eine doppelseitige Tabelle mit rechtsseitiger Caption unterhalb]%
@@ -2703,7 +2708,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=r]%
+\hvFloat[doublePage,capWidth=n,capPos=right]%
{table}%
{\usebox\hvOBox}%%%%%%%%%%%%%%
[Eine doppelseitige Tabelle mit rechtsseitiger Caption unterhalb]%
@@ -2741,7 +2746,7 @@ the object is set. Let's assume that we use something like
The label \texttt{demo:fullpage} is used for the \emph{image} and not for the caption! Internally another label
called \texttt{demo:fullpage-cap} is set on the caption page which can be before or
-behind the opject (depending to the optional argument of \Lkeyword{capPos}).
+behind the object (depending to the optional argument of \Lkeyword{capPos}).
For example:
\begin{verbatim}
diff --git a/macros/latex/contrib/hvfloat/doc/images/missing.txt b/macros/latex/contrib/hvfloat/doc/images/missing.txt
new file mode 100644
index 0000000000..5a0917558c
--- /dev/null
+++ b/macros/latex/contrib/hvfloat/doc/images/missing.txt
@@ -0,0 +1,3 @@
+Not all imaging of the documentation are listed here, because
+some are not for public use. You can use any other imgae if you
+want to run the documentation by yourselve.