Topics

Site settings


In This Guide

Brightspot provides a number of configurations and settings at both global and site levels. This guide explains concepts like site hierarchy, expands on site setting fields in Brightspot CMS, and more.


Setting hierarchy

There are several levels of entities in Brightspot, each with its own level of settings. System administrators can make settings at the top-most level, and then override those settings at the site, role, and user levels.

Site hierarchy

Referring to the previous diagram, there are three groups of settings.

  • Role and user settings—These settings impact how users work with Brightspot. The settings in this group include the dashboard’s appearance, two-factor authentication, and notifications. Many of these settings can be overridden at the role and user level.
  • Site settings—These settings include how a site’s widgets appear within Brightspot, the URLs with which the site is associated, and some security settings. Many of these settings can be overridden at the site level.
  • System-wide settings—These settings include broadcast messages, debugging settings used by developers, integration settings with other web services, and general configuration. These settings cannot be overridden.

Advanced Brightspot deployments have richer hierarchies that define settings at site-role pairs, site-role-content type triplets, and other combinations.


Spelling, dictionaries, 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.

Spelling_1.png

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.

Spelling_2.png

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.

Locales_1.png

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.

Locales_2.png

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.

Dictionary Selection.png

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.

Misspelled Words.png

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.


Create an auxiliary dictionary

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.

To create an auxiliary dictionary:

  1. Click menu> Admin > Sites & Settings > Sites > Global. The Edit Global widget appears.
  2. Under CMS, expand Hunspell.
  3. Under Dictionaries, click add_circle_outline, and select Create New. A New Hunspell Dictionary content edit page appears.

    Auxiliary Dictionary_1.png

  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 add to add additional words.
  7. Click Save.
  8. Click Back. You return to the content picker.
  9. In the content picker, select the name of the dictionary you created.
  10. Close the content picker. You return to the Edit Global widget.

    Auxiliary Dictionary_2.png

  11. Click Save.

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

Word in Dictionary 4.0.png


Customizing Brightspot's labels

Note
This section describes using resource bundles to customize Brightspot's widgets, dashboard, reports, and other editorial components.

Some of Brightspot's labels are in configuration files. For example, the configuration file SiteDefault_en.properties provides labels appearing in the Sites widget.

Example 1. Configuration file for labels in Sites widget

displayName=Site
global=Global
action.switch=Switch

Brightspot uses the labels when rendering the Sites widget, as described in the following illustration.

Site Properties Labels.png

Each configuration file's name contains one of the following:

  • A code indicating a language and region
  • A code indicating only a language
  • Neither language nor region code

The following table illustrates file names and the associated language and region.

Table 1. Language and region codes in file names

File name
Language code
Region code
Language
Region
SiteDefault_en_GB.properties
en
GB
English
United Kingdom
SiteDefault_en.properties
en
N/A
English
N/A
SiteDefault_es_MX.properties
es
MX
Spanish
Mexico
SiteDefault_es.properties
es
N/A
Spanish
N/A

For a list of language and region codes, see ISO-3166 Country Codes and ISO-639 Language Codes.

Brightspot retrieves labels based on an editor's locale.

  • If an editor selected a locale English (United States), then Brightspot retrieves the labels for the Sites widget using the following priority:

    1. From the file SiteDefault_en_US.properties. If that file does not exist,
    2. From the file SiteDefault_en.properties. If that file does not exist,
    3. From the Brightspot defaults (which are US English).
  • If an editor selected a locale Spanish (Mexico), then Brightspot retrieves the labels for the Sites widget using the following priority:

    1. From the file SiteDefault_es_MX.properties. If that file does not exist,
    2. From the file SiteDefault_es.properties. If that file does not exist,
    3. From the Brightspot defaults (which are US English).

(For information about setting a user's locale, see Users.)

You can override the labels appearing in the configuration files to customize the Brightspot experience to your organization's needs (and personality).

To customize labels:

  1. Acquire from your Brightspot developer the path and name of the file you want to override. Examples of these files are as follows:

    • com/psddev/cms/db/SiteDefault_en_US.properties
    • com/psddev/cms/tool/content/SitesWidgetDefault_en.properties
  2. Inside the file, identify the label you want to customize.
  3. From the Navigation Menu, expand Admin, and select Sites & Settings.
  4. In the Sites widget, select Global. The Edit Global widget appears.
  5. Under Main, expand UI.
  6. Under Localization Bundles, click.add_circle_outline . A form appears.

    Localization bundles.png

  7. From the Locale list, select the language and region whose labels you want to customize. The language corresponds to the two-letter code in the file name.
  8. Under Localizations, click add_circle_outline . A form appears.

    Localizations.png

  9. In the Name field, enter the path and filename from step 1 until the word Default. For example, if the developer gave you a path and filename com/psddev/cms/db/SiteDefault_en.properties, enter com/psddev/cms/db/Site.
  10. Under Entries, click.add_circle_outline . A form appears.

    Localization entries.png

  11. In the Key field, enter the key corresponding to the label you want to customize. Enter one of the following keys: displayName, global, or action.switch.
  12. Repeat steps 10–11 to customize additional labels in the configuration file.
  13. Repeat steps 8–12 to customize labels in other configuration files for the current locale.
  14. Repeat steps 6–13 to customize labels for other locales.
  15. Click Save.

When an editor uses the locale you selected in step 7, Brightspot retrieves the label from the override you entered.

Retreived label.png