Support and Documentation

List modules

List modules allow you to display lists of authors, quotes, or pages.

Lists are used to achieve any number of needs:

  • Basic, manual curation of lists.

  • Deeper, editorially voiced lists that include entire modules.

  • Completely dynamic list based on filters and selections.

Below is a breakdown of the fields for each of the different kinds of list modules in Brightspot.

Author list

The following explainer covers the fields belonging to an author list 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.

  • Description: A text field that you can use to add a description to the module.

  • Items: Allows you to add items to the author list module.

    • Basic: Allows you to manually add internal authors to the list.

    • Advanced: Allows you to add internal or external authors to the list. Advanced lists also allow you to override title, description, and image, as well as determine the behavior of the target after the list item is clicked.

    • Dynamic: Allows you to apply filters and make selections to dynamically populate the author list.

      • Items Per Page: Allows you to control how many results are returned per page.

      • Types: Allows you to limit the asset types that display in the list. If none are selected, all will return.

      • Sort: Allows you to sort a dynamic list by Newest, Oldest or Relevance.

      • Pinned Items: Allows a user to pin either a dynamic page result or a promo in the dynamic result set. You can program the following fields: Item (Internal, External, or No Link), Title, Description and Image Override.

  • Call to Action: Allows you to insert a call to action (None, External, or Internal). Depending on selection, you can enter a URL (External) or add attributes, an anchor, and determine the behavior of the target after the call to action is clicked (Internal).

List

The following explainer covers the fields belonging to a list 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.

  • Description: A text field that you can use to add a description to the module.

  • Items: Allows you to add items to the list module.

    • Basic: Allows you to manually add internal pages to the list.

    • Advanced: Allows you to add internal or external pages to the list. Advanced lists also allow you to override title, description, and image, as well as determine the behavior of the target after the list item is clicked.

    • Dynamic: Allows you to apply filters and make selections to dynamically populate the list.

      • Items Per Page: Allows you to control how many results are returned per page.

      • Types: Allows you to limit the asset types that display in the list. If none are selected, all will return.

      • Sort: Allows you to sort a dynamic list by Newest, Oldest or Relevance.

      • Pinned Items: Allows you to pin either a dynamic page result or a promo in the dynamic result set. You can program the following fields: Item (Internal, External, or No Link), Title, Description and Image Override.

      • Authors: Allows you to limit the result set to a single author or multiple authors. You can also select Current Author to show results just from the corresponding author on which the item is placed.

      • Time Period: Allows you to limit the returned content to that published within a number of days. This means that if you input 13 days, the result set will only show the newest content within the last 13 days.

      • Sites: Allows you to limit the result set to only items published on certain sites.

      • Include All Locales: Toggles whether all locales are included on this list.

      • Sections: Allows you to limit the result set to a single section or multiple sections. You can also select Current Section to show results just from the corresponding section on which the item is placed.

      • Tags: Allows yo to limit the result set to a single tag or multiple tags. You can also select Current Tag to show results just from the corresponding tag on which the item is placed.

  • Call to Action: Allows you to insert a call to action (None, External, or Internal). Depending on selection, you can enter a URL (External) or add attributes, an anchor, and determine the behavior of the target after the call to action is clicked (Internal).

  • CTA Button Text: Allows you to insert text for the button representing the call to action.

Quote list

The following explainer covers the fields belonging to a quote list module.

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

  • Items: Allows you to select the style of the quote list.

    • Basic: Allows you to manually add quotes to the module, either by creating them or by adding shared quotes.

    • Advanced: Allows you to add shared quotes and opens interface that you can use to create new quotes. You can also associate an attribution image to the quotes.

Dynamic list filters

Users configure dynamic lists using filters. This section explains each filter.

None

No filters are applied to the dynamic list.

All Match

The items in this filter must match all rules.

When scanning for items to include in the list, Brightspot only includes those items that match the all the rules. For example, a visitor is viewing an article that contains this list. The list includes items that match the following rules:

  • Authored by Tanner Peterson

  • Tagged with Culture

All_Match_good.png
Any Match

The items in this filter must match any rules.

When scanning for items to include in the list, Brightspot includes any items that match any rules. For example, a visitor is viewing an article that contains this list. The list includes any items that match the following rules:

  • Authored by Tanner Peterson

  • Published in the last 14 days

Any_Match.png
Authors

The items in this filter must match all authors.

When scanning for items to include in the list, Brightspot includes only those items that matches selected authors. For example, a visitor is viewing an article that contains this list. This list includes items that match the following authors:

  • Tanner Peterson

Authors.png
Date Range

The items in this dynamic list must match the time period specified in the filter.

When scanning for items to include in the list, Brightspot includes only those items that match the specified time period. For example, a visitor is viewing an article that contains this list. The list includes items that were published in the last 7 days.

Date_Range.png
None Match

The items in this filter must not match all rules.

When scanning for items to include in the list, Brightspot only includes those items that do not match the specified rules. For example, if a visitor is viewing an article that contains this list, the list includes items that do not match the following rules:

  • Authored by Tanner Peterson

  • Published in the last 30 days.

None_Match.png
Sections

The items in this dynamic list must match the sections specified in the filter.

For example, a visitor is viewing an article that contains this list. The list includes items that match the following sections:

  • Our Mission

  • Our Work

Sections.png
Tags

The items in this dynamic list must match the tags selected in the filter.

When scanning for items to include in this list, Brightspot includes only those items that match the specified tags. For example, a visitor is viewing an article that contains this list. The list includes items that match the following tags:

  • Culture

  • Employees

Tags.png
Include Current toggle

When a user builds a dynamic list in Brightspot, filters determine what populates the list. Some filters include an Include Current toggle.

One such filter is Authors. Below is an example of how this functionality works with the Authors filter.

Let's say that you are an editor, and one of your staff has just written an article. You want the readers of this article to see other articles that the author has written; however, you also want two other things:

  • You want to do this for every author on the articles they write.

  • You only want to create this list once, preventing yourself from having to create a new list for each author on your staff.

This is where the Include Current toggle comes in. When a dynamic list is placed on an asset, like an article, Brightspot checks the author of the asset. Brightspot then populates the list with other assets the author has created. That means that the dynamic list can be created once, then placed on different assets with different authors, and Brightspot will always identify the author first before populating the list with assets relevant to that author.

The Include Current toggle also exists in the Tags and Sections filters.

In both cases, Brightspot checks the tag or section associated to the asset a visitor is currently viewing, then populates the list with other assets that share this tag or section.