• Overview
• Plugin widget
• Simple project file
  • ABBDocumentationProProject
    • section
    • makeindex
    • stations
      • app
      • filelist
      • img
      • recursiveimg
      • text
      • robot
      • breakline
      • breakpage
      • date
• Examples
• Resources

---

▲ Overview

The Documentation Generator Pro Plugin automatically generates documentation for the multiple robots' archive files in MS Word or PDF format.

To customize the view of generated documents the user can edit or create a new XML documentation project file.

The plugin uses customized MS Word document as template to generate final documentation.
The user can prepare MS Word template with customized header and footer and even the title page.

In the figure below you can see the example of documentation template.
Into the first empty text field on the first page the robot name will be automatically written.
The second text field can contains the project name customized by the user.




Below you can find description of simple project file and predefined XML tags used to include external files' sources, display robot's system information and many others.
If you want to create your own documentation project file contact us and we will help you free of charge.

---

▲ Plugin widget

1	XML project file.
2	MS Word documentation template file.
3	Output directory to save generated files to.
4	Select robots' archive files
5	Type of inserted variables' reference list text. Inserting table view gives a good looking text but costs a lot of time. For now this option has no functionality.
6	Format of generated documentation files - PDF or MS Word.
7	Shows processing messages.
8	Displays plugin's documentation.
9	Press to generate documentation.
10	Press to stop generating documentation immediately.
11	Exit this plugin.

---

▲ Simple project file

To customize the look of generated documentation the user can create or edit simply XML project file with some predefined tags.
Those tags are used to write ordinary text with specified font, color and alignment or insert some extra information about the robot.

▲ The XML project file starts with the main tag ABBDocumentationProProject.
Between those tags the user can define entire documentation's content.

Property	Values	Description
version	Any valid version number text	Project file version number.

---

▲ The section tag is used to attach robot's information and listing of external files.

Property	Values	Description
title	Any valid text	Section title.
style	Style sheet	Allows styling information to be included with the rich text for the section title. A limited subset of CSS syntax can be used to change the appearance of the text. Please refer to the resources for more details.
align	[ left | right | center | justify ]	Horizontal section title text alignment.
include	[ 1 | 0 ]	Includes title page section to the document if 1. If 0 or not specified this section will not be displayed.

The section tag can contain the following subtags: img, text, robot, breakline, breakpage, filelist.

---

▲ The makeindex tag creates pages' index.
If you want to display correct page number for each included section in document please insert this tag at the end of the project file.
Only in this way the plugin can refer to pages' numbers correctly.

Property	Values	Description
title	Any valid text	Index page title.
style	Style sheet	Allows styling information to be included with the rich text for the pages' index title. A limited subset of CSS syntax can be used to change the appearance of the text. Please refer to the resources for more details.
style2	Style sheet	Allows styling information to be included with the rich text for the pages' list with sections' names. A limited subset of CSS syntax can be used to change the appearance of the text. Please refer to the resources for more details.
align	[ left | right | center | justify ]	Horizontal text allignment.
include	[ 1 | 0 ]	Includes pages' index to the document if 1. If 0 or not specified this section will not be displayed.

---

▲ The app tag defines robot's application description.

Property	Values	Description
text	Any valid text	Application's description text eg.: Handling, Kleben, Schweissen.
makro	Text semicolon list	Semicolon list with makros' numbers used by specified application. For example the Handling applications use makros: 340;342;343 or the Glue use makros: 180;181;190;191;200;201.

See robotapplication and robot tags for more details.

---

▲ The stations tag defines long stations' names.

Property	Values	Description
short	Any valid text
long	Any valid text

See robot tags for more details.

---

▲ The filelist tag is used to include source code of the robot's programs.

Property	Values	Description
filter	Valid regular expression	This regular expression defines a filter for the fileset to be searched for and included into documentation. For example, if you want to include in current fileset only Makro defined by the user use the following filter makro5[0-9].src. This filter will include Makro: 50, 51, 52, 53, 54, 55, 56, 57, 58 and 59 if it exists. The folge*.src filter will include all Folge files and up*.src only UP.
style	Style sheet	Allows styling information to be included with the rich text for the displayed file name. A limited subset of CSS syntax can be used to change the appearance of the text. Please refer to the resources for more details.
style2	Style sheet	Allows styling information to be included with the rich text for the attached files' source code. A limited subset of CSS syntax can be used to change the appearance of the text. Please refer to the resources for more details.
align	[ left | right | center | justify ]	Horizontal text allignment.
viewer	[ -1 | 0 | 1 ]	Displays file contents as plain text if 0. If 1 displays text as shown in the ABB viewer. Do not show file contents if -1.
task	text	The name of task directory to list available files, eg.: TASK1, TASK2, TASK*
comment	[ 0 | 1 ]	Displays file comment after file name if 1.

