Unordered lists
Unordered lists are used in Splunk documentation when the sequence of items is irrelevant, ensuring clarity and consistency in presenting options or information.
When you write Splunk documentation, use an unordered list, sometimes called a bulleted list, when the order of list items isn't important. For example, you can use an unordered list for a list of options.
Qualities of unordered lists
Unordered lists must have the following qualities:
- A complete lead-in sentence that describes the list's purpose, punctuated by a colon
- A consistent hierarchy or order, such as alphabetization
- More than 1 list item
- No more than 1 sublist for each list item if needed, with at least 2 items in a sublist
- Parallel sentence construction
- Sentence case capitalization
- 1 sentence or idea for each list item
- End punctuation if the list items are complete sentences
- No end punctuation if the list items are characters, words, or phrases
For more guidance on using lists, see Best practices for writing with lists.
Example
The following example of an unordered list contains a complete lead-in sentence. Each item in the list uses parallel construction and doesn't contain more than 1 phrase.
You can use the following types of Search Processing Language (SPL) commands:
- Eventing commands
- Generating commands
- Reporting commands
- Streaming commands