diff options
Diffstat (limited to 'macros/latex/contrib/hvfloat/doc/hvfloat.tex')
| -rw-r--r-- | macros/latex/contrib/hvfloat/doc/hvfloat.tex | 104 |
1 files changed, 73 insertions, 31 deletions
diff --git a/macros/latex/contrib/hvfloat/doc/hvfloat.tex b/macros/latex/contrib/hvfloat/doc/hvfloat.tex index 40bb098819..169270c2d4 100644 --- a/macros/latex/contrib/hvfloat/doc/hvfloat.tex +++ b/macros/latex/contrib/hvfloat/doc/hvfloat.tex @@ -1,4 +1,4 @@ -%% $Id: hvfloat.tex 876 2024-03-03 14:04:56Z herbert $ +%% $Id: hvfloat.tex 878 2024-03-16 20:49:50Z herbert $ %\listfiles \errorcontextlines=100 \documentclass[twoside,paper=a4,usegeometry,index=totoc]{scrartcl} @@ -188,6 +188,8 @@ \marginnote{\fbox{\shortstack{float\\#1}}}\fi } +\graphicspath{{images/}} + \begin{document} \title{Package \texttt{hvfloat}\\ Controlling captions, fullpage and doublepage floats\\ver \hvFloatFileVersion} @@ -216,7 +218,10 @@ marginnote \fbox{float} is set into the margin. This is done also only for demon objectAngle=120, capAngle=-210, objectPos=center -]{figure}{\protect\fbox{\includegraphics[scale=0.9]{images/rose}}}{\protect\fbox{What a nice Caption :-)}}{fig:title} + objectFrame, +]{figure}{\includegraphics[scale=0.9]{images/rose}} + {\protect\fbox{What a nice Caption :-)}} + {fig:title} \vspace*{\fill} @@ -458,8 +463,7 @@ Code for figure \ref{fig:0}: \end{lstlisting} -\MarginNote{Tab.~\ref{tab:0}} -\hvFloat[capPos=top]{table}{% +\savebox\hvOBox{% \begin{tabularx}{\textwidth}{l|l|X} \rmfamily Name & Type & Description\\\hline \CMD{hvFloat} & command & places object and caption in different ways\\ @@ -468,23 +472,30 @@ Code for figure \ref{fig:0}: \CMD{tabcaption} & command & writes a table caption in a non floating environment\\ \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} +\end{tabularx}} + +\MarginNote{Tab.~\ref{tab:0}} +\hvFloat[capPos=top,useOBox]{table}{} + {With the only Option \texttt{capPos=top} to place the caption on + top of the table, which is often the default.} + {tab:0} Code for table \ref{tab:0}: \begin{lstlisting} -\hvFloat[capPos=top]{table}{% -\begin{tabularx}{\textwidth}{>{\ttfamily}l|l|X} +\savebox\hvOBox{% +\begin{tabularx}{\textwidth}{l|l|X} \rmfamily Name & Type & Description\\\hline \CMD{hvFloat} & command & places object and caption in different ways\\ - hvFloatEnv & environment & places object and caption exactly Here\\ + \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{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} +\end{tabularx}} +\hvFloat[capPos=top,useOBox]{table}{} + {With the only Option \texttt{capPos=top} to place the caption on + top of the table, which is often the default.} + {tab:0} \end{lstlisting} See section~\ref{sec:tables} for some more informations about tabulars as objects. @@ -1147,26 +1158,29 @@ the caption to the left, center, or right of the full width which is linewidth a %\hvblindtext +\clearpage + \section{Margin floats} With the optional argument \Lkeyword{inMargin} the opject and the caption can be placed into the margin. This is done internally with the command \Lcs{marginnote} from the package of the same name. + + %\marginnote{Fig.~\ref{thea}} \hvFloat[inMargin]{figure}{\includegraphics[width=\marginparwidth]{images/thea}} {An image in the margin of the document.} {thea} - \begin{lstlisting} \hvFloat[inMargin]{figure}{\includegraphics[width=\marginparwidth]{images/thea}} {An image in the margin of the document.} {thea} - ... - -\hvFloat[inMargin]{table}{\small\begin{tabular}{@{}ccc@{}}\hline Mon& Di& Mi\\ frei & Dienst & frei\\ +\savebox\hvOBox{\small\begin{tabular}{@{} + ccc@{}}\hline Mon& Di& Mi\\ frei & Dienst & frei\\ Dienst & Dienst & Frei\\\hline \end{tabular}} +\hvFloat[inMargin,useOBox]{table}{} {A tabular in the margin just like the image.} {thea2} \end{lstlisting} @@ -1175,9 +1189,13 @@ the margin. This is done internally with the command \Lcs{marginnote} from the p \hvblindtext +\savebox\hvOBox{% + \small\begin{tabular}{@{}ccc@{}}\hline + Mon& Di& Mi\\ frei & Dienst & frei\\ + Dienst & Dienst & Frei\\\hline \end{tabular}% +} %\marginnote{Fig.~\ref{thea2}} -\hvFloat[inMargin]{table}{\small\tabcolsep=3pt\begin{tabular}{@{}ccc@{}}\hline Mon& Di& Mi\\ frei & Dienst & frei\\ - Dienst & Dienst & Frei\\\hline \end{tabular}} +\hvFloat[inMargin,useOBox]{table}{} {A tabular in the margin just like the image.} {thea2} @@ -1383,7 +1401,7 @@ The code for table \ref{table:1} and \ref{table:2} is: \hvFloat[% floatPos=!hb, capPos=top, - useOBox=true]{table}{}{Demonstration of the \texttt{useOBox} Parameter}{table:1} + useOBox]{table}{}{Demonstration of the \texttt{useOBox} Parameter}{table:1} \hvblindtext @@ -1403,14 +1421,14 @@ In this case leave the third parameter empty. \hvFloat[% floatPos=!hb, capPos=top, - useOBox=true]{table}{}{Demonstration of the \texttt{useOBox} Parameter}{table:1} + useOBox]{table}{}{Demonstration of the \texttt{useOBox} Parameter}{table:1} \MarginNote{Tab.~\ref{table:2}} \hvFloat[% floatPos=!htb,% - useOBox=true,% + useOBox,% objectAngle=90,% capPos=right,% capVPos=top,% @@ -2730,7 +2748,7 @@ in the inner margin on both pages. \begin{lstlisting} \hvFloat[doubleFULLPAGE,capPos=right]% {figure}% - {\includegraphics[height=\paperheight]{images/rheinsberg-1000}}% + {\includegraphics[height=\paperheight]{images/rheinsberg}}% {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. No further text is placed on the pages. A short form is used for the LOF. @@ -2741,7 +2759,7 @@ in the inner margin on both pages. \MarginNote{Fig.~\ref{fig:doubleFULLPAGE1}} \hvFloat[doubleFULLPAGE,capPos=right]% {figure}% - {\includegraphics[height=\paperheight]{images/rheinsberg-1000}}% + {\includegraphics[height=\paperheight]{images/rheinsberg}}% {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. No further text is placed on the pages. A short form is used for the LOF. @@ -2770,7 +2788,7 @@ and the right part on page~\pageref{bar-2}. All three labels points to the same \hvFloat[doubleFULLPAGE,capPos=after]% {figure}% {\includegraphics[doubleFULLPAGE, - keepaspectratio=false]{images/rheinsberg-1000}}% + keepaspectratio=false]{images/rheinsberg}}% {A caption for a double-sided image that will be placed \textbf{after} 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. @@ -2783,7 +2801,7 @@ and the right part on page~\pageref{bar-2}. All three labels points to the same \MarginNote{Fig.~\ref{foo}} \hvFloat[doubleFULLPAGE,capPos=after]% {figure}% - {\includegraphics[doubleFULLPAGE]{images/rheinsberg-1000}}% + {\includegraphics[doubleFULLPAGE]{images/rheinsberg}}% {A caption for a double-sided image that will be placed \textbf{after} 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. @@ -2804,7 +2822,7 @@ and the right part on page~\pageref{bar-2}. All three labels points to the same \hvFloat[doubleFULLPAGE,capPos=before]% {figure}% {\includegraphics[height=\paperheight,width=2\paperwidth, - keepaspectratio=false]{images/rheinsberg-1000}}% + keepaspectratio=false]{images/rheinsberg}}% {A caption for a double-sided image that will be placed \textbf{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. @@ -2815,7 +2833,7 @@ and the right part on page~\pageref{bar-2}. All three labels points to the same \MarginNote{Fig.~\ref{bar}} \hvFloat[doubleFULLPAGE,capPos=before]% {figure}% - {\includegraphics[height=\paperheight,width=2\paperwidth,keepaspectratio=false]{images/rheinsberg-1000}}% + {\includegraphics[height=\paperheight,width=2\paperwidth,keepaspectratio=false]{images/rheinsberg}}% {A caption for a double-sided image that will be placed \textbf{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. @@ -3117,9 +3135,9 @@ Artikel gesamt & 2 & 6 & 13 & 8 & 4 & 3 & 5 & 4 & 0 & 6 & 3 & 5 &23 &10 & 8 & 15 \hvBlindtext -\hvFloat[doublePage,capPos=right,capVPos=top,floatCapSep=12pt]% +\hvFloat[doublePage,capPos=right,capVPos=top,floatCapSep=12pt,useOBox]% {table}% - {\usebox\hvOBox}%%%%%%%%%%%%%% + {}%%%%%%%%%%%%%% [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 @@ -3128,7 +3146,7 @@ Artikel gesamt & 2 & 6 & 13 & 8 & 4 & 3 & 5 & 4 & 0 & 6 & 3 & 5 &23 &10 & 8 & 15 \end{lstlisting} -\global\savebox\hvOBox{% +\savebox\hvOBox{% \begin{tabular}{l*{18}r} \toprule & \textbf{1972} & \textbf{1973} & \textbf{1974} & \textbf{1975} & \textbf{1976} & \textbf{1977} & \textbf{1978} & \textbf{1979} & \textbf{1980} & \textbf{1981} & \textbf{1982} & \textbf{1983} & \textbf{1984} & \textbf{1985} @@ -3159,7 +3177,31 @@ Artikel gesamt & 2 & 6 & 13 & 8 & 4 & 3 & 5 & 4 & 0 & 6 & 3 & 5 &23 &10 & 8 & 15 \marginpar{Tab.~\ref{tab:doublePage3}}% \hvFloat[doublePage,capPos=right,capVPos=top,floatCapSep=12pt]% {table}% - {\usebox\hvOBox}%%%%%%%%%%%%%% + {\begin{tabular}{l*{18}r} \toprule + & \textbf{1972} & \textbf{1973} & \textbf{1974} & \textbf{1975} & \textbf{1976} + & \textbf{1977} & \textbf{1978} & \textbf{1979} & \textbf{1980} & \textbf{1981} & \textbf{1982} & \textbf{1983} & \textbf{1984} & \textbf{1985} + & \textbf{1986} & \textbf{1987} & \textbf{1988} & \textbf{1989} + \\\midrule +\addlinespace[3pt] +Zeile 1 & 1 & 3 & 1 & 1 & 1 & 0 & 1 & 1 & 0 & 0 & 0 & 0 &20 & 0 & 2 & 2 & 2 & 1\\\addlinespace[3pt] +Zeile 2 & 1 & 1 & 3 & 1 & 0 & 0 & 0 & 0 & 0 & 0 & 2 & 1 & 3 & 4 & 4 & 6 & 4 & 2\\\addlinespace[3pt] +Zeile 3 & 2 & 1 & 2 & 1 & 0 & 0 & 0 & 0 & 0 & 0 & 0 & 1 & 5 & 3 & 1 & 7 & 7 & 3\\\addlinespace[3pt] +Zeile 4 & 1 & 0 & 5 & 1 & 2 & 0 & 0 & 0 & 0 & 2 & 1 & 0 & 1 & 0 & 3 & 7 & 2 & 1\\\addlinespace[3pt] +Zeile 6 & 2 & 1 & 1 & 0 & 0 & 0 & 0 & 0 & 0 & 1 & 2 & 0 & 5 & 2 & 2 & 5 & 4 & 2\\\addlinespace[3pt] +Zeile 5 & 0 & 0 & 4 & 2 & 1 & 2 & 2 & 1 & 0 & 0 & 0 & 1 & 1 & 0 & 2 & 5 & 4 & 3\\\addlinespace[3pt] +Zeile 8 & 0 & 1 & 1 & 0 & 0 & 0 & 1 & 1 & 0 & 3 & 2 & 1 & 2 & 1 & 3 & 5 & 3 & 4\\\addlinespace[3pt] +Zeile 9 & 0 & 0 & 0 & 0 & 0 & 1 & 2 & 1 & 0 & 0 & 0 & 0 & 4 & 2 & 1 & 4 & 5 & 2\\\addlinespace[3pt] +Zeile10 & 0 & 1 & 3 & 0 & 1 & 0 & 1 & 0 & 0 & 1 & 1 & 0 & 1 & 1 & 1 & 4 & 4 & 1\\\addlinespace[3pt] +Zeile11 & 0 & 2 & 2 & 1 & 1 & 0 & 1 & 0 & 0 & 0 & 0 & 2 & 6 & 1 & 0 & 2 & 1 & 1 \\\addlinespace[3pt] +Zeile12 & 2 & 0 & 2 & 4 & 1 & 0 & 4 & 0 & 0 & 0 & 0 & 0 & 0 & 0 & 0 & 1 & 0 & 3\\\addlinespace[3pt] +Lärm & 2 & 3 & 0 & 0 & 0 & 0 & 0 & 0 & 0 & 0 & 1 & 0 & 2 & 0 & 0 & 2 & 2 & 2\\\addlinespace[3pt] +Zeile13 & 0 & 1 & 0 & 0 & 1 & 0 & 3 & 0 & 0 & 0 & 0 & 0 & 2 & 0 & 1 & 3 & 0 & 2\\\addlinespace[3pt] +Zeile14 & 0 & 1 & 0 & 0 & 0 & 0 & 0 & 0 & 0 & 0 & 0 & 0 & 3 & 3 & 2 & 1 & 1 & 0\\\addlinespace[3pt] +Zeile15 & 0 & 0 & 0 & 0 & 0 & 0 & 0 & 0 & 0 & 1 & 0 & 0 & 4 & 0 & 0 & 3 & 1 & 1\\\addlinespace[3pt] +Zeile16 & 0 & 0 & 0 & 0 & 0 & 1 & 0 & 0 & 0 & 0 & 0 & 0 & 0 & 0 & 3 & 5 & 0 & 1\\\addlinespace[3pt]\midrule +Artikel gesamt & 2 & 6 & 13 & 8 & 4 & 3 & 5 & 4 & 0 & 6 & 3 & 5 &23 &10 & 8 & 15 & 13 &1 \\ +\bottomrule +\end{tabular}}%%%%%%%%%%%%%% [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 |