JakeHillion/dissertation-4-dissertation
1
0
Fork 0
Code Issues Pull Requests Releases 1 Wiki Activity

1.0 Beta

Browse Source
This commit is contained in:
Krishna Kumar 2013-11-24 23:26:21 +00:00
parent ee0f6ee61f
commit 73c8dd9ea8
8 changed files with 127 additions and 68 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
ChangeLog Normal file
View File

@ -0,0 +1,16 @@
2013/11/24 - Version 1.0 Beta Release
Author(s): Krishna Kumar
* Adaptive Title Page: Title page adapts to title length
* Print / On-line version: Different layout and hyper-referncing styles
* Pre-defined and custom fonts (Times / Palatino / Latin Modern) with math support
* Pre-defined and custom bibliography style support (authoryear / numbered / custom)
* Custom page styles: 3 Different Header / Footer styles
2013/11/14 - Inception
Author(s): Krishna Kumar

2
Chapter3/chapter3.tex
View File

@ -3,7 +3,7 @@
\section{First Section of the Third Chapter}
And now I begin my third chapter here \dots
And now to cite some more people~\citet{Rea85}
And now to cite some more people~\citet{Rea85,Ancey1996}
\subsection{First Subsection in the First Section}
\dots and some more

50
Classes/PhDThesisPSnPDF.cls
View File

@ -13,7 +13,7 @@
% ******************** Class Identification *********************
%\NeedsTeXFormat{LaTeX2e}
\ProvidesClass{PhDThesisPSnPDF}[2013/11/14 version 1.0 by Krishna Kumar]
\ProvidesClass{PhDThesisPSnPDF}[2013/11/24 version 1.0Beta by Krishna Kumar]
\typeout{https://github.com/kks32/phd-thesis-template/}
@ -60,10 +60,6 @@
\newif\ifCU@pageStyleII\CU@pageStyleIIfalse % Set Page StyleI
\DeclareOption{PageStyleII}{\CU@pageStyleIItrue}
% *************************** Eco Mode ****************************
\newif\ifCU@eco\CU@ecofalse % Set Eco Mode to squeeze more text
\DeclareOption{eco}{\CU@ecotrue}
\ProcessOptions\relax%
% ********************* Pre-defined Options **********************
@ -106,20 +102,6 @@
\fi%
% ******************************** Eco Mode **************************************
\ifCU@eco
\usepackage[title=normal]{savetrees} % subtle / moderate /extreme
\linespread{0.9}
\fi
% ************** Set pdfpage and dvips paper sizes ***************
% pdfoutput is defined and not equal to \relax
% check for pdfpageheight existence just in case someone sets pdfoutput
% under non-pdflatex. If exists, set them regardless of value of \pdfoutput.
\@ifundefined{pdfpageheight}{\relax}{\global\pdfpagewidth\paperwidth
\global\pdfpageheight\paperheight}%
% **************************** Print / Online ***************************
% Defines a print / online version to define page-layout and hyperrefering
@ -141,19 +123,15 @@
citecolor=black,
anchorcolor=black
}
\ifCU@eco
\RequirePackage{a4wide}
\else
\if@twoside
\if@twoside
% Odd and Even side Margin staggering for binding and set viewmode for PDF
\RequirePackage[hmarginratio=3:2]{geometry}
\hypersetup{pdfpagelayout=TwoPageRight}
\else
\RequirePackage[hmarginratio=3:2]{geometry}
\hypersetup{pdfpagelayout=TwoPageRight}
\else
% Single side print margin for binding and set view mode for PDF
\RequirePackage[hmarginratio=3:2]{geometry}
\hypersetup{pdfpagelayout=OneColumn}
\fi
\fi
\RequirePackage[hmarginratio=3:2]{geometry}
\hypersetup{pdfpagelayout=OneColumn}
\fi
\else
\RequirePackage{hyperref}
% For PDF Online version
@ -171,13 +149,9 @@
urlcolor=blue,
citecolor=blue,
anchorcolor=green}
\ifCU@eco
\RequirePackage{a4wide}
\else
% No Margin staggering on Odd and Even side
\RequirePackage[hmarginratio=1:1]{geometry}
% No Margin staggering on Odd and Even side
\RequirePackage[hmarginratio=1:1]{geometry}
\hypersetup{pdfpagelayout=OneColumn}
\fi
\fi
@ -222,8 +196,8 @@
% **************************** URL Package and Definition ***********************
\RequirePackage{url}
% Redefining urlstyle to use smaller fontsize in References with URLs
\def\url@leostyle{%
\@ifundefined{selectfont}{\def\UrlFont{\sf}}{\def\UrlFont{\small\ttfamily}}}
\newcommand{\url@leostyle}{%
\@ifundefined{selectfont}{\renewcommand{\UrlFont}{\sf}}{\renewcommand{\UrlFont}{\small\ttfamily}}}
\urlstyle{leo}
% ********************************** Bibliography *******************************

4
Declaration/declaration.tex
View File

