summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/hvfloat/doc
diff options
context:
space:
mode:
authorNorbert Preining <norbert@preining.info>2021-06-08 03:02:17 +0000
committerNorbert Preining <norbert@preining.info>2021-06-08 03:02:17 +0000
commit19ec3a90133b7827c16b0ffde16152fb4d566138 (patch)
tree056101811eeb7e1bfb0067e3628591dd0e52bc06 /macros/latex/contrib/hvfloat/doc
parent1ba2ae020aea220436899cf65f5a85c1686940cd (diff)
CTAN sync 202106080302
Diffstat (limited to 'macros/latex/contrib/hvfloat/doc')
-rw-r--r--macros/latex/contrib/hvfloat/doc/examples/capPos.inc129
-rw-r--r--macros/latex/contrib/hvfloat/doc/examples/capPos.ltx34
-rw-r--r--macros/latex/contrib/hvfloat/doc/examples/capPos.tex147
-rw-r--r--macros/latex/contrib/hvfloat/doc/examples/capVPos.inc133
-rw-r--r--macros/latex/contrib/hvfloat/doc/hvfloat.pdfbin7111003 -> 7113219 bytes
-rw-r--r--macros/latex/contrib/hvfloat/doc/hvfloat.tex5
6 files changed, 299 insertions, 149 deletions
diff --git a/macros/latex/contrib/hvfloat/doc/examples/capPos.inc b/macros/latex/contrib/hvfloat/doc/examples/capPos.inc
new file mode 100644
index 0000000000..0acdf34bf0
--- /dev/null
+++ b/macros/latex/contrib/hvfloat/doc/examples/capPos.inc
@@ -0,0 +1,129 @@
+
+\subsection{\texttt{default}}
+\blindtext
+
+\begin{lstlisting}
+\hvFloat{figure}{\includegraphics{frose}}{\capShortText}{}
+\end{lstlisting}
+
+\hvFloat{figure}{\includegraphics{frose}}{\capShortText}{}
+
+\blindtext
+
+\begin{lstlisting}
+\hvFloat{figure}{\includegraphics{frose}}{\capLongText}{}
+\end{lstlisting}
+
+\hvFloat{figure}{\includegraphics{frose}}{\capLongText}{}
+
+\blindtext
+
+\NewColumn
+
+
+
+%----------------------top-----------------------------------
+\subsection{\texttt{capPos=top}}
+
+\begin{lstlisting}
+\hvFloat[capPos=top]{figure}{\includegraphics{frose}}{\capShortText}{}
+\end{lstlisting}
+
+\hvFloat[capPos=top]{figure}{\includegraphics{frose}}{\capShortText}{}
+
+\blindtext
+
+\begin{lstlisting}
+\hvFloat[capPos=top]{figure}{\includegraphics{frose}}{\capLongText}{}
+\end{lstlisting}
+
+\hvFloat[capPos=top]{figure}{\includegraphics{frose}}{\capLongText}{}
+
+\blindtext
+
+\NewColumn
+
+%----------------------before-----------------------------------
+\subsection{\texttt{capPos=before}, same as \texttt{capPos=left}}
+
+\begin{lstlisting}
+\hvFloat[capPos=before]{figure}{\includegraphics{frose}}{\capShortText}{}
+\end{lstlisting}
+
+\hvFloat[capPos=before]{figure}{\includegraphics{frose}}{\capShortText}{}
+
+\blindtext
+
+\begin{lstlisting}
+\hvFloat[capPos=before]{figure}{\includegraphics{frose}}{\capLongText}{}
+\end{lstlisting}
+
+\hvFloat[capPos=before]{figure}{\includegraphics{frose}}{\capLongText}{}
+
+\blindtext
+\NewColumn
+
+%----------------------after-----------------------------------
+\subsection{\texttt{capPos=after}, same as \texttt{capPos=right}}
+
+\begin{lstlisting}
+\hvFloat[capPos=after]{figure}{\includegraphics{frose}}{\capShortText}{}
+\end{lstlisting}
+
+\hvFloat[capPos=after]{figure}{\includegraphics{frose}}{\capShortText}{}
+
+\blindtext
+
+\begin{lstlisting}
+\hvFloat[capPos=after]{figure}{\includegraphics{frose}}{\capLongText}{}
+\end{lstlisting}
+
+\hvFloat[capPos=after]{figure}{\includegraphics{frose}}{\capLongText}{}
+
+\blindtext
+
+\NewColumn
+
+%----------------------inner-----------------------------------
+\subsection{\texttt{capPos=inner}}
+
+\begin{lstlisting}
+\hvFloat[capPos=inner]{figure}{\includegraphics{frose}}{\capShortText}{}
+\end{lstlisting}
+
+\hvFloat[capPos=inner]{figure}{\includegraphics{frose}}{\capShortText}{}
+
+\blindtext
+
+\begin{lstlisting}
+\hvFloat[capPos=inner]{figure}{\includegraphics{frose}}{\capLongText}{}
+\end{lstlisting}
+
+\hvFloat[capPos=inner]{figure}{\includegraphics{frose}}{\capLongText}{}
+
+\blindtext
+
+\NewColumn
+
+
+%----------------------outer-----------------------------------
+\subsection{\texttt{capPos=outer}}
+
+\begin{lstlisting}
+\hvFloat[capPos=outer]{figure}{\includegraphics{frose}}{\capShortText}{}
+\end{lstlisting}
+
+\hvFloat[capPos=outer]{figure}{\includegraphics{frose}}{\capShortText}{}
+
+\blindtext
+
+\begin{lstlisting}
+\hvFloat[capPos=outer]{figure}{\includegraphics{frose}}{\capLongText}{}
+\end{lstlisting}
+
+\hvFloat[capPos=outer]{figure}{\includegraphics{frose}}{\capLongText}{}
+
+\blindtext
+
+\NewColumn
+
diff --git a/macros/latex/contrib/hvfloat/doc/examples/capPos.ltx b/macros/latex/contrib/hvfloat/doc/examples/capPos.ltx
deleted file mode 100644
index 9fcd593abb..0000000000
--- a/macros/latex/contrib/hvfloat/doc/examples/capPos.ltx
+++ /dev/null
@@ -1,34 +0,0 @@
-\documentclass[twoside,DIV=11]{scrartcl}
-%% $Id: capPos.ltx 72 2021-05-02 11:40:10Z herbert $
-
-\input{preamble.ltx}
-\usepackage{multicol}
-\usepackage[all=!htb]{hvfloat-fps}
-
-\setlength\columnseprule{0.4pt}
-\def\capShortText{A short caption}
-\def\capLongText{Here comes a caption to show the justification of the text relative to the object. It refers to
-the optional argument \texttt{capPos}.}
-
-\let\OrigBlindtext\blindtext
-\def\blindtext{\TeX\ is a typesetting language. Instead of visually formatting your text, you enter y
-our manuscript text intertwined with \TeX\ commands in a plain text file. You then run \TeX\ to
-produce formatted output, such as a PDF file. %Thus, in contrast to standard word processors,
-%your document is a separate file that does not pretend to be a representation of the final
-%typeset output, and so can be easily edited and manipulated.
-}
-
-
-
-\begin{document}
-\part{Examples for \texttt{capPos} and onecolumn mode}\clearpage
-\let\NewColumn\clearpage
-\input{capPos}
-
-\twocolumn[\part{Examples for \texttt{capPos} and twocolumn mode}]
-\def\blindtext{\OrigBlindtext}
-\let\NewColumn\columnbreak
-\input{capPos}
-
-
-\end{document} \ No newline at end of file
diff --git a/macros/latex/contrib/hvfloat/doc/examples/capPos.tex b/macros/latex/contrib/hvfloat/doc/examples/capPos.tex
index db2e889f6e..3887dfd06e 100644
--- a/macros/latex/contrib/hvfloat/doc/examples/capPos.tex
+++ b/macros/latex/contrib/hvfloat/doc/examples/capPos.tex
@@ -1,129 +1,50 @@
+\documentclass[twoside,DIV=13]{scrartcl}
+%% $Id: capPos.tex 103 2021-05-31 12:37:11Z herbert $
-\section{\texttt{default}}
-\blindtext
+\input{preamble.ltx}
+\usepackage{multicol}
+\usepackage[all=!htb]{hvfloat-fps}
-\begin{lstlisting}
-\hvFloat{figure}{\includegraphics{frose}}{\capShortText}{}
-\end{lstlisting}
+\setlength\columnseprule{0.4pt}
+\def\capShortText{A short caption}
+\def\capLongText{Here comes a caption to show the justification of the text relative to the object. It refers to
+the optional argument \texttt{capPos}.}
-\hvFloat{figure}{\includegraphics{frose}}{\capShortText}{}
+\let\OrigBlindtext\blindtext
+\def\myblindtext{\TeX\ is a typesetting language. Instead of visually formatting your text, you enter y
+our manuscript text intertwined with \TeX\ commands in a plain text file. You then run \TeX\ to
+produce formatted output, such as a PDF file. %Thus, in contrast to standard word processors,
+%your document is a separate file that does not pretend to be a representation of the final
+%typeset output, and so can be easily edited and manipulated.
+}
-\blindtext
-\begin{lstlisting}
-\hvFloat{figure}{\includegraphics{frose}}{\capLongText}{}
-\end{lstlisting}
-\hvFloat{figure}{\includegraphics{frose}}{\capLongText}{}
+\begin{document}
-\blindtext
+\tableofcontents
-\NewColumn
+\newpage
+\section{Examples for \texttt{capPos} and onecolumn mode}
+\let\NewColumn\clearpage
+\let\blindtext\myblindtext
+\input{capPos.inc}
+\section{Examples for \texttt{capVPos} and onecolumn mode }
+Horizontal alignment with the optional arguments from package \texttt{caption}, e.g. \texttt{singlelinecheck=off} for short captions.
-%----------------------top-----------------------------------
-\section{\texttt{capPos=top}}
+\input{capVPos.inc}
-\begin{lstlisting}
-\hvFloat[capPos=top]{figure}{\includegraphics{frose}}{\capShortText}{}
-\end{lstlisting}
-\hvFloat[capPos=top]{figure}{\includegraphics{frose}}{\capShortText}{}
+\twocolumn[\section{Examples for \texttt{capPos} and twocolumn mode}]
+\let\NewColumn\columnbreak
+\input{capPos.inc}
-\blindtext
+\let\blindtext\OrigBlindtext
+\section{Examples for \texttt{capVPos} and twocolumn mode (\texttt{capPos=right})}
+\let\NewColumn\columnbreak
+\input{capVPos.inc}
-\begin{lstlisting}
-\hvFloat[capPos=top]{figure}{\includegraphics{frose}}{\capLongText}{}
-\end{lstlisting}
-
-\hvFloat[capPos=top]{figure}{\includegraphics{frose}}{\capLongText}{}
-
-\blindtext
-
-\NewColumn
-
-%----------------------before-----------------------------------
-\section{\texttt{capPos=before}, same as \texttt{capPos=left}}
-
-\begin{lstlisting}
-\hvFloat[capPos=before]{figure}{\includegraphics{frose}}{\capShortText}{}
-\end{lstlisting}
-
-\hvFloat[capPos=before]{figure}{\includegraphics{frose}}{\capShortText}{}
-
-\blindtext
-
-\begin{lstlisting}
-\hvFloat[capPos=before]{figure}{\includegraphics{frose}}{\capLongText}{}
-\end{lstlisting}
-
-\hvFloat[capPos=before]{figure}{\includegraphics{frose}}{\capLongText}{}
-
-\blindtext
-\NewColumn
-
-%----------------------after-----------------------------------
-\section{\texttt{capPos=after}, same as \texttt{capPos=right}}
-
-\begin{lstlisting}
-\hvFloat[capPos=after]{figure}{\includegraphics{frose}}{\capShortText}{}
-\end{lstlisting}
-
-\hvFloat[capPos=after]{figure}{\includegraphics{frose}}{\capShortText}{}
-
-\blindtext
-
-\begin{lstlisting}
-\hvFloat[capPos=after]{figure}{\includegraphics{frose}}{\capLongText}{}
-\end{lstlisting}
-
-\hvFloat[capPos=after]{figure}{\includegraphics{frose}}{\capLongText}{}
-
-\blindtext
-
-\NewColumn
-
-%----------------------inner-----------------------------------
-\section{\texttt{capPos=inner}}
-
-\begin{lstlisting}
-\hvFloat[capPos=inner]{figure}{\includegraphics{frose}}{\capShortText}{}
-\end{lstlisting}
-
-\hvFloat[capPos=inner]{figure}{\includegraphics{frose}}{\capShortText}{}
-
-\blindtext
-
-\begin{lstlisting}
-\hvFloat[capPos=inner]{figure}{\includegraphics{frose}}{\capLongText}{}
-\end{lstlisting}
-
-\hvFloat[capPos=inner]{figure}{\includegraphics{frose}}{\capLongText}{}
-
-\blindtext
-
-\NewColumn
-
-
-%----------------------outer-----------------------------------
-\section{\texttt{capPos=outer}}
-
-\begin{lstlisting}
-\hvFloat[capPos=outer]{figure}{\includegraphics{frose}}{\capShortText}{}
-\end{lstlisting}
-
-\hvFloat[capPos=outer]{figure}{\includegraphics{frose}}{\capShortText}{}
-
-\blindtext
-
-\begin{lstlisting}
-\hvFloat[capPos=outer]{figure}{\includegraphics{frose}}{\capLongText}{}
-\end{lstlisting}
-
-\hvFloat[capPos=outer]{figure}{\includegraphics{frose}}{\capLongText}{}
-
-\blindtext
-
-\NewColumn
+\end{document} \ No newline at end of file
diff --git a/macros/latex/contrib/hvfloat/doc/examples/capVPos.inc b/macros/latex/contrib/hvfloat/doc/examples/capVPos.inc
new file mode 100644
index 0000000000..10ef70e88c
--- /dev/null
+++ b/macros/latex/contrib/hvfloat/doc/examples/capVPos.inc
@@ -0,0 +1,133 @@
+%\define@choicekey*+{hvSet}{capVPos}[\val\nr]{bottom,center,top}[center]{%
+
+
+\iffalse
+justification=
+ justified
+ centering
+ centerlast
+ centerfirst
+ raggedright
+ RaggedRight
+ raggedleft
+\fi
+
+\subsection{\texttt{default}, same as \texttt{center}}
+\blindtext
+
+\begin{lstlisting}
+\hvFloat[capPos=right]{figure}{\includegraphics{frose}}{\capShortText}{}
+\end{lstlisting}
+
+\hvFloat[capPos=right]{figure}{\includegraphics{frose}}{\capShortText}{}
+
+\blindtext
+
+\begin{lstlisting}
+\hvFloat[capPos=right,capFormat={singlelinecheck=off}]{figure}{\includegraphics{frose}}{\capShortText}{}
+\end{lstlisting}
+
+\hvFloat[capPos=right,capFormat={singlelinecheck=off}]{figure}{\includegraphics{frose}}{\capShortText}{}
+
+\blindtext
+
+\begin{lstlisting}
+\hvFloat[capPos=right]{figure}{\includegraphics{frose}}{\capLongText}{}
+\end{lstlisting}
+
+\hvFloat[capPos=right]{figure}{\includegraphics{frose}}{\capLongText}{}
+
+\blindtext
+
+\NewColumn
+
+
+
+%----------------------top-----------------------------------
+\subsection{\texttt{capVPos=top}}
+
+\begin{lstlisting}
+\hvFloat[capPos=right,capVPos=top]{figure}{\includegraphics{frose}}{\capShortText}{}
+\end{lstlisting}
+
+\hvFloat[capPos=right,capVPos=top]{figure}{\includegraphics{frose}}{\capShortText}{}
+
+\blindtext
+
+
+\begin{lstlisting}
+\hvFloat[capPos=right,capFormat={singlelinecheck=off},capVPos=top]{figure}{\includegraphics{frose}}{\capShortText}{}
+\end{lstlisting}
+
+\hvFloat[capPos=right,capFormat={singlelinecheck=off},capVPos=top]{figure}{\includegraphics{frose}}{\capShortText}{}
+
+\blindtext
+
+
+\begin{lstlisting}
+\hvFloat[capPos=right,capVPos=top]{figure}{\includegraphics{frose}}{\capLongText}{}
+\end{lstlisting}
+
+\hvFloat[capPos=right,capVPos=top]{figure}{\includegraphics{frose}}{\capLongText}{}
+
+\blindtext
+
+\NewColumn
+
+%----------------------bottom-----------------------------------
+\subsection{\texttt{capVPos=bottom}}
+
+\begin{lstlisting}
+\hvFloat[capPos=right,capVPos=bottom]{figure}{\includegraphics{frose}}{\capShortText}{}
+\end{lstlisting}
+
+\hvFloat[capPos=right,capVPos=bottom]{figure}{\includegraphics{frose}}{\capShortText}{}
+
+\blindtext
+
+
+\begin{lstlisting}
+\hvFloat[capPos=right,capFormat={singlelinecheck=off},capVPos=bottom]{figure}{\includegraphics{frose}}{\capShortText}{}
+\end{lstlisting}
+
+\hvFloat[capPos=right,capFormat={singlelinecheck=off},capVPos=bottom]{figure}{\includegraphics{frose}}{\capShortText}{}
+
+\blindtext
+
+\begin{lstlisting}
+\hvFloat[capPos=right,capVPos=bottom]{figure}{\includegraphics{frose}}{\capLongText}{}
+\end{lstlisting}
+
+\hvFloat[capPos=right,capVPos=bottom]{figure}{\includegraphics{frose}}{\capLongText}{}
+
+\blindtext
+\NewColumn
+
+%----------------------center-----------------------------------
+\subsection{\texttt{capPos=center}}
+
+\begin{lstlisting}
+\hvFloat[capPos=right,capVPos=center]{figure}{\includegraphics{frose}}{\capShortText}{}
+\end{lstlisting}
+
+\hvFloat[capPos=right,capVPos=center]{figure}{\includegraphics{frose}}{\capShortText}{}
+
+\blindtext
+
+\begin{lstlisting}
+\hvFloat[capPos=right,capFormat={singlelinecheck=off},capVPos=center]{figure}{\includegraphics{frose}}{\capShortText}{}
+\end{lstlisting}
+
+\hvFloat[capPos=right,capFormat={singlelinecheck=off},capVPos=center]{figure}{\includegraphics{frose}}{\capShortText}{}
+
+\blindtext
+
+\begin{lstlisting}
+\hvFloat[capPos=right,capVPos=center]{figure}{\includegraphics{frose}}{\capLongText}{}
+\end{lstlisting}
+
+\hvFloat[capPos=right,capVPos=center]{figure}{\includegraphics{frose}}{\capLongText}{}
+
+\blindtext
+
+\NewColumn
diff --git a/macros/latex/contrib/hvfloat/doc/hvfloat.pdf b/macros/latex/contrib/hvfloat/doc/hvfloat.pdf
index 981f685c0a..ce628eaf57 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 807a63415e..df1729be27 100644
--- a/macros/latex/contrib/hvfloat/doc/hvfloat.tex
+++ b/macros/latex/contrib/hvfloat/doc/hvfloat.tex
@@ -1,4 +1,4 @@
-%% $Id: hvfloat.tex 103 2021-05-31 12:37:11Z herbert $
+%% $Id: hvfloat.tex 105 2021-06-07 07:30:15Z herbert $
\listfiles
\errorcontextlines=100
\documentclass[twoside,paper=a4,]{scrartcl}
@@ -261,7 +261,8 @@ be used for own purposes.
\begin{BDef}
\Lcs{figcaption}\OptArg{short caption text}\Largb{caption text}\\
-\Lcs{tabcaption}\OptArg{short caption text}\Largb{caption text}
+\Lcs{tabcaption}\OptArg{short caption text}\Largb{caption text}\\
+\Lcs{tabcaptionbelow}\OptArg{short caption text}\Largb{caption text}\\
\end{BDef}
They are used for the \Lkeyword{nonFloat} keyword, where these macros write captions in the same way but outside of