material/Beiträge/INFOS2015/lniguide.tex

271 lines
8.1 KiB
TeX
Raw Normal View History

\documentclass{lni}
\IfFileExists{latin1.sty}{\usepackage{latin1}}{\usepackage{isolatin1}}
\usepackage{graphicx}
\author{Robert Tolksdorf\\\\mail@robert-tolksdorf.de}
\title{Die LNI Dokumentenklasse f<>r \LaTeX}
\begin{document}
\maketitle
\begin{abstract}
Die \LaTeX-Klasse \texttt{lni} setzt die Layout-Vorgaben f<>r Beitr<74>ge
in LNI Konferenzb<7A>nden um. Dieses Dokument beschreibt ihre Verwendung
und ist bei Beispiel f<>r die entsprechende Darstellung.
\end{abstract}
Die GI gibt unter \texttt{http://www.gi-ev.de/LNI} Vorgaben f<>r die
Formatierung von Dokumenten in der LNI Reihe. F<>r \LaTeX-Dokumente
(\cite{IB-A95005}) werden diese durch die Dokumentenklasse
\texttt{lni} realisiert. Dieses Dokument beschreibt die Klasse in der
Version 0.4.
\section{Verwendung}
Die Dokumentenklasse wird wie <20>blich durch Verwendung im
Dokumentenkopf eingebunden:
\begin{verbatim}
\documentclass{lni}
\end{verbatim}
Die Klasse beruht auf der normalen \texttt{article}-Klasse und
verlangt zus<75>tzlich das Vorhandensein der Schriftart Times-Roman und
deren Einbindung <20>ber den Stil \texttt{times} sowie den
\texttt{verbatim}-Styles. Diese sind mit praktisch allen
\LaTeX-Installationen erh<72>ltlich, ebenso sind die entsprechenden
Zeichens<EFBFBD>tze frei erh<72>ltlich.
M<EFBFBD>gliche Dokumentenoptionen sind:
\begin{itemize}
\item \texttt{forInclusion}: Bei der Anlieferung von LNI-formatierten
Beitr<74>gen kann es -- je nach Herstellungsart des Tagungsbands -- zu
Problemen mit der Ausrichtung des Satzspiegels kommen. In diesem
Fall sollte die Option gesetzt werden und das daras entstehenden pdf
angeliefert werden.\footnote{Dank an Matthias Rust
(mrust@rostock.zgdv.de) f<>r den entsprechenden Hinweis und den
Code}
\item \texttt{english}: F<>r Auswahl der Sprache, siehe
Abschnitt~\ref{sprache}.
\end{itemize}
\section{Benutzung}
Die Klasse f<>hrt keine zus<75>tzlichen \LaTeX-Makros ein. Ein LNI-Betrag
sollte sich auf die f<>r die Klasse \texttt{article} definierten Makros
st<EFBFBD>tzen und wo immer m<>glich auf die Standardmakros bauen. Eigene
Makros sollten zus<75>tzlich in externen \texttt{.sty}-Dateien definiert
werden, um das sp<73>tere Zusammenstellen von Beitr<74>gen einer Konferenz
zu erleichtern.
\subsection{Sprache der Dokumente}
\label{sprache}
Die Dokumentenklasse trifft Vorkehrungen f<>r deutsch- und
englischsprachige Dokumente. Dabei ist f<>r den Normalfall deutsch als
Dokumentensprache vorgesehen. Soll ein Dokument komplett in englischer
Sprache gesetzt werden, muss die Dokumentenoption \texttt{english}
verwendet werden.
Zum Umschalten innerhalb des Textes oder am Anfang des Dokuments wird
wie gewohnt mit \verb|\selectlanguage| aus dem Babel-Paket gearbeitet.
Diese Paket l<>dt die \texttt{lni}-Klasse vor -- es braucht also nicht
normals geladen werden.
\texttt{lni} verwendet f<>r die deutsche Sprache die Trennmuster nach
der neuen Rechtschreibung. Das entsprechende Sprachk<68>rzel daf<61>r lautet
\texttt{ngerman} (und nicht \texttt{german}). Falls Ihr \LaTeX\ diese
Trennmuster noch nicht unterst<73>tzt, m<>ssen Sie Ihre System
entsprechend anpassen (siehe \texttt{www.dante.de}).
Um beispielsweise ein Dokument komplett in Englisch zu setzen, sollte
im Dokument mit
\begin{verbatim}
\documentclass[english]{lni}
\end{verbatim}
beginnen. Dadurch werden die Trennmuster und verschiedene feste
Textbestandteile ge<67>ndert (z.B.\ "`Literaturverzeichnis"' in
"`References"').
Die
Eventuell weitere notwendige sprachspezifische Zusatzklassen m<>ssen
allerdins manuell genutzt werden. Dieses Dokument verwendet
beispielsweise:
\begin{verbatim}
\usepackage{latin1}
\end{verbatim}
\subsection{Titelei}
Der Beitragstitel wird wir <20>blich in \verb|\title|
vermerkt. Autorenangaben sind in \verb|\author| definiert. Der Titel
selber wird wie <20>blich durch \verb|\maketitle| gesetzt. Angaben <20>ber
den Autoren (Einrichtung, Mailadm<64>ssen innerhalb von \verb|\author|
vermerkt
Dieses Dokument verwendet folgende Zeilen zum Setzen der
Dokumenteninformationen:
\begin{verbatim}
\author{Robert Tolksdorf\\\\
mail@robert-tolksdorf.de}
\title{Die LNI Dokumentenklasse f<>r \LaTeX}
\begin{document}
\maketitle
\end{verbatim}
\subsection{Textstrukturen}
Verschiedene Parameter f<>r Textstrukturen werden in der
\texttt{lni}-Klasse umdefiniert. Damit diese Einstellung wirksam sind,
m<EFBFBD>ssen die Dokumente teilweise genau die entsprechenden Makros
verwenden.
\subsubsection{Formeln}
Die korrekte Einr<6E>ckung und Numerierung f<>r Formeln ist bei den
Umgebungen \texttt{equation} und \texttt{eqnarray} gew<65>hrleistet.
%\newpage
\begin{verbatim}
\begin{equation}
1=4-3
\end{equation}
\begin{eqnarray}
2=7-5\\
3=2-1
\end{eqnarray}
\end{verbatim}
ergibt
\begin{equation}
1=4-3
\end{equation}
und
\begin{eqnarray}
2=7-5\\
3=2-1
\end{eqnarray}
\subsubsection{Programmausz<EFBFBD>ge}
Die LNI Formatvorlage verlangt die Einr<6E>ckung von Listings vom linken
Rand. In der \texttt{lni}-Klasse ist dies f<>r die
\texttt{verbatim}-Umgebung realisiert.
\subsubsection{Abbildungen}
Abbildungen werden mit den <20>blichen \LaTeX-Mitteln erzeugt. Dabei muss
die Abbildungsunterschrift mit \verb|\caption| nach der Abbildung
eingef<EFBFBD>gt werden und Abbildung und -unterschrift mit der
\texttt{center}-Umgebung umschlossen sein.
\begin{figure}[htb]
\begin{center}
\includegraphics[width=2cm]{gilogo}
\caption{\label{logo}Das Logo der GI}
\end{center}
\end{figure}
F<EFBFBD>r die Positionierung von Abbildungen sollte \verb|[htb]| gew<65>hlt
werden. Abbildung~\ref{logo} zeigt ein Beispiel, das so erzeugt wurde:
\begin{verbatim}
\begin{figure}[htb]
\begin{center}
\includegraphics[width=2cm]{gilogo}
\caption{\label{logo}Das Logo der GI}
\end{center}
\end{figure}
\end{verbatim}
Gleiches gilt bei der Verwendung der \texttt{table}-Umgebung. Bislang
sind keine weiteren Spezialstile f<>r Abbildungen getestet worden
(beispielsweise \texttt{subfigure}).
\subsubsection{Literaturverzeichnis}
Die \texttt{lni}-Klasse definiert automatisch den
\texttt{lnig}-Bibliographiestil, eine separate Deklaration mit
\verb|\bibliographystyle{lni}| ist also <20>berfl<66>ssig, aber auch nicht
sch<EFBFBD>dlich. Wie gewohnt wird das Literaturverzeichnis wir folgt
eingebunden:
\begin{verbatim}
\bibliography{lniguide}
\end{verbatim}
Bei Verwendung der Dokumentenoption \texttt{english} wird der
englischsprachige Bibliographiestil \texttt{lni} verwendet. Bei
eventuell wechselnder Sprachlichkeit im Dokument gilt die Sprachwahl,
die bei Auftreten von \verb|\bibliography| eingestellt ist auch f<>r
das Literaturverzeichnis.
\section{Installation}
\texttt{lni.cls} und \texttt{lni.bst} m<>ssen f<>r Ihr
\TeX-System auffindbar sein. Die Klasse benutzt die Pakete
\texttt{times} und \texttt{verbatim}, die in \LaTeX-Installationen
normalerweise vorhanden und ansonsten beispielsweise <20>ber
\texttt{www.dante.de} kostenfrei erh<72>ltlich sind.
\section{Verarbeitung von Beitr<74>gen in LNI Konferenzb<7A>nden}
Die Klasse \texttt{lni} dient der Auszeichnung von einzelnen Beitr<74>gen
f<EFBFBD>r Workshops, Tagungen etc., die einen LNI-Konferenzband
herausgeben. Die Verarbeitung der einzelnen Beitr<74>ge zu einem
kompletten Band ist Aufgabe der jeweiligen Herausgeber und wird durch
eine weitere Klasse \texttt{lniproc} unterst<73>tzt.
\section{Fragen und Hilfestellung}
Bei auftretenden Fehlern und Erg<72>nzungsw<73>nschen zu der
\texttt{lni}-Klasse wenden Sie sich bitte an den Autoren unter
\texttt{mail@robert-tolksdorf.de}. \emph{Bitte senden Sie nur Anfragen
zu \texttt{lni}-spezifischen Problemen und keine \LaTeX-Fragen
allgemeiner Art.}
\bibliography{lniguide}
\section{<EFBFBD>nderungen von V0.3 auf V0.4}
\begin{itemize}
\item Getrennte Bibliographiestile\texttt{lni.bst} und
\texttt{lnig.bst} und Dokumentenoption \texttt{english}
\end{itemize}
\section{<EFBFBD>nderungen von V0.1 auf V0.3}
\begin{itemize}
\item Option \texttt{forInclusion}
\end{itemize}
\section{<EFBFBD>nderungen von V0.1 auf V0.2}
\begin{itemize}
\item Mehrsprachigkeit durch Einbinden von \texttt{english}
unterst<73>tzt.
\item Neue deutsche Trennmuster \texttt{ngerman} benutzt.
\end{itemize}
\end{document}