diff --git a/.gitignore b/.gitignore index 747d42e..4579efc 100644 --- a/.gitignore +++ b/.gitignore @@ -20,7 +20,7 @@ # these rules might exclude image files for figures etc. # *.ps # *.eps -# *.pdf +*.pdf ## Generated if empty string is given at "Please type another file name for output:" .pdf diff --git a/literatur.bib b/literatur.bib new file mode 100755 index 0000000..8c64c38 --- /dev/null +++ b/literatur.bib @@ -0,0 +1,173 @@ +% Encoding: UTF-8 + +@Book{eco, + author = {Umberto Eco}, + title = {Wie man eine wissenschaftliche Abschlußarbeit schreibt}, + year = {2010}, + language = {Deutsch}, + edition = {13. Aufl.}, + publisher = {C. F. Müller}, + pages = {270}, + address = {Heidelberg}, + timestamp = {2013.07.04}, +} + +@Book{kara, + author = {Matthias Karmasin and Rainer Ribing}, + title = {Die Gestaltung wissenschaftlicher Arbeiten}, + year = {2012}, + language = {Deutsch}, + edition = {7. Aufl.}, + publisher = {WUV Universitätsverlag}, + pages = {166}, + address = {Wien}, + timestamp = {2013.07.04}, +} + +@Book{kraemer, + author = {Walter Krämer}, + title = {Wie schreibe ich eine Seminar- oder Examensarbeit?}, + year = {2009}, + language = {Deutsch}, + edition = {3. Aufl.}, + publisher = {Campus-Verlag}, + pages = {189}, + address = {Frankfurt am Main (u.a.)}, + month = {September}, + timestamp = {2013.07.04}, +} + +@BOOK{stengel, + title = {Vorsicht, Denkfehler!}, + publisher = {Uni-Edition}, + year = {2005}, + author = {Oliver Stengel}, + pages = {133}, + address = {Berlin}, + language = {Deutsch}, + timestamp = {2013.07.04} +} + +@online{Dean2012, + Author = {Dean, Jeff}, + Date-Added = {2012-03-05 11:28:31 +0000}, + Date-Modified = {2012-03-05 11:36:17 +0000}, + Keywords = {Google, ULS}, + Lastchecked = {05.03.2012}, + Title = {Software Engineering Advice from Building Large-Scale Distributes Systems}, + Url = {http://static.googleusercontent.com/external_content/untrusted_dlcp/research.google.com/de/people/jeff/stanford-295-talk.pdf}, + Urldate = {2012-03-05}, + Year = {2012}, +} + +@online{Gao2017, + Author = {Gao, Liangcai and Yi, Xiaohan and Hao, Leipeng and Jiang, Zhuoren and Tang, Zhi}, + Date-Added = {2017-06-19 19:21:12 +0000}, + Date-Modified = {2017-06-19 19:21:12 +0000}, + Title = {{ICDAR 2017 POD Competition: Evaluation}}, + Url = {http://www.icst.pku.edu.cn/cpdp/ICDAR2017_PODCompetition/evaluation.html}, + Urldate = {2017-05-30}, + Year = {2017}, + Bdsk-Url-1 = {http://www.icst.pku.edu.cn/cpdp/ICDAR2017_PODCompetition/evaluation.html} +} + +@book{Kornmeier2011, + Author = {Marin Kornmeier}, + Date-Added = {2012-04-04 12:07:45 +0000}, + Date-Modified = {2012-04-04 12:09:25 +0000}, + Edition = {5. Auflage}, + Keywords = {Writing}, + Publisher = {UTB}, + Title = {Wissenschaftlich schreiben leicht gemacht}, + Year = {2012} +} + +@book{Kramer2009, + Author = {Walter Kr{\"a}mer}, + Date-Added = {2011-10-27 13:55:22 +0000}, + Date-Modified = {2011-10-27 14:01:55 +0000}, + Edition = {3. Auflage}, + Keywords = {Writing}, + Month = {9}, + Publisher = {Campus Verlag}, + Title = {Wie schreibe ich eine Seminar- oder Examensarbeit?}, + Year = {2009} +} + +@book{Willberg1999, + Author = {Hans Peter Willberg and Friedrich Forssmann}, + Date-Added = {2011-11-10 08:58:09 +0000}, + Date-Modified = {2012-01-24 19:24:12 +0000}, + Keywords = {Writing}, + Publisher = {Verlag Hermann Schmidt}, + Title = {Erste Hilfe in Typographie}, + Year = {1999} +} + +@book{Forssman2002, + Author = {Friedrich Forssman and Ralf de Jong}, + Date-Added = {2012-01-24 19:20:46 +0000}, + Date-Modified = {2012-01-24 19:21:56 +0000}, + Keywords = {Writing}, + Publisher = {Verlag Hermann Schmidt}, + Title = {Detailtypografie}, + Year = {2002} +} + +@online{Weber2006, + Author = {Stefan Weber}, + Date-Added = {2011-10-27 14:30:30 +0000}, + Date-Modified = {2011-10-27 14:32:34 +0000}, + Journal = {Telepolis}, + Keywords = {Writing}, + Lastchecked = {2011-10-27}, + Month = {12}, + Title = {Wissenschaft als Web-Sampling}, + Url = {http://www.heise.de/tp/druck/mb/artikel/24/24221/1.html}, + Urldate = {2011-10-27}, + Year = {2006}, + Bdsk-Url-1 = {http://www.heise.de/tp/druck/mb/artikel/24/24221/1.html} +} + +@online{Wikipedia_HarveyBalls, + Author = {{Harvey Balls}}, + Date-Added = {2011-10-27 14:30:30 +0000}, + Date-Modified = {2011-10-27 14:32:34 +0000}, + Lastchecked = {2018-02-07}, + Month = {4}, + Title = {Harvey Balls -- Wikipedia}, + Url = {https://de.wikipedia.org/w/index.php?title=Harvey_Balls&oldid=116517396}, + Urldate = {2018-02-07}, + Year = {2013} +} + +@Article{Christidis2016, + author = {K. {Christidis} and M. {Devetsikiotis}}, + title = {Blockchains and Smart Contracts for the Internet of Things}, + pages = {2292-2303}, + volume = {4}, + journal = {IEEE Access}, + year = {2016}, +} + +@INPROCEEDINGS{Redmon2016, + author={J. {Redmon} and S. {Divvala} and R. {Girshick} and A. {Farhadi}}, + booktitle={2016 IEEE Conference on Computer Vision and Pattern Recognition (CVPR)}, + title={You Only Look Once: Unified, Real-Time Object Detection}, + year={2016}, + volume={}, + number={}, + pages={779-788}, +} + +@online{gronkh2019, + title = {METRO EXODUS 039: Der Admiral}, + Date = {2019-03-26}, + year = {2019}, + organization = {YouTube}, + author = {Gronkh}, + url = {https://youtu.be/vDP1vFyMLfs}, + Urldate = {2020-05-04}, +} + +@Comment{jabref-meta: databaseType:biblatex;} diff --git a/preambel.tex b/preambel.tex new file mode 100644 index 0000000..037e394 --- /dev/null +++ b/preambel.tex @@ -0,0 +1,53 @@ +% Hier muss normalerweise nichts angepasst werden +\usepackage[utf8]{inputenx} +\usepackage[pdftex]{graphicx} +\DeclareGraphicsExtensions{.pdf,.jpeg,.jpg,.png} +\usepackage[cmex10]{amsmath} +\usepackage{algorithmic} +\usepackage{array} +\usepackage{url} +\usepackage[autostyle=true,german=quotes]{csquotes} +\usepackage[ + backref, + sorting=none, % Keine Sortierung + doi=true, % DOI anzeigen + isbn=false, % ISBN nicht anzeigen + url=true, % URLs anzeigen + maxnames=6, % Ab 6 Autoren et al. verwenden + minnames=1, % und nur den ersten Autor angeben + style=ieee, + sorting=nyt]{biblatex} +\usepackage{booktabs} +\usepackage{xcolor} +\usepackage{listings} % Source Code listings +\usepackage[printonlyused]{acronym} +\usepackage{fancyvrb} +\usepackage{tocloft} % Schönere Inhaltsverzeichnisse + +\usepackage[ngerman]{betababel} + +\DefineBibliographyStrings{ngerman}{ + andothers = {{et al\adddot}}, % Immer et al. sagen, auch bei Deutsch als Sprache +} +\usepackage[ + unicode=true, + hypertexnames=false, + colorlinks=true, + linkcolor=black, + citecolor=black, + urlcolor=black, + pdfpagelabels, + ]{hyperref} + +\hypersetup{ + pdftitle={\dokumententitel}, + pdfauthor={\autoren}, + pdfdisplaydoctitle=true +} + +% Makros für typographisch korrekte Abkürzungen +\newcommand{\zb}[0]{z.\,B.} +\newcommand{\dahe}[0]{d.\,h.} +\newcommand{\ua}[0]{u.\,a.} + + diff --git a/seminararbeit.tex b/seminararbeit.tex new file mode 100755 index 0000000..a74b6b0 --- /dev/null +++ b/seminararbeit.tex @@ -0,0 +1,307 @@ +\documentclass[conference,compsoc,final,a4paper]{IEEEtran} + +%% Bitte legen Sie hier den Titel und den Autor der Arbeit fest +\newcommand{\autoren}[0]{NACHNAME, VORNAME} +\newcommand{\dokumententitel}[0]{Vorlage für eine Seminararbeit} + +\input{preambel} % Weitere Einstellungen aus einer anderen Datei lesen + +% Literatur einbinden +\addbibresource{literatur.bib} + +\begin{document} + +% Titel des Dokuments +\title{\dokumententitel} + +% Namen der Autoren +\author{ + \IEEEauthorblockN{\autoren} + \IEEEauthorblockA{ + Hochschule Mannheim\\ + Fakultät für Informatik\\ + Paul-Wittsack-Str. 10, + 68163 Mannheim + } +} + +% Titel erzeugen +\maketitle +\thispagestyle{plain} +\pagestyle{plain} + +% Eigentliches Dokument beginnt hier +% ---------------------------------------------------------------------------------------------------------- + +% Kurze Zusammenfassung des Dokuments +\begin{abstract} +An dieser Stelle steht eine kurze Zusammenfassung des Inhaltes des Dokuments. Der Abstrakt ist vollkommen eigenständig und hat weder Querverweise zu anderen Teilen dieser Arbeit noch Referenzen zu Quellen. + +Schreiben Sie die Zusammenfassung im sogenannten faktenzentrierten Stil, d.\,h. beschreiben Sie nicht das Dokument, sondern die Fakten und Informationen, die das Dokument liefert. Zum Beispiel schreiben Sie \textit{nicht} \enquote{Dieses Dokument stellt die besondere Bedeutung des Flux-Kompensators für Zeitreisen im Film \enquote{Zurück in die Zukunft} dar.}, sondern schreiben Sie \enquote{Ohne den Flux-Kompensator wären die Zeitreisen im Film \enquote{Zurück in die Zukunft} nicht möglich.} + +Den Abstract schreibt man als letztes. +\end{abstract} + +% Inhaltsverzeichnis erzeugen +\small\tableofcontents + +% Abschnitte mit \section, Unterabschnitte mit \subsection und +% Unterunterabschnitte mit \subsubsection +% ------------------------------------------------------- +\section{Einleitung} +Die Einleitung liefert eine generelle Darstellung des Problems, der Ziele der Arbeit und deren Aufbau. Sie beschreibt den Hintergrund der Arbeit, das bearbeitete Problem bzw. die zu beantwortende Forschungsfrage und die Untersuchungsmethoden. Am Ende wird kurz der Aufbau der Arbeit erläutert. + +Die Einleitung schreibt man erst, nachdem der Hauptteil der Arbeit fertig ist. + +% ------------------------------------------------------- +\section{Schreibstil} +\subsection{Zielgruppe} +Schreiben Sie die Arbeit so, dass ein fachkundiger Dritter in der Lage ist, den Text zu verstehen und die darin enthaltenen Schlüsse nachvollziehen zu können. Hierzu sollten alle nicht bekannten Fakten mit Literaturstellen belegt werden (\autoref{quellen}). + +\subsection{Sprache} +Schreiben Sie in einer einfachen, gut verständlichen Sprache mit kurzen Sätzen. Schreiben Sie durchgängig in der Gegenwartsform und im Aktiv (z.\,B. \enquote{\dots wird untersucht}, \enquote{\dots zeigt folgende Ergebnisse}). Nutzen Sie wenn möglich deutsche Begriffe, auf keinen Fall jedoch Mischformen wie \emph{downgeloaded} oder \emph{upgedatet}. Wenn es keinen guten deutschen Begriff gibt, dann verwenden Sie die englische Version, \zb{} Repository, Interrupt, etc. + +\subsection{Gliederung} +Gliedern Sie die Arbeit nach logischen Kriterien. Die Gliederung der Arbeit erfolgt über \verb+\section{}+, \verb+\subsection{}+, \verb+\subsubsection{}+ und \verb+\paragraph{}+. + +\subsection{Qualitätssicherung} +Zur Qualitätssicherung Ihrer Arbeit ist u.\,a. folgende Vorgehensweise hilfreich: +\begin{itemize} +\item Wenn es irgendwie möglich ist, sollten Sie die Arbeit auch Kommilitonen lesen lassen. Selbst Verwandte, Freunde und Bekannte, die nicht \emph{vom Fach} sind, finden vielleicht Fehler oder kommentieren Ihre Arbeit. +\item Um sicherzustellen, dass Sie die hier beschriebenen Aspekte beachten, sollten Sie die Formalien z.\,B. nach jedem geschriebenen Kapitel überprüfen. +\item Lassen Sie sich von Ihrem betreuenden Professor alle Randbedingungen und Bewertungsschemata geben und fragen Sie, worauf sie achten sollen. +\end{itemize} + +% ------------------------------------------------------- +\section{Zitate und Quellenangaben}\label{quellen} +Alle von anderen Autoren gewonnenen Erkenntnisse müssen mit Quellen belegt werden. Falls Sie wörtlich zitieren werden, so muss der Text originalgetreu in Anführungszeichen wiedergegeben werden. Wird ein Teil des Textes ausgelassen, so werden Punkte in eckigen Klammern [\,\dots] an die Stelle der Auslassung gesetzt. Zusätze innerhalb des zitierten Textes bedürfen eckiger Klammern []. Gehen Sie sparsam mit wörtlichen Zitaten um. Längere wörtliche Zitate werden i.\,a. eingerückt. Hierzu dient die \textit{quotation}-Umgebung. + +\begin{quotation} +Dies ist ein längeres Zitat, dass in einer Quotation-Umgebung gesetzt wurde. Es hat keine Anführungszeichen aber am Ende natürlich eine Quellenangabe \cite{Kornmeier2011}. +\end{quotation} + +Die Zitierweise muss im gesamten Text einheitlich sein. + +Wichtig ist, dass das Übernehmen von fremden Textstellen ohne entsprechende Kennzeichnung der Herkunft in einer wissenschaftlichen Arbeit nicht akzeptabel ist. Plagiate werden mit der Note 5.0 bewertet. + +\subsection{Zitate im Text} +Wichtig ist das korrekte Zitieren von Quellen, wie es auch von \cite{Kornmeier2011} dargelegt wird. Interessant ist in diesem Zusammenhang auch der Artikel von \cite{Kramer2009}. Häufig werden die Zitate auch in Klammern gesetzt, wie bei \parencite{Kornmeier2011} und mit Seitenzahlen versehen \parencite[S. 22--24]{Kornmeier2011}. +Damit hier auch wissenschaftliche Arbeiten zitiert sind, sei hier auf eine Journal-Veröffentlichung \cite{Christidis2016} und einen Konferenzbeitrag \cite{Redmon2016} verwiesen. + +In manchen Fällen (zur Illustration oder Visualisierung) könnte auch ein YouTube-Video\autocite{gronkh2019} als Quelle vorkommen. + +Bei Webseiten wird auch die URL und das Abrufdatum mit angegeben \parencite{Gao2017}. + +Verwenden Sie das wörtliche Zitat nur dann, wenn es aus dem Kontext heraus sinnvoll ist, also z.\,B. um eine besondere Definition herauszustellen, oder eine sehr prägnante Aussage zu zitieren. Im Allgemeinen benötigen Sie kein wörtliches Zitat -- das macht Ihre Arbeit nur schwer zu lesen. + +Insbesondere bei fremdsprachigen Quellen sollten Sie keine Original-Sätze zitieren, um sie dann mit eigenen Worten im Deutschen zu wiederholen (Ausnahme wie oben, wenn etwa die Wortwahl oder die Aussage besonders prägnant ist). Stattdessen sollten Sie den Text in ihren eigenen Worten in Deutsch formulieren, und dann die Quelle angeben. + +Verwenden Sie die Namen des Autors/der Autoren nur dann, wenn + +\begin{enumerate} +\item Sie es wichtig finden, zu sagen, dass diese Aussage von genau diesem Autor/diesen Autoren getroffen wurde (etwa bei einer Definition, oder bei einer Gegenüberstellung) oder +\item Sie deutlich machen wollen, dass die Aussage nicht von Ihnen stammt (was man aus dem Kontext sonst eventuell missverstehen könnte). +\end{enumerate} + +Verwenden Sie Seitenzahlen bei der Angabe einer Quelle nur dann, wenn das für das Verständnis wichtig ist. Entnehmen Sie \enquote{Wissen} aus einem Paper an mehreren Stellen, dann reicht die Angabe des Papers. Ist es wichtig, die Stelle zu markieren (z.\,B. weil ein bestimmtes Argument referenziert wird), dann ergänzen Sie die Seite. + +Insgesamt kann man sagen, dass Sie Sachverhalte mit eigenen Worten formulieren sollen, und jeweils kennzeichnen, wo der \enquote{Input} hergekommen ist. Eine explizite Nennung von Autor ist nur dann erforderlich, wenn es auch Sinn ergibt, diesen hervorzuheben. + +Damit sollten Sie ein Plagiat vermeiden können, ohne extensiv zu zitieren. Umgekehrt schützt extensives Zitieren auch nicht vor einem Plagiat (z.\,B. wenn Sie einen englischen Text in Google Translation stecken, den übersetzten Text als Ihren eigenen ausgeben, und dann die Quelle ergänzen, ist das ein Plagiat). + +\subsection{Zitierstile} +Verwenden Sie eine einheitliche und im gesamten Dokument konsequent durchgehaltene Zitierweise. Es gibt eine ganze Reihe von unterschiedlichen Standards für das Zitieren und den Aufbau eines Literaturverzeichnisses. Sie können entweder mit Fußnoten oder Kurzbelegen im Text arbeiten. Welches Verfahren Sie einsetzen ist Ihnen überlassen, nur müssen Sie es konsequent durchhalten. + +In der Informatik ist das Zitieren mit Kurzbelegen im Text (Harvard-Zitierweise) weit verbreitet, wobei für das Literaturverzeichnis häufig die Regeln der \ac{ACM} oder \ac{IEEE} angewandt werden.\footnote{Einen Überblick über viele verschiedene Zitierweisen finden Sie in der \url{https://www.reed.edu/cis/help/LaTeX/bibtexstyles.html}} + +Am einfachsten ist es, wenn Sie das \verb+\autocite{}+-Kommando verwenden. Bei diesem Kommando können Sie in der Datei \texttt{preambel.tex} festlegen, wie die Zitate generell aussehen sollen, \zb{} ob sie in Fußnoten erfolgen sollen oder nicht. Wollen Sie von dem globalen Zitierstil abweichen, können Sie weiterhin spezielle Kommandos benutzen: + +\begin{itemize} + \item \verb+\autocite{Willberg1999}+: \autocite{Willberg1999} + \item \verb+\cite{Willberg1999}+: \cite{Willberg1999} + \item \verb+\parencite{Willberg1999}+: \parencite{Willberg1999} + \item \verb+\footcite{Willberg1999}+: \footcite{Willberg1999} + \item \verb+\citeauthor{Willberg1999}+: \citeauthor{Willberg1999} + \item \verb+\citeauthor*{Willberg1999}+: \citeauthor*{Willberg1999} + \item \verb+\citetitle{Willberg1999}+: \citetitle{Willberg1999} + \item \verb+\fullcite{Willberg1999}+: \fullcite{Willberg1999} +\end{itemize} + +\textit{Für die Veranstaltung WIA ist der Zitierstil mit IEEE festgelegt und Sie sollten die Einstellungen am Template nicht verändern. Am besten, Sie verwenden einfach} \verb+\autocite{}+ \textit{und machen sich dann keine Gedanken mehr um den Stil.} + +\subsection{Zitieren von Internetquellen} +Internetquellen sind normalerweise \textit{nicht} zitierfähig. Zum einen, weil sie nicht dauerhaft zur Verfügung stehen und damit für den Leser möglicherweise nicht beschaffbar sind und zum anderen, weil häufig der wissenschaftliche Anspruch fehlt.\footnote{Eine lesenswerte Abhandlung zu diesem Thema findet sich (im Internet) bei \autocite{Weber2006}.} + +Wenn ausnahmsweise doch eine Internetquelle zitiert werden muss, z.\,B. weil für eine Arbeit dort Informationen zu einem beschriebenen Unternehmen abgerufen wurden, sind folgende Punkte zu beachten: + +\begin{itemize} +\item Die Webseite ist als PDF zusammen mit der Arbeit einzureichen, +\item das Datum des Abrufs und die URL sind anzugeben, +\item verwenden Sie Internet-Seiten ausschließlich zu illustrativen Zwecken (z.\,B. um einen Sachverhalt noch etwas genauer zu erläutern), aber nicht zur Faktenvermittlung (z.\,B. um eine Ihrer Thesen zu belegen). +\end{itemize} + +Wenn Sie aufgrund der Natur Ihrer Arbeit sehr viele Internetquellen benötigen, dann können Sie diese, statt sie auszudrucken auch in elektronischer Form ablegen. + +Wikipedia stellt einen immensen Wissensfundus dar und enthält zu vielen Themen hervorragende Artikel. Sie müssen sich aber darüber im Klaren sein, dass die Artikel in Wikipedia einem ständigen Wandel unterworfen sind und nicht als Quelle für wissenschaftliche Fakten genutzt werden sollten. Es gelten die allgemeinen Regeln für das Zitieren von Internetquellen. Sollten Sie doch Wikipedia nutzen müssen, verwenden Sie bitte ausschließlich den Perma-Link\footnote{Sie erhalten den Permalink über die Historie der Seite und einen Klick auf das Datum.} zu der Version der Seite, die Sie aufgerufen haben. + +\subsection{Wo kommt die Quelle hin?} +Wo werden die Quellen zu einem Zitat bzw. die Belege zu einer Aussage platziert? + +\begin{itemize} +\item Wenn die Quelle sich auf den ganzen Satz bezieht: Am Ende des Satzes \textit{vor} dem Punkt:\\ \textit{Ein Muggle ist ein Mensch ohne Zauberkräfte [1, S. 124]. Ein Dementor ist ein Untoter [2, S. 234].} +\item Wenn der Autor herausgestellt werden soll: Am Anfang des Satzes:\\ \textit{Rowling [2, S. 234] beschreibt den Muggle als Menschen ohne Zauberkräfte.} +\item Wenn der Autor herausgestellt werden soll aber der Absatz lang ist, am Ende des Absatzes:\\ \textit{Rowling beschreibt den Muggle als Menschen ohne Zauberkräfte... [2, S. 234].} +\item Wenn die Quelle sich auf ein \textit{kurzes} wörtliches Zitat bezieht, direkt nach dem Zitat, vor dem Punkt:\\ \textit{Hermine behauptet, dass \enquote{Harry Potter der weltgrößte Zauberer} [1, S. 20] sei.} +\item Wenn die Quelle sich auf einen Begriff oder Teil des Satzes bezieht, direkt \textit{nach dem Begriff}, auf den sich die Quelle bezieht:\\ \textit{Man unterscheidet bei Harry Potter Muggle [2, S. 124] und Zauberer [2, S. 133].} +\item Wenn es sich um ein langes wörtliches Zitat handelt, wird es eingerückt und ohne Anführungszeichen gesetzt, wobei die Quelle am Ende angegeben wird. Hierzu verwendet man die \texttt{quote}-Umgebung in \LaTeX. +\end{itemize} + +% ------------------------------------------------------- +\section{Typographie} +\subsection{Hervorhebungen}\label{Einleitung:Textauszeichnungen} +Achten Sie bitte auf die grundlegenden Regeln der Typografie\footnote{Ein Ratgeber in allen Detailfragen ist \cite{Forssman2002}.}, wenn Sie Ihren Text schreiben. Hierzu gehören \zb{} die Verwendung der richtigen "`Anführungszeichen"' und der Unterschied zwischen Binde- (-), Gedankenstrich (--) und langem Strich (---). + +Wenn Sie Text hervorheben wollen, dann setzten Sie ihn \textit{kursiv} (Italic) und nicht \textbf{fett} (Bold). Fettdruck ist Überschriften vorbehalten; im Fließtext stört er den Lesefluss. Das \underline{Unterstreichen} von Fließtext ist im gesamten Dokument tabu und kann maximal bei Pseudo-Code vorkommen. + +\subsection{Anführungszeichen} +Deutsche Anführungszeichen gehen so: "`dieser Text steht in \glq Anführungszeichen\grq; alles klar?"'. Englische Anführungszeichen werden anders benutzt: ``this is an `English' quotation.'' + +Am besten Sie verwenden das Paket \textit{csquotes}, dass über das Makro \verb+\enquote+ immer die richtigen \enquote{Anführungszeichen} bietet und auch die Spracheinstellungen berücksichtigt. Sie können mehrere Anführungszeichen ineinander schachteln: \enquote{Und der Almöhi sagte \enquote{Heidi, komm heim} und steckte sich die Pfeife an.} + +\subsection{Abkürzungen} +Abkürzungen müssen in einem Ab"-kürzungs"-verzeichnis aufgeführt und bei der ersten Verwendung auch ausgeschrieben werden, also z.\,B. \ac{AES} bei der ersten Verwendung, danach einfach nur \ac{AES}. Man kann allerdings die Langform explizit anfordern: \acl{ABK} oder die Kurzform \acs{ABK} oder auch noch einmal die Definition: \acf{ABK}. + +Beachten Sie, dass bei Abkürzungen, die für zwei Wörter stehen, ein kleines Leerzeichen nach dem Punkt kommt: z.\,B. bzw. \zb{}, d.\,h. bzw. \dahe{} + +\subsection{Querverweise} +Querverweise auf eine Kapitelnummer macht man im Text mit \verb+\ref+ (Kapitel~\ref{Einleitung:Textauszeichnungen}) und auf eine bestimmte Seite mit \verb+\pageref+ (Seite~\pageref{Einleitung:Textauszeichnungen}). Man kann auch den Befehl \verb+\autoref+ benutzen, der automatisch die Art des referenzierten Elements bestimmt (\zb{} \autoref{Einleitung:Textauszeichnungen}). + +\subsection{Fußnoten} +Fußnoten werden einfach mit in den Text geschrieben, und zwar genau an die Stelle\footnote{an der die Fußnote auftauchen soll.} + +\subsection{Fremdsprachige Begriffe} +Wenn Sie Ihre Arbeit auf Deutsch verfassen, gehen Sie sparsam mit englischen Ausdrücken um. Natürlich brauchen Sie etablierte englische Fachbegriffe, wie z.\,B. \textit{Interrupt}, nicht zu übersetzen. Sie sollten aber immer dann, wenn es einen gleichwertigen deutschen Begriff gibt, diesem den Vorrang geben. Den englischen Begriff (\textit{term}) können Sie dann in Klammern oder in einer Fußnote\footnote{Englisch: \textit{footnote}.} erwähnen. Absolut unakzeptabel sind deutsch gebeugte englische Wörter oder Kompositionen aus deutschen und englischen Wörtern wie z.\,B. downgeloadet, upgedated, Keydruck oder Beautyzentrum. + +\subsection{Tabellen} +Tabellen werden normalerweise ohne vertikale Striche gesetzt, sondern die Spalten werden durch einen entsprechenden Abstand voneinander getrennt.\footnote{Siehe \cite[S. 89]{Willberg1999}.} Zum Einsatz kommen ausschließlich horizontale Linien (siehe \autoref{google:numbers}). Beachten Sie, dass bei Tabellen -- anders als bei Abbildungen -- die Beschriftung über der Tabelle steht. + +% Tabelle +\begin{table}[!ht] +\centering +\rmfamily +\caption{Zeitbedarf für ausgewählte Aktionen, nach~\cite{Dean2012}} +\renewcommand{\arraystretch}{1.1} +\sffamily +\begin{footnotesize} +\begin{tabular}{l r} +\toprule +\textbf{Vorgang} & \textbf{Zeitbedarf} \\ +\midrule +L1 cache reference & 0,5 ns\\ +Branch mispredict & 5 ns\\ +L2 cache reference & 7 ns\\ +Mutex lock/unlock & 100 ns\\ +Main memory reference & 100 ns\\ +Compress 1K bytes with Zippy & 10.000 ns\\ +Send 2K bytes over 1 Gbps network & 20.000 ns\\ +Read 1 MB sequentially from memory & 250.000 ns\\ +Round trip within same datacenter & 500.000 ns\\ +Disk seek & 10.000.000 ns\\ +Read 1 MB sequentially from network & 10.000.000 ns\\ +Read 1 MB sequentially from disk & 30.000.000 ns\\ +Send packet CA-Netherlands-CA & 150.000.000 ns\\ +\bottomrule +\end{tabular} +\end{footnotesize} +\label{google:numbers} +\end{table} + +\subsection{Aufzählungen} +Aufzählungen werden mit der \texttt{itemize}-Umgebung erzeugt und können auch einfach ineinander geschachtelt werden. + +\begin{itemize} + \item Ein wichtiger Punkt + \item Noch ein wichtiger Punkt + \item Ein Punkt mit Unterpunkten + \begin{itemize} + \item Unterpunkt 1 + \item Unterpunkt 2 + \end{itemize} + \item Ein abschließender Punkt ohne Unterpunkte +\end{itemize} + +Aufzählungen mit laufenden Nummern sind mit der \texttt{enumerate}-Umgebung möglich. + +\begin{enumerate} + \item Ein wichtiger Punkt + \item Noch ein wichtiger Punkt + \item Ein Punkt mit Unterpunkten + \begin{enumerate} + \item Unterpunkt 1 + \item Unterpunkt 2 + \end{enumerate} + \item Ein abschließender Punkt ohne Unterpunkte +\end{enumerate} + +\subsection{Abbildungen} +Abbildungen sind oft sehr hilfreich, um Zusammenhänge zu verdeutlichen. Soweit möglich, sollten die Abbildungen als Vektorgrafiken eingebunden werden. Die in der Abbildung enthaltenen Schriftarten sollten nach Möglichkeit die gleichen sein, wie im restlichen Dokument. Alle Beschriftungen innerhalb der Grafik sollten gut lesbar sein. +Graphen können farbig sein, wenn es der Lesbarkeit dient. Es sollte jedoch darauf geachtet werden, dass auch eine schwarz\-weiß-Kopie noch alle nötigen Informationen enthält (d.\,h. Liniendiagramme mit verschiedenen Linienarten z.\,B. Strichpunkt). +Falls eine Abbildung nur in Form einer Bitmap realisiert werden kann (z.\,B. Screenshot), sollte die Auflösung mindestens 600 dpi betragen und die Qualität nicht durch Komprimierung (z.\,B. jpg) verschlechtert werden. Unkomprimierte oder verlustfrei komprimierte Bildformate wie \emph{png} oder \emph{bmp} sind zu bevorzugen. Nur für echte Fotos ist \emph{jpg} geeignet. + +% Grafik in einer Spalte für die Datei bsp1.jpg +\begin{figure}[!ht] +\centering +\includegraphics[width=8.5cm]{bsp1.pdf} +\caption{Beispielgrafik~\cite{Dean2012}} +\label{fig_sim} +\end{figure} + +Jede Abbildung (vgl. \autoref{fig_sim} auf Seite~\pageref{fig_sim}) und Tabelle (z.\,B. \autoref{google:numbers} auf Seite~\pageref{google:numbers}) sollte im Fließtext referenziert und beschrieben/erläutert werden. Die Beschriftung unter den Abbildungen sollte die Abbildung vollständig und verständlich beschreiben, auch ohne dass man den restlichen Text gelesen hat. Gleiches gilt für die Beschriftungen von Tabellen, die über die Tabellen gesetzt werden. + +\subsection{Formelsatz} +Eine Formel gefällig? Mitten im Text $a_2 = \sqrt{x^3}$ oder als eigener Absatz (siehe Formel~\ref{Formel}): + +\begin{equation} +\begin{bmatrix} + 1 & 4 & 2 \\ + 4 & 0 & -3 +\end{bmatrix} + \cdot +\begin{bmatrix} + 1 & 1 & 0 \\ + -2 & 3 & 5 \\ + 0 & 1 & 4 +\end{bmatrix} + {=} +\begin{bmatrix} + -7 & 15 & 28 \\ + 4 & 1 & -12 +\end{bmatrix} +\label{Formel} +\end{equation} + +% -------------------------------------------------------------------- +\section*{Abkürzungen} +\addcontentsline{toc}{section}{Abkürzungen} + +% Die längste Abkürzung wird in die eckigen Klammern +% bei \begin{acronym} geschrieben, um einen hässlichen +% Umbruch zu verhindern +% Sie müssen die Abkürzungen selbst alphabetisch sortieren! +\begin{acronym}[IEEE] +\acro{A2A}{Application-to-Application} +\acro{ABK}{Abkürzung} +\acro{ACL}{Acess Control List} +\acro{ACM}{Association of Computing Machinery} +\acro{AES}{Advanced Encryption Standard} +\acro{IEEE}{Institute of Electrical and Electronics Engineers} +\acro{ISO}{International Organization for Standardization} +\acro{PDF}{Portable Document Format} +\end{acronym} + +% Literaturverzeichnis +\addcontentsline{toc}{section}{Literatur} +\AtNextBibliography{\small} +\printbibliography + +\end{document}