Accessibiliy Features¶

Activate Accessibility Features¶

Add a11y to the documentclass options:

\documentclass[…,a11y]{cocotex}

Paragraph tagging¶

Until further notice, text paragraphs need to be tagged by the converter by adding \ccaStructStart{P} at the beginning of each paragraph (no whitespaces between the macro and subsequent text or other macros!) and \ccaStructEnd{P} at the end of each paragraph (no whitespaces before \ccaStructEnd!):

\ccaStructStart{P}Ipsum Lorem … finis.\ccaStructEnd{P}

This must also be done in broader contexts that may(!) contain multiple paragraphs of plain text, like footnotes, captions, list items, quotations, table cells or abstracts. Which ones exactly varies from publisher style to publisher style, so if in doubt, ask your friendly neighborhood TeX developer.

Alternative Texts¶

Figures and Math both need alternative texts.

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.

\incudegraphics[...,alt={This is what the image file shows}]{image.png}

or as \tpAltText inside the tpFigure or tpSubFloat environments:

\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}

If both exist, the alt in \includegraphics takes precedence over the \tpAltText.

Math¶

both inline and display style math needs alternative texts. This is done with the \ccaAddAltText macro:

\begin{equation*}\ccaAddAltText{Z equals x minus mu divided by sigma}%
  \mathbf{Z}=\,\frac{\boldsymbol{x}-\mathbf{\mu }}{\mathbf{\sigma }}
\end{equation*}

or, for inline math:

The Variable $x\addAltText{x}$ means...

XMP Meta Data¶

• Template.xmp

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 (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 the template!

Also be cautious where to use rdf:Bag, rdf:Alt and rdf:Seq!

Use the following XML tags for meta data:

Author¶

is a list of the document's main authors or edtiors, one per line:

<dc:creator>
  <rdf:Seq>
    <rdf:li>Firstname Lastname</rdf:li>
    <rdf:li>Firstname Lastname</rdf:li>
    ...
  </rdf:Seq>
</dc:creator>

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

<dc:title>
  <rdf:Alt>
    <rdf:li xml:lang="x-default">Default title</rdf:li>
  </rdf:Alt>
</dc:title>

Publisher¶

<dc:publisher>
  <rdf:Bag>
    <rdf:li>Publisher Name</rdf:li>
  </rdf:Bag>
</dc:publisher>

Chapter authors/Contributors¶

<dc:contributor>
  <rdf:Bag>
    <rdf:li>Firstname Lastname</rdf:li>
    <rdf:li>Firstname Midname Lastname</rdf:li>
    ...
  </rdf:Bag>
</dc:contributor>

Abstract¶

Like dc:title, dc:description allows multiple entries for different languages.

<dc:description>
  <rdf:Alt>
    <rdf:li xml:lang="x-default">...</rdf:li>
  </rdf:Alt>
</dc:description>

Keywords¶

<dc:subject>
  <rdf:Bag>
    <rdf:li>keyword 1</rdf:li>
    <rdf:li>keyword 2</rdf:li>
    ....
  </rdf:Bag>
</dc:subject>

Copyright¶

<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>

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.

Colours and Embedded Images¶

The colour spaces of embedded images must match the Output Indent of the PDF file for the latter to be PDF/A2-a compatible. By default, CoCoTeX puts CMYK as output intent, but this can be overridden with the color-env class option.

\documentclass[…,color-env=<space>,…]{cocotex}

with <space> either srgb, rgb, gray, cmy, cmyk (default when a11y), natural (no automatic conversion of custom colours, see below), or none (xcolor package is not loaded).

Custom document colours get automatically converted to the Output Intent color space by LaTeX, so they may be defined with any color model. The following colour definitions are roughly equivalent:

\definecolor{myblue}{HTML}{3527FF}
\definecolor{myblue}{RGB}{53,39,255}
\definecolor{myblue}{rgb}{0.21,0.15,1}
\definecolor{myblue}{cmyk}{0.79,0.85,0,0}