summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/bgteubner/doc/src/verzeichnisse.tex
diff options
context:
space:
mode:
Diffstat (limited to 'macros/latex/contrib/bgteubner/doc/src/verzeichnisse.tex')
-rw-r--r--macros/latex/contrib/bgteubner/doc/src/verzeichnisse.tex351
1 files changed, 351 insertions, 0 deletions
diff --git a/macros/latex/contrib/bgteubner/doc/src/verzeichnisse.tex b/macros/latex/contrib/bgteubner/doc/src/verzeichnisse.tex
new file mode 100644
index 0000000000..3d5476ba97
--- /dev/null
+++ b/macros/latex/contrib/bgteubner/doc/src/verzeichnisse.tex
@@ -0,0 +1,351 @@
+%
+% bgteubner class bundle
+%
+% verzeichnisse.tex
+% Copyright 2003--2012 Harald Harders
+%
+% This program may be distributed and/or modified under the
+% conditions of the LaTeX Project Public License, either version 1.3
+% of this license or (at your opinion) any later version.
+% The latest version of this license is in
+% http://www.latex-project.org/lppl.txt
+% and version 1.3 or later is part of all distributions of LaTeX
+% version 1999/12/01 or later.
+%
+% This program consists of all files listed in manifest.txt.
+% ===================================================================
+\chapter{Verzeichnisse}%
+\index{Verzeichnis}%
+
+Verzeichnisse nehmen im Buch eine gesonderte Stellung ein.
+Sie enthalten keine eigentlichen Inhalte.
+Stattdessen dienen sie zur Orientierung im Buch.
+Da es verschiedene Herangehensweisen beim Konsultieren eines Buches
+gibt, sind auch unterschiedliche Verzeichnisse notwendig.
+
+Die Reihenfolge der einzelnen Verzeichnisse ist nicht exakt
+festgelegt (bis auf das Stichwortverzeichnis, das als letztes
+Verzeichnis gesetzt werden muss).
+Eine mögliche Reihenfolge\index{Verzeichnis!Reihenfolge} ist die
+folgende:
+Literaturverzeichnis, Formelzeichenverzeichnis, Abkürzungsverzeichnis,
+Abbildungsverzeichnis, Tabellenverzeichnis, Verzeichnis der
+Beispiele, Aufgabenverzeichnis, Stichwortverzeichnis.
+
+In den meisten Fällen sind aber einige dieser Verzeichnisse nicht
+nötig.
+So werden die meisten Leser nach einem Sachverhalt nicht im
+Abbildungs"~, Tabellen"~, Aufgaben"~ oder Beispielverzeichnis suchen,
+sondern das Stichwortverzeichnis konsultieren, in dem der im Bild
+o.\,ä.\ verwendete Begriff aufgeführt sein sollte.
+Ein Formelzeichenverzeichnis beispielsweise sollte aber vorhanden
+sein.
+
+% -------------------------------------------------------------------
+\section{Inhaltsverzeichnis}%
+\index{Inhaltsverzeichnis|textbf}%
+
+Das Aussehen des Inhaltsverzeichnisses kann am einfachsten anhand des
+Inhaltsverzeichnisses dieser Anleitung studiert werden.
+
+Einige Hinweise seien jedoch hier gegeben:
+Teil"= und Kapitelüberschriften werden in unterschiedlichen
+Schriftgraden fett gesetzt, dazu rechtsbündig fett die entsprechende
+Seitenzahl.
+Abschnitte sowie Unterabschnitte werden normal gesetzt.
+Bei ihnen wird zusätzlich eine Punktreihe bis zur Seitenzahl gesetzt.
+
+Im Inhaltsverzeichnis sind auch die weiteren
+Verzeichnisse wie Formel"~, Abkürzungs"~,
+\feinschliff{Literatur"=,}{Literatur"~,}{Literatur"~,}{Literatur"~,}
+Abbildungs"~,
+Tabellen"~, sowie Stichwortverzeichnis eingetragen, sofern vorhanden.
+
+Da das Inhaltsverzeichnis automatisch erzeugt wird, wird auf weitere
+Einzelheiten verzichtet.
+
+% -------------------------------------------------------------------
+\section{Literaturverzeichnis}%
+\index{Literaturverzeichnis|textbf}%
+
+Im Literaturverzeichnis werden alle Literaturstellen, auf die im Buch
+verwiesen wird, aufgeführt.
+Es wird eine numerische Bezeichnung der Literaturstellen, jeweils in
+eckigen Klammern, verwendet.
+Titel werden kursiv gesetzt, alles andere normal aufrecht.
+Kapitälchen werden normalerweise nicht verwendet.
+Es wird Flattersatz eingesetzt, da ansonsten ein sehr unruhiges
+Satzbild entstehen würde.
+Da das Literaturverzeichnis automatisch erstellt wird, wird an dieser
+Stelle auf eine genauere Beschreibung verzichtet.
+
+
+% -------------------------------------------------------------------
+\section{Abbildungsverzeichnis und Tabellenverzeichnis}%
+\index{Abbildungsverzeichnis|textbf}%
+\index{Tabellenverzeichnis|textbf}%
+
+Das Abbildungsverzeichnis und das Tabellenverzeichnis werden als
+unnummerierte Kapitel gesetzt, die im Anschluss an den Anhang
+eingefügt werden können.
+
+Im Abbildungsverzeichnis werden alle im Buch vorhandenen Bilder
+aufgelistet.
+Für jedes Bild wird die Bildnummer, die Bildunterschrift und die
+Seitenzahl eingetragen.
+Da die Bildunterschriften mitunter recht lang werden können, sollte
+dann im Verzeichnis nur eine Kurzform der Bildunterschrift verwendet
+werden.
+Für das Tabellenverzeichnis gilt dasselbe wie für das
+Abbildungsverzeichnis.
+
+Ob ein Abbildungsverzeichnis und ein Tabellenverzeichnis überhaupt
+erstellt werden soll, bleibt dem Autoren freigestellt.
+Es müssen aber entweder beide oder keines der beiden Verzeichnisse
+gedruckt werden.
+Das Abbildungsverzeichnis muss direkt vor dem Tabellenverzeichnis
+stehen und am Ende des Anhangs gesetzt werden.
+
+Um Platz zu sparen, werden diese Verzeichnisse in einer
+9~Punkt~Schrift gesetzt.
+
+% -------------------------------------------------------------------
+\section{Verzeichnisse der Beispiele und der Aufgaben usw.}%
+\index{Verzeichnis der Beispiele|textbf}%
+\index{Aufgabenverzeichnis|textbf}%
+
+Diese Verzeichnisse werden wie das Abbildungsverzeichnis gesetzt.
+Sie enthalten die in den Abschnitten~\ref{sec:beispiele} und
+\ref{sec:aufgaben} eingeführten Beispiele, Aufgaben oder andere
+entsprechend gesetzte Umgebungen.
+Auch diese Verzeichnisse sind optional.
+
+Wird eine zentrale Aufgabensammlung für das Buch verwendet, können die
+Aufgaben auch ins Inhaltsverzeichnis statt in ein gesondertes
+Aufgabenverzeichnis aufgenommen werden.
+
+% -------------------------------------------------------------------
+\section{Verwendete Formelzeichen}%
+\label{sec:formelzeichen}%
+\index{Formelzeichenverzeichnis|textbf}%
+
+Im Formelzeichenverzeichnis werden tabellarisch alle wichtigen Formelzeichen
+und Indizierungen des Buches aufgeführt und kurz erklärt oder benannt.
+Dabei bleibt es dem Autoren freigestellt, ob er alle Formelzeichen
+in eine gemeinsame Liste setzt, oder ob er einzelne, nach Themen
+getrennte Listen (z.\,B.\ Skalare, Vektoren, Matrizen, \dots)
+erstellt.
+
+Ein Formelverzeichnis kann etwa so aussehen:
+\begin{theglossary}[\subsection*{Skalare}]%
+ %
+ \item[$\alpha_{\mathrm{k}}$] Kerbformzahl
+ %
+ \item[$\varepsilon$] technische Dehnung
+ %
+ \item[$\varphi$] wahre Dehnung
+ %
+ \item[$\sigma$] Spannung
+ %
+ \item[$a$] Gitterkonstante
+ \item[$a$] Risslänge bei Oberflächenrissen und halbe Risslänge bei inneren
+ Rissen
+ %
+ \item[$c$] Gitterkonstante
+ %
+ \item[$K$] Spannungsintensitätsfaktor
+ %
+ \item[$R_{\mathrm{eH}}$] obere Streckgrenze für Materialien mit ausgeprägter
+ Streckgrenze
+ \item[$R_{\mathrm{eL}}$] untere Streckgrenze für Materialien mit
+ ausgeprägter Streckgrenze
+ \item[$R_{\mathrm{m}}$] Zugfestigkeit
+ \item[$R_{\mathrm{p0,2}}$] Dehngrenze für Materialien ohne ausgeprägte
+ Streckgrenze
+ %
+\end{theglossary}%
+
+Es ist auch möglich, Buchstaben zur Gliederung einzufügen:
+\begin{theglossary}[\subsection*{Skalare}]%
+ \glossarynewchar{Symbole}
+ \item[$\alpha_{\mathrm{k}}$] Kerbformzahl
+ \item[$\varepsilon$] technische Dehnung
+ \item[$\varphi$] wahre Dehnung
+ \item[$\sigma$] Spannung
+ \glossarynewchar{A}
+ \item[$a$] Gitterkonstante
+ \item[$a$] Risslänge bei Oberflächenrissen und halbe Risslänge bei
+ inneren Rissen
+ \glossarynewchar{C}
+ \item[$c$] Gitterkonstante
+ \glossarynewchar{K}
+ \item[$K$] Spannungsintensitätsfaktor
+ \glossarynewchar{R}
+ \item[$R_{\mathrm{eH}}$] obere Streckgrenze für Materialien mit
+ ausgeprägter Streckgrenze
+ \item[$R_{\mathrm{eL}}$] untere Streckgrenze für Materialien mit
+ ausgeprägter Streckgrenze
+ \item[$R_{\mathrm{m}}$] Zugfestigkeit
+ \item[$R_{\mathrm{p0,2}}$] Dehngrenze für Materialien ohne
+ ausgeprägte Streckgrenze
+\end{theglossary}%
+
+Im Formelverzeichnis sollen die Einträge alphabetisch sortiert
+sein.
+Die Symbole, die sich nicht in das lateinische Alphabet einsortieren
+lassen (z.\,B. griechische Zeichen), stehen davor und sind~-- soweit
+möglich~-- untereinander sortiert.
+
+Das griechische Alphabet wird folgendermaßen sortiert:
+$A\alpha$, $B\beta$, $\Gamma\gamma$, $\Delta\delta$,
+\makeatletter
+$E\varepsilon\iftimes{\ifhhcls@mathtime\epsilon\fi}{\epsilon}$,
+\makeatother
+$Z\zeta$, $H\eta$,
+$\Theta\vartheta\theta$, $I\iota$, $K\kappa$, $\Lambda\lambda$,
+$M\mu$, $N\nu$, $\Xi\xi$, $Oo$, $\Pi\pi$,
+\makeatletter
+$P\varrho\iftimes{\ifhhcls@mathtime\rho\fi}{\rho}$,
+\makeatother
+$\Sigma\sigma$, $T\tau$, $Y\upsilon$, $\Phi\varphi\phi$, $X\chi$,
+$\Psi\psi$, $\Omega\omega$.
+
+Ob nur ein Verzeichnis als unnummeriertes Kapitel erstellt wird, das
+alle Formelzeichen enthält, oder ob ein unnummeriertes Kapitel
+verwendet wird, in dem unterschiedliches Verzeichnisse als
+unnummerierte Abschnitte eingefügt werden, die beispielsweise nach
+\emph{Skalaren}, \emph{Vektoren}, \emph{Tensoren} und \emph{Indizes
+ und Operatoren} aufgeteilt sind, bleibt dem Autoren überlassen.
+Die Formelzeichenverzeichnisse werden in einer 8"=Punkt"=Schrift
+gesetzt, um Platz zu sparen.
+Da hier keine längeren Passagen gelesen werden, ist eine so kleine
+Schriftart ausreichend groß.
+
+% -------------------------------------------------------------------
+\section{Abkürzungsverzeichnis bzw.\ Glossar}%
+\label{sec:abkuerzungsverzeichnis}%
+\index{Abkürzungsverzeichnis|textbf}%
+\index{Glossar|see{Abkürzungsverzeichnis}}%
+
+Abkürzungsverzeichnisse und Glossare werden wie
+Formelzeichenverzeichnisse gesetzt.
+Ein Beispiel:
+\begin{theglossary}[\subsection*{Abkürzungsverzeichnis}]
+ %
+ \item[\acro{GEH}] Gestaltänderungsenergiehypothese
+ %
+ \item[hdp] hexagonal dichtest gepackt
+ %
+ \item[kfz] kubisch flächenzentriert
+ \item[krz] kubisch raumzentriert
+ %
+ \item[\acro{SH}] Schubspannungshypothese
+ %
+\end{theglossary}%
+
+
+% -------------------------------------------------------------------
+\section{Stichwortverzeichnis}%
+\index{Stichwortverzeichnis|textbf}%
+
+Das Stichwortverzeichnis wird zweispaltig in einer
+8"~Punkt"=Schrift gesetzt.
+Die Seitenzahlen, auf denen der jeweilige Begriff auftaucht, werden
+durch ein Komma getrennt direkt an den Begriff angehängt.
+Das genaue Aussehen des Stichwortverzeichnisses kann am besten anhand
+des Verzeichnisses am Ende dieser Anleitung studiert werden.
+
+Einige wichtige Dinge beim Aufbau des Verzeichnisses sollen dennoch
+hier beschrieben werden:
+Es sollen nicht alle Stellen, an denen ein Begriff im Buch vorkommt,
+in das Stichwortverzeichnis aufgenommen werden, sondern nur
+diejenigen, an denen der Begriff eingeführt oder maßgeblich verwendet
+wird.
+Auch wenn der Begriff selbst nur in einer Kapitel"= oder
+Abschnittsüberschrift vorkommt, soll er im Stichwortverzeichnis
+vorkommen, sofern er dort wichtig ist.\footnote{Mir ist einmal ein Buch
+ untergekommen, in dem der Begriff \emph{Schweißen} im
+ Stichwortverzeichnis zwar vorkam, aber nur auf eine Seite verwies,
+ auf der der Begriff zwar stand, aber fast nichts über Schweißen
+ geschrieben wurde.
+ Die Seitenzahl des Kapitels über Schweißen war dafür aber nicht im
+ Stichwortverzeichnis enthalten.
+ So etwas darf nicht vorkommen.}
+Die Seitenzahl für einen besonders wichtigen Eintrag kann fett
+gedruckt werden, z.\,B.
+\begin{quotation}
+ \bsptheindex
+ \begin{theindex}
+ \item Stichwortverzeichnis, \textbf{27}, 34, 35
+ \end{theindex}
+\end{quotation}
+
+Existieren für einen Begriff auch andere Beschreibungen, so sollen
+alle möglichen Wörter, unter denen man diesen Begriff suchen könnte,
+im Stichwortverzeichnis aufgeführt werden.
+Es kann dann ein Verweis auf denjenigen Begriff gesetzt werden, der im
+Dokument verwendet wird, z.\,B.
+\begin{quotation}
+ \bsptheindex
+ \begin{theindex}
+ \item Cosinus, \see{Trigonometrische Funktion}{15}
+
+ \indexspace
+ \item Sinus, \see{Trigonometrische Funktion}{15}
+
+ \indexspace
+ \item Tangens, \see{Trigonometrische Funktion}{15}
+ \item Trigonometrische Funktion, 15
+
+ \indexspace
+ \item Winkelfunktion, 23, \seealso{Trigonometrische Funktion}{15}
+ \end{theindex}
+\end{quotation}
+Seien Sie hier nicht zu sparsam. Es ist nichts ärgerlicher, als einen
+Begriff im Stichwortverzeichnis nicht zu finden, nur weil man einen
+etwas anderen Begriff als der Autor des Buches verwendet!
+Meine eigene Erfahrung ist es, dass man in den meisten Fällen über das
+Stichwortverzeichnis nach Inhalten in einem Buch sucht.
+Daher ist es besonders wichtig, dass ein Buch ein gutes
+Stichwortverzeichnis enthält.
+
+Häufig kommt es vor, dass zu einem Überbegriff einige Unterbegriffe
+existieren.
+Diese Tatsache sollte auch beim Setzen des Stichwortverzeichnisses
+berücksichtigt werden, beispielsweise so:
+\begin{quotation}
+ \bsptheindex
+ \begin{theindex}
+ \item Cosinus, 15
+ \subitem Hyperbolicus, 15
+
+ \indexspace
+ \item Sinus, 15
+
+ \indexspace
+ \item Tangens, 16, \seealso{Trignonometrische Funktion\subind
+ Tangens}{16}\label{ind:bsp1}
+ \item Trigonometrische Funktion, 15, 16
+ \subitem Cosinus, 15
+ \subsubitem Hyperbolicus, 15
+ \subitem Sinus, 15
+ \subitem Tangens, 16
+ \end{theindex}
+\end{quotation}
+Wie im Beispiel zu erkennen, gibt es zwei Stufen für Unterbegriffe.
+Dennoch sollten die Unterbegriffe häufig zusätzlich in der Hauptebene
+aufgenommen werden.
+
+Soll ein Verweis auf einen Unterbegriff vorgenommen werden, so wird
+dieser wie im Beispiel bei "`\seealso{Trignonometrische
+ Funktion\subind Tangens}{16}"' mit einem Gedankenstrich vom
+Hauptbegriff getrennt.
+
+% ===================================================================
+% Dateiende
+
+
+%%% Local Variables:
+%%% mode: latex
+%%% TeX-master: "bgteubner"
+%%% End: