
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
- Enter your user-specified domain in this format: https://<user-specified domain>.splunkcloud.com.
- Incorrect
- Enter your user-specified domain in this format: https://{user-specified domain}.splunkcloud.com.
- Enter your user-specified domain in this format: https://(user-specified domain).splunkcloud.com
- Enter your user-specified domain in this format: https://[user-specified domain].splunkcloud.com
Do not use the right-pointing angle bracket ( > ) to indicate navigation through a series of menu item selections. Instead, spell out the sentence using a word like "then".
- Correct
-
- Select Start, then Administrative Tools, then Computer Management.
- Incorrect
-
- Select Start > Administrative Tools > Computer Management.
In order for an action to qualify as a step in a menu path, the action must be accessible within that menu. If completing a step in the path takes the user to a new page or menu where they complete another action, describe that action in a new task step instead of combining it in the same step.
- Correct
-
- In Splunk Web, select Settings, then Advanced Search.
- On the Advanced search page, select Search commands.
- Incorrect
-
- In Splunk Web, select Settings > Advanced Search > Search commands.
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
- Enter your user-specified domain in this format: https://[user-specified domain].splunkcloud.com.
PREVIOUS Apostrophe |
NEXT Colon |
This documentation applies to the following versions of Splunk® Style Guide: current
Feedback submitted, thanks!