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.tex43
1 files changed, 23 insertions, 20 deletions
diff --git a/macros/latex/contrib/hvfloat/doc/hvfloat.tex b/macros/latex/contrib/hvfloat/doc/hvfloat.tex
index 29404eaadd..18d4d56527 100644
--- a/macros/latex/contrib/hvfloat/doc/hvfloat.tex
+++ b/macros/latex/contrib/hvfloat/doc/hvfloat.tex
@@ -1,4 +1,4 @@
-%% $Id: hvfloat.tex 54 2021-03-14 14:55:34Z herbert $
+%% $Id: hvfloat.tex 56 2021-03-15 07:20:37Z herbert $
\listfiles
\errorcontextlines=100
\documentclass[twoside,paper=a4]{scrartcl}
@@ -233,18 +233,18 @@ The following packages are loaded by \Lpack{hvfloat} and the optional argument
\section{The Macros and optional arguments}
-The syntax for the macros and \Lcs{setDefaults}, \Lcs{hvSet}, and \CMD{hvFloat} is
+The syntax for the macros and \Lcs{hvFloatSetDefaults}, \Lcs{hvFloatSet}, and \CMD{hvFloat} is
\begin{BDef}
-\Lcs{hvset}\Largb{key=value list}\\
-\Lcs{setDefaults}\\
+\Lcs{hvFloatSet}\Largb{key=value list}\\
+\Lcs{hvFloatSetDefaults}\\
\Lcs{hvFloat}\OptArg*{*}\OptArgs\OptArg*{+}\Largb{float type}\Largb{floating object}\OptArg{short caption}\Largb{long caption}\Largb{label}
\end{BDef}
The star version is explained in section~\vref{star-version0} and \vref{star-version} and
the optional \OptArg*{+} is explained in section~\vref{sec:multifloats}.
-\Lcs{hvSet} allows the global setting of keywords and \Lcs{setDefaults} sets all keywords to
+\Lcs{hvFloatSet} allows the global setting of keywords and \Lcs{hvFloatSetDefaults} sets all keywords to
its default value as shown in Table~\vref{tab:options}.
If \Lcs{hvFloat} has an empty second parameter \texttt{<float type>}, then \Lcs{hvFloat} switches by default to
@@ -276,11 +276,14 @@ in the usual way, so that a reference to the not existing table~\ref{dummy} is
\end{verbatim}}
-With the macro \Lcs{defhvstyle} one can define a style which can be used instead of
+%\hvDefFloatStyle
+%\hvFloatSetDefaults
+
+With the macro \Lcs{hvDefFloatStyle} one can define a style which can be used instead of
the individual setting:
\begin{BDef}
-\Lcs{defhvstyle}\Largb{name}\Largb{setting}
+\Lcs{hvDefFloatStyle}\Largb{name}\Largb{setting}
\end{BDef}
Internally the style is saved in a macro named \verb|\hv@<name>|.
@@ -378,8 +381,8 @@ Code for figure \ref{fig:0}:
\Lenv{hvFloatEnv} & environment & places object and caption exactly Here\\
\CMD{figcaption} & command & writes a figure caption in a non floating environment\\
\CMD{tabcaption} & command & writes a table caption in a non floating environment\\
- \CMD{setDefaults} & command & sets all options to the defaults\\
- \CMD{defhvstyle} & command & define a user style
+ \CMD{hvFloatSetDefaults} & command & sets all options to the defaults\\
+ \CMD{hvDefFloatStyle} & command & define a user style
\end{tabularx}%
}{With the only Option \texttt{capPos=top} to place the caption on top of the table, which is often the default.}{tab:0}
@@ -392,8 +395,8 @@ Code for table \ref{tab:0}:
hvFloatEnv & environment & places object and caption exactly Here\\
\CMD{figcaption} & command & writes a figure caption in a non floating environment\\
\CMD{tabcaption} & command & writes a table caption in a non floating environment\\
- \CMD{setDefaults} & command & sets all options to the defaults\\
- \CMD{defhvstyle} & command & define a user style
+ \CMD{hvFloatSetDefaults} & command & sets all options to the defaults\\
+ \CMD{hvDefFloatStyle} & command & define a user style
\end{tabularx}}%
{With the only Option \texttt{capPos=top} to place the caption on top of the table, which is often the default.}%
{tab:0}
@@ -1187,7 +1190,7 @@ For example see table~\ref{table:1} and \ref{table:2}:
hvFloatEnv & environment & places object and caption exactly Here\\
\CMD{figcaption} & command & writes a figure caption in a non floating environment\\
\CMD{tabcaption} & command & writes a table caption in a non floating environment\\
- \CMD{setDefaults} & command & sets all options to the defaults\\\hline
+ \CMD{hvFloatSetDefaults} & command & sets all options to the defaults\\\hline
\end{tabular}%
}
@@ -1202,7 +1205,7 @@ For example see table~\ref{table:1} and \ref{table:2}:
hvFloatEnv & environment & places object and caption exactly Here\\
\CMD{figcaption} & command & writes a figure caption in a non floating environment\\
\CMD{tabcaption} & command & writes a table caption in a non floating environment\\
- \CMD{setDefaults} & command & sets all options to the defaults\\\hline
+ \CMD{hvFloatSetDefaults} & command & sets all options to the defaults\\\hline
\end{tabular}%
}
\end{lstlisting}
@@ -2727,7 +2730,7 @@ With the command \CMD{pageref} one can have a reference to the page number of a
the object is set. Let's assume that we use something like
\begin{verbatim}
-\setDefaults
+\hvFloatSetDefaults
\hvFloat[fullpage,capPos=evenPage]{figure}%
{\IncludeGraphics{images/frose}}%
[A float which needs the complete paper width and height.]%
@@ -2772,15 +2775,15 @@ and the caption on page~\pageref{demo:fullpage-cap}
\section{Defining a style}
-With \Lcs{defhvstyle} one can define a special style to get rid of the individual setting:
+With \Lcs{hvDefFloatStyle} one can define a special style to get rid of the individual setting:
\begin{BDef}
-\Lcs{defhvstyle}\Largb{name}\Largb{setting}
+\Lcs{hvDefFloatStyle}\Largb{name}\Largb{setting}
\end{BDef}
For example:
\begin{verbatim}
-\defhvstyle{RightCaption}{floatPos=htb, capWidth=0.5, capPos=after, capVPos=bottom, objectPos=center}
+\hvDefFloatStyle{RightCaption}{floatPos=htb, capWidth=0.5, capPos=after, capVPos=bottom, objectPos=center}
\end{verbatim}
@@ -2791,8 +2794,8 @@ For example:
\end{lstlisting}
-\setDefaults
-\defhvstyle{RightCaption}{floatPos=htb, capWidth=0.5, capPos=after, capVPos=bottom, objectPos=center}
+\hvFloatSetDefaults
+\hvDefFloatStyle{RightCaption}{floatPos=htb, capWidth=0.5, capPos=after, capVPos=bottom, objectPos=center}
\hvFloat[style=RightCaption]{figure}{\includegraphics{images/rose}}%
@@ -2824,7 +2827,7 @@ optional package options to set the global placement:
\Blindtext
-\setDefaults
+\hvFloatSetDefaults
\hvFloat[FULLPAGE]{figure}%
{\includegraphics[FULLPAGE]{tiger}}%
[A float which needs the complete paper width and height.]%