Splunk® Style Guide

Splunk Style Guide

Acrobat logo Download manual as PDF


Acrobat logo Download topic as PDF

Quotation marks

Use logical quotation and place punctuation, like commas and periods, outside of quotation marks. If you use only one set of quotation marks, use double quotation marks, not single.

Use double quotation marks to format the following elements:

  • An actual quotation
  • To offset words that aren't part of the meaning of your sentence
  • Error messages

Don't use quotation marks for emphasis or to enclose the names of UI elements.

Correct
Search for "Query tables" on the Microsoft website.
If you see an error message that says "The user isn't authenticated", try logging in again.
See "Create workload pools" in this topic.
Incorrect
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 quick reference.

Last modified on 08 July, 2020
PREVIOUS
Period
  NEXT
Slashes

This documentation applies to the following versions of Splunk® Style Guide: current, 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