definitionTable, definedTerm, definition

Sandcastle MAML

Collapse image Expand Image Copy image CopyHover image

This element describes a list of terms and their definitions. Technically, the MAML schema defines the definition table as a two-column table without a header or footer. However, Sandcastle renders the element as an HTML definition list (dl/dt/dd).

Usage

Enter the element in the topic and specify one or more nested pairs of definedTerm and definition elements. The definedTerm element describes the term being defined. The definition element supplies the definition. Each definition element can contain other MAML elements, nested lists, tables, etc. Text should be contained in a para element.

Tip

The definedTerm element supports an address attribute that can be used to link to a specific defined term from another location.

Example

  Copy imageCopy
<para>This link takes you to <link xlink:href="#Term8">Term #8</link>.</para>

<definitionTable>
  <definedTerm>Term 1</definedTerm>
  <definition><para>Definition 1</para></definition>

  <definedTerm>Term 2</definedTerm>
  <definition><para>Definition 2</para></definition>

  <definedTerm>Term 3</definedTerm>
  <definition><para>Definition 3</para></definition>

  <definedTerm>Term 4</definedTerm>
  <definition><para>Definition 4</para></definition>

  <definedTerm>Term 5</definedTerm>
  <definition><para>Definition 5</para></definition>

  <definedTerm>Term 6</definedTerm>
  <definition><para>Definition 6</para></definition>

  <definedTerm>Term 7</definedTerm>
  <definition><para>Definition 7</para></definition>

  <definedTerm address="Term8">Term 8</definedTerm>
  <definition><para>Definition 8.  The entry's term has an <codeInline>address</codeInline>
attribute that can be used as a link target.</para></definition>
</definitionTable>

Example Output

This link takes you to Term #8.

Term 1

Definition 1

Term 2

Definition 2

Term 3

Definition 3

Term 4

Definition 4

Term 5

Definition 5

Term 6

Definition 6

Term 7

Definition 7

Term 8

Definition 8. The entry's term has an address attribute that can be used as a link target.

See Also