%------------------------------------------------------------------------------ % Das Dokument ist ein Artikel in der Schriftgr"o"se 12 Punkt \documentclass[12pt]{article} %------------------------------------------------------------------------------ % Die folgenden Pakete definieren zus"atzliche Befehle und Umgebungen \usepackage{epsfig} % Einbinden von EPS-Dateien \usepackage{german} % Sprachanpassung f"ur Deutsch \usepackage{fancyheadings} % Definition von eigenen Kopf- und Fu"szeilen %------------------------------------------------------------------------------ % Hier bitte keine Fragen stellen \voffset-1in \hoffset-1in \renewcommand{\topfraction}{1} \renewcommand{\bottomfraction}{1} \renewcommand{\topfraction}{1} \renewcommand{\textfraction}{0} \renewcommand{\floatpagefraction}{1} \frenchspacing \sloppy \newenvironment{compactitem}% {\begin{list}{$\bullet$}% {\setlength{\topsep}{0pt}% \setlength{\leftmargin}{18pt}% \setlength{\parsep}{0pt}% \setlength{\itemsep}{0pt}% } } {\end{list}} \newcounter{compenumcount} \newenvironment{compactenum}% {\begin{list}{\arabic{compenumcount}.}{\usecounter{compenumcount}% \setlength{\topsep}{0pt}% \setlength{\leftmargin}{18pt}% \setlength{\parsep}{0pt}% \setlength{\itemsep}{0pt}% } } {\end{list}} %------------------------------------------------------------------------------ % Abst"ande und R"ander definieren \topmargin20mm % Abstand der Kopfzeile vom oberen Seitenrand \headheight5mm % H"ohe der Kopfzeile \headsep5mm % Abstand der Kopfzeile vom Text \footskip1.5cm % Der Abstand vom unteren Rand des Textes bis zum % Grundlinie der Fu"szeile \oddsidemargin30mm % linker Seitenrand \textheight235mm % Texth"ohe \textwidth150mm % Textbreite \parindent12pt % Abs"atze nicht einr"ucken \parskip0mm % keinen Zwischenraum zwischen Abs"atzen \renewcommand{\baselinestretch}{0.95} % Zeilenabstand einfach %------------------------------------------------------------------------------ % Schriftarten f"ur die "Uberschriften festlegen \newcommand{\HeadingOneFont}{\fontsize{14}{14}\bf\rmfamily} \newcommand{\HeadingTwoFont}{\fontsize{12}{12}\bf\rmfamily} \newcommand{\HeadingThreeFont}{\fontsize{12}{12}\it\rmfamily} \newcommand{\TitleFontOne}{\fontsize{20}{20}\rmfamily} \newcommand{\TitleFontTwo}{\fontsize{16}{16}\bf\rmfamily} \newcommand{\TitleFontThree}{\fontsize{14}{14}\bf\rmfamily} %------------------------------------------------------------------------------ % Neue "Uberschriftenformate definieren \makeatletter \renewcommand{\section}{\@startsection{section}{1}{0mm} {12pt}{3pt}{\HeadingOneFont}}% \renewcommand{\subsection}{\@startsection {subsection}{2}{0mm} {6pt}{3pt}{\HeadingTwoFont}}% \renewcommand{\subsubsection}{\@startsection{subsubsection}{2}{0mm} {6pt}{3pt}{\HeadingThreeFont}}% \makeatother %------------------------------------------------------------------------------ % Hier werden die Inhalte der Kopf- und Fu"szeilen definiert \pagestyle{fancy} % Seitenstil festlegen % Kopfzeile \lhead{Formatvorgaben f"ur die Ausarbeitung im Proseminar} % links \chead{} % Mitte \rhead{Dirk J"ager} % rechts % Fu"szeile \lfoot{} % links \cfoot{\thepage} % Mitte \rfoot{} % rechts %---------------------------------------------------------------------------- %---------------------------------------------------------------------------- % Hier f"angt jetzt der Text an \begin{document} %---------------------------------------------------------------------------- % Titelseite \thispagestyle{empty} \begin{center} \rule{0mm}{1mm} \\ \vspace{50mm} {\TitleFontThree Proseminar} \\ \vspace{12pt} {\TitleFontTwo Objektorientierte Softwareentwicklung in Eiffel} \\ \vspace{10mm} {\TitleFontThree Lehrstuhl f"ur Informatik III} \\ \vspace{6pt} {\TitleFontThree RWTH Aachen} \\ \vspace{6pt} {\TitleFontThree Sommersemester 2003} \\ \vspace{20mm} {\TitleFontOne Formatvorgaben f"ur die Ausarbeitung im Proseminar} \\ \vspace{10mm} {\TitleFontThree Dirk J"ager} \\ \end{center} %---------------------------------------------------------------------------- % Inhaltsverzeichnis \newpage \pagenumbering{roman} % Seitenzahl auf eins setzen und als kleine % r"omische Ziffern anzeigen \tableofcontents % Inhaltsverzeichnis ausgeben %---------------------------------------------------------------------------- % Ab jetzt kommen die Flie"stextseiten \newpage % neue Seite anfangen \pagenumbering{arabic} % Seitenzahl auf eins setzen und als kleine % arabische Ziffern anzeigen \section{Allgemeines} Dieses Dokument beschreibt die Formatvorgaben, die bei der Erstellung der Proseminarausarbeitung einzuhalten sind. Der Text h"alt sich selber an die Richtlinien, die er beschreibt, er kann daher als Vorlage f"ur die eigene Ausarbeitung verwendet werden. Dieser Text ist mit dem frei verf"ugbaren Textverarbeitungssystem \LaTeX{} erstellt worden. Die Ausarbeitung ist in jedem Fall mit einem Textverarbeitungssystem zu erstellen. Die Wahl des Systems ist freigestellt, solange die Formatvorgaben eingehalten werden. Es empfiehlt sich aber, entweder MS-Word oder \LaTeX{} zu verwenden. Falls jemand keinen eigenen Rechner hat, wird ihm f"ur die Dauer des Proseminars eine Kennung auf den Rechnern des Lehrstuhls zur Verf"ugung gestellt. Der Sinn dieser Formatierungsrichtlinien besteht darin, die Lesbarkeit der Texte zu erh"ohen und den Teilnehmern des Proseminars eine sinnvolle Formatierung an die Hand zu geben, die sich weitgehend an die g"ultigen Standards f"ur wissenschaftliche Ausarbeitungen in der Informatik h"alt. Insbesondere ist \LaTeX{} in der Informatik sehr verbreitet, so da"s sich einige der aufgef"uhrten Richtlinien an dem orientieren, was bei diesem System als Voreinstellung mitgeliefert wird. Es ist aber kein Problem, in anderen Textverarbeitungen diese Formatierungen nachzuvollziehen. Alle Gr"o"sen sind entweder in Zentimetern (cm) oder in Punkten (pt) angegeben. Ein Punkt ist die "ubliche Ma"seinheit f"ur die Festlegung von Schriftgr"o"sen und Abst"anden in Texten. Ein Punkt entspricht 0,351 mm. \section{Umfang der Ausarbeitung} Der geforderte Umfang der Ausarbeitung bezieht sich immer auf den reinen Text, einschlie"slich der "Uberschriften. Sind z.B. zwanzig Seiten Ausarbeitung gefordert, so z"ahlen Abbildungen ebenso wie die Titelseite, das Inhaltsverzeichnis und das Literaturverzeichnis nicht zu den zwanzig Seiten. Abbildungen kommen grunds"atzlich auf gesonderte Seiten am Ende. \section{Layout der Seiten} \label{layout} Das Format der Seiten ist DIN A4. Die Textseiten haben oben, unten, links und rechts jeweils einen Rand von 3 cm. Die Kopfzeile der Seite befindet sich 2 cm vom oberen Rand der Seite entfernt. In der Kopfzeile steht links der Titel des Proseminarbeitrags und rechts der Name des Proseminarteilnehmers bzw. die Namen der Proseminarteilnehmer. Die Fu"szeile der Seite ist 2 cm vom unteren Seitenrand entfernt. In der Fu"szeile steht zentriert die Seitennummer. Die Titelseite hat keine Seitennummer. Die Seiten des Inhaltsverzeichnisses werden mit kleinen r"omischen Ziffern numeriert, beginnend mit eins\footnote{ Bei der in Proseminaren "ublichen L"ange einer Ausarbeitung ist zu erwarten, da"s das Inhaltsverzeichnis nur eine Seite umfa"st.}. Ab der ersten Textseite werden die Seiten mit arabischen Ziffern numeriert. Die Z"ahlung beginnt hier wieder mit eins! Das Literaturverzeichnis kann unmittelbar an das Ende des letzten Textabschnitts angeh"angt werden, es mu"s also keine neue Seite begonnen werden. \section{Gliederungsebenen} Bei der Gliederung der Ausarbeitung k"onnen maximal drei Gliederungsebenen verwendet werden. Alle Gliederungsebenen sind im Inhaltsverzeichnis aufzuf"uhren. Die "Uberschriften der Textabschnitte werden numeriert. Die "Uberschriften des Inhaltsverzeichnisses und das Literaturverzeichnisses werden zwar wie eine "Uberschrift der ersten Stufe formatiert, aber nicht numeriert. \section{"Uberschriften der ersten Stufe} Diese "Uberschrift ist in 14 pt fett formatiert, der Abstand zum vorherigen Text betr"agt 12 pt, der Abstand zum nachfolgenden Text betr"agt 3 pt. \subsection{"Uberschriften der zweiten Stufe} Diese "Uberschrift ist in 12 pt fett formatiert, der Abstand zum vorherigen Text betr"agt 6 pt, der Abstand zum nachfolgenden Text betr"agt 3 pt. \subsubsection{"Uberschriften der dritten Stufe} Diese "Uberschrift ist in 12 pt kursiv formatiert, der Abstand zum vorherigen Text betr"agt 6 pt, der Abstand zum nachfolgenden Text betr"agt 3 pt. \section{Textformatierung} Der Text ist einspaltig in Blocksatz zu formatieren. Der Zeilenabstand ist einzeilig. Zwischen zwei Abs"atzen wird {\it kein} Zwischenraum eingef"ugt. Die erste Zeile eines neuen Absatzes wird um 12 pt einger"uckt. \subsection{Schriftarten und Schriftgr"o"sen} \label{Schrift} In der gesamten Ausarbeitung wird f"ur den Flie"stext ausschlie"slich die Schriftart {\it Times New Roman} verwendet, bzw. in \LaTeX{} die voreingestellte Schriftart {\it Computer Modern Roman}. Tabelle \ref{SchriftTabelle} gibt an, welche Schriftgr"o"sen f"ur die einzelnen Elemente der Ausarbeitung zu w"ahlen sind. \begin{table}[p] \begin{center} \begin{tabular}{|l|l|} \hline Flie"stext & 12 pt normal \\ \hline "Uberschrift 1. Ebene & 16 pt fett \\ \hline "Uberschrift 2. Ebene & 14 pt fett \\ \hline "Uberschrift 3. Ebene & 12 pt fett \\ \hline Inhaltsverzeichnis & 12 pt normal \\ \hline Fu"snoten & 10 pt normal \\ \hline Text in Tabellen & 10 pt oder 12 pt \\ \hline \end{tabular} \caption{Schriftgr"o"sen} \label{SchriftTabelle} \end{center} \end{table} \subsection{Die Titelseite} Die Titelseite der Ausarbeitung ist entsprechend der Titelseite dieses Dokumentes zu gestalten. Der Name des Proseminars und der Name des Autors sind in 14 pt fett, das Thema der Ausarbeitung ist in 20 pt normal zu setzen. Der Rest der Seite wird in 12 pt fett gesetzt. \subsection{Hervorhebungen im Text} \label{Hervorhebungen} Textstellen, die besonders hervorgehoben werden sollen, k"onnen in {\it kursiver Schrift} gesetzt werden. Wenn innerhalb des Textes Namen von Variablen, Schl"usselw"orter von Programmiersprachen, Namen von Dateien o."a. verwendet werden, sind diese in der Schriftart {\it Courier} zu setzten. In \LaTeX{} wird daf"ur der Befehl {\tt\{$\backslash$tt\}} verwendet. Als Beispiel ist in Abbildung \ref{C-Programm} auf Seite \pageref{C-Programm} der Quelltext des Programms {\tt hello} angegeben. Das Programm {\tt hello} schreibt die Meldung "`Hello World!"' auf den Bildschirm. Es benutzt dazu die Funktion {\tt printf}. \subsection{Abbildungen und Tabellen} Abbildungen kommen auf gesonderte Seiten an das Ende des Textes. Auf diesen Seiten befindet sich also kein Flie"stext und sie z"ahlen auch nicht zu der geforderten Mindestl"ange der Ausarbeitung. Es ist jedoch erlaubt, mehrere Abbildungen auf eine Seite zu bringen. Abbildungen werden fortlaufend numeriert und erhalten ein Unterschrift (siehe Abb. \ref{BeispielAbbildung}). Die verwendeten Abbildungen sind im Text zu referenzieren, d.h. der Text mu"s an mindestens einer Stelle Bezug auf die Abbildung nehmen und einen expliziten Verweis (s.o.) auf sie enthalten. Wenn das nicht der Fall ist, wird der Sinn einer Abbildung f"ur den Leser nicht klar. Quelltexte und Tabellen werden ebenfalls als Abbildungen behandelt, d.h. sie kommen auf eine gesonderte Seite, erhalten eine Unterschrift und werden im Flie"stext referenziert. Quelltexte sind grunds"atzlich in Courier bzw. als {\tt\{$\backslash$tt\}} zu formatieren (siehe Abb. \ref{C-Programm}). Innerhalb von Tabellen und Quelltexten k"onnen wahlweise auch die Schriftgr"o"sen 10 pt oder 11 pt verwendet werden (siehe Abschnitt \ref{Schrift}). \begin{figure}[p] \begin{center} \epsfig{file=SampleFigure.eps, width=20mm} \end{center} \caption{Logo des Lehrstuhls f"ur Informatik III} \label{BeispielAbbildung} \end{figure} \begin{figure}[p] \begin{verbatim} #include"stdio.h" #include"stdlib.h" void main (void) { printf("Hello World!\n"); exit(0); } \end{verbatim} \caption{Mein erstes C-Programm} \label{C-Programm} \end{figure} \subsection{Aufz"ahlungen und Listen} Der Text von Aufz"ahlungen wird um 16 pt gegen"uber dem "ubrigen Flie"stext einger"uckt. Die Nummern der einzelnen Punkte stehen links neben dem Text. Die erste Zeile jedes Absatzes wird {\it nicht} einger"uckt. Ansonsten werden die Abs"atze genau wie die Abs"atze des Flie"stextes formatiert. \begin{compactenum} \item eins eins eins eins eins eins eins eins eins eins eins eins eins eins eins eins eins eins eins eins eins eins eins eins eins eins eins eins eins eins eins eins eins eins eins eins eins eins eins eins eins eins eins eins eins eins eins eins eins eins eins eins eins eins eins eins \item zwei zwei zwei zwei zwei zwei zwei zwei zwei zwei zwei zwei zwei zwei zwei zwei zwei zwei zwei zwei zwei zwei zwei zwei zwei \item drei drei drei drei drei drei drei drei drei drei drei drei drei drei drei drei drei drei drei drei drei drei drei drei drei drei drei drei \end{compactenum} Anstelle einer numerierten Aufz"ahlung kann auch eine nicht numerierte Liste verwendet werden. Die einzelnen Punkte der Liste werden durch ein Bullet-Symbol "`$\bullet$"' anstatt durch Zahlen markiert. Dar"uber hinaus gelten die selben Regeln wie f"ur Aufz"ahlungen. \begin{compactitem} \item eins eins eins eins eins eins eins eins eins eins eins eins eins eins eins eins eins eins eins eins eins eins eins eins eins eins eins eins \item zwei zwei zwei zwei zwei zwei zwei zwei zwei zwei zwei zwei zwei zwei zwei zwei zwei zwei zwei zwei zwei zwei zwei zwei zwei \item drei drei drei drei drei drei drei drei drei drei drei drei drei drei drei drei drei drei drei drei drei drei drei drei drei drei drei drei \end{compactitem} \subsection{Mathematische Formeln} Kleinere mathematische Formeln k"onnen direkt in den Flie"stext eingebaut werden: Die erste binomische Formel lautet: $(a+b)^2 > a^2 + 2ab + b^2$. L"angere Formeln werden zentriert in eine eigene Zeile geschrieben: \begin{equation} x_1 = \frac{\sqrt{3 y_2}- 7 x_2}{y_1^3-2} + \sqrt {x_2 + y_2} \label{MatheBeispiel} \end{equation} Die Namen von mathematischen Variablen, Konstanten usw. sind kursiv zu setzen. Dies gilt sowohl innerhalb einer Formel als auch innerhalb des Flie"stextes: Die erste binomische Formel enth"alt die Variblen $a$ und $b$. Wenn man sich im Text auf eine Formel beziehen will, werden die Formeln durchlaufend numeriert. Die Nummer steht am Ende der Zeile in Klammern, z.B. wie bei Formel \ref{MatheBeispiel}. \section{Kennzeichnung von Zitaten} Wird aus einer Literaturquelle direkt oder indirekt zitiert, ist dieses Zitat kenntlich zu machen. Es kann entweder die amerikanische Zitierweise oder die deutsche Zitierweise nach Dudenrichtlinien verwendet werden (vgl. \cite{poen88}). Bei der amerikanischen Zitierweise wird der Verweis auf die Quelle hinter das Zitat in eckigen Klammern gesetzt. Ein Beispiel hierf"ur ist \cite{jaeger}. Wenn man, wie in diesem Proseminar, nur wenige Quellen verwendet und viel daraus zitiert, ist zu jedem Zitat auch noch die genaue Stelle in der Quelle anzugeben, z.B. \cite[S. 3 ff]{jaeger}. \section{Rechtschreibung} Es kann wahlweise die alte oder die neue Rechtschreibung verwendet werden, jedoch keine Mischung aus beiden. Um die gr"obsten Fehler aus dem Text zu entfernen (Tippfehler, vertauschte Buchstaben, etc.) empfiehlt sich der Einsatz eines Programms zur Rechtschreibpr"ufung (Spellchecker). Das ersetzt aber nicht das anschlie"sende gr"undliche Korrekturlesen des Textes auf Grammatik-, Zeichensetzungs- und Ausdruckfehler. Die Erfahrung zeigt, da"s der Zeitaufwand, der f"ur ein gr"undliches Korrekturlesen notwendig ist, von vielen zun"achst untersch"atzt wird. \section{Das Inhaltsverzeichnis} Das Inhaltsverzeichnis wird ebenfalls so formatiert, wie in diesem Text, d.h. die "Uberschriften der ersten Stufe sind im Inhaltsverzeichnis 12 pt fett und haben 12 pt Abstand zur vorherigen Zeile. Die "Uberschriften der Stufen zwei und drei sind 12 pt normal. Die Einr"uckungen dieser "Uberschriften wird von \LaTeX{} automatisch vorgenommen. Wenn eine andere Textverarbeitung verwendet wird, k"onnen die Einr"uckungen dort auch entfallen. Die Seitenzahlen sind im Inhaltsverzeichnis rechtsb"undig aufzuf"uhren. Zwischen den "Uberschriften der Stufen zwei und drei und den entsprechenden Seitenzahlen sind Punkte als F"ullzeichen einzuf"ugen. \section{Das Literaturverzeichnis} Die verwendeten Quellen werden so in das Literaturverzeichnis "ubernommen, wie sie auf dem ausgeteilten Themenblatt zu finden sind. Dabei sind auch die dort verwendeten Textformatierungen beizubehalten. N"ahere Angaben "uber die Zusammensetzung einer Literaturreferenz findet man ebenfalls in \cite{poen88}. \begin{thebibliography}{XXXXXX} \bibitem[jaeg01]{jaeger} J"ager, Dirk. {\it Formatvorgaben f"ur die Ausarbeitung im Proseminar.} Internes Papier, Lehrstuhl f"ur Informatik III, RWTH-Aachen, 2001. \bibitem[poen88]{poen88} Poenicke, Klaus. {\it Wie verfa"st man wissenschaftliche Arbeiten?: Ein Leitf. vom 1. Studiensem. bis zur Promotion.} Die Duden-Taschenb"ucher: Bd. 21, 2. Aufl., Dudenverlag, Mannheim, 1988. \end{thebibliography} %---------------------------------------------------------------------------- \end{document} %---------------------------------------------------------------------------- % END OF FILE %----------------------------------------------------------------------------