Description List

What is it?

A description list consists of terms followed by their corresponding descriptions or definitions. It is specifically designed to group items in a name-value or key-value format.

How do you use it?

Description lists are ideal for structured data, such as:

  • Glossaries: Mapping technical terms to their definitions.
  • FAQs: Pairing questions with their answers.
  • Program parameters: Defining functions and their descriptions in technical documentation.

Creating a List

  1. Navigate to Structure -> Taxonomy -> Definitions.
  2. To begin a new list, click the "Add Term" button.
  3. Fill in the "Name" and "Description" fields.
    • Click Save if you wish to enter multiple terms sequentially.
    • Click Save and go to list to add a single term and return to the main overview.
  4. To place the list on a Canvas page, locate the Description List component in the component library and drag it to your desired area on the page.