README.md 4.75 KB
Newer Older
Edward Longman's avatar
Edward Longman committed
1
2
3
# University Of Southampton LaTeX documents
LaTeX Documents for the University of Southampton. Mainly for Thesis and project reports

4
For slides with Beamer, please see https://git.soton.ac.uk/sw2f11/latex-slides-template
Edward Longman's avatar
Edward Longman committed
5
6

## FAQ
Edward Longman's avatar
Edward Longman committed
7
8
9
#### Q: How do I install and use the templates?
See the [Install](#install-instructions) section below.

Edward Longman's avatar
Edward Longman committed
10
11
12
13
14
15
#### 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).

Edward Longman's avatar
Edward Longman committed
16
#### Q: How do I fix a bib entry with special characters (`&%`)?
Edward Longman's avatar
Edward Longman committed
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
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.

The short term solution is to manually "escape" special characters in the `.bib` url fields,
i.e. `url = {http://www.somesite.com/8%20report}` => `url = {http://www.somesite.com/8\%20report}`.

Unfortunately, the longer term solution requires editing some source files.
Locate the `plainnat.bst` (or `biblatex.bst` file, if using `biblatex`)
and add the following in the file at the end of `FUNCTION {begin.bib}`
```
    "\providecommand{\BIBdecl}{\relax}"
    write$ newline$
    "\BIBdecl"
    write$ newline$
```
Then add ``\newcommand{\BIBdecl}{\catcode`\%=12 }`` before `\begin{document}` in your `.tex` document source.

[Stack Exchange Source](https://tex.stackexchange.com/questions/140143/hyperref-with-pagebackref-requires-manual-escaping-of-percentage-signs-in-urls)

#### Q: Can I use `biblatex` instead of `natbib`?
Yes you can. Since this template has existed longer than `biblatex` it uses the older `natbib`.
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,

Edward Longman's avatar
Edward Longman committed
41
42
43
44
45
46
47
48
49
## 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
50
For Tex Live: This whole folder can be moved into the `~/texmf` directory to begin using the class files.
Edward Longman's avatar
Edward Longman committed
51

52
53
54
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.
55

Edward Longman's avatar
Edward Longman committed
56
#### The folder post install
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
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.

```
+-{TEXMF}
    +-bibtex
    |  +-bib
    |  |   +-uosdocs
    |  +-bst
    |      +-uosdocs
    +-doc
    |  +-latex
    |      +-uosdocs
    +-templates
    |  +-latex
    |      +-uosdocs
    +-tex
    |  +-latex
    |      +-uosdocs
    +-source
       +-docstrip
           +-uosdocs
```

Edward Longman's avatar
Edward Longman committed
82
83
84
85
86
87
88
89
90
91
#### 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.

92
## About this package
Edward Longman's avatar
Edward Longman committed
93
Created with docstrip `.ins` and `.dtx` files in the source directory. See the Instructions manual for more info about usage and building.
94
95

The version hosted on https://git.soton.ac.uk/el7g15/uos-latex-template is kept up to date with the University of Southampton template. The version hosted on GitHub may diverge from that.