# HG changeset patch
# User markus schnalke <meillo@marmaro.de>
# Date 1341496675 -7200
# Node ID 996c4ac500df2cf72af84d73f1fe72a3dbe146af
# Parent  044b4d0a8fa3599750892d69f872d9bac1c7aab1
preface: Wrote about the organization of the document.

diff -r 044b4d0a8fa3 -r 996c4ac500df preface.roff
--- a/preface.roff	Thu Jul 05 15:56:54 2012 +0200
+++ b/preface.roff	Thu Jul 05 15:57:55 2012 +0200
@@ -188,37 +188,61 @@
 
 .U2 "Organization
 .P
-Which font for what use.
-Meaning of `foo(1)'.
-RFCs.
+This thesis consists of three chapters.
+Chapter 1 introduces into the topic, describing MH and explaining
+the background and goals of the mmh project.
+Chapter 2 discusses the work done in the project.
+It is organized along the three major goals of the project, namely
+streamlining, modernizing, and styling.
+Not all the work done in the project is described,
+because that would bore the reader.
+Instead, important changes and those standing for a set of similar
+changes are described and discussed.
+Chapter 3 finishes up by summarizing the achivements and taking
+an outlook to the future of the mmh project.
 .P
-References to source code repository commits are printed as
-.Ci 1a2b3c4 .
-They can be looked up with
-.Cl "git show XXX
-on the command line or
-online at
-.CW "http://git.marmaro.de/?p=mmh;a=commitdiff;h=XXX" ,
-replacing `\f(CWXXX\fP' with the hash value.
+.I "Italic font
+is used to emphasize new terms.
+.CW "Constant width font
+is used to denote names of programs, files,
+functions, command lines, code excrepts, program input and output.
+.P
+References to man pages are printed as ``\c
+.Mp cat (1)''.
+In this case it is a reference to the man page of
+.Pn cat ,
+which is in section one of the Unix manual.
+Internet technologies are specified by \fIRequests for Comments\fP (RFCs).
+Throughout the document, they are referenced in this way ``RFC\|822''.
+A list of relevant RFCs is located at the end of the document.
+References to literature are printed in backets, like
+.[ ``[
+kernighan pike unix programming env
+.]]'', within the text.
+The full references are collected at the end of the document.
+.P
+This document describes practical programming work.
+The code of mmh is managed by the
+.Pn git
+version control system.
+All code changes were checked in.
+In the discussions, references to corresponding code changes are printed
+as ``\c
+.Ci 1a2b3c4 ''.
+The identifier is the seven-letter-prefix of the changeset hash value,
+which is considered unique.
+A change can be looked up in the repository, on the command line with
+.Cl "git show XXX" ,
+replacing `\f(CWXXX\fP' with the concrete hash value or any unique prefix.
 In this example:
-.Cl "git show 1a2b3c4
-or
-.CW "http://git.marmaro.de/?p=mmh;a=commitdiff;h=1a2b3cd" .
-Whereas the code repository will probably be available on the Internet
-forever, a website URL is always at risk to change.
-.P
-This thesis is divided into XXX chapters, ...
-.P
-.I Chapter 1
-introduces ...
-.P
-.I Chapter 2
-describes ...
-.P
-.I Chapter 3
-covers ...
+.Cl "git show 1a2b3c4" .
+At the time of writing, changesets can be looked up online this way:
+.CW "http://git.marmaro.de/?p=mmh;a=commitdiff;h=XXX" .
+But URIs are always at risk to change.
 
 
 .U2 "Acknowledgments
 .P
 To be written at the very end.
+.P
+FIXME