summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/tagpdf/tagpdfdocu-patches.sty
blob: da42672f4430526021b720bb020dedb69243b5d1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
%\RequirePackage[enable-debug]{expl3}[2018/06/14]
\ProvidesExplPackage {tagpdfdocu-patches} {2021-07-03} {0.91}
 {patches/commands for the tagpdf documentation}
\RequirePackage{etoolbox}
%%%%
% header and footer (now needed as attributes are global again)
%%%%
%% patching \@oddfoot/\@oddhead is nonsense, that is redefined all the time.
%% Using the scrlayer interfaces would probably work
%% but we will need a core latex solution anyway
%% so let's test it here and patch \@outputpage
%% we also disable paratagging, not for the tagging but to avoid that the small
%% numbers gives overfull vbox messages ...
\patchcmd\@outputpage
 {\hb@xt@\textwidth{\@thehead}}
 {
  \hb@xt@\textwidth
   {
    \bool_set_false:N \l__tag_para_bool
    \tag_mc_artifact_group_begin:n{pagination}
    \@thehead
    \tag_mc_artifact_group_end:
   }
 }
 {}{\fail}
\patchcmd\@outputpage
 {\hb@xt@\textwidth{\@thefoot}}
 {
  \hb@xt@\textwidth
   {
    \bool_set_false:N \l__tag_para_bool
    \tag_mc_artifact_group_begin:n{pagination}
    \@thefoot
    \tag_mc_artifact_group_end:
   }
 }
 {}{\fail}

%%%%%
% tableofcontents
% no internal patches, but KOMA-only solution
% TODO it must be checked how best practice is now for the table of contents.
%%%%%


