Capitalization

Coveo documentation uses sentence case capitalization. This means that most things are lowercase except for titles, headings, proper nouns (which include the names of brands, products, features, and services), user interface elements, and the first word of sentences.

Guidelines

  • Use sentence case capitalization most of the time:

    • Always capitalize the first word of a sentence or standalone phrase. Write your sentences so that they don’t start with a lowercase word (such as a camel cased parameter name).

    • Capitalize proper nouns.

  • Don’t use all caps for emphasis.

  • For Coveo UI elements that are in all caps, use title case instead.

    Example

    CONTENT TO INCLUDE → Content to Include

  • Don’t use internal (or camel case) capitalization unless it’s part of a Coveo or third-party brand, product, feature, or service name.

    Examples

    • Sitecore

    • ServiceNow

    • Coveo JavaScript Search Framework

  • Follow the appropriate camel case capitalization for component and parameter names.

    Examples

  • Don’t use title case for the spelled-out form of an acronym unless it consists of proper nouns or it’s a Coveo or third-party product, feature, or service.

    Examples

    • query pipeline language (QPL)

    • Coordinated Universal Time (UTC)

    • Automatic Relevance Tuning (ART)

  • Always use the appropriate capitalization for Coveo or third-party products, features, and services when referring to them (see our naming conventions).

    Examples

    • Coveo Administration Console

    • Web source

  • Always use title case for people’s titles.

    Examples

    • Chief Information Officer

    • Director of Sales

  • When words are joined by a slash, capitalize the word after the slash if the word before the slash is capitalized.

    Examples

    • Country/Region

    • A key/value pair

  • For information on capitalization in hyphenated compound words, see Hyphens (coming soon).

Title case capitalization in titles and headings

Titles and headings should always be in title case.

  • Always capitalize the first and last words, even if they would otherwise not be capitalized.

    Example

    A Hero to Look Up To

  • Don’t capitalize a, an, or the unless it’s the first word.

    Examples

    • Use the Analytics Library

    • The Result Templates Group

  • Don’t capitalize prepositions of four or fewer letters (such as on, to, in, up, down, of, and for) unless the preposition is the first or last word.

    Examples

    • Test a Query Pipeline in the Content Browser

    • Use the Analytics Library

    • How to Measure a Purchase

    • For Further Information

  • Don’t capitalize and, but, or, nor, yet, or so unless it’s the first word or the last word.

    Example

    Sitemap and Web Connector Comparison and Specificities

  • Capitalize all other words, including nouns, verbs (including is and other forms of be), adverbs (including very and too), adjectives, and pronouns (including this, that, and its).

    Examples

    • How the Script Is Used

    • Breakdown of the Content in This Section

  • Capitalize the word after a hyphen if it would be capitalized without the hyphen or it’s the last word.

    Examples

    • Did-You-Mean Actions

    • Using Local Resources on Single-Purpose Component Pages

  • Capitalize the first word of labels, terms, components, and parameter names that appear in the UI and APIs unless they’re always lowercase or camel case (for example, organizationId).

  • In programming languages, follow the traditional capitalization of keywords and other special terms.

You can convert your text to title case at https://capitalizemytitle.com/ using the Default option.

Title case capitalization in UI elements

Certain UI elements are always written in title case, regardless of how they appear in the UI itself. These include:

  • Window, page, blank slate, modal, panel, pop-up, dialog box, and section headings

  • Menu and breadcrumb items

  • Menu section, tab, and collapsible panel labels

  • Table column headers

  • Dropdown menu labels

  • Facet names and values

  • Button labels

Sentence case in table headings

Use sentence case capitalization for table column headings to minimize column width.

Example
Service Name Access level

Organization

Organization

View