docs/diploma

changeset 302:fb66805bc870

reworked section about conventions; minor other stuff
author meillo@marmaro.de
date Tue, 20 Jan 2009 12:06:34 +0100
parents 1b2f12da528a
children 7680c80babae
files thesis/tex/0-preface.tex
diffstat 1 files changed, 15 insertions(+), 30 deletions(-) [+]
line diff
     1.1 --- a/thesis/tex/0-preface.tex	Tue Jan 20 10:45:02 2009 +0100
     1.2 +++ b/thesis/tex/0-preface.tex	Tue Jan 20 12:06:34 2009 +0100
     1.3 @@ -4,6 +4,10 @@
     1.4  
     1.5  << preface text (about 1 page) >> %FIXME
     1.6  
     1.7 +<< \textbf{say what you want to say} >>
     1.8 +
     1.9 +<< the overall goal of the document >>
    1.10 +
    1.11  goal: revive masqmail; make it future save; clean it up; add some missing features; release a new version
    1.12  
    1.13  << write about the motivation to cover this topic: what is it I want? >> %FIXME
    1.14 @@ -39,7 +43,6 @@
    1.15  explain about administrating \unix.
    1.16  And developing programs in C may be learned from \cite{k&r} and \cite{rochkind85}. %FIXME: references
    1.17  
    1.18 -%TODO: should I tell them to send email to me when having questions? Or somewhere else?
    1.19  
    1.20  
    1.21  \section*{Organisation}
    1.22 @@ -48,45 +51,27 @@
    1.23  
    1.24  << explain where the main part lies (theory vs. implementation) >> %FIXME:
    1.25  
    1.26 -<< write about the bundled CD, and tell what's included >> %TODO
    1.27  
    1.28  
    1.29  \section*{Conventions}
    1.30 -%TODO: check if this tells what is really used!
    1.31 -%FIXME: make it complete!
    1.32 -%FIXME: remove everything not needed. Maybe write only a few sentences text.
    1.33 +%TODO: check it!
    1.34  The following typographic conventions are used in this thesis:
    1.35  
    1.36 -\begin{tabular}{ p{0.25\textwidth} p{0.7\textwidth} }
    1.37 -\emph{Italics} &
    1.38 -is used for names, including command names, file name, hostnames, usernames and email addresses.
    1.39 -Further more it is used to emphasize text.
    1.40 -\\ &\\
    1.41 +\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.
    1.42  
    1.43 -\texttt{Constant Width} &
    1.44 -is used for source code, contents of files and output from programs.
    1.45 -\\ &\\
    1.46 +Source code, contents of files, and output from programs is displayed in \texttt{Typewriter font}.
    1.47  
    1.48 -\person{Small Caps} &
    1.49 -are used to indicate names of persons.
    1.50 -\\ &\\
    1.51 -\end{tabular}
    1.52 +References to external resources are marked using one of three styles, distinguished by the type of resource.
    1.53  
    1.54 -References to external resources are marked using one of three styles:
    1.55 +\begin{enumerate}
    1.56 +\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).
    1.57  
    1.58 -\begin{tabular}{ p{0.25\textwidth} p{0.7\textwidth} }
    1.59 -\cite{kernighan84} &
    1.60 -is a reference to a book, an article, or a similar document. The Bibliography is located at the end of the thesis.
    1.61 -\\ &\\
    1.62 +\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}.
    1.63  
    1.64 -\citeweb{masqmail:homepage} &
    1.65 -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.
    1.66 -\\ &\\
    1.67 +\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.
    1.68 +\end{enumerate}
    1.69  
    1.70 -\RFC821 &
    1.71 -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
    1.72 -\\ &\\
    1.73 -\end{tabular}
    1.74 +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.
    1.75  
    1.76  
    1.77  
    1.78 @@ -95,4 +80,4 @@
    1.79  \section*{Acknowledgments}
    1.80  %FIXME: write this at the very end.
    1.81  % dont forget: proove readers, suggestion makers, supporters, ...
    1.82 -% FIXME: if too long, include a file on the CD and refer on it here
    1.83 +% FIXME: if too long, think about a page in the appendix