Splunk® Style Guide

Splunk Style Guide

Acrobat logo Download manual as PDF


Acrobat logo Download topic as PDF

Show symbols in text

If you want to show a symbol in your text, write out the symbol first, and then refer to the symbol in parentheses with nonbreaking spaces. The HTML character entity for a nonbreaking space is  .

Correct
Begin the line with a forward slash ( / ).
Enter your search after the pipe ( | ).
Incorrect
Begin the line with a forward slash, /.
Enter your search after the |.

What to call symbols

Use the following terms when writing about symbols in Splunk documentation:

Symbol What to call it
` Backtick
~ Tilde
! Exclamation point
@ At symbol
# Pound sign
$ Dollar sign
% Percent sign
^ Caret
& Ampersand
* Asterisk, wildcard
( Left parenthesis
) Right parenthesis
- Dash, hyphen, minus sign
_ Underscore
= Equal sign
+ Plus sign
[ Left bracket
] Right bracket
{ Left brace
} Right brace
\ Backslash
| Pipe, vertical bar
; Semicolon
: Colon
' Single quotation mark
" Double quotation mark
, Comma
< Less than, left-pointing angle bracket
. Period
> Greater than, right-pointing angle bracket
/ Forward slash
? Question mark
Last modified on 18 January, 2023
PREVIOUS
Versions
  NEXT
Ampersand

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