17.12.4 description

This element specifies a description for the contents of this glossary document entry. This description can contain any string content, and allows the entry to have additional information contained within the definition for this glossary document entry. [Note: This description can be surfaced in a user interface, for example. end note]

[Example: Consider the following WordprocessingML fragment for the properties of a single glossary document entry:

<w:docPartPr>
  …
  <w:name w:val="Sample Entry" />
  <w:description w:val="This is an example of a glossary document entry for
example purposes." />
  …
</w:docPartPr>

The description element specifies that the long description associated with the parent entry must be This is an example of a glossary document entry for example purposes. This value can be used as needed by an application, for example, to display in a user interface. end example]

Attributes

val (String Value)

Specifies that its contents contain a string.

The contents of this string are interpreted based on the context of the parent XML element.

[Example: Consider the following WordprocessingML fragment:

  <w:pPr>
    <w:pStyle w:val="Heading1" />
  </w:pPr>

The value of the val attribute is the ID of the associated paragraph style’s styleId.

However, consider the following fragment:

  <w:sdtPr>
    <w:alias w:val="SDT Title Example" />
    …
  </w:sdtPr>

In this case, the decimal number in the val attribute is the caption of the nearest ancestor structured document tag. In each case, the value is interpreted in the context of the parent element. end example]

The possible values for this attribute are defined by the ST_String simple type (22.9.2.13).

[Note: The W3C XML Schema definition of this element’s content model (CT_String) is located in A.1. end note]