Skip to content

Commit

Permalink
update docu files
Browse files Browse the repository at this point in the history
  • Loading branch information
u-fischer committed Feb 9, 2024
1 parent b6795bf commit 201a19c
Show file tree
Hide file tree
Showing 13 changed files with 100 additions and 40 deletions.
Binary file modified doc/ex-AF-file.pdf
Binary file not shown.
Binary file modified doc/ex-alt-actualtext.pdf
Binary file not shown.
Binary file modified doc/ex-attribute.pdf
Binary file not shown.
Binary file modified doc/ex-formula-problem.pdf
Binary file not shown.
Binary file modified doc/ex-list.pdf
Binary file not shown.
Binary file modified doc/ex-mc-manual-para-split-obsolete.pdf
Binary file not shown.
Binary file modified doc/ex-softhyphen.pdf
Binary file not shown.
Binary file modified doc/ex-spaceglyph-listings.pdf
Binary file not shown.
Binary file modified doc/ex-structure-obsolete.pdf
Binary file not shown.
Binary file modified doc/ex-tagpdf-template.pdf
Binary file not shown.
128 changes: 97 additions & 31 deletions doc/keylist.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Keys of tagpdfsetup


## latex-lab-math
~~~~
math-tagging =
mathml/writehash .code:n = {... write template ...}
mathml/setfiles .clist_set:N = \l__tag_math_mathml_files_clist,
Expand All @@ -10,54 +10,66 @@ math-tagging =
mathml/alt .bool_set:N = \l__tag_math_alt_bool
texsource/panel .bool_set:N = \l__tag_math_texsource_panel_bool,
~~~~
## latex-lab-table
## latex-lab-table
~~~~
table-tagging .choice: = true/false/layout
table-header-rows .clist_set:N = \l_@@_header_rows_clist
~~~~

## tagpdf.dtx

