Commit 92905a2a authored by Edward Longman's avatar Edward Longman
Browse files

Update install instructions

parent 167ee07e
......@@ -4,13 +4,16 @@ LaTeX Documents for the University of Southampton. Mainly for Thesis and project
For slides with Beamer, please see https://git.soton.ac.uk/sw2f11/latex-slides-template
## FAQ
#### Q: How do I install and use the templates?
See the [Install](#install-instructions) section below.
#### Q: How do I include an "Accessed on", "Visited on", "Date last Accessed" or "Last visited" note for urls?
The bibliography is formatted by the `natbib` package that does not support the `urldate` field in `.bib` files.
As a work around, add a `note={Accessed on 2020-01-01}` to the relevant bib entry.
For more info see [this Stack Exchange question](https://tex.stackexchange.com/questions/103133/problems-with-natbib-strange-url-format-and-urldate-not-shown).
#### Q: How do I fix a bib entry with special characters (`&``%`)?
#### Q: How do I fix a bib entry with special characters (`&%`)?
You may get an error like "Paragraph ended before \\BR@@bibitem was complete"
or there may be a cascade of errors because of an unclosed `\begin` statement.
......@@ -35,14 +38,22 @@ Yes you can. Since this template has existed longer than `biblatex` it uses the
there are good reasons to change to `biblatex` but `natbib` is still preferred by journals,
so using `natbib` will mean that source material from papers will not need to be modified,
## Your `{TEXMF}` root subdirectory
## Install instructions
### For preparing a single document - Thesis, Dissertation, Final project report
Since you will only need this template once, go to the [Releases page](https://git.soton.ac.uk/el7g15/uos-latex-template/-/releases) and download the relevant quickstart package. Unzip and start editing the `Thesis.tex`,`Progress.tex`,`GDP.tex` file as appropriate for the report you are doing. This should compile straight away from an editor like TeXstudio.
### For multiple use - for progress reports, and thesis and more frequent use
Assuming you will use the template more than once, this is definitely the preferred option.
Download the `Source Code` from the [Releases page](https://git.soton.ac.uk/el7g15/uos-latex-template/-/releases) and extract it to the `{TEXMF}` folder (see below).
#### Your `{TEXMF}` root subdirectory
For Tex Live: This whole folder can be moved into the `~/texmf` directory to begin using the class files.
For MikTeX: It is platform dependent, See `UserInstall` from (https://miktex.org/kb/texmf-roots).
You may need to register your directories: https://docs.miktex.org/manual/localadditions.html.
You will need to update the filename database (FNDB) (MiKTeX Console -> Tasks ->Refresh file name database), see https://docs.miktex.org/manual/configuring.html#fndbupdate. You can do this in the command line with the `initexmf -u` command.
## The folder post install
#### The folder post install
If using the zip download there may be one or two containing directories before the actual
folders that need copying. Once the folder has been extracted your `{TEXMF}` directory should
look like so.
......@@ -68,6 +79,16 @@ look like so.
+-uosdocs
```
#### Using the template
Now copy the contents of the `templates/latex/uosdocs` directory into your working directory.
In the working directory, open the relevant copied root `tex` file, i.e. `Thesis.tex` etc. and begin your masterpiece.
More info can be found in the [Instructions repository](https://git.soton.ac.uk/el7g15/uos-latex-template-instructions/-/blob/master/README.pdf)
### Updating
Repeat the installation step and it will overwrite the existing files.
## About this package
Created with docstrip `.ins` and `.dtx` files in the source directory. See the Instructions manual for more info about usage and building.
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment