From 013a7082a7e06ad8649258eec049b9a94edde67f Mon Sep 17 00:00:00 2001
From: Starbeamrainbowlabs <sbrl@starbeamrainbowlabs.com>
Date: Fri, 26 May 2023 15:27:29 +0100
Subject: [PATCH] make template more accessible

---
 README.md                                     |  17 +++++++++++++++++
 report/report.pdf => report.pdf               | Bin 49753 -> 52799 bytes
 report/report.tex                             |   9 +++++++++
 .../short-report.pdf => short-report.pdf      | Bin 39239 -> 42427 bytes
 short-report/chapters/7-appendix.tex          |   2 +-
 short-report/short-report.tex                 |   9 +++++++++
 6 files changed, 36 insertions(+), 1 deletion(-)
 rename report/report.pdf => report.pdf (65%)
 rename short-report/short-report.pdf => short-report.pdf (80%)

diff --git a/README.md b/README.md
index 631b4bb..69d7398 100644
--- a/README.md
+++ b/README.md
@@ -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.
 
diff --git a/report/report.pdf b/report.pdf
similarity index 65%
rename from report/report.pdf
rename to report.pdf
index c4977183d1bf39628432d505b09591fb5756f08a..0839a35a8efd09142c20b0581f066284e16f8a45 100644
GIT binary patch
diff --git a/report/report.tex b/report/report.tex
index 9faa59e..f1c8ba2 100644
--- a/report/report.tex
+++ b/report/report.tex
@@ -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}
diff --git a/short-report/short-report.pdf b/short-report.pdf
similarity index 80%
rename from short-report/short-report.pdf
rename to short-report.pdf
index 560d4b3dc7979ce6e8d66d44bea60e31dd4ea434..c84c8863c509e2cdf7dc17f6e93f4925ee2fb1d8 100644
GIT binary patch
diff --git a/short-report/chapters/7-appendix.tex b/short-report/chapters/7-appendix.tex
index ab309c0..d50757d 100644
--- a/short-report/chapters/7-appendix.tex
+++ b/short-report/chapters/7-appendix.tex
@@ -1,7 +1,7 @@
 \begin{appendices}
 
 
-\chapter{Appendix A: Example Appendix}
+\chapter{Example Appendix}
 \label{chapter:appendix-a}
 
 \begin{lstlisting}
diff --git a/short-report/short-report.tex b/short-report/short-report.tex
index 98ce650..aabc403 100644
--- a/short-report/short-report.tex
+++ b/short-report/short-report.tex
@@ -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}]}}
 
 
