Create a MS Word Export Template

Microsoft Word export templates are DOC or DOCX files used to generate, structure and format exported wizard documents.

In the export process, wizard properties and content elements are inserted into the export file by using predefined fields in the template.

You can use the templates provided with your installation, or you can create your own custom templates for wizard export in Microsoft Word.

Microsoft Word Template Fields, Structure and Formatting

In Word, wizard elements are inserted into predefined MergeField fields in the template. All MergeField fields are described in the table below.

Field Name

Description

TableStart:Wizards

An opening tag that causes wizard properties to appear in the exported file.

This field, along with the TableEnd:Wizards closing field, must wrap any other wizard, step and action fields.

WizardName

The wizard title

WizardDescription

A description of what the wizard does

WizardPath

A full path to the library, category and subcategories that contain the Wizard in Studio. see Categories

WizardHyperlink

A unique, direct link to the Wizard that can be pasted or embedded in an email message, Web browser address bar, or the Windows Run box

WizardNotes

Any notes or comments typed in the wizard’s Notes tab in Studio

Image:WizardApplicatio nImage

An icon of the application on which the Wizard is played

TableStart:Steps

An opening tag that causes all wizard steps to appear in the exported file in their original sequence.

This field along with the TableEnd:Steps closing field, must wrap any step and action fields.

StepName

The step title assigned by the content author. See Editing Wizard Steps

StepNumber

The step number assigned automatically in the Wizard Editor

Image:StepImage

An image of the area that surround the step’s click position

Image:StepFullImage

The full step image, as it appears in the Wizard Editor Display pane.

TableStart:StepActions

An opening tag that causes all the actions of a wizard step to appear in the exported file in their original sequence.

This field, along with the TableEnd:StepActions closing field, must wrap any other action fields.

Action

A description of the mouse click, any key strokes and bubble text (including buttons) in the order in which they appear in a step

StepNotes

Any notes or comments typed in the step’s Notes tab

Image:ActionImage

An image of the object that detects and clicks in the step

Image:ActionTypeImag e

An icon indicating the type of action that performs, such as a bubble or mouse click

TableEnd:StepActions

A closing tag that causes all the actions of a wizard step to appear in the exported file in their original sequence.

This field, along with the TableStart:StepActions opening field, must wrap any other action fields.

TableEnd:Steps

A closing tag that causes all wizard steps to appear in the exported file in their original sequence.

This field, along with the TableStart:Steps opening field, must wrap any step and action fields.

TableEnd:Wizards

A closing tag that causes wizard properties to appear in the exported file.

This field, along with the TableStart:Wizards opening field, must wrap any other wizard, step and action fields.

In order to successfully export the wizard to a document, these MergeField fields must be structured according to the hierarchy. the MergeField hierarchy you must use in your Word export template is as follows:

The formatting used for each field in the template is reflected in the export file.

Creating a Microsoft Word Export Template

  1. In a blank Microsoft Word document, click Insert > Quick Parts > Field….

  2. In the Field dialog, from the Field names list, select MergeField.

  3. In the Field name field, type: TableStart:Wizards.

  4. Repeat steps 1-2, and in the Field name field, type the field name for the wizard item that you want to insert, according to the MergeField field names. (Repeat this step for all wizard items that you want to insert)

  5. To insert step items, do the following:

    1. Repeat steps 1-2, and in the Field name field, type: TableStart:Steps

    2. Repeat steps 1-2, and in the Field name field, type the field name for the step item that you want to insert, according to the MergeField field name. (Repeat this step for all wizard items that you want to insert)

    3. To insert core action items, do the following:

      Repeat steps 1-2, and in the Field name field, type: TableStart:StepActions

      Repeat steps 1-2, and in the Field name field, type the field name for the core action item that you want to insert, according to the MergeField field name. (Repeat this step for all wizard items that you want to insert)

      When you are done inserting core action fields, repeat steps 1-2, and in the Field name field, type: TableEnd:StepActions

      When you are done inserting step fields, repeat steps 1-2, and in the Field name field, type: TableEnd:Steps

  6. When you are done inserting wizard fields, repeat steps 1-2, and in the Field name field, type: TableEnd:Wizards

  7. Save the template to any location in DOC or DOCX file format.

  8. Customize the Word document's header and footer, page numbers, logo, and any other customizations of your choice.