Project Glossary View
The Model, or Project, Glossary consists of a list of defined terms for your project, as displayed in the Project Glossary View.
You can create Glossary items to define terms in two ways:
- Through the 'Glossary' dialog as text-based entries or
- As elements in a model structure, grouped under Glossary Category Packages
The Project Glossary View provides options to review the terms of different types already defined for a model. It identifies which Glossary items are defined as model elements, and therefore those that are not will be entries created in the 'Glossary' dialog. You can use the Project Glossary View to:
- Add glossary terms (via the 'Glossary Detail' dialog, not as a model element)
- Assign a Markup Style to a glossary term Type or Category, to print in a documentation report any terms of that Type/Category in that style
- Modify glossary terms
- the display to show terms of a specific Type or Category only
- Change a definition Type for all terms of that Type
- Print the displayed list of terms
- Delete glossary terms (those defined via the 'Glossary' dialog, not those created as model elements)
From the View you can also select, copy and paste (and ) some or all of your Glossary entries to an external text editor or spreadsheet tool. The text is copied in CSV format.
Use one of the methods described in the table, to display the Glossary view.
Design > Dictionary > Glossary > Glossary View
Glossary View Options
Within the Glossary view, right-click on an entry and select the appropriate option for the operation you intend to perform (as listed); if you select the:
- 'Add New' option, the 'Glossary Detail' dialog displays; complete the fields as indicated in the Glossary Detail Dialog Fields table
- 'Assign Markup Styles' option, the 'Glossary Markup' dialog displays on which you assign display styles to terms of each existing term Type or Category; the style is applied when you generate an RTF report containing the glossary terms (see the Glossary Styles Help topic)
- 'Modify Selected' option, either the element 'Properties' dialog (for model element terms) or 'Glossary Detail' dialog displays, in which you can edit the name and/or definition of the term
- 'Field Chooser' option, the 'Field Chooser' dialog displays, from which you can drag any column headings not currently displayed into position in the heading row; to return a header to the dialog, simply drag it out of the heading row (see the List Header Help topic)
- 'Enable Group Box' option, the Group Box is displayed above the header row, in which you reorganize the list to group the entries according to one or more properties (see the List Header Help topic)
- 'Toggle Bar' - a row of fields displays below the header row, in which you can type values to display only those items that contain that value in the property shown in that column (see the List Header Help topic)
- 'Rename Type' option (not available for model element glossary terms), the 'Rename Glossary Type' dialog displays on which you type in or select the alternative Type name (either another of the existing Types or a new Type); when you click on the , all entries of the original Type are changed to the new Type
- 'Set term filter' option, the 'Term Type Filter' dialog displays on which you enter the Type or Category of glossary term to list; when you click on the OK button, only items of that Type are shown on the Glossary view
- 'Remove term filter' option, the Glossary view refreshes to show glossary items of all Types
- 'Print List' option, the 'Print' dialog displays on which you define the printing parameters; when you click on the OK button, the currently-displayed list prints out
- 'Find in Project Browser' option (only for model element glossary terms) the system locates and highlights the element that defines the term in the Browser window
- 'Reload' option, the Glossary view refreshes to capture any new glossary elements that might have been created since the view was displayed
- 'Delete' option (not available for model element glossary entries), a prompt displays to confirm the deletion; click on the to remove the term from the Glossary
Glossary Detail Dialog Fields
(Mandatory) Type the term to include in the glossary.
(Mandatory) Select the required Type.
If you require a different glossary Type, click on the 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 context menu.
Further discussion of the 'Type' field is provided in The Glossary Dialog Help topic.
|The Glossary Dialog
Type the definition or description of the term.
If necessary, format the text of this description using the Notes toolbar at the top of the field.
Clear the dialog fields so that you can define a new Glossary term.
Save the new or updated glossary entry.
Delete the entry.
A prompt displays to confirm the deletion; click on the to remove the term from the glossary.
- In the Corporate, Unified and Ultimate Editions of Enterprise Architect, if security is enabled you must have 'Manage Glossary' permission in order to create, update or delete Glossary items; if security is not enabled, you can manage Glossary items without any permissions