Common Desktop Environment: Help System Author's and Programmer's Guide

<abstract>

Abstract: Provides a short description of the help volume.

Syntax

<metainfo>
   .
    .
    .
   <abstract>
   abstract text here ...
   <\abstract>
    .
    .
    .
 <\metainfo>

The abstract text should not contain HelpTag markup because the abstract may be read and displayed by applications that don't recognize markup.

The <abstract> element is automatically assigned the ID string _abstract. An author-defined ID cannot be assigned. The _abstract ID can be used with the <link> element, but not with the <xref> element.

Abstract text may contain an optional <head>.

Example

This markup briefly describes the contents of a help volume:

<abstract>
 Online help for the Application Manager Version 1.0.
 <\abstract>

Note

When creating a link to an element within the <metainfo> element, be sure it is a type=Definition link.

The following markup shows how to create a link to the abstract:

<link hyperlink= "_abstract" type=Definition>
 Choose this link for an abstract.<\link>

<abstract>

Syntax

Example

Note

See Also