\documentclass{cshonours}
\bibliographystyle{acm}

\usepackage{graphics}  %optional

\title{The Honours Dissertation Class for \LaTeX2e}
\author{Cara MacNish}

\keywords{Honours, report preparation, \LaTeX}
\categories{A.2, I.7.2}

\begin{document}
\maketitle

\begin{abstract}
This is a short report on how to use the {\tt cshonours.cls} class
to prepare dissertations using the latest \LaTeX\ version,
\LaTeX2e. This class is based on the standard class {\tt report.cls}.
\end{abstract}

\begin{acknowledgements}
This class is designed to produce reports that look
the same as those produced by the older {\tt cshonours.sty} style for
\LaTeX 2.09, which was modified by Nick Spadaccini from a style
provided by Ken Wessen..
\end{acknowledgements}

\tableofcontents
\listoftables  %optional
\listoffigures  %optional

\chapter{The Honours Dissertation Style Guide}

This style was produced to standardize the ``look and
feel'' of dissertations produced by the Honours students of this department.

\section{Getting Started}

The {\tt cshonours} files are located in:
\begin{verbatim}
/cslinux/cstex/local
\end{verbatim}

In order to use the {\tt cshonours} class you need to tell \TeX\ how
to find it. To do this simply add the following to your shell resource
file (ie.\ {\tt .zshrc}, {\tt .bashrc}, etc):
\begin{verbatim}
export TEXINPUTS=$TEXINPUTS:.:/cslinux/cstex//
\end{verbatim}
(The double-slash \verb!//! tells \TeX\ to search the tree from this
point.) Then open a new shell window to run \LaTeX\ in.

If you are using a machine that doesn't mount {\tt cslinux} or a
stand-alone system such as a home machine, you can take a copy of the
{\tt cshonours.cls} file and put it on your own machine. Please copy
the class file directly from the original in the above directory to
make sure you have an unadulterated copy.

Once you have told \TeX\ how to find the class file, the easiest way
to get started is to copy this example file, {\tt cshonours.tex}, and
the accompanying example bibliography file, {\tt cshonours.bib}, from
the above directory, give them a new name, and start modifying the text.

\section{What does it all mean?}
\label{code}

The example file is pretty self explanatory, but here's a little
elucidation for those who are interested.

\begin{verbatim}
\documentclass{cshonours}
\end{verbatim}
\ldots tells \LaTeX\ to use the {\tt cshonours} class. The commands
between here and the \verb!\begin{document}! command are known as the
{\em preamble\/} of the latex document. Font size is automatically set
to 12pt in this class.

\begin{verbatim}
\bibliographystyle{acm}
\end{verbatim}
\ldots sets the bibliography style. Default is the style used in
Transactions of the ACM.

\begin{verbatim}
\usepackage{graphics}  %optional
\end{verbatim}
\ldots this is only needed if you want to include postscript images.

\begin{verbatim}
\title{The Honours Dissertation Class for \LaTeX2e}
\author{Cara MacNish}
\end{verbatim}
\ldots same as usual.

\begin{verbatim}
\keywords{Honours, report preparation, \LaTeX}
\categories{A.2, I.7.2}
\end{verbatim}
\ldots keywords and Computing Reviews classification numbers. These
will be put at the bottom of the abstract page.

\begin{verbatim}
\begin{document}
\end{verbatim}
\ldots so much for the preamble, now we start the document proper.

\begin{verbatim}
\maketitle
\end{verbatim}
\ldots produces the title page using the title and author stored
earlier. Unlike the standard {\tt report} class it also starts roman
page numbering.

\begin{verbatim}
\begin{abstract}
This is a short report...
\end{abstract}
\end{verbatim}
\ldots produces the abstract page, including the keywords and
categories stored earlier.

\begin{verbatim}
\begin{acknowledgements}
This style is designed...
\end{acknowledgements}
\end{verbatim}
\ldots produces the acknowledgements page.

\begin{verbatim}
\tableofcontents
\listoftables  %optional
\listoffigures  %optional
\end{verbatim}
\ldots you guessed it! \verb!\listoftables! and \verb!listoffigures!
can be omitted if you have no tables or figures respectively.

\begin{verbatim}
\chapter{The Honours Dissertation Style Guide}
\end{verbatim}

\ldots and so the first chapter begins. Unlike the standard {\tt
report} class the first \verb!\chapter! command also switches
pagenumbering to arabic.

The main body is created using the usual \LaTeX\ commands. At the end
we come to:

\begin{verbatim}
\appendix
\end{verbatim}
\ldots starts off the appendices.

\begin{verbatim}
\bibliography{cshonours}
\end{verbatim}
\ldots puts in the bibliography, generated in this case from the
file {\tt cshonours.bib}.


