Difference between revisions of "Command/setupexternalfigure"
< Command
Jump to navigation
Jump to search
m (comment about mov) |
|||
(5 intermediate revisions by 4 users not shown) | |||
Line 21: | Line 21: | ||
</cd:parameter> | </cd:parameter> | ||
<cd:parameter name="label"> | <cd:parameter name="label"> | ||
− | <cd:paramdoc></cd:paramdoc> | + | <cd:paramdoc>internal name</cd:paramdoc> |
<cd:constant type="cd:name"></cd:constant> | <cd:constant type="cd:name"></cd:constant> | ||
</cd:parameter> | </cd:parameter> | ||
Line 53: | Line 53: | ||
<cd:constant type="tex"></cd:constant> | <cd:constant type="tex"></cd:constant> | ||
<cd:constant type="cld"></cd:constant> | <cd:constant type="cld"></cd:constant> | ||
− | <cd:constant type="auto"></cd:constant> | + | <cd:constant type="auto">strips suffix and uses "order"</cd:constant> |
</cd:parameter> | </cd:parameter> | ||
<cd:parameter name="controls"> | <cd:parameter name="controls"> | ||
Line 84: | Line 84: | ||
</cd:parameter> | </cd:parameter> | ||
<cd:parameter name="arguments"> | <cd:parameter name="arguments"> | ||
− | <cd:paramdoc></cd:paramdoc> | + | <cd:paramdoc>used for converters</cd:paramdoc> |
<cd:constant type="cd:text"></cd:constant> | <cd:constant type="cd:text"></cd:constant> | ||
</cd:parameter> | </cd:parameter> | ||
Line 177: | Line 177: | ||
<cd:constant type="test"></cd:constant> | <cd:constant type="test"></cd:constant> | ||
<cd:constant type="frame"></cd:constant> | <cd:constant type="frame"></cd:constant> | ||
− | <cd:constant type="empty"></cd:constant> | + | <cd:constant type="empty">don’t include actual image (“draft mode”)</cd:constant> |
</cd:parameter> | </cd:parameter> | ||
<cd:parameter name="foregroundcolor"> | <cd:parameter name="foregroundcolor"> | ||
− | <cd:paramdoc></cd:paramdoc> | + | <cd:paramdoc>probably synonymous to "color"</cd:paramdoc> |
<cd:constant type="cd:color"></cd:constant> | <cd:constant type="cd:color"></cd:constant> | ||
</cd:parameter> | </cd:parameter> | ||
Line 189: | Line 189: | ||
</cd:parameter> | </cd:parameter> | ||
<cd:parameter name="background"> | <cd:parameter name="background"> | ||
− | <cd:paramdoc></cd:paramdoc> | + | <cd:paramdoc>like {{cmd|setupframed}}</cd:paramdoc> |
<cd:constant type="color"></cd:constant> | <cd:constant type="color"></cd:constant> | ||
<cd:constant type="foreground"></cd:constant> | <cd:constant type="foreground"></cd:constant> | ||
Line 200: | Line 200: | ||
</cd:parameter> | </cd:parameter> | ||
<cd:parameter name="backgroundcolor"> | <cd:parameter name="backgroundcolor"> | ||
− | <cd:paramdoc></cd:paramdoc> | + | <cd:paramdoc>like {{cmd|setupframed}}, used if <tt>background=color</tt></cd:paramdoc> |
<cd:constant type="cd:color"></cd:constant> | <cd:constant type="cd:color"></cd:constant> | ||
</cd:parameter> | </cd:parameter> | ||
Line 217: | Line 217: | ||
</cd:parameter> | </cd:parameter> | ||
<cd:parameter name="interaction"> | <cd:parameter name="interaction"> | ||
− | <cd:paramdoc></cd:paramdoc> | + | <cd:paramdoc>How to handle the interaction (links etc.) of included PDFs – default is to disable all of them.</cd:paramdoc> |
− | <cd:constant type="yes"></cd:constant> | + | <cd:constant type="yes">keep all(?)</cd:constant> |
− | <cd:constant type="all"></cd:constant> | + | <cd:constant type="all">keep all</cd:constant> |
− | <cd:constant default="yes" type="none"></cd:constant> | + | <cd:constant default="yes" type="none">disable all</cd:constant> |
− | <cd:constant type="reference"></cd:constant> | + | <cd:constant type="reference">keep references</cd:constant> |
− | <cd:constant type="layer"></cd:constant> | + | <cd:constant type="layer">keep PDF layers (viewer layers, optional content groups)</cd:constant> |
− | <cd:constant type="bookmark"></cd:constant> | + | <cd:constant type="bookmark">keep bookmarks</cd:constant> |
</cd:parameter> | </cd:parameter> | ||
<cd:parameter name="bodyfont"> | <cd:parameter name="bodyfont"> | ||
Line 251: | Line 251: | ||
</cd:parameter> | </cd:parameter> | ||
<cd:parameter name="display"> | <cd:parameter name="display"> | ||
− | <cd:paramdoc>alternative figure, e.g. lowres</cd:paramdoc> | + | <cd:paramdoc>alternative figure, e.g. lowres; used with movie and 3D contents, probably obsolete</cd:paramdoc> |
<cd:constant type="cd:file"></cd:constant> | <cd:constant type="cd:file"></cd:constant> | ||
</cd:parameter> | </cd:parameter> | ||
Line 267: | Line 267: | ||
<cd:parameter name="crossreference"> | <cd:parameter name="crossreference"> | ||
<cd:paramdoc></cd:paramdoc> | <cd:paramdoc></cd:paramdoc> | ||
− | <cd:constant type="yes"></cd:constant> | + | <cd:constant type="yes">use counter for referencing</cd:constant> |
<cd:constant type="no"></cd:constant> | <cd:constant type="no"></cd:constant> | ||
<cd:constant type="cd:number"></cd:constant> | <cd:constant type="cd:number"></cd:constant> | ||
Line 288: | Line 288: | ||
</cd:command> | </cd:command> | ||
</cd:variants> | </cd:variants> | ||
− | <cd:description></cd:description> | + | <cd:description>The also exists the following option which is missing in the interface files: |
+ | |||
+ | * '''orientation''': rotation (in LMTX arbitrary angles, in MkIV only 90˚steps)</cd:description> | ||
<cd:examples><cd:example title=""><texcode> | <cd:examples><cd:example title=""><texcode> | ||
\setupexternalfigures | \setupexternalfigures | ||
Line 298: | Line 300: | ||
<cd:seealso> | <cd:seealso> | ||
<cd:commandref name="defineexternalfigure" originator="system"></cd:commandref> | <cd:commandref name="defineexternalfigure" originator="system"></cd:commandref> | ||
− | <cd: | + | <cd:commandref name="externalfigure"></cd:commandref> |
− | <cd: | + | <cd:commandref name="definegraphictypesynonym"></cd:commandref> |
<cd:wikipage originator="system" page="Category:Graphics"></cd:wikipage> | <cd:wikipage originator="system" page="Category:Graphics"></cd:wikipage> | ||
− | <cd: | + | <cd:source file="grph-inc.mkvi" originator="system">MkIV source</cd:source> |
+ | <cd:source file="grph-inc.mkxl">LMTX source</cd:source> | ||
+ | <cd:source file="grph-con.lua">conversions source</cd:source> | ||
+ | <cd:wikipage page="Using Graphics"></cd:wikipage> | ||
+ | <cd:wikipage page="Multimedia Inclusion">to add audio and video contents</cd:wikipage></cd:seealso> | ||
</cd:commandgroup> | </cd:commandgroup> |
Latest revision as of 12:40, 22 April 2024
Contents
\setupexternalfigure
Summary
The command \setupexternalfigure sets up \externalfigure
Settings
\setupexternalfigure[...,...][...=...,...] | |
[...,...] | name |
width | dimension |
height | dimension |
label | name |
page | number |
object | yes no |
prefix | text |
method | pdf mps jpg png jp2 jbig svg eps gif tif mov buffer tex cld auto |
controls | yes no |
preview | yes no |
mask | none |
resolution | number |
color | color |
cmyk | yes no auto |
arguments | text |
repeat | yes no |
factor | fit broad max auto default |
hfactor | fit broad max auto default |
wfactor | fit broad max auto default |
maxwidth | dimension |
maxheight | dimension |
equalwidth | dimension |
equalheight | dimension |
scale | number |
xscale | number |
yscale | number |
s | number |
sx | number |
sy | number |
lines | number |
location | local global default |
directory | path |
option | test frame empty |
foregroundcolor | color |
reset | yes no |
background | color foreground name |
frame | on off |
backgroundcolor | color |
xmax | number |
ymax | number |
frames | on off |
interaction | yes all none reference layer bookmark |
bodyfont | dimension |
comment | command text |
size | none media crop trim art |
cache | path |
resources | path |
display | file |
conversion | text |
order | list |
crossreference | yes no number |
transform | auto number |
userpassword | text |
ownerpassword | text |
Option | Explanation | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
label |
| ||||||||||||||
page |
| ||||||||||||||
object |
| ||||||||||||||
method |
| ||||||||||||||
controls |
| ||||||||||||||
resolution |
| ||||||||||||||
color |
| ||||||||||||||
cmyk |
| ||||||||||||||
arguments |
| ||||||||||||||
factor |
| ||||||||||||||
maxwidth |
| ||||||||||||||
maxheight |
| ||||||||||||||
scale |
| ||||||||||||||
lines |
| ||||||||||||||
location |
| ||||||||||||||
directory |
| ||||||||||||||
option |
| ||||||||||||||
foregroundcolor |
| ||||||||||||||
background |
| ||||||||||||||
frame |
| ||||||||||||||
backgroundcolor |
| ||||||||||||||
interaction |
| ||||||||||||||
size |
| ||||||||||||||
cache |
| ||||||||||||||
display |
| ||||||||||||||
conversion |
| ||||||||||||||
order |
| ||||||||||||||
crossreference |
| ||||||||||||||
transform |
| ||||||||||||||
userpassword |
| ||||||||||||||
ownerpassword |
|
Description
The also exists the following option which is missing in the interface files:
- orientation: rotation (in LMTX arbitrary angles, in MkIV only 90˚steps)
Examples
Example 1
\setupexternalfigures [order={pdf,png,jpg}, location=global, directory={images}]
Notes
See also
- \defineexternalfigure
- \externalfigure
- \definegraphictypesynonym
- grph-inc.mkvi MkIV source
- grph-inc.mkxl LMTX source
- grph-con.lua conversions source
- Using Graphics
- Multimedia Inclusion to add audio and video contents