How to install the templates, additions to appendix

This commit is contained in:
Krishna Kumar 2013-12-07 12:25:57 +00:00
parent 02c9c812f0
commit 87148f4ce2
9 changed files with 3883 additions and 1837 deletions

1
.gitignore vendored
View File

@ -14,7 +14,6 @@
*.d
*.btmp
*.fls
*.dvi
*.glo
*.idx
*.ist

View File

@ -1,6 +1,12 @@
% ******************************* Thesis Appendix A ********************************
\chapter{Appendix A}
\chapter{Appendix A\texorpdfstring{\\ }{: }Installing the CUED Class file}
and here I put a bit of postamble ...
\LaTeX.cls files can be accessed system-wide when they are placed in the
<texmf>/tex/latex directory, where <texmf> is the root directory of the users \TeX installation. On systems that have a local texmf tree (<texmflocal>), which
may be named ``texmf-local'' or ``localtexmf'', it may be advisable to install packages in <texmflocal>, rather than <texmf> as the contents of the former, unlike that of the latter, are preserved after the \LaTeX system is reinstalled and/or upgraded.
It is recommended that the user create a subdirectory <texmf>/tex/latex/CUED for all CUED related \LaTeX class and package files. On some \LaTeX systems, the directory look-up tables will need to be refreshed after making additions or deletions to the system files. For \TeX Live systems this is accomplished via executing ``texhash'' as root. MIK\TeX users can run ``initexmf -u'' to accomplish the same thing.
Users not willing or able to install the files system-wide can install them in their personal directories, but will then have to provide the path (full or relative) in addition to the filename when referring to them in \LaTeX.

View File

