Debian Codegraph @

texmf-dist/source/latex/nonfloat/nonfloat.dtx

raw
1 \def\filedate{1999/07/05}
2 \def\fileversion{1.0}
3 %
4 %
5 %\iffalse
6 % class `nonfloat' to be used with LaTeX 2e
7 % Copyright (C) 1999 Kai Rascher. All rights reserved.
8 %
9 % Copying of this file is authorized only if either
10 % (1) you make absolutely no changes to your copy, including name, or
11 % (2) if you do make changes, you name it something other than
12 % nonfloat.* .
13 % This restriction helps ensure that all files developed
14 % are identical.
15 %
16 % Error reports for UNCHANGED versions please to:
17 %
18 % Kai Rascher
19 % Am Remenhof 17a
20 % 38104 Braunschweig
21 % Germany
22 % E-Mail: <[email protected]>
23 %
24 %\fi
25 %
26 %\flushbottom
27 %
28 %\parindent0mm
29 %\parskip3mm
30 %\title{ Nicht-gleitende Tabellen und Bilder\\
31 % in \LaTeXe\\
32 % --~nonfloat\thanks{Diese Datei
33 % hat die Versionsnummer \fileversion\ --\
34 % letzte "Uberarbeitung \filedate.}~~--}
35 %
36 %\author{ Kai Rascher\\
37 % Am Remenhof 17a\\
38 % D--38104 Braunschweig\\
39 % {\tt [email protected]}}
40 %
41 %\date{Version~\fileversion}
42 %
43 %\maketitle
44 %
45 %\section{Kurzinformation}
46 %
47 %Die Positionierung von Bildern und Tabellen in \LaTeXe-Dokumenten wirft
48 %immer wieder fragen auf. Insbesondere wenn Tabellen und Bilder nicht gleiten
49 %sollen, aber dennoch ein numerierte Tabellen"uberschrift bzw.\
50 %Bildunterschrift gew"unscht wird, wird h"aufig versucht, dies "uber den
51 %Parameter [h] zu erreichen. Da die Parameter f"ur Gleitobjekte optional und
52 %f"ur \LaTeXe\ nicht bindend sind, erreicht man durch die Angabe von [h]
53 %i.\,a.\ nicht die Plazierung der Tabelle oder des Bildes an der mit
54 %\glqq here\grqq\ angegebenen Stelle.
55 %
56 %Als Alternative kann auf das \LaTeXe-Paket \textsf{float} zur"uckgegriffen
57 %werden. Dieses Paket, welches die Definition weiterer Gleitobjekte beispielsweise
58 %f"ur Programm-Code oder Algorithmen erm"oglicht, bietet den zus"atzlichen
59 %Parameter [H]. Damit lassen sich Gleitobjekte zwar \glqq Here\grqq\ oder
60 %am Seitenanfang der n"achsten Seite plazieren, die Beschriftungen sind aber
61 %nur unterhalb des Gleitobjekts m"oglich. Typographisch richtig ist jedoch, da"s
62 %Tabellen stets "Uberschriften haben.
63 %
64 %Das Paket \textsf{nonfloat} greift die in \cite{epslatex,Reichert} gemachten
65 %Empfehlungen auf und definiert verschiedene \verb|\XXXcaption|-Befehle f"ur
66 %nicht-gleitende Objekte.
67 %
68 %Weiterhin erfolgt eine Anpassung der Plazierungsparameter \verb|\textfraction|,
69 %\verb|\topfraction|, \verb|\bottomfraction| und \verb|\floatpagefraction| nach
70 %Vorgaben in \cite{epslatex}. Zus"atzlich werden die L"angenangaben f"ur die
71 %Plazierung von Gleitobjekten auf separaten \glqq Floatpages\grqq\ so
72 %angepa"st, da"s keine vertikale Zentrierung mehr stattfindet.
73 %
74 %Tabellen und Bilder werden standardm"a"sig nicht zentriert, obwohl ein einzeiliger
75 %\verb|\caption|-Eintrag zentriert ausgegeben wird. In \textsf{nonfloat} wird nach
76 %\cite{Reichert2} eine entsprechende Anpassung vorgenommen. Dabei wird auch der
77 %vertikale Abstand von Tabellen"uberschriften analog zu den Bildunterschriften
78 %festgelegt.
79 %
80 %Aus \cite{epslatex} wurde die \verb|narrow|-Umgebung "ubernommen. Mit dieser
81 %Umgebung kann nicht nur ein schmaler Textbereich gesetzt werden, durch die
82 %Angabe negativer L"angen ist es m"oglich, sehr breite Bilder, Tabellen o.\,"a.\
83 %in den linken oder rechten Rand hineinragen zu lassen.
84 %
85 %\section{Verwendung}
86 %\subsection{Laden der Style-Option}
87 %Um die Befehle des \textsf{nonfloat}-Pakets verwenden zu k"onnen, mu"s die
88 %Style-Option mit einem Aufruf
89 %
90 %\verb|\usepackage{nonfloat}|
91 %
92 %nach der Deklaration der Dokumentenklasse mit \verb|\documentclass| geladen
93 %werden.
94 %
95 %\subsection{Befehle}
96 %Nach dem Laden stehen neben dem Befehl \verb|\caption| weitere 2~Befehle
97 %zur Erzeugung von Beschriftungen f"ur nicht-gleitende Tabellen und Bilder
98 %zur Verf"ugung.
99 %\\[\intextsep]
100 %\begin{minipage}{\linewidth}
101 %\centering%
102 %\tabcaption{Befehle f"ur Tabellen"uber- und Bildunterschriften}%
103 %\label{tab:Befehle}%
104 %\begin{tabular}{*{2}{l}}
105 % "Uberschrift f"ur nicht-gleitende Tabellen & \verb|\tabcaption|\\
106 % Unterschrift f"ur nicht-gleitende Bilder & \verb|\figcaption|
107 %\end{tabular}
108 %\end{minipage}
109 %\\[\intextsep]
110 %Zur Realisierung wurde ein Befehl \verb|\topcaption| definiert, der den gleichen
111 %vertikalen Abstand zwischen einer "Uberschrift und dem Objekt einf"ugt, wie dies
112 %bei Objektunterschriften mit \verb|\caption| erfolgt. Der Befehl
113 %\verb|\topcaption| wird innerhalb des \LaTeXe-Dokumentes nicht ben"otigt.
114 %
115 %Die Befehle \verb|\tabcaption| und \verb|\figcaption| greifen auf die Befehle
116 %\verb|\topcaption| bzw.\ \verb|\caption| zur"uck, sind aber f"ur die Verwendung
117 %au"serhalb von Gleitumgebungen gedacht. Beispiele sind in
118 %Abschnitt~\ref{Beispiele} zu finden.
119 %
120 %\subsection{Anpassung der Plazierungsparameter}
121 %\tablename~\ref{tab:Plazierung} umfa"st die neu definierten Werte f"ur die
122 %Plazierungsparameter sowie ihre bisherigen \LaTeXe-Standardwerte. Au"serdem
123 %sind Ungleichungen f"ur empfohlene Wertebereiche gegeben \cite{epslatex}.
124 %\\[\intextsep]
125 %\begin{minipage}{\linewidth}
126 %\centering%
127 %\tabcaption{"Anderung der Parameter f"ur die Gleitobjektplazierung}%
128 %\label{tab:Plazierung}%
129 %\small
130 %\renewcommand{\arraystretch}{1.25}
131 %\begin{tabular}{@{}l*{2}{c}l@{}}\hline
132 % Name & Wert & Default & Empfehlung\\ \hline
133 % \verb|\textfraction| & 0.15 & 0.2 & $\verb|\textfraction| \ge 0.15$\\
134 % \verb|\topfraction| & 0.85 & 0.7 & $\verb|\topfraction| \le 1-\verb|\textfraction|$\\
135 % \verb|\bottomfraction| & 0.65 & 0.3 & $\verb|\bottomfraction| < \verb|\topfraction|$\\
136 % & & & $\verb|\bottomfraction| \le 1-\verb|\textfraction|$\\
137 % \verb|\floatpagefraction| & 0.60 & 0.5 & $\verb|\floatpagefraction| \le \verb|\topfraction|-0.05$\\
138 % & & & $\verb|\floatpagefraction| \le 1-\verb|\textfraction|$\\ \hline
139 %\end{tabular}
140 %\end{minipage}
141 %
142 %\subsection{Anpassung der table- und figure-Umgebung}
143 %Innerhalb der \verb|table|"~ und \verb|figure|"~Umgebung wird der Inhalt
144 %nicht zentriert gesetzt, obwohl gleichzeitig eine einzeilige Beschriftung
145 %zentriert ausgegeben wird. Die Umgebungen wurden daher umdefiniert, wobei
146 %dar"uber hinaus die vertikalen Abst"ande f"ur Tabellen"uberschriften analog
147 %zu Bildunterschriften angepa"st wurden \cite{Reichert2}.
148 %
149 %\subsection{Anpassung vertikaler Zwischenr"aume bei \glqq Gleitseiten\grqq}
150 %Wenn Gleitobjekte nicht innerhalb des Textes, sondern auf extra Seiten
151 %(Gleitseiten~--~Floatpages) angeordnet werden, zentriert \LaTeXe\ die Gleitobjekte
152 %vertikal. Dies wird durch die in \tablename~\ref{tab:Gleitseiten} angegebenen neuen
153 %Werte verhindert. Werden mehrere Gleitobjekte auf einer Gleitseite plaziert,
154 %wird nun der gleiche vertikale Zwischenraum wie bei Gleitobjekte auf
155 %anderen Seiten eingef"ugt. Die bisherigen Defaultwerte sind ebenfalls angegeben.
156 %\\[\intextsep]
157 %\begin{minipage}{\linewidth}
158 %\centering%
159 %\tabcaption{"Anderung der vertikalen Zwischenr"aume bei Gleitseiten}%
160 %\label{tab:Gleitseiten}%
161 %\small%
162 %\renewcommand{\arraystretch}{1.25}%
163 %\begin{tabular}{@{}*{3}{l}@{}}\hline
164 % Name & neuer Wert & Defaultwert\\ \hline
165 % \verb|\@fptop| & \verb|0pt| & \verb|0pt plus 1.0fil|\\
166 % \verb|\@fpsep| & \verb|20pt plus 2pt minus 2pt| & \verb|8pt plus 2.0fil|\\
167 % \verb|\@fpbot| & \verb|0pt| & \verb|0pt plus 1.0fil|\\ \hline
168 %\end{tabular}
169 %\end{minipage}
170 %\\[\intextsep]
171 %
172 %Die Einheit \verb|fil| erm"oglicht das Einf"ugen vertikalen Zwischenraums
173 %beliebiger L"ange. Dies ist mit dem Befehl \verb|\vfill| vergleichbar.
174 %Durch Multiplikation von \verb|fil| wird eine entsprechend proportionale
175 %Aufteilung des Freiraums erzeugt.
176 %
177 %"Anderungen an den in \tablename~\ref{tab:Gleitseiten} gegebenen L"angenparametern
178 %m"ussen innerhalb eines \LaTeXe-Dokumentes mit den Befehlen \verb|\makeatletter|
179 %und \verb|\makeatother| eingerahmt werden, damit das at-Zeichen (\verb|@|)
180 %in den Parameternamen richtig verarbeitet wird.
181 %
182 %\subsection{Umgebung}
183 %Zum Setzen sehr breiter Bilder oder Tabellen kann die \verb|narrow|-Umgebung
184 %mit negativen L"angenangaben innerhalb oder au"serhalb von Gleitobjekten
185 %verwendet werden. Mit
186 %\begin{verbatim}
187 % \begin{narrow}{-1in}{0in}
188 % ...
189 % \end{narrow}
190 %\end{verbatim}
191 %wird der Inhalt der \verb|narrow|-Umgebung so gesetzt, da"s er um 1\,in in den
192 %linken Rand ragt und b"undig mit dem rechten Rand abschlie"st. Soll auch in den
193 %rechten Rand geschrieben werden, mu"s die zweite L"angenangabe ebenfalls negativ
194 %sein.
195 %
196 %\subsection{Beispiele}
197 %\label{Beispiele}
198 %\subsubsection{Gleitende Tabelle}
199 %\begin{verbatim}
200 % \begin{table}[htbp]
201 % \caption{Tabellen"uberschrift}%
202 % \label{tab:ueberschrift}%
203 % \begin{tabular}{...}
204 % ...
205 % \end{tabular}
206 % \end{table}
207 %\end{verbatim}
208 %
209 %\subsubsection{Gleitendes Bild}
210 %\begin{verbatim}
211 % \begin{figure}[htbp]
212 % \includegraphics[width=0.8\linewidth,clip=]{input.eps}%
213 % \caption{Bildunterschrift}%
214 % \label{fig:input.eps}%
215 % \end{figure}
216 %\end{verbatim}
217 %
218 %\pagebreak
219 %\subsubsection{Nicht-gleitende Tabelle}
220 %\begin{verbatim}
221 % \\[\intextsep]
222 % \begin{minipage}{\linewidth}
223 % \centering%
224 % \tabcaption{Befehle f"ur Tabellen"uber- und Bildunterschriften}%
225 % \label{tab:Befehle}%
226 % \begin{tabular}{*{2}{l}}
227 % ...
228 % \end{tabular}
229 % \end{minipage}
230 % \\[\intextsep]
231 %\end{verbatim}
232 %Die Angabe von \verb|\\[\intextsep]| f"ugt genau den vertikalen Zwischenraum ein,
233 %der auch bei Gleitobjekten verwendet wird.
234 %
235 %\subsubsection{Nicht-gleitendes Bild}
236 %\begin{verbatim}
237 % \\[\intextsep]
238 % \begin{minipage}{\linewidth}
239 % \centering%
240 % \includegraphics[width=0.8\linewidth,clip=]{input.eps}%
241 % \figcaption{Bildunterschrift}%
242 % \label{fig:input.eps}%
243 % \end{minipage}
244 % \\[\intextsep]
245 %\end{verbatim}
246 %
247 %
248 %\begin{thebibliography}{99}
249 % \bibitem{epslatex} Reckdahl, Keith: \emph{Using Imported Graphics in \LaTeXe},
250 % Version~2.0, 15.~Dezember~1997.
251 % \bibitem{Reichert} Reichert, Axel:
252 % \mbox{\verb|<[email protected]>|}
253 % Message-ID im Usenet
254 % \bibitem{Reichert2} Reichert, Axel:
255 % \mbox{\verb|<[email protected]>|}
256 % Message-ID im Usenet
257 %\end{thebibliography}
258 %\enddocument
259 %
260 %
261 %
262 %\begin{macrocode}
263 %
264 % nonfloat BEFEHLE
265 %
266 %<*style>
267 \def\filename{nonfloat.sty}
268 \NeedsTeXFormat{LaTeX2e}[1994/06/01]
269 \RequirePackage{ifthen}[1994/06/01]
270 %
271 % Von Axel Reichert Message-ID: <[email protected]>
272 % Definition eines \topcaption-Befehls mit angepa"sten Abst"anden, wenn
273 % das zu beschriftende Objekt unterhalb der Beschriftung steht.
274 \newcommand{\topcaption}{%
275 \setlength{\@tempdima}{\abovecaptionskip}%
276 \setlength{\abovecaptionskip}{\belowcaptionskip}%
277 \setlength{\belowcaptionskip}{\@tempdima}%
278 \caption%
279 }
280 %
281 % Definition von \figcaption zur Nutzung au"serhalb von Gleitumgebungen;
282 % aus epslatex.ps
283 \newcommand{\figcaption}{\def\@captype{figure}\caption}
284 %
285 % Definition von \tabcaption zur Nutzung au"serhalb von Gleitumgebungen
286 % Es wird \topcaption verwendet, damit die vertikalen Zwischenr"aume
287 % wieder passen;
288 % aus epslatex.ps und ver"andert.
289 \newcommand{\tabcaption}{\def\@captype{table}\topcaption}
290 %
291 % Von Axel Reichert Message-ID: <[email protected]>
292 % Anpassen der figure-Umgebung, damit der Inhalt automatisch zentriert wird,
293 % denn einzeilige \caption-Eintr"age werden ebenfalls zentriert.
294 \renewenvironment{figure}[1][]{%
295 \ifthenelse{\equal{#1}{}}{%
296 \@float{figure}%
297 }{%
298 \@float{figure}[#1]%
299 }%
300 \centering%
301 }{%
302 \end@float%
303 }
304 %
305 % Von Axel Reichert Message-ID: <[email protected]>
306 % Anpassen der table-Umgebung, damit der Inhalt automatisch zentriert wird,
307 % denn einzeilige \caption-Eintr"age werden ebenfalls zentriert. Au"serdem wird
308 % der Abstand bei der table-Umgebung so angepa"st, da"s die Tabellen"uberschrift den
309 % richtigen Abstand zur darunter stehenden Tabelle aufweist.
310 \renewenvironment{table}[1][]{%
311 \ifthenelse{\equal{#1}{}}{%
312 \@float{table}%
313 }{%
314 \@float{table}[#1]%
315 }%
316 \centering%
317 \setlength{\@tempdima}{\abovecaptionskip}%
318 \setlength{\abovecaptionskip}{\belowcaptionskip}%
319 \setlength{\belowcaptionskip}{\@tempdima}%
320 }{%
321 \end@float%
322 }
323 %
324 % Anpassung der Plazierungsparameter
325 \renewcommand{\textfraction}{0.15}
326 \renewcommand{\topfraction}{0.85}
327 \renewcommand{\bottomfraction}{0.65}
328 \renewcommand{\floatpagefraction}{0.60}
329 %
330 % Anpassung der vertikalen Zwischenr"aume f"ur Gleitobjekte auf
331 % \glqq Gleitseiten\grqq
332 \setlength{\@fptop}{0pt}
333 \setlength{\@fpsep}{20pt plus 2pt minus 2pt}
334 \setlength{\@fpbot}{0pt}
335 %
336 % Definition der narrow-Umgebung
337 \newenvironment{narrow}[2]{%
338 \begin{list}{}%
339 {%
340 \setlength{\topsep}{0pt}%
341 \setlength{\leftmargin}{#1}%
342 \setlength{\rightmargin}{#2}%
343 \setlength{\listparindent}{\parindent}%
344 \setlength{\itemindent}{\parindent}%
345 \setlength{\parskip}{\parskip}%
346 }%
347 \item[]}%
348 {\end{list}}%
349 %</style>
350 %
351 %<*driver>
352 \documentclass{ltxdoc}
353 \usepackage{german}
354 \usepackage{nonfloat}
355 \begin{document}
356 \DocInput{nonfloat.dtx}
357 \end{document}
358 %</driver>
359 %
360 %\end{macrocode}
361 \endinput