---

▲ The img tag inserts the given image from the resource.

Property	Values	Description
src	Image	Contains a URI that is supposed to point to the location of the image resource.
style	Style sheet	Allows styling information to be included with the rich text for the image. A limited subset of CSS syntax can be used to change the appearance of the text. Please refer to the resources for more details.
width	<length> px	Specifies the width of the image.
height	<length> px	Specifies the height of the image.
rotation	<angle>	Specifies the rotation angle in degrees. Positive value for clockwise rotation and negative for counterclockwise rotation.
align	[ left | right | center | justify ]	Horizontal image allignment.

---

▲ The recursiveimg tag inserts images recursively.
You can use it to insert payload protocols, safety configuration etc...

If you want to insert more than one payload protocol image you can set the files' names like follow:
and use following file filter:

The __ROBOTNAME__ tag will be replaced with the present robot name.

Property	Values	Description
path	Any valid system path	Path to the directory contains images.
filter	File filter semicolon list	The filter is used to find suitable image in the directory e.g.: *.png;*.bmp;*.gif;*.jpg;*.jpeg You can insert even Acrobat Reader file. In this case use *.pdf filter. In the filter you can use __ROBOTNAME__ tag which will be replaced with the present robot name.
align	[ left | right | center | justify ]	Horizontal image allignment.
scaleW	Any valid float number	Image width scale factor.
scaleH	Any valid float number	Image height scale factor.
rotation	<angle>	Specifies the rotation angle in degrees. Positive value for clockwise rotation and negative for counterclockwise rotation.
breakpage	[true | false]	break page after this image if true.

---

▲ The text tag inserts a plain text into document.
If you want to write < character please use &lt; or &gt; for > character.

Property	Values	Description
style	Style sheet	Allows styling information to be included with the rich text for the inserted text. A limited subset of CSS syntax can be used to change the appearance of the text. Please refer to the resources for more details.
align	[ left | right | center | justify ]	Horizontal text allignment.

---

▲ The robot tag attaches some extra information about robot system.

Property	Values	Description
attr	[ name | systemname | station |   ip | ip-backup | gateway |   subnetmask | type | serial |   plc | safety | application |   limits-positive | limits-negative |   tool | base | profinet |   collisions | releases | fm | calibration ]	Robot's property name to be displayed. Some of properties return only single text line (station property prints a station description if defined (See stations for more details).
task	text	The name of task directory to list available collisions, releases or fm attribute, eg.: TASK1, TASK2, TASK*
title	Any valid text	This is a property name displayed before text value.
style	Style sheet	Allows styling information to be included with the rich text for the property name text. A limited subset of CSS syntax can be used to change the appearance of the text. Please refer to the resources for more details.
style2	Style sheet	Allows styling information to be included with the rich text for the inserted property text. A limited subset of CSS syntax can be used to change the appearance of the text. Please refer to the resources for more details.
align	[ left | right | center | justify ]	Horizontal text allignment.
regexp	Any valid regular expression	Finds the matched regular expression in the given robot's attribute and returns the captured text. This can be used to extract a part of string like station name from the robot name string.
from	Any valid character index	Returns a substring of the given robot's attribute, starting at the specified position from and leading to the specified position to. This can be used to extract a part of string like station name from the robot name string.
to	Any valid character index	Returns a substring of the given robot's attribute, starting at the specified position from and leading to the specified position to. This can be used to extract a part of string like station name from the robot name string.
stationname	[ 1 | 0 ]	Add station name to the current attribute value. Please refer to the stations tag for more details.

---

▲ The breakline tag inserts the break line character at the end of current line.

---

▲ The breakpage tag breaks the current page and moves the text cursor to the first line of the next page.

---

▲ The date tag is used to insert the current date in given format.

Property	Values	Description
style	Style sheet	Allows styling information to be included with the rich text for the property name text. A limited subset of CSS syntax can be used to change the appearance of the text. Please refer to the resources for more details.
align	[ left | right | center | justify ]	Horizontal text allignment.
format	Date format	If empty is set to default value dd.MM.yyyy. Please refer to the Qt online documentation for more details.

---

▲ Examples

All listed examples have been generated automatically with our plugin.

K9VDKD110090R01.pdf

---

▲ Resources

• Qt limited subset of CSS syntax