% document describing the disithesis class
% Davide Ancona 15/5/98
\documentclass[a4paper,11pt]{article}

\usepackage{xspace}
%%\usepackage{moreverb}
\usepackage{longtable}

\addtolength\textwidth{1in}
\addtolength\oddsidemargin{-0.5in}
\addtolength\textheight{1in}
\addtolength\topmargin{-0.5in}

\newcommand{\csthesis}{{\tt disithesis}\xspace}

\begin{document}

\parskip=10pt
\parindent=0pt

\title{The \csthesis Class for \LaTeXe}
\author{}
\maketitle

\section{Introduction}

This document describes the \csthesis class which has been
specifically written for \LaTeXe. This class provides a general style
for presenting postgraduate theses in the department
of Computer Science. 
To use this class, all you need do is begin your \LaTeX\ 
document with the declaration:

\begin{verbatim}
     \documentclass[<options>]{disithesis}\end{verbatim}

The default behaviour of this formatting class is to produce documents
which are typeset as 12 point text on single-sided A4 pages with
1 line spacing. However, a number of options are provided by
the \csthesis class to alter these default formatting setting. Also,
a collection of useful environments and commands are defined to 
simplify the production of your thesis. 

This document will begin by introducing the various options which the
\csthesis class currently supports. It will also describe the various
environments and commands which it offers the user. 

\section{Class Options}

The \csthesis class is built on top of the standard \LaTeXe\ {\tt
  report} class. As such, it will accept and support all of the
options which can be passed to {\tt report}, e.g.\ {\tt twoside}, {\tt
  leqno}, {\tt fleqn} etc. In addition to these inherited features,
\csthesis provides the following options (which can be specified in
the square-bracketed section of the \verb+\documentclass+ command).

\begin{description}

\item [phd] : By supplying this option, the \verb+\maketitle+ command
  will produce a title page for a Ph.D.\ thesis (please refer to
  Section~\ref{sec:COMMANDS} for a description of the
  \verb+\maketitle+ command under the \csthesis class). This is the
  default operation.

\item [centerchapter] : All chapter headings are centred on the page
  (this includes Appendicies, Table of Contents, Bibliography etc.).
  There is a synonym for this option called {\bf centrechapter}. This
  is the default operation.

\item [leftchapter] : All chapter headings are positioned flush with
  the left hand margin (this includes Appendicies, Table of Contents,
  Bibliography etc.).

\item [rightchapter] : All chapter headings are positioned flush with
  the right hand margin (this includes Appendicies, Table of Contents,
  Bibliography etc.).

\item [draft] : The {\tt draft} option will insert the text 
   ``(Draft Copy)'' on the title page to 
  indicate that the report is a draft version and 
  suppresse the cover page produced
  by the \verb+\+{\bf maketitle} command (see Section~\ref{sec:COMMANDS}).
  In addition to this, the standard draft behaviour of
  the {\tt report} class will be implemented.

\item [singlespacing] : This option can be used to override the
  default 1${1\over2}$ spacing behaviour and force a single spaced
  thesis.

\item [doublespacing] : This option can be used to override the
  default 1${1\over2}$ spacing behaviour and force a double spaced
  thesis.

\item [nocoverpage] : This option suppresses the cover page produced
  by the \verb+\+{\bf maketitle} command (see Section~\ref{sec:COMMANDS}).
\end{description}

\section{Environments}

This section describes the various environments which are
defined within the \csthesis class. 

\begin{description}

\item [abstract] : As with the the {\tt report} style, the \csthesis
  class has an environment for you to enter your abstract into. This
  is similar to the standard {\tt report} one, but with a couple of
  differences (e.g.\ the title is in a larger font and the abstract
  is not centred between the top and bottom margins).

\item [acknowledgements] : Normally, an Acknowledgements section
  follows the abstract. This can be created by simply using the {\tt
    acknowledgements} environment.

\item [citetext] : This environment accept a
  single parameter to define the name and details of the originator.
  This will then be right justified directly after the quotation. E.g.

\begin{verbatim}
    \begin{citetext}{Monty Python}
       And now for something completely different\ldots
    \end{citetext}\end{verbatim}

\item [addresspage] : This environment is used to create the page
      just after the title page containing all useful information
      about the author and her/his advisors.
   
\end{description}

\section{Commands}
\label{sec:COMMANDS}

The \csthesis class also exports a number of commands which can be
used within your thesis. These are common or useful operations which
are provided to ease the development of your \LaTeXe\ document.

\begin{description}

\item [] \verb+\+{\bf maketitle} : This command has been redefined for the
  \csthesis class. Instead of the default {\tt report} operation, it
  will produce a suitably formatted title page with the title of the
  thesis, the author, the university name, the
  year and month. It also produces a cover page with the title, the author, the
  number of the technical report and all the information about the department
  (recall that this page is suppressed by the draft and nocoverpage options).
  For this, the user can define the following strings before
  calling the \verb+\maketitle+ command:

\newcommand{\curly}{{\tt \symbol{123}\ldots\symbol{125}}\ }

\begin{itemize}
\item \verb+\title+\curly : the title of the thesis.
\item \verb+\author+\curly : the author of the thesis.
\item \verb+\submityear+\curly : the year of presentation.
\item \verb+\submitmonth+\curly : the month of presentation.
\item \verb+\technumber+\curly : the number of the technical report.
\end{itemize}

  For example, the following extract illustrates how to create a
  thesis title page. 

\begin{verbatim}
   \title{How I Did It}
   \author{Victor Frankenstein}
   \submityear{1785}
   \submitmonth{December}
   \technumber{17}
   \maketitle
\end{verbatim}

\newcommand{\openc}{{\tt \symbol{123}<}}
\newcommand{\closec}{{\tt >\symbol{125}}}

\item [] \verb+\+{\bf dedication} : You can use this command to insert a
  short dedication page at the front of your thesis. This will usually
  follow immediately after the title and the address page 
  (i.e.\ before the abstract and acknowledgements). For example:

\begin{verbatim}
     \dedication{To my Mum.}
\end{verbatim}

\end{description}

\end{document}