Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Tweaks to comply with Cambridge BGS regs 2020 #215

Open
wants to merge 6 commits into
base: master
Choose a base branch
from
Open

Tweaks to comply with Cambridge BGS regs 2020 #215

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
d5f0ae4
Tweaks to comply with Cambridge BGS regs 2020
deryckchan Dec 2, 2020
5d4c571
Update PhDThesisPSnPDF.cls
deryckchan Dec 15, 2020
e840faa
Make ntabstract the default
deryckchan Jan 4, 2021
dc49874
Make ntabstract the default
deryckchan Jan 4, 2021
f5ac2a2
nontabstract
deryckchan Jan 4, 2021
4d62feb
ntabstracttrue is now default
deryckchan Jan 4, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 29 additions & 11 deletions PhDThesisPSnPDF.cls
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,15 @@
%% %%
%% A PhD thesis LaTeX template for Cambridge University Engineering Department%%
%% %%
%% Version: v2.4 %%
%% Version: v2.5 %%
%% Authors: Krishna Kumar %%
%% License: MIT License (c) 2016-2018 Krishna Kumar %%
%% GitHub Repo: https://github.com/kks32/phd-thesis-template/ %%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

% ************************** Class Identification ******************************
\newcommand\fileversion{2.4}
\newcommand\filedate{2018/04/12}
\newcommand\fileversion{2.5}
\newcommand\filedate{2020/12/02}
\NeedsTeXFormat{LaTeX2e}
\ProvidesClass{PhDThesisPSnPDF}[\filedate\space A PhD thesis class file
by Krishna Kumar (v\fileversion)]
Expand Down Expand Up @@ -224,6 +224,11 @@ footnotes.}
\DeclareOption{lineno}{\PHD@linenotrue}
\DeclareOption{nolineno}{\PHD@linenofalse}

% Declare new Boolean variable to allow separate toggle
% to include author name and title in abstract,
% i.e. Cambridge BGS style
\newif\ifntabstract\ntabstractfalse
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
\newif\ifntabstract\ntabstractfalse
\newif\ifPHD@abstracttitle\PHD@abstracttitletrue
\DeclareOption{abstracttitle}PHD@abstracttitletrue}
\DeclareOption{noabstractitle}{\PHD@abstracttitlefalse}

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should have abstract title on by default as per the university guidelines, so let's have it turned to true.

\DeclareOption{ntabstract}{\ntabstracttrue}

% Generates Warning for unknown options
\DeclareOption*{
Expand Down Expand Up @@ -622,8 +627,12 @@ supported!}
\ifsetCustomMargin
% Margin to be define in preamble using geometry package
\else
\RequirePackage[paper=\PHD@papersize,hmarginratio=1:1,
vmarginratio=1:1,scale=0.75,bindingoffset=5mm]{geometry}
% Edited DYC 2020 so print and online versions have the same
% body space per page
\RequirePackage[paper=\PHD@papersize,hmarginratio=1:1,
vmarginratio=1:1,vscale=0.75,width=157mm,bindingoffset=5mm]{geometry}
% \RequirePackage[paper=\PHD@papersize,hmarginratio=1:1,
deryckchan marked this conversation as resolved.
Show resolved Hide resolved
% vmarginratio=1:1,scale=0.75,bindingoffset=5mm]{geometry}
\fi

\if@twoside
Expand Down Expand Up @@ -655,8 +664,12 @@ supported!}
% Margin to be define in preamble using geometry package
\else
% No Margin staggering on Odd and Even side
% Edited DYC 2020 so print and online versions have the same
% body space per page
\RequirePackage[paper=\PHD@papersize,hmarginratio=1:1,
vmarginratio=1:1,scale=0.75]{geometry} % dvips
vmarginratio=1:1,vscale=0.75,width=157mm]{geometry} % dvips
% \RequirePackage[paper=\PHD@papersize,hmarginratio=1:1,
deryckchan marked this conversation as resolved.
Show resolved Hide resolved
% vmarginratio=1:1,scale=0.75]{geometry} % dvips
\fi
\hypersetup{pdfpagelayout=OneColumn}
\fi
Expand Down Expand Up @@ -1102,10 +1115,11 @@ wish to left align your text}
% The abstract environment puts a large, bold, centered "Abstract" label at
% the top of the page. Defines both abstract and separate abstract environment

