diff options
Diffstat (limited to 'Master/texmf-dist/doc/latex/bgteubner/textelemente.tex')
-rw-r--r-- | Master/texmf-dist/doc/latex/bgteubner/textelemente.tex | 393 |
1 files changed, 393 insertions, 0 deletions
diff --git a/Master/texmf-dist/doc/latex/bgteubner/textelemente.tex b/Master/texmf-dist/doc/latex/bgteubner/textelemente.tex new file mode 100644 index 00000000000..0f57587d050 --- /dev/null +++ b/Master/texmf-dist/doc/latex/bgteubner/textelemente.tex @@ -0,0 +1,393 @@ +% +% bgteubner class bundle +% +% textelemente.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{Weitere Textelemente}% +\label{sec:textelemente}% +\index{Textelement}% + +In diesem Kapitel werden einige Textelemente, wie z.\,B. Beispiele, +Aufgaben oder Anmerkungen, besprochen. + +% ------------------------------------------------------------------- +\section{Aufzählungen}% +\label{sec:aufzaehlungen}% +\index{Aufzählung} + +Aufzählungen können sowohl nummeriert als auch unnummeriert vorliegen. +Allgemein werden sie eingerückt und können geschachtelt auftreten. +Es sollte jedoch darauf geachtet werden, die Verschachtelungstiefe +nicht zu groß werden zu lassen. + +Je nachdem, wie lang die einzelnen Punkte der Aufzählungen sind, +können die vertikalen Abstände unterschiedlich gewählt werden. +Für sehr lange Einträge bietet es sich an, sowohl am Beginn der Liste +als auch zwischen den einzelnen Punkten einen vertikalen Zwischenraum +einzufügen, wie es das folgende Beispiel zeigt: +\begin{itemize} +\item Hier wird vor dem ersten Eintrag, zwischen den Einträgen und + nach dem letzten Eintrag ein vertikaler Zwischenraum eingefügt. +\item Bei kurzen Einträgen wirkt der Text durch die Zwischenräume + löchrig. +\end{itemize} + +Sind die Einträge kürzer, so bietet es sich an, nur vor und nach der +Aufzählung einen Zwischenraum einzufügen, zwischen diesen aber nur +einen normalen Zeilenabstand: +\begin{itemize*} +\item Vor dem ersten Aufzählungspunkt ist ein Zwischenraum, +\item zwischen den Einträgen nicht, und +\item nach dem letzten Eintrag ist wieder Zwischenraum eingefügt. +\end{itemize*} + +Sind die Einträge sehr kurz und vielleicht in einen Satz eingebettet, +der über die Aufzählung hinausgeht, so sollte weder +\begin{compactitem} +\item vor noch +\item zwischen noch +\item nach +\end{compactitem} +den einzelnen Punkten ein Zwischenraum eingefügt werden. + +Wie bei abgesetzten Formeln ist bei Aufzählungen darauf zu achten, ob +für den folgenden Text ein neuer Absatz begonnen werden soll oder +nicht. +Bei den beiden ersten Aufzählungen in diesem Abschnitt ist dies der +Fall, bei der dritten nicht. + +Das folgende Beispiel zeigt die Kennzeichnung der Punkte in einer +nummerierten Aufzählung: +\begin{compactenum} +\item Die erste Ebene wird mit arabischen Zahlen nummeriert. + \begin{compactenum} + \item In der zweiten Ebene werden Kleinbuchstaben verwendet. + \begin{compactenum} + \item Die dritte Ebene wird mit kleinen römischen Zahlen gekennzeichnet. + \end{compactenum} + \end{compactenum} +\end{compactenum} + +Für eine unnummerierte Aufzählung werden folgende Zeichen verwendet: +\begin{compactitem} +\item Die erste Ebene erhält einen großen Punkt. + \begin{compactitem} + \item Für die zweite Ebene werden Spiegelstriche verwendet. + \begin{compactitem} + \item Die dritte Ebene wird mit Sternen gekennzeichnet. + \end{compactitem} + \end{compactitem} +\end{compactitem} + +% ------------------------------------------------------------------- +\section{Beispiele}% +\label{sec:beispiele}% +\index{Beispiel}% + +Es sind zwei Möglichkeiten zum Setzen von Beispielen vorgesehen: +Entweder werden Beispiele ohne typographische Kennzeichnung im +Fließtext gesetzt. +Dann muss jedoch darauf geachtet werden, dass der Anfang und das Ende +des Beispiels aus dem Text eindeutig ersichtlich sind. +Die zweite Möglichkeit, Beispiele zu kennzeichnen, besteht darin, sie +optisch vom Fließtext abzusetzen. +Dazu wird eine Überschrift gesetzt, die mit dem Wort "`Beispiel"' +beginnt. +Es können optional eine Beispielnummer und ein Titel folgen, +wie im folgenden Beispiel illustriert: +\begin{example}[Ein Beispielbeispiel] + \label{bsp:beispiel1}% + Ein Beispiel wird links und rechts eingerückt. + Im Gegensatz zu alten Versionen der Dokumentklasse werden Beispiele + per Default in normaler Schriftgröße und mit normalem Zeilenabstand + gesetzt. + Dies kann jedoch umgeschaltet werden (vgl.\ + Abschnitt~\ref{sec:tex:aufbau}). +\end{example} +Das folgende Beispiel zeigt, wie Beispiele mit kleiner Schriftgröße +aussehen. +\begingroup + \makeatletter + \def\theoremfont{\small}% + \ifhhcls@times + \def\theoremspacing{1.12}% + \else + \def\theoremspacing{1.06}% + \fi + \makeatother + \begin{example}[Kleine Schrift] + Mit der Schriftgröße 9~Punkt sieht das Beispiel so aus. + Wegen der kleinen Schrift wird der (relative) Zeilenabstand etwas + erhöht, um die Lesbarkeit zu gewährleisten. + \end{example} +\endgroup +Beide Setzarten haben Vor- und Nachteile. +Zum einen suggeriert die kleinere Schrift (unter Umständen ungewollt), +dass der Inhalt der entsprechenden Umgebung unwichtig sei. +Andererseits kann es bei normalgroßer Schrift passieren, dass der +Leser bei langen Beispielen mit Seitenumbruch nicht merkt, dass er +noch innerhalb des Beispiels ist. + +Auf nummerierte Beispiele kann dann eine Referenz gesetzt werden +(vgl.\ Beispiel~\ref{bsp:beispiel1}). + +Ein nicht nummeriertes Beispiel sieht so aus: +\begin{example*}[Noch ein Beispielbeispiel] + Auf ein nicht nummeriertes Beispiel kann natürlich, außer über die + Seitenzahl, nicht im Text verwiesen werden. +\end{example*} + +Die Nummerierung eines Beispiels besteht aus der Kapitelnummer und der +Nummer des Beispiels innerhalb des aktuellen Kapitels. +Im nächsten Kapitel wird die Zählung erneut bei 1 begonnen. + +% ------------------------------------------------------------------- +\section{Sätze, Lemmata, Definitionen usw.}% +\index{Anmerkung}% +\index{Satz}% +\index{Lemma}% + +Außer Beispielen gibt es noch einige weitere Dinge, die durch +abgesetzte Formatierung hervorgehoben werden können. +Dazu zählen Sätze, Lemmata, Definitionen usw. +Sie werden wie Beispiele gesetzt, nur natürlich mit den entsprechenden +Überschriften. +Eine eventuelle Nummerierung erfolgt getrennt nach den einzelnen +Typen. + +Häufig möchte man dem Leser weiterführende Informationen geben, die +nicht unbedingt zum Verständnis des Buches notwendig sind. +Hier kann es zweckmäßig sein, diese in einer kleineren Schrift +($\np[pt]{8}$) zu setzen und links und rechts einzurücken, um sie vom +übrigen Text abzuheben. +\begin{advanced} + Durch diese Auszeichnung + wird dem Leser suggeriert, dass dieser Text unter Umständen nicht + ganz so wichtig ist. + Deshalb sollte diese Variante auch nur dann verwendet werden, wenn + der in der Anmerkung enthaltene Text nicht unbedingt für das + Verständnis des Buches notwendig ist. + + Wenn man diese Formatierungsart verwendet, ist es zwingend + notwendig, dass der Leser im Vorwort oder in der Einleitung darauf + hingewiesen wird, dass die so gesetzten Bereiche Ergänzungen bzw.\ + Anmerkungen sind, die für das Verständnis des Buches nicht unbedingt + notwendig sind. +\end{advanced} + +Wenn man diese Art der Auszeichnung verwendet, muss dringend darauf +geachtet werden, dass sich der Text sowohl dann sinnvoll und flüssig +liest, wenn man die Anmerkung mitliest, als auch dann, wenn man sie +auslässt. + +Manche Autoren möchten besonders wichtige Gleichungen und Textpassagen +durch einen grauen Hintergrund hervorheben. +Auch dies ist möglich. +\begin{example} + \label{bsp:important}% + Wenn man sich ständig Textbeispiele ausdenken muss, gehen einem + irgendwann die Ideen aus. + % + \begin{important} + Das ist nicht besonders angenehm. + \begin{align*} + \sin^2\alpha + \cos^2\alpha &= 1\,.\quad\text{(eine beliebige Formel)} + \end{align*}% + \end{important} + % + Da dieser Satz inhaltlich dazu gehört, ist er ohne Absatzeinzug + gesetzt. + % + \begin{important*} + \begin{align*} + \sin^2\alpha + \cos^2\alpha &= 1\,.\quad\text{(eine beliebige Formel)} + \end{align*} + Es muss inhaltlich entschieden werden, ob ein Absatz folgt oder + nicht.\footnote{Warum hier zwei graue Kästen gezeigt werden, eine + mit Text am Anfang, die andere mit einer abgesetzten Gleichung + am Anfang, wird in Abschnitt~\ref{sec:tex:important} deutlich.} + \end{important*} + + Da dieser Satz nichts mit dem Rest zu tun hat, beginnt mit ihm ein + neuer Absatz. + Das ist am Absatzeinzug zu erkennen. +\end{example} + +Diese grau hinterlegten Boxen sollten kurz gehalten werden, da in +ihnen normalerweise kein Seitenumbruch auftreten soll. + +% ------------------------------------------------------------------- +\section{Aufgaben und Lösungen}% +\label{sec:aufgaben}% +\index{Aufgabe}% +\index{Lösung}% + +Für Lehrbücher ist es sinnvoll, im Buch Aufgaben zu stellen, für die +direkt danach oder an anderer Stelle Lösungen vorhanden sind. +Es ist dabei möglich, eine globale Aufgabensammlung am Ende des Buches zu +erstellen oder Aufgabensammlungen am Ende jeden Kapitels zu erstellen. +Sie sollten sich für eine der beiden Varianten entscheiden. + +% ------------------------------------------------------------------- +\subsection{Globale Aufgabensammlung}% +\label{sec:aufgabensammlung_global}% +\index{Aufgabensammlung!global}% + +Eine globale Aufgabensammlung kann zweckmäßigerweise zwischen dem +Textteil und dem Anhang des Buches gesetzt werden. +Dabei ist es denkbar, einen Teil mit dem Titel "`Übungsteil"' +einzurichten, in dem dann zwei Kapitel enthalten sind, nämlich +"`Aufgaben"' und "`Lösungen"'. +Eine andere Möglichkeit besteht darin, einfach als letztes Kapitel das +Kapitel "`Aufgaben"' zu setzen und dann am Ende des Anhangs das +Kapitel "`Lösungen"'. +Schließlich ist es auch denkbar, nur ein Kapitel "`Aufgaben"' zu +definieren, in dem die Lösungen jeweils direkt auf die entsprechenden +Aufgaben folgen. +Auf jeden Fall sollte am Beginn des Kapitels "`Aufgaben"' darauf +verwiesen werden, an welcher Stelle die Lösungen gefunden werden +können. + +Für eine globale Aufgabensammlung ist es sinnvoll, die Aufgaben +zu nummerieren, wie es in folgendem Beispiel getan wird: +\begin{exercise}{Buch erstellen} + \label{auf:beispiel1}% + Erstellen Sie ein Buch zur Veröffentlichung im Teubner Verlag! + Dabei sind die Autorenrichtlinien, die sie gerade lesen, zu + beachten. +\end{exercise} +\bigskip + +Da diese Art der Formatierung dafür gedacht ist, dass nur Aufgaben und +Lösungen aufeinander folgen und kein normaler Text eingemischt ist +(was an dieser Stelle demnach falsch gemacht wird\footnote{Daher wurde + hier nach der Aufgabe ein Abschnittsabstand manuell eingefügt.}), +ist keine Textauszeichnung durch Einrückungen o.\,ä.\ notwendig. +Die Überschrift der Aufgabe entspricht Abschnittsüberschriften, ein +Titel ist obligatorisch.\footnote{Wer partout keinen Titel haben + möchte, kann ihn auch leer definieren. + Allerdings ist es dann nicht sinnvoll, die Aufgaben ins + Inhaltsverzeichnis aufzunehmen oder ein Verzeichnis der Aufgaben zu + erstellen.} + +Wenn die entsprechende Lösung direkt auf die Aufgabe folgt, kann eine +Nummerierung der Aufgaben auch entfallen, wie im folgenden Beispiel: +\begin{exercise*}{Stichwortverzeichnis} + Erstellen Sie für Ihr Buch ein Stichwortverzeichnis! + Achten Sie darauf, dass es sinnvoll und nicht zu kurz wird! +\end{exercise*} +\bigskip + +Lösungen werden mit einem kleineren Schriftgrad gesetzt, um Platz zu +sparen. +Unnummerierte Lösungen können (wie hier gezeigt), müssen jedoch nicht, +einen Titel erhalten: +\begin{answer*}[Stichwortverzeichnis] + Die Lösung der Aufgabe kann ich Ihnen leider nicht abnehmen. + Lesen Sie aber auf jeden Fall Abschnitt~\ref{sec:tex_index} + aufmerksam durch. +\end{answer*} +\bigskip + +Eine unnummerierte Lösung muss direkt auf die entsprechende Aufgabe +folgen, da sonst eine Zuordnung nicht möglich ist. + +Für nummierierte Lösungen gilt das selbe (hier ohne Titel): +\begin{answer}{auf:beispiel1} + Die Lösung zu dieser Aufgabe ist, wie Sie sicherlich schon gemerkt + haben, mit großem Aufwand verbunden. + Bei der Erstellung dieser Autorenrichtlinien merke auch ich dies + aufs Neue. +\end{answer} +\bigskip + +Bei allen in diesem Abschnitt gezeigten Beispielen besteht das +Problem, dass der Übergang von Aufgabe bzw.\ Lösung zu normalem Text +schwierig zu finden ist. +Aus diesem Grund sind so formatierte Aufgaben auch nur in Aufgaben"= +und Lösungssammlungen zu verwenden, in denen auf eine Aufgabe nur eine +weitere Aufgabe oder eine Lösung folgen kann. + +% ------------------------------------------------------------------- +\subsection{Aufgaben am Ende jeden Kapitels}% +\index{Aufgabensammlung!kapitelweise}% + +Soll am Ende jeden Kapitels eine Aufgabensammlung erstellt werden, so +besteht die Aufgabennummer aus der Kapitelnummer und der +Aufgabennummer. +Die Aufgabensammlung kann in einem eigenen Abschnitt, +beispielsweise "`Aufgaben"', zusammengefasst werden. + +Einige Beispiele: +\begin{subexercise}{Buch erstellen} + \label{auf:beispiel2}% + Erstellen Sie ein Buch zur Veröffentlichung im Teubner Verlag! + Dabei sind die Autorenrichtlinien, die sie gerade lesen, zu + beachten. +\end{subexercise} +\begin{subanswer}{auf:beispiel2} + Die Lösung zu dieser Aufgabe ist, wie Sie sicherlich schon gemerkt + haben, mit großem Aufwand verbunden. + Bei der Erstellung dieser Autorenrichtlinien merke auch ich dies + aufs Neue. +\end{subanswer} +\begin{subexercise*}{Stichwortverzeichnis} + Erstellen Sie für Ihr Buch ein Stichwortverzeichnis! + Achten Sie darauf, dass es sinnvoll und nicht zu kurz wird! +\end{subexercise*} +\begin{subanswer*}[Stichwortverzeichnis] + Die Lösung der Aufgabe kann ich Ihnen leider nicht abnehmen. + Lesen Sie aber auf jeden Fall Abschnitt~\ref{sec:tex_index} + aufmerksam durch. +\end{subanswer*} + + +% ------------------------------------------------------------------- +\subsection{Teilaufgaben}% +\index{Aufgabe!Teil-}% + +Häufig ist es zweckmäßig, innerhalb einer Aufgabe Teilaufgaben zu +definieren. +Diese werden mit Buchstaben, gefolgt von einer Klammer, bezeichnet, +wie im folgenden Beispiel: +\begin{subexercise*}{Mal wieder Buch erstellen} + \label{auf:teilaufgaben}% + Zur Erstellung eines Buches sollen folgende Dinge erledigt werden: + \begin{subtask} + \item Recherchieren Sie gründlich! + \item Schreiben Sie den Text, ohne auf Formatierungen zu achten! + \end{subtask} + Wenn der inhaltliche Teil fertig ist, geht es an die optischen + Dinge: + \begin{subtask} + \item Formatieren Sie den Text! + \item Erstellen Sie die Verzeichnisse (Formelverzeichnis, + Abkürzungsverzeichnis, Literaturverzeichnis, + Stichwortverzeichnis)! + \end{subtask} +\end{subexercise*} + +Wie im Beispiel zu sehen, werden die Teilaufgaben innerhalb einer +Aufgabe fortlaufend nummeriert, auch wenn Text zur Erläuterung +eingefügt ist. +Bei jeder Aufgabe beginnt die Nummerierung bei a). + + +% =================================================================== + +%%% Local Variables: +%%% mode: latex +%%% TeX-master: "richtlinien" +%%% End: |