 Printing a complete document

The ISaGRAF Document Generator allows the user to build and print a complete document for the selected project. It can be called by the "Project / Print" commands of the Project Management or the Program windows to print a complete document. The Document Generator is also run by the "Print" command of all other ISaGRAF editors to print the contents of a single ISaGRAF document. However, the Document Generator provides the same features in both cases.

Customizing the table of contents

Options

The commands of the "Edit" menu are used to define the elements of the project that must be inserted in the document. Doing this the user builds the "table of contents" for the desired document. Any information about the project (programs, variables, options, I/O connection...) may be inserted in the project document. No information from another project or from ISaGRAF libraries may appear in this document.

 The "File / Print" command generates the document and send it to the printer, according to the specified table of contents. The "Print" job may take few minutes to build and format the document. It is highly recommended to wait until "Printing Job" is done in the ISaGRAF Document Generator window, before running other commands of the ISaGRAF Workbench. Building the whole document may require a large space on the hard disk. An error message will be displayed if the disk is full. In such a case, the user will have to either free up disk space by removing files, or reduce the size of the print job. When the "Print" command is run, a dialog box appears. It allows the user to enter a note describing the actual print command. Those notes are stored in a history file, and will be printed on the first page of any future document (including the present one).


Customizing the table of contents

The "Edit" menu contains the commands to define the "Table of Contents" of the document. A choice of commands allow the user to use a default table (with all the components of the project),  build a specific table (with only some components) or move items in the table and modify it.

The default list

 	Cut and paste

Clearing the table

Inserting items in the table


The default list

The "Default list" command of the "Edit" menu defines a standard table of contents for the document, which includes all the components of the project. The standard table consists of:

- Project descriptor

- Hierarchy tree (links between programs)

- Source code for any program

- Diary file for any program

- Common definitions

- Global definitions

- Local definitions for any program

- Global variables

- Local variables for any program

- Application options

- I/O Connection

- Lists of variables

- Conversion tables

- Condensed cross references

- Detailed cross references

- Declaration summary

- Network addresses map

- History of modifications

The table of contents can be saved on disk using the "File / Save" command. This command is grayed when document generator is run from an ISaGRAF editor to print a single document.


 	Cut and paste

Use "Edit / Cut" and "Edit / Paste" commands to move items in the list, in order to customize the order of the table. The Document Generator allows multiple selection so that a group of items may be cut and pasted.


Clearing the table

Use "Edit / Clear" command reset the table of contents, so that it can be totally rebuilt using single item insertion.


Inserting items in the table

When the "Edit / Insert" command is run, the "Add item" dialog box appears. It allows the user to insert items (components of the project) into the table of contents.

For an item relative to a program, use the "Program" combo box to select a program name. Press the "Add" button to insert the selected item to the table of contents. The same item can appear only once in the table.


Options

The commands of the "Options" menu are used to define and customize the format of the generated document.

SFC charts

Page format

Page title template

 	Selecting character fonts

Other options are directly available from buttons of the Document Generator window:

When the "Font page" option is set, a header page is printed at the beginning of the document, containing the project title and the history of printouts. When this option is nopt set, the first item to be printed starts on the first page.

When the "Table of contents" option is set, a table of contents is printed at the end of the generated document.

Both options are initially unchecked when the Document Generator is run from a "Print" command of an ISaGRAF editor (program, dictionary...)


SFC charts

The "Separate SFC levels" option directs the system to print, for each SFC program, first the level 1 of the SFC (chart and comments), and then the level 2 programming. When this option is not checked, levels 1 and 2 appear together on the same printout.


Page format

The "Page format" command of the "Options" menu is used to define the main parameters operated by the Document Generator when formatting a page. The following parameters can be specified:

•	Left margin: (1 or 2 centimeters, or no margin)

•	Page border: When this option is selected, a border is drawn around any printed page.


Page title template

The "Page Title" command of the "Options" menu is used to define the contents of the title box printed at the bottom of any page. The standard layout of this box is as follows:

The first line of the main title (with the name of the ISaGRAF project), the current date and the page number are automatically generated by the Document Manager, and cannot be changed.

The three lines of text on the left side of the box (text1, text2, text3) and the second line of the main title are user defined. The user also can change the logo printed in the box on the left. To use another logo, the user has to specify the pathname of a bitmap image file (.BMP). The image can have any dimension. It will be stretched or shrunk, according to the exact dimensions of the printed page. Clicking on the logo area, in the dialog box, shows the new specified image. The image file must be on the disk (at the specified directory and with the specified filename) when the "Print" command is run.


 	Selecting character fonts

The "Text font" and "Title font" commands of the "Options" menu are used to define the fonts of characters used when printing text, and titles for any item of the document. The size and style of characters may also be selected for text and titles. The selection of a font is made with the standard dialog box defined by Windows. Any text (literal programs, names within diagrams...) will be printed with the selected size, style and font of characters. Only titles will be printed with the font selected for titles.

If the fonts of characters are not defined, the standard font of the printer will be used for any text, with the following styles:

•	"Normal" style for texts and names within diagrams

•	"Bold" style for titles