@ -7,7 +7,7 @@ I hereby declare that except where specific reference is made to the work of oth
%Permission has been granted by board of graduate studies to exceed the recommended limits 150 figures and to include a CD-ROM in the dissertation. This dissertation is presented less than 65,000 words and 210 figures.
\flushright
Krishna Kumar Soundararajan\\
2014
Krishna Kumar\\
2013
\end{declaration}

6
Preamble/preamble.tex
View File

@ -51,9 +51,9 @@
% *****************************************************************************
% *************************** Bibliography and References ********************
\usepackage{cleveref} %Referencing without need to explicitly state fig /table
\ifsetBib % True it's already set do nothing
\else % custom bibliography style chosen so enter bibstyle here
\RequirePackage[square, sort, numbers, authoryear]{natbib} %author year
\ifsetBib % True, Bibliography option is chosen in class options
\else % If custom bibliography style chosen then load bibstyle here
\RequirePackage[square, sort, numbers, authoryear]{natbib} % CustomBib
\fi

54
README.md
View File

@ -8,9 +8,9 @@ phd-thesis-template
* Print / On-line version: Different layout and hyper-referncing styles
* Custom font and pre-defined fonts (Times / Latin Modern)
* Pre-defined and custom fonts (Times / Palatino / Latin Modern) with math support
* Custom bibliography style support (authoryear / numbered / custom)
* Pre-defined and custom bibliography style support (authoryear / numbered / custom)
* Custom page styles: 3 Different Header / Footer styles
@ -80,8 +80,10 @@ It support the following custom options:
`PhDThesisPSnPDF` currently supports two fonts `Times` and `Latin Modern (default)`.
* `times`: Specifying times option in the document class will use `mathptpx` or `Times` font with Math Support.
* `default (empty)`: When no font is specified, `Latin Modern` is used as the default font with Math Support. The default font is set in preamble with the following condition `ifFontNotSet` is True then default is set as `Latin Modern`. User can change this default font in the preamble.
* `palatino`: Palatino font with math support
* `default (empty)`: When no font is specified, `Latin Modern` is used as the default font with Math Support.
* `customfont`: Any custom font can be set in preamble by using `customfont` option in the document class. Then the custom font can be loaded in preamble.tex in
`\ifsetFont\else \RequirePackage{Your_Custom_Font}\fi`
### Choosing the Bibliography style
@ -100,15 +102,20 @@ It support the following custom options:
* `default (leave empty)`: For Page Numbers in Header (Left Even, Right Odd) and Chapter Name in Header (Right Even) and Section #. Section Name (Left Odd). Blank Footer.
Header (Even) : 4 Introduction
Header (Odd) : 1.2 Section Name 5
Footer : Empty
* `PageStyleI`: For Page Numbers in Header (Left Even, Right Odd) and Chapter Name next to the Page Number on Even Side (Left Even). Section Number and Section Name and Page Number in Header on Odd Side (Right Odd). Footer is empty. Layout:
3 | Introduction and 1.2 Section Name | 4
Header (Even) : 4 | Introduction
Header (Odd) : 1.2 Section Name | 5
Footer : Empty
* `PageStyleII`: Chapter Name on Even Side (Left Even) in Header. Section Number and Section Name in Header on Odd Side (Right Odd). Page numbering in footer. Layout:
Header (Even) : Introduction
Header (Odd) : 1.2 Section Name
Header (Even) : Introduction
Footer[centered]: 3
## Custom Settings
@ -130,8 +137,6 @@ Footer[centered]: 3
* Bibliography with Author-Year Citation in `preamble.tex`:
`\RequirePackage[round, sort, numbers, authoryear]{natbib}`
* You can change the Title of Nomenclature to Notations or Symbols in the `preamble.tex` using:
`\renewcommand\nomname{Symbols}`
## Nomenclature Definition
@ -151,6 +156,9 @@ The sort keys have prefix. In this case a prefix of `g` is used to denote Greek
* `X` or `x`: Other Symbols
* You can change the Title of Nomenclature to Notations or Symbols in the `preamble.tex` using:
`\renewcommand\nomname{Symbols}`
-------------------------------------------------------------------------------
@ -170,8 +178,7 @@ You can also mail
## _Q3_: Can I use my own Makefile?
By all means. We are currently using the very nice (and smart) `Makefile` built
specifically for LaTeX:
Yes please. We are using this nice `Makefile` built specifically for LaTeX:
> [http://code.google.com/p/latex-makefile/](http://code.google.com/p/latex-makefile/)
@ -197,6 +204,27 @@ After you've installed your custom/favourite fonts, add the following command in
You can run the following command:
`ps2ascii thesis.pdf | wc -w`
--------------------------------------------------------------------------------
# Warnings and FAQs
__W1__: I get the ``LaTeX Warning: You have requested document class `Classes/PhDThesisPSnPDF', but the document class provides `PhDThesisPSnPDF'." warning, should I be concerned?
No! Do nothing, or if you don't want any warning messages change the line near the top of the class file to \ProvidesClass{Classes/PhDthesisPSnPDF} if you're not going to install the class file in a more standard location.
__W2__:I get package Fancyhdr Warning: \fancyhead's `E' option without twoside option is useless on input line 321 or 322.. What should I do?
Nothing. The warning is because twoside option is also defined in the class, although only oneside option is currently used.
__W3__: I get Class PhDThesisPSnPDF Warning: Unknown or non-standard option 'something'. Will see if I can load it from the book class. If you get a warning unused global option(s): `eco` then the option is not supported! on input line 91.
You are either trying to use a undefined option or a non-standard option, which is in the book class but not defined in the PhD Thesis Template. If it can be used it will be loaded and you will get no further warnings. If not the option you chose is unavailable.
__W4__: I get LaTeX Warning: Unused global option(s):[something].
You are trying to load an option that is not supported in the PhDThesisClass and the Book Class. Check you spelling!
--------------------------------------------------------------------------------
# Known Issue(s) / Bugs
@ -209,8 +237,4 @@ You can run the following command:
* Support Libertine fonts + Math
* Support eco mode: squeeze more text in a page
* Scale the section sizes by an order when moving from a4paper to a5paper
* Support custom margin

BIN
thesis.pdf
View File

Binary file not shown.

63
thesis.tex
View File

@ -1,4 +1,50 @@
\documentclass[a4paper,12pt,twoside,times,numbered,PageStyleI,eco,print,index]{Classes/PhDThesisPSnPDF}
% ******************************* PhD Thesis Template ************************
% Please have a look at the README.md file for info on how to use the template
\documentclass[a4paper,twoside,12pt,times,numbered,print,index]{Classes/PhDThesisPSnPDF}
% *****************************************************************************
% ******************************* Class Options *******************************
% *****************************************************************************
% `a4paper` or `a5paper` or `letter`: Paper size
%
% `10pt` or `11pt` or `12pt`: Font Size
%
% `oneside` or `twoside`: Printing double side (twoside) or single side.
%
% `print`: Use `print` for print version with appropriate margins and page layout. Leaving the options field blank will activate Online version.
%
% `index`: For index at the end of the thesis
%
% `draft`: For draft mode without loading any images (same as draft in book)
%
% ******************* Choosing the Fonts in Class Options *********************
%
% `times`: For Times font with math support.
%
% `palatino`: For Palatino font
%
% `customfont`: Use `customfont' option in the document class and load the package in the preamble.tex
%
% `default (leave empty)`: When no font is specified, `Latin Modern` is used as the default font with Math Support.
%
% ******************** Choosing the Bibliography style ***********************
%
% `authoryear`: For author-year citation eg., Krishna (2013)
%
% `numbered`: (Default Option) For numbered and sorted citation e.g., [1,5,2]
%
% `custombib`: Define your own bibliography style in the `preamble.tex` file.
% `\RequirePackage[square, sort, numbers, authoryear]{natbib}`
%
% ********************** Choosing the Page Style *********************************
%
% `default (leave empty)`: For Page Numbers in Header (Left Even, Right Odd) and Chapter Name in Header (Right Even) and Section Name (Left Odd). Blank Footer.
%
% `PageStyleI`: Chapter Name next & Page Number on Even Side (Left Even). Section Name & Page Number in Header on Odd Side (Right Odd). Footer is empty.
%
% `PageStyleII`: Chapter Name on Even Side (Left Even) in Header. Section Number and Section Name in Header on Odd Side (Right Odd). Page numbering in footer
% ********************************* Preamble **********************************
% Preamble: Contains packages and user-defined commands and settings
@ -6,8 +52,8 @@
% ******************** Thesis Information & Meta-data *************************
%% The title of the thesis
\title{Multiscale Modelling of \texorpdfstring{\\}{}Granular Flows}
\title{ How to write your thesis in \texorpdfstring{\\ \LaTeX}{LaTeX}}
%\texorpdfstring is used for PDF metadata and \\ creates a new line
%% The full name of the author
\author{Krishna Kumar}
@ -29,11 +75,11 @@
\college{King's College}
%% Submission date
\degreedate{Yet to be decided}
\degreedate{2013}
%% Meta information
\subject{GeoMechanics}
\keywords{{Material Point Method} {Lattice Boltzmann} {Multi-scale} {Multiphase} {Granular Flows}}
\subject{LaTeX}
\keywords{{LaTeX} {PhD Thesis} {Engineering} {University of Cambridge}}
% ********************************Front Matter************************************
@ -86,10 +132,10 @@
\begin{spacing}{0.9}
\bibliographystyle{apalike}
%\bibliographystyle{plainna}
%\bibliographystyle{plainnat}
\renewcommand{\bibname}{References}% changes default name Bibliography-> References
\cleardoublepage
\bibliography{References/References}
\bibliography{References/References} % Path to your References.bib file
\end{spacing}
@ -97,4 +143,3 @@
\printthesisindex
\end{document}