File: hyperref.cwl

package info (click to toggle)
texstudio 4.9.1%2Bds-1
  • links: PTS
  • area: main
  • in suites: forky, sid
  • size: 110,128 kB
  • sloc: cpp: 111,264; xml: 18,668; ansic: 8,977; python: 357; javascript: 177; sh: 147; makefile: 52
file content (404 lines) | stat: -rw-r--r-- 9,544 bytes parent folder | download
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
# hyperref package
# neeraavi 21 Mar 2007
#modified Edson 30-12-2010
#modified Denis Bitouz\'e 14-06-2014
#modified muzimuzhi 18 Jan 2020, 8 May 2020, 8 Jul 2020
#modified Matthew Bertucci 21 June 2025 for v7.01n

#include:iftex
#include:keyval
#include:kvsetkeys
#include:kvdefinekeys
#include:pdfescape
#include:hycolor
#include:kvoptions
#include:intcalc
#include:url
#include:bitset
#include:bigintcalc
#include:rerunfilecheck
#include:nameref
#include:etoolbox
#include:stringenc

#ifOption:backref
#include:backref
#endif
#ifOption:backref=section
#include:backref
#endif
#ifOption:backref=slide
#include:backref
#endif
#ifOption:backref=page
#include:backref
#endif
#ifOption:pagebackref
#include:backref
#endif
#ifOption:pagebackref=true
#include:backref
#endif

#ifOption:colorlinks
#include:color
#endif
#ifOption:colorlinks=true
#include:color
#endif

#ifOption:destlabel
\HyperDestRename{destination}{newname}
#endif
#ifOption:destlabel=true
\HyperDestRename{destination}{newname}
#endif

#ifOption:hyperindex
\hyperxindexformat{arg1}{arg2}#*
#endif
#ifOption:hyperindex=true
\hyperxindexformat{arg1}{arg2}#*
#endif

\hypersetup{keyvals}
#keyvals:\hypersetup,\usepackage/hyperref#c
addtopdfcreator=%<text%>
allbordercolors=#%color
allcolors=#%color
anchorcolor=#%color
backref=#section,slide,page,none,false
baseurl=%<URL%>
bookmarks#true,false
bookmarksdepth
bookmarksdepth=%<number%>
bookmarksnumbered#true,false
bookmarksopen#true,false
bookmarksopenlevel=%<level%>
bookmarkstype=
breaklinks#true,false
citebordercolor=#%color
citecolor=#%color
CJKbookmarks#true,false
colorlinks#true,false
customdriver=%<file%>
debug#true,false
destlabel#true,false
draft#true,false
driverfallback=%<driver%>
dvipdfm
dvipdfmx
dvipdfmx-outline-open#true,false
dvips
dvipsone
dviwindo
encap=%<character%>
extension=%<file ext%>
filebordercolor=#%color
filecolor=#%color
final#true,false
frenchlinks#true,false
hidelinks
hitex
hyperfigures#true,false
hyperfootnotes#true,false
hyperindex#true,false
hypertex
hypertexnames#true,false
implicit#true,false
linkbordercolor=#%color
linkcolor=#%color
linkfileprefix=%<prefix%>
linktoc=#section,page,all,none
linktocpage#true,false
luatex
menubordercolor=#%color
menucolor=#%color
nativepdf
naturalnames#true,false
nesting#true,false
next-anchor=%<anchor name%>
ocgcolorlinks#true,false
pageanchor#true,false
pagebackref#true,false
pdfa#true,false
pdfauthor=%<author%>
pdfborder=
pdfborderstyle=
pdfcenterwindow#true,false
pdfcreationdate=%<date%>
pdfcreator=%<creator%>
pdfdirection=#L2R,R2L
pdfdisplaydoctitle#true,false
pdfduplex=#Simplex,DuplexFlipShortEdge,DuplexFlipLongEdge
pdfencoding=#pdfdoc,unicode,auto
pdfescapeform#true,false
pdffitwindow#true,false
pdfhighlight=#/I,/N,/O,/P
pdfinfo={%<info keys%>}
pdfkeywords={%<keyword list%>}
pdflang=%<lang id%>
pdflinkmargin=##L
pdfmark
pdfmenubar#true,false
pdfmoddate=%<date%>
pdfnewwindow#true,false
pdfnonfullscreenpagemode
pdfnumcopies=%<integer%>
pdfpageduration=
pdfpagelabels#true,false
pdfpagelayout=#SinglePage,OneColumn,TwoColumnLeft,TwoColumnRight,TwoPageLeft,TwoPageRight
pdfpagemode=#FullScreen,UseNone,UseOutlines,UseOC,UseAttachments,UseThumbs
pdfpagescrop=%<n1 n2 n3 n4%>
pdfpagetransition=#Split,Blinds,Box,Wipe,Dissolve,Glitter,R,Fly,Push,Cover,Uncover,Fade
pdfpicktraybypdfsize#true,false
pdfprintarea=#Mediabox,CropBox,BleedBox,TrimBox,ArtBox
pdfprintclip=#Mediabox,CropBox,BleedBox,TrimBox,ArtBox
pdfprintpagerange=%<n1 n2%>
pdfprintscaling=#None,AppDefault
pdfproducer=%<producer%>
pdfremotestartview=#XYZ,Fit,FitH,FitV,FitR,FitB,FitBH,FitBV
pdfstartpage=%<page number%>
pdfstartview=#XYZ,Fit,FitH,FitV,FitR,FitB,FitBH,FitBV
pdfsubject=%<subject%>
pdftex
pdftitle=%<title%>
pdftoolbar#true,false
pdftrapped=#True,False,Unknown
pdfusetitle#true,false
pdfversion=%<version%>
pdfview=#XYZ,Fit,FitH,FitV,FitR,FitB,FitBH,FitBV
pdfviewarea=#Mediabox,CropBox,BleedBox,TrimBox,ArtBox
pdfviewclip=#Mediabox,CropBox,BleedBox,TrimBox,ArtBox
pdfwindowui#true,false
plainpages#true,false
ps2pdf
psdextra#true,false
raiselinks#true,false
runbordercolor=#%color
runcolor=#%color
setpagesize#true,false
tex4ht
textures
unicode#true,false
urlbordercolor=#%color
urlcolor=#%color
verbose#true,false
vtex
vtexpdfmark
xetex
#endkeyvals

