Tagging issues 777 and 778 (#1607)

* handle tagging/777 (par for \mainmatter) * Âtestfiles,changes.txt for latex3/tagging-project#777 and latex3/tagging-project#778 * add luatex testfile * use ARIA role for presentation tables. * update changes.txt text * reenable the div option for presentation tables, WIP * correct docu * extend test file * forgot lvt * update changes.txt * from review * better command name
latex3 · Jan 16, 2025 · 33f80ff · 33f80ff
1 parent 87372f4
commit 33f80ff
Show file tree

Hide file tree

Showing 9 changed files with 19,135 additions and 146 deletions.
diff --git a/required/latex-lab/changes.txt b/required/latex-lab/changes.txt
@@ -1,3 +1,8 @@
+2025-01-05 Ulrike Fischer <[email protected]>
+	* latex-lab-sec.dtx: add \par before \mainmatter etc (tagging/777)
+	* latex-lab-table.dtx: use ARIA-role as default for presentation tables (tagging/778), add option to use Div-structures instead of Table. 
+
+
 2024-12-27  Frank Mittelbach  <[email protected]>
 
 	* latex-lab-table.dtx,latex-lab-toc-kernel-changes.dtx,

diff --git a/required/latex-lab/latex-lab-sec.dtx b/required/latex-lab/latex-lab-sec.dtx
@@ -16,8 +16,8 @@
 %
 % for those people who are interested or want to report an issue.
 %
-\def\ltlabsecdate{2024-10-04}
-\def\ltlabsecversion{0.84f}
+\def\ltlabsecdate{2025-01-05}
+\def\ltlabsecversion{0.84g}
 %<*driver>
 \documentclass[kernel]{l3doc}
 \EnableCrossrefs
@@ -359,11 +359,12 @@
 %
 % The commands \cs{mainmatter}, \cs{backmatter}, \cs{frontmatter} and
 % \cs{appendix} close all \texttt{Sect} and \texttt{Part} structures.
+% \changes{v0.84g}{2025/01/05}{ensure that paragraph is ended (tagging/777)}
 %    \begin{macrocode}
-\AddToHook{cmd/frontmatter/before}{\@@_sec_end:n{-10}}
-\AddToHook{cmd/mainmatter/before} {\@@_sec_end:n{-10}}
-\AddToHook{cmd/backmatter/before} {\@@_sec_end:n{-10}}
-\AddToHook{cmd/appendix/before}   {\@@_sec_end:n{-10}}
+\AddToHook{cmd/frontmatter/before}{\par\@@_sec_end:n{-10}}
+\AddToHook{cmd/mainmatter/before} {\par\@@_sec_end:n{-10}}
+\AddToHook{cmd/backmatter/before} {\par\@@_sec_end:n{-10}}
+\AddToHook{cmd/appendix/before}   {\par\@@_sec_end:n{-10}}
 %    \end{macrocode}
 %
 % \subsection{Tagging tools}

diff --git a/required/latex-lab/latex-lab-table.dtx b/required/latex-lab/latex-lab-table.dtx
@@ -16,8 +16,8 @@
 %
 % for those people who are interested or want to report an issue.
 %
-\def\ltlabtbldate{2024-12-27}
-\def\ltlabtblversion{0.85o}
+\def\ltlabtbldate{2025-01-05}
+\def\ltlabtblversion{0.85p}
 %<*driver>
 \documentclass{l3doc}
 \EnableCrossrefs
@@ -138,17 +138,24 @@
 % as a layout to ensure that the content is properly aligned
 % or because it is a not yet (fully) supported table structure, 
 % the tagging can be disabled with
-% \verb|\tagpdfsetup{table/tagging=false}| or with \verb|\tagpdfsetup{table/tagging=presentation}|%
+% \verb|\tagpdfsetup{table/tagging=false}| or changed with 
+% \verb|\tagpdfsetup{table/tagging=presentation}| or \verb|\tagpdfsetup{table/tagging=div}|%
 % \footnote{The key has been renamed. The old name `table-tagging` still works but is 
 % deprecated. The value \texttt{presentation} refers to the ARIA role \enquote{presentation}.}
 % The first option disables the table tagging code and the content of the tabular
 % is then treated more or less like running text. This works ok for simple tables using
 % only hmode-cells (l/c/r) with normal text content, but fails if the table uses vmode-cells
-% (p/m/b). In such cases the second option works better: it keeps the tagging code active
-% but changes the tag names to \texttt{Div} and the grouping structure \texttt{NonStruct}. It also
-% (re)sets the \texttt{table/header-rows} key to empty. 
-% The key should currently only be used in a group as there is no key (yet) to reset to the default 
-% tag names.
+% (p/m/b). In such cases the second option works better: it keeps the tagging code active,
+% but adds an ARIA-role as attribute to indicate that this is a presentation table. 
+% When deriving to html this gives the best result
+% as it keeps the layout.
+% The last option changes the tag names and creates simply a number of DIV structures. 
+% Both options also
+% (re)set the \texttt{table/header-rows} and \texttt{table/header-columns} keys to empty. 
+% 
+% To reset to the normal tagging in the current group (e.g. inside a presentation
+% table) one can use \verb|\tagpdfsetup{table/tagging=true}| (and if needed reenable the headers).
+% 
 %
 % \subsection{Header rows and columns}
 % There is some basic support\footnote{This is not meant to be the
@@ -228,7 +235,8 @@
 % \item Not every table should be tagged as a Table structure, often they are
 % only used as layout help, e.g. to align authors in a title pages. In such uses
 % the tagging of the table must be deactivated with \verb|\tagpdfsetup{table/tagging=false}|
-% or \verb|\tagpdfsetup{table/tagging=presentation}|.
+% or changed with \verb|\tagpdfsetup{table/tagging=presentation}| or 
+% \verb|\tagpdfsetup{table/tagging=div}|.
 %
 % \item Only simple header rows and columns are currently supported. Complex headers with
 % subheaders will be handled later as that needs some syntax changes. Tables
@@ -827,9 +835,6 @@
 %    \end{macrocode}
 % \end{plugdecl}
 %
-%
-%
-%
 % \begin{plugdecl}{Table}
 %    \begin{macrocode}
 \NewSocketPlug{tagsupport/tbl/hmode/begin}{Table}
@@ -847,6 +852,26 @@
   }
 %    \end{macrocode}
 % \end{plugdecl}
+% 
+% \begin{plugdecl}{LayoutTable}
+% \changes{v0.85p}{2025/01/05}{new plugs for layout tables (tagging/778)}
+% This plug is meant for presentation tables, it sets the ARIA role.
+%    \begin{macrocode}
+\NewSocketPlug{tagsupport/tbl/hmode/begin}{LayoutTable}
+  {
+    \tag_mc_end_push:
+%    \end{macrocode}
+%    Close the P-chunk. This assumes that para-tagging is active.
+%    For nested tables that is not necessarily true, so we test for it.
+%    \begin{macrocode}
+     \bool_lazy_and:nnT
+      { \bool_if_exist_p:N \l__tag_para_bool } { \l__tag_para_bool }
+      { \tag_struct_end:n { text } }
+    \tag_struct_begin:n {tag=\l_@@_tabletag_tl,attribute-class=ARIA-role-presentation}
+    \tl_gset:Ne \g_@@_struct_table_tl { \tag_get:n {struct_num} }
+  }
+%    \end{macrocode}
+% \end{plugdecl}
 %
 % \begin{plugdecl}{Table}
 %    \begin{macrocode}
@@ -874,6 +899,17 @@
   }
 %    \end{macrocode}
 % \end{plugdecl}
