Support and Documentation

Modules

This concepts guide discusses the modules you can add to your pages' layouts.

Rich-text modules

The rich-text module is used to allow for text to be placed onto a page as a module. Within this rich text module, a user is able to format text, place enhancements, as well as other editorial features like track changes and commenting.

The rich-text module is derived from the rich-text editor found in the body of various assets, like an article.

Below is an explanation of the fields found in the rich-text module.

  • Internal Name: A required field that is used in search.

  • Title: A text field that you can use to add a title to the module.

  • Rich Text: A large rich-text editor field in which you can enter rich text.

Promo modules

Promo modules are used to promote multiple forms of content. Promo modules can be used as leads on many different kinds of assets, like articles, sections, tags, homepages, and more.

When a promo is used as a lead, its fields will be auto-populated using the asset's fields, but these fields can be overridden once the lead is selected.

The following assets are available to be used as promo modules:

  • Image

  • Video

When selecting an image as a promo, you can override the following fields:

  • Alt Text: Text shown in case the image does not load.

  • Caption: A rich-text field with a small toolbar where you can write a caption for the image.

  • Credit: A rich-text field with a small toolbar where you can write a credit for the image.

When selecting a video as a promo, you can override the following fields:

  • Title: A rich-text field with a tiny toolbar where you can write a title for the video.

  • Description: A rich-text field with a small toolbar where you can write a description for the video.

  • Poster Image: A field where you may add either a shared or one-off image to be displayed with the video.

Shared and embedded modules

Shared modules are reusable modules that are available for use in more than one parent asset. Shared modules need only be created once and then can be reused wherever is necessary.

Embedded modules are one-off modules that you can create in certain assets and are not reusable, appearing only in one parent asset.

  • Add assets to Brightspot as shared when—

    • You want them to be available for use in multiple parent assets.

    • You want their updates to appear in the parent assets.

  • Add assets to Brightspot as one-off when—

    • You believe they are not pertinent to more than one parent asset.

    • You do not want them to be available in other parent assets.

    • You want to prevent automatic updates from appearing in the parent asset.