Difference between revisions of "Command/setupexternalfigure"

From Wiki
Jump to navigation Jump to search
m (comment about mov)
(some more information)
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 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>There are a few more options that are missing in the interface files:
 +
 
 +
* '''minwidth/minheight'''
 +
* '''strut''': strut=none also avoids the \noindent; otherwise we're in hmode when blank happens and we get a lineskip</cd:description>
 
<cd:examples><cd:example title=""><texcode>
 
<cd:examples><cd:example title=""><texcode>
 
\setupexternalfigures
 
\setupexternalfigures
Line 298: Line 301:
 
<cd:seealso>
 
<cd:seealso>
 
<cd:commandref name="defineexternalfigure" originator="system"></cd:commandref>
 
<cd:commandref name="defineexternalfigure" originator="system"></cd:commandref>
<cd:source file="grph-inc.mkvi" originator="system"></cd:source>
+
<cd:commandref name="externalfigure"></cd:commandref>
<cd:source file="grph-con.lua">conversions</cd:source>
 
 
<cd:wikipage originator="system" page="Category:Graphics"></cd:wikipage>
 
<cd:wikipage originator="system" page="Category:Graphics"></cd:wikipage>
<cd:commandref name="externalfigure"></cd:commandref></cd:seealso>
+
<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:seealso>
 
</cd:commandgroup>
 
</cd:commandgroup>

Revision as of 21:17, 11 August 2022


\setupexternalfigure

Summary

The command \setupexternalfigure sets up \externalfigure

Settings

\setupexternalfigure[...,...][...=...,...]
[...,...]name
widthdimension
heightdimension
labelname
pagenumber
objectyes no
prefixtext
methodpdf mps jpg png jp2 jbig svg eps gif tif mov buffer tex cld auto
controlsyes no
previewyes no
masknone
resolutionnumber
colorcolor
cmykyes no auto
argumentstext
repeatyes no
factorfit broad max auto default
hfactorfit broad max auto default
wfactorfit broad max auto default
maxwidthdimension
maxheightdimension
equalwidthdimension
equalheightdimension
scalenumber
xscalenumber
yscalenumber
snumber
sxnumber
synumber
linesnumber
locationlocal global default
directorypath
optiontest frame empty
foregroundcolorcolor
resetyes no
backgroundcolor foreground name
frameon off
backgroundcolorcolor
xmaxnumber
ymaxnumber
frameson off
interactionyes all none reference layer bookmark
bodyfontdimension
commentcommand text
sizenone media crop trim art
cachepath
resourcespath
displayfile
conversiontext
orderlist
crossreferenceyes no number
transformauto number
userpasswordtext
ownerpasswordtext

OptionExplanation
label
internal name
page
Page number of PDF.
object
Reuse this image file as an object, i.e. embed it only once in PDF if it’s used several times?
method
force a file type (and processing), e.g. if there are different versions
mov is removed from LMTX
auto strips suffix and uses "order"
controls
Show media controls (for movies)
resolution
Set the image resolution (after scaling) for automatic downsampling
number dpi
color
Colorize the image. Works only with some greyscale pictures (no channels, no additional tables, ...?) and only with toned (p=) or spot colors. Use with object=no
color color name
cmyk
Force CMYK conversion
arguments
used for converters
factor
If both width and height are set, the factor is important. If factor is empty, the image is deformed accordingly.
fit aspect ratio is kept, the image is scaled to the smaller (fitted) variant
max aspect ratio is kept, the image is scaled to the bigger (oversized) variant
maxwidth
maximum width
maxheight
maximum height
scale
1000 is original size (100%); to get 72%, use scale=720.
lines
Height in lines
location
Where to find figure files. Multiple comma-separated options are allowed, and the default value is local,global
local search in the current directory
global search path specified with the directory key
default search in the texmf tree
directory
comma-separated directories to search for figure files
option
empty don’t include actual image (“draft mode”)
foregroundcolor
probably synonymous to "color"
background
like \setupframed
frame
Show frame around image. Most(?) options of \setupframed are usable!
backgroundcolor
like \setupframed, used if background=color
size
Use specified box of PDF (MediaBox, CropBox, TrimBox, ArtBox). (No BleedBox?)
cache
Set location of cache for conversions
display
alternative figure, e.g. lowres; used with movie and 3D contents, probably obsolete
conversion
see grph-con.lua. conversion=mp activates internal processing of SVG via MetaPost
order
Sets the order in which the individual file types are looked up.
crossreference
yes use counter for referencing
transform
Rotation in 90˚ steps (otherwise use \rotate); does not always work (?) orientation=90|180|270 works
userpassword
Access to encrypted PDFs
ownerpassword
Access to encrypted PDFs

Description

There are a few more options that are missing in the interface files:
  • minwidth/minheight
  • strut: strut=none also avoids the \noindent; otherwise we're in hmode when blank happens and we get a lineskip

Examples

Example 1

\setupexternalfigures
   [order={pdf,png,jpg},
    location=global,
    directory={images}]

Notes

See also

Help from ConTeXt-Mailinglist/Forum

All issues with: