summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/sidecap
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2006-01-09 00:44:40 +0000
committerKarl Berry <karl@freefriends.org>2006-01-09 00:44:40 +0000
commitb4fc5f639874db951177ec539299d20908adb654 (patch)
tree52f08823ca58fffe3db6a9b075635038c567626c /Master/texmf-dist/doc/latex/sidecap
parentdec3d98ebe442d7ea93efbaa8dd2e2be8149a467 (diff)
doc 4
git-svn-id: svn://tug.org/texlive/trunk@80 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/sidecap')
-rw-r--r--Master/texmf-dist/doc/latex/sidecap/README15
-rw-r--r--Master/texmf-dist/doc/latex/sidecap/sc-test-common.tex122
-rw-r--r--Master/texmf-dist/doc/latex/sidecap/sc-test1.tex141
-rw-r--r--Master/texmf-dist/doc/latex/sidecap/sc-test2.tex89
-rw-r--r--Master/texmf-dist/doc/latex/sidecap/sc-test3.tex54
-rw-r--r--Master/texmf-dist/doc/latex/sidecap/sc-test4.tex76
-rw-r--r--Master/texmf-dist/doc/latex/sidecap/sc-test5.tex41
-rw-r--r--Master/texmf-dist/doc/latex/sidecap/sc-test6.tex89
8 files changed, 627 insertions, 0 deletions
diff --git a/Master/texmf-dist/doc/latex/sidecap/README b/Master/texmf-dist/doc/latex/sidecap/README
new file mode 100644
index 00000000000..7838eedf0d1
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/sidecap/README
@@ -0,0 +1,15 @@
+
+The sidecap package.
+
+This package defines the new environments SCfigure and SCtable, analogous to
+figure and table, which make it easy to typeset captions sideways. The package
+knows the options outercaption, innercaption, leftcaption and rightcaption.
+
+Please send enhancements and corrections to:
+
+ Rolf Niepraschk, Rolf.Niepraschk@ptb.de
+ Hubert Gaesslein,
+
+ 2003/05/04
+
+
diff --git a/Master/texmf-dist/doc/latex/sidecap/sc-test-common.tex b/Master/texmf-dist/doc/latex/sidecap/sc-test-common.tex
new file mode 100644
index 00000000000..22b5dd9ff81
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/sidecap/sc-test-common.tex
@@ -0,0 +1,122 @@
+
+% `sc-test-comon.tex', part of the LaTeX package `sidecap'
+% 2003-02-21
+% Rolf Niepraschk and Hubert G\"a\ss{}lein -- niepraschk@ptb.de
+
+\setlength{\emergencystretch}{20pt}
+\renewcommand{\textfraction}{0}
+\renewcommand{\topfraction}{1}
+\renewcommand{\bottomfraction}{1}
+\setcounter{bottomnumber}{4}
+\setcounter{topnumber}{4}
+\setcounter{totalnumber}{8}
+
+\errorcontextlines100
+
+\renewcommand\tablename{Tab.} \renewcommand\figurename{Fig.}
+
+\setlength{\belowcaptionskip}{\abovecaptionskip}
+
+\setlength\columnseprule{.4pt}
+
+\newcommand{\FIG}[2][]{%
+ \begingroup
+ \def\xxx{#1}%
+ \ifx\xxx\empty
+ \setlength{\unitlength}{\linewidth}%
+ \addtolength{\unitlength}{-2\fboxrule}%
+ \setlength{\unitlength}{.1\unitlength}%
+ \else
+ \setlength{\unitlength}{#1}%
+ \fi%
+ \setlength{\fboxsep}{0pt}%
+ \ifcase#2\relax
+ \or%
+ \fbox{%
+ \begin{picture}(4,6)%
+ \put(1,5){\circle{1}}%
+ \put(3,5){\circle{1}}%
+ \put(2,3){\circle{1}}%
+ \put(1,1){\circle{1}}%
+ \put(3,1){\circle{1}}%
+ \end{picture}}%
+ \or%
+ \fbox{%
+ \begin{picture}(10,4)%
+ \put(1,3){\circle{1}}%
+ \put(9,3){\circle{1}}%
+ \put(5,2){\circle{1}}%
+ \put(1,1){\circle{1}}%
+ \put(9,1){\circle{1}}%
+ \end{picture}}%
+ \or% (doesn't make a difference to use [b] or [t] or [c] here !!!)
+ \begin{minipage}{5\unitlength}%
+ text text text text text text text text
+ text text text text text text text text
+ text text text text text text text text
+ text text text text text text text text
+ text text text text text text text text
+ text text text text text text text text
+ text text text text text text text text
+ text text text text text text text text.
+ \end{minipage}%
+ \or% (doesn't make a difference to use [b] or [t] or [c] here !!!)
+ \begin{minipage}{5\unitlength}%
+ \strut
+ text text text text text text text text
+ text text text text text text text text
+ text text text text text text text text
+ text text text text text text text text
+ text text text text text text text text
+ text text text text text text text text
+ text text text text text text text text
+ text text text text text text text text.
+ \unskip\strut
+ \end{minipage}%
+ \fi
+ \endgroup
+}
+
+\newcommand{\TABi}{%
+ \begin{tabular}{@{} | c | c c c c c | @{}} \hline
+ \multicolumn{1}{| c} {1}
+ & 2 & 3 & 4 & 5 & 6 \\ \cline{2-6}
+ 2 & 4 & 6 & 8 & 10 & 12 \\
+ 3 & 6 & 9 & 12 & 15 & 18 \\
+ 4 & 8 & 12 & 16 & 20 & 24 \\
+ 5 & 10 & 15 & 20 & 25 & 30 \\
+ 6 & 12 & 18 & 24 & 30 & 36 \\
+ 7 & 14 & 21 & 28 & 35 & 42 \\
+ 8 & 16 & 24 & 32 & 40 & 48 \\
+ 9 & 18 & 27 & 36 & 45 & 54 \\
+ 10 & 20 & 30 & 40 & 50 & 60 \\
+ 11 & 22 & 33 & 44 & 55 & 66 \\
+ 12 & 24 & 36 & 48 & 60 & 72 \\
+ 13 & 26 & 39 & 52 & 65 & 78 \\
+ 14 & 28 & 42 & 56 & 70 & 84 \\
+ \hline
+ \end{tabular}%
+}
+
+
+\newcommand{\CAPi}{%
+ The dazed brown fox quickly gave 12345--67890 jumps!
+ The dazed brown fox quickly gave 12345--67890 jumps!
+}
+
+\newcommand{\CAPii}{%
+ The dazed brown fox quickly gave 12345--67890 jumps!
+ The dazed brown fox quickly gave 12345--67890 jumps!
+ The dazed brown fox quickly gave 12345--67890 jumps!
+ The dazed brown fox quickly gave 12345--67890 jumps!
+}
+
+\newcommand{\SHORTCAPi}{%
+ The dazed brown fox etc.}
+
+\newcommand*{\MARKER}
+ {\noindent\strut\vrule\hrulefill~text area
+ (\ifthenelse{\isodd{\thepage}}{odd}{even} page)~\hrulefill\vrule%
+ \marginpar{\strut\vrule\hrulefill~margin area~\hrulefill\vrule}}
+
+\endinput
diff --git a/Master/texmf-dist/doc/latex/sidecap/sc-test1.tex b/Master/texmf-dist/doc/latex/sidecap/sc-test1.tex
new file mode 100644
index 00000000000..726eaad5b5a
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/sidecap/sc-test1.tex
@@ -0,0 +1,141 @@
+
+% `sc-test1.tex', part of the LaTeX package `sidecap'
+% 2003-02-21
+% Rolf Niepraschk and Hubert G\"a\ss{}lein -- niepraschk@ptb.de
+
+\listfiles
+\documentclass[12pt,a4paper]{article}
+%\usepackage[bf,footnotesize]{caption2}
+%\usepackage[innercaption,origragged,ragged]{sidecap}
+%\usepackage[innercaption,raggedright]{sidecap}
+\usepackage{sidecap}
+
+\input{sc-test-common}
+
+%\newlength\mylength
+
+\begin{document}
+
+\section*{The \texttt{sidecap} package}
+
+First, a standard \LaTeX\ \texttt{figure} environment
+(fig.~\ref{fig:standard}).
+Since width of the body of the figure is considerably less than
+the document's \verb|\textwidth|, there is much space wasted.
+
+\begin{figure}[h]
+ \centering
+ \FIG[1cm]{1}%
+ \caption[\SHORTCAPi]{\CAPi}
+ \label{fig:standard}
+\end{figure}
+
+For such cases, the \textsf{sidecap} package provides the
+\verb|SCfigure| and \verb|SCtable| environments to put the
+caption beside the body of the floating environment.
+
+In this document, we used the defaults of the \textsf{sidecap} package:
+%
+\begin{verbatim}
+ \usepackage{sidecap}
+\end{verbatim}
+%
+In the text, we used the optional arguments for the following figures
+(fig.~\ref{fig:sc1}, \ref{fig:sc2}, and \ref{fig:sc3}).
+%
+\begin{verbatim}
+ \begin{SCfigure} ...
+ \begin{SCfigure}[1.2][bhp] ...
+ \begin{SCfigure}[][bhp] ...
+\end{verbatim}
+%
+In the first case, no optional arguments were given, so the defaults
+(\verb|[1.0][tbp]|) are used. I.e., the caption will be as wide as
+the body of the float; and the `float placement specifier' is the same
+as for \LaTeX's standard floats (fig.~\ref{fig:sc1}).
+In the second case, both optional arguments are given to change the
+caption width as well as the placement options (fig.~\ref{fig:sc2}).
+To change only the placement, just leave the first optional argument
+empty (fig.~\ref{fig:sc3}).
+
+\begin{SCfigure}
+ \FIG[1cm]{1}%
+ \caption[\SHORTCAPi]{\CAPi}
+ \label{fig:sc1}
+\end{SCfigure}
+
+\begin{SCfigure}[1.2][bhp]
+ \FIG[1cm]{1}%
+ \caption[\SHORTCAPi]{\CAPi}
+ \label{fig:sc2}
+\end{SCfigure}
+
+\begin{SCfigure}[][bhp]
+ \FIG[1cm]{1}%
+ \caption[\SHORTCAPi]{\CAPi}
+ \label{fig:sc3}
+\end{SCfigure}
+
+\clearpage
+
+Now, a standard \LaTeX\ \texttt{table} environment
+(tab.~\ref{tab:standard}).
+
+\begin{table}[h]
+ \centering
+ \caption[\SHORTCAPi]{\CAPi}
+ \TABi%
+ \label{tab:standard}
+\end{table}
+
+The only difference between the \verb|SCfigure| and the
+\verb|SCtable| environments is the vertical position of the
+caption with respect to the body of the float:
+The former places the caption bottom-aligned, the latter top-aligned
+(compare fig.~\ref{fig:sc1} to tab.~\ref{tab:sc1}).
+
+Also, like standard \LaTeX, the \textsf{sidecap} package doesn't care
+about the contents of the float (cf.\ tabs.~\ref{tab:standard} and
+\ref{tab:sc1}).
+
+\begin{SCtable}
+ \caption[\SHORTCAPi]{\CAPi}
+ \FIG[1cm]{1}%
+ \label{tab:sc1}
+\end{SCtable}
+
+If you want to use all the remaining space for the caption, just
+specify a sufficiently large factor in the first optional argument.
+E.g., for tab.~\ref{tab:sc2} we used the following:
+%
+\begin{verbatim}
+ \begin{SCtable}[50] ...
+\end{verbatim}
+%
+Note, however, that \TeX\ may complain
+%
+\begin{verbatim}
+ ! Dimension too large.
+\end{verbatim}
+%
+if the factor times the width of the body is huge enough to exceed
+the range \TeX\ is able to represent in a length register.
+%
+(Max.\ \verb|\maxdimen|%
+${}={}$\the\maxdimen
+${}\approx 5.76$\,{meters}).
+
+% VOODOO:
+%\setlength
+%\mylength=\maxdimen
+%\mylength=-\mylength
+%\the\mylength
+
+\begin{SCtable}[50]
+ \caption[\SHORTCAPi]{\CAPi}
+ \label{tab:sc2}
+% \TABi%
+ \FIG[1cm]{1}%
+\end{SCtable}
+
+\end{document}
diff --git a/Master/texmf-dist/doc/latex/sidecap/sc-test2.tex b/Master/texmf-dist/doc/latex/sidecap/sc-test2.tex
new file mode 100644
index 00000000000..b16d0eea837
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/sidecap/sc-test2.tex
@@ -0,0 +1,89 @@
+
+% `sc-test2.tex', part of the LaTeX package `sidecap'
+% 2003-02-21
+% Rolf Niepraschk and Hubert G\"a\ss{}lein -- niepraschk@ptb.de
+
+\documentclass[12pt,a4paper,twocolumn,twoside,draft]{article}
+\usepackage[bf,footnotesize]{caption2}
+%\usepackage[innercaption]{sidecap}
+\usepackage[outercaption,raggedright]{sidecap}
+
+\input{sc-test-common}
+
+\begin{document}
+\section*{\centering The \texttt{sidecap} package (two~column~layout)}
+
+In this document, we used the following options of the \textsf{sidecap} package:
+%
+\begin{verbatim}
+ \usepackage
+ [outercaption,raggedright]
+ {sidecap}
+\end{verbatim}
+%
+Note that fig.~\ref{fig:B} is an \verb|SCfigure*| environment.
+The \textsf{sidecap} package inherits the standard \LaTeX\ ``feature''
+that two-column floats and one-column floats may be out of order.
+
+\begin{figure}[bhp]
+ \centering
+ \FIG[1cm]{1}%
+ \caption[\SHORTCAPi]{\CAPi}\label{fig:A}%
+\end{figure}
+
+\begin{SCfigure*}[50] % [bhp]
+ \FIG[1cm]{1}%
+ \caption[\SHORTCAPi]{\CAPi}\label{fig:B}%
+\end{SCfigure*}
+
+\begin{SCfigure}[1.2][bhp]
+ \FIG[1cm]{1}%
+ \caption[\SHORTCAPi]{\CAPi}\label{fig:C}%
+\end{SCfigure}
+
+\begin{SCfigure}[][bhp]
+ \FIG[1cm]{1}%
+ \caption[\SHORTCAPi]{\CAPi}\label{fig:D}%
+\end{SCfigure}
+
+\begin{SCtable}
+ \caption[\SHORTCAPi]{\CAPi}\label{tab:A}%
+ \FIG[1cm]{1}%
+\end{SCtable}
+
+\begin{table}
+ \centering
+ \caption[\SHORTCAPi]{\CAPii}\label{tab:B}%
+ \TABi%
+\end{table}
+
+\begin{SCtable}
+ \caption[\SHORTCAPi]{\CAPi\CAPii}\label{tab:C}%
+ \TABi%
+\end{SCtable}
+
+%----------------------------
+
+\begin{SCfigure}[50][b]
+ \FIG[1cm]{1}%
+ \caption[\SHORTCAPi]{\CAPi}\label{fig:E}%
+\end{SCfigure}
+
+\clearpage
+
+
+\begin{SCfigure}[50][b]
+ \FIG[1cm]{1}%
+ \caption[\SHORTCAPi]{\CAPi}\label{fig:F}%
+\end{SCfigure}
+
+
+\end{document}
+
+
+
+
+
+
+
+
diff --git a/Master/texmf-dist/doc/latex/sidecap/sc-test3.tex b/Master/texmf-dist/doc/latex/sidecap/sc-test3.tex
new file mode 100644
index 00000000000..1b0de01b206
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/sidecap/sc-test3.tex
@@ -0,0 +1,54 @@
+
+% `sc-test3.tex', part of the LaTeX package `sidecap'
+% 2003-02-21
+% Rolf Niepraschk and Hubert G\"a\ss{}lein -- niepraschk@ptb.de
+
+\documentclass{article}
+
+\usepackage{sidecap}
+
+\input{sc-test-common}
+
+\begin{document}
+
+\section*{\centering The \texttt{sidecap} package
+ (changed caption alignment)}
+
+\begin{SCfigure}[][hb]
+ \FIG{1}
+ \caption{normal `SCfigure'}
+\end{SCfigure}
+
+\begin{SCtable}[][b]
+ \TABi
+ \caption{normal `SCtable'}
+\end{SCtable}
+
+\iffalse% the old way
+\makeatletter
+ \renewenvironment{SCfigure}{\SC@float[t]{figure}}
+ {\endSC@float}
+ \renewenvironment{SCfigure*}{\SC@dblfloat[t]{figure}}
+ {\endSC@dblfloat}
+ \renewenvironment{SCtable}{\SC@float[b]{table}}
+ {\endSC@float}
+ \renewenvironment{SCtable*}{\SC@dblfloat[b]{table}}
+ {\endSC@dblfloat}
+\makeatother
+\fi
+
+% the new way
+\sidecaptionvpos{figure}{t}
+\sidecaptionvpos{table}{b}
+
+\begin{SCfigure}[][hb]
+ \FIG{1}
+ \caption{`SCfigure' modified\dots}
+\end{SCfigure}
+
+\begin{SCtable}[][b]
+ \TABi
+ \caption{`SCtable' modified\dots}
+\end{SCtable}
+
+\end{document}
diff --git a/Master/texmf-dist/doc/latex/sidecap/sc-test4.tex b/Master/texmf-dist/doc/latex/sidecap/sc-test4.tex
new file mode 100644
index 00000000000..1061deed9e2
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/sidecap/sc-test4.tex
@@ -0,0 +1,76 @@
+
+% `sc-test4.tex', part of the LaTeX package `sidecap'
+% 2003-02-14
+% Rolf Niepraschk and Hubert G\"a\ss{}lein -- niepraschk@ptb.de
+
+\errorcontextlines\maxdimen
+
+\listfiles
+\documentclass[12pt,draft,a4paper,twoside]{article}
+\usepackage[bf,footnotesize]{caption2}
+\usepackage[outercaption,wide,raggedright]{sidecap}
+%\usepackage[outercaption,wide,raggedright]{sidecap}
+%\usepackage[innercaption,wide]{sidecap}
+
+\usepackage[verbose]{geometry}[2002/07/04]
+\geometry{includemp,marginpar=5cm,hmarginratio={2:3},right=3cm}
+
+\input{sc-test-common}
+
+\begin{document}
+
+\tracingall \tracingonline0
+
+\section*{The \texttt{sidecap} package (package option \texttt{wide} and
+ the wide environment)}
+
+\begin{SCfigure}[50][h]
+ \FIG{1}\caption{\CAPi}%
+\end{SCfigure}
+
+\vfill
+\MARKER
+\vfill
+
+\begin{figure}[b]
+ \begin{wide}
+ \FIG{2}\caption{XYZ \CAPi}%
+ \end{wide}
+\end{figure}
+
+\clearpage
+
+\begin{SCfigure}[50][h]
+ \FIG{1}\caption{\CAPi}%
+\end{SCfigure}
+
+\vfill
+\MARKER
+\vfill
+
+\begin{figure}[b]
+ \begin{wide}
+ \FIG{2}\caption{\CAPi}%
+ \end{wide}
+\end{figure}
+
+\clearpage
+
+\begin{SCfigure}[.9][t]
+ \FIG{1}\caption{\CAPi}%
+\end{SCfigure}
+
+\MARKER
+
+\begin{wide}
+ \FIG{2}
+\end{wide}
+
+\vfill
+
+\end{document}
+
+
+
+
+
diff --git a/Master/texmf-dist/doc/latex/sidecap/sc-test5.tex b/Master/texmf-dist/doc/latex/sidecap/sc-test5.tex
new file mode 100644
index 00000000000..8029eaa66b2
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/sidecap/sc-test5.tex
@@ -0,0 +1,41 @@
+
+% `sc-test5.tex', part of the LaTeX package `sidecap'
+% 2003-02-14
+% Rolf Niepraschk and Hubert G\"a\ss{}lein -- niepraschk@ptb.de
+
+\listfiles
+\documentclass[12pt,draft,a4paper,twoside]{article}
+\usepackage[bf,footnotesize]{caption2}
+%\usepackage[margincaption,raggedright]{sidecap}
+%\usepackage[margincaption,raggedright,innerbody]{sidecap}
+\usepackage[margincaption,ragged,centerbody]{sidecap}
+
+\usepackage{geometry}[2002/07/04]
+\geometry{includemp,marginpar=5cm,hmarginratio={2:3},right=3cm}
+
+\input{sc-test-common}
+
+\begin{document}
+
+\section*{The \texttt{sidecap} package (package option \texttt{margincaption})}
+
+\begin{SCfigure}[][bh]
+ \FIG{1}\caption{\CAPi}%
+\end{SCfigure}
+
+\MARKER
+
+\clearpage
+
+\begin{SCfigure}
+ \FIG{1}\caption{\CAPi}%
+\end{SCfigure}
+
+\MARKER
+
+\end{document}
+
+
+
+
+
diff --git a/Master/texmf-dist/doc/latex/sidecap/sc-test6.tex b/Master/texmf-dist/doc/latex/sidecap/sc-test6.tex
new file mode 100644
index 00000000000..be544084835
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/sidecap/sc-test6.tex
@@ -0,0 +1,89 @@
+
+% `sc-test6.tex', part of the LaTeX package `sidecap'
+% 2003-02-21
+% Rolf Niepraschk and Hubert G\"a\ss{}lein -- niepraschk@ptb.de
+
+\listfiles
+\documentclass[a4paper]{article}
+
+%\usepackage[colorgrid,gridunit=pt]{eso-pic}
+
+\usepackage{sidecap}
+%\usepackage[ragged]{sidecap}
+
+\input{sc-test-common}
+
+\begin{document}
+
+\section*{The \texttt{sidecap} package
+ (text in body of floats)}
+
+If you need to put text inside the body of a floating
+environment, you'll have to put it inside a \verb|\parbox|
+or a \verb|minipage| environment.
+(This is necessary due to the way the \textsf{sidecap} package
+grabs the body of the float.)
+
+For example, the first pair of floats in this document
+(fig.~\ref{fig:wrong} and tab.~\ref{tab:wrong})
+contain essentially the following:
+%
+\begin{verbatim}
+ \begin{minipage}{0.5\textwidth}%
+ text text ... text text.
+ \end{minipage}%
+\end{verbatim}
+%
+Note that the alignment of the caption with respect to text in the body
+is wrong.
+
+\begin{SCfigure}[][hb]
+ \FIG[0.078\textwidth]{3}
+ \caption{`SCfigure' \CAPi}
+ \label{fig:wrong}
+\end{SCfigure}
+
+\begin{SCtable}[][hb]
+ \FIG[0.078\textwidth]{3}
+ \caption{`SCtable' \CAPi}
+ \label{tab:wrong}
+\end{SCtable}
+
+To fix this problem, you'll have to use some extra effort.
+
+\clearpage
+
+For example, the second pair of floats
+(fig.~\ref{fig:right} and tab.~\ref{tab:right})
+contain essentially the following:
+%
+\begin{verbatim}
+ \begin{minipage}{0.5\textwidth}%
+ \strut
+ text text ... text text.
+ \unskip\strut
+ \end{minipage}%
+\end{verbatim}
+%
+Now the caption is properly aligned with the first or last line of
+the text in the float's body.
+
+\begin{SCfigure}[][hb]
+ \FIG[0.078\textwidth]{4}
+ \caption{`SCfigure' \CAPi}
+ \label{fig:right}
+\end{SCfigure}
+
+\begin{SCtable}[][hb]
+ \FIG[0.078\textwidth]{4}
+ \caption{`SCtable' \CAPi}
+ \label{tab:right}
+\end{SCtable}
+
+Still, there is a flaw in the captions:
+Due to the small \verb|\linewidth| the linebreaking and\slash or
+word spacing may be awful.
+Use one of the \texttt{raggedright}, \texttt{raggedleft}, or
+\texttt{ragged} package options.
+
+\end{document}