summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/dtk/beispiel.tex
blob: fe14cb2428e33ffe19e829f30a0188ef88a04698 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
%%*****************************************************************************
%% $Id: beispiel.tex,v 1.4 2001/10/21 15:17:13 gene Exp $
%%*****************************************************************************
%% Author: Gerd Neugebauer
%%-----------------------------------------------------------------------------
%%
%% Dies ist ein Beispieldokument zu einem Artikel für "`Die TeXnische
%% Kom"odie"'. Dieses soll die Struktur aufzeigen, die solch ein Artikel
%% haben sollte. Au"serdem sind hier die speziellen Makros im Einsatz
%% zu sehen und es werden einige Regeln vermittelt, die es zu beachten
%% gilt.
%%
%% Diese Datei enthält nur den eigentlichen Artikel. Diese Datei kann
%% nicht alleine von LaTeX bearbeitet werden. Hierzu ist der Treiber
%% in der Datei beispiel.ltx notwendig. Die Übersetzung des Beitrags
%% geschieht mit
%%
%%	latex beispiel.ltx
%%
%%-----------------------------------------------------------------------------

%%-----------------------------------------------------------------------------
%% Die ben"otigten Pakete k"onnen hier noch einmal deklariert werden.
%% Diese werden hier gebraucht, da die Pr"aambel sich in der
%% Treiber-Datei befindet, die nicht zur Produktion der
%% Vereinszeitschrift eingesetzt wird.
% \NeedPackage{multicol}
\NeedPackage{booktabs}
%%
%% Das Paket german/ngerman wird automatisch geladen und sollte nicht
%% explizit angefordert werden. 
%%
%% Regel: Es sollten so wenig wie m"oglich zus"atzliche Pakete
%%        angefordert werden, da diese mit anderen Paketen in Konflikt
%%        geraten k"onnten, die in anderen Artikeln unbedingt
%%        ben"otigt werden.
%% Regel: Es sollten nicht unn"otig viele Kommandos oder Umgebungen
%%        definiert werden (aus demselben Grund). N"otigenfalls
%%        sollte die Definition im Artikel und nicht in der Pr"aambel
%%        geschehen. 
%% Regel: Es darf kein spezielles inputencoding verwendet werden. Die
%%        Eingabe muss reines ASCII sein.
%%        Bei Bedarf kann als letzter Schritt die Umwandlung der
%%        Sonderzeichen in pures ASCII erfolgen (z.B. mit recode)
%%

%%-----------------------------------------------------------------------------
%% Angabe des Titels der Arbeit.
\title{Der Titel, der auch so lang sein kann, dass er nicht mehr in die
  Kopfzeile passt}

%%-----------------------------------------------------------------------------
%% Angabe der Autoren. Mehrere Autoren sind durch \and getrennt.
%% Die Vornamen m"oglichst nicht abk"urzen.
\author{A. Utor\and J.E. Mand}

