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.

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

Conversation

deryckchan
Copy link

@deryckchan deryckchan commented Dec 2, 2020

Hardbound thesis submission formatting requirements from Cambridge University Board of Graduate Studies have changed since this template was last updated in 2018. Some of the changes could not be satisfied without modifying the class file, so this patch tweaked some details to provide functionality to comply with the latest Cambridge regulations.

Changes include:

  • abstract option (abstract-only mode) now hides title page, nomenclature, and references as well (class file and thesis.tex)
  • New class option ntabstract to print name and title onto abstract even when bound into the whole thesis (class file)
  • Abstract now comes before Acknowledgements (thesis.tex)
  • Default horizontal margins now defined using width rather than ratio, so that bindingoffset no longer causes print and web editions to have different pagination. (class file)

I can update CHANGELOG and README as well if this pull request is committed into the master branch.

Hardbound thesis submission formatting requirements from Cambridge University Board of Graduate Studies have changed since this template was last updated in 2018. Some of the changes could not be satisfied without modifying the class file, so this patch tweaked some details to provide functionality to comply with the latest Cambridge regulations.

Changes include:
- `abstract' option (abstract-only mode) now hides title page, nomenclature, and references as well (class file and thesis.tex)
- New class option `ntabstract' to print name and title onto abstract even when bound into the whole thesis (class file)
- Abstract now comes before Acknowledgements (thesis.tex)
- Default horizontal margins now defined using `width' rather than `ratio', so that bindingoffset no longer causes print and web editions to have different pagination. (class file)
@kks32
Copy link
Owner

kks32 commented Dec 6, 2020

@deryckchan Thank you for the changes, much appreciated. I would like to verify the following, as the guidelines still include these in the submission: https://www.cambridgestudents.cam.ac.uk/your-course/examinations/graduate-exam-information/after-examination/degree-approval-and-1

It still says we need to submit a title page, declaration and the abstract. Could you please provide a link to the new guidelines where it says we don't need those?

Thanks again!

@kks32 kks32 self-assigned this Dec 6, 2020
@deryckchan
Copy link
Author

Hello @kks32 ! It's the same guideline page that you linked to. Notice that "title page" and "declaration" are mentioned in the "Bound inside the thesis" section but not the "Loose with the thesis" section. Hence I've made abstract mode strip literally everything except the abstract.

Also point 4 of "Bound inside of the thesis" says "Summary/Abstract with your name and thesis title on it", and then the next section "Loose with the thesis" says "Summary/Abstract (the same as the one you have bound in to your thesis)". Hence the ntabstract toggle (so that people submitting for other degrees / institutions can still have an abstract section that says "Abstract" rather than their name if they wish). Searching for +latex +"ntabstract" returns precisely zero results so the option name shouldn't conflict with any package one may want to invoke alongside this thesis template.

PhDThesisPSnPDF.cls Outdated Show resolved Hide resolved
PhDThesisPSnPDF.cls Outdated Show resolved Hide resolved
Remove commented out margin specs per @kks32
@deryckchan
Copy link
Author

@kks32 Done, please review and merge.

Copy link
Owner

@kks32 kks32 left a comment

Choose a reason for hiding this comment

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

@deryckchan Thank you so much, sorry to ask you for further changes.

Since the university requirement is to have title in the abstract, let's make sure it's enabled by default and could you please use the same styling \PHD@abstracttitle similar to \PHD@lineno used previously in the template?

Also, could you please add abstracttitle and noabstracttitle to the README as well.

Thank you so much for your contribution!

% 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.

PhDThesisPSnPDF.cls Outdated Show resolved Hide resolved
\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.

thesis.tex Outdated
@@ -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

@deryckchan
Copy link
Author

I'm slightly concerned I might mess up the mixture of comment / suggested changes. Do you mind doing all of them as suggested changes so I can click commit (to my patch)?

@pwichmann
Copy link

Has this now been merged? If not, are there any conflicts / problems?

@deryckchan
Copy link
Author

@deryckchan Thank you so much, sorry to ask you for further changes.

Since the university requirement is to have title in the abstract, let's make sure it's enabled by default and could you please use the same styling \PHD@abstracttitle similar to \PHD@lineno used previously in the template?

Happy new year! I've looked into this in more depth. I've changed the default to \ntabstracttrue and added a nontabstract option.

However, it was a conscious decision to use \ifntabstract rather than the PHD@optionname nomenclature in this case, because:

  • Conditional variables with @ in them cannot be accessed outside the files in which they were declared. I can imagine there will be users who want to include other conditional statements in their abstract page depending on which abstract page format it is;
  • The variable name abstracttitle is used by a number of other LaTeX thesis templates for quite different meanings, e.g. K-State thesis template; tikz abstract box tutorial, so I thought it would be best to avoid that name, and instead coin a new name that means "Name and Title on ABSTRACT".

@deryckchan
Copy link
Author

Has this now been merged? If not, are there any conflicts / problems?

@pwichmann - Not yet, @kks32 and I are having a discussion (as you can see here) about default behaviour and variable naming. A working copy of the template including my amendments can be found in my fork.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants