A LaTeX document class that conforms to the Computer Laboratory's PhD thesis formatting guidelines.
TeX Shell Makefile
Latest commit f115b71 Dec 22, 2016 @urbas urbas committed on GitHub Merge pull request #33 from cambridge/feature/techreport-firstyr-samples
Feature/techreport firstyr samples
Permalink
Failed to load latest commit information.
CollegeShields
Samples
.travis.script.sh
.travis.yml Extracted the travis build into a script. Sep 4, 2016
CONTRIBUTING.md Fixes a typo in CONTRIBUTING.md. Oct 15, 2016
License - Licensed all relevant files with the Simplified BSD License. May 6, 2011
Makefile Forces makeindex et al before going into loop. Dec 22, 2016
README.md Adds links to techreport and firstyr samples. Dec 22, 2016
cam-thesis.cls Fixes a broken else-if in firstyr. Dec 22, 2016
thesis.bib - Initial commit. May 5, 2011
thesis.tex

README.md

cam-thesis

Build Status

a LaTeX thesis template for Cambridge PhD students

Want to write a thesis? Here is what you need:

  1. this template (just clone it with git),
  2. one of the existing samples (which can be found in the ./Samples/ folder), and
  3. some research content.

The samples are based on other PhD students' theses.

Quick start

Copy all files from this directory (where you found this README file) to your desired location.

Now you can start writing your thesis using the thesis.tex file.

Finally, build the PDF document by running the following in the command line:

make

How will it look like?

Your thesis document will look something like this:

Plain (PDF)

If you use the clean sample, which can be found in ./Samples/clean, it will look like this:

Sample Clean (PDF)

The template also supports DVI and PS formats. All three formats can be generated with the provided Makefile.

Producing PDF, DVI and PS documents

Build your thesis

To build the PDF version of your thesis, run:

make

This build procedure uses pdflatex and will produce thesis.pdf.

To produce DVI and PS versions of your document, you should run:

make thesis.ps

This will use the latex and dvips commands to build the document and will produce thesis.dvi and thesis.ps documents.

Clean unwanted files

To clean unwanted clutter (all LaTeX auto-generated files), run:

make clean

Usage details

Class options

cam-thesis supports all the options of the standard report class (on which it is based).

It also supports some custom options.

  • techreport: formats the document as a technical report (here's a sample). Here is a list of formatting points in which the technical report differs from a normal thesis (see guidelines for more information):

    • different margins (left and right margins are 25mm, top and bottom margins are 20mm),
    • normal line spacing (instead of one-half spacing),
    • no custom title page,
    • no declaration,
    • page count starts with 3,
    • if the hyperref package is used, the option pdfpagelabels=false will be passed to it.
  • firstyr: formats the document as a first-year report (here's a sample). This option removes some unneeded elements and modifies the submission note. Here is a list of formatting points in which the first year report differs from a normal thesis:

    • an appropraite subtitle is added,
    • the submission note is changed appropriately,
    • no standalone abstract,
    • no declaration,
    • no acknowledgements.
  • times: tells the class to use the times font.

  • glossary: puts the glossary after the TOC. The glossary contains a list of abbreviations, their explanations etc. Describe your abbreviations and add them to the glossary immediately after you introduce them in the body of your thesis. You can use the following command for this:

    \newglossaryentry{computer}
    {
      name=computer,
      description={is a programmable machine that receives input,
                   stores and manipulates data, and provides
                   output in a useful format}
    }
    

    After that, you can reference particular glossary entries like this:

    \gls{computer}
    

    You can also change the glossary style. For example, try putting this on the very top of the preamble (even before you define the document class with \documentclass[glossary]{cam-thesis}):

    \PassOptionsToPackage{style=altlong4colheader}{glossaries}
    

    Further instructions can be found on LaTeX Wikibooks or the user manual at CTAN.

    Note: glossaries is the package used to create the glossary.

  • withindex: build the index, which you can put at the and of the thesis with the following command (it will create a new unnumbered chapter):

    \printthesisindex
    

    Instructions on how to use the index can be found here.

    Note: the package makeidx is used to create the index.


Troubleshooting

Q1: I found a bug in the template. Where do I report bugs?

You can report issues through our GitHub repository.

You can also mail the maintainers directly.

Q2: Where can I find the thesis formatting guidelines this class is based on?

The University of Cambridge guidelines:

http://www.admin.cam.ac.uk/students/studentregistry/exams/submission/phd/format.html

The Computer Laboratory guidelines:

http://www.cl.cam.ac.uk/local/phd/typography/

The Computer Laboratory guidelines for technical reports:

http://www.cl.cam.ac.uk/techreports/submission.html

Q3: Can I use my own Makefile?

By all means. Previously we used the horrendously complex Makefile at

http://code.google.com/p/latex-makefile/

Q4: But what if I don't want the template files in my thesis directory?

Put the files and folders listed below into a directory where LaTeX can find them (for more info see [1]):

cam-thesis.cls
CollegeShields/

[1] You can put these files either into the standard LaTeX directory for classes [2], or a directory listed in your TEXINPUTS environment variable.

[2] The location of the standard LaTeX class directory depends on which LaTeX installation and operating system you use. For example, for TeX Live on Fedora 14 it is /usr/share/texmf/tex/latex/base.

In any case, after this, LaTeX will still not be able find your class. You will have to rebuild the package index. This procedure also depends on your installation specifics, but for TeX Live you have to run the texhash command.

For more comprehensive information refer to LaTeX Wikibooks.

Q5: Where can I find newer versions of the University of Cambridge logo?

The university updates its logo every now and then. You can find up-to-date logos on this page (subject to change without notice).

Download and exchange the new logos with CUni.eps and/or CUni.pdf.

Q6: My college's shield/coat of arms/crest is not included. Why u no include it?

The shields are being added on the go (when somebody, who uses them, provides them).

If you find a distributable vector-based image of your college's shield you can report it as an issue or mail it to contributors directly (refer to question Q1 above).

Q7: Where can I find extra fonts (like Adobe Sabon, Adobe Utopia etc.)?

The Computer Laboratory provides some here.

After you've installed the fonts, add somewhere in the preamble (before \begin{document}) the following command:

\renewcommand\rmdefault{psb}

Q8: How should I count the number of words in my thesis?

There is a page on the Computer Lab's web site. They recommend using this command:

ps2ascii thesis.pdf | wc -w

TODO list

  • Fill out more PDF meta tags (e.g.: keywords, subject etc.).