Use numbered lists, sometimes called ordered lists or task lists, when the order of the list items is important, such as in procedural information or for sequential steps a user must follow.
Qualities of numbered lists
Numbered lists must have the following qualities:
- A complete lead-in sentence punctuated by a period or a colon
- More than one list item
- Up to two levels
- Parallel sentence construction
- One action 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.
The following example of a numbered list contains a complete lead-in sentence. Each item in the list contains a single action and uses parallel construction.
Create a real-time alert with per-result triggering
Real-time alerts with per-result triggering, also called per-result alerts, use a continuous real-time search to look for events. Each search result triggers the alert.
- Navigate to the Search page in the Search & Reporting app.
- Create a search.
- Select Save As > Alert.
- Type a title and optional description.
- Specify permissions.
- Select the Real-time alert type.
- Select the Per-Result trigger option.
- (Optional) Configure a trigger throttling period.
- Select at least one alert action that occurs when the alert triggers.
- Click Save.
This documentation applies to the following versions of Splunk® Style Guide: current