Changes

Jump to navigation Jump to search
Created page with "Documentation for \setupexternalfigure"
<cd:commandgroup name="setupexternalfigure" xmlns:cd="http://wiki.contextgarden.net/commanddoc/20200807">
<cd:shortdesc><!-- a short command summary goes here -->
The command <tt>\setupexternalfigure</tt> sets up {{cmd|externalfigure}}
</cd:shortdesc>
<cd:variants>
<cd:command category="graphics" file="grph-inc.mkvi" interfacedate="2020-07-14T09:24" interfacefile="i-graphics.xml" level="style" name="setupexternalfigure" variantnumber="1">
<cd:arguments>
<cd:keywords list="yes" optional="yes" ordinal="1">
<cd:keywordsdoc></cd:keywordsdoc>
<cd:constant type="cd:name"></cd:constant>
</cd:keywords>
<cd:assignments list="yes" ordinal="2">
<cd:assignmentsdoc></cd:assignmentsdoc>
<cd:parameter name="width">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="cd:dimension"></cd:constant>
</cd:parameter>
<cd:parameter name="height">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="cd:dimension"></cd:constant>
</cd:parameter>
<cd:parameter name="label">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="cd:name"></cd:constant>
</cd:parameter>
<cd:parameter name="page">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="cd:number"></cd:constant>
</cd:parameter>
<cd:parameter name="object">
<cd:paramdoc></cd:paramdoc>
<cd:constant default="yes" type="yes"></cd:constant>
<cd:constant type="no"></cd:constant>
</cd:parameter>
<cd:parameter name="prefix">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="cd:text"></cd:constant>
</cd:parameter>
<cd:parameter name="method">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="pdf"></cd:constant>
<cd:constant type="mps"></cd:constant>
<cd:constant type="jpg"></cd:constant>
<cd:constant type="png"></cd:constant>
<cd:constant type="jp2"></cd:constant>
<cd:constant type="jbig"></cd:constant>
<cd:constant type="svg"></cd:constant>
<cd:constant type="eps"></cd:constant>
<cd:constant type="gif"></cd:constant>
<cd:constant type="tif"></cd:constant>
<cd:constant type="mov"></cd:constant>
<cd:constant type="buffer"></cd:constant>
<cd:constant type="tex"></cd:constant>
<cd:constant type="cld"></cd:constant>
<cd:constant type="auto"></cd:constant>
</cd:parameter>
<cd:parameter name="controls">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="yes"></cd:constant>
<cd:constant default="yes" type="no"></cd:constant>
</cd:parameter>
<cd:parameter name="preview">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="yes"></cd:constant>
<cd:constant default="yes" type="no"></cd:constant>
</cd:parameter>
<cd:parameter name="mask">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="none"></cd:constant>
</cd:parameter>
<cd:parameter name="resolution">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="cd:number"></cd:constant>
</cd:parameter>
<cd:parameter name="color">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="cd:color"></cd:constant>
</cd:parameter>
<cd:parameter name="cmyk">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="yes"></cd:constant>
<cd:constant default="yes" type="no"></cd:constant>
<cd:constant type="auto"></cd:constant>
</cd:parameter>
<cd:parameter name="arguments">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="cd:text"></cd:constant>
</cd:parameter>
<cd:parameter name="repeat">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="yes"></cd:constant>
<cd:constant default="yes" type="no"></cd:constant>
</cd:parameter>
<cd:parameter name="factor">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="fit"></cd:constant>
<cd:constant type="broad"></cd:constant>
<cd:constant type="max"></cd:constant>
<cd:constant type="auto"></cd:constant>
<cd:constant type="default"></cd:constant>
</cd:parameter>
<cd:parameter name="hfactor">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="fit"></cd:constant>
<cd:constant type="broad"></cd:constant>
<cd:constant type="max"></cd:constant>
<cd:constant type="auto"></cd:constant>
<cd:constant type="default"></cd:constant>
</cd:parameter>
<cd:parameter name="wfactor">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="fit"></cd:constant>
<cd:constant type="broad"></cd:constant>
<cd:constant type="max"></cd:constant>
<cd:constant type="auto"></cd:constant>
<cd:constant type="default"></cd:constant>
</cd:parameter>
<cd:parameter name="maxwidth">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="cd:dimension"></cd:constant>
</cd:parameter>
<cd:parameter name="maxheight">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="cd:dimension"></cd:constant>
</cd:parameter>
<cd:parameter name="equalwidth">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="cd:dimension"></cd:constant>
</cd:parameter>
<cd:parameter name="equalheight">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="cd:dimension"></cd:constant>
</cd:parameter>
<cd:parameter name="scale">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="cd:number"></cd:constant>
</cd:parameter>
<cd:parameter name="xscale">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="cd:number"></cd:constant>
</cd:parameter>
<cd:parameter name="yscale">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="cd:number"></cd:constant>
</cd:parameter>
<cd:parameter name="s">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="cd:number"></cd:constant>
</cd:parameter>
<cd:parameter name="sx">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="cd:number"></cd:constant>
</cd:parameter>
<cd:parameter name="sy">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="cd:number"></cd:constant>
</cd:parameter>
<cd:parameter name="lines">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="cd:number"></cd:constant>
</cd:parameter>
<cd:parameter name="location">
<cd:paramdoc>Where to find figure files. Multiple comma-separated options are allowed, and the default value is <code>local,global</code>
</cd:paramdoc>
<cd:constant default="yes" type="local">search in the current directory</cd:constant>
<cd:constant default="yes" type="global">search path specified with the <cd:iref name="directory"/> key</cd:constant>
<cd:constant type="default">search in the texmf tree</cd:constant>
</cd:parameter>
<cd:parameter name="directory">
<cd:paramdoc>comma-separated directories to search for figure files</cd:paramdoc>
<cd:constant type="cd:path"></cd:constant>
</cd:parameter>
<cd:parameter name="option">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="test"></cd:constant>
<cd:constant type="frame"></cd:constant>
<cd:constant type="empty"></cd:constant>
</cd:parameter>
<cd:parameter name="foregroundcolor">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="cd:color"></cd:constant>
</cd:parameter>
<cd:parameter name="reset">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="yes"></cd:constant>
<cd:constant default="yes" type="no"></cd:constant>
</cd:parameter>
<cd:parameter name="background">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="color"></cd:constant>
<cd:constant type="foreground"></cd:constant>
<cd:constant type="cd:name"></cd:constant>
</cd:parameter>
<cd:parameter name="frame">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="on"></cd:constant>
<cd:constant default="yes" type="off"></cd:constant>
</cd:parameter>
<cd:parameter name="backgroundcolor">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="cd:color"></cd:constant>
</cd:parameter>
<cd:parameter name="xmax">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="cd:number"></cd:constant>
</cd:parameter>
<cd:parameter name="ymax">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="cd:number"></cd:constant>
</cd:parameter>
<cd:parameter name="frames">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="on"></cd:constant>
<cd:constant default="yes" type="off"></cd:constant>
</cd:parameter>
<cd:parameter name="interaction">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="yes"></cd:constant>
<cd:constant type="all"></cd:constant>
<cd:constant default="yes" type="none"></cd:constant>
<cd:constant type="reference"></cd:constant>
<cd:constant type="layer"></cd:constant>
<cd:constant type="bookmark"></cd:constant>
</cd:parameter>
<cd:parameter name="bodyfont">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="cd:dimension"></cd:constant>
</cd:parameter>
<cd:parameter name="comment">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="cd:command"></cd:constant>
<cd:constant type="cd:text"></cd:constant>
</cd:parameter>
<cd:parameter name="size">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="none"></cd:constant>
<cd:constant type="media"></cd:constant>
<cd:constant type="crop"></cd:constant>
<cd:constant type="trim"></cd:constant>
<cd:constant type="art"></cd:constant>
</cd:parameter>
<cd:parameter name="cache">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="cd:path"></cd:constant>
</cd:parameter>
<cd:parameter name="resources">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="cd:path"></cd:constant>
</cd:parameter>
<cd:parameter name="display">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="cd:file"></cd:constant>
</cd:parameter>
<cd:parameter name="conversion">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="cd:text"></cd:constant>
</cd:parameter>
<cd:parameter name="order">
<cd:paramdoc>Sets the order in which the individual file types are looked up.