\AfterTOCHead{\tag_struct_begin:n{tag=TOC}}
\AfterStartingTOC{\tag_struct_end:} %end TOC
%Marking the toc entries
%around the whole entry so only structure:
\newcommand\tagscrtocentry[1]{\tag_struct_begin:n{tag=TOCI}#1\tag_struct_end:}

%leaf so structure and mc:
\newcommand\tagscrtocpagenumber[1]
 {
   \tag_struct_begin:n{tag=Reference}
   \tag_mc_begin:n{tag=Reference}
   #1
   \tag_mc_end:
 \tag_struct_end:
 }


\DeclareTOCStyleEntry[
   entryformat=\tagscrtocentry,
   pagenumberformat=\tagscrtocpagenumber]{tocline}{section}
\DeclareTOCStyleEntry[
   entryformat=\tagscrtocentry,
   pagenumberformat=\tagscrtocpagenumber]{tocline}{subsection}
\DeclareTOCStyleEntry[
   entryformat=\tagscrtocentry,
   pagenumberformat=\tagscrtocpagenumber]{tocline}{subsubsection}
\DeclareTOCStyleEntry[
   entryformat=\tagscrtocentry,
   pagenumberformat=\tagscrtocpagenumber]{tocline}{paragraph}


% \IfStr{#3} doesnt like a \label ...
\renewcommand{\addtocentrydefault}[3]{%
% \Ifstr{#3}{}{}
%   {%
   \Ifstr{#2}{}
    {%
     \addcontentsline{toc}{#1}
      {%
       \protect\nonumberline
       \tagstructbegin{tag=P}%
       \tagmcbegin{tag=P}%
        #3%
       \tagmcend
       \tagstructend
      }%
    }%
    {%
    \addcontentsline{toc}{#1}{%
     \tagstructbegin{tag=Lbl}%
     \tagmcbegin{tag=Lbl}%
     \protect\numberline{#2}%
     \tagmcend\tagstructend
     \tagstructbegin{tag=P}%
     \tagmcbegin{tag=P}%
      #3%
     \tagmcend
     \tagstructend
     }%
    }%
  %}
}%

% the dots must be marked too

\renewcommand*{\TOCLineLeaderFill}[1][.]{
  \leaders\hbox{$\m@th
    \mkern \@dotsep mu\hbox{\tag_mc_begin:n{artifact}#1\tag_mc_end:}\mkern \@dotsep
    mu$}\hfill
}

%%%%%%%%%
% Sectioning commands
% no internal patches, but KOMA-only solution
%%%%%%%%

\AddtoDoHook{heading/begingroup}{\tagpdfparaOff\use_none:n}

\prop_new:N    \g_tag_section_level_prop
\prop_gput:Nnn \g_tag_section_level_prop {section}{H1}
\prop_gput:Nnn \g_tag_section_level_prop {subsection}{H2}
\prop_gput:Nnn \g_tag_section_level_prop {subsubsection}{H3}
\prop_gput:Nnn \g_tag_section_level_prop {paragraph}{H4}

\renewcommand{\sectionlinesformat}[4]
 {
  \@hangfrom
   {\hskip #2
    \tagstructbegin{tag=\prop_item:Nn\g_tag_section_level_prop{#1}}
    %\tl_if_empty:nF{#3}
    \tl_if_in:nnF{\@empty}{#3}
    {
     \tag_mc_begin:n    {tag=\prop_item:Nn\g_tag_section_level_prop{#1}}
     #3
     \tag_mc_end:
    }
   }
   {\tag_mc_begin:n    {tag=\prop_item:Nn\g_tag_section_level_prop{#1}}
    #4
    \tag_mc_end:\tagstructend}%
 }

% minisec is simply P,  so we let paratagging handle this.
% But we add a strong structure
% TODO: Should changed to H6 as it is no longer required to have H6 only after H5
% but need to check how to disable paratagging ...
\cs_new:Nn \__tag_docu_tag_minisec:n
{
  \tag_struct_begin:n {tag=Strong}
  \tag_mc_begin:n{tag=Strong}
  #1
  \tag_mc_end:
  \tag_struct_end:
}
%
\addtokomafont{minisec}{\__tag_docu_tag_minisec:n}


%%%%
%% Lists
%% patches enumitem internals!
%%%%
\AddToHook{env/itemize/begin}{\par\tagstructbegin{tag=L}}%\par is needed to close the paragraph before.
\AddToHook{env/itemize/end}{\par\tagstructend\tagstructend\tagstructend}%LBody,LI,L
\AddToHook{env/enumerate/begin}{\par\tagstructbegin{tag=L}}
\AddToHook{env/enumerate/end}{\par\tagstructend\tagstructend\tagstructend}%LBody,LI,L
\AddToHook{env/description/begin}{\par\tagstructbegin{tag=L}}
\AddToHook{env/description/end}{\par\tagstructend\tagstructend\tagstructend}%LBody,LI,L

\newcommand\tag@enit@format@preset[1]{%
 \str_if_eq:eeTF { \prop_item:cn { g__tag_struct_\g__tag_struct_stack_current_tl _prop }{S} }{/L}
  {
   %\typeout{BEGIN~OF~LIST}
  }
  {%\typeout{NEXT ITEM}
   \tagstructend\tagstructend} % for the LBody/LI
  \tagstructbegin{tag=LI}
  \tagstructbegin{tag=Lbl}
  \tagmcbegin{tag=Lbl}
    #1
  \tagmcend
  \tagstructend
  \tagstructbegin{tag=LBody}
  }

\ExplSyntaxOff
\xpatchcmd\enit@preset{\@firstofone}{\tag@enit@format@preset}{}{\fail}
%close mc from paratagging and reopen ...
\xpatchcmd\@item{\box\@labels}{\tagmcend \box\@labels \tagmcbegin{tag=P}}{}{\fail}
\ExplSyntaxOn

% keys that overwrite \enit@format must be patched, eg like the follow
% the font key should be patched in a similar way
\enitkv@key{}{format}{% new enumitem don't use first argument
  \def\enit@format{%
   \tagstructbegin{tag=LI}%
   \tagstructbegin{tag=Lbl}%
   \tagmcbegin{tag=Lbl}%
   #1\tagmcend}}


% listings + verbatim
% the paragraph code could create span around the lines ...
% it is quite unclear if Code is a sensible structure as it no longer exists in pdf 2.0

\AddToHook{env/lstlisting/begin}{\tagpdfparaOff\tagstructbegin{tag=Code}\tagmcbegin{tag=Code}}
\AddToHook{env/lstlisting/end}{\tagmcend\tagstructend}

\AddToHook{env/verbatim/begin}{\tagpdfparaOff\tagstructbegin{tag=Code}\tagmcbegin{tag=Code}}
\AddToHook{env/verbatim/end}{\tagmcend\tagstructend}


% ======== marginnote ==========
% TODO marginnote has a bug (a \par is missing) so it messes up tagging.
% but currently unneeded as we marked them up as artifacts anyway as they don't contain
% meaningful contents

\NewDocumentCommand\sidenote{m}
 {
   \tag_mc_artifact_group_begin:n{notype}\tagpdfparaOff\marginnote{#1}\tag_mc_artifact_group_end:
 }

% ======== tikzpicture ==========
% TODO this needs some investigation: it messes up the stack if one add paraOff

\AddToHook{env/tikzpicture/begin}{}

%======== tcolorbox ========
% We switch of paratagging at the begin and reenable it locally in before upper.
% the before upper setting is dangerous as it can be overwritten by
% users. So a more stable hook is needed.
%\AddToHook{env/tcolorbox/begin}{\tagpdfparaOff}
%\AddToHook{env/docCommand/begin}{\tagpdfparaOff}
%\tcbset{before~upper=\tagpdfparaOn}
\AddToHook{env/tcolorbox/begin}{\tagpdfparaOff \tcbset{before~upper=\tagpdfparaOn}}
\AddToHook{env/docCommand/begin}{\tagpdfparaOff \tcbset{before~upper=\tagpdfparaOn}}

 %locally for now


% ======= footnote ========
% TODO

% ======= bibliography ========
% biblatex. Creates some empty mc-chunks.
% no internal patches, but redefining begentry/finentry is not safe.
% better hook is needed.

\newbibmacro*{begentry}{\tagstructbegin{tag=BibEntry}\tagmcbegin{tag=BibEntry}}
\newbibmacro*{finentry}{\finentry\tagmcend\tagstructend}

% ====== hyperref ========
% this should probably go into tagpdf, but it is related to
% problem of pdf strings and context ....

\@ifpackageloaded{hyperref}{%
\pdfstringdefDisableCommands{
 \let\tagstructbegin\@gobble
 \let\tagmcbegin\@gobble
 \let\tagmcend\relax
 \let\tagstructend\relax
}}{}


%====== pictures ========
% PAC3 complained that the BBox is missing, so we are cheating for now
% and add a fix size.
\tagpdfsetup
  {
     newattribute =
        {bbox}{/O /Layout /BBox [0~0~100~100]}
  }

%%%%%
%======== Role maps =========
%%%%%
\tagpdfsetup{ add-new-tag=Title/H1,add-new-tag=Strong/Span }



\endinput

% ==========================
% now unneeded commands

% we need a command which simply starts a paragraph \TagP^,
% a "continuation" variant which closes the previous paragraph (\TagP),
% and a final end.

\NewDocumentCommand\TagP{t{^}}
 {
  \tag_mc_if_in:T { \tag_mc_end: }
  \IfBooleanF{#1}
  {
    \tag_struct_end:
  }
  \tag_struct_begin:n{tag=P}
  \tag_mc_begin:n{tag=P}
 }
% close a mc and one structure

\NewDocumentCommand\TagPend{}
 {
  \tag_mc_if_in:T { \tag_mc_end: }
  \tag_struct_end:
 }


 \ExplSyntaxOn
\newcommand\showcurrentstruct{\prop_show:c { g__tag_struct_\g__tag_struct_stack_current_tl _prop }}


\ExplSyntaxOff