diff options
author | Karl Berry <karl@freefriends.org> | 2020-01-15 21:51:17 +0000 |
---|---|---|
committer | Karl Berry <karl@freefriends.org> | 2020-01-15 21:51:17 +0000 |
commit | ca06c2adc9964661159bbb5544ebdd1a8d620ac7 (patch) | |
tree | 84e358ba80a3bc8a6d7b9a240e26660fa8ff080a /Master/texmf-dist/source/latex/axessibility/axessibility.dtx | |
parent | 14a474d3938a000b58ddd4c440338dc727bdc830 (diff) |
axessibility (15jan20)
git-svn-id: svn://tug.org/texlive/trunk@53416 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/source/latex/axessibility/axessibility.dtx')
-rw-r--r-- | Master/texmf-dist/source/latex/axessibility/axessibility.dtx | 1014 |
1 files changed, 1014 insertions, 0 deletions
diff --git a/Master/texmf-dist/source/latex/axessibility/axessibility.dtx b/Master/texmf-dist/source/latex/axessibility/axessibility.dtx new file mode 100644 index 00000000000..7d9cc0ac552 --- /dev/null +++ b/Master/texmf-dist/source/latex/axessibility/axessibility.dtx @@ -0,0 +1,1014 @@ +% +% \iffalse meta-comment +% +% +% Copyright (C) 2018, 2019, 2020 by +% Anna Capietto, Sandro Coriasco, Boris Doubrov, Alexander Koslovski, +% Tiziana Armano, Nadir Murru, Dragan Ahmetovic, Cristian Bernareggi +% +% Based on accsupp and tagpdf +% +% This work consists of the main source files axessibility.dtx and axessibility.lua, +% and the derived files +% axessibility.ins, axessibility.sty, axessibility.pdf, README, +% axessibilityExampleSingleLineT.tex, axessibilityExampleSingleLineA.tex, +%. axessibilityExampleAlignT.tex, axessibilityExampleAlignA.tex +% +% This work may be distributed and/or modified under the +% conditions of the LaTeX Project Public License, either version 1.3 +% of this license or (at your option) any later version. +% The latest version of this license is in +% http://www.latex-project.org/lppl.txt +% and version 1.3 or later is part of all distributions of LaTeX +% version 2005/12/01 or later. +% +% This work has the LPPL maintenance status `maintained'. +% +% The Current Maintainer of this work is +% Sandro Coriasco +% +% \fi +% +%\iffalse +%<*driver> +\documentclass{ltxdoc} +\usepackage{axessibility} +\EnableCrossrefs +\CodelineIndex +\RecordChanges\begin{document} +\title{The \textsf{axessibility} package} +\date{January 8, 2020} + \author{Dragan Ahmetovic\thanks{Dipartimento di Matematica ``G. Peano'', Universit\`a degli Studi di Torino, 10123, Italy}, Tiziana Armano\footnotemark[1], + Cristian Bernareggi\footnotemark[1], Anna Capietto\footnotemark[1], \\ + Sandro Coriasco\footnotemark[1], Boris Doubrov\thanks{Dual Lab, Ottignies-Louvain-la-Neuve 1340, Belgium}, Alexander Kozlovskiy\footnotemark[2], Nadir Murru\footnotemark[1] +%% \\ +%% $ $ +%% \\ +%% Dipartimento di Matematica ``G. Peano''\\Universit\`a degli Studi di Torino \\ +%% Dual Lab, Ottignies-Louvain-la-Neuve 1340, Belgium +%% +\\ + $ $ + \\ + \texttt{<anna.capietto at unito.it>,<sandro.coriasco at unito.it>,}\\ +\texttt{<boris.doubrov at duallab.com>}} +% +\DocInput{axessibility.dtx } +\end{document} +%</driver> +%\fi +% +% \changes{v1.0}{2018/07/09}{Initial version} +% \changes{v2.0}{2019/01/08}{Added support for environments align, align*, alignat, alignat*, flalign, flalign*, gather, gather*, xalignat, xalignat*, and xxalignat, from the package \textbf{amsmath}} +% \changes{v3.0}{2019/xx/yy}{Added option to select between tagging via accsupp or tagpdf packages. Added support for environment multline from the package \textbf{amsmath}. Added option to automatically replace $$ and $$ by \[\] and \(\) in lua mode.} +% +% \maketitle +% +%\begin{abstract} +%PDF documents containing formulae generated by \LaTeX\ +% are usually not accessible by assistive technologies for people with special educational needs +% and visually impaired people +% (i.e., by screen readers and braille displays). The package manages this issue, allowing to create a PDF document where the formulae are read by these assistive technologies, since it automatically generates hidden comments in the PDF document (by means of the /ActualText attribute) in correspondence to each formula. The package does not generate a PDF/UA document. +%\end{abstract} +% +%\tableofcontents +% +%\section{Introduction} +%This package focuses on the specific problem of the accessibility of PDF documents generated by \LaTeX\ for visually impaired people +%and people with special educational needs. +%When a PDF document is generated starting from \LaTeX, formulae are not accessible by screen readers and braille displays. +% They can be made accessible by inserting a hidden comment, i.e., an ActualText, similarly to the case of web pages. +% This can be made, e.g., by using the \LaTeX\ package pdfcomment.sty. In any case, this task must be manually performed by the author and it is surely inefficient, +% since the author should write the formulae and, in addition, insert a description for each formula. +% Note also that the package pdfcomment.sty does not allow to insert special characters like `backslash', `brace', etc, in the comment. +% Moreover, with these solutions, the reading is bothered since the screen reader first reads incorrectly the formula and then, +% only as a second step, provides the correct comment of the formula. +% There are also some \LaTeX\ packages that try to improve the accessibility of PDF documents produced by \LaTeX. +% In particular, the packages accsupp.sty, accessibility$\_$meta.sty and tagpdf have +% been developed in order to obtain tagged PDF documents. The package accsupp.sty develops some interesting tools for commenting formulae +% using also special characters (possibility that is not available, e.g., in the pdfcomment.sty package). The package tagpdf widely +% further developed tagging functionalities, along the most recent specifications for PDF documents accessibility. However, all of the +% above are not automatized methods, +% since the comment and tags must be manually inserted by the author. +% The package accessibility$\_$meta.sty is an improved version of the package accessibility.sty. +% This package allows the possibility of inserting several tags for sections, links, figures and tables. +% However, even if these tags are recognized by the tool for checking tags of Acrobat Reader Pro, they are not always recognized by the screen readers. +% Moreover, this package does not manage formulae. Our package automatically produces an ActualText corresponding to the \LaTeX\ commands that generate the formulae. +% This ActualText is hidden in the PDF document, but the screen reader reads it without reading any incorrect sequence before. +% Additional functionalities, implemented in this version, are available when the typeset is done by means of lua\LaTeX (see below). +% +%\section{License} +% +% This work may be distributed and/or modified under the +% conditions of the LaTeX Project Public License, either version 1.3 +% of this license or (at your option) any later version. +% The latest version of this license is in +% http://www.latex-project.org/lppl.txt +% and version 1.3 or later is part of all distributions of LaTeX +% version 2005/12/01 or later. +% +%\section{Prerequisites} +% +%The package \textbf{axessibility} requires the following packages: \textbf{accsupp, amsmath, amssymb, tagpdf, xstring}. +% +%\section{Package specification} +% +%If you use \LaTeX$2_\epsilon$ simply add the following line in the preamble: +% \begin{itemize} +% \item for the usage based on the \textbf{tagpdf} package,\\ +% +%\indent $\backslash$\textbf{usepackage}$\{$\textbf{axessibility}$\}$\\ +% +% or, equivalently, \\ +% +% $\backslash$\textbf{usepackage[tagpdf]}$\{$\textbf{axessibility}$\}$ +% \item for the usage based on the \textbf{accsupp} package,\\ +% +% $\backslash$\textbf{usepackage[accsupp]}$\{$\textbf{axessibility}$\}$ +% \end{itemize} +% +% \medskip +% +%\noindent The package includes the following features: +%\begin{itemize} +%\item In the \textbf{accsupp} version, the commands\\ \\ +%\indent $\backslash$\textbf{pdfcompresslevel=0} \\ +%\indent $\backslash$\textbf{pdfoptionpdfminorversion=6} \\ \\ +% produce an uncompressed PDF document. The command \\ \\ +%\indent $\backslash$\textbf{BeginAccSupp} +%\\ \\ +%contained in the package \textbf{accsupp}, has been redefined so that the screen readers access the ActualText created by this command. +%\item In the \textbf{tagpdf} version, the commands\\ \\ +%\indent $\backslash$\textbf{tagpdfsetup\{tabsorder=structure,uncompress,activate-all,interwordspace=true\}}\\ +%$\backslash$\textbf{tagpdfifpdftexT}\\ +% \textbf{\{}\\ +% $\backslash$\textbf{pdfcatalog\{/Lang (en-US)\}}\\ +% $\backslash$\textbf{usepackage[T1]\{fontenc\}}\\ +% $\backslash$\textbf{input glyphtounicode}\\ +% $\backslash$\textbf{pdfgentounicode=1}\\ +% \textbf{\}}\\ +%$\backslash$\textbf{tagpdfifluatexT}\\ +% \textbf{\{}\\ +% $\backslash$\textbf{pdfextension catalog\{/Lang (en-US)\}}\\ +% $\backslash$\textbf{RequirePackage\{fontspec\}}\\ +% $\backslash$\textbf{RequirePackage\{luacode\}}\\ +% $\backslash$\textbf{newfontface$\backslash$zerowidthfont\{freeserif\}}\\ +%$\backslash$\textbf{directlua\{}\\ +%\textbf{require("axessibility.lua")}\\ +%\textbf{\}}\\ +%\textbf{\}}\\ +% +%produce an uncompressed PDF document, directing appropriately the typesetting, either via pdf\LaTeX\ or lua\LaTeX. +%Equations (and other structures) are tagged by means of the commands defined in the \textbf{tagpdf} package, so that +%screen readers access the ActualText created by them. When typeset via lua\LaTeX, additional functionalities, implemented +%in the file axessibility.lua, can be activated (see Section \ref{sec:extra} below). +%\item The new commands \\ \\ +%\indent $\backslash$\textbf{wrap$\#$1}\\ +%\indent $\backslash$\textbf{wrapml$\#$1}\\ +%\indent $\backslash$\textbf{wrapmlstar$\#$1} +%\\ \\ +%allow to store their input into an ActualText in the PDF document (e.g., the \LaTeX\ commands for generating a formula), +%for single line and multiple line formulae environments, respectively. +% +%\item The environments \\ \\ +%\indent $\backslash$\textbf{begin}$\{$\textbf{equation}$\}$ \dots $\backslash$\textbf{end}$\{$\textbf{equation}$\}$ \\ +%\indent $\backslash$\textbf{begin}$\{$\textbf{equation*}$\}$ \dots $\backslash$\textbf{end}$\{$\textbf{equation*}$\}$ \\ +%\indent $\backslash$[ \dots $\backslash$]\\ +%\indent $\backslash$( \dots $\backslash$)\\ +% +%have been redefined. In each environment listed above, the command \cs{wrap} is inserted, together with +%the command \cs{collect@body}, so that all the content of the environment is automatically stored into an +% ActualText in the PDF document. The following multiline formula environments, defined in the \textbf{amsmath} package,\\ \\ +%\indent $\backslash$\textbf{begin}$\{$\textbf{align}$\}$ \dots $\backslash$\textbf{end}$\{$\textbf{align}$\}$ \\ +%\indent $\backslash$\textbf{begin}$\{$\textbf{align*}$\}$ \dots $\backslash$\textbf{end}$\{$\textbf{align*}$\}$ \\ +%\indent $\backslash$\textbf{begin}$\{$\textbf{alignat}$\}$ \dots $\backslash$\textbf{end}$\{$\textbf{alignat}$\}$ \\ +%\indent $\backslash$\textbf{begin}$\{$\textbf{alignat*}$\}$ \dots $\backslash$\textbf{end}$\{$\textbf{alignat*}$\}$ \\ +%\indent $\backslash$\textbf{begin}$\{$\textbf{flalign}$\}$ \dots $\backslash$\textbf{end}$\{$\textbf{flalign}$\}$ \\ +%\indent $\backslash$\textbf{begin}$\{$\textbf{flalign*}$\}$ \dots $\backslash$\textbf{end}$\{$\textbf{flalign*}$\}$ \\ +%\indent $\backslash$\textbf{begin}$\{$\textbf{gather}$\}$ \dots $\backslash$\textbf{end}$\{$\textbf{gather}$\}$ \\ +%\indent $\backslash$\textbf{begin}$\{$\textbf{gather*}$\}$ \dots $\backslash$\textbf{end}$\{$\textbf{gather*}$\}$ \\ +%\indent $\backslash$\textbf{begin}$\{$\textbf{xalignat}$\}$ \dots $\backslash$\textbf{end}$\{$\textbf{xalignat}$\}$ \\ +%\indent $\backslash$\textbf{begin}$\{$\textbf{xalignat*}$\}$ \dots $\backslash$\textbf{end}$\{$\textbf{xalignat*}$\}$ \\ +%\indent $\backslash$\textbf{begin}$\{$\textbf{xxalignat}$\}$ \dots $\backslash$\textbf{end}$\{$\textbf{xxalignat}$\}$ \\ +%\indent $\backslash$\textbf{begin}$\{$\textbf{multline}$\}$ \dots $\backslash$\textbf{end}$\{$\textbf{multline}$\}$ \\ +%\indent $\backslash$\textbf{begin}$\{$\textbf{multline*}$\}$ \dots $\backslash$\textbf{end}$\{$\textbf{multline*}$\}$ \\ +% +% have been similarly redefined, using the commands \cs{wrapml} and \cs{wrapmlstar}. +% The content of these environments, too, is now stored into an +% ActualText in the PDF document. The support for more multiline environments will be added in future versions of the package. +%\end{itemize} +% +%\section{Usage}\label{sec:usage} +% +% An author that wants to create an accessible PDF document for visually impaired people, or people with special educational needs, +% can add this package and use the above +% environments for inserting the formulae. The \LaTeX\ code of the inserted formulae will be added as hidden comments in +% correspondence to the location of the formulae in the text. This will allow the user to access the formula code with the screen reader +% and with the braille refreshable display. Additionally, the package enables to copy the formula \LaTeX\ code from the PDF reader +% and paste it elsewhere (concerning this feature, please see also Section \ref{sec:issues} below). +% +% Inline and displayed mathematical modes encoded by means of $\$$ and $\$\$$ are not supported by the package. However, external scripts, +% or a command \textbf{\textbackslash{}doreplacement\{true\}} when typesetting with lua\LaTeX, implement the automatic replacement of these TeX markers by their LaTeX equivalents $\backslash(\backslash)$ and $\backslash[\backslash]$. +% The external scripts are provided as companion software and described in the following section. +% +%Moreover, provided that also the package +% \textbf{eqnalign} is added, the (old) multiline formula environments\\ \\ +%\indent $\backslash$\textbf{begin}$\{$\textbf{eqnarray}$\}$ \dots $\backslash$\textbf{end}$\{$\textbf{eqnarray}$\}$ \\ +%\indent $\backslash$\textbf{begin}$\{$\textbf{eqnarray*}$\}$ \dots $\backslash$\textbf{end}$\{$\textbf{eqnarray*}$\}$ \\ +% +% \noindent will automatically generate the corresponding hidden ActualText. +% + + +% +%\section{External scripts and screen reader integration}\label{sec:extra} +% +%In addition to the package, we also provide scripts and other resources that complement its functionalities. +% +%\subsection{Preprocessing scripts} +%While we warmly suggest to follow the indications provided in the usage guide (suggested commands and environments), it is also +%possible to apply our package to an already existing \LaTeX\ document. In this case, if pdf\LaTeX\ is employed, it is necessary to +%preprocess the document in order to replace some of the unsupported commands and environments with the suggested ones. We provide +%a preprocessing script to handle some of these cases at our Github repository\footnote{\url{www.integr-abile.unito.it/axessibility/?repository}}. Namely, the underscore characters have to be substituted as indicated above when employing the \textbf{accsupp} mode, +% while this is not necessary when the \textbf{tagpdf} mode is selected. $\$$ and $\$\$$ markers must be replaced when typesetting with +%pdf\LaTeX\ both in the \textbf{accsupp} and \textbf{tagpdf} mode. +% +%\subsection{Expansion of user macros} +%Note that custom macros used by the author within the formulae are copied as-is into the ActualText in the hidden comment. This macros may bear no meaning for other readers, so it may be more meaningful to expand those macros into the original \LaTeX\ commands. We provide a script that can parse the \LaTeX\ document and replace all the user macros within the formulae with their expanded definitions. You can download this script at our Github repository\footnotemark[\value{footnote}]. +% +%\subsection{Screen reader dictionaries} +%\LaTeX\ commands that are included as ActualText in the hidden comments corresponding to formulae may appear awkward when read by the screen reader. We provide dictionaries for JAWS and NVDA screen readers that convert \LaTeX\ commands into natural language. Please note that the braille refreshable display will still show the formulae in their original \LaTeX\ representations. The dictionaries can be downloaded at our Github repository\footnotemark[\value{footnote}]. +% +%\subsection{Automatic replacement of $\$$ and $\$\$$ markers in Lua mode} +% Lua mode implements the \LaTeX\ command \textbf{doreplacement} to switch on/off the automatic replacement of $\$$ and $\$\$$ by +% \cs{(} \cs{)} and \cs{[} \cs{]} environments, so that external scripts are no longer required. +% This option is disabled by default and can be switched on or off by the call +% \textbf{\cs{doreplacement}\{true\}} or \textbf{\cs{doreplacement}\{false\}} respectively. +% When enabled, the replacement is applied to every input line, which might have undesired effects in verbatim mode or other +% environments, where $\$$ and $\$\$$ are used as regular symbols. So, it is recommended to switch off the automatic replacement +% functionality in such cases. +% The Lua code implementing the replacement is contained in the second main source file axessibility.lua. Please see the comments +% within the file itself for further explanations. +% +% +% +%\section{Known issues}\label{sec:issues} +% +%Note that, to preserve the compatibility with Acrobat Reader when employing the \textbf{accsupp} mode, our package discourages +%the use of the underscore character ($\_$), which is not correctly read using screen readers in combination with this PDF reader. +%Alternatively, we suggest to use the equivalent command \cs{sb}. The underscore character works correctly when the PDF file +%is produced in the \textbf{tagpdf} mode. +% +% The typeset of documents with \textbf{axessibility} by means of lua\LaTeX\ does not work corrrectly when selecting +% the \textbf{accsupp} mode. +% +% The copy and paste feature described in Section \ref{sec:usage} above does not work correctly at times. We observed that +% it behaves as expected when the NVDA screenreader is active, while it can produce multiple copies of the formula code +% when this software is not running. +% +% The preprocessing scripts do not cover all the possible character/environment combinations, so some errors can be generated, at times, +% when they are employed to perform the underscore, $\$$ and $\$\$$ substitutions. + +%\section{Implementation} +% + +% Standard file identification. + +% \begin{macrocode} +% +\NeedsTeXFormat{LaTeX2e} +\ProvidesPackage{axessibility} +%[2019/11/01 v3.0: Accessibility support by marked content for inline, +% displayed single line, and various displayed multiline formulae] + +%% 'tagpdf' or 'accsupp' option +\newif\iftagpdfopt + +\DeclareOption{accsupp}{ + \tagpdfoptfalse +} + +\DeclareOption{tagpdf}{ + \tagpdfopttrue +} + +\ExecuteOptions{tagpdf} + +\ProcessOptions\relax + +\RequirePackage{amsmath} +\RequirePackage{amssymb} +\RequirePackage{xstring} + +%%% +% to avoid errors in if constructs +%%% +\makeatletter +\long\def\@macronestedifalign{ +\ifingather@ + \restorealignstate@ + \egroup + \nonumber + \ifnum0=`{\fi\iffalse}\fi + \else + $$% + \fi + } + +\long\def\@macronestedifmultline{ + \iftagsleft@ \@xp\lendmultline@ \else \@xp\rendmultline@ \fi +} +% +\makeatother +% +% \end{macrocode} + + +% \begin{macrocode} +% +\iftagpdfopt + %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + % tagpdf option code (default) % + %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%\def\messaggio{option tagpdf} %debug +% +% \end{macrocode} + +% \noindent Setup of the \textbf{tagpdf} package. + +% \begin{macrocode} +% +\RequirePackage{tagpdf} +\tagpdfsetup{tabsorder=structure,uncompress,activate-all,interwordspace=true} +\tagpdfifpdftexT + { + %set language / can also be done with hyperref + \pdfcatalog{/Lang (en-US)} + \usepackage[T1]{fontenc} + \input glyphtounicode + \pdfgentounicode=1 + } +\tagpdfifluatexT + { + %set language / can also be done with hyperref + \pdfextension catalog{/Lang (en-US)} + \RequirePackage{fontspec} + \RequirePackage{luacode} + \newfontface\zerowidthfont{freeserif} +\directlua{ +require("axessibility.lua") +} +} +% +% \end{macrocode} + +% \noindent Tokens used for the treatment of multiline formula environments. + +% \begin{macrocode} +% +\makeatletter + +\newtoks\@mltext +\newtoks\@mltexttmp + +% +% \end{macrocode} + +% \noindent The command \textbf{\textbackslash{}doreplacmeent} with boolean argument switches on or off $\$$ and $\$\$$ replacement by LaTeX environments \cs{(} \cs{)} and \cs{[} \cs{]}. This command works only in Lua mode and allows to avoid the use of external substitution script. It is switched off by default. + +% \begin{macrocode} +% +\newcommand{\doreplacement}[1]{ + \tagpdfifluatexT + \directlua { replace_dls_and_double_dls(#1) } +} +% +% \end{macrocode} + +% \noindent Automatic tagging at the document level. + +% \begin{macrocode} +% +\let\begin@document=\document +\let\end@document=\enddocument +\renewcommand{\document}{\begin@document\tagstructbegin{tag=Document}} +\renewcommand{\enddocument}{\tagstructend\end@document} +\makeatother +% +% \end{macrocode} + + +% \noindent The next function redefines \cs{(} \cs{)} by means of a (temporary) +% math environment that calls the wrapper defined above. + +% \begin{macrocode} +% +\makeatletter +\newenvironment{temp@env}{% + \relax\ifmmode\@badmath\else$\fi% + \collect@body\wrap}{% + \relax\ifmmode\ifinner$\else\@badmath\fi\else \@badmath\fi} +\protected\def\(#1\){\begin{temp@env}#1\end{temp@env}} +\makeatother +% +% \end{macrocode} + + +% \noindent The next command creates a blank space to avoid clash with references (it appears to be a \cs{protect}...). +% Refer to https://tex.stackexchange.com/questions/57151/how-do-i-prevent-conflicts-between-accsupp-and-hyperref +% for possible handling of such issues. + +% \begin{macrocode} +% +\newcommand{\auxiliaryspace}{ } +% +% \end{macrocode} + + +% \noindent The next one is the actual wrapper. It takes the body of a formula environment and wraps it in the \textbf{tagpdf} +% package tagging commands, to make the math-text available in comments. +% \cs{detokenize} allows the formula to be parsed and read as a string. +% \cs{expandafter} there applies to the token "\{" and allows \cs{detokenize} to be applied +% after argument \#1 is passed to the tagging commands. + +% \begin{macrocode} +% +\makeatletter +\long\def\wrap#1{ +\tagstructbegin{tag=P,alttext-o=\detokenize\expandafter{#1}, + actualtext-o=\detokenize\expandafter{#1}} + \tagmcbegin{tag=P,alttext-o=\detokenize\expandafter{#1}, + actualtext-o=\detokenize\expandafter{#1}} + #1 + \tagmcend +\tagstructend +} +\makeatother +% +% \end{macrocode} + +% \noindent The next function redefines \cs{equation} by calling the above wrapper to its argument. +% This makes \cs{equation} accessible. + +% \begin{macrocode} +% +\makeatletter +\renewenvironment{equation}{% + \incr@eqnum + \mathdisplay@push + \st@rredfalse \global\@eqnswtrue + \mathdisplay{equation}% + \collect@body\wrap\auxiliaryspace}{% + \endmathdisplay{equation}% + \mathdisplay@pop + \ignorespacesafterend +} +\makeatother +% +% \end{macrocode} + + +% \noindent The next function redefines \cs{equation*} +% by calling the above wrapper to its argument. +% This makes \cs{equation*} accessible. + +% \begin{macrocode} +% +\makeatletter +\renewenvironment{equation*}{% + \mathdisplay@push + \st@rredtrue \global\@eqnswfalse + \mathdisplay{equation*}% + \collect@body\wrap\auxiliaryspace}{% + \endmathdisplay{equation*}% + \mathdisplay@pop + \ignorespacesafterend +} +\makeatother +% +% \end{macrocode} + + +% \noindent The next function redefines \cs{[} \cs{]}, +% using the above redefinition of \cs{equation*}. + +% \begin{macrocode} +% +\makeatletter +\protected\def\[#1\]{\begin{equation*}#1\end{equation*}} +\makeatother +% +% \end{macrocode} + + +% \noindent The next wrappers, similar to the previous one, are used to handle multiline formula environments. +% Here some additional step is needed to obtain the desired content, to be stored via the tagging commands. + +% \begin{macrocode} +% +\makeatletter + +\long\def\wrapml#1{ +\def\@mltext{\detokenize\expandafter{#1}} +\def\@mltexttmp{} +\StrBehind[6]{\@mltext}{ }[\@mltexttmp] +\StrGobbleRight{\@mltexttmp}{1}[\@mltext] +\tagstructbegin{tag=P,alttext-o=\detokenize\expandafter{\@mltext}, + actualtext-o=\detokenize\expandafter{\@mltext}} + \tagmcbegin{tag=P,alttext-o=\detokenize\expandafter{\@mltext}, + actualtext-o=\detokenize\expandafter{\@mltext}} + #1 +} + +% +% This one should be \wrapml parametrized \StrBehind[5] +% +\long\def\wrapmlstar#1{ +\def\@mltext{\detokenize\expandafter{#1}} +\def\@mltexttmp{} +\StrBehind[5]{\@mltext}{ }[\@mltexttmp] +\StrGobbleRight{\@mltexttmp}{1}[\@mltext] +\tagstructbegin{tag=P,alttext-o=\detokenize\expandafter{\@mltext}, + actualtext-o=\detokenize\expandafter{\@mltext}} + \tagmcbegin{tag=P,alttext-o=\detokenize\expandafter{\@mltext}, + actualtext-o=\detokenize\expandafter{\@mltext}} + #1 +} + +% +% This one should be \wrapml parametrized = \wrapmlstar +% +\long\def\wrapmlalt#1{ +\def\@mltext{\detokenize\expandafter{#1}} +\def\@mltexttmp{} +\StrBehind[5]{\@mltext}{ }[\@mltexttmp] +\StrGobbleRight{\@mltexttmp}{1}[\@mltext] +\tagstructbegin{tag=P,alttext-o=\detokenize\expandafter{\@mltext}, + actualtext-o=\detokenize\expandafter{\@mltext}} + \tagmcbegin{tag=P,alttext-o=\detokenize\expandafter{\@mltext}, + actualtext-o=\detokenize\expandafter{\@mltext}} + #1 +} + +\makeatother +% +% \end{macrocode} + + +% \noindent The next functions redefine the environments align, align*, alignat, alignat*, flalign, flalign*, gather, gather*, +% xalignat, xalignat*, xxalignat, multline, multline*, originally defined in the package \textbf{amsmath}, by calling the +% above multiline wrapper to their +% argument. The structure, as for the original macros, is essentially the same for all of them. + +% \begin{macrocode} +% +\makeatletter + +\renewenvironment{align}{% + \collect@body\wrapml\auxiliaryspace + \start@align\@ne\st@rredfalse\m@ne +}{% + \math@cr \black@\totwidth@ + \egroup + \@macronestedifalign + \ignorespacesafterend + \tagmcend + \tagstructend +} + +\renewenvironment{align*}{% + \collect@body\wrapmlstar\auxiliaryspace + \start@align\@ne\st@rredtrue\m@ne +}{% + \endalign +} + +\renewenvironment{alignat}{% + \collect@body\wrapml\auxiliaryspace\auxiliaryspace + \start@align\z@\st@rredfalse +}{% + \endalign +} + +\renewenvironment{alignat*}{% + \collect@body\wrapmlstar\auxiliaryspace + \start@align\z@\st@rredtrue +}{% + \endalign +} + +\renewenvironment{xalignat}{% + \collect@body\wrapmlalt\auxiliaryspace + \start@align\@ne\st@rredfalse +}{% + \endalign +} + +\renewenvironment{xalignat*}{% + \collect@body\wrapmlstar\auxiliaryspace + \start@align\@ne\st@rredtrue +}{% + \endalign +} + +\renewenvironment{xxalignat}{% + \collect@body\wrapmlalt\auxiliaryspace + \start@align\tw@\st@rredtrue +}{% + \endalign +} + +\renewenvironment{flalign}{% + \collect@body\wrapml\auxiliaryspace + \start@align\tw@\st@rredfalse\m@ne +}{% + \endalign +} + +\renewenvironment{flalign*}{% + \collect@body\wrapmlstar\auxiliaryspace + \start@align\tw@\st@rredtrue\m@ne +}{% + \endalign +} + +\renewenvironment{gather}{% + \collect@body\wrapmlalt\auxiliaryspace\auxiliaryspace + \start@gather\st@rredfalse +}{% + \math@cr \black@\totwidth@ \egroup + $$\ignorespacesafterend + \tagmcend + \tagstructend +} + +\renewenvironment{gather*}{% + \collect@body\wrapmlstar\auxiliaryspace\auxiliaryspace + \start@gather\st@rredtrue +}{% + \endgather +} + +\renewenvironment{multline}{% + \collect@body\wrapmlalt\auxiliaryspace\auxiliaryspace + \start@multline\st@rredfalse +}{% +% \iftagsleft@ \@xp\lendmultline@ \else \@xp\rendmultline@ \fi + \@macronestedifmultline + \ignorespacesafterend + \tagmcend + \tagstructend +} + +\renewenvironment{multline*}{ + \collect@body\wrapmlstar\auxiliaryspace\auxiliaryspace + \start@multline\st@rredtrue +}{ + \endmultline +} + +\makeatother +% +% \end{macrocode} + +%%%% +% End of tagpdf option code +%%%% + +% \begin{macrocode} +% +\else + %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + % accsupp option code % + %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%\def\messaggio{option accsupp} %debug + +\RequirePackage{accsupp} + +%\RequirePackage{amsmath} +%\RequirePackage{amssymb} +%\RequirePackage{xstring} +% \noindent PDF compression/unicode settings. + + +\pdfcompresslevel=0 +\pdfoptionpdfminorversion=6 +\input{glyphtounicode} +\pdfgentounicode=1 +% +% \end{macrocode} + + +% \noindent Tokens used for the treatment of multiline formula environments. + +% \begin{macrocode} +% + +\makeatletter + +\newtoks\@mltext +\newtoks\@mltexttmp + +\makeatother +% +% \end{macrocode} + + +% \noindent Renewed command \cs{BeginAccSupp}, originally defined in the package \textbf{accsupp}, +% to add the string \cs{S} before \cs{span}. +% This makes the formula readable by screenreading technologies. + +% \begin{macrocode} +% +\makeatletter +\renewcommand*{\BeginAccSupp}[1]{% + \begingroup + \setkeys{ACCSUPP}{#1}% + \edef\ACCSUPP@span{% + /S/Span<<% + \ifx\ACCSUPP@Lang\relax + \else + /Lang\ACCSUPP@Lang + \fi + \ifx\ACCSUPP@Alt\relax + \else + /Alt\ACCSUPP@Alt + \fi + \ifx\ACCSUPP@ActualText\relax + \else + /ActualText\ACCSUPP@ActualText + \fi + \ifx\ACCSUPP@E\relax + \else + /E\ACCSUPP@E + \fi + >>% + }% + \ACCSUPP@bdc + \ACCSUPP@space + \endgroup +} +\makeatother +% +% \end{macrocode} + + +% \noindent The next command creates a blank space to avoid clash with references (it appears to be a \cs{protect}...). +% Refer to https://tex.stackexchange.com/questions/57151/how-do-i-prevent-conflicts-between-accsupp-and-hyperref +% for possible handling of such issues. + +% \begin{macrocode} +% +\newcommand{\auxiliaryspace}{ } +% +% \end{macrocode} + + +% \noindent The next one is the actual wrapper. It takes the body of a formula environment and wraps it in AccSupp +% commands, to make the math-text available in comments. +% \cs{detokenize} allows the formula to be parsed and read as a string. +% \cs{expandafter} there applies to the token "\{" and allows \cs{detokenize} to be applied +% after argument \#1 is passed to \cs{BeginAccSupp}. + +% \begin{macrocode} +% +\makeatletter +\long\def\wrap#1{ +\BeginAccSupp{method=escape,ActualText=\detokenize\expandafter{#1}} + #1 +\EndAccSupp{}% +} +\makeatother +% +% \end{macrocode} + + +% \noindent The next wrapper, similar to the previous one, is used to handle multiline formula environments. +% Here some additional step is needed to obtain the desired content, to be stored via \cs{BeginAccSupp}. + +% \begin{macrocode} +% +\makeatletter +\long\def\wrapml#1{ +\def\@mltext{\detokenize\expandafter{#1}} +\def\@mltexttmp{} +\StrBehind[5]{\@mltext}{ }[\@mltexttmp] +\StrGobbleRight{\@mltexttmp}{1}[\@mltext] +% +\BeginAccSupp{method=escape,ActualText=\auxiliaryspace\@mltext} + #1 +\EndAccSupp{}% +} +\makeatother +% +% \end{macrocode} + + + +% \noindent The next function redefines \cs{equation} by calling the above wrapper to its argument. +% This makes \cs{equation} accessible. + +% \begin{macrocode} +% +\makeatletter +\renewenvironment{equation}{% + \incr@eqnum + \mathdisplay@push + \st@rredfalse \global\@eqnswtrue + \mathdisplay{equation}% + \collect@body\wrap\auxiliaryspace}{% + \endmathdisplay{equation}% + \mathdisplay@pop + \ignorespacesafterend +} +\makeatother +% +% \end{macrocode} + + +% \noindent The next function redefines \cs{equation*} +% by calling the above wrapper to its argument. +% This makes \cs{equation*} accessible. + +% \begin{macrocode} +% +\makeatletter +\renewenvironment{equation*}{% + \mathdisplay@push + \st@rredtrue \global\@eqnswfalse + \mathdisplay{equation*}% + \collect@body\wrap\auxiliaryspace}{% + \endmathdisplay{equation*}% + \mathdisplay@pop + \ignorespacesafterend +} +\makeatother +% +% \end{macrocode} + + +% \noindent The next function redefines \cs{[} \cs{]}, +% using the above redefinition of \cs{equation*} + +% \begin{macrocode} +% +\makeatletter +\protected\def\[#1\]{\begin{equation*}#1\end{equation*}} +\makeatother +% +% \end{macrocode} + + +% \noindent The next function redefines \cs{(} \cs{)} by means of a (temporary) +% math environment that calls the wrapper defined above. + +% \begin{macrocode} +% +\makeatletter +\newenvironment{tempenv}{% + \relax\ifmmode\@badmath\else$\fi% + \collect@body\wrap}{% + \relax\ifmmode\ifinner$\else\@badmath\fi\else \@badmath\fi} +\protected\def\(#1\){\begin{tempenv}#1\end{tempenv}} +\makeatother +% +% \end{macrocode} + + +% \noindent The next functions redefine the environments align, align*, alignat, alignat*, flalign, flalign*, gather, gather*, +% xalignat, xalignat*, xxalignat, multline, multline*, originally defined in the package \textbf{amsmath}, by calling the +% above multiline wrapper to their +% argument. The structure, as for the original macros, is essentially the same for all of them. + +% \begin{macrocode} +% +\makeatletter + +\renewenvironment{align}{% + \collect@body\wrapml\auxiliaryspace + \start@align\@ne\st@rredfalse\m@ne +}{% + \math@cr \black@\totwidth@ + \egroup + \@macronestedifalign + \ignorespacesafterend +} + +\renewenvironment{align*}{% + \collect@body\wrapml\auxiliaryspace + \start@align\@ne\st@rredtrue\m@ne +}{% + \endalign +} + +\renewenvironment{alignat}{% + \collect@body\wrapml\auxiliaryspace + \start@align\z@\st@rredfalse +}{% + \endalign +} +\renewenvironment{alignat*}{% + \collect@body\wrapml\auxiliaryspace + \start@align\z@\st@rredtrue +}{% + \endalign +} +\renewenvironment{xalignat}{% + \collect@body\wrapml\auxiliaryspace + \start@align\@ne\st@rredfalse +}{% + \endalign +} +\renewenvironment{xalignat*}{% + \collect@body\wrapml\auxiliaryspace + \start@align\@ne\st@rredtrue +}{% + \endalign +} +\renewenvironment{xxalignat}{% + \collect@body\wrapml\auxiliaryspace + \start@align\tw@\st@rredtrue +}{% + \endalign +} +\renewenvironment{flalign}{% + \collect@body\wrapml\auxiliaryspace + \start@align\tw@\st@rredfalse\m@ne +}{% + \endalign +} + +\renewenvironment{flalign*}{% + \collect@body\wrapml\auxiliaryspace + \start@align\tw@\st@rredtrue\m@ne +}{% + \endalign +} + +\renewenvironment{gather}{% + \collect@body\wrapml\auxiliaryspace\auxiliaryspace + \start@gather\st@rredfalse +}{% + \math@cr \black@\totwidth@ \egroup + $$\ignorespacesafterend +} + +\renewenvironment{gather*}{% + \collect@body\wrapml\auxiliaryspace\auxiliaryspace + \start@gather\st@rredtrue +}{% + \endgather +} + +\renewenvironment{multline}{% + \collect@body\wrapml\auxiliaryspace\auxiliaryspace + \start@multline\st@rredfalse +}{% + %\iftagsleft@ \@xp\lendmultline@ \else \@xp\rendmultline@ \fi + \@macronestedifmultline + \ignorespacesafterend +} + +\renewenvironment{multline*}{ + \collect@body\wrapml\auxiliaryspace\auxiliaryspace + \start@multline\st@rredtrue +}{ + \endmultline +} + +%%} +%% +\makeatother +%%%% +% End of accsupp option code +%%%% +\fi +% +% \end{macrocode} +% +% \noindent +% For the automatic $\$$ and $\$\$$ replacement code, please see the second main source file axessibility.lua. +% +%\section{History} +%\noindent \textbf{[2018/07/09: v1.0] } +%\begin{itemize} +% \item First version (with Michele Berra, Alice Ruighi, and Eugenia Taranto). +%\end{itemize} +%\noindent \textbf{[2019/01/08: v2.0] } +%\begin{itemize} +% \item Added support for environments align, align*, alignat, alignat*, flalign, flalign*, gather, gather*, xalignat, xalignat*, and xxalignat, from the package \textbf{amsmath} (with Michele Berra, Alice Ruighi, and Eugenia Taranto). +%\end{itemize} +%\noindent \textbf{[2020/01/08: v3.0] } +%\begin{itemize} +% \item Added selection option, to choose between tagging via accsupp or tagpdf packages. Added support for environment +% multline and multline* from the package \textbf{amsmath}. Added the second main source file axessibility.lua, containing code +% that can be activated when typesetting with lua\LaTeX. +%\end{itemize} + +\endinput +%% +%% End of file `axessibility.sty'. |