Accessibiliy Features » Historie » Revision 12
Revision 11 (Patrick Schulz, 16.09.2024 13:03) → Revision 12/23 (Patrick Schulz, 16.09.2024 13:45)
h1. Accessibiliy Features
h2. Activate Accessibility Features
Add @a11y@ to the documentclass options:
<pre><code>
\documentclass[…,a11y]{cocotex}
</code></pre>
h2. Paragraph tagging
Until further notice, text paragraphs need to be tagged by the converter by adding @\ccaStructStart{Para}@ at the beginning of each paragraph (no whitespaces between the macro and subsequent text or other macros!) and @\ccaStructEnd{Para}@ at the end of each paragraph (no whitespaces before @\ccaStructEnd@!):
<pre>
\ccaStructStart{Para}Ipsum Lorem … finis.\ccaStructEnd{Para}
</pre>
This must also be done in broader contexts that may(!) contain multiple paragraphs of plain text, like footnotes, captions, list items, quotations, or abstracts. Which ones exactly varies from publisher style to publisher style, so if in doubt, ask your friendly neighborhood TeX developer.
h2. Alternative Texts
Figures and Math both need alternative texts.
h4. Figures
For figures, there are two ways to encode alt-text: the @alt@ Parameter in the optional argument of @\includegraphics@ (needs texlive > 2021), e.g.
<pre>\incudegraphics[...,alt={This is what the image file shows}]{image.png}</pre>
or as @\tpAltText@ inside the @tpFigure@ or @tpSubFloat@ environments:
<pre>\begin{tpFigure}
\tpCaption{This is the caption}
\tpAltText{This is the alt text. It MUST NOT be the same as the caption!}
\tpFig{\includegraphics{image.png}}
\end{tpFigure}</pre>If both exist, the @alt@ in @\includegraphics@ takes precedence over the @\tpAltText@.
h4. Math
both inline and display style math needs alternative texts. This is done with the @\ccaAddAltText@ macro:
<pre>
\begin{equation*}\ccaAddAltText{Z equals x minus mu divided by sigma}%
\mathbf{Z}=\,\frac{\boldsymbol{x}-\mathbf{\mu }}{\mathbf{\sigma }}
\end{equation*}
</pre>
or, for inline math:
<pre>The Variable $x\addAltText{x}$ means...</pre>
h2. XMP Meta Data
* ***"Template.xmp":https://redmine.le-tex.de/attachments/27865***
PDF/UA requires meta data to be embedded into the PDF file. CoCoTeX provides two ways to do that: If the TeX run does not find a xmp file that has the same basename as the .tex document, it generates one from the data in the tpMeta environment. If there is a .xmp file (either because it was there from the beginning, or it was generated during a previous tex run), it includes that one. If the xmp file is to be generated by the converter, make sure to use the "attached template.xmp":https://redmine.le-tex.de/attachments/27865 (see below) and include the document specific meta data in line 24 instead of the comment.
***Important: Don't remove anything in that template, especially not the PIs at the beginning and end, and the blank spaces at the bottom of if the template!***
Also be cautious where to use @rdf:Bag@, @rdf:Alt@ and @rdf:Seq@!
Use the following XML tags for meta data:
h4. Author
is a list of the document's main authors or edtiors, one per line:
<pre><code class="xml">
<dc:creator>
<rdf:Seq>
<rdf:li>Firstname Lastname</rdf:li>
<rdf:li>Firstname Lastname</rdf:li>
...
</rdf:Seq>
</dc:creator>
</code></pre>
h4. Document Title
There can be more than one document title for various languages. The displayed title (e.g. in the pdf viewer window's top line) depends on the selected system language
<pre><code class="xml">
<dc:title>
<rdf:Alt>
<rdf:li xml:lang="x-default">Default title</rdf:li>
</rdf:Alt>
</dc:title>
</code></pre>
h4. Publisher
<pre><code class="xml">
<dc:publisher>
<rdf:Bag>
<rdf:li>Publisher Name</rdf:li>
</rdf:Bag>
</dc:publisher>
</code></pre>
h4. Chapter authors/Contributors
<pre><code class="xml">
<dc:contributor>
<rdf:Bag>
<rdf:li>Firstname Lastname</rdf:li>
<rdf:li>Firstname Midname Lastname</rdf:li>
...
</rdf:Bag>
</dc:contributor>
</code></pre>
h4. Abstract
Like @dc:title@, @dc:description@ allows multiple entries for different languages.
<pre><code class="xml">
<dc:description>
<rdf:Alt>
<rdf:li xml:lang="x-default">...</rdf:li>
</rdf:Alt>
</dc:description>
</code></pre>
h4. Keywords
<pre><code class="xml">
<dc:subject>
<rdf:Bag>
<rdf:li>keyword 1</rdf:li>
<rdf:li>keyword 2</rdf:li>
....
</rdf:Bag>
</dc:subject>
</code></pre>
h4. Copyright
<pre><code class="xml">
<dc:rights>
<rdf:Alt>
<rdf:li xml:lang="x-default">Unless otherwise indicated, this work is licensed under a Creative Commons License Attribution 4.0 International. This does not apply to quoted content and works based on other permissions.</rdf:li>
</rdf:Alt>
</dc:rights>
</code></pre>
h4. Other
If you must, you can _alter_ the values of @<pdf:Producer>@ and @<xmp:CreatorTool>@, where @pdf:Producer@ is the tool that generated the PDF, and @xmp:CreatorTool@ is the Tool with which the original manuscript was created prior to any conversions or transformations.
The values of @xmp:ModifyDate@ and @xmp:CreateDate@ are generated and overwritten during the tex run by the ltpdfa package, so you can leave those fields as they are.