Splunk® Style Guide

Splunk Style Guide

Acrobat logo Download manual as PDF


Acrobat logo Download topic as PDF

Brackets

There are three kinds of brackets: angle brackets, curly braces, and square brackets.

Angle brackets ( < and > )

Use angle brackets as a placeholder for variables you want the user to enter.

Correct
Type your user-specified domain in this format: https://<user-specified domain>.splunkcloud.com.
Incorrect
Type your user-specified domain in this format: https://{user-specified domain}.splunkcloud.com.
Type your user-specified domain in this format: https://(user-specified domain).splunkcloud.com
Type your user-specified domain in this format: https://[user-specified domain].splunkcloud.com

You can also use angle brackets to indicate navigation or a series of menu item clicks. See the following example:

  • Select Save As > Saved search > Close.

Curly braces ( { and } )

Use curly braces only when they are part of a code sample or other string literal.

Square brackets ( [ and ] )

Use square brackets around a .conf file stanza name or within code.

Correct
Edit the [splunktcp] stanza.
Specify a subsearch that starts with this search command: tag=dns query [search tag=malware].
Incorrect
Type your user-specified domain in this format: https://[user-specified domain].splunkcloud.com.
Last modified on 19 February, 2020
PREVIOUS
Apostrophe
  NEXT
Colon

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