activate-space .bool_gset:N = \g_@@_active_space_bool,
activate-mc .bool_gset:N = \g_@@_active_mc_bool,
activate-tree .bool_gset:N = \g_@@_active_tree_bool,
activate-struct .bool_gset:N = \g_@@_active_struct_bool,
activate-all .meta:n =
{activate-mc={#1},activate-tree={#1},activate-struct={#1}},
activate-all .default:n = true,
no-struct-dest .bool_gset_inverse:N = \g_@@_active_struct_dest_bool,

log .choice:, none, v,vv,vvv,all (\l_@@_loglevel_int and \@@_check_typeout_v:n),
~~~~
activate-space .bool_gset:N = \g_@@_active_space_bool,
activate-mc .bool_gset:N = \g_@@_active_mc_bool,
activate-tree .bool_gset:N = \g_@@_active_tree_bool,
activate-struct .bool_gset:N = \g_@@_active_struct_bool,
activate-all .meta:n =
{activate-mc={#1},activate-tree={#1},activate-struct={#1}},
activate-all .default:n = true,
no-struct-dest .bool_gset_inverse:N = \g_@@_active_struct_dest_bool,
log .choice:, none, v,vv,vvv,all (\l_@@_loglevel_int and \@@_check_typeout_v:n),
tagunmarked .bool_gset:N = \g_@@_tagunmarked_bool,
tagunmarked .bool_gset:N = \g_@@_tagunmarked_bool,
tabsorder .choice: (row,column,*structure*, none)
uncompress
tabsorder .choice: (row,column,*structure*, none)
uncompress
~~~~


## tagpdf-roles
~~~~
mathml-tags .bool_gset:N = \g_@@_role_add_mathml_bool %if mathml->span should be written out
add-new-tag
~~~~

## tagpdf-spaces

~~~~
interwordspace boolean

show-spaces boolean
~~~~

## tagpdf-struct

~~~~
root-AF object name (file reference)
newattribute
~~~~

## tagpdf-user

~~~~
activate-socket .bool_set:N = \l_@@_active_socket_bool,
activate .meta, sets activate-mc,activate-tree,activate-struct,activate-socket and sets `Document` as first structure.
activate .meta,
paratagging .bool_set:N = \l_@@_para_bool,
paratagging-show .bool_set:N = \l_@@_para_show_bool,
paratag .tl_set:N = \l_@@_para_tag_tl
exclude-header-footer .choice: true/false/pagination (default true)
~~~~

# keys of debug option in documentmetadata

Expand All @@ -70,36 +82,90 @@ debug=
firstaidoff
para = paratagging-show

# Sorting the keys
# Sorting the tagpdfsetup keys

## activate-XX, interwordspace
## activate key path

looks fine, active as meta key too.
`activate` is used for keys that enable general, typically document wide tagging options related
to the PDF processing.

activate-space should be made identical to
interwordspace (which can be deprecated).
* make `activate-spacechar` alias for interwordspace
* make `activate-struct-dest` alias/counterpart to `no-struct-dest`

~~~~
activate . meta:n
activate / spacechar
activate / mc (old: activate-mc)
activate / tree (old: activate-tree)
activate / struct (old: activate-struct)
activate / all (old: activate-all)
activate / tagunmarked (old tagunmarked)
activate / socket (temporary until tagging-sockets are in the kernel)
activate / struct-dest
activate / mathml-tags (old mathml-tags, adds them to the global rolemap)
~~~~

## log, paratagging-show, show-spaces
new debug key
new debug key to align with `\DocumentMetadata`-

~~~~
debug
show = {para,spaces,false}
log = {...}
uncompress (not really needed anymore)
~~~~

Check: does both `debug / show=` and `debug={show=, log=}` work?

## tagunmarked, tabsorder, no-struct-dest

## „document element“ keys

Currently we have keys for four document elements: `page`, `para`, `math`, `table`

### page key path

~~~~
page / tabsorder (old tabsorder)
page / header-footer (old exclude header-footer)
~~~~

low-level stuff, that normally isn't changed (perhaps with the
exception ot tabsorder
### para key path

## "content" key
~~~~
para / tagging .choice: = true/false (other options are possible)
para
para / text-tag = sets P-tag (old paratag)
para / unit-tag = sets text-unit-Tag
~~~~

math
### math key path
~~~~
math / mathml-template (writes the template, old mathml/writehash)
math / mathml-files (list of mathml-files to read)
math / mathml-panel (show mathml-files in attachment panel)
math / texsource-panel (show texsource-files in attachment panel)
math / use-alt (use the /Alt key, currently clashes with mathml-AF in foxit, so false
if mathml handling is activated)
~~~~
Perhaps later (currently not offered, as implicit or always true)

~~~~
math / mathml-AF (activates reading of mathml-AF)
math / texsource-AF (add texsource as AF)
~~~~

### table key path
~~~~
table / tagging .choice: (true/false/layout, old: table-tagging)
table / header-rows .clist_set:N (old: table-header-rows)
~~~~

table
## add-new-tag, root-AF, newattribute,

No idea yet so leave if alone currently
??


# Keys of tagtool
Expand Down
Binary file modified doc/tagpdf-code.pdf
Binary file not shown.
12 changes: 3 additions & 9 deletions update-temp.sh
Original file line number Diff line number Diff line change
@@ -1,9 +1,3 @@
l3build save test-add-new-tag-2
l3build save -c config-pdftex test-struct-OBJR test-root-AF test-ref test-AFref show-variables-17 test-beast-1 test-namespace-pdfII-book test-namespace-pdfII-article test-link test-AF-file test-header-footer test-beast-2 parent-child-20-structures show-variables-20
l3build save -c config-luatex parent-child-20-structures test-header-footer test-struct-OBJR test-root-AF test-ref test-link test-AF-file



l3build check --show-saves test-add-new-tag-2
l3build check --show-saves -c config-pdftex test-struct-OBJR test-root-AF test-ref test-AFref show-variables-17 test-beast-1 test-namespace-pdfII-book test-namespace-pdfII-article test-link test-AF-file test-header-footer test-beast-2 parent-child-20-structures show-variables-20
l3build check --show-saves -c config-luatex parent-child-20-structures test-header-footer test-struct-OBJR test-root-AF test-ref test-link test-AF-file
l3build save -c config-pdftex -e pdftexmain ptagging-004 ptagging-001b test-showattributes test-mc-manual-para-split parent-child-17-nonstruct test-mc-low-luaonly parent-child-20-nonstruct parent-child-17-structures ptagging-002 test-mc-tag-expansion test-patch-koma ptagging-005 parent-child-20-structures

l3build check --show-saves -c config-pdftex ptagging-004 test-mc-low-luaonly parent-child-20-structures test-mc-user parent-child-17-nonstruct test-mc-manual-para-split show-variables-17 test-mc-savebox ptagging-001b base show-variables-20 test-showattributes ptagging-005 parent-child-20 test-parentkey parent-child-17-structures test-patch-koma test-mc-tag-expansion ptagging-002 parent-child-20-nonstruct

0 comments on commit 201a19c

Please sign in to comment.