Skip to content

Commit

Permalink
Added FAQs related to double line spacing, APA referencing, and margin
Browse files Browse the repository at this point in the history
sizing.
  • Loading branch information
jp-um committed Oct 6, 2023
1 parent b08c822 commit 4dfe8d5
Show file tree
Hide file tree
Showing 5 changed files with 40 additions and 6 deletions.
26 changes: 24 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,11 @@ I am also keen on keeping an FAQ with the most common LaTeX problems, which you

# Requirements

For this template you will need the beautiful Lato font for headings. This sans font creates a pleasing contrast with the serif text. `lato.sty` can be installed (on Ubuntu) with:
For this template you will need the beautiful Lato font for headings and also algorithm typesetting from the science packages. This sans font creates a pleasing contrast with the serif text. `lato.sty` can be installed (on Ubuntu) with:

```
sudo apt install texlive-fonts-extra
sudo apt install texlive-fonts-extra texlive-science
```

## FAQ
Expand Down Expand Up @@ -80,6 +81,27 @@ Many computational scientists are used to the IEEE referencing style with number

The template uses the ```floatpag``` package. All you need to do is place a ```\thisfloatpagestyle{empty}``` inside the figure or table environment. Et voilà! There is an example of this [here](https://github.com/jp-um/university_of_malta_LaTeX_dissertation_template/blob/master/chap2/background_and_lit_overview_main.tex).

### How do I change the referencing style change from plainnat to APA?

This is more involved than I would have liked, but anyway. Follow these steps:

1. From the `natbib` package import in [um.cls](https://github.com/jp-um/university_of_malta_LaTeX_dissertation_template/blob/b08c822a3b1043699258adc53fb0547f1a1d1bde/um.cls#L38C52-L38C52), remove all options `[authoryear,semicolon,sort]` as these are incompatible with the `apacite` package (which we need for APA referencing)
2. Above the line changed above, insert `\RequirePackage{apacite}`
3. In [dissertation_main.tex](https://github.com/jp-um/university_of_malta_LaTeX_dissertation_template/blob/b08c822a3b1043699258adc53fb0547f1a1d1bde/dissertation_main.tex#L121) change the bibliography style from `um-plainnat` to `apacite`.
4. Rebuild the bibliography and recompile the document.

### How do I change the one-and-a-half to double line spacing?

In my opinion you don't want to do this because the document is going to become very long. The idea of having double line spacing is to let examiners/supervisors write between the lines. This is not required for the final submission and mostly superceded by more modern word-processing and reviewing tools. Also, the current one and a half line spacing gives enough space for this.

If you want to go ahead anyway with this, change this line in [um.cls](https://github.com/jp-um/university_of_malta_LaTeX_dissertation_template/blob/b08c822a3b1043699258adc53fb0547f1a1d1bde/um.cls#L120) from `\OnehalfSpacing` to `\DoubleSpacing`.

### How do I change the document margins?

Also required in ancient times to write notes in the margin (and again superceded by modern word-processing and reviewing tools).

Still, should be an easy one, just change the values in the following line in [um.cls](https://github.com/jp-um/university_of_malta_LaTeX_dissertation_template/blob/b08c822a3b1043699258adc53fb0547f1a1d1bde/um.cls#L144C2-L144C2).

### How do I write good Latex Mathematical Notation/Formulae?

The [Math on Quora](https://math-on-quora.surge.sh/) is all you need. Any math notation you might need is available conveniently in the menu bar. All examples contain live code blocks so you can try out your math formulae directly in the web browser.
Expand Down
3 changes: 3 additions & 0 deletions chap2/background_and_lit_overview_main.tex
Original file line number Diff line number Diff line change
Expand Up @@ -392,6 +392,9 @@ \section{An Algorithm Example}

An algorithm example is shown in Algorithm~\ref{alg:example}. \blindtext

\section{A Referencing Example (In- and Out- Text)}

In their study, \citet{Ebejer2016} show the world is round. Others have shown this to be the case \citep{Arrighi2003, WithersMartinez2012}.

\section{Some Technique One}
\index{Some Technique One|(}
Expand Down
Binary file modified dissertation_main.pdf
Binary file not shown.
7 changes: 5 additions & 2 deletions dissertation_main.tex
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
%% The updated version of this document should be downloaded from
%% https://github.com/jp-um/university_of_malta_LaTeX_dissertation_template
%%
%% In case of any difficulties please contact Dr JP Ebejer on [email protected]
%% In case of any difficulties please contact Prof. JP Ebejer on [email protected]
%%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

Expand Down Expand Up @@ -117,7 +117,10 @@
{\backmatter
% Bibliography
\if@openright\cleardoublepage\else\clearpage\fi


%% for APA
%% \bibliographystyle{apacite}
%% for plainnat
\bibliographystyle{um-plainnat} %% specific plainnat does not show url for articles
% Use something like https://flamingtempura.github.io/bibtex-tidy/ to clean all your bibtex entries
{ \scriptsize\bibliography{chap1/introduction_biblio,chap2/background_and_lit_overview_biblio}}
Expand Down
10 changes: 8 additions & 2 deletions um.cls
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
%% ** **
%% ** LaTeX Template for Thesis/Dissertation/FYP **
%% ** **
%% ** Dr Jean-Paul Ebejer **
%% ** Prof. Jean-Paul Ebejer **
%% ** [email protected] **
%% ** **
%% ** "Build something which will outlast you" **
Expand All @@ -13,7 +13,7 @@
%% ****************************************************

\NeedsTeXFormat{LaTeX2e}
\ProvidesClass{um}[2018/05/01-2022/03/17 v2.1 University of Malta, Dissertation/FYP/Thesis Template]
\ProvidesClass{um}[2018/05/01-2023/10/06 v2.3 University of Malta, Dissertation/FYP/Thesis Template]


\DeclareOption*{\PassOptionsToClass{\CurrentOption}{memoir}}
Expand All @@ -35,7 +35,12 @@
\RequirePackage[pdftex]{graphicx} % For pictures
\RequirePackage{amssymb} % At least, for black squares in bullet list
\RequirePackage[pdfusetitle]{hyperref} % For hyperreferences

%% Uncomment the following lines for APA referencing (and remove the next line)
%%\RequirePackage{apacite}
%%\RequirePackage{natbib} % for (Ebejer, 2012; Alba, 2013) kind of references; removed 'square' option after viva examination comments
\RequirePackage[authoryear,semicolon,sort]{natbib} % for (Ebejer, 2012; Alba, 2013) kind of references; removed 'square' option after viva examination comments

\RequirePackage{floatpag} % Used to hide page number on pages which contain only floats ... put a \thisfloatpagestyle{empty} in the float env, e.g. figure ...
\RequirePackage{longtable} % For very long tables
\RequirePackage{pdflscape} % For landscape tables (instead of portrait)
Expand Down Expand Up @@ -119,6 +124,7 @@

\OnehalfSpacing % One and a half line spacing


\setlength{\headsep}{1.5cm} % Add space between the header and text

\nouppercaseheads % Don't convert titles to Uppercase
Expand Down

0 comments on commit 4dfe8d5

Please sign in to comment.