Debian Codegraph @

texmf-dist/doc/latex/tagpdf/tagpdfsetup-keys.tex

raw
1 %% Overview over tagpdfsetup keys
2 %% The keys are split in a number of key paths.
3 \tagpdfsetup{table/header-rows=1}
4 \begin{longtable}{lllll}
5 \toprule
6 \caption{Overview of the keys for \cs{tagpdfsetup}}\label{tab:setupkey}%
7 \\\midrule
8 new key name & old key name & value &type & defined in \\\endfirsthead
9 \caption{Overview of keys for \cs{tagpdfsetup} (continued)}\\\midrule%
10 new key name & old key name & value &type & defined in \\\midrule\endhead
11 ??? & root-AF & string &code &tagpdf-struct\\
12 root-supplemental-file & & string &code &tagpdf-struct\\
13 attach-css & & boolean &bool &tagpdf-user\\
14 css-list & & string &code &tagpdf-user\\
15 css-list-remove & & string &code &tagpdf-user\\
16 css-list-add & & string &code &tagpdf-user\\
17 \\[4pt]\midrule
18 %% activate key path
19 %% activate` is used for keys that enable
20 %% general, typically document wide tagging options
21 %% related to the PDF processing.
22
23 activate & activate & string &meta & tagpdf \\
24 activate/all & activate-all & boolean &meta & tagpdf\\
25 activate/mc & activate-mc & boolean &bool & tagpdf\\
26 activate/softhyphen & --- & string &code & tagpdf \\
27 activate/spaces & interwordspace & boolean &code & tagpdf-space\\
28 activate/struct & activate-struct & boolean &bool & tagpdf\\
29 activate/struct-dest & no-struct-dest&boolean &bool & tagpdf\\
30 activate/tagunmarked& tagunmarked & boolean &bool & tagpdf\\
31 activate/tree & activate-tree & boolean &bool & tagpdf\\[4pt]\midrule
32 % temporary until tagging-sockets are in the kernel:
33 % activate/socket & --- & boolean & bool & tagpdf\\
34 %% role key path. For everything related to tag and attribute names
35 %% adds mathml to the global rolemap, should perhaps be default
36 role/mathml-tags & mathml-tags & boolean &bool & tagpdf-roles\\
37 role/new-tag & add-new-tag & string &code & tagpdf-roles\\
38 role/new-attribute&newattribute & string &code & tagpdf-struct\\
39 role/user-NS & --- & string &code & tagpdf-roles\\
40 % values: latex, pdf, default is latex, with pdf only PDF-tags are used
41 role/map-tags & --- & choice & code & tagpdf-roles\\[4pt]\midrule
42 %% debug key path
43 %% for logging and showing
44 debug/show &various &choice &code & various \\
45 debug/show=para & paratagging-show& --- &code & tagpdf-user\\
46 debug/show=paraOff& & --- &code & tagpdf-user\\
47 debug/show=spaces & show-spaces & --- &code & tagpdf-spaces\\
48 debug/show=spacesOff& --- & --- &code & tagpdf-spaces\\
49 debug/log & log & choice &code & tagpdf \\
50 debug/uncompress & uncompress & --- &code & tagpdf\\
51 debug/parent-child-check & & choice &code &tagpdf
52 \\[4pt]\midrule
53 %% viewer key path.
54 %% viewer keys influence some display options in a pdf viewer.
55 %% There is an overlap with similar "non-tagging" options.
56 % TODO viewer/display-title
57 %% show mathml-files in attachment pane (old mathml-panel)
58 viewer/pane/mathml & --- & boolean &bool &latex-lab-math (dev)\\
59 viewer/pane/mathsource& --- &boolean &bool &latex-lab-math (dev)\\
60 viewer/startstructure & --- &number &code &tagpdf-tree \\[4pt]\midrule
61 %%% Document element keys
62 %% page key path
63 page/tabsorder &tabsorder & choice & code & tagpdf\\
64 page/exclude-header-footer & exclude-header-footer &choice & code &tagpdf-user\\
65 page/tag-header-footer & &choice & code &tagpdf-user\\
66
67 \\[4pt]\midrule
68 %% para key path
69 para/tagging &paratagging &boolean &bool &tagpdf-user\\
70 para/tag &paratag &string &code &tagpdf-user\\
71 para/maintag &--- &string &code &tagpdf-user\\
72 para/flattened &--- &boolean &bool &tagpdf-user\\[4pt]\midrule
73 %% math key path
74 % use the /Alt key, currently clashes with mathml-AF in foxit,
75 % so false if mathml handling is activated
76 math/alt/use &--- &boolean &bool &latex-lab-math\\
77 math/mathml/write-dummy & --- &--- &code &latex-lab-math\\
78 % mathml source files:
79 math/mathml/sources &--- & clist &clist &latex-lab-math\\
80 math/mathml/AF &--- &boolean &bool &latex-lab-math\\
81 math/tex/AF & --- &boolean &bool &latex-lab-math\\
82 math/setup & --- &string &code &latex-lab-math\\ [4pt]\midrule
83 % TODO math/alt/type = source|manual| (later)
84 %% table key path
85 % true/false/layout
86 table/tagging & table-tagging &choice &code &latex-lab-table\\
87 table/header-rows & table-header-rows& clist &clist &latex-lab-table\\[4pt]\midrule
88 % change for text
89 text/lang & --- & string & code &tagpdf-user
90 \\\bottomrule
91 \end{longtable}
92 \bookmark[dest=\csname @currentHref\endcsname,level=section]{List of keys}