+% 
+% \begin{plugdecl}{Table}
+%    \begin{macrocode}
+\NewSocketPlug{tagsupport/tbl/vmode/begin}{LayoutTable}
+  {
+    \tag_struct_begin:n {tag=\l_@@_tabletag_tl,attribute-class=ARIA-role-presentation}
+    \tl_gset:Ne \g_@@_struct_table_tl { \tag_get:n {struct_num} }
+  }
+%    \end{macrocode}
+% \end{plugdecl}
+%
 %
 % \begin{plugdecl}{Table}
 %    \begin{macrocode}
@@ -1015,26 +1051,58 @@
  }
 %    \end{macrocode}
 %  \end{macro}
+%
+% \begin{macro}{\@@_init_tagnames_default:,\@@_init_tagnames_div:} 
+% These commands are used to switch the tagnames. 
+%    \begin{macrocode}
+\cs_new_protected:Npn\@@_init_tagnames_default:
+  {
+    \tl_set:Nn\l_@@_rowtag_tl   {TR}
+    \tl_set:Nn\l_@@_pcelltag_tl {TD}
+    \tl_set:Nn\l_@@_celltag_tl  {TD}
+    \tl_set:Nn\l_@@_tabletag_tl {Table} 
+  }     
+
+\cs_new_protected:Npn\@@_init_tagnames_div:
+  {
+    \tl_set:Nn\l_@@_rowtag_tl   {NonStruct}
+    \tl_set:Nn\l_@@_pcelltag_tl {NonStruct}
+    \tl_set:Nn\l_@@_celltag_tl  {text}
+    \tl_set:Nn\l_@@_tabletag_tl {Div} 
+  }     
+%    \end{macrocode}
+% \end{macro}
 
 %    \begin{macrocode}
 % See tagpdfsetup-keys.md in tagpdf/doc for the naming scheme.
 \keys_define:nn { __tag / setup }
   {
     table/tagging .choices:nn = { true, on }
-      { \__tag_tbl_enable: },
+      { 
+        \__tag_tbl_enable: 
+        \@@_init_tagnames_default:
+      },
     table/tagging .choices:nn = { false, off }
       { \__tag_tbl_disable: },
     table/tagging .choice:,
     table/tagging / presentation .code:n = 
-     {
-       \__tag_tbl_enable:
-       \tl_set:Nn\l_@@_rowtag_tl   {NonStruct}
-       \tl_set:Nn\l_@@_pcelltag_tl {NonStruct}
-       \tl_set:Nn\l_@@_celltag_tl  {text}
-       \tl_set:Nn\l_@@_tabletag_tl {Div} 
-       \clist_clear:N \l_@@_header_rows_clist
-       \clist_clear:N \l_@@_header_columns_clist  
-     },  
+      {
+        \__tag_tbl_enable:
+        \@@_init_tagnames_default:
+        \AssignSocketPlug{tagsupport/tbl/hmode/begin}{LayoutTable}
+        \AssignSocketPlug{tagsupport/tbl/vmode/begin}{LayoutTable}
+        \clist_clear:N \l_@@_header_rows_clist
+        \clist_clear:N \l_@@_header_columns_clist  
+      },  
+    table/tagging / div .code:n = 
+      {
+        \__tag_tbl_enable:
+        \@@_init_tagnames_div:
+        \AssignSocketPlug{tagsupport/tbl/hmode/begin}{LayoutTable}
+        \AssignSocketPlug{tagsupport/tbl/vmode/begin}{LayoutTable}
+        \clist_clear:N \l_@@_header_rows_clist
+        \clist_clear:N \l_@@_header_columns_clist  
+      },          
     table/tagging .default:n = true,
     table/tagging .initial:n = true
   }
