diff options
author | Karl Berry <karl@freefriends.org> | 2024-01-08 21:47:22 +0000 |
---|---|---|
committer | Karl Berry <karl@freefriends.org> | 2024-01-08 21:47:22 +0000 |
commit | 218e823b3c691868564686239bf240745742eda6 (patch) | |
tree | 3f7ce282bd8fe2d756cafac2a4ce7467aa5f77a7 /Master/texmf-dist/doc/luatex/minim-pdf | |
parent | 5cbbbf546da0983be4c134a518ea8da7f71ae963 (diff) |
minim (8jan24)
git-svn-id: svn://tug.org/texlive/trunk@69352 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/luatex/minim-pdf')
-rw-r--r-- | Master/texmf-dist/doc/luatex/minim-pdf/README | 16 | ||||
-rw-r--r-- | Master/texmf-dist/doc/luatex/minim-pdf/minim-pdf.doc | 99 | ||||
-rw-r--r-- | Master/texmf-dist/doc/luatex/minim-pdf/minim-pdf.pdf | bin | 116670 -> 126824 bytes |
3 files changed, 96 insertions, 19 deletions
diff --git a/Master/texmf-dist/doc/luatex/minim-pdf/README b/Master/texmf-dist/doc/luatex/minim-pdf/README index eb9a1bd114b..0626208f2fa 100644 --- a/Master/texmf-dist/doc/luatex/minim-pdf/README +++ b/Master/texmf-dist/doc/luatex/minim-pdf/README @@ -1,4 +1,4 @@ -Version: 2023/1.3 +Version: 2024/1.4 SUMMARY @@ -27,6 +27,20 @@ In order to obtain the typeset manual of this package, simply say: HISTORY +2024/1.4 (5/1/2024) + + Breaking changes: + + * Table cells and headers now connect automatically in \automarktable + + New features: + + * Add support for pdf/ua + * Re-write \hyperlink, adding many options + * Add ref and title options to structure elements + * New helper macros for footnotes + * Add \withpdfresource + 2023/1.3 (20/10/2023) New features: diff --git a/Master/texmf-dist/doc/luatex/minim-pdf/minim-pdf.doc b/Master/texmf-dist/doc/luatex/minim-pdf/minim-pdf.doc index e04deb31abc..111d8c1423b 100644 --- a/Master/texmf-dist/doc/luatex/minim-pdf/minim-pdf.doc +++ b/Master/texmf-dist/doc/luatex/minim-pdf/minim-pdf.doc @@ -3,7 +3,7 @@ \manual{minim-pdf} -\ifchapter \chapter Hypertext +\ifchapter \chapter Advanced PDF features This chapter and the next document the support of the modern pdf features provided by the minim-pdf package. @@ -14,8 +14,8 @@ all other features of the package are described here. \else \startmetadata author {Esger Renkema} title {minim-pdf} - date {2023-10-20} - version {2023/1.3} + date {2024-01-05} + version {2024/1.4} keywords {LuaTeX; Plain TeX; PDF/A; Tagged PDF; accessibility; a11y; hypertext; bookmarks; document outline; associated files} stopmetadata @@ -33,10 +33,16 @@ all other features will be covered first. \section Hyperlinks %1 -For most simple cases, you can use -⟦*\hyperlink [name {...} | url {...}] ... \endlink⟧ for linking to a named -destination in your own document or to an external hyperlink respectively. -There is no support for nonsimple cases. +Hyperlinks can be made with +⟦*\hyperlink [alt {...}] [attr {...}] <action> ... \endlink⟧, where the +⟦<action>⟧ must be one of +⟦name {...} | url {...} | name {...} | next | prev | first | last⟧ +With the ⟦name⟧ action, a named destination must be used (see below), while the +⟦user⟧ action will be passed directly to the back-end (as with the pdftex +primitive). +The ⟦*\hyperlinkstyle⟧ token list can be used so set common (pdf) link +attributes; it defaults to ⟦/Border [0 0 0]⟧. The contents of the optional +⟦attr⟧ parameter will be appended to these. A named destination can be created with ⟦*\nameddestination {...}⟧ (also in horizontal mode, unlike the backend primitive) and if you cannot think of @@ -47,9 +53,10 @@ generated name. \section Bookmarks %1 -Bookmarks can be added with ⟦*\outline [open|closed] [dest {name}] {title}⟧. -Add ⟦open⟧ or ⟦closed⟧ to have the bookmark appear initially open or -closed (default), and +Bookmarks (also known as outlines) can be added with ⟦*\outline [open|closed] +[dest {name}] {title}⟧. +Add ⟦open⟧ or ⟦closed⟧ to have the bookmark appear initially open or closed +(default), and say ⟦dest {name}⟧ for having it refer to a specific named destination (otherwise, a new one will be created where the ⟦\outline⟧ command appears). @@ -101,6 +108,48 @@ are enabled by default. You can disable them by setting ⟦*\writehyphensandspaces⟧ to a nonpositive value. +\section PDF/UA %1 + +You can claim pdf/ua conformance with ⟦*\pdfualevel 1⟧. +By itself, this will do very little: + +\startlist +\tagattribute List ListNumbering /Decimal +\item 1. The ⟦pdfuaid:part⟧ metadata key will be set. +\item 2. A conforming ⟦ViewerPreferences⟧ dictionary will be added to the document catalog. +\item 3. The ⟦/Suspects⟧ key of the ⟦MarkInfo⟧ dictionary will be set to ⟦false⟧. +\item 4. ⟦/Tab /S⟧ will be added to the page attributes. +\stoplist + +Also making your document pdf/a-compliant, however, will relieve you of a few +additional worries: + +\startlist +\tagattribute List ListNumbering /Decimal +\tagattribute List ContinuedList true +\item 5. Fonts will be included properly. +\item 6. The (natural) language of every element will be known. +\item 7. Headings will be strongly-structured. +\item 8. Table headers will have their ⟦Scope⟧ set properly. +\item 9. A document outline will be generated automatically. +\stoplist + +This leaves the following for you to provide before your document can be +pdf/ua-compliant: + +\startlist +\tagattribute List ListNumbering /Decimal +\tagattribute List ContinuedList true +\item 10. Figure and Formula structure elements must have alt texts. +\item 11. Hyperlinks must have alternate descriptions. +\item 12. Lists must have the ⟦ListNumbering⟧ attribute set. +\item 13. Tables must have headers that are tagged as such. +\item 14. Page headers and footers must be marked as header or footer artifacts. +\item 15. Document section structure elements should have their ⟦title⟧ set. +\item 16. All embedded files must have a description. +\stoplist + + \section Embedded files %1 You can attach (associate) files with ⟦*\embedfile <options>⟧. @@ -110,7 +159,9 @@ document catalog. Arguments consisting of a single word can be given without braces and exactly one of the options ⟦file⟧ or ⟦string⟧ must be present. -\smallskip\marktableaslist \halign{#\quad\hfil&#\hfil\cr +\smallskip\marktableaslist +\tagattribute List ListNumbering /Description +\halign{#\quad\hfil&#\hfil\cr ⟦file ⟧\hfill⟦{...}⟧ & The file to embed.\cr ⟦string ⟧\hfill⟦{...}⟧ & The string to embed.\cr ⟦global⟧ & Attach to the document catalog.\cr @@ -166,6 +217,7 @@ You should always check the result in an external application. This is the full list of limitations, pitfalls and shortcomings: \startlist +\tagattribute List ListNumbering /Decimal \item1. Document content must be seen by tex in its logical order (although you can mark out-of-order content explicitly if you know what you are doing; see below). @@ -342,9 +394,16 @@ Note that for the ⟦owner⟧ and ⟦key⟧ the initial slash must be omitted; t ⟦value⟧ on the other hand will be written to the pdf verbatim. Any number of attributes can be added. -An identifier can be set with the ⟦id⟧ option, or after the fact with +An identifier can be set with the ⟦id {...}⟧ option, or after the fact with ⟦*\settagid {...}⟧. This identifier will be added to the ⟦IDTree⟧ and is entirely optional; you will probably already know when you need it. +The ⟦ref {...}⟧ option lets a structure element refer to another (the ⟦/Ref⟧ +option in the structure element dictionary). Its argument should be the ⟦id⟧ of +the other structure element. + +The title of the structure element (corresponding to the ⟦/T⟧ entry in the +structure element dictionary) can be set with the ⟦title {...}⟧ option. The +pdf/ua standard requires this key for all document sections. Finally, structure element classes can be given with the ⟦class <classname>⟧ keyword, which can be repeated. @@ -450,12 +509,13 @@ sort (and indeed, no general logic can be given in the latter case). Always proc with caution when using cells spanning multiple rows, and inspect the resulting structure carefully. -Marking a table header (either manually or with ⟦\automarktable⟧) will not -connect normal cells with their headers; you will have to connect these -manually by including ⟦*\markcolumnhead⟧ or ⟦*\markrowhead⟧ in the appropriate -header cells. This must be done \emph{after} ⟦\markcolumnspan⟧ if the latter -appplies. If properly setup like this, other cells of the table (including -header cells) will be assigned to matching row or column headers automatically. +Marking up a table header (except if done through ⟦\automarktable⟧) +will not connect normal table cells with their headers; you will have to +connect these manually by including ⟦*\markcolumnhead⟧ or ⟦*\markrowhead⟧ in +the appropriate header cells. This must be done \emph{after} ⟦\markcolumnspan⟧ +if the latter appplies. If properly setup like this, other cells of the table +(including header cells) will be assigned to matching row or column headers +automatically. \section Other helper macros %1 @@ -465,6 +525,9 @@ For marking up an entry in a table of contents, you can use the macro tags in the correct way. (The ⟦dest⟧ is a link destination and can be empty; the ⟦lbl⟧ is a section number and can also be empty.) +For tagging (foot)notes, ⟦*\marknoteref{*}⟧ and ⟦*\marknotelbl{*}⟧, when placed +around the footnote markers, will insert the proper ⟦Ref⟧, ⟦Note⟧ and ⟦Lbl⟧ +tags. % diff --git a/Master/texmf-dist/doc/luatex/minim-pdf/minim-pdf.pdf b/Master/texmf-dist/doc/luatex/minim-pdf/minim-pdf.pdf Binary files differindex a6e22ee194a..2b2ea69c428 100644 --- a/Master/texmf-dist/doc/luatex/minim-pdf/minim-pdf.pdf +++ b/Master/texmf-dist/doc/luatex/minim-pdf/minim-pdf.pdf |