Use a definition list to define a set of terms, descriptions, explanations, or associations.
You can add a paragraph break after each definition if the formatting is tight.
Qualities of definition lists
Definition lists must have the following qualities:
- A complete lead-in sentence
- More than one defined term
- Up to two levels: the term, which is in bold and on its own line, and the definition, which is at least one full sentence indented on its own line
- Parallel sentence construction
- One action for each list item
- End punctuation in every definition line
For more guidance on using lists, see Best practices for writing with lists.
The following example of a definition list contains a complete lead-in sentence. Each item in the list uses parallel construction and complete sentences.
Splunk Cloud differs from Splunk Enterprise in the following ways:
- Command line interface (CLI)
- Splunk Cloud customers don't have access to the command line. Splunk Support must perform tasks that require CLI access.
- Only Splunk inspected and approved apps are permitted to run in a Splunk Cloud deployment.
- License pooling
- Splunk Cloud doesn't allow license pooling.
- Two-factor authentication
- Splunk Cloud doesn't support two-factor authentication.
Best practices for using callout boxes
This documentation applies to the following versions of Splunk® Style Guide: current