Description (content object property)

Scope

• Content object > Basic Properties > Description

Purpose

This property can be used to provide a longer-format description of the parent object. This property is edited via the Text Editor, so it is possible to use text formatting (including defined styles), as well as tables, graphics, video, and so on.

The contents of this property are displayed on the rightmost side of the Trainer screen, 'below the line' (the horizontal rule separating the Short Description and play mode buttons and the Description). It is therefore often used for providing context, concepts, or additional information about the object. For Books and Simulations, this should provide enough contextual information to let the user know if they want to open the Book or play the Simulation.

The Description can appear in the generated documents, by specifying a Fragment of Description.

The Description may also appear in the Desktop Assistant object list, if Settings > Desktop Assistant: Playback Settings > Desktop Assistant > Desktop Assistant - Content and Behavior > Use Text From is set to Document. In this case, the Description should be kept relatively short as the object list does not provide a lot of space.

See Also

• * Desktop Assistant (Content Object) content object > Basic Properties > Info Description