Git Product home page Git Product logo

thesis's Introduction

cam-thesis

builder

a LaTeX thesis template for Cambridge PhD students

Quick start

  1. Clone this repository.

  2. Start adding contents of your thesis into thesis.tex.

  3. Build the PDF by running the following in the command line:

    make
    
  4. Open thesis.pdf.

Pro tip: you can use one of the samples in the Samples directory.

How will the thesis 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.
  • secondyr: formats the document as a second-year report (here's a sample). Similarly to firstyr, this style modifies the submission note and removes unneeded elements. Specially, an abstract is retained (as for this report, research is often in a more "stable" state). Here is a list of formatting points in which the second year report differs from a normal thesis:

    • an appropraite subtitle is added,
    • the submission note is changed appropriately,
    • 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.

  • backrefs: Add back references in the References section (here's a sample). In other words, for each reference, it adds the page(s) where it is cited.

    Note: the package backref is used to create the back references.


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 submission guidelines:

https://www.cambridgestudents.cam.ac.uk/your-course/examinations/graduate-exam-information/submitting-and-examination/phd-msc-mlitt/submit

The University of Cambridge final submission guidelines:

https://www.cambridgestudents.cam.ac.uk/your-course/examinations/graduate-exam-information/after-examination/degree-approval-and-1

The Computer Laboratory guidelines:

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

The Computer Laboratory guidelines for technical reports:

https://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 a vector-based image. Why u no include it?

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.

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

Q9: How can I change the College Shield?

In thesis.tex use \collegeshield{CollegeShields/<college>} with <college> as your your desired college name, as found in CollegeShields.

Alternatively, \collegeshield{CollegeShields/CUniNoText} can be used to display the University of Cambridge shield design.

thesis's People

Contributors

aaronstockdill avatar alexkuhnle avatar chatcannon avatar cmangla avatar drt24 avatar j5b avatar jzstark avatar mgkuhn avatar ryangibb avatar simonepri avatar skollmann avatar steffenloesch avatar tjiagom avatar urbas avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

thesis's Issues

Suggestion for bibliography

What about changing the bibliography style from plain to plainnat?
This would allow us to use some handy things like \citeauthor{}
What do you think, @urbas ?

Margin widths don't match those suggested by J S Wilson

I notice that, when the document is not a technical report, the odd, even, top and bottom margins are 35mm, 30mm, 35mm, 25mm, respectively, while J S Wilson suggests 30mm, 20mm, 20mm and 20mm. You might want to change the margins to match this recommendation if there isn't a good reason why they don't. Thanks for this template, by the way -- it has saved me a lot of time!

Command \printindex already defined

Hello,
i'm really would like to use this thesis template, but i get an error while trying to compile the sources.
I have no idea what to do, even tried to remove \printindex occurences, but doesn't work neither.
Here's the full output of my error :

$ make
NOTE: You may ignore warnings about the following files:
thesis.d
Makefile:2556: thesis.d: No such file or directory
= thesis.tex --> thesis.d thesis.pdf.1st.make (0-1) =
= thesis.glo --> thesis.gls =
= thesis.idx --> thesis.ind =
= thesis.tex --> thesis.d thesis.pdf.1st.make (1-1) =
= thesis.bib thesis.aux --> thesis.bbl =
/usr/share/texlive/texmf-dist/tex/latex/glossaries/base/glossaries.sty:1413: LaTeX Error: Command \printindex already defined.
Or name \end... illegal, see p.192 of the manual.
make: *** [thesis.pdf] Error 1

It gives the same \printindex issue when using makepdf or makeps.

Thanks for help,

eoutin

License terms with respect to a PDF file produced with the cam-thesis template

The current license states that "Redistributions in binary form must reproduce the above copyright notice". Based on that, one could state that a distributed PDF file, as a binary form of distribution of the cam-thesis template, should include the copyright notice and acknowledge the use of the cam-thesis repository.

Could you tell how the cam-thesis license relates to PDF files produced with the help of the cam-thesis repository? If you expect such files to include the copyright notice, what would be your recommended way to do so?

Thank you for maintaining this repository.

University of Cambridge logo should not be added to the title page

@RyanGibb reports that the University of Cambridge has banned their arms/shield/logo appearing on PhD dissertations.

Please note that the University logo should not be used as your thesis is your work and not the work of the University. If you wish to use a logo on your title page, you are advised to ask your College about the use of their logo.[0]

[0] https://www.cambridgestudents.cam.ac.uk/your-course/examinations/graduate-exam-information/submitting-and-examination/phd-msc-mlitt/submit

Suggestion of small change in layout

If the title has more than one line, I think it has too much space. So, I would suggest changing line 361 of cam-thesis.cls to the following:

       \begin{spacing}{1}
            	{\Huge%
                    \ifcam@times\else%
                        \bfseries%
                    \fi%
                 {\@title{}}%
                 \ifcam@firstyr\\%
                 {\vspace{5mm}\emph{\LARGE PhD Proposal}}%
                 \fi}%
        \end{spacing}

Basically, I changed \begin{spacing}{2} to \begin{spacing}{1}. And I added the \vspace{5mm} so the PhD Proposal subtitle still has a space before.

For hardbound thesis: abstract page should include the dissertation title and author name

http://www.cambridgestudents.cam.ac.uk/your-course/examinations/graduate-exam-information/submitting-and-examination/phd-msc-mlitt/submit#hardbound

What are the requirements for the hardbound submission?

The minimum requirements for the Hardbound thesis are as follows:

  • [... omitted requirements for the binding process ...]
  • a completed Deposit and Copying of Dissertation Declaration Form - this form must be bound inside each copy of the thesis as the very first page - that is, before the title page. [...]
  • a copy of your Summary/Abstract with your name and dissertation title on it. This must be bound inside the thesis following the title page

Declaration page uses "thesis" instead of "dissertation".

The declaration, which is in the style and is therefore not normally editable, has a few problems.
One is that it uses "thesis" instead of "dissertation" which is specified http://www.admin.cam.ac.uk/students/studentregistry/exams/submission/phd/submitting.html. Dissertation is technically the correct term, I believe.

Furthermore there is no space between the declaration and the name for a signature.

My supervisor (Simon Moore) also was not familiar with the list format and expected a paragraph. Is the list format non-standard?

I've got:
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%
%% Declaration
%%
%%%%%
\ifcam@techreport
% Technical report doesn't need the declaration
% (see http://www.cl.cam.ac.uk/techreports/submission.html).
\else
\chapter*{Declaration}
\thispagestyle{empty}
This dissertation is my own work and contains nothing which is the outcome of work done in collaboration with others, except where specified in the text. This dissertation is not substantially the same as any that I have submitted for a degree or diploma or other qualification at any other university. This dissertation does not exceed the prescribed limit of 60,000 words.
\begin{flushright}
\vskip 4cm
@author{}
@Date{}
\end{flushright}
\vfill
\fi

.cls missing files

Hi,
I am trying to use Cambridge thesis template for First-year submission. However, when is change tag to \documentclass[withindex,glossary]{firstyr}, Overleaf is reporting an error saying firstyr.cls is missing.

cls files are missing

Suggestion about glossary layout

I suggest to change the line 142 of cam-thesis.cls to the following:

\newcommand{\printthesisglossary}{\printglossary[nonumberlist]}

Basically I added the option nonumberlist to \printglossary. I think that what is useful is to have just a list of names for the glossary, there's no need to have all the page numbers with the places where the names are used. This might turn in a ugly glossary page if the name is used everywhere in the thesis.

Suggestion on solving some underfull \vbox

In my report I got some pages in which the paragraphs had to be stretched to fill the whole page. This meant that some unexpected spaces between paragraphs appeared. Searching a little bit, it seems the correct way to handle this situation is using the \raggedbottom option (which, in my case, completely solved my problem).

Using this command means that the pages might not have all the same size in terms of text content. But in the case of reports like this one, it seems it is much nicer to have a regular space between paragraphs rather than some pages with stretched paragraphs.

What do you think?

Use package microtype

I've come to some words that went outside the document's margin and the problem was solved by including a package that I have been using until now: microtype. I want to suggest to include that in the .cls style file. What do you think?

A link with some highlights of the package: http://www.khirevich.com/latex/microtype/
(It really shows a lot of parameters we can benefit from the package, but only its inclusion seems already very positive)

Adding numbers to (sub)sections?

Hi, I was just wondering how you would edit this template to include numbering in the section and subsection headings. I realise these are already present in the ToC but is there an easy way to enable them?

Using the simple or clean template that was provided by the way.

Thanks,
Mike.

University Logo not to be centered on page

The University Logo, consisting of the shield and the "UNIVERSITY OF CAMBRIDGE" text to the right of it, was not designed to be used in the centre of the page (as you currently do on the title page). It actually looks pretty painful to me when used centred near other centred text, as it is highly asymmetric in a symmetric structure. If you want to use the full logo, it really belongs into a corner of the page (Communications Office suggest top-left or top-bottom).

https://www.cam.ac.uk/brand-resources/guidelines/using-the-logo

Question about crests

Hi, just a quick question: is there any reason to have many different formats for the crests when only PDF is actually used? In my last commit I actually put both PDFs and SVGs but actually it seems I didn't need to. And as PDF is also a vector document (like svg), nothing is lost, right? :p

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.