-
Notifications
You must be signed in to change notification settings - Fork 5
/
hyperref-generic.dtx
4849 lines (4759 loc) · 148 KB
/
hyperref-generic.dtx
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
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
% \iffalse meta-comment
%
%% File: hyperref-generic.dtx
%
% Copyright (C) 2020 The LaTeX3 Project
%
% It may be distributed and/or modified under the conditions of the
% LaTeX Project Public License (LPPL), either version 1.3c of this
% license or (at your option) any later version. The latest version
% of this license is in the file
%
% http://www.latex-project.org/lppl.txt
%
% This file is part of the "pdfresources bundle" (The Work in LPPL)
% and all files in that bundle must be distributed together.
%
% The released version of this bundle is available from CTAN.
%
% -----------------------------------------------------------------------
%
% The development version of the bundle can be found at
%
% https://github.com/latex3/pdfresources
%
% for those people who are interested.
%
%<*driver>
\documentclass[full]{l3doc}
\begin{document}
\DocInput{\jobname.dtx}
\end{document}
%</driver>
% \fi
% \NewDocElement[
% idxgroup=hypersetup keys\actualchar\cs{hypersetup} keys,
% idxtype = {hypersetup key},
% printtype= \textit{setup key}
% ]{Hypkey}{xhypkey}
% \ExplSyntaxOn
% \NewDocumentEnvironment{hypkey}{m}
% {
% \clist_map_inline:nn {#1}{\begin{xhypkey}{##1}}
% }
% {
% \clist_map_inline:nn {#1}{\end{xhypkey}}
% }
% \ExplSyntaxOff
% \NewDocElement[
% idxgroup=Hooks,
% printtype= \textit{hook}
% ]{Hook}{hook}
%
% \title{^^A
% The \pkg{hyperref-generic} package \\ A generic driver for hyperref ^^A
% }
%
% \author{^^A
% The \LaTeX3 Project\thanks
% {^^A
% E-mail:
% \href{mailto:latex-team@latex-project.org}
% {latex-team@latex-project.org}^^A
% }^^A
% }
%
% \date{Released XXXX-XX-XX}
%
% \maketitle
% \begin{documentation}
% This package generates a generic driver for \pkg{hyperref} meant to be used
% with the new LaTeX PDF management code. It is loaded automatically
% if the PDF management code is active. The name of the driver will probably change.
%
% The generic driver can be used with pdflatex, lualatex, xelatex, latex with
% dvipdfmx, latex with dvips+ps2pdf. latex with dvips+distiller could work too
% but is untested. (x)dvipdfmx will probably soon support dvilualatex, then this
% combination should work too.
%
% The driver \emph{requires} the new PDF management code, so documents wanting to use it
% should start like this
% \begin{verbatim}
% \RequirePackage{pdfmanagement} %loads the code
% \DeclareDocumentMetadata % activates it
% {
% % options
% % e.g. pdf version, backend:
% % pdfversion=1.7,
% % backend = dvipdfmx
% }
% \end{verbatim}
%
% The new driver tries to be compatible with the standard \pkg{hyperref} drivers
% but there are nevertheless differences. Some of them due to the still experimental
% status of the driver, others are design decisions: one part of the project is
% to clean up and modernize the code. The following sections try to describe
% the differences but also to document some of the rationals of the changes,
% and to add some details and comments about the existing options and so to
% extend the \pkg{hyperref} manual.
%
% \section{Avoiding transition problems}
% Some code will only work properly after other packages have been adapted to
% the new PDF management code and the changes in this driver too.
% This will take some time. Until then it is recommended to follow
% the following rules
% \begin{itemize}
% \item Almost all options---with the exception of a few mentioned below in
% section~\ref{sec:pkg-options}---should be set in \cs{hypersetup},
% not as package option.
% \item Colors used in the keys for link colors should be defined after the
% package has been loaded.
% \item Report problems! Only known problem can be resolved.
% \end{itemize}
%
%
% \section{Bookmarks / outlines}
% The new driver doesn't contain code to handle bookmarks/outlines.
% Instead it forces the loading of the \pkg{bookmark} package
% unless the package option |bookmarks=false|
% has been used. Currently \pkg{bookmark} is loaded at the end of the preamble
% so if commands from \pkg{bookmark} are needed in the preamble the document
% should load it manually. This is subject to change at some time in the future.
%
% \section{PDF page size (mediabox)}
% The standard \pkg{hyperref} driver contain code to set the PDF page size.
% There is no real justification why this is done by \pkg{hyperref} apart from the
% fact that \LaTeX{} itself doesn't do it and that the needed special code could
% be added to the backend drivers.
%
% In the new driver this code is gone. The reason is not that it is
% difficult to set the MediaBox, actually it could be done with one line of code:
% \begin{verbatim}
% \pdfmanagement_add:nnn{Page}{MediaBox}
% {[0~0~\dim_to_decimal_in_bp:n{\paperwidth}~
% \dim_to_decimal_in_bp:n{\paperheight}]}
% \end{verbatim}
%
% The problem is to know which value to use (with the memoir class e.g.\cs{stockwidth}
% should be used instead of \cs{paperwidth}),
% and detecting this not a \pkg{hyperref} task. Instead the packages which change
% these values should also set the PDF page size. Also there are
% too many actors here: color/graphicx, geometry,the KOMA-classes, memoir,
% \ldots\ all try to set this.
%
% So if the PDF page size is wrong: load one of the other packages setting it
% e.g. the \pkg{color} or the \pkg{graphicx} package.
%
%
% \section{Link decorations: border, color, OCG-color, \ldots}
% Some main changes are
% \begin{itemize}
% \item The default colors have been changed.
% \item |citecolor| is no longer set with |allcolors| and it is not part of the
% color scheme, it is only supported for compability.
% \item a number of color schemes have been predefined.
% \end{itemize}
%
% \subsection{Background information}
% With the standard drivers \pkg{hyperref} allows either to color the link text,
% or to use a border around it.
% There is also a (rather unknown) option |frenchlinks| to use small caps
% for some links instead of colors.
%
% The \emph{link border} is a setting in the PDF annotation directory.
% It can be colored and styled (with the |<xxx>bordercolor|, |pdfborderstyle|
% and |pdfhighlight| keys), but the exact look depends on the PDF viewer.
% Such decorations are normally not printed.
%
% The \emph{link text} is colored with the standard color commands for text.
% Such a color is also printed, which is often not wanted. The printing
% can be avoided in PDF with so-called OCG-layers: They allow to add
% variants of a text along with instructions which variant should be used for
% viewing and which for printing. \pkg{hyperref} implements a rather simple version
% for links: The link text is put in a box and printed twice with different colors
% on different OCG layers. As boxes are used such links can't be broken. The
% package \pkg{ocgx2} implements a more sophisticated version which allows to
% use it for links broken over lines and pages.
%
% \pkg{hyperref} has keys to set the color and border for |link|, |url|, |file|,
% |menu| and |run| types. They correspond to the PDF annotation types
% |GoTo|, |URI|, |GoToR|, |Named| and |Launch|.
% Beside this there is a |anchorcolor| which isn't used at all, and |citecolor|
% which is a semantical category and doesn't fit to the other types.
%
% In the standard drivers the decoration options are more or less exclusive and global:
% One of the options (|colorlinks|, |ocgcolorlinks|, or borders) has to be
% chosen in the preamble and is then used for the whole document
% and all link types.
% Only colors and eventually the border style can be adjusted locally.
% But there is no technical reason for these restrictions:
% It is quite possible to change all these attributes
% at any time both by link type and locally. The restrictions of the current
% implementation can only be explained by the age of the code: \pkg{hyperref}
% has been created at a time when memory was small and the main drivers were html
% and postscript based.
%
% While link colors have been traditionally more or less
% under the control of \pkg{hyperref},
% the situation with other format options, like the font, is more complicated.
% The font in \cs{url} is for example determined by \cs{Urlfont},
% a command from the \pkg{url} package.
% In the case of internal (GoTo) references packages like \pkg{cleveref} or
% \pkg{biblatex} or \pkg{glossaries} offer formatting options too.
% Formatting here is often connected to semantics:
% an acronym should use a different font than a citation.
% While \pkg{hyperref} could offer options here, it would probably only clash
% with package formatting. It is more sensible not to interfere here. For this
% reason the |frenchlinks| option has been dropped.
%
% \subsection{New Keys}
% Some of the existing keys have been extended to allow individual setting for
% the link types |link|, |url|, |file| |menu| and |run|:
%
% \begin{itemize}
% \item Beside |pdfborder| there are also |linkborder|, |urlborder| etc
% \item Beside |pdfhighlight| there are also |linkhighlight|, |urlhighlight| etc
% \item Beside |pdfborderstyle| there are also |linkborderstyle|, |urlborderstyle| etc
% \item Beside |colorlinks| there are also |colorlink|, |colorurl| etc
% \item Beside |ocgcolorlinks| there are also |ocgcolorlink|, |ocgcolorurl|, etc %TODO
% \item Beside |hidelinks| there are also |hidelink|, |hideurl|, etc
% \item |bordercolormodel| allows to set the model used in annotations,
% the allowed values are |rgb| or |cmyk|. |rgb| is the default.
% It does \emph{not} change the model of text colors. Be aware
% that while the PDF format allows cmyk (4 numbers) in the |/C| key of an annotation,
% this is often ignored by pdf viewers and the colors can be wrong.
% \item The boolean keys |url|, |link|, |run|, |menu|, |file| allow to deactivate
% locally the link types.
% \end{itemize}
%
% \subsection{Changed behaviour}
% \begin{description}
% \item[colorlinks] |colorlinks| will as before disable the |pdfborder|, but it is possible
% to use the key in the document at any time, or to reenable the border if wanted.
% Internally |colorlinks| \& friends will no longer define/undefine
% |\Hy@colorlink|, but instead use the hooks provided by the \pkg{l3pdfannot} package.
% \item Color keys accept the following input syntax:
%
% \begin{tabular}{ll}
% model based & |urlbordercolor = [rgb]{1,1,0}| \\
% color expression & |urlbordercolor = red!50!blue| \\
% command & |urlbordercolor = \mycolor|
% \end{tabular}
%
% where |\mycolor| should expand to one of the other two syntax variants.
%
% \item[frenchlinks] The option |frenchlinks| does nothing at all.
% \item[cite colors] As mentioned above the support for |citecolor| and |citebordercolor| etc
% has been reduced. A package like \pkg{hyperref} can't keep track of such semantic
% contexts like cite, acronym, glossaries, special references and maintain keys for
% them. The keys are not completly dropped as this would affect packages like
% \pkg{natbib}, but they have been separated and are no longer affected by
% group keys like |allcolors| but must be set individually instead.
%
% \item[link margin] The driver sets a default link margin---this is identical
% to pdftex and luatex driver, but a change for the xetex and dvips driver.
% The (undocumentated) command \cs{setpdflinkmargin} does nothing.
% Use either the key |pdflinkmargin| or \cs{pdfannot_link_margin:n} to change the margin.
% See also the description in section~\ref{sec:keydesc} and in the hyperref manual.
% \end{description}
%
% \section{PDF strings}
%
% \pkg{hyperref} uses a command called \cs{pdfstringdef} to convert text input into
% something that makes sense and is valid in a PDF string, e.g. in the bookmarks
% or in the info dictionary or as form field values.
%
% As the handling of the outlines are delegated to the \pkg{bookmark} package, they
% will for now still use \cs{pdfstringdef}, but all other strings produced by
% this driver will use a new method based on the expl3 commands
% \cs{text_purify:n} and \cs{str_set_convert:Nnnn}. For normal text
% it shouldn't matter, but a variety of commands and math are handled differently.
% Like with \cs{pdfstringdef} they are a number of ways to adjust the outcome of
% \cs{text_purify:n}. These are described in the expl3 documentation interface3.pdf.
%
% \emph{The new method is under heavy development!}
%
% Important differences here are
% \begin{itemize}
% \item \emph{This new method requires that files are utf8-encoded}
% (at least if non-ascii chars are used in for PDF strings).
% \item \emph{All} robust commands are currently removed,
% unless an equivalent has been declared.
% \item Currently the new method is much more silent: it doesn't warn like
% \pkg{hyperref} if it removes commands.
% \end{itemize}
%
% \section{Package options from hyperref}\label{sec:pkg-options}
% Only a options are currently recognized by the new driver
% when used as package options as \pkg{hyperref} hasn't been adapted yet to pass
% them to the driver.
%
% So normally options should be set with \cs{hypersetup} after
% the package has been loaded. This is also the case for options which normally
% don't work in \cs{hypersetup}.
%
% Options that must be set as package options are
% \begin{itemize}
% \item |backref|
% \item |CJKbookmarks| this key should not be used anymore. At some time
% it will be removed.
% \item |destlabels| (destination names are taken from \cs{label} if possible)
% \item |encap|
% \item |hyperfigures| (according to the \pkg{hyperref} manual
% it makes figures hyper links, but actually is a no-op for most drivers, and it
% does nothing with this driver either.)
% \item |hyperfootnotes|
% \item |hyperindex|
% \item |implicit| (redefine \LaTeX\ internals)
% \item |nesting| unneeded key, see comment below in \ref{sec:keydesc}. At some time
% it will be either removed or extended (if some use can be found).
% \item |pagebackref|
% \item |pdfpagelabels| (set PDF page labels)
% \item |psdextra| this loads some extra definitions used by \cs{pdfstringdef}.
% The new driver uses \cs{pdfstringdef} only for the bookmarks, for other strings
% it is not relevant.
% \end{itemize}
%
% Options that can be set as package options are
% \begin{itemize}
% \item |debug|, |verbose| (a boolean)
% \item |bookmarks| (a boolean)
% \item |plainpages|
% \item |draft|, |final|
% \item |hypertexnames|
% \item |naturalnames|
% \item |pageanchor|
% \end{itemize}
%
% Ignored options:
% \begin{itemize}
% \item All driver options like |pdftex|, |dvipdfmx|, \ldots
% \item |raiselinks| (only used in the dviwind, textures and tex4ht driver anyway)
% \item |frenchlinks|
% \item |setpagesize|
% \end{itemize}
%
% \section{Disabling links}
%
% \pkg{hyperref} knows like many packages the options |draft| and |final|.
% With \pkg{hyperref} they can be used as package options or in the preamble
% in \cs{hypersetup} and disable links and anchors completely.
% The new driver passes the options also to the \pkg{bookmark} package if
% \pkg{bookmark} hasn't been loaded yet as bookmarks can't work properly if
% the anchors from hyperref are missing.
%
% \DescribeHypkey{link}%
% \DescribeHypkey{url}%
% \DescribeHypkey{file}%
% \DescribeHypkey{run}%
% \DescribeHypkey{menu}%
% The |draft| option is a global option that can't be undone (at least not easily).
% So the new driver offers also boolean keys |link|, |url|, |file|, |run| and |menu|
% which allow to locally disable a link type. So e.g.
% |\hypersetup{link=false}\ref{abc}| will give a reference without link (this
% is naturally also possible with |\ref*{abc}|). This disables also all hooks of
% the link type, so the link is for example no longer colored. It also removes the
% implicit grouping of the content.
%
%
% \section{Draftmode}
% pdftex and other engines knows a
% draftmode which can be set with |\pdfdraftmode=1|
% and \pkg{hyperref} honors this in some places. The new
% driver ignores it, for example |pagelabels| are created in any case.
% With today's computer power there is not much to gain and it only complicates
% the code.
%
% This should not be confused with the |draft| and |final| package options! They
% are still honored.
%
% \section{Dropped options}
% A number of options are ignored by this driver
% \begin{description}
% \item[pdfversion] The pdfversion should be set in \cs{DeclareDocumentMetadata}
% \item[setpagesize] The key is ignored and the PDF page size is not
% set. Load \pkg{color} or \pkg{graphicx} or use a class which sets the PDF page size.
% \item[breaklinks] The option does nothing sensible anyway (apart from triggering
% a warning). Currently with latex+dvips links can't be broken. But there is work
% in progress to change this.
% \item[unicode] This is always true.
% \item[pdfa] If this option is set to true \pkg{hyperref} normally checks and sets
% a small number of requirements for the PDF standard PDF/A.
% The key is ignored with this driver. Instead the wanted standard should be declared
% in \cs{DeclareDocumentMetadata}:
% \begin{verbatim}
% \DeclareDocumentMetadata{standard=A-2b}
% \end{verbatim}
% Currently |A-1b|, |A-2b|, |A-3b| can be set.
% The support for various requirements is still incomplete, but the parts that
% \pkg{hyperref} checked are implemented:
% \begin{itemize}
% \item The |/F| key is added to links and |Print| is activated, |Hidden|, |Invisible|,
% |NoView| are deactivated.
% \item |/NeedAppearances| is suppressed
% \item Pushbuttons, which use the action |/S/JavaScript| are suppressed.
% \item Resetbuttons, which use the action |/S/ResetForm| are suppressed.
% \item In widget annotations, the /AA dictionary is suppressed.
% \end{itemize}
% \end{description}
% \section{Destinations}
% Destinations (sometimes call anchors in the \pkg{hyperref} documentation)
% are the places a link jumped too. Unlike the name may suggest they don't described
% an exact location in the PDF. Instead a destination contains a reference to
% a page along with an instruction how to display this page.
% The normally used \enquote{XYZ \textit{top left zoom}} for example instructs
% the viewer to show the page with the given \textit{zoom} and
% the top left corner at the \textit{top left} coordinates---which then gives
% the impression that there is an anchor at this position.
%
% From these instructions two (|Fit| and |FitB|) don't take an argument.
% All others take one (|FitH|, |FitV|, |FitBH|, |FitBV|)
% or more (|XYZ|, |FitR|) arguments. These arguments are normally
% coordinates, |XYZ| takes also a zoom factor. The coordinates are
% absolute coordinates in |bp| relative to the lower left corner
% of the PDF.
%
% With the primitive command \cs{pdfdest} of pdftex almost all instructions are created
% with a keyword only: The needed coordinate is calculated automatically from the location
% the \cs{pdfdest} command is issued. So to get a specific coordinate one has to
% move the command to the right place. E.g.
% \begin{verbatim}
% \AddToHookNext{shipout/background}
% {\put(0,-\pdfpageheight+100bp){\pdfdest name{destA} FitH\relax}}
% \end{verbatim}
%
% Exceptions are the |XYZ| instruction, where pdftex accepts a keyword
% |zoom| followed by a zoom factor, and the |FitR| instruction
% which understands the keywords |width|, |height| and |depth|
% followed by a dimension, which is then used to calculate a rectangle relative to the
% current location. If no keywords are given the dimensions are taken from the surrounding
% box---which can also lead to zero sized areas.
%
% The manual of \pkg{hyperref} gives a bit the impression as if this
% coordinates can be set manually by the user but as described above this is
% mostly wrong: It is for normal destination only possible with a dvi-backend like
% dvips which make use of |pdfmark.def|. pdftex and luatex can use manual coordinates
% only for |pdfstartview| and |pdfremotestartview|.
% As dvips was the first driver of \pkg{hyperref} the option |pdfview| was at first
% developed for it and then adapted to pdftex. But this had the effect that the handling
% of the option |pdfview| is inconsequent across the backend and engines:
% For example with |pdfview=FitH 100| pdftex ignores the
% number and calculates its own, while dvips sets the coordinate to the absolute
% 100. The zoom factor of |XYZ| is not supported by the pdftex driver at all, and
% |FitR| only partially.
%
% The generic driver consolidate this but tries to stay compatible with the other
% drivers as far as possible.
% It also takes into account that |pdfview| and |pdfstartview| and |pdfremotestartview|
% have different requirements: While for the first relative coordinates are fine,
% for the two others absolute coordinates are more sensible.
%
% \DescribeHypkey{pdfview}
% \DescribeHypkey{pdfstartview}
% \DescribeHypkey{pdfremotestartview}
% So with this driver the options
% |pdfview|, |pdfstartview| and |pdfremotestartview| take
% the following options:
% \begin{itemize}
% \item |Fit|, |FitB|, |FitH|, |FitV|,
% |FitBH|, |FitBV| which can be followed by a positive integer (separated by a space) or the
% keyword |null|.
% The number can be gives as a \meta{dimension expression} surrounded with
% \cs{hypercalcbp}. The driver redefines this command to use
% \cs{dim_to_decimal_in_bp:n}.
% \begin{itemize}
% \item |pdfview| will ignore the integer and any other arguments and calculate
% the expected coordinates as described above for pdftex with all
% supported engines and backends.
% \item |pdfstartview| and |pdfremotestartview| will pass the optional
% number or keyword after expansion as absolute coordinate. Missing numbers will
% be filled up with |null|.
% \end{itemize}
%
% \item |XYZ|. This can be followed (separated by spaces) by up to three
% positive integers or keywords |null| which are then taken as \textit{top left zoom}
% in this order. \textit{zoom} is a factor, so e.g. 0.5 will give a scaling of 50\%.
% \begin{itemize}
% \item |pdfview| will use the last value as \textit{zoom}, ignore all other values
% and calculate the expected coordinates as described above for pdftex with all
% supported engines and backends (this means it is possible to use |XYZ 2| to
% set a zoom of 200\%, it is not necessary to fill in dummy values.)
% \item |pdfstartview| and |pdfremotestartview| will pass the optional
% numbers or keyword after expansion as absolute coordinates and zoom.
% Missing numbers will be filled up with |null|.
% \end{itemize}
% This new behaviour is in part incompatible with previous handling with the dvips driver.
%
%
% \item |FitR|.
% If no argument (separated by spaces) follows then
% |pdfview| will use with pdftex and luatex
% the automatic calculation of the coordinates from the encompassing box. With
% dvips and (x)dvipdfmx it will fall back to |Fit|.
% |pdfstartview| and |pdfremotestartview| will fallback to |Fit| too.
%
% If arguments (separated by spaces) follow they should be
% four numbers representing \texttt{left bottom right top}.
% \begin{itemize}\item
% |pdfview| will use the values to calculate coordinates relative to the current
% location. So |0 -100 200 400| will give a \enquote{box} of width 200bp,
% height 400bp and depth 100dp that the destination should encompass.
% Missing numbers will be set to 0. But one should be aware that is it is quite
% unpredicable how viewers which support |FitR| handles zero sizes.
%
% \item |pdfstartview| and |pdfremotestartview| will pass
% the values as absolute coordinates.
% \end{itemize}
% \end{itemize}
%
%
%\section{Assorted key descriptions}\label{sec:keydesc}
%The following gives a few details to some keys that are perhaps not
%completly described in the manual, or are a bit different in this driver.
%The list is alphabetic.
%
% \DescribeHypkey{bookmarkstype} This key takes as value the extension of a list
% like |toc| or |lof|. If this list uses \cs{addcontentsline} the content will
% be added to the bookmarks. The key can be use in \cs{hypersetup} and also in
% the middle of the document to switch the list.
%
% \DescribeHypkey{bordercolormodel} With |bordercolormodel| the colormodel used in the |/C|
% key of the annotation array and in similar keys is set. It does not affect
% the text and graphics colors in the page stream.
% Possible choices are |rgb| (three numbers in the array) and |cmyk| (four numbers).
% While the PDF reference allows four numbers, PDF readers don't necessarly handle
% this correctly, so the value can be wrong.
%
% \DescribeHypkey{destlabel} This is a boolean key. Currently it must be set
% as package option. If set to true, the name
% of a destination is taken from a following \cs{label}, if there is one before
% the next destination command. This requires two compilations to get
% the correct coordinates in the destination. In the first compilation
% the alias name is recorded in the aux-file:
% \begin{verbatim}
% \hyper@newdestlabel{section.1.2}{sec:sec2}
% \end{verbatim}
% The next compilation can then make use of it.
% The two-pass could be avoided in the future with a better labeling system,
% where the name if set earlier.
%
% \DescribeHypkey{extension} This key sets an variable that has two purposes:
% It is used if file name has not extension, and it decides if the annotation
% is a URI or GoToR annotation. So
% \begin{verbatim}
% \hypersetup{extension=dvi}
% \href{mwe1.pdf}{pdf}
% \href{mwe2.dvi}{dvi}
% \href{mwe3}{no ext}
% \end{verbatim}
% will create
% \begin{verbatim}
% /Subtype/Link/A<</S/URI /URI(mwe1.pdf)>>
% /Subtype/Link/A<</S/GoToR /F (mwe2.dvi)>>
% /Subtype/Link/A<</S/GoToR /F (mwe3.dvi)>>
% \end{verbatim}
% Typically PDF viewer can handle only GoToR annotions pointing to a PDF.
% So normally the default value |pdf| of this key should not be changed.
% \DescribeHypkey{nesting}\label{key:nesting}%
% This key is useless in PDF context. The boolean is only used in
% the code for anchors/destination where nesting doesn't make sense.
% It should not be changed.
%
% \DescribeHypkey{pdfborder}\DescribeHypkey{linkborder}\DescribeHypkey{urlborder}
% \DescribeHypkey{runborder}\DescribeHypkey{menuborder}
% This key set accept as value three numbers or three numbers and an array describing
% a dash pattern, examples are |0 0 1| or |0 0 1 [3 2]|.
% The first two numbers should according to the reference set round
% corners, but PDF viewer seem to ignore it. The third number is the line width
% of the border. Settings done with |pdfborderstyle| should take precedence.
%
% \DescribeHypkey{pdfborderstyle}\DescribeHypkey{linkborderstyle}
% \DescribeHypkey{urlborderstyle}\DescribeHypkey{fileborderstyle}
% \DescribeHypkey{runborderstyle}\DescribeHypkey{menuborderstyle}
% The value of this key is the content of the |BS| dictionary.
% As an example |/Type/Border /W 1 /S/U /D[3 2]|
%
% \begin{tabular}{>{\ttfamily} lll}
% Key & Values & comment / example\\\hline
% /Type & |/Border| & optional \\
% /W & \meta{number} & Width of border line \\
% /S & |/S| & solid (default)\\
% & |/D| &dash pattern can be set with /D\\
% & |/B| & beveled\\
% & |/I| & inset\\
% & |/U| & underline\\
% /D & \meta{array of numbers} & dash pattern (lines/gaps) (default [3])
% \end{tabular}
%
% \DescribeHypkey{pdflinkmargin}As described in the \pkg{hyperref} manual
% the behaviour differs between the backends: with dvips it is possible to
% change links locally, pdflatex and lualatex work by page, with dvipdfmx
% the setting is global (and has to be done in the preamble).
%
% \DescribeHypkey{pdflang} The key will work, but it is recommended to the set
% the language in \cs{DeclareDocumentMetadata} instead.
%^^A %% This is an adapted version of hluatex.def
%^^A %% meant to test the use of the commands
%^^A %% from pdfmanagement.sty
%^^A %%
%^^A %% drivers are loaded in line 4745 in hyperref.sty in a \Hy@AtEndOfPackage command.
%^^A %%%%%%%%%%%%%%%%%%%%%%%%%%%%
%^^A %% list of new internal commands
%^^A %% __hyp_link_goto_begin:nw : start command for links to internal destination
%^^A %% replaces \find@pdflink
%^^A %% __hyp_link_goto_end:
%^^A %% __hyp_destination:n : sets an anchor, replaces \new@pdflink
%^^A %% \__hyp_PageLabels_gpush: : puts pagelabels in the catalog, used on every storing
%^^A %% PDF String (text)
%^^A %% *\@@_text_pdfstring:nnN : replaces Hy@pstringdef, converts #1 to pdfstring in encoding #2
%^^A %% and stores in N
%^^A %% Build with:
%^^A %% *\@@_text_purify:nN
%^^A %% *\@@_text_cleanup:N
%^^A %% *\@@_text_convert:nN
%^^A %%
%^^A %% Destinations (dest)
%^^A %% \l_@@_dest_box
%^^A %%
%^^A %% References (ref)
%^^A %% *\@@_ref_label:nn
%^^A %% *\@@_ref_if_exist:nn
%^^A %% *\@@_ref_check:nn
%^^A %% % helps to display key list messages
%^^A %% \@@_clist_display:n
%^^A %%
%^^A %% \__hyp_info_generate_addons: what did this do??
%^^A %%
%^^A %% \g__hyp_AcroForm_CoFields_prop
%^^A %% \g__hyp_AcroForm_Fields_prop
%^^A %%
%^^A %% \g_@@_dest_pdfstartpage_tl ,
%^^A %% \g_@@_dest_pdfstartview_tl ,
%^^A %% \l_@@_dest_pdfremotestartview_tl ,
%^^A
%^^A %% Constants
%^^A %% *\c_@@_map_annot_hyp_prop
%^^A %% *\c_@@_dest_undefined_tl
%^^A %% Temp variables
%^^A %% \l_@@_tmpa_seq
%^^A %% \l_@@_tmpa_box
%^^A %% \l_@@_tmpa_tl
%^^A %% \l_@@_tmpa_str
%^^A %% \l_@@_tmpa_int
%^^A %%
%^^A %% \l_@@_dest_name_tmpa_tl
%^^A %% \l_@@_uri_tmpa_tl
%^^A %% \l_@@_filename_tmpa_tl
%^^A %% \l_@@_para_tmpa_tl
%^^A %% \l_@@_text_tmpa_str
%^^A %% \g_@@_text_tmpa_str
%^^A %% \l_@@_CheckmarkYes_tl
%^^A %% \l_@@_CheckmarkOff_tl
%^^A %% \l_@@_RadioYes_tl
%^^A %% \g_@@_bordercolormodel_tl
%
%^^A %% \l_@@_dest_pdfview_tl
%^^A %% list of commands which probably will have to change
% \end{documentation}
% \begin{implementation}
% \part{\pkg{hyperref-generic} driver implementation}
% \begin{macrocode}
%<*package>
%<@@=hyp>
% \end{macrocode}
% \begin{macrocode}
\ProvidesFile{hgeneric-experimental.def}
[2020/12/26 v0.71 %
Hyperref driver for luaTeX]
\RequirePackage{etoolbox} %why?
% \end{macrocode}
% We need l3color for the color export command and need to activate
% the patches for color and xcolor.
% It would be too late for colors defined earlier, but is the best one
% can do for now.%
% \begin{macrocode}
\RequirePackage{l3color}
\ExplSyntaxOn
\cs_gset_eq:NN \@expl@color@set@@@@nnn \color_set:nnn
\file_input:n {hyperref-colorschemes.def}
\ExplSyntaxOff
\@ifpackageloaded{xcolor}{\@firstoftwo}{\@secondoftwo}
{
\RequirePackage{xcolor-patches-tmp}
\XC@@@@names
}
{
\AddToHook{package/after/xcolor}
{\RequirePackage{xcolor-patches-tmp}\XC@@@@names}
}
% \end{macrocode}
%
%
% \section{messages}
% Redirect the message name:
% \begin{macrocode}
\ExplSyntaxOn
\prop_gput:Nnn \g_msg_module_name_prop { hyp }{ hyperref }
% \end{macrocode}
% At first a message for the testing of the resource management
% \begin{macrocode}
\msg_new:nnnn
{ hyp }
{ missing-resource-management }
{ The~PDF~resource~management~is~required~for~this~hyperref~driver! }
{
Activate~it~with \\
\tl_to_str:n{\RequirePackage{pdfmanagement}}\\
\tl_to_str:n{\DeclareDocumentMetadata{<options>}}\\
before~\tl_to_str:n{\documentclass}
}
% \end{macrocode}
% The pdfversion should be set in \cs{DeclareDocumentMetadata}
% \begin{macrocode}
\msg_new:nnnn
{ hyp }
{ pdfversion-disabled }
{
This~hyperref~driver~ignores~the~pdfversion~key!\\
Set~the~pdfversion~in~\token_to_str:N \DeclareDocumentMetadata
}
{
For example:\\
\tl_to_str:n
{
\DeclareDocumentMetadata { pdfversion=1.7 }
}
}
% \end{macrocode}
% A generic message for ignored keys.
% \begin{macrocode}
\msg_new:nnn
{ hyp }
{ key-dropped }
{
This~hyperref~driver~ignores~the~key~#1!\\
Please~check~the~documentation.
}
% \end{macrocode}
% pdf/A messages for fields, this will probably be moved to an external package
% \begin{macrocode}
\msg_new:nnn
{ hyp }
{ pdfa-no-push-button }
{ PDF/A:~Push~button~with~JavaScript~is~prohibited }
\msg_new:nnn
{ hyp }
{ pdfa-no-reset-button }
{ PDF/A:~Reset~action~is~prohibited }
% \end{macrocode}
% pdf/A message for not allowed Named actions
% \begin{macrocode}
\msg_new:nnn
{ hyp }
{ pdfa-no-named-action }
{ PDF/A:~Named~action~#1~is~prohibited }
% \end{macrocode}
% A message if the destination name is empty.
% \begin{macrocode}
\msg_new:nnn
{ hyp }
{ empty-destination-name }
{
Empty~destination~name,\\
using~`#1'
}
% \end{macrocode}
% A message if the destination check fails
% \begin{macrocode}
\msg_new:nnn
{ hyp }
{ invalid-destination-value }
{
Invalid~value~`#1'~of~`#2' \\
is~replaced~by~`Fit'~\msg_line_context:.
}
% \end{macrocode}
% Some options or values should not be used in older pdf versions
% \begin{macrocode}
\msg_new:nnn
{ hyp }
{ ignore-deprecated-or-unknown-option-in-pdf-version }
{
Option~`#1'~is~unknown~or~deprecated~in\\
pdf~version~#2.~Ignored.
}
\msg_new:nnn
{ hyp }
{ ignore-deprecated-or-unknown-value-in-pdf-version }
{
Value~`#1'~is~unknown~or~deprecated~in\\
pdf~version~#2.~Ignored.
}
\msg_new:nnn
{ hyp }
{ replace-deprecated-or-unknown-value-in-pdf-version }
{
Value~`#1'~is~unknown~or~deprecated~in\\
pdf~version~#2. Value~`#3'~is used instead.
}
% \end{macrocode}
% During development not all standard hyperref keys are known and the
% Hyp-handler needs to process some new keys unknown to him.
% This issues warnings for now:
% \begin{macrocode}
\msg_new:nnn
{ hyp }
{ unknown-key }
{
unknown~key~#2~of~module~’#1’~set~to~’#3’.
}
\msg_new:nnn
{ hyp }
{ unknown-key-to-Hyp }
{
ignored~in~family~Hyp~unknown~key~#1.
}
% \end{macrocode}
% There are a lot choice keys. This defines messages which shows the valid
% choices if a faulty one has been used:
% \begin{macrocode}
\cs_new:Npn \@@_clist_display:n #1 {*~#1\\}
\msg_new:nnn
{ hyp }
{ unknown-choice }
{
Value~'#3'~is~invalid~for~key~'#1'.\\
The~key~accepts~only~the~choices\\
\clist_map_function:nN { #2 }\@@_clist_display:n
}
\msg_new:nnn
{ hyp }
{ unknown-choice+empty }
{
Value~'#3'~is~invalid~for~key~'#1'.\\
The~key~accepts~only~the~choices\\
\clist_map_function:nN { #2 }\@@_clist_display:n
An~empty~value~removes~the~setting.
}
\msg_new:nnn
{ hyp }
{ no-bool }
{
Value~'#2'~is~invalid~for~key~'#1'.\\
The~key~accepts~only~the~choices\\
*~true\\
*~false \\
*~and~an~empty~value~which~removes~the~setting.\\
No~value~is~equivalent~to~using~`true`.
}
% \end{macrocode}
% \section{Variants}
% \begin{macrocode}
\cs_generate_variant:Nn\pdf_destination:nn {nf}
% \end{macrocode}
% \section{Overwriting/providing commands from hyperref}
% hyperref checks driver version, we need to suppress this during the development
% \begin{macrocode}
\chardef\Hy@VersionChecked=1 %don't check the version!
% \end{macrocode}
%
% \begin{macro}[EXP]{\hypercalcbp}
% We define a better (expandable) version of \cs{hypercalcbp}
% \begin{macrocode}
\cs_set_eq:NN \hypercalcbp \dim_to_decimal_in_bp:n
% \end{macrocode}
% \end{macro}
%
% This command must be provided for now, but they are unused by the driver:
% \begin{macrocode}
\providecommand\@pdfborder{}
\providecommand\@pdfborderstyle{}
\newcommand\OBJ@OCG@view {} % needed in hyperref
\def\Hy@numberline#1{#1\c_space_tl} %needed by bookmark
% \end{macrocode}
%
% We force unicode as option. As bookmarks are still using \cs{pdfstringdef}
% we also need to load puenc.def.
% \begin{macrocode}
\HyPsd@LoadUnicode
\Hy@unicodetrue
\let\HyPsd@pdfencoding\HyPsd@pdfencoding@unicode
\Hy@DisableOption{unicode}
% \end{macrocode}
% The pdfversion should be set in \cs{DeclareDocumentMetadata} but we must
% copy it to the \pkg{hyperref} command:
% \begin{macrocode}
\cs_set_eq:NN \Hy@pdfminorversion \pdf_version_minor:
\cs_set_eq:NN \Hy@pdfmajorversion \pdf_version_major:
% \end{macrocode}
% \begin{macrocode}
\legacy_if:nT { Hy@setpdfversion }
{
\msg_warning:nn { hyp }{ pdfversion-disabled }
}
\Hy@DisableOption{pdfversion}
% \end{macrocode}
% \cs{Acrobatmenu} should use the new internal link command
% \begin{macrocode}
\RenewDocumentCommand \Acrobatmenu { m m }
{
\hyper@linknamed {#1} {#2}
}
% \end{macrocode}
%
% \cs{hypersetup} should set the new keys.
% We can't also execute |\kvsetkeys{Hyp}| as this errors for example with colors.
% This means the driver has to provide new code for every key!
%
% \begin{macrocode}
% TODO should go at some time ...
% \kv@set@family@handler{Hyp}
% { \msg_warning:nnx {hyp}{unknown-key-to-Hyp}{#1} }
\cs_set_protected:Npn \hypersetup #1
{
%\kvsetkeys{Hyp} {#1}
\keys_set:nn { hyp / setup }{ #1 }
}
% TODO for now unknown keys should only give warnings.
\keys_define:nn { hyp / setup }
{
unknown .code:n =
{
\msg_warning:nnxxx { hyp } { unknown-key }
{ hyp~/~setup }{ \l_keys_key_str } { #1 }
}
}
% \end{macrocode}
%
% \section{Compability commands}
% \subsection{Metadata}
% A number of values should be accessible from other packages. Until know
% packages like \pkg{hyperxmp} used variables like \cs{@pdfauthor}. As they are
% gone we need to provide some fallback.
% \begin{macrocode}
\cs_new_protected:Npn \@@_store_metadata:nn #1 #2 %#1 key, #2 value.
{
\tl_set:cn {@#1}{#2}
\AddToDocumentMetadata {#1}{#2}
}
\cs_generate_variant:Nn \@@_store_metadata:nn {xn,nx,xx}
% \end{macrocode}
% \subsection{citecolor}
% cite is a link context. So we define a hook, and the keys in terms of this hook.
%
% \begin{macrocode}
\hook_new:n{hyp/link/cite}
\tl_new:N \l_@@_annot_citecolor_tl
\tl_set:Nn \l_@@_annot_citecolor_tl {@@_color_cite}
\tl_new:N \l_@@_annot_citebordercolor_tl
\tl_set:Nn \l_@@_annot_citebordercolor_tl {@@_color_citeborder}
\color_set:nnn {@@_color_cite}{HTML}{2E7E2A}
\color_set:nn {@@_color_citeborder}{@@_color_cite!60!white}
\keys_define:nn { hyp / setup }
{
,citecolor .tl_set:N = \l_@@_annot_citecolor_tl
,citebordercolor .tl_set:N = \l_@@_annot_citebordercolor_tl
}
\hook_gput_code:nnn { hyp/link/cite }{hyp/cite}
{
\keys_set:nn { hyp / setup }
{
,linkbordercolor= \l_@@_annot_citebordercolor_tl
,linkcolor = \l_@@_annot_citecolor_tl
}
}
% \end{macrocode}
% \section{Checks}
% The driver can not work properly if the pdfmanagement is not active,
% as keys need to write to the catalog and to info. But annotations
% and outlines should work.
% So should this be a fatal error?
% Should there be a difference between missing and inactive management?
% TODO
% \begin{macrocode}
\bool_lazy_and:nnF
{ \cs_if_exist_p:N \pdfmanagement_if_active_p: }{ \pdfmanagement_if_active_p: }
{ \msg_error:nn { hyp}{ missing-resource-management } }
% \end{macrocode}
% Outlines/bookmarks require the bookmark package.
% TODO check pdfpagemode if booksmarks are suppressed.
% \begin{macrocode}
\legacy_if:nT { Hy@bookmarks }
{
\AddToHook{begindocument/before}[hyperref/bookmark]{\RequirePackage{bookmark}}
}
\legacy_if:nT {Hy@draft}
{
\PassOptionsToPackage{draft}{bookmark}
}
% \end{macrocode}
%
% \section{Reference and label commands}
% The code uses the l3ref-tmp package which
% must have been loaded as pdfmanagement is a requirement.
% The commands use after the module prefix always |_ref|.
%
% At first a label command which add the space commands from LaTeX: