Inserting an image
To insert an image, use the image
tag and specify the
placement
attribute to set line wrapping.
<image href="images/sample.png" placement="break"><alt>Sample image</alt></image>
You can also choose placement="inline"
if you're inserting an image in the
line of your sentence (such as a button image) or if you want text to flow around your image.
The Open Toolkit renders images with a placement="break"
attribute with two br
tags before and after the image.
Sponsored content
You can also choose an align
attribute and select left
,
right
, or center
. The alt
tags in the
middle define the alt text for the image, which is what displays if a user's images are turned
off.
Note that images won't automatically resize or automatically take on a border. However, you can set those properties in your webhelp CSS to accomplish this.
When you're writing a task, you can put images inside the cmd
or the
info
tag.
<fig><title>Sample Image</title>
<image href="images/sample.png" placement="break"><alt>Sample image</alt></image>
</fig>
The caption will actually appear below the image in the Oxygen webhelp output.
Reusing images
conref
element, you must include the
href
attribute because this attribute is required. But the value for href
is
-dita-use-conref-target
.
<img conref="#concept_engines/img_ej25_engine" href="-dita-use-conref-target" />
Referring to specific figures
<p>See <xref href="#concept_lcw_fkl_q4/image1" type="fig">Oxygen Sample Webhelp</xref> for details.</p>
<fig id="image1">
<title>Oxygen Sample Webhelp</title>
<image href="oxygen.png" placement="break"/>
</fig>
The output will say "See Oxygen Sample Webhelp for details." With the webhelp, the reference will link to the image. The image itself won't have a figure number below it. With PDF, there will be a figure number below it.
conref
to manually pull in the image title, you can do
so like
this:
<p>See <xref href="#concept_lcw_fkl_q4/image1" type="fig"><ph conref="testfile.dita#concept_lcw_fkl_q4/image1_title"/></xref> for details.</p>
<fig id="image1" frame="all">
<title><ph id="image1_title">Oxygen Sample Webhelp</ph></title>
<image href="oxygen.png" placement="break" scalefit="yes"/>
</fig>
Image format
It's recommended that you use the SVG format for images because this format allows you to add callouts that you can later edit and extract for translation.
Other parameters
frame="all"
attribute. If you want your image to be scaled to its container size, use
scalefit
. You can also specify a width
.
<fig id="image1" frame="all">
<title>Oxygen Sample Webhelp</title>
<image href="oxygen.png" placement="break" scalefit="yes" width="700"/>
</fig>
However, I think it would be wiser to use max-width
on images in your
webhelp stylesheet.