@@ -1071,6 +1139,7 @@
 % At first we define attributes for the three standard cases:
 % We delay to begin document
 % as we can't know if tagpdf is already loaded.
+%  \changes{v0.85p}{2025/01/05}{add ARIA-role for presentation (tagging/778)}
 %    \begin{macrocode}
 \AddToHook{begindocument}
   {
@@ -1084,6 +1153,8 @@
              {TH-row}{/O /Table /Scope /Row},
            role/new-attribute =
              {TH-both}{/O /Table /Scope /Both},
+           role/new-attribute =
+            {ARIA-role-presentation}{/O /ARIA-1.1/role (presentation)}
          }
 %    \end{macrocode}
 %

diff --git a/required/latex-lab/testfiles-sec/test-gh777-sec-end.luatex.tlg b/required/latex-lab/testfiles-sec/test-gh777-sec-end.luatex.tlg
@@ -0,0 +1,33 @@
+This is a generated file for the l3build validation system.
+Don't change this file in any respect.
+Chapter 1.
+[1
+]
+[2
+]
+[1
+Non-PDF special ignored!]
+[2
+]
+Chapter 2.
+[1
+]
+[2
+]
+[3
+Non-PDF special ignored!]
+[4
+]
+[5
+Non-PDF special ignored!] (test-gh777-sec-end.aux)
+Package tagpdf Info: Finalizing the tagging structure:
+(tagpdf)             Writing out ~38 structure objects
+(tagpdf)             with ~30 'MC' leaf nodes.
+(tagpdf)             Be patient if there are lots of objects!
+Package tagpdf Info: writing ParentTree
+Package tagpdf Info: writing IDTree
+Package tagpdf Info: writing RoleMap
+Package tagpdf Info: writing ClassMap
+Package tagpdf Info: writing NameSpaces
+Package tagpdf Info: writing StructElems
+Package tagpdf Info: writing Root
diff --git a/required/latex-lab/testfiles-sec/test-gh777-sec-end.lvt b/required/latex-lab/testfiles-sec/test-gh777-sec-end.lvt
@@ -0,0 +1,27 @@
+\DocumentMetadata
+  {
+    lang=en-US,
+    pdfversion=2.0,
+    pdfstandard=ua-2,
+    testphase={latest},
+  }
+\input{regression-test}
+\documentclass{book}
+
+\begin{document}
+\START
+\chapter{abc}
+blub
+\frontmatter
+\chapter{abc}
+blub
+\mainmatter 
+\chapter{main}
+blub
+\backmatter 
+\chapter{main}
+blub
+\appendix
+\chapter{main}
+blub
+\end{document}
diff --git a/required/latex-lab/testfiles-sec/test-gh777-sec-end.tlg b/required/latex-lab/testfiles-sec/test-gh777-sec-end.tlg
@@ -0,0 +1,32 @@
+This is a generated file for the l3build validation system.
+Don't change this file in any respect.
+Chapter 1.
+[1
+]
+[2
+]
+[1
+]
+[2
+]
+Chapter 2.
+[1
+]
+[2
+]
+[3
+]
+[4
+]
+[5] (test-gh777-sec-end.aux)
+Package tagpdf Info: Finalizing the tagging structure:
+(tagpdf)             Writing out ~38 structure objects
+(tagpdf)             with ~30 'MC' leaf nodes.
+(tagpdf)             Be patient if there are lots of objects!
+Package tagpdf Info: writing ParentTree
+Package tagpdf Info: writing IDTree
+Package tagpdf Info: writing RoleMap
+Package tagpdf Info: writing ClassMap
+Package tagpdf Info: writing NameSpaces
+Package tagpdf Info: writing StructElems
+Package tagpdf Info: writing Root