Splunk® Style Guide

Splunk Style Guide

Acrobat logo Download manual as PDF


Acrobat logo Download topic as PDF

Bulleted lists

Use a bulleted list, sometimes called an unordered list, for a list in which the list item order isn't important, such as a list of options.

You can choose whether you want to alphabetize or apply a different order to bulleted list items.

Qualities of bulleted lists

Bulleted lists must have the following qualities:

  • A complete lead-in sentence punctuated by a colon
  • More than one list item
  • Up to two levels
  • Parallel sentence construction
  • One 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 a bulleted list contains a complete lead-in sentence. Each item in the list uses parallel construction and doesn't contain more than one phrase.

You can create the following types of Search Processing Language (SPL) commands:

  • Eventing commands
  • Generating commands
  • Reporting commands
  • Streaming commands
Last modified on 23 September, 2019
PREVIOUS
Best practices for writing with lists
  NEXT
Numbered 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