Specify Image Format
Although to a reader, an image is just an image, different image formats must be processed differently by the converter in order to be referenced by or embedded in the output format.
Some image formats, such as SVG, even activate additional behavior.
On this page, you learn how an AsciiDoc processor determines the format of an image and how it can be specified explicitly using the
format attribute if the format cannot be determined.
Automatic image format
Most of the time, the image format can be determined from the file extension (e.g.,
.svg) of the target.
Here’s an example that shows an image target that has a file extension:
In this case, the converter can determine that this is an SVG image based on the file extension
So the author does not need to specify the image format.
The author only needs to specify the format when the image format cannot be determined.
When the file extension is not present, or—in the case of a URL—not in its usual place, the author must specify the image format explicitly.
format attribute on a block or inline image macro can be used to specify the format of an image.
In this case, the converter would not be able to determine that this is an SVG image because the target has no file extension.
But since the author has specified
format=svg, the converter can recognize this as an SVG image.
Here are few cases when the image format cannot be determined automatically:
the target does not have a file extension
the target is using an unrecognized file extension
the target is a URL that contains a query string (thus hiding the file extension)
The value of the format attribute is the sub-MIME type (the part after the forward slash) (e.g.,
png for a PNG image).
One exception to this rule is the format for SVG, which is specified as
svg instead of
You can find a list of common image formats along with their MIME type values on the image file type and format guide page.
When is the format used?
There are several scenarios when a converter almost always needs to know the image format. One is to distinguish an SVG target. Another is to convert the image to a data URI. Yet another is when a converter must reencode the image.
AsciiDoc recognizes extra settings for SVG images, such as how to include it in the HTML output and whether to provide a fallback image. If the converter needs to read and process the file, it often must use a different library to process an SVG since the contents of an SVG is an XML document. So being able to recognize an SVG target is essential for almost any converter.
data-uri attribute is set on the document, an AsciiDoc processor must convert the image to a data URI.
To start, the data URI for an SVG differs from a data URI for any other format.
But even when creating a data URI for a non-SVG, the MIME type of that image must be included in the data URI, in which case the image format must be known.
Some converters, such as a PDF converter, have to reencode the image data. This means the converter must parse the image data, which may require loading an additional library. Doing that processing almost certainly requires knowing the format of the image. It also provides an opportunity for the converter to inform the author whether the image uses a format that cannot be processed.
As you can see, while the image format not always needed, it’s needed often enough that you should specify the format if it’s not apparent from the file extension of the target.