\section{Carrying on\ldots}

The rest of the document proceeds in the usual way, with all standard
\LaTeX\ commands available. These are described in~\cite{bible}, which
is written by the author of \LaTeX, Leslie Lamport, and commonly known
as the \LaTeX\ ``Bible''.

For those who are feeling ambitious, a wealth of contributed
packages, some of which are included in our distribution, and some of
which you would need to download yourself, are described
in~\cite{doggie}, commonly known as the ``Doggie Book''.


\section{Including Postscript Files}

Most drawing packages (such as {\tt xfig} and {\tt xpaint}) and image
manipulation packages (such as {\tt xv} and {\tt gimp}) allow you to
save your work as (encapsulated) postscript, which can be easily
included in your \LaTeX\ document. The recommended (and simplest!) way
of doing this is by including the command \verb!\usepackage{graphics}!
in the preamble (see Section~\ref{code}) and then include the
postscript file using the \verb!\includegraphics! command.

\begin{figure}
\begin{center}
\includegraphics{gnu}
\end{center}
\caption{This is a Gnu.}
\label{gnu}
\end{figure}

For example, Figure~\ref{gnu} shows a Gnu, produced by the following code:
\begin{verbatim}
\begin{figure}
\begin{center}
\includegraphics{gnu}
\end{center}
\caption{This is a Gnu.}
\label{gnu}
\end{figure}
\end{verbatim}

\begin{figure}
\begin{center}
\scalebox{0.6}{\includegraphics{gnu}}
\end{center}
\caption{This is a smaller Gnu.}
\label{smallergnu}
\end{figure}

You can scale graphics using the \verb!\scalebox! command. For
example, Figure~\ref{smallergnu} shows a smaller Gnu, produced as follows:
\begin{verbatim}
\begin{figure}
\begin{center}
\scalebox{0.6}{\includegraphics{gnu}}
\end{center}
\caption{This is a smaller Gnu.}
\label{smallergnu}
\end{figure}
\end{verbatim}


\section{Producing Postscript Output}

\LaTeX\ produces a {\tt .dvi} file which you can convert to postscript
using {\tt dvips}. If you have included encapsulated postscript figures the
bounding boxes of those figures sometime confuse the printing
routines. To overcome this it is recommended you use the {\tt -K}
option to strip bounding box comments out. The full recommended format
is:

\begin{verbatim}
dvips -K -f myfile.dvi > myfile.ps
\end{verbatim}

To save typing I just use a simple script for
all my {\LaTeX}ing. Just create a file, called say {\tt laps}, containing something like:
\begin{verbatim}
latex $1
dvips -K -o $1.ps $1.dvi
\end{verbatim}
Then make it executable, run \LaTeX\ with the command
\begin{verbatim}
laps myfile
\end{verbatim}
and view with ghostview (with ``State'' set to ``Watch file'').

\section{Producing PDF}

If you prefer PDF output you can produce this using {\tt
pdfelatex}. This does not use {\tt dvi} as an intermediary so you just
say:
\begin{verbatim}
pdfelatex myfile
\end{verbatim}

Note that any graphics you include must also be in
suitable PDF. There are conversion programs, such as {\tt ps2pdf}, but
I've found they often don't work well. It is better to produce the
graphics directly in {\tt pdf}.

I've also found that {\tt pdf} viewers don't tend to refresh well, so
that you need to keep opening the file. As a result I tend to
postscript where possible.


\section{Emacs and \LaTeX}

Gnu Emacs and Xemacs recognise both {\tt .tex} and {\tt .bib} files,
and provide a number of tools for preparing them. For example you can
select {\tt .bib} entry templates from a drop-down menu. Simple
commands like \verb!C-c C-e! (puts in the \verb!\end! command to
finish an environment) save lots of typing.


\section{Appendices}

After the main body comes the appendices. See Appendix~\ref{appa} and
Appendix~\ref{appb}.

\section{Bibliography}

Finally, the bibliography can be produced automatically from a {\tt .bib} file
using {\tt bibtex} in the usual way. This is described
in~\cite{bible}. 

The bibliography is the only change from the \LaTeX 2.09 {\tt
cshonours} style file. The bibliography now comes after the
appendices, in line with printed books, and uses alphanumeric citation
tags to make reading (and marking) easier.


\appendix

\chapter{Original Honours Proposal}
\label{appa}

You must include as your first appendix an exact copy (in wording) of
your original project proposal. This aids other readers to establish
what was the initial focus of the project.

\chapter{Another Appendix}
\label{appb}

Other appendices might include pseudocode 
for your implementation, a Users Manual, an important data file, etc. 

\bibliography{cshonours}

\end{document}