\href[options%keyvals]{URL}{text%plain}#U
\href{URL}{text%plain}#U

#keyvals:\href
pdfremotestartview=#XYZ,Fit,FitH,FitV,FitR,FitB,FitBH,FitBV
pdfnewwindow#true,false
page=%<number%>
ismap#true,false
nextactionraw={%<PDF code%>}
#endkeyvals

\AddToDocumentProperties{property}{value}#*
\AddToDocumentProperties[category]{property}{value}#*
\GetDocumentProperties{property}#*

## these are now in the format
# \MakeLinkTarget{counter}
# \MakeLinkTarget[prefix]{counter}
# \MakeLinkTarget*{target name}
# \NextLinkTarget{target name}
# \LinkTargetOn
# \LinkTargetOff
\SetLinkTargetFilter{filter code}

\url{URL}#U
\nolinkurl{URL}#U
\hyperbaseurl{URL}#U
\hyperimage{imageURL%URL}{text}#U
\hyperdef{category}{name}{text}
\hyperref{URL}{category}{name}{text}#M
# trick for commandExtract, for now
\hyperref[label%ref]{URL}{category}{name}{text}#M
\hyperref[label%ref]{text}
\hyperref{text}
\hyperlink{target name}{link text%text}
\hypertarget{target name}{anchor text%text}

\phantomsection

\hyperget{anchor}{label}
\autopageref{label}#r
\autopageref*{label}#r
\autoref{label}#r
\autoref*{label}#r
\thispdfpagelabel
\pdfstringdef{command}{TeX code}#d
\begin{NoHyper}
\end{NoHyper}
\pdfbookmark{text}{name}
\pdfbookmark[level]{text}{name}
\currentpdfbookmark{text}{name}
\subpdfbookmark{text}{name}
\belowpdfbookmark{text}{name}
\texorpdfstring{TeX code}{PDF string}
\pdfstringdefDisableCommands{code}
\hypercalcbp{dimen specification}

\Acrobatmenu{menuoption}{text}

\begin{Form}
\begin{Form}[options%keyvals]
\end{Form}
#keyvals:\begin{Form}
action=%<URL%>
encoding=%<encoding%>
method=#post,get
#endkeyvals