%%-----------------------------------------------------------------------------
%% Angabe der Adressen der Autoren. Jeder Autor ist mit einer eigenen
%% \address-Anweisung vertreten.
%% Das erste Argument enth"alt (Titel und) Vornamen.
%% Das zweite Argument enth"alt die restlichen Namensbestandteile
%% (hiernach wird sortiert).
%% Das dritte Argument enth"at die Adresse. Die Bestandteile der
%% Adresse sind durch \\ voneinander getrennt.
\address{A.}{Utor}{Eine Stra"se 11\\11111 Irgendwo}
\address{J.E.}{Mand}{Weiter Weg 22\\99999 Hinterm Berg}

%%-----------------------------------------------------------------------------
%% Hier wird der Titel gesetzt.
\maketitle

%%-----------------------------------------------------------------------------
%% Die Definition von lokalen Makros und Umgebungen erfolgt hier.
\newcommand{\bs}{\symbol{`\\}}

%%-----------------------------------------------------------------------------
%% Falls der Titel sehr lang ist, muss hier eine kurze Fassung f"ur die
%% Kopfzeile angegeben werden. Ansonsten kann diese Anweisung wegfallen.
\markboth{Der Kurztitel}{Der Kurztitel}

%%-----------------------------------------------------------------------------
\begin{abstract}
  Der Abstract enth"alt eine kurze Zusammenfassung der Problemstellung,
  die in dem Artikel behandelt wird. Hier soll der Leser einen Hinweis
  bekommen, ob der Artikel interessant ist, oder erst sp"ater gelesen
  werden kann.
\end{abstract}

\section{Einleitung}

In der Einleitung sollte das Problem motiviert werden, das in diesem
Artikel behandelt wird. Wir behandeln hier das Vorbereiten von
Artikeln f"ur \DTK. Normalerweise wird das etwas l"anger ausfallen.

\section{Jetzt geht's los}

Es k"onnen alle \LaTeX-Konstrukte verwendet werden, die im
\texttt{article}-Style definiert sind. Dabei sind allerdings einige
Einschr"ankungen zu beachten.

\begin{itemize}
\item Die Abschnitte sind nicht nummeriert. Deshalb macht es keinen
  Unterschied, ob \verb|\section| oder \verb|\section*| verwendet
  wird. Der Einfachheit halber sollte deshalb \verb|\section| benutzt
  werden. Analoges gilt f"ur Unterabschnitte etc.
\item Die Papiergr"o"se ist DIN A5. Das muss ber"ucksichtigt werden, wenn
  Figuren oder Tabellen entworfen werden.
\item Es d"urfen keine globalen Parameter umdefiniert werden, da dies
  andere Artikel st"oren k"onnte. Insbesondere ist die Schriftgr"o"se
  festgelegt.
\item Es sollten keine Randnotizen (\verb|\marginpar|) benutzt werden
  (Es ist einfach kein ausreichender Rand vorhanden).
\end{itemize}

Die Makros in der Tabelle~\ref{tab:logos} stehen zus"atzlich zur
Verf"ugung und sollten an den entsprechenden Stellen auch benutzt
werden.
\begin{table}[t]
  \begin{center}
    \caption{Logos in dtk.cls}\label{tab:logos}

    \begin{tabular}{ll}\toprule
      \emph{Marko}		& \emph{Ergebnis}\\\midrule
      \texttt{\bs AMSLaTeX}	& \AMSLaTeX	\\
      \texttt{\bs AMSTeX}	& \AMSTeX	\\
      \texttt{\bs AMS}		& \AMS		\\
      \texttt{\bs BibTeX}	& \BibTeX	\\
      \texttt{\bs dante}	& \dante	\\
      \texttt{\bs Dante}	& \Dante	\\
      \texttt{\bs DTK}		& \DTK		\\
      \texttt{\bs emTeX}	& \emTeX	\\
      \texttt{\bs eTeX}		& \eTeX		\\
      \texttt{\bs LAmSTeX}	& \LAmSTeX	\\
      \texttt{\bs LaTeXTeX}	& \LaTeXTeX	\\
      \texttt{\bs LaTeXe}	& \LaTeXe	\\
      \texttt{\bs MF}		& \MF		\\
      \texttt{\bs MP}		& \MP		\\
      \texttt{\bs MakeIndex}	& \MakeIndex	\\
      \texttt{\bs NTS}		& \NTS		\\
      \texttt{\bs PS}		& \PS		\\
      \texttt{\bs PiCTeX}	& \PiCTeX	\\
      \texttt{\bs PubliCTeX}	& \PubliCTeX	\\
      \texttt{\bs SliTeX}	& \SliTeX	\\
      \texttt{\bs TeXXeT}	& \TeXXeT	\\
      \texttt{\bs TeXeT}	& \TeXeT	\\\bottomrule
    \end{tabular}
  \end{center}
\end{table}

Beim Setzen von Verzeichnisnamen, E-Mail-Adressen, URLs und "ahnlichem
tritt oft das Problem auf, dass diese nicht getrennt werden k"onnen,
wenn sie in \verb|\texttt| gesetzt sind. Zu diesem Zweck wurde von
dieser Klasse das Makro \verb|\Path| bereitgestellt, das sein Argument
in der Nichtproportionalschrift setzt und die Trennung an gewissen
Stellen erlaubt. Damit ist es dann m"oglich, auch lange URLs wie die
folgende zu setzen:
\Path{http://www.gerd-neugebauer.de/software/TeX/}.

Bei dieser Gelegenheit sind die Tilde \verb|~| und der Unterstrich
\verb|_| keine aktiven Zeichen mehr und k"onnen damit direkt
eingegeben werden.

Leider ist \verb|\Path| fragil. Das hei"st, dass es in Argumenten von
anderen Makros unerwartete Resultate liefern kann und somit dort nicht
gebraucht werden sollte.


\section{Tabellen}

\begin{enumerate}
\item Tabellen sollten normalerweise als Floats ausgef"uhrt werden.
  Damit ist es f"ur \LaTeX{} m"oglich, einen geeigneten Ort f"ur deren
  Plazierung zu finden. In der Regel sollte als Plazierungsargument
  \verb|[tp]| angegeben werden.
\item Tabellen sollten eine Unterschrift (\verb|\caption|) tragen und
  "uber eine Referenz im laufenden Text verankert werden.
\item Auf "uberfl"ussigen Schmuck, wie Rahmen und Linien sollte
  verzichtet werden. Meistens kann man "uber angemessene Formatierung
  bessere Ergebnisse erreichen als durch zus"atzliche Linien.
\item Die mit \verb|\label| vergebenen Namen sind lokal f"ur jeden
  Artikel. Hier braucht keine R"ucksicht auf andere Artikel genommen zu
  werden. 
\end{enumerate}

Ein Beispiel ist in der Tabelle~\ref{tab:logos} zu sehen.


\section{Goldene Regeln}

In diesem Abschnitt werden Regeln f"ur den Satz deutscher Texte
gesammelt. Diese sind von allgemeinerem Interesse. Die Erfahrung hat
gezeigt, dass diese Regeln trotzdem nicht allgemein bekannt sind, oder
angewendet werden.

\begin{enumerate}
\item Es gilt die deutsche Rechtschreibung, wie sie im Duden
  festgelegt ist! Seit der Ausgabe 1/2000 wird die 21. Auf\/lage des
  Duden zu Grunde gelegt.
\item Die Satzzeichen Punkt, Komma, Semikolon, Ausrufezeichen und
  Fragezeichen folgen ohne Zwischenraum auf das davorstehende Wort.
\item Bei Abk"urzungen folgt nach einem inneren Punkt ein kleiner
  Zwischenraum:
  z.\,B. wird als \verb|z.\,B.| eingegeben.

  Am Anfang eines Satzes werden Abk"urzungen ausgeschrieben. Im
  Allgemeinen ist es ratsam, Abkürzungen nur sehr sparsam einzusetzen.
  So kann man "`z.\,B."' immer durch "`beispielsweise"' ersetzen.
\item Hervorhebungen erfolgen mit \verb|\emph|. \verb|\textbf| ist f"ur
  Hervorhebungen \emph{nicht}\/ zu\-l"assig!
\item Die Gedankenstriche -- werden als \verb|--| eingegeben. Davor
  und danach ist ein Leerraum zu lassen.
\item Ein Bereich von Zahlen wird mit \verb|--| gebildet. Hierbei sind
  davor und danach \emph{keine}\/ Leerzeichen einzuf"ugen:
  21--34
\item Bindestriche zwischen Worten werden mit \verb|-| eingegeben.
  Davor und danach sind keine Leerzeichen zul"assig.
\end{enumerate}


\section{Literatur}

Literatur sollte mit \BibTeX{} verwaltet werden.

\begin{itemize}
\item Es git einen speziellen \BibTeX-Style \texttt{dtk.bst}, der mit
  der Klasse \verb|dtk.cls| verteilt wird. Dieser sollte verwendet
  werden. 
\item Die Literatur muss in einer \BibTeX-Datei gesammelt sein. Diese
  muss denselben Basisnamen haben wie das eigentliche Dokument. 
\item Alternativ kann die Literatur in dem Dokument direkt angegeben
  werden. In diesem Fall k"onnen die Beipiele am Ende dieses Dokuments
  oder in der Zeitschrift "`\DTK"' "ur das Aussehen dienen. Davon wird
  allerdings dringend abgeraten.
\end{itemize}

An dieser Stelle kommen einige Beispiele f"ur Literaturzitate.  Eine
Kurzbeschreibung der Klasse und deren Entstehung wurde in
\cite{neugebauer:klasse} ver"offentlicht.

Angefangen hat alles mit einigen B"uchern von Donald Knuth
\cite{knuth:texbook,knuth:mfbook}. Der Klassiker zu \LaTeX{} stammt
von Leslie Lamport \cite{lamport:latex.2}. Neuerdings gibt es den
"`Companion"' \cite{companion}. Schlie"slich sollen auch noch B"ucher auf
Deutsch nicht verschwiegen werden \cite{kopka:latex,kopka:latex2}.

Schlie"slich muss auch noch die \TeX-Directory-Structure
\cite{twg:tds} erw"ahnt werden, da das ein Beipiel f"ur eine Referenz
ins CTAN enth"alt.


\section{Zusammenfassung}

Hier sollte noch einmal ein Resum\'e gezogen werden. Auch ein Ausblick
oder eine Diskussion von offenen Problemen kann hier erfolgen.

Eine letzte Bitte sei hier noch angebracht. Das Dokument, das zur
Ver"offentlichung f"ur "`\DTK"' eingereicht wird, sollte m"oglichst
ohne Fehler durch \LaTeX{} bearbeitet werden k"onnen. Dazu z"ahlen
auch "`l"a"sliche S"unden"' wie overfull/underfull Boxes.

\bibliography{beispiel}

\endinput%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%
% Local Variables: 
% mode: latex
% TeX-master: "beispiel.ltx"
% End: