Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
56 changes: 52 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,7 @@ something. Stylewise, be sure to follow the conventions of your discipline!
\begin{figure}
\centering
\includegraphics[alt={Alt text}]{image}
\caption{Caption}
\caption[Optional short title to appear in list of figures]{Caption}
\label{fig:image}
\end{figure}
```
Expand All @@ -164,7 +164,7 @@ something. Stylewise, be sure to follow the conventions of your discipline!
```latex
\begin{table}
\centering
\caption{Caption}
\caption[Optional short title to appear in list of tables]{Caption}
\tagpdfsetup{table/header-rows={1}}
\begin{tabular}{|l|l|}
\hline
Expand All @@ -185,10 +185,53 @@ something. Stylewise, be sure to follow the conventions of your discipline!
Use multirow and multicolumn layouts in tables with caution. It *may* be
possible to use the `multirow` package if you load `array` [first][7].

## Validation

There are currently no perfect tools for testing PDFs for digital accessibility.
This template is tested using [veraPDF][8], an industry-supported, open-source
tool. You can [download veraPDF from its website][9], or you can install it via
`conda-forge`:

```bash
conda install -c conda-forge verapdf
```

> [!TIP]
> If you are installing by conda on a Mac computer with Apple silicon, you will
> need to configure your environment for x86_64 because the feedstock does not
> currently support ARM-based processors.
>
> ```bash
> conda config --env --set subdir osx-64
> ```

Once installed, you can validate your compiled document for PDF/UA-2:

```bash
verapdf -f ua2 --format html main.pdf > verapdf-ua-2.html
```

To test against [Web Content Accessibility Guidelines (WCAG) 2.2][10],
first [download the veraPDF validation profiles][11] and and extract them to
`veraPDF-validation-profiles`. Then,

```bash
verapdf --profile veraPDF-validation-profiles/PDF_UA/WCAG-2-2-Complete-PDF20.xml \
--format html main.pdf > verapdf-wcag-2.2.html
```

Review the reports and address any issues! Please note, though, that some
aspects of compliance may still need to be checked manually.

> [!WARNING]
> The [PDF Accessibility Checker (PAC)][12] is another commonly used validator;
> however, it may currently interpret elements of PDF 2.0 files, which is the
> file format for this template, as errors.

## License and credits

This template is made available under an [MIT License](./LICENSE). It was
adapted from [uiucthesis][8] under its license:
adapted from [uiucthesis][13] under its license:

```
MIT License
Expand Down Expand Up @@ -221,4 +264,9 @@ SOFTWARE.
[5]: https://latex3.github.io/tagging-project/tagging-status
[6]: https://auburn.edu/about/academic-calendar
[7]: https://github.com/graduatecollege/uofithesis/issues/6#issuecomment-4057268158
[8]: https://github.com/graduatecollege/uofithesis
[8]: https://verapdf.org
[9]: https://docs.verapdf.org/install
[10]: https://www.w3.org/TR/WCAG22
[11]: http://github.com/veraPDF/veraPDF-validation-profiles
[12]: https://pac.pdf-accessibility.org
[13]: https://github.com/graduatecollege/uofithesis
2 changes: 1 addition & 1 deletion chapter/02/02.tex
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ \chapter{Coffee Berries}
berries clustered together on coffee tree branches}]{
Clumps_of_coffee_berries_growing_on_a_tree_by_Brian_Smith.jpg
}
\caption{Clumps of coffee berries growing on a tree (Photo by Brian Smith)}
\caption[Clumps of coffee berries growing on a tree]{Clumps of coffee berries growing on a tree (Photo by Brian Smith)}
\label{ch2:fig:coffee_berries}
\end{figure}

Expand Down
Loading