MagicDraw 18.4 Documentation
Glossary saves time by ensuring consistent usage of terminology in the organization. It also improves the communication between team members since terms are understood in the same way and definitions become visible everywhere the terms are used.
The Glossary Table allows you to:
- Create a list of all the specific terms used in the project.
- Define your terms in one place.
- Use them everywhere in your project.
- Export your glossary to new project and use it in other projects.
- Export your glossary into an .html, .csv, or .xlsx files.
- Have several glossaries in one project.
- Customize the representation of the glossary in the table.
Each row in the table represents a term. A word, phrase, or any element of the model can be a term. Words and phrases defined as terms are underlined. That is how you can identify terms in your model.
The word or phrase is underlined only if it matches completely the defined term. For example, you have defined a word Project in your glossary. So when you type a word Projects, it would not be underlines, because it is used in plural.
The video below demonstrates how to use the glossary in MagicDraw when working with Requirements.
The sections below describe basic features of the Glossary Table:
Visibility of terms
The term descriptions are visible on the diagram pane.
Navigation through terms
When a term is a whole phrase and one or more words are also defined as terms, you can easily navigate through all those terms in the description window. We recommend creating a new package where the Glossary Table and all terms will be stored. In the created package, create a Glossary Table.
Usage of terms
After terms are defined in the glossary, it is easy to use them in your project. Press Ctrl + Backspace while typing to get a list of available terms.
Usage of acronyms
You can define a capitalized acronyms, such as ABS, MBSE in the glossary (see the figure below).
Only capitalized terms are recognized as acronyms. The lowercase words are not interpreted as acronyms.
The option to recognize acronyms everywhere in the text are enabled by default.
To disable acronyms usage
- From the Glossary table toolbar, select .
- Click to clear the Use Acronyms check box.
- No labels