make template more accessible

This commit is contained in:
Starbeamrainbowlabs 2023-05-26 15:27:29 +01:00
parent 3a0b414bdc
commit 013a7082a7
Signed by: sbrl
GPG key ID: 1BE5172E637709C2
6 changed files with 36 additions and 1 deletions

View file

@ -4,6 +4,7 @@
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`).
@ -15,6 +16,22 @@ Then, in a terminal (or _Git Bash_ on Windows), run the provided build script li
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](https://starbeamrainbowlabs.com/)
## 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.
- <https://gradschool.cornell.edu/academic-progress/thesis-dissertation/appendix-additional-accessibility-information/>
- [Making Accessible Documents Using LaTeX](https://www.ams.org/journals/notices/202301/rnoti-p68.pdf?adat=January%202023&trk=2606&cat=career&galt=none)
## Licence
While I've listed this repository under the MIT licence, that only covers the modifications I've made to the template myself.

Binary file not shown.

View file

@ -3,6 +3,7 @@
\renewcommand\familydefault{\sfdefault}
\usepackage[utf8]{inputenc}
\usepackage[english]{babel}
\usepackage[document]{ragged2e}
\usepackage{amssymb}
\usepackage{amsthm}
\usepackage{amsmath}
@ -24,6 +25,14 @@
breaklines=true
}
% This is important for A) accessibility, and B) getting the document title to display in PDF viewers
\hypersetup{
pdflang={en-GB}, % Set this to the ISO code for the primary language you are writing in
pdftitle={Enter the title of your work here},
pdfauthor={Your name},
pdfsubject={Your subject}
}
\newcommand{\comments}[1]{\textcolor{OliveGreen}{[\emph{#1}]}}
\newcommand{\reporttype}{Final Report}

View file

@ -1,7 +1,7 @@
\begin{appendices}
\chapter{Appendix A: Example Appendix}
\chapter{Example Appendix}
\label{chapter:appendix-a}
\begin{lstlisting}

View file

@ -3,6 +3,7 @@
\renewcommand\familydefault{\sfdefault}
\usepackage[utf8]{inputenc}
\usepackage[english]{babel}
\usepackage[document]{ragged2e}
\usepackage{amssymb}
\usepackage{amsthm}
\usepackage{amsmath}
@ -24,6 +25,14 @@
breaklines=true
}
% This is important for A) accessibility, and B) getting the document title to display in PDF viewers
\hypersetup{
pdflang={en-GB}, % Set this to the ISO code for the primary language you are writing in
pdftitle={Enter the title of your work here},
pdfauthor={Your name},
pdfsubject={Your subject}
}
\newcommand{\comments}[1]{\textcolor{OliveGreen}{[\emph{#1}]}}