@ -1,5 +1,110 @@
% ******************************* Thesis Appendix B ********************************
\chapter{Appendix B}
\chapter{Appendix B: How to install \LaTeX}
and here I put some more postamble ...
\section*{Windows OS}
\subsection*{TeXLive package - full version}
\begin{enumerate}
\item Download the TeXLive ISO (2.2GB) from\\
\href{https://www.tug.org/texlive/}{https://www.tug.org/texlive/}
\item Download WinCDEmu (if you don't have a virtual drive) from \\
\href{http://wincdemu.sysprogs.org/download/}{http://wincdemu.sysprogs.org/download/}
\item To install Windows CD Emulator follow the instructions at\\
\href{http://wincdemu.sysprogs.org/tutorials/install/}{http://wincdemu.sysprogs.org/tutorials/install/}
\item Right click the iso and mount it using the WinCDEmu as shown in \\
\href{http://wincdemu.sysprogs.org/tutorials/mount/}{http://wincdemu.sysprogs.org/tutorials/mount/}
\item Open your virtual drive and run setup.pl
\end{enumerate}
or
\subsection*{Basic MikTeX - TeX distribution}
\begin{enumerate}
\item Download Basic-MiK\TeX (32bit or 64bit) from \href{http://miktex.org/download}{http://miktex.org/download}
\item Run the installer
\item To add a new package go to Start >> All Programs >> MikTex >> Maintenance (Admin) and choose Package Manager
\item Select or search for packages to install
\end{enumerate}
\subsection*{TexStudio - Tex Editor}
\begin{enumerate}
\item Download TexStudio from \href{http://texstudio.sourceforge.net/\#downloads}{http://texstudio.sourceforge.net/\#downloads}
\item Run the installer
\end{enumerate}
\section*{Mac OS X}
\subsection*{MacTeX - TeX distribution}
\begin{enumerate}
\item Download the file from \href{http://mirror.ctan.org/systems/mac/mactex/MacTeX.pkg}{http://mirror.ctan.org/systems/mac/mactex/MacTeX.pkg}
\item Extract and double click to run the installer. It does the entire configuration, sit back and relax.
\end{enumerate}
\subsection*{TexStudio - Tex Editor}
\begin{enumerate}
\item Download TexStudio from \href{http://texstudio.sourceforge.net/\#downloads}{http://texstudio.sourceforge.net/\#downloads}
\item Extract and Start
\end{enumerate}
\section*{Unix/Linux}
\subsection*{TeXLive - TeX distribution}
\subsubsection*{Getting the distribution:}
\begin{enumerate}
\item TexLive can be downloaded from \href{http://www.tug.org/texlive/acquire-netinstall.html}{http://www.tug.org/texlive/acquire-netinstall.html}. You might require wget to download through proxies.
\item TexLive DVD is also available in the Grad Suite
\item TexLive is provided by most operating system you can use (rpm,apt-get or yum) to get TexLive distributions
\end{enumerate}
\subsubsection*{Installation}
\begin{enumerate}
\item Mount the ISO file in the mnt directory
\begin{verbatim}
mount -t iso9660 -o ro,loop,noauto /your/texlive####.iso /mnt
\end{verbatim}
\item Install wget on your OS (use rpm, apt-get or yum install)
\item Run the installer script install-tl.
\begin{verbatim}
cd /your/download/directory
./install-tl
\end{verbatim}
\item Enter command `i' for installation
\item Post-Installation configuration:\\ \href{http://www.tug.org/texlive/doc/texlive-en/texlive-en.html\#x1-320003.4.1}{http://www.tug.org/texlive/doc/texlive-en/texlive-en.html\#x1-320003.4.1}
\item Set the path for the directory of TexLive binaries in your .bashrc file\\
\textbf{For 32Bit OS}\\
For Bourne-compatible shells such as bash, and using Intel x86 GNU/Linux and a default directory setup as an example, the file to edit might be \begin{verbatim}
edit $~/.bashrc file and add following lines
PATH=/usr/local/texlive/2011/bin/i386-linux:$PATH;
export PATH
MANPATH=/usr/local/texlive/2011/texmf/doc/man:$MANPATH;
export MANPATH
INFOPATH=/usr/local/texlive/2011/texmf/doc/info:$INFOPATH;
export INFOPATH
\end{verbatim}
\textbf{For 64Bit}
\begin{verbatim}
edit $~/.bashrc file and add following lines
PATH=/usr/local/texlive/2011/bin/x86_64-linux:$PATH;
export PATH
MANPATH=/usr/local/texlive/2011/texmf/doc/man:$MANPATH;
export MANPATH
INFOPATH=/usr/local/texlive/2011/texmf/doc/info:$INFOPATH;
export INFOPATH
\end{verbatim}
\end{enumerate}
%\subsection{Installing directly using Linux packages}
\subsubsection*{Fedora/RedHat/CENTOS:}
\begin{verbatim} sudo yum install texlive \end{verbatim}
\subsubsection*{SUSE:}
\begin{verbatim} sudo zypper install texlive \end{verbatim}
\subsubsection*{Debian/Ubuntu:}
\begin{verbatim} sudo apt-get install texlive \end{verbatim}

View File

@ -2,6 +2,8 @@
%% %%
%% Class ``PhD Thesis PSnPDF'' %%
%% %%
%% A PhD thesis LaTeX template for Cambridge University Engineering Department%%
%% %%
%% Version: v1.0 %%
%% Authors: Krishna Kumar %%
%% Date: 2013/11/16 (inception) %%
@ -24,52 +26,52 @@
\DeclareOption{print}{\@printtrue}
% ****************************** Define index **********************************
\newif\ifCU@index\CU@indexfalse
\DeclareOption{index}{\CU@indextrue}
\newif\ifCUED@index\CUED@indexfalse
\DeclareOption{index}{\CUED@indextrue}
% ******************************* Font Option **********************************
\newif\ifsetFont\setFontfalse % Font is not set
\newif\ifCU@times\CU@timesfalse % Times with Math Support
\DeclareOption{times}{\CU@timestrue}
\newif\ifCUED@times\CUED@timesfalse % Times with Math Support
\DeclareOption{times}{\CUED@timestrue}
\newif\ifCU@fourier\CU@fourierfalse % Fourier with Math Support
\DeclareOption{fourier}{\CU@fouriertrue}
\newif\ifCUED@fourier\CUED@fourierfalse % Fourier with Math Support
\DeclareOption{fourier}{\CUED@fouriertrue}
\newif\ifCU@customfont\CU@customfontfalse % Custom Font with Math Support
\DeclareOption{customfont}{\CU@customfonttrue}
\newif\ifCUED@customfont\CUED@customfontfalse % Custom Font with Math Support
\DeclareOption{customfont}{\CUED@customfonttrue}
% ******************************* Bibliography *********************************
\newif\ifsetBib\setBibfalse % Using Custom Bibliography
\newif\ifCU@authoryear\CU@authoryearfalse % Author-Year citation
\DeclareOption{authoryear}{\CU@authoryeartrue}
\newif\ifCUED@authoryear\CUED@authoryearfalse % Author-Year citation
\DeclareOption{authoryear}{\CUED@authoryeartrue}
\newif\ifCU@numbered\CU@numberedfalse % Numbered citiation
\DeclareOption{numbered}{\CU@numberedtrue}
\newif\ifCUED@numbered\CUED@numberedfalse % Numbered citiation
\DeclareOption{numbered}{\CUED@numberedtrue}
\newif\ifCU@custombib\CU@custombibfalse % Custom Bibliography
\DeclareOption{custombib}{\CU@custombibtrue}
\newif\ifCUED@custombib\CUED@custombibfalse % Custom Bibliography
\DeclareOption{custombib}{\CUED@custombibtrue}
% ************************* Header / Footer Styling ****************************
\newif\ifCU@pageStyleI\CU@pageStyleIfalse % Set Page StyleI
\DeclareOption{PageStyleI}{\CU@pageStyleItrue}
\newif\ifCUED@pageStyleI\CUED@pageStyleIfalse % Set Page StyleI
\DeclareOption{PageStyleI}{\CUED@pageStyleItrue}
\newif\ifCU@pageStyleII\CU@pageStyleIIfalse % Set Page StyleI
\DeclareOption{PageStyleII}{\CU@pageStyleIItrue}
\newif\ifCUED@pageStyleII\CUED@pageStyleIIfalse % Set Page StyleI
\DeclareOption{PageStyleII}{\CUED@pageStyleIItrue}
% ***************************** Custom Margins ********************************
\newif\ifsetMargin\setMarginfalse % Margins are not set
\newif\ifCU@custommargin\CU@custommarginfalse % Custom margin
\DeclareOption{custommargin}{\CU@custommargintrue}
\newif\ifCUED@custommargin\CUED@custommarginfalse % Custom margin
\DeclareOption{custommargin}{\CUED@custommargintrue}
% **************************** Separate Abstract ******************************
\newif \ifdefineAbstract\defineAbstractfalse %To enable Separate abstract
\newif\ifCU@abstract\CU@abstractfalse % Enable Separate Abstract
\newif\ifCUED@abstract\CUED@abstractfalse % Enable Separate Abstract
\DeclareOption{abstract}{
\CU@abstracttrue
\CUED@abstracttrue
\ClassWarning{PhDThesisPSnPDF}{You have chosen an option that generates only
the Title page and an abstract with PhD title and author name, if this was
intentional, ignore this warning. Congratulations on submitting your thesis!!
@ -82,30 +84,30 @@ recompile. Good luck with your writing!}
% *************************** Pre-defined Options ******************************
% Font Size
\newcommand\CU@ptsize{12pt} %Set Default Size as 12
\newcommand\CUED@ptsize{12pt} %Set Default Size as 12
\DeclareOption{10pt}{
\ClassWarning{PhDThesisPSnPDF}{The Cambridge University PhD thesis guidelines
recommend using a minimum font size of 11pt (12pt is preferred) and 10pt for
footnotes.}
\renewcommand\CU@ptsize{10pt}
\renewcommand\CUED@ptsize{10pt}
}
\DeclareOption{11pt}{\renewcommand\CU@ptsize{11pt}}%
\DeclareOption{12pt}{\renewcommand\CU@ptsize{12pt}}%
\PassOptionsToClass{\CU@ptsize}{book}%
\DeclareOption{11pt}{\renewcommand\CUED@ptsize{11pt}}%
\DeclareOption{12pt}{\renewcommand\CUED@ptsize{12pt}}%
\PassOptionsToClass{\CUED@ptsize}{book}%
% Page Size
\newcommand\CU@papersize{a4paper} % Set Default as a4paper
\newcommand\CUED@papersize{a4paper} % Set Default as a4paper
\DeclareOption{a4paper}{\renewcommand\CU@papersize{a4paper}}
\DeclareOption{a5paper}{\renewcommand\CU@papersize{a5paper}}
\DeclareOption{a4paper}{\renewcommand\CUED@papersize{a4paper}}
\DeclareOption{a5paper}{\renewcommand\CUED@papersize{a5paper}}
\DeclareOption{letterpaper}{
\ClassWarning{PhDThesisPSnPDF}{The Cambridge University Engineering Deparment
PhD thesis guidelines recommend using A4 or A5paper}
\renewcommand\CU@papersize{letterpaper}
\renewcommand\CUED@papersize{letterpaper}
}
\PassOptionsToClass{\CU@papersize}{book}%
\PassOptionsToClass{\CUED@papersize}{book}%
% Column layout
\DeclareOption{oneside}{\PassOptionsToClass{\CurrentOption}{book}}%
@ -169,7 +171,7 @@ supported!}
citecolor=black,
anchorcolor=black
}
\ifCU@custommargin
\ifCUED@custommargin
\setMarginfalse
\else
% Odd and Even side Margin for binding and set viewmode for PDF
@ -201,7 +203,7 @@ supported!}
anchorcolor=green
}
\ifCU@custommargin
\ifCUED@custommargin
\setMarginfalse
\else
% No Margin staggering on Odd and Even side
@ -257,20 +259,19 @@ supported!}
% Redefining urlstyle to use smaller fontsize in References with URLs
\newcommand{\url@leostyle}{%
\@ifundefined{selectfont}{\renewcommand{\UrlFont}{\sf}}
{\renewcommand{\UrlFont}{\small\ttfamily}}
}
{\renewcommand{\UrlFont}{\small\ttfamily}}}
\urlstyle{leo}
% ******************************* Bibliography *********************************
\ifCU@authoryear
\ifCUED@authoryear
\RequirePackage[round, sort, numbers, authoryear]{natbib} %author year
\setBibtrue
\else
\ifCU@numbered
\ifCUED@numbered
\RequirePackage[numbers,sort&compress]{natbib} % numbered citation
\setBibtrue
\else
\ifCU@custombib
\ifCUED@custombib
\setBibfalse
\else
\RequirePackage[numbers,sort&compress]{natbib} % Default - numbered
@ -279,7 +280,6 @@ supported!}
Default numbered style is used. If you would like to use a different style, use
`authoryear' or `numbered' in the options in documentclass or use `custombib`
and define the natbibpackage with required style in the Preamble.tex file}
% Generate a warning message here
\fi
\fi
\fi
@ -292,15 +292,15 @@ and define the natbibpackage with required style in the Preamble.tex file}
\RequirePackage[T1]{fontenc}
% Font Selection
\ifCU@times
\ifCUED@times
\RequirePackage{mathptmx} % times roman, including math (where possible)
\setFonttrue
\else
\ifCU@fourier
\ifCUED@fourier
\RequirePackage{fourier} % Fourier
\setFonttrue
\else
\ifCU@customfont
\ifCUED@customfont
\setFontfalse
\else
\ClassWarning{PhDThesisPSnPDf}{Using default font Latin Modern. If you
@ -357,7 +357,7 @@ font in preamble by specifying `customfont' in the class options}
\newcommand{\setFancyHdr}{
\pagestyle{fancy}
\ifCU@pageStyleI
\ifCUED@pageStyleI
% Style 1: Sets Page Number at the Top and Chapter/Section Name on LE/RO
\renewcommand{\chaptermark}[1]{\markboth{##1}{}}
\renewcommand{\sectionmark}[1]{\markright{\thesection\ ##1\ }}
@ -367,7 +367,7 @@ font in preamble by specifying `customfont' in the class options}
\else
\ifCU@pageStyleII
\ifCUED@pageStyleII
% Style 2: Sets Page Number at the Bottom with Chapter/Section Name on LO/RE
\renewcommand{\chaptermark}[1]{\markboth{##1}{}}
\renewcommand{\sectionmark}[1]{\markright{\thesection\ ##1}}
@ -502,11 +502,11 @@ font in preamble by specifying `customfont' in the class options}
\begin{center}
% Title
{\Huge \bfseries{\@title} \par}
\vspace{.25\CU@titlepagespacing}
\vspace{.25\CUED@titlepagespacing}
% Crest
{\@crest \par}
\vspace{.2\CU@titlepagespacing}
\vspace{.2\CUED@titlepagespacing}
% Author
{\Large \bfseries{\@author} \par}
@ -516,7 +516,7 @@ font in preamble by specifying `customfont' in the class options}
{\large \@dept \par}
\vspace*{1ex}
{\large \@university \par}
\vspace{.2\CU@titlepagespacing}
\vspace{.2\CUED@titlepagespacing}
% Submission Text
{\large \submissiontext \par}
@ -611,7 +611,7 @@ font in preamble by specifying `customfont' in the class options}
% ***************************** Create the index *******************************
\ifCU@index
\ifCUED@index
\RequirePackage{makeidx}
\makeindex
\newcommand{\printthesisindex}{
@ -628,7 +628,7 @@ font in preamble by specifying `customfont' in the class options}
% 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
\ifCU@abstract
\ifCUED@abstract
\defineAbstracttrue
% Disable the table of contents, figures, tables, index and nomenclature
\renewcommand{\tableofcontents}{}
@ -644,7 +644,7 @@ font in preamble by specifying `customfont' in the class options}
\newenvironment{abstract} {
\ifCU@abstract
\ifCUED@abstract
% Separate abstract as per Student Registry guidelines
\thispagestyle{empty}
\setsinglecolumn
@ -671,30 +671,30 @@ font in preamble by specifying `customfont' in the class options}
% Title Box
\newsavebox{\CU@Title}
\begin{lrbox}{\CU@Title}
\newsavebox{\CUED@Title}
\begin{lrbox}{\CUED@Title}
\begin{minipage}[c]{0.98\textwidth}
\centering \Huge \bfseries{\@title}
\end{minipage}
\end{lrbox}
% University Crest Box
\newsavebox{\CU@crest}
\begin{lrbox}{\CU@crest}
\newsavebox{\CUED@crest}
\begin{lrbox}{\CUED@crest}
\@crest
\end{lrbox}
% Author Box
\newsavebox{\CU@author}
\begin{lrbox}{\CU@author}
\newsavebox{\CUED@author}
\begin{lrbox}{\CUED@author}
\begin{minipage}[c]{\textwidth}
\centering \Large \bfseries{\@author}
\end{minipage}
\end{lrbox}
% Department Box
\newsavebox{\CU@dept}
\begin{lrbox}{\CU@dept}
\newsavebox{\CUED@dept}
\begin{lrbox}{\CUED@dept}
\begin{minipage}[c]{\textwidth}
\centering {\large \@dept \par}
\vspace*{1ex}
@ -703,8 +703,8 @@ font in preamble by specifying `customfont' in the class options}
\end{lrbox}
% Submission Box
\newsavebox{\CU@submission}
\begin{lrbox}{\CU@submission}
\newsavebox{\CUED@submission}
\begin{lrbox}{\CUED@submission}
\begin{minipage}[c]{\textwidth}
\begin{center}
\large \submissiontext \par
@ -715,8 +715,8 @@ font in preamble by specifying `customfont' in the class options}
\end{lrbox}
% College and Date Box
\newsavebox{\CU@collegedate}
\begin{lrbox}{\CU@collegedate}
\newsavebox{\CUED@collegedate}
\begin{lrbox}{\CUED@collegedate}
\begin{minipage}[c]{\textwidth}
\large
\begin{minipage}{0.45\textwidth}
@ -729,13 +729,13 @@ font in preamble by specifying `customfont' in the class options}
\end{lrbox}
% Now to compute the free vertical space
\newlength{\CU@titlepagespacing}
\setlength{\CU@titlepagespacing}{ \textheight %
- \totalheightof{\usebox{\CU@Title}}
- \totalheightof{\usebox{\CU@crest}}
- \totalheightof{\usebox{\CU@author}}
- \totalheightof{\usebox{\CU@dept}}
- \totalheightof{\usebox{\CU@submission}}
- \totalheightof{\usebox{\CU@collegedate}}
\newlength{\CUED@titlepagespacing}
\setlength{\CUED@titlepagespacing}{ \textheight %
- \totalheightof{\usebox{\CUED@Title}}
- \totalheightof{\usebox{\CUED@crest}}
- \totalheightof{\usebox{\CUED@author}}
- \totalheightof{\usebox{\CUED@dept}}
- \totalheightof{\usebox{\CUED@submission}}
- \totalheightof{\usebox{\CUED@collegedate}}
}
}

View File

@ -326,6 +326,8 @@ If you are generating a separate abstract for your thesis submission, ignore thi
## Known Issue(s) / Bugs
* Hyperlinks doesn't seem to be working in Post-Script file, however works on DVI and PDF (which is produced from the PS file), possibly viewer limitation than a code bug.
* No know bug(s) so far. If you find any let me know, or even better, patch it and contribute to the development of the LaTeX Template.
@ -333,9 +335,14 @@ If you are generating a separate abstract for your thesis submission, ignore thi
## TODO list
* Make example thesis a document on how to use the template and include general guidelines and good practices.
--------------------------------------------------------------------------------
## ChangeLog
### 2013/12/07 - Version 1.0 Beta Release 9.0
> Commit
* Wider text area (75% of page size), support for separate abstract for submission to the Student Registry
### 2013/12/05 - Version 1.0 Beta Release 8.0
> Commit 324d1a5609992028afb109b424573cd3a5e31849
* Update class file to support dvips driver when using dvi > PS output in hyperTeX. Removed deprecated codes from Declaration and class files

View File

@ -1,6 +1,6 @@
# If you list files or wildcards here, they will *not* be cleaned - default is
# to allow everything to be cleaned.
neverclean := *.pdf *.ps
neverclean := *.pdf *.ps *.dvi
# If you list files here, they will be treated as _include_ files
includes.fig := Figs/University_Crest.pdf Figs/University_Crest.eps

BIN
thesis.dvi Normal file

Binary file not shown.

Binary file not shown.

5449
thesis.ps

File diff suppressed because it is too large Load Diff