<Description> and <ShortDescription> elements

Descriptions are optional informative text fields that can be added to various elements in the catalog files. These fields are optional, but it is recommended that catalog writers use them to document the parent element.

Syntax

The parent element of a <ShortDescription> element can be one of:

  • <Catalog>
  • <SubCat>

The parent element of a <Description> element can be one of:

  • <Catalog>
  • <SubCat>
  • <ParameterDef>
  • <ConstraintDef>

The content of the <Description> and <ShortDescription> elements is either a simple string, or a translated message defined by one of the <NLSCatalog>, <NLSSmitHelp> or <NLSCommand> elements. See the Globalization support topic for more information.

Usage

Currently, only the description of <ParameterDef> elements is retrieved and displayed by the artexget command with the -i flag. It is recommended to provide globalization for the text included in those description fields.

The description field of the other elements are currently not used by the AIX Runtime Expert framework, but they should be provided for future use and for documentation purpose.

Example

  1. Here is a simple example of description fields:
    <ShortDescription>
       chuser parameters
    </ShortDescription>
    <Description>
       Parameter definition for the chuser command
    </Description>
  2. The same example, using translated messages from the artexcat.cat message file:

    <ShortDescription>
    <NLSCatalog catalog="artexcat.cat" setNum="12" msgNum="1">
      chuser parameters
    </NLSCatalog>
    </ShortDescription>
    <Description>
    <NLSCatalog catalog="artexcat.cat" setNum="12" msgNum="2">
      Parameter definition for the chuser command
    </NLSCatalog>
    </Description>