Glossary Styles

When you are defining your Glossary terms, you can also define a documentation style to apply to terms of a specific term type. When you generate RTF, PDF or DOCX documents those terms are shown in the defined color, font and/or emphasis. This applies a visual key to the Glossary terms of each type, and makes it easier for the reader to recognize all the terms for which they can obtain a definition or explanation.

The term type also acts as a key for substituting the meaning of any term of that type for the term itself. For example, if you select a term type of 'edition', in a report the terms 'Corp', 'BSE', 'SysE' and 'Ult' would be replaced by the meanings 'Corporate', 'Business and Software Engineering', 'Systems Engineering' and 'Ultimate', respectively.

You apply the glossary styles and meaning substitution through the 'Generate Documentation' dialog. You should not set up term substitution in a model from which you generate HTML reports; the HTML report generator does not apply glossary styles, nor does it substitute meanings.

Configure Glossary Styles

You configure Glossary styles within a Glossary Style Sheet, using the 'Glossary Markup' dialog; you display this dialog from the Glossary View. For each Glossary Term Type, you define one style in the Style Sheet, using the standard CSS style definition language. This is an example of two style definitions in a style sheet:

.paragraph {

font-family: courier;

font-size: 16px;

font-weight: italic;

color: #FF0000;

background: none;

text-transform: capitalize;

}

.language-term {

font-family: arial;

font-size: 14px;

font-weight: bold;

color: #800000;

background: none;

text-transform: capitalize;

}

Access

Use one of the methods described here to display the Glossary view, then:

Right-click within the Glossary view > Assign Markup Styles

Ribbon	Publish > Documentation > Glossary
Keyboard Shortcuts	Alt+2

Define Styles

Assign one style to each of the Glossary Term Types, which have been defined on the 'Glossary' dialog.

Option	Action
Term	This column lists the existing Term Types in the Glossary.
Style Name	This column identifies the style assigned to each Term Type. If no style has been assigned, the field is blank. To assign or switch the style, double-click on the row, type the style name on the 'Input' prompt and click on the OK button. If the name contains more than one word, link the words with hyphens. The new style name is added to the top of the 'CSS' panel.
CSS	Between the parentheses under the style name, type in or copy/paste the new style definition, or edit an existing definition. The styles are created one after another within the single style sheet for the Glossary.
OK	Click on this button to save changes to the style definitions and close the dialog.

Using Glossary Styles

You use Glossary Styles to identify and highlight Glossary terms in your printable reports, and to indicate what kinds of term they might be. You can also use the terms as place-holders for more complex text strings in the term definitions, so that the report generator substitutes the text string for the place-holder term. Both text formatting and text substitution are enabled by selecting options on the 'Generate Documentation' dialog (click on a Package or element and press F8).

Configure Reporting for Glossary Styles

You can apply glossary styles to your RTF, PDF or DOCX documentation through the 'Generate Documentation' dialog.

Task	Action
Using the Markup Style	Select the Markup Glossary Terms checkbox to apply, in the generated report, any styles applied to any Glossary terms through the Notes text of an element. A style is applied to a Glossary term according to its Glossary term type.
Using Substitutions	(Available if the 'Markup Glossary Terms' checkbox is selected.) In the 'Use Glossary Substitution' field, click on the drop-down arrow and select a term type. For all glossary terms of that type, wherever a term occurs in the report it will now be replaced by its meaning.

Task

Action

Using the Markup Style

Select the Markup Glossary Terms checkbox to apply, in the generated report, any styles applied to any Glossary terms through the Notes text of an element.

A style is applied to a Glossary term according to its Glossary term type.

Using Substitutions

(Available if the 'Markup Glossary Terms' checkbox is selected.)

In the 'Use Glossary Substitution' field, click on the drop-down arrow and select a term type. For all glossary terms of that type, wherever a term occurs in the report it will now be replaced by its meaning.

Notes

You can copy the Glossary Style Sheet between models as reference data, using the 'Configure > Model > Transfer > Export Reference Data' and 'Import Reference Data' ribbon options

Learn more