Image

With the help of the markup Image, which has to be inserted into a Description, Summary or Example, you can include images in your documentation.

To include images, create a folder called "Images" in the folder of the PLC project. The folder "Images" may have subfolders to structure the images. All references to the images are then made within this folder, i.e. "Subfolder/ImageName".

Place the images in the PLC project folder as follows:

1. Create a new folder below your PLC project.
Image 1:
2. Name the folder "Images".
Image 2:
3. Drag and drop all the images you want to use into the folder.
You can now use the stored images in your documentation.

Include the images in the documentation as follows:

1. Include the markup Image in either the Description, Summary, or Example markup.
2. Inside the markup, specify the name of the image.
The image is output to the documentation.
Image 3:

For the image to be found, the image name must match.

  • Be sure to write the name of the image correctly in the markup.

Example

(*!<description>This is a description with picture.
<image uri="Sample Picture.png">Replacement text</image></description>*)

Alternatively, you can include the images in the documentation using the absolute storage path.

Image 4:

(*!<description> This is a description with picture.
<image uri="C:/TE1030 PLC/IMAGES/test.jpg">Replacement text</image> </description>*)

Image 5:

If the image cannot be displayed, a replacement text that you create is generated in the documentation instead.

Scale image size

The included images can be scaled using the "width" and "height" markups.

Normal form:

(*!<description>This is a description with picture.

<image uri="test.jpg">image title

width="10"

height="20"

</image></description>*)