</cd:paramdoc>
<cd:constant type="cd:list"></cd:constant>
</cd:parameter>
<cd:parameter name="crossreference">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="yes"></cd:constant>
<cd:constant type="no"></cd:constant>
<cd:constant type="cd:number"></cd:constant>
</cd:parameter>
<cd:parameter name="transform">
<cd:paramdoc></cd:paramdoc>
<cd:constant default="yes" type="auto"></cd:constant>
<cd:constant type="cd:number"></cd:constant>
</cd:parameter>
<cd:parameter name="userpassword">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="cd:text"></cd:constant>
</cd:parameter>
<cd:parameter name="ownerpassword">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="cd:text"></cd:constant>
</cd:parameter>
</cd:assignments>
</cd:arguments>
</cd:command>
</cd:variants>
<cd:description><!-- the long description of the command goes here -->
</cd:description>
<cd:examples><cd:example title=""><texcode>
\setupexternalfigures
[order={pdf,png,jpg},
location=global,
directory={images}]
</texcode></cd:example></cd:examples>
<cd:notes></cd:notes>
<cd:seealso>
<cd:commandref name="defineexternalfigure" originator="system"></cd:commandref>
<cd:source file="grph-inc.mkvi" originator="system"></cd:source>
<cd:wikipage originator="system" page="Category:Graphics"></cd:wikipage>
<cd:commandref name="externalfigure"></cd:commandref></cd:seealso>
</cd:commandgroup>

Navigation menu