# HG changeset patch
# User meillo@marmaro.de
# Date 1232449594 -3600
# Node ID fb66805bc870475b83ef18343755d354c98bbff5
# Parent  1b2f12da528ad49f381be0fd7ba707377636d211
reworked section about conventions; minor other stuff

diff -r 1b2f12da528a -r fb66805bc870 thesis/tex/0-preface.tex
--- a/thesis/tex/0-preface.tex	Tue Jan 20 10:45:02 2009 +0100
+++ b/thesis/tex/0-preface.tex	Tue Jan 20 12:06:34 2009 +0100
@@ -4,6 +4,10 @@
 
 << preface text (about 1 page) >> %FIXME
 
+<< \textbf{say what you want to say} >>
+
+<< the overall goal of the document >>
+
 goal: revive masqmail; make it future save; clean it up; add some missing features; release a new version
 
 << write about the motivation to cover this topic: what is it I want? >> %FIXME
@@ -39,7 +43,6 @@
 explain about administrating \unix.
 And developing programs in C may be learned from \cite{k&r} and \cite{rochkind85}. %FIXME: references
 
-%TODO: should I tell them to send email to me when having questions? Or somewhere else?
 
 
 \section*{Organisation}
@@ -48,45 +51,27 @@
 
 << explain where the main part lies (theory vs. implementation) >> %FIXME:
 
-<< write about the bundled CD, and tell what's included >> %TODO
 
 
 \section*{Conventions}
-%TODO: check if this tells what is really used!
-%FIXME: make it complete!
-%FIXME: remove everything not needed. Maybe write only a few sentences text.
+%TODO: check it!
 The following typographic conventions are used in this thesis:
 
-\begin{tabular}{ p{0.25\textwidth} p{0.7\textwidth} }
-\emph{Italics} &
-is used for names, including command names, file name, hostnames, usernames and email addresses.
-Further more it is used to emphasize text.
-\\ &\\
+\emph{Italic shape} is used to emphasize text and for all kinds of names, including command names, file name, hostnames, usernames, and email addresses, except names of persons for which \textsc{Small Caps} are used.
 
-\texttt{Constant Width} &
-is used for source code, contents of files and output from programs.
-\\ &\\
+Source code, contents of files, and output from programs is displayed in \texttt{Typewriter font}.
 
-\person{Small Caps} &
-are used to indicate names of persons.
-\\ &\\
-\end{tabular}
+References to external resources are marked using one of three styles, distinguished by the type of resource.
 
-References to external resources are marked using one of three styles:
+\begin{enumerate}
+\item References to books, articles, and similar documents looks like this: \cite{kernighan84}. The letters represent the author(s) (here \person{Kenighan} and \person{Pike}), the number represents the year of publication (here 1984).
 
-\begin{tabular}{ p{0.25\textwidth} p{0.7\textwidth} }
-\cite{kernighan84} &
-is a reference to a book, an article, or a similar document. The Bibliography is located at the end of the thesis.
-\\ &\\
+\item Websites differ from documents as they are less of a text written by some author but more a place where information is gathered. They are only indicated by numbers, like for example: \citeweb{masqmail:homepage}.
 
-\citeweb{masqmail:homepage} &
-is a reference to a website. Websites differ from documents as they are less of a text written by some author, but more a place where information is gathered.
-\\ &\\
+\item \name{Request for Comments}---documents that define Internet standards---are referenced in a third way, by specifying the unique number of the \RFC\ directly: \RFC821.
+\end{enumerate}
 
-\RFC821 &
-is a reference to the \name{Request For Comments}, here the one numbered 821. \RFC{}s are only referenced in this way. A list of relevant \RFC{}s and how they can be retrieved is available in the Appendix. %fixme: add ref
-\\ &\\
-\end{tabular}
+The Bibliography is located at the end of the thesis. It also includes a list of the relevant \RFC{}s and how they can be retrieved.
 
 
 
@@ -95,4 +80,4 @@
 \section*{Acknowledgments}
 %FIXME: write this at the very end.
 % dont forget: proove readers, suggestion makers, supporters, ...
-% FIXME: if too long, include a file on the CD and refer on it here
+% FIXME: if too long, think about a page in the appendix