Working with Model documents and Include documents

Creating and running, i.e., testing of ITP Models can be done from within the ITP/MDK Microsoft Word menu. For Microsoft Word 2007 and up you can find this menu in the ribbon Add-Ins. This menu will also be shown if an Include document is opened. In that case, functions that are not applicable on Include document will give an error message when used.

Working with model documents

Create model

Create model will try to make an ITP Model out of the active model document. All documents open in the ITP/Model Development Kit are saved before the ITP Model is created.

Note

To create ITP Models based on Microsoft Word documents (*.docx), ITP/Create Model Package version 3.5.4 (or higher) has to be installed.

Test

The option Test will run the ITP Model that is associated with the active document. The Result Document is opened in the ITP/Model Development Kit.

Working with includes

Browse Includes

With the Browse Includes menu item a list is composed with all the documents that are included in the active document. It is possible to open one of these include documents from the list to edit it or to view it.

Edit Include

When the cursors is positioned somewhere on a __INC() tag, the document indicated by the tag is opened for editing when you select Edit Include. This means that the corresponding document in the ITP/Model Development Kit will be locked. When the cursor is not positioned on a __INC() tag the ITP/Model Development Kit gives a message.

The ITP/Model Development Kit searches the include folders in the Configuration of the project or folder in the order given. ITP also uses this search order when creating your Model.

View Include

When the cursor is positioned somewhere on a __INC() tag, the document indicated by the tag is opened read-only when you select View Include. When the cursor is not positioned on a __INC() tag the ITP/Model Development Kit gives a message.

The ITP/Model Development Kit searches the include folders in the Configuration of the project or folder in the order given. ITP also uses this search order when creating your Model.

Tools

Compare and merge documents

Enters documents compare mode. Please refer to the Microsoft Word documentation for more information on working with Compare.

Browse DID

Browse DID checks if a DID Browser is already started. If so, this browser is activated. If not, the browser is started showing you the current DID as set in the projects/folders configuration.

ITP Toolbox

The ITP Toolbox contains features to insert fields and functions into the Microsoft Word document. It can be activated from your Microsoft Word document by clicking the icon ITP Toolbox ico in the toolbar. When activated the ITP Toolbox will initially remain on top of your Microsoft Word document, this is signaled by the icon pushpinpushed right on top of the ITP Toolbox window. To unpin the ITP Toolbox, click the pin and it will move to the back when the user returns to the Microsoft Word document. Per document only one ITP Toolbox can be activated.

At this moment the ITP Toolbox consists of two features, which are presented in tabs:

  1. In the first tab a list with the currently available Field Sets for the specific document is presented.
  2. In the second tab a list with frequently used functions is presented.

sub 1. As in a tree view a Field Set can be expanded to show the fields. To insert a field into the Microsoft Word document, first it has to be selected. Then the user can choose to double click it, to select Insert @() from the context menu by right-clicking it, to drag the field from the ITP Toolbox to the Microsoft Word document, or to click icon ITP Toolbox insert@(). In these cases the inserted field will be surrounded with @([field]). It is also possible to insert a field without the symbols @(). After selecting the field, the user can choose 'Insert' from the context menu, or click the icon ITP Toolbox insert.

sub 2. A function can also be expanded to show the parameters. The function can be selected to insert into the Microsoft Word document. When the function is selected, it can be inserted by double clicking it, clicking Insert @() in the context menu, by dragging the function from the ITP Toolbox to the Microsoft Word document, or by clicking the icon ITP Toolbox insert@(). The inserted section in the Microsoft Word document consists of @([function name] ([parameter description])). It is also possible to insert a function without the symbols @(). After selecting the function, the user can choose Insert from the context menu, or click the icon ITP Toolbox insert. The parameters that are inserted with the selected function are only placeholders. The user should replace these parameter placeholders with the actual values.

Note

If the Microsoft Word document represents a Rich Text Block, the second tab will not be available. Also, the functionality offered by the ITP Toolbox differs slightly from the above. See Editing Rich Text Blocks for more information on this subject.

Help menus

ITP Help

ITP Help opens the Help instructions for the ITP version that is configured as Create Model Package in the project.

MDK Help

ITP/Model Development Kit help opens the ITP/Model Development Kit Help.

Model developers manual

The model developers manual opens the Help instructions for the ITP version that is configured as Create Model Package in the project as a PDF file.

The ITP/Model Development Kit toolbar

The ITP/Model Development Kit toolbar offers the same functions as described above under menu ITP/MDK.