Splunk® Style Guide

Splunk Style Guide

Acrobat logo Download manual as PDF


Acrobat logo Download topic as PDF

Numbered lists

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. If you add substeps, use an ordered list marked by lowercase letters.

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.

Example

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. In step three, the procedure has substeps marked by lowercase letters.

Search for sales of a specific product

Search for how many simulation style games were bought yesterday.

  1. In the time range picker, change the time range to Yesterday.
  2. Run the following search:
    sourcetype=access_* status=200 action=purchase categoryId=simulation
  3. Find the number of purchases for each type of product.
    1. Remove categoryId=simulation from your search criteria and run the search again.
    2. Locate the unique categoryId values by clicking the categoryId field in the Selected Fields list.
    3. Click on a categoryId name. The categoryId is added to your search and the search is automatically run again. The results show the number of purchases for that product.
  4. For the number of purchases made each day of the previous week, run the search again for each time range.
Last modified on 03 June, 2021
PREVIOUS
Bulleted lists
  NEXT
Definition lists

This documentation applies to the following versions of Splunk® Style Guide: current


Was this documentation topic helpful?

You must be logged into splunk.com in order to post comments. Log in now.

Please try to keep this discussion focused on the content covered in this documentation topic. If you have a more general question about Splunk functionality or are experiencing a difficulty with Splunk, consider posting a question to Splunkbase Answers.

0 out of 1000 Characters