Fanuc Documentation Generator Pro




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.


  fanuc.doc.pro.template.pdf


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

Be aware to generate actual robot's reference list before you start.




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.

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.
These tags are used to write ordinary text with specified font, color and alignment or insert some extra information about the robot.

Every XML project file has to start with the main tag FanucDocumentationProProject.
<FanucDocumentationProProject version="">

</FanucDocumentationProProject>
Between these tags the user can define entire documentation's content.

PropertyValuesDescription
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.
<FanucDocumentationProProject version="1.0">

<section title="" style="" align="" include="">

</section>

</FanucDocumentationProProject>

PropertyValuesDescription
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, reference.



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.
<FanucDocumentationProProject version="1.0">

<makeindex title="" style="" style2="" align="" include="" />

</FanucDocumentationProProject>

PropertyValuesDescription
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.

<app text="" makro="" />

PropertyValuesDescription
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.

<FanucDocumentationProProject version="1.0">

<stations include="">

    <name short="" long="" />

</stations>

</FanucDocumentationProProject>

PropertyValuesDescription
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.

<filelist filter="" counter="" style="" style2="" align="" />

PropertyValuesDescription
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.
counter [ 1 | 0 ] Displays subsection number for each file if 1. If 0 or not specified subsection number will not be displayed.
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.




The reference tag is used to include a reference list for the given variable.
This reference list is generated using robot's reference list. Please make sure that you created robot's reference list before you start.

The output of this command is a table with 3 columns.
The first column contains variable name, the second one long text for variable and the third one lists files where this variable is used.
<reference variable="" style="" align="" cellpadding="" border="" />

PropertyValuesDescription
variable Regular expression with variable name(s) The variable name is one of the valid variables listed in reference file eg.: (E|A) - displays all inputs and outputs, Makro, M, bin, F, I, etc...
style Style sheet Allows styling information to be included with the rich text for the displayed 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.
cellpadding Any positive number value Sets the amount of space (both horizontal and vertical) between the cell wall and the contents.
border Any positive number value Establishes the size of the border surrounding the table.




The img tag inserts the given image from the resource.
<img src="" style="" height="" width="" align="" />

PropertyValuesDescription
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.
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:
loaddata_kahka1516480r01rs--kux_T7.xlsx
loaddata_kahka1516480r01rs--kux_T8.xlsx
loaddata_kahka1516480r01rs--kux_T9.xlsx
loaddata_kahka1516480r01rs--kux_T10.xlsx
...
and use following file filter:
loaddata_*__ROBOTNAME__*.xlsx;

The __ROBOTNAME__ tag will be replaced with the present robot name.
<recursiveimg path="" filter="" align="" breakpage="" />

PropertyValuesDescription
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 MS Office Excel Sheet. In this case use *.xlsx filter.
In the filter you can use __ROBOTNAME__ tag which will be replaced with the present robot name.
align [ left | right | center | justify ]/td> Horizontal image allignment.
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.
<text style="" align="">

</text>

PropertyValuesDescription
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.
<robot attr="" title="" style="" style2="" align="" regexp="" from="" to="" />

PropertyValuesDescription
attr [ name | plc | safety | id |
  swserial | swversion |
  vagupdate | controlid |
  station | tool | base ]
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).
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 ] Please refer to the resources for more details.




The breakline tag inserts the break line character at the end of current line.
<breakline />



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



Examples

All listed examples have been generated automatically with our plugin.

K1U1A2211950R01.pdf

  K1U1A2211950R01.pdf




Resources