Dictionaries, terms, and spotlights

By configuring dictionaries, terms, and spotlights, you can highlight assets on your site when visitors use search. For example, if you have a dictionary named Holiday sale that includes the term gift, you can create a spotlight that highlights an article called Top 10 holiday gifts whenever a visitor's search query includes the term gift.

• Dictionary—An organization of terms around a common idea or purpose (for example, Holiday sale, GraphQL, or Advertising). Dictionaries can be created and saved in Brightspot.
• Term—A component of a dictionary that returns a spotlight in search results (for example, gift, API, or demo).
• Spotlight—A highlighted asset that Brightspot returns after you map it to a term (for example, Top 10 holiday gifts, Inside Brightspot's GraphQL API, or Top 10 reasons why editors love Brightspot). Spotlights appear as promos in search results.

Dictionaries

A dictionary is a group of terms and associated variants and misspellings. When a visitor searches for a term in the dictionary, Brightspot includes the associated spotlight in the search results.

Creating dictionaries

To create a dictionary:

1. Click > Search > Dictionaries/Terms.
2. In the left rail, under Dictionary, click New Dictionary.
3. In the Name field, type a name for the dictionary.
4. Click Save.

Adding terms to dictionaries

Terms are individual entries in a dictionary. As you add terms to a dictionary, you typically include synonyms, misspellings, and other variants associated with the term.

To add terms to a dictionary:

1. Click > Search > Dictionaries/Terms.
2. In the left rail, under Term, click New Term.
3. In the Primary Phrase field, type a term or a phrase. Do not enclose phrases in quotes.
4. In the Variants field, add synonyms or variants of the term or phrase.
5. In the Misspellings field, add misspellings associated with the term or phrase.
6. In the Dictionaries field, click to select dictionaries to which you want to add this term.
7. Click Save.

Spelling and locales

With the introduction of word processors in the 1980s, spelling has become quite a bit easier, particularly with hard-to-spell languages such as English. Today, almost any app in which you type also includes a dictionary with standard words. As you type, the app shows misspelled words with a red underline.

If you work in a technical field with a specialized vocabulary, the chances are that some of the words you use are not in the app’s dictionary, so those words are marked as misspelled.

In the previous example, Musa is a technical term not in the standard English dictionary, but it is not misspelled. You can add technical words such as Musa to an auxiliary dictionary so that they are not marked as misspelled.

In addition, apps provide dictionaries for almost every language. If you are typing an article in Spanish, you can use the app’s Spanish dictionary, and add technical words to that dictionary as well.

Locales

In different parts of the world, there are differences in written communication—even within the same language. A date, number, or spelling may be different in one region compared to another.

Apps group customary presentations for spellings, numbers, dates, and currency symbols into locales—a language-country pair. In Brightspot, you can see all the available locales in your profile widget.

When you change the locale, Brightspot's widgets change to match the locale’s settings. In particular, Brightspot uses the locale’s dictionary for text you type.

Dictionary selection

The following diagram illustrates how Brightspot determines which dictionary to use as you type in the content edit form.

For example, if your locale is English (United Kingdom), Brightspot assumes that all the words you type are in the UK dictionary. If that dictionary is installed in Brightspot, spelling errors are caught accordingly. If that dictionary is not installed in Brightspot, your browser checks for spelling errors using its own dictionary.

(Dictionaries and spelling in browsers is a very complicated topic. Some browsers have dictionaries installed for several languages. Those browsers automatically detect in which language you are typing, and use the corresponding dictionary for spelling. If the browser cannot detect the language you are using, it may assume you are using a default dictionary and mark every word as misspelled, or it may not perform spell check at all. See your browser’s user guide for information about how it checks spelling.)

Detecting misspelled words

Your version of Brightspot may have several language dictionaries installed as well as auxiliary dictionaries with technical terms for those languages. The following diagram illustrates the logic Brightspot uses to detect misspelled words among all those dictionaries.

For example, you are working in the English-Australia locale, and you type I saw the movie Breaker Morant.

1. Brightspot looks in the standard English-Australia dictionary, and does not find the word Morant.
2. Brightspot then looks in the auxiliary dictionary for English-Australia (if you created one), and again does not find the word Morant.

In this case, Brightspot marks the word Morant as misspelled.

Auxiliary dictionaries

Brightspot comes with spell-check dictionaries for English and Spanish. (Your Brightspot developer can add additional languages.) These dictionaries contain standard words, and Brightspot checks your text against those dictionaries. Words not in those dictionaries are marked as misspelled.

If you use non-standard terminology, such as technical terms or product names, Brightspot marks those terms as misspelled. If you add such terms to an auxiliary dictionary, Brightspot recognizes them as spelled correctly.

Auxiliary dictionaries are specific to your profile’s locale. If you are creating content in US English, you add terms to that locale’s auxiliary dictionary; if you are creating content in Mexican Spanish, you add terms that locale’s auxiliary directory.

Note

This topic describes the in-CMS process of creating an auxiliary dictionary in Brightspot; however, you must also perform a development task to achieve this end. For details on this task, see Installing additional dictionaries.

To create an auxiliary dictionary:

1. Click > Admin > Sites & Settings > Sites > Global.
2. From the CMS tab, expand the Hunspell cluster.
3. Under Dictionaries, click , and select Create New.
4. In the Name field, type a name for the dictionary.
5. From the Locale list, select the language for which the dictionary is applicable.
6. In the Additional Words list, type a word. Click to add additional words.
7. Click Save.
8. Click Back.
9. In the content picker, select the name of the dictionary you created.
10. Close the content picker.
11. Click Save.

As you type text in various Brightspot fields, words appearing in the dictionaries are not marked as misspelled.

Spotlights

A spotlight is a dictionary associated with a promo, and you can list spotlights at the top of site searches. For example, if you have a dictionary Environment that contains the word green, and you associate that dictionary with a promo for the article "Measuring Your Environmental Footprint." When a visitor searches on the term green, Brightspot lists the promo at the top of the search results. Depending on your version of Brightspot, the spotlight may also include a flag above it that says Featured Result.

To create a spotlight:

1. Open the required dictionary in the content edit page, or create a new one. Ensure the dictionary contains the terms with which you want to associate the promo. For details, see Adding terms to a dictionary.

2. Click > Search > Dictionary Spotlight.

3. In the Create widget, click New Page Promo Dictionary Spotlight.

   

4. Under Promo, complete the fields as necessary. This is the promo that will be associated with the term and serve as the spotlight in search. For details, see Page Promo.

5. From the Term list, select the search term with which you want to associate the promo that will appear in search.

6. From the Dictionary list, select the dictionary with which you want to associate the promo. This field is helpful in case a term applies to more than one dictionary, ensuring that the spotlight you create applies only to the intended term.

7. Click Save.

When visitors search on the term you selected in step 5, Brightspot includes the promo at the top of the search results. This includes if a visitor searches any misspellings or variants that you associated with the term. For details, see Adding terms to a dictionary.

Terms in multiple dictionaries

When visitors search for a term on your site, Brightspot lists the content associated with that term. In addition, you can include a spotlight, which appears as a promo for an asset that you explicitly associate with the search term in the search results.

You may have multiple dictionaries for different purposes, and at times the same term may be included in each. In these scenarios, Brightspot checks the site search page to which the dictionary is associated to ensure the correct spotlight is served to visitors. For information on site search pages, see Site search.

Referring to the previous illustration, a publisher operates two sites: Fashion Trends and Environment Today. Each site has an associated dictionary of spotlight terms assigned to its site search page.

• Fashion Trends has a dictionary Colors containing colors.
• Environment Today has a dictionary Environment containing related terms.

Each dictionary has the term green. If a visitor searches for green on Fashion Today, with which the Colors dictionary is associated, Brightspot includes in the search results a spotlight to the article "This Summer's Accessories." If a visitor searches for green on Environment Today, with which the Environment dictionary is associated, Brightspot includes in the search results a spotlight to the article "Measuring Environmental Footprint."

Pinning assets in search results

In a typical search scenario, visitors enter keywords in a search field, and Brightspot retrieves the assets that best match the keywords. You can customize the order in which the search results display for visitors by pinning specific assets into specific positions.

Referring to the previous illustration, Brightspot returns six assets matching the search term CMS. After pinning, the assets in positions two and five will always appear in those positions when a visitor searches on CMS.

To pin assets in search results:

1. Ensure you already created the following:

   • A dictionary with search terms. For details, see Creating a dictionary and Adding terms to a dictionary.
   • A site search page. For details, see Site search.
2. Click > Search > Term Search Results.

3. In the Create widget, click New Term Search Results.

4. From the Term list, select one of the available terms.

5. From the Search list, select the site search page to which the pinned assets apply.

6. In the editorial toolbar, click Save. Under Results, Brightspot lists the assets that naturally match the selected term.

7. Under Results, in each of the available positions, do the following:

   1. Click to open the cluster.

   2. From the Item list, select one of the following:

      • Dynamic Search Result (Placeholder)—The result in this position is the natural result based on Brightspot's search algorithm, accounting for any pinned results above it.
      • Referenced Search Result Item—The result in this position is an asset you select.

8. Click Save.

Brightspot adjusts the retrieval listing.

• The natural position of an asset is changed accounting for pinned assets above it. For example, if Asset A naturally appears in the third position, and there is one pinned asset above it, then Asset A appears in the fourth position.
• Pinned assets are removed from the natural listing. For example, if Asset B naturally appears in position five, but you pinned it in position four, then Asset B does not appear in the natural listing.

Removing pinned search results

You can remove all pinned assets from search results by archiving the corresponding term search results.

To remove all pinned search results:

1. Click > Search > Term Search Results.
2. In the search panel, click the term search results you want to remove.
3. In the editorial toolbar, click > Archive.
4. In the confirmation prompt, click OK.