Open main menu
Wiki

Changes

Command/externalfigure (view source)

Revision as of 14:41, 15 October 2019

4,392 bytes added ,  14:41, 15 October 2019
no edit summary
<noinclude>
 
{{Reference
|name=externalfigure
}}
== [[Help:Reference|Syntax]] (autogenerated) ==
<syntax>externalfigure</syntax>
== [[Help:Reference|Syntax]] ==
<table cellspacing="4" cellpadding="2" class="cmd">
</table>
</noinclude>
== Description ==
Command The <code>\externalfigure</code> command is used to include an external figure/movie inside ConTeXt. Includes both local files or remote files hosted on HTTP servers.  The simplest way to insert an image is to use: <context source="yes" mode="mkiv">\externalfigure[cow.pdf]</context> This command places the PDF image <code>cow.pdf</code> in a<code>\vbox</code>; the width and height of the image are equal to the natural dimensions of the image. To set the width of the image to a specific size, say <code>1cm</code>, use:<context source="yes" mode="mkiv" text="which gives">\externalfigure[cow.pdf][width=1cm]</context> Similarly, to set the height of the image to a specific size, say <code>2cm</code>, use:<context source="yes" mode="mkiv" text="which gives">\externalfigure[cow.pdf][height=2cm]</context> If only the <code>width</code> or <code>height</code> of the image is specified, the other dimension is scaled appropriately to keep the aspect ratio. To include a specific page, say page 5, of a multi-page PDF file, use:<texcode>\externalfigure[filename.pdf][page=5]</texcode> These four variations cover 90% of the use cases. 
=== How the filetype is determined ===
* '''auto''': When the file extension is <code>.auto</code> or <code>method=auto</code> is used, ConTeXt reads the first few bytes of the file to determine the filetype. Such an auto-discovery is useful for remote images that do not have a file extension.
If the extension of the file is not specified, ConTeXt searches for all possible extensions in the order given below for natively supported image formats. (When  Historically, when postscript output was used, the order in which the file extensions were searched depended on the output format (PDF or PS). These daysWith recent releases of ConTeXt, PDF is the default output format, so for all practical purposes, the order in which the file extensions are searched is fixed).
=== Natively supported image formats ===
=== Supported movie formats ===
 
{{note| Inclusion of movie formats is broken in MkIV }}
The following movie formats are supported.
* '''[http://en.wikipedia.org/wiki/QuickTime QuickTime]''': File extension <code>.mov</code>.
* '''[https://en.wikipedia.org/wiki/Flash_Video Flash Video]''': File extension <code>.flv</code>
* '''[https://en.wikipedia.org/wiki/MPEG-4 MPEG 4]''': File extension <code>.mp4</code>
 
{{ note| Movie inclusion only works in Adobe Acrobat but does not work on Linux }}
=== Support for special TeX formats ===
* '''cld''': Typeset the [[CLD|ConTeXt Lua document]] using <code>context</code> and include the result as a PDF file.
== Tracing and error Messages Command options == === <code>interaction</code> ===
When a file is specified by its full nameBy default, and is not found, no error message is displayed in the log; rather a gray box is shown in interactive elements of the generated included PDF which indicates that file are discarded. To enable the figure was not found. For example (note that <code>cat.pdf</code> should '''not''' exist in interactive elements of the current directory)included PDF file, use
<context source=yestexcode>\externalfigure[catfilename.pdf][interaction=yes]</contexttexcode>
== Example ==
</context>
=== Rotate an image ===
 
* '''Rotate by 90, 180, or 270 degrees''': Use <code>orientation=90|180|270</code> to rotate an image in multiples of 90. For example:
 
<context source="yes" mode=mkiv>
\externalfigure[mill][orientation=180]
</context>
 
 
* '''Rotate by an arbitrary angle''': Use {{cmd|rotate}} command.
 
<context source="yes" mode=mkiv>
\rotate[rotation=45]{\externalfigure[mill]}
</context>
 
=== Flip an image ===
 
Use {{cmd|mirror}} to horizontally flip an image
 
<context source=yes mode=mkiv>
\mirror{\externalfigure[cow][width=3cm]}
</context>
 
== Error Messages ==
 
When a file is specified by its full name, and is not found, no error message is displayed in the log; rather a gray box is shown in the generated PDF which indicates that the figure was not found. For example (note that <code>cat.pdf</code> should '''not''' exist in the current directory)
 
<context source=yes>
\externalfigure[cat.pdf]
</context>
 
== Tracking ==
 
The following trackers are available for {{cmd|externalfigures}} (MkIV only)
 
* '''graphics.locating''': Gives details about where the image files are searched, what strategy was used to infer the file format, and what was the inferred file format.
 
* '''graphics.conversion''': Gives details about the conversion from one file format to another
 
* '''graphics.inclusions''': Gives details of including a movie
 
The trackers are enabled using
 
\enabletrackers[...tracker...]
 
or
 
context --trackers=list [filename]
 
When '''graphics.locating''' tracker is enabled, including a known file gives the following information on the terminal
 
graphics > inclusion > locations: local,global
graphics > inclusion > path list: . .. ../..
graphics > inclusion > strategy: unknown format, prefer quality
graphics > inclusion > found: ./cow.pdf -> /opt/context-minimals/texmf-context/tex/context/sample/cow.pdf
graphics > inclusion > format natively supported by backend: pdf
 
If the asked file does not exist, the following information is displayed.
 
 
graphics > inclusion > locations: local,global
graphics > inclusion > path list: . .. ../..
graphics > inclusion > strategy: forced format pdf
graphics > inclusion > not found: cat.pdf
graphics > inclusion > not found: ./cat.pdf
graphics > inclusion > not found: ../cat.pdf
graphics > inclusion > not found: ../../cat.pdf
graphics > inclusion > format not supported: %s
 
When '''graphics.conversion''' tracker is enabled, and, including a file type that requires conversion, say PS, displays the following message on the terminal
 
graphics > inclusion > checking conversion of './tiger.ps' (./tiger.ps): old format 'ps', new format 'pdf', conversion 'default', resolution 'default'
graphics > inclusion > no need to convert './tiger.ps' (tiger.ps) from 'ps' to 'pdf'
graphics > inclusion > new graphic, hash: m_k_i_v_tiger.ps.pdf->1->crop->unknown->unknown->unknown->
 
When '''graphics.inclusion''' tracker is enabled, including a movie displays the following message on the terminal
 
graphics > inclusion > including movie 'clip.mov': width 5594039.4330709, height 5594039.4330709
 
 
<noinclude>
== See also ==
* {{cmd|defineexternalfigure}} to define a collection of settings
* {{cmd|setupexternalfigures}} to define a different collection of settings
* {{cmd|useexternalfigure}} to define an image+settings combination
* [[Using Graphics]]
== Help from ConTeXt-Mailinglist/Forum ==
All issues with:
{{Forum|{{SUBPAGENAME}}}}
</noinclude>
[[Category:Command/FiguresImages|externalfigure]]
/code>. Converted to PDF on the fly using MPtoPDF.
* '''[http://en.wikipedia.org/wiki/JPEG JPEG]''': File extension
Retrieved from "https://wiki.contextgarden.net/Special:MobileDiff/21283...24880"