Demos/latex-templates
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity
A collection of LaTeX templates that are useful when writing a report.
10 commits 1 branch 0 tags 181 KiB
TeX 88.8%
Shell 11.2%
Find a file
Starbeamrainbowlabs b9d9a439e4
short-report: add scrartcl as option 
This way you don't get all the problems with numbering if you use asection as the top-level instead of \chapter
2023-06-30 16:18:21 +01:00
lantern-build-engine@617fcdb5b9 Create example report 2019-05-03 13:25:42 +01:00
report make template more accessible 2023-05-26 15:27:29 +01:00
short-report short-report: add scrartcl as option 2023-06-30 16:18:21 +01:00
.gitignore Create example report 2019-05-03 13:25:42 +01:00
.gitmodules Create example report 2019-05-03 13:25:42 +01:00
build Update build script 2019-05-03 13:58:51 +01:00
LICENSE Initial commit 2019-05-03 13:37:23 +01:00
README.md make template more accessible 2023-05-26 15:27:29 +01:00
report.pdf make template more accessible 2023-05-26 15:27:29 +01:00
short-report.pdf make template more accessible 2023-05-26 15:27:29 +01:00

README.md

latex-templates

A collection of LaTeX templates that are useful when writing a report.

All examples use the official University of Hull referencing style, and are originally derived from the template given to me for my interim report.

Getting Started

Start by cloning this repository (git clone https://git.starbeamrainbowlabs.com/Demos/latex-templates.git).

Then, in a terminal (or Git Bash on Windows), run the provided build script like this:

./build setup render

Note that it uses pdflatex and bibtex by default. If you use a different LaTeX render, I'd love to know! Get in contact with me via any method mentioned on my website

Design decisions

The following notes are provided about design decisions made in these templates.

  • Unjustified text: Justified text can cause readability and accessibility issues for readers with dyslexia. Therefore, left-aligned text has been chosen as the default.
  • Short/normal report: The short report template differs from the normal report template in that when \chapter{Some heading} is used it does not cause a page break. This is useful for shorter documents, where there may potentially be a page limit.
  • \hypersetup{...}: Please make sure you update this. This not only sets the document title in the title bar for PDF viewers, but is also important for accessibility.

Resources about accessibility

When writing a document using these templates, you will have the opportunity to make a number of design decisions that may affect the accessibility of your final document. It is worth taking a few minutes to inform yourself of potential problem areas such that the final output you produce is more accessible.

Licence

While I've listed this repository under the MIT licence, that only covers the modifications I've made to the template myself.

The actual template (including the referencing style itself) that I've based these templates on is probably Copyright © University of Hull 2019 (though hull.bst claims it's under the LaTeX Project Public License).

Disclaimer: These templates are provided for University of Hull students only. No guarantee is provided - even fitness-for-purpose. In other words, no guarantee is made that these templates actually conform to official University guidelines and regulations!