i-graphics.xml /size: 24 Kb    last modification: 2025-02-21 11:03
1<?xml version="1.0" encoding="UTF-8"?>
2
3<?context-directive job ctxfile x-setups.ctx ?>
4
5<cd:interface xmlns:cd="http://www.pragma-ade.com/commands">
6
7    <cd:command name="defineexternalfigure" level="style" category="graphics" file="grph-inc.mkiv">
8        <cd:arguments>
9            <cd:resolve name="keyword-name"/>
10            <cd:resolve name="keyword-name-optional"/>
11            <cd:assignments list="yes" optional="yes">
12                <cd:inherit name="setupexternalfigure"/>
13            </cd:assignments>
14        </cd:arguments>
15    </cd:command>
16
17    <!--
18
19        <cd:command name="defineexternalfigures" level="style" category="graphics" file="grph-inc.mkiv">
20            <cd:arguments>
21                <cd:resolve name="keyword-name"/>
22                <cd:resolve name="keyword-name-optional"/>
23                <cd:assignments list="yes" optional="yes">
24                    <cd:inherit name="setupexternalfigure"/>
25                </cd:assignments>
26            </cd:arguments>
27        </cd:command>
28
29    -->
30
31    <cd:command name="setupexternalfigure" level="style" category="graphics" file="grph-inc.mkxl">
32        <cd:arguments>
33            <cd:resolve name="keyword-name-list-optional"/>
34            <cd:assignments list="yes">
35                <cd:parameter name="width">
36                    <cd:constant type="cd:dimension"/>
37                </cd:parameter>
38                <cd:parameter name="height">
39                    <cd:constant type="cd:dimension"/>
40                </cd:parameter>
41                <cd:parameter name="label">
42                    <cd:constant type="cd:name"/>
43                </cd:parameter>
44                <cd:parameter name="page">
45                    <cd:constant type="cd:number"/>
46                </cd:parameter>
47                <cd:parameter name="object">
48                    <cd:constant type="yes" default="yes"/>
49                    <cd:constant type="no"/>
50                </cd:parameter>
51                <cd:parameter name="prefix">
52                    <cd:constant type="cd:text"/>
53                </cd:parameter>
54                <cd:parameter name="method">
55                    <cd:constant type="pdf"/>
56                    <cd:constant type="mps"/>
57                    <cd:constant type="jpg"/>
58                    <cd:constant type="png"/>
59                    <cd:constant type="jp2"/>
60                    <cd:constant type="jbig"/>
61                    <cd:constant type="svg"/>
62                    <cd:constant type="eps"/>
63                    <cd:constant type="gif"/>
64                    <cd:constant type="tif"/>
65                    <cd:constant type="mov"/>
66                    <cd:constant type="buffer"/>
67                    <cd:constant type="tex"/>
68                    <cd:constant type="cld"/>
69                    <cd:constant type="auto"/>
70                </cd:parameter>
71                <cd:parameter name="controls">
72                    <cd:constant type="yes"/>
73                    <cd:constant type="no" default="yes"/>
74                </cd:parameter>
75                <cd:parameter name="preview">
76                    <cd:constant type="yes"/>
77                    <cd:constant type="no" default="yes"/>
78                </cd:parameter>
79                <cd:parameter name="mask">
80                    <cd:constant type="none"/>
81                </cd:parameter>
82                <cd:parameter name="resolution">
83                    <cd:constant type="cd:number"/>
84                </cd:parameter>
85                <cd:parameter name="color">
86                    <cd:constant type="cd:color"/>
87                </cd:parameter>
88                <cd:parameter name="cmyk">
89                    <cd:constant type="yes"/>
90                    <cd:constant type="no" default="yes"/>
91                    <cd:constant type="auto"/>
92                </cd:parameter>
93                <cd:parameter name="arguments">
94                    <cd:constant type="cd:text"/>
95                </cd:parameter>
96                <cd:parameter name="repeat">
97                    <cd:constant type="yes"/>
98                    <cd:constant type="no" default="yes"/>
99                </cd:parameter>
100                <cd:parameter name="factor">
101                    <cd:constant type="fit"/>
102                    <cd:constant type="broad"/>
103                    <cd:constant type="max"/>
104                    <cd:constant type="auto"/>
105                    <cd:constant type="default"/>
106                </cd:parameter>
107                <cd:parameter name="hfactor">
108                    <cd:constant type="fit"/>
109                    <cd:constant type="broad"/>
110                    <cd:constant type="max"/>
111                    <cd:constant type="auto"/>
112                    <cd:constant type="default"/>
113                </cd:parameter>
114                <cd:parameter name="wfactor">
115                    <cd:constant type="fit"/>
116                    <cd:constant type="broad"/>
117                    <cd:constant type="max"/>
118                    <cd:constant type="auto"/>
119                    <cd:constant type="default"/>
120                </cd:parameter>
121                <cd:parameter name="maxwidth">
122                    <cd:constant type="cd:dimension"/>
123                </cd:parameter>
124                <cd:parameter name="maxheight">
125                    <cd:constant type="cd:dimension"/>
126                </cd:parameter>
127                <cd:parameter name="equalwidth">
128                    <cd:constant type="cd:dimension"/>
129                </cd:parameter>
130                <cd:parameter name="equalheight">
131                    <cd:constant type="cd:dimension"/>
132                </cd:parameter>
133                <cd:parameter name="scale">
134                    <cd:constant type="cd:number"/>
135                </cd:parameter>
136                <cd:parameter name="xscale">
137                    <cd:constant type="cd:number"/>
138                </cd:parameter>
139                <cd:parameter name="yscale">
140                    <cd:constant type="cd:number"/>
141                </cd:parameter>
142                <cd:parameter name="s">
143                    <cd:constant type="cd:number"/>
144                </cd:parameter>
145                <cd:parameter name="sx">
146                    <cd:constant type="cd:number"/>
147                </cd:parameter>
148                <cd:parameter name="sy">
149                    <cd:constant type="cd:number"/>
150                </cd:parameter>
151                <cd:parameter name="lines">
152                    <cd:constant type="cd:number"/>
153                </cd:parameter>
154                <cd:parameter name="location">
155                    <cd:constant type="local" default="yes"/>
156                    <cd:constant type="global" default="yes"/>
157                    <cd:constant type="default"/>
158                </cd:parameter>
159                <cd:parameter name="directory">
160                    <cd:constant type="cd:path"/>
161                </cd:parameter>
162                <cd:parameter name="option">
163                    <cd:constant type="test"/>
164                    <cd:constant type="frame"/>
165                    <cd:constant type="empty"/>
166                </cd:parameter>
167                <cd:parameter name="foregroundcolor">
168                    <cd:constant type="cd:color"/>
169                </cd:parameter>
170                <cd:parameter name="reset">
171                    <cd:constant type="yes"/>
172                    <cd:constant type="no" default="yes"/>
173                </cd:parameter>
174                <cd:parameter name="background">
175                    <cd:constant type="color"/>
176                    <cd:constant type="foreground"/>
177                    <cd:constant type="cd:name"/>
178                </cd:parameter>
179                <cd:parameter name="frame">
180                    <cd:constant type="on"/>
181                    <cd:constant type="off" default="yes"/>
182                </cd:parameter>
183                <cd:parameter name="backgroundcolor">
184                    <cd:constant type="cd:color"/>
185                </cd:parameter>
186                <!--
187                    <cd:parameter name="align">
188                        <cd:inherit name="setupalign"/>
189                    </cd:parameter>
190                -->
191                <cd:parameter name="xmax">
192                    <cd:constant type="cd:number"/>
193                </cd:parameter>
194                <cd:parameter name="ymax">
195                    <cd:constant type="cd:number"/>
196                </cd:parameter>
197                <cd:parameter name="frames">
198                    <cd:constant type="on"/>
199                    <cd:constant type="off" default="yes"/>
200                </cd:parameter>
201                <cd:parameter name="interaction">
202                    <cd:constant type="yes"/>
203                    <cd:constant type="all"/>
204                    <cd:constant type="none" default="yes"/>
205                    <cd:constant type="reference"/>
206                    <cd:constant type="layer"/>
207                    <cd:constant type="bookmark"/>
208                </cd:parameter>
209                <cd:parameter name="bodyfont">
210                    <cd:constant type="cd:dimension"/>
211                </cd:parameter>
212                <cd:parameter name="comment">
213                    <cd:constant type="cd:command"/>
214                    <cd:constant type="cd:text"/>
215                </cd:parameter>
216                <cd:parameter name="size">
217                    <cd:constant type="none"/>
218                    <cd:constant type="media"/>
219                    <cd:constant type="crop"/>
220                    <cd:constant type="trim"/>
221                    <cd:constant type="art"/>
222                </cd:parameter>
223                <cd:parameter name="cache">
224                    <cd:constant type="cd:path"/>
225                </cd:parameter>
226                <cd:parameter name="resources">
227                    <cd:constant type="cd:path"/>
228                </cd:parameter>
229                <cd:parameter name="display">
230                    <cd:constant type="cd:file"/> <!-- an alternative figure often low res .. old school pdf stuff -->
231                </cd:parameter>
232                <cd:parameter name="conversion">
233                    <cd:constant type="cd:text"/> <!-- a extra (kind of) suffix that triggers conversion -->
234                </cd:parameter>
235                <cd:parameter name="order">
236                    <cd:constant type="cd:list"/> <!-- a list of suffixes/types to check -->
237                </cd:parameter>
238                <cd:parameter name="crossreference">
239                    <cd:constant type="yes"/>
240                    <cd:constant type="no"/>
241                    <!-- only passed by the system: -->
242                    <cd:constant type="cd:number"/>
243                </cd:parameter>
244                <cd:parameter name="transform">
245                    <cd:constant type="auto" default="yes"/>
246                    <cd:constant type="cd:number"/>
247                </cd:parameter>
248                <cd:parameter name="userpassword">
249                    <cd:constant type="cd:text"/>
250                </cd:parameter>
251                <cd:parameter name="ownerpassword">
252                    <cd:constant type="cd:text"/>
253                </cd:parameter>
254                <cd:parameter name="orientation">
255                    <cd:constant type="cd:number"/>
256                </cd:parameter>
257                <cd:parameter name="compact">
258                    <cd:constant type="yes"/>
259                    <cd:constant type="no" default="yes"/>
260                    <cd:constant type="merge"/>
261                    <cd:constant type="tikz"/>
262                    <cd:constant type="cd:name"/>
263                </cd:parameter>
264                <cd:parameter name="metadata">
265                    <cd:constant type="yes"/>
266                    <cd:constant type="no"/>
267                    <cd:constant type="page" default="yes"/>
268                    <cd:constant type="document"/>
269                </cd:parameter>
270            </cd:assignments>
271        </cd:arguments>
272    </cd:command>
273
274    <cd:command name="setupexternalfigures" level="style" category="graphics" file="grph-inc.mkxl">
275        <cd:arguments>
276            <cd:resolve name="keyword-name-list-optional"/>
277            <cd:assignments list="yes">
278                <cd:inherit name="setupexternalfigure"/>
279            </cd:assignments>
280        </cd:arguments>
281    </cd:command>
282
283    <cd:command name="useexternalfigure" level="style" category="graphics" file="grph-inc.mkiv">
284        <cd:arguments>
285            <cd:resolve name="keyword-name"/>
286            <cd:resolve name="keyword-file"/>
287            <cd:resolve name="keyword-name-optional"/>
288            <cd:assignments list="yes" optional="yes">
289                <cd:inherit name="setupexternalfigure"/>
290            </cd:assignments>
291        </cd:arguments>
292    </cd:command>
293
294    <cd:command name="externalfigure" level="document" category="graphics" file="grph-inc.mkiv">
295        <cd:arguments>
296            <cd:resolve name="keyword-file"/>
297            <cd:resolve name="keyword-name-optional"/>
298            <cd:assignments list="yes" optional="yes">
299                <cd:inherit name="setupexternalfigure"/>
300            </cd:assignments>
301        </cd:arguments>
302    </cd:command>
303
304    <cd:command name="getfiguredimensions" level="system" category="graphics" file="grph-inc.mkiv">
305        <cd:arguments>
306            <cd:resolve name="keyword-file"/>
307            <cd:assignments list="yes" optional="yes">
308                <cd:inherit name="setupexternalfigure"/>
309            </cd:assignments>
310        </cd:arguments>
311    </cd:command>
312
313    <cd:command name="figurewidth" level="system" category="graphics" file="grph-inc.mkiv"/>
314
315    <cd:command name="figureheight" level="system" category="graphics" file="grph-inc.mkiv"/>
316
317    <cd:command name="figurenaturalwidth" level="system" category="graphics" file="grph-inc.mkiv"/>
318
319    <cd:command name="figurenaturalheight" level="system" category="graphics" file="grph-inc.mkiv"/>
320
321    <cd:command name="figurefullname" level="system" category="graphics" file="grph-inc.mkiv"/>
322
323    <cd:command name="figurefilename" level="system" category="graphics" file="grph-inc.mkiv"/>
324
325    <cd:command name="figurefilepath" level="system" category="graphics" file="grph-inc.mkiv"/>
326
327    <cd:command name="figurefiletype" level="system" category="graphics" file="grph-inc.mkiv"/>
328
329    <cd:command name="noffigurepages" level="system" category="graphics" file="grph-inc.mkiv"/>
330
331    <cd:command name="definegraphictypesynonym" level="system" category="graphics" file="grph-inc.mkiv">
332        <cd:arguments>
333            <cd:resolve name="keyword-name"/>
334            <cd:resolve name="keyword-name"/>
335        </cd:arguments>
336    </cd:command>
337
338    <cd:command name="doifelsefigure" level="system" category="graphics" keywords="conditional" file="grph-inc.mkiv">
339        <cd:arguments>
340            <cd:resolve name="argument-file"/>
341            <cd:resolve name="argument-true"/>
342            <cd:resolve name="argument-false"/>
343        </cd:arguments>
344    </cd:command>
345
346    <cd:command name="doiffigureelse" level="system" category="graphics" keywords="conditional" file="grph-inc.mkiv">
347        <cd:arguments>
348            <cd:resolve name="argument-file"/>
349            <cd:resolve name="argument-true"/>
350            <cd:resolve name="argument-false"/>
351        </cd:arguments>
352    </cd:command>
353
354    <cd:command name="registerexternalfigure" level="system" category="graphics" file="grph-inc.mkiv">
355        <cd:arguments>
356            <cd:resolve name="keyword-file"/>
357            <cd:resolve name="keyword-name-optional"/>
358            <cd:assignments list="yes" optional="yes">
359                <cd:inherit name="setupexternalfigure"/>
360            </cd:assignments>
361        </cd:arguments>
362    </cd:command>
363
364    <cd:command name="usefigurebase" level="style" category="graphics" file="grph-inc.mkiv">
365        <cd:arguments>
366            <cd:keywords>
367                <cd:constant type="reset"/>
368                <cd:constant type="cd:file"/>
369            </cd:keywords>
370        </cd:arguments>
371    </cd:command>
372
373    <cd:command name="externalfigurecollection" type="environment" level="style" category="graphics" file="grph-inc.mkiv">
374        <cd:arguments>
375            <cd:resolve name="keyword-name"/>
376        </cd:arguments>
377    </cd:command>
378
379    <cd:command name="externalfigurecollectionminwidth" level="style" category="graphics" file="grph-inc.mkiv">
380        <cd:arguments>
381            <cd:resolve name="argument-name"/>
382        </cd:arguments>
383    </cd:command>
384
385    <cd:command name="externalfigurecollectionmaxwidth" level="style" category="graphics" file="grph-inc.mkiv">
386        <cd:arguments>
387            <cd:resolve name="argument-name"/>
388        </cd:arguments>
389    </cd:command>
390
391    <cd:command name="externalfigurecollectionminheight" level="style" category="graphics" file="grph-inc.mkiv">
392        <cd:arguments>
393            <cd:resolve name="argument-name"/>
394        </cd:arguments>
395    </cd:command>
396
397    <cd:command name="externalfigurecollectionmaxheight" level="style" category="graphics" file="grph-inc.mkiv">
398        <cd:arguments>
399            <cd:resolve name="argument-name"/>
400        </cd:arguments>
401    </cd:command>
402
403    <cd:command name="externalfigurecollectionparameter" level="system" category="graphics" file="grph-inc.mkiv">
404        <cd:arguments>
405            <cd:resolve name="argument-name"/>
406            <cd:resolve name="argument-key"/>
407        </cd:arguments>
408    </cd:command>
409
410    <cd:command name="efcminwidth" level="style" category="graphics" file="grph-inc.mkiv">
411        <cd:arguments>
412            <cd:resolve name="argument-name"/>
413        </cd:arguments>
414    </cd:command>
415
416    <cd:command name="efcmaxwidth" level="style" category="graphics" file="grph-inc.mkiv">
417        <cd:arguments>
418            <cd:resolve name="argument-name"/>
419        </cd:arguments>
420    </cd:command>
421
422    <cd:command name="efcminheight" level="style" category="graphics" file="grph-inc.mkiv">
423        <cd:arguments>
424            <cd:resolve name="argument-name"/>
425        </cd:arguments>
426    </cd:command>
427
428    <cd:command name="efcmaxheight" level="style" category="graphics" file="grph-inc.mkiv">
429        <cd:arguments>
430            <cd:resolve name="argument-name"/>
431        </cd:arguments>
432    </cd:command>
433
434    <cd:command name="efcparameter" level="style" category="graphics" file="grph-inc.mkiv">
435        <cd:arguments>
436            <cd:resolve name="argument-name"/>
437            <cd:resolve name="argument-key"/>
438        </cd:arguments>
439    </cd:command>
440
441    <cd:command name="overlayfigure" level="style" category="graphics" file="grph-inc.mkiv">
442        <cd:arguments>
443            <cd:resolve name="argument-file"/>
444        </cd:arguments>
445    </cd:command>
446
447    <cd:command name="bitmapimage" level="document" category="graphics" file="grph-inc.mkiv">
448        <cd:arguments>
449            <cd:assignments list="yes">
450                <cd:parameter name="color">
451                    <cd:constant type="rgb"/>
452                    <cd:constant type="cmyk"/>
453                    <cd:constant type="gray"/>
454                </cd:parameter>
455                <cd:parameter name="width">
456                    <cd:constant type="cd:dimension"/>
457                </cd:parameter>
458                <cd:parameter name="height">
459                    <cd:constant type="cd:dimension"/>
460                </cd:parameter>
461                <cd:parameter name="x">
462                    <cd:constant type="cd:number"/>
463                </cd:parameter>
464                <cd:parameter name="y">
465                    <cd:constant type="cd:number"/>
466                </cd:parameter>
467            </cd:assignments>
468            <cd:keywords delimiters="braces">
469                <cd:constant type="cd:number"/>
470            </cd:keywords>
471        </cd:arguments>
472    </cd:command>
473
474    <cd:command name="bitmapimage" type="environment" level="document" category="graphics" file="grph-inc.mkiv">
475        <cd:arguments>
476            <cd:assignments list="yes">
477                <cd:parameter name="color">
478                    <cd:constant type="rgb"/>
479                    <cd:constant type="cmyk"/>
480                    <cd:constant type="gray"/>
481                </cd:parameter>
482                <cd:parameter name="width">
483                    <cd:constant type="cd:dimension"/>
484                </cd:parameter>
485                <cd:parameter name="height">
486                    <cd:constant type="cd:dimension"/>
487                </cd:parameter>
488                <cd:parameter name="x">
489                    <cd:constant type="cd:number"/>
490                </cd:parameter>
491                <cd:parameter name="y">
492                    <cd:constant type="cd:number"/>
493                </cd:parameter>
494            </cd:assignments>
495        </cd:arguments>
496    </cd:command>
497
498    <cd:command name="typesetbuffer" level="document" category="graphics" keywords="buffer" file="grph-fig.mkiv">
499        <cd:arguments>
500            <cd:keywords optional="yes">
501                <cd:constant type="*"/>
502                <cd:constant type="cd:buffer"/>
503            </cd:keywords>
504            <cd:assignments list="yes" optional="yes">
505                <cd:inherit name="setupexternalfigure"/>
506            </cd:assignments>
507        </cd:arguments>
508    </cd:command>
509
510    <cd:command name="typesetbufferonly" level="document" category="graphics" keywords="buffer" file="grph-fig.mkiv">
511        <cd:arguments>
512            <cd:keywords optional="yes">
513                <cd:constant type="*"/>
514                <cd:constant type="cd:buffer"/>
515            </cd:keywords>
516        </cd:arguments>
517    </cd:command>
518
519    <cd:command name="definetypesetting" level="style" category="graphics" keywords="structure" file="grph-fig.mkiv">
520        <cd:arguments>
521            <cd:resolve name="keyword-name"/>
522            <cd:resolve name="keyword-text-optional"/>
523            <cd:assignments list="yes" optional="yes">
524                <cd:inherit name="setupexternalfigure"/>
525            </cd:assignments>
526        </cd:arguments>
527    </cd:command>
528
529    <cd:command name="typesetfile" level="document" category="graphics" keywords="structure" file="grph-fig.mkiv">
530        <cd:arguments>
531            <cd:keywords>
532                <cd:constant type="cd:name"/>
533                <cd:constant type="cd:file"/>
534            </cd:keywords>
535            <cd:keywords optional="yes">
536                <cd:constant type="cd:file"/>
537                <cd:constant type="cd:text"/>
538            </cd:keywords>
539            <cd:assignments list="yes" optional="yes">
540                <cd:inherit name="setupexternalfigure"/>
541            </cd:assignments>
542        </cd:arguments>
543    </cd:command>
544
545    <cd:command name="backgroundimage" level="style" category="graphics" file="pack-box.mkiv">
546        <cd:arguments>
547            <cd:resolve name="argument-number"/>
548            <cd:resolve name="argument-dimension"/>
549            <cd:resolve name="argument-dimension"/>
550            <cd:resolve name="argument-command"/>
551        </cd:arguments>
552    </cd:command>
553
554    <cd:command name="backgroundimagefill" level="style" category="graphics" file="pack-box.mkiv">
555        <cd:arguments>
556            <cd:resolve name="argument-number"/>
557            <cd:resolve name="argument-dimension"/>
558            <cd:resolve name="argument-dimension"/>
559            <cd:resolve name="argument-command"/>
560        </cd:arguments>
561    </cd:command>
562
563    <cd:command name="overlayimage" level="style" category="graphics" file="pack-box.mkiv">
564        <cd:arguments>
565            <cd:resolve name="argument-file"/>
566        </cd:arguments>
567    </cd:command>
568
569    <cd:command name="clippedoverlayimage" level="style" category="graphics" file="pack-box.mkiv">
570        <cd:arguments>
571            <cd:resolve name="argument-file"/>
572        </cd:arguments>
573    </cd:command>
574
575    <cd:command name="includesvgfile" level="document" category="graphics" file="grph-inc.mkiv">
576        <cd:arguments>
577            <cd:resolve name="keyword-file"/>
578            <cd:assignments list="yes" optional="yes">
579                <cd:parameter name="offset">
580                    <cd:constant type="cd:dimension"/>
581                </cd:parameter>
582            </cd:assignments>
583        </cd:arguments>
584    </cd:command>
585
586    <cd:command name="includesvgbuffer" level="document" category="graphics" file="grph-inc.mkiv">
587        <cd:arguments>
588            <cd:resolve name="keyword-buffer"/>
589            <cd:assignments list="yes" optional="yes">
590                <cd:parameter name="offset">
591                    <cd:constant type="cd:dimension"/>
592                </cd:parameter>
593            </cd:assignments>
594        </cd:arguments>
595    </cd:command>
596
597</cd:interface>
598