% To include only the Title and the abstract pages for submission to BoGS
% To include only the abstract pages for submission to BoGS
\ifPHD@abstract
\defineAbstracttrue
% Disable the table of contents, figures, tables, index and nomenclature
% Disable the title, table of contents, figures, tables, index and nomenclature
\renewcommand{\maketitle}{} % Added by DYC 2020
\renewcommand{\tableofcontents}{}
\renewcommand{\listoffigures}{}
\renewcommand{\listoftables}{}
Expand All @@ -1114,14 +1128,18 @@ wish to left align your text}
\renewcommand{\printthesisindex}{}
\renewcommand{\bibname}{}
\renewcommand{\bibliography}[1]{\thispagestyle{empty}}

% Turn on name and title on abstract (DYC 2020)
\ntabstracttrue
deryckchan marked this conversation as resolved.
Show resolved Hide resolved
\else
\defineAbstractfalse
\fi


\newenvironment{abstract} {
\ifPHD@abstract
% Separate abstract as per Student Registry guidelines
\ifntabstract
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since this is set as default, we don't need it here

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is still needed for the "compile the entire thesis and don't put my name and thesis title onto the abstract page" combination to work.

% Print name and title on abstract, whether when
% abstract is standalone or toggled by ntabstract option
% (per Student Registry guidelines)
\thispagestyle{empty}
\setsinglecolumn
\begin{center}
Expand Down
22 changes: 14 additions & 8 deletions thesis.tex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,10 @@
% `abstract': To generate only the title page and abstract page with
% dissertation title and name, to submit to the Student Registry
%
% `ntabstract': To add name and title to abstract page
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

abstracttitle and noabstracttitle

% even when bound into thesis (required by Cambridge Uni
% hardbound submission)
%
% `chapter`: This option enables only the specified chapter and it's references
% Useful for review and corrections.
%
Expand Down Expand Up @@ -87,13 +91,13 @@
\input{thesis-info}

% ***************************** Abstract Separate ******************************
% To printout only the titlepage and the abstract with the PhD title and the
% To printout only the abstract with the PhD title and the
% author name for submission to the Student Registry, use the `abstract' option in
% the document class.

\ifdefineAbstract
\pagestyle{empty}
\includeonly{Declaration/declaration, Abstract/abstract}
\includeonly{Abstract/abstract}
\fi

% ***************************** Chapter Mode ***********************************
Expand All @@ -104,6 +108,8 @@

\ifdefineChapter
\includeonly{Chapter3/chapter3}
% You can put multiple files into this command, e.g.
% \includeonly{Declaration/declaration, Chapter3/chapter3}
\fi

% ******************************** Front Matter ********************************
Expand All @@ -115,8 +121,8 @@

\include{Dedication/dedication}
\include{Declaration/declaration}
\include{Acknowledgement/acknowledgement}
\include{Abstract/abstract}
\include{Acknowledgement/acknowledgement}

% *********************** Adding TOC and List of Figures ***********************

Expand All @@ -126,10 +132,8 @@

\listoftables

% \printnomenclature[space] space can be set as 2em between symbol and description
%\printnomenclature[3em]

\printnomenclature
% \printnomencl[space] space can be set as 2em between symbol and description
\printnomencl[3em]

% ******************************** Main Matter *********************************
\mainmatter
Expand Down Expand Up @@ -167,7 +171,9 @@
% specified in the preamble.tex file in the custombib section.
% Comment out the lines related to natbib above and uncomment the following line.

%\printbibliography[heading=bibintoc, title={References}]
%\ifdefineAbstract\else \printbibliography[heading=bibintoc, title={References}] \fi
% The if command on the previous line is required because
% biber package is invoked after calling the class definition


\end{spacing}
Expand Down