The guidelines in the Splunk Style Guide establish best practices for writing technical documentation. Search docs.splunk.com to find documentation related to Splunk products.
Download topic as PDF
Colon
The following table shows ways to use a colon properly in your writing:
Scenario | Example |
---|---|
To introduce bulleted lists, tables, or images. Always precede these elements with a full sentence. | Use a full sentence and a colon to introduce the following items:
|
To introduce a list within a sentence. Always precede the inline list with a full sentence. Capitalize the first word that proceeds the colon only when it's a complete sentence. | The application can access the following items: the file system, the command line, and other applications. |
To separate parts in a title or heading. Capitalize the first word that proceeds the colon. |
|
To separate a main idea from a secondary idea in a doc subheading or UI dashboard label. Capitalize the first word that proceeds the colon. | Control your data volume: Aggregate your metrics
Sources contributing to false positive: Incorrect analytic logic |
Last modified on 02 May, 2024
PREVIOUS Brackets |
NEXT Comma |
This documentation applies to the following versions of Splunk® Style Guide: current
Feedback submitted, thanks!