The Glossary Dialog

To open the Glossary dialog, select the Project | Documentation | Glossary menu option. Use this dialog to add, modify and delete glossary entries.

You can also limit the display to list entries of a specific type for editing or deletion.

GlossaryDialog

Option

Use to

Glossary Term

Type the term to include in the glossary.

Glossary Type

Select either Technical or Business.

If you require a different glossary type, click on the [ ... ] (browse) button and specify the name of the new type.

This field applies the type only to the selected term. You can rename a type for all terms of that type, using the Project Glossary tab of the System window.

Description

Type the definition or description of the term.

You can format the text of this description using the Notes toolbar at the top of the field.

Limit Display To

Select the appropriate type to filter the Type | Term list to show entries of a specific type for editing or deletion.

Type | Term

Review the list of defined glossary terms.

Report

Print a glossary report.

Add a Glossary Entry

To add an entry to the glossary, follow the steps below:

  1. Enter the details for the glossary item: the Glossary Term, the Glossary Type and the Description.

Note:

A glossary term must have a defined type and description. You cannot save a new term without both of these values.

  1. Click on the Save button.
  2. To enter another item, click on the New button.

Modify a Glossary Entry

To modify a glossary entry, follow the steps below:

  1. Select the entry to modify from the bottom panel of the dialog. The details of the entry display in the fields in the top half of the window.

Note:

A glossary term must have a defined type and description. You cannot save an edited term without both of these values.

  1. Change the details as required.
  2. Click on the Save button.

Delete a Glossary Entry

To delete a glossary entry, follow the steps below:

  1. Select the entry to delete from the bottom panel of the dialog. The details of the entry display in the fields in the top half of the window.
  2. Click on the Delete button.

Limit the Display

You can select which entry categories are displayed in the list. To:

  • View all glossary entries, select the All value in the Limit Display To field.
  • View entries of a specific type only, select the appropriate value in the Limit Display To field.