From b3120c22e2087180c92c944d9e33a9d8df826c35 Mon Sep 17 00:00:00 2001
From: Edward Longman <el7g15@soton.ac.uk>
Date: Tue, 15 Jan 2019 18:21:14 +0000
Subject: [PATCH] Move Getting started instructions into Starting.tex, add
index and glossary instructions
---
Introduction.tex | 63 ---------------------------------------
README.tex | 1 +
Starting.tex | 77 ++++++++++++++++++++++++++++++++++++++++++++++++
3 files changed, 78 insertions(+), 63 deletions(-)
create mode 100644 Starting.tex
diff --git a/Introduction.tex b/Introduction.tex
index f631933..883d672 100644
--- a/Introduction.tex
+++ b/Introduction.tex
@@ -48,68 +48,5 @@ You can use this page as a reference or crib sheet, the symbols are rendered as
\section{Prerequisistes}\label{prereq}
You should have installed a TeX distribution (MiKTeX or TexLive). How to do so can be found by searching the internet.
-Following a medium install of texlive some extra packages are required to be able to use this template.
-These packages are:
\begin{itemize}
- \item droid
- %TODO: finish package requirements
\end{itemize}
-
-The particular packages required following MiKTeX are unknown as it was not tested with this.
-%TODO: Test with MiKTeX
-\section{Getting Started}\label{start}
-You probably have downloaded the templates as a zip file.
-This zip file should be extracted to the tex-mf folder that is probably in the same place as where your tex distribution was installed.
-For TeXLive this defaults to `C:\textbackslash texlive` on Windows. It can be found by running `kpsewhich -var-value=TEXMFHOME`.
-The structure of this folder should results as so is as so:
-\begin{lstlisting}
-+-texmf
- +-bibtex
- | +-bib
- | | +-ecsdocs
- | +-bst
- | +-ecsdocs
- +-doc
- | +-latex
- | +-ecsdocs
- +-templates
- | +-latex
- | +-ecsdocs
- +-tex
- +-latex
- +-ecsdocs
-\end{lstlisting}
-
-The `templates\textgreater latex\textgreater ecsdocs` folder contains the files to get you started.
-The base file is `Thesis.tex` for a thesis and `Progress.tex` for a progress report.
-
-The base files have dependancies for the sections and the figures.
-These files are: `Definitions.tex`, `Introduction.tex`, `Conclusion.tex`, `AppendixA.tex`, `figure.eps`, `ECS.bib`.
-These files are designed as a starting point for the structure of your thesis.
-
-To start using the templates, copy the base file and the dependancies into your working directory.
-You are then free to edit them.
-
-\section{Common Changes}
-\subsection{University Structure Changes}
-The template assumes that you are in the \groupname, \deptname, \facname at the \univname.
-This can be easily changed at the top of your latex file by redefinition of the variables.
-
-These commands are:
-\begin{lstlisting}
-\university {\texorpdfstring{\href{http://www.soton.ac.uk}
- {University of Southampton}}
- {University of Southampton}}
-\UNIVERSITY {\MakeUppercase{\univname}}
-\department {}
-\DEPARTMENT {\MakeUppercase{\deptname}}
-\group {}
-\GROUP {\MakeUppercase{\groupname}}
-\faculty {}
-\FACULTY {\MakeUppercase{\facname}}
-\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 `doc\textgreater latex\textgreater ecsdocs` of the texmf directory discussed in Section~\ref{start}.
-
-The other common commands already exist in the top level template file.
diff --git a/README.tex b/README.tex
index f5e9899..39ec774 100644
--- a/README.tex
+++ b/README.tex
@@ -44,6 +44,7 @@
\mainmatter
%% ----------------------------------------------------------------
\include{Introduction}
+\include{Starting}
\include{Rebuilding}
\include{Conclusions}
\begin{lstlisting}[caption=Without a title it doesn't appear in the table]
diff --git a/Starting.tex b/Starting.tex
new file mode 100644
index 0000000..cd62d9a
--- /dev/null
+++ b/Starting.tex
@@ -0,0 +1,77 @@
+\chapter{Getting Started}\label{start}
+You probably have downloaded the templates as a zip file.
+This zip file should be \emph{extracted to the texmf} folder that will either need to be created in your user directory or will be near your installation directory.
+For TeXLive this defaults to \verb|<userdirectory>\texlive| on Windows. It can be found by running the command \verb|kpsewhich -var-value=TEXMFHOME|. For MiKTeX see \url{https://miktex.org/kb/texmf-roots}.
+
+The structure of this folder should look like this.
+\begin[caption=Folder Structure of the texmf folder.]{lstlisting}\label{folder_struct}
++-texmf
+ +-bibtex
+ | +-bib
+ | | +-ecsdocs
+ | +-bst
+ | +-ecsdocs
+ +-doc
+ | +-latex
+ | +-ecsdocs
+ +-templates
+ | +-latex
+ | +-ecsdocs
+ +-tex
+ | +-latex
+ | +-ecsdocs
+ +-source
+ +-docstrip
+ +-ecsdocs
+\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 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 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.
+
+\section{File Structure}
+The \verb|Thesis.tex| file is composed of two main parts.
+Firstly, \verb|frontmatter| is all the information that goes before your and \verb|mainmatter|.
+
+It is advisable to write each chapter (an possibly section) in a separate file to keep each file of a manageable size.
+They are included into the main file with an \verb|\include{Filename}| statement.
+Also keep Appendix and Listings files separate if possible.
+
+\section{Changes and additions}
+\subsection{University Organizational information}
+The template assumes that you are in the \groupname, \deptname, \facname at the \univname.
+This can be easily changed at the top of your latex file by redefinition of the variables.
+These commands are:
+\begin{lstlisting}
+\university {\texorpdfstring{\href{http://www.soton.ac.uk}
+ {University of Southampton}}
+ {University of Southampton}}
+\UNIVERSITY {\MakeUppercase{\univname}}
+\department {}
+\DEPARTMENT {\MakeUppercase{\deptname}}
+\group {}
+\GROUP {\MakeUppercase{\groupname}}
+\faculty {}
+\FACULTY {\MakeUppercase{\facname}}
+\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}` of the texmf directory discussed in Section~\ref{start}.
+
+The other common commands already exist in the top level template file.
+\subsection{Add a Glossary or Index}
+\emph{Both Indexes and Glossaries involve an extra build step so you will need to read the manual before inserting these.} They should be put after a \verb|\cleartoeven| as is convention for indexes to start on the left.
+Some people may want to have an index or prefer Glossary instead of a list of symbols.
+The \href{http://anorien.csc.warwick.ac.uk/mirrors/CTAN/macros/latex/contrib/glossaries}{\texttt{glossaries}} package can be used.
+Inserting the \verb|\printglossaries| command will put the glossary where you want it.
+The list of symbols command can be removed in this case.
+Inserting the \verb|\printindex| command will put the glossary where you want it.
+The recomended index package is \href{https://en.wikibooks.org/wiki/LaTeX/Indexing}{\texttt{makeidx}}.
--
GitLab