Difference between revisions of "Command/setupexternalfigure"

From Wiki
Jump to navigation Jump to search
(Created page with "Documentation for \setupexternalfigure")
 
 
Line 25: Line 25:
 
     </cd:parameter>
 
     </cd:parameter>
 
     <cd:parameter name="page">
 
     <cd:parameter name="page">
       <cd:paramdoc></cd:paramdoc>
+
       <cd:paramdoc>Page number of PDF.</cd:paramdoc>
 
       <cd:constant type="cd:number"></cd:constant>
 
       <cd:constant type="cd:number"></cd:constant>
 
     </cd:parameter>
 
     </cd:parameter>
 
     <cd:parameter name="object">
 
     <cd:parameter name="object">
       <cd:paramdoc></cd:paramdoc>
+
       <cd:paramdoc>Reuse this image file as an object, i.e. embed it only once in PDF if it’s used several times? </cd:paramdoc>
 
       <cd:constant default="yes" type="yes"></cd:constant>
 
       <cd:constant default="yes" type="yes"></cd:constant>
 
       <cd:constant type="no"></cd:constant>
 
       <cd:constant type="no"></cd:constant>
Line 56: Line 56:
 
     </cd:parameter>
 
     </cd:parameter>
 
     <cd:parameter name="controls">
 
     <cd:parameter name="controls">
       <cd:paramdoc></cd:paramdoc>
+
       <cd:paramdoc>Show media controls (for movies?)</cd:paramdoc>
 
       <cd:constant type="yes"></cd:constant>
 
       <cd:constant type="yes"></cd:constant>
 
       <cd:constant default="yes" type="no"></cd:constant>
 
       <cd:constant default="yes" type="no"></cd:constant>
Line 74: Line 74:
 
     </cd:parameter>
 
     </cd:parameter>
 
     <cd:parameter name="color">
 
     <cd:parameter name="color">
       <cd:paramdoc></cd:paramdoc>
+
       <cd:paramdoc>Colorize the image. Works only with some greyscale pictures (no channels, no additional tables, ...?) and only with toned (<tt>p=</tt>) or [[Spot_Colors|spot colors]]. Use with <cd:iref name="object" type="no"/></cd:paramdoc>
 
       <cd:constant type="cd:color"></cd:constant>
 
       <cd:constant type="cd:color"></cd:constant>
 
     </cd:parameter>
 
     </cd:parameter>
Line 93: Line 93:
 
     </cd:parameter>
 
     </cd:parameter>
 
     <cd:parameter name="factor">
 
     <cd:parameter name="factor">
       <cd:paramdoc></cd:paramdoc>
+
       <cd:paramdoc>If both <tt>width</tt> and <tt>height</tt> are set, the <tt>factor</tt> is important.
       <cd:constant type="fit"></cd:constant>
+
 
 +
If <cd:iref name="factor"/> is empty, the image is deformed accordingly.</cd:paramdoc>
 +
       <cd:constant type="fit">aspect ratio is kept, the image is scaled to the smaller (fitted) variant</cd:constant>
 
       <cd:constant type="broad"></cd:constant>
 
       <cd:constant type="broad"></cd:constant>
       <cd:constant type="max"></cd:constant>
+
       <cd:constant type="max">aspect ratio is kept, the image is scaled to the bigger (oversized) variant</cd:constant>
 
       <cd:constant type="auto"></cd:constant>
 
       <cd:constant type="auto"></cd:constant>
 
       <cd:constant type="default"></cd:constant>
 
       <cd:constant type="default"></cd:constant>
Line 133: Line 135:
 
     </cd:parameter>
 
     </cd:parameter>
 
     <cd:parameter name="scale">
 
     <cd:parameter name="scale">
       <cd:paramdoc></cd:paramdoc>
+
       <cd:paramdoc>1000 is original size (100%); to get 72%, use scale=720.</cd:paramdoc>
 
       <cd:constant type="cd:number"></cd:constant>
 
       <cd:constant type="cd:number"></cd:constant>
 
     </cd:parameter>
 
     </cd:parameter>
Line 233: Line 235:
 
     </cd:parameter>
 
     </cd:parameter>
 
     <cd:parameter name="size">
 
     <cd:parameter name="size">
       <cd:paramdoc></cd:paramdoc>
+
       <cd:paramdoc>Use specified box of PDF (MediaBox, CropBox, TrimBox, ArtBox). (No BleedBox?)</cd:paramdoc>
 
       <cd:constant type="none"></cd:constant>
 
       <cd:constant type="none"></cd:constant>
 
       <cd:constant type="media"></cd:constant>
 
       <cd:constant type="media"></cd:constant>
Line 249: Line 251:
 
     </cd:parameter>
 
     </cd:parameter>
 
     <cd:parameter name="display">
 
     <cd:parameter name="display">
       <cd:paramdoc></cd:paramdoc>
+
       <cd:paramdoc>alternative figure, e.g. lowres</cd:paramdoc>
 
       <cd:constant type="cd:file"></cd:constant>
 
       <cd:constant type="cd:file"></cd:constant>
 
     </cd:parameter>
 
     </cd:parameter>
Line 269: Line 271:
 
     </cd:parameter>
 
     </cd:parameter>
 
     <cd:parameter name="transform">
 
     <cd:parameter name="transform">
       <cd:paramdoc></cd:paramdoc>
+
       <cd:paramdoc>Rotation in 90˚ steps (otherwise use {{cmd|rotate}})</cd:paramdoc>
 
       <cd:constant default="yes" type="auto"></cd:constant>
 
       <cd:constant default="yes" type="auto"></cd:constant>
 
       <cd:constant type="cd:number"></cd:constant>
 
       <cd:constant type="cd:number"></cd:constant>
Line 285: Line 287:
 
   </cd:command>
 
   </cd:command>
 
</cd:variants>
 
</cd:variants>
<cd:description><!-- the long description of the command goes here -->
+
<cd:description></cd:description>
</cd:description>
 
 
<cd:examples><cd:example title=""><texcode>
 
<cd:examples><cd:example title=""><texcode>
 
\setupexternalfigures
 
\setupexternalfigures

Latest revision as of 13:32, 23 September 2020


\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
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?
controls
Show media controls (for movies?)
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
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
scale
1000 is original size (100%); to get 72%, use scale=720.
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
size
Use specified box of PDF (MediaBox, CropBox, TrimBox, ArtBox). (No BleedBox?)
display
alternative figure, e.g. lowres
order
Sets the order in which the individual file types are looked up.
transform
Rotation in 90˚ steps (otherwise use \rotate)

Description

Examples

Example 1

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

Notes

See also

Help from ConTeXt-Mailinglist/Forum

All issues with: