There are differences between single quotation marks and double quotation marks, how to style them, and where to place punctuation that is used near a quotation mark.
Use logical quotation
When you place a keyword or other string literal within quotation marks, put punctuation, like commas and periods, outside of the final quotation mark.
- If you see the message "Authentication Failed", try logging in again.
- The message shows "Authentication Successful".
- If you see the message "Authentication Failed," try logging in again.
- The message shows "Authentication Successful."
Use straight quotation marks
Use straight quotation marks instead of curly quotation marks when you write. In certain scenarios, especially in code examples, you must use straight quotation marks because curly quotation marks cause code to break. A better practice is to use straight quotes everywhere in your writing.
When to use single quotation marks
Use single quotation marks for code examples in languages that use the mark. See the following example:
SPLUNK_HOME = os.environ['SPLUNK_HOME']<br><br> LOGGING_DEFAULT_CONFIG_FILE = os.path.join(SPLUNK_HOME, 'etc', 'log.cfg')
When to use double quotation marks
Use double quotation marks to format the following elements:
- To offset words that aren't part of the meaning of your sentence
- Error messages
Don't use quotation marks for emphasis, to show user input, or to enclose the names of UI elements.
- Search for "Query tables" on the Microsoft website.
- If you see an error message that says "The user isn't authenticated", check the user's permissions.
- Enter "Filename" into the UI field.
- From the "Field" menu, select Filename.
For a full list of formatting rules for commonly documented elements, including the elements that take quotation marks, see Formatting reference.
This documentation applies to the following versions of Splunk® Style Guide: current, current