From e48e6259c11f8cb34c13be019d185835660aa43f Mon Sep 17 00:00:00 2001 From: Edward Longman <el7g15@soton.ac.uk> Date: Wed, 30 Jan 2019 17:54:18 +0000 Subject: [PATCH] Change the style name from ecsdocs to uosdocs and update accoringly --- README.tex | 6 +++--- Rebuilding.tex | 8 ++++---- Starting.tex | 18 +++++++++--------- ECS.bib => UOS.bib | 2 +- figure.eps | 2 +- 5 files changed, 18 insertions(+), 18 deletions(-) rename ECS.bib => UOS.bib (99%) diff --git a/README.tex b/README.tex index abe12ee..3f0d04d 100644 --- a/README.tex +++ b/README.tex @@ -1,7 +1,7 @@ %% ---------------------------------------------------------------- %% README.tex %% ---------------------------------------------------------------- -\documentclass[sotoncolour]{ecsthesis} % Use the Thesis Style +\documentclass[sotoncolour]{uosthesis} % Use the Thesis Style \graphicspath{{../Figures/}} % Location of your graphics files \usepackage{natbib} % Use Natbib style for the refs. \hypersetup{colorlinks=true} % Set to false for black/white printing @@ -63,7 +63,7 @@ say not much at all \appendix \include{AppendixA} \backmatter -\bibliographystyle{ecs} -\bibliography{ECS} +\bibliographystyle{uos} +\bibliography{UOS} \end{document} %% ---------------------------------------------------------------- diff --git a/Rebuilding.tex b/Rebuilding.tex index 575ef84..2084937 100644 --- a/Rebuilding.tex +++ b/Rebuilding.tex @@ -1,6 +1,6 @@ \chapter{Rebuilding the Templates}\label{rebuilding} In most cases this template style and layout will be suitable. If it is not, it may only require a small change to bring the template in line with your institution's recommendations. -Quick modifications will need to be done on the \verb|ecsdocs.cls| file in the \verb|tex/latex/ecsdocs| folder. Modification of all the templates or major modifications should be made to the original \verb|source/docstrip/ecsdocs/ecsdocs.dtx| +Quick modifications will need to be done on the \verb|uosdocs.cls| file in the \verb|tex/latex/uosdocs| folder. Modification of all the templates or major modifications should be made to the original \verb|source/docstrip/uosdocs/uosdocs.dtx| \section{The Build Process} To change the templates you should understand how the templates are made. @@ -8,15 +8,15 @@ The templates are built using the docstrip package. "The packÂage preÂpares a \LaTeX kerÂnel or packÂage source file for acÂtual use, by reÂmovÂing the docÂuÂmenÂtaÂtion and meta-data" \citep{Docstrip} It also creates a document containing some documentation for the created files. -The docstrip utility comes as a latex package so when the main file (.dtx) is run with the command \verb|$(LATEX) ecsdocs.ins| it creates all the class files plus the example templates. +The docstrip utility comes as a latex package so when the main file (.dtx) is run with the command \verb|$(LATEX) uosdocs.ins| it creates all the class files plus the example templates. When this tool is run it creates lots of auxiliary files. To help with managing these auxiliary files GNU Make is used. "GNU Make is a tool which controls the generation of executables and other non-source files of a program from the program's source files."\citep{GNUdesc}. The make command can be run in several different configurations. \verb|make all| creates all of the class, template, bibliography and figure files from the source files. \verb|make install| moves all of the created files into the users texmf directory ready for use. \section{The Source File} -The source file \verb|ecsdocs.dtx| results in the several different class (\verb|.cls|) files as well as the template (\verb|.tex|) files. -"The installer is the \verb|ecsdocs.ins| file. An installer file +The source file \verb|uosdocs.dtx| results in the several different class (\verb|.cls|) files as well as the template (\verb|.tex|) files. +"The installer is the \verb|uosdocs.ins| file. An installer file extracts the code from a \verb|.dtx| file, uses \verb|DocStrip| to strip off the comments and documentation, and outputs the \verb|.cls| files."\citep{} It also creates the figure files and the chapter files. diff --git a/Starting.tex b/Starting.tex index 1ec3735..c7347ff 100644 --- a/Starting.tex +++ b/Starting.tex @@ -8,31 +8,31 @@ The structure of this folder should look like this. +-texmf +-bibtex | +-bib - | | +-ecsdocs + | | +-uosdocs | +-bst - | +-ecsdocs + | +-uosdocs +-doc | +-latex - | +-ecsdocs + | +-uosdocs +-templates | +-latex - | +-ecsdocs + | +-uosdocs +-tex | +-latex - | +-ecsdocs + | +-uosdocs +-source +-docstrip - +-ecsdocs + +-uosdocs \end{lstlisting} On some \LaTeX{} systems, the directory look-up tables will need to be refreshed after making additions or deletions to the system files. For TeXlive systems this is accomplished via executing \verb|texhash| as root. MikTeX users can run \verb|initexmf -u| to accomplish the same thing. -The \verb|templates/latex/ecsdocs| folder contains the files to get you started. +The \verb|templates/latex/uosdocs| folder contains the files to get you started. The base file is \verb|Thesis.tex| for a thesis and \verb|Progress.tex| for a progress report. The base files have dependancies for the sections and the figures. -These files are: \verb|Definitions.tex|, \verb|Introduction.tex|, \verb|Conclusion.tex|, \verb|AppendixA.tex|, \verb|figure.eps|, \verb|ECS.bib|. To start using the templates, copy the base file and the dependancies into your working directory. +These files are: \verb|Definitions.tex|, \verb|Introduction.tex|, \verb|Conclusion.tex|, \verb|AppendixA.tex|, \verb|figure.eps|, \verb|UOS.bib|(in the bibtex base folder). To start using the templates, copy the base file and the dependancies into your working directory. These files are designed as a starting point for the structure of your thesis. If you are familiar with \LaTeX{}, go and explore the template and use it. Maybe start with putting your info in the section \emph{THESIS/DOC INFORMATION} block of the \verb|Thesis.tex| or \verb|Progress.tex| file. You can then modify the rest of this file to your unique specifications based on your degree/university. If you are new to \LaTeX{} then read about the file structure below. @@ -90,7 +90,7 @@ These commands are: \end{lstlisting} The all caps command version must be run after changing the normal case command for it to change the default. The university example here also has a link embedded. -More detail can be found in the class docs file. Found in \verb|doc\latex\ecsdocs| +More detail can be found in the class docs file. Found in \verb|doc\latex\uosdocs| of the texmf directory discussed in Section~\ref{start}. The other common commands already exist in the top level template file. diff --git a/ECS.bib b/UOS.bib similarity index 99% rename from ECS.bib rename to UOS.bib index cd6f7ea..267eef9 100644 --- a/ECS.bib +++ b/UOS.bib @@ -1,5 +1,5 @@ %% ---------------------------------------------------------------- -%% ECS.bib +%% UOS.bib %% ---------------------------------------------------------------- @MISC{Gunn:2001:pdflatex, diff --git a/figure.eps b/figure.eps index ec21b4c..0ec0278 100644 --- a/figure.eps +++ b/figure.eps @@ -1,6 +1,6 @@ %!PS-Adobe-3.0 %%Title: figure.eps -%%Creator: ECSThesis.dtx +%%Creator: UoSThesis.dtx %%BoundingBox: 0 150 600 650 %%EndComments -- GitLab