\TextField{label}#/Form
\TextField[parameters%keyvals]{label}#/Form
\CheckBox{label}#/Form
\CheckBox[parameters%keyvals]{label}#/Form
\ChoiceMenu{label}{choices}#/Form
\ChoiceMenu[parameters%keyvals]{label}{choices}#/Form
\PushButton{label}#/Form
\PushButton[parameters%keyvals]{label}#/Form
\Submit{label}#/Form
\Submit[parameters%keyvals]{label}#/Form
\Reset{label}#/Form
\Reset[parameters%keyvals]{label}#/Form
#keyvals:\TextField,\CheckBox,\ChoiceMenu,\PushButton,\Submit,\Reset
accesskey=%<key%>
align=#0,1,2
altname=%<altname%>
backgroundcolor=#%color
bordercolor=#%color
bordersep=##L
borderstyle=#S,B,D,I,U
borderwidth=##L
calculate={%<JavaScript code%>}
calculatesortkey=%<key%>
charsize=##L
checkboxsymbol=%<symbol%>
checked#true,false
color=#%color
combo#true,false
default=%<default value%>
disabled#true,false
format={%<JavaScript code%>}
height=##L
hidden#true,false
keystroke={%<JavaScript code%>}
mappingname=%<name%>
maxlen=%<number%>
menulength=%<number%>
multiline#true,false
name=%<name%>
onblur={%<JavaScript code%>}
onchange={%<JavaScript code%>}
onclick={%<JavaScript code%>}
ondbclick={%<JavaScript code%>}
onfocus={%<JavaScript code%>}
onkeydown={%<JavaScript code%>}
onkeypress={%<JavaScript code%>}
onkeyup={%<JavaScript code%>}
onmousedown={%<JavaScript code%>}
onmousemove={%<JavaScript code%>}
onmouseout={%<JavaScript code%>}
onmouseover={%<JavaScript code%>}
onmouseup={%<JavaScript code%>}
onselect={%<JavaScript code%>}
password#true,false
popdown#true,false
radio#true,false
radiosymbol=%<symbol%>
readonly#true,false
rotation=%<multiple of 90%>
tabkey=%<key%>
validate={%<JavaScript code%>}
value=%<init value%>
width=##L
#endkeyvals

\LayoutTextField{label}{field}#*
\LayoutChoiceField{label}{field}#*
\LayoutCheckField{label}{field}#*
\MakeRadioField{width}{height}#*
\MakeCheckField{width}{height}#*
\MakeTextField{width}{height}#*
\MakeChoiceField{width}{height}#*
\MakeButtonField{text}#*
\DefaultHeightofSubmit#*
\DefaultWidthofSubmit#*
\DefaultHeightofReset#*
\DefaultWidthofReset#*
\DefaultHeightofCheckBox#*
\DefaultWidthofCheckBox#*
\DefaultHeightofChoiceMenu#*
\DefaultWidthofChoiceMenu#*
\DefaultHeightofText#*
\DefaultHeightofTextMultiline#*
\DefaultWidthofText#*
\DefaultOptionsofSubmit#*
\DefaultOptionsofReset#*
\DefaultOptionsofPushButton#*
\DefaultOptionsofCheckBox#*
\DefaultOptionsofText#*
\DefaultOptionsofListBox#*
\DefaultOptionsofComboBox#*
\DefaultOptionsofPopdownBox#*
\DefaultOptionsofRadio#*

\AfterBeginDocument{code}#*
\AMSautorefname#*
\appendixautorefname#*
\chapterautorefname#*
\equationautorefname#*
\FancyVerbLineautorefname#*
\figureautorefname#*
\footnoteautorefname#*
\Hfootnoteautorefname#*
\Hurl{URL}#*U
\HyperDestLabelReplace{dest}#*
\HyperDestNameFilter{arg}#*
\hypergetpageref{label}#*r
\hypergetref{label}#*r
\hyperlinkfileprefix{prefix}#*
\hyperpage{arg}#*
\HyperRaiseLinkDefault#*
\HyperRaiseLinkHook#*
\IfHyperBoolean{options}{true}{false}#*
\IfHyperBooleanExists{option}{true}{false}#*
\ifpdfstringunicode{unicode chars}{chars}#*
\Itemautorefname#*
\itemautorefname#*
\MakeLowercaseUnsupportedInPdfStrings{text}#*
\MakeUppercaseUnsupportedInPdfStrings{text}#*
\MaybeStopEarly#*
\MaybeStopNow#*
\nohyperpage{arg}#*
\pageautorefname#*
\paragraphautorefname#*
\partautorefname#*
\pdfstringdefPostHook#*
\pdfstringdefPreHook#*
\pdfstringdefWarn{arg}#*
\sectionautorefname#*
\setpdflinkmargin{length}#*
\subparagraphautorefname#*
\subsectionautorefname#*
\subsubsectionautorefname#*
\tableautorefname#*
# most \theH<counter> are now in the format
\theHchapter#*
\theHHfootnote#*
\theHHmpfootnote#*
\theHItem#*
\theHtheorem#*
\theHthm#*
\theoremautorefname#*
\unichar{char num}#*
\XeTeXLinkBox{contents}#*
\XeTeXLinkMargin#*