Support and Documentation

Authoring

This concepts guide discusses the motivation for various authoring activities.

Content and field locking

In a collaborative environment, many editors may be working simultaneously on the same item, which opens the possibility of one editor overwriting the edits of another editor. To prevent conflicting edits, Brightspot locks content in one of two ways:

  • Content locking locks content at the item level. When the first editor (locking editor) opens an item in the content edit form, all fields are locked to any other editors until the item is released by the locking editor.

  • Field-level locking locks only the fields modified by an editor, allowing other editors to modify other fields in the content edit form. The editor who locks a field first is the locking editor, preventing other editors from accessing the field. For example:

    Action

    Result

    Andy is modifying the headline

    Headline field is locked to Alice and Arthur

    Alice is modifying the image

    Image field is locked to Andy and Arthur

    Arthur is modifying tags

    Tags field is locked to Andy and Alice

Content locking

Content locking locks content at the item level. The message area indicates that the item is locked and by whom. When an item is locked, only the locking editor can change the item. If another editor belongs to a role with permission to unlock a locked item, then the lock message includes an option to remove the lock.

Lock message
Figure 32. Lock message


Lock message with option to unlock
Figure 33. Lock message with option to unlock


Brightspot allows editors to remove another editor's content lock after a period of inactivity. For details about configuring the duration of inactivity, see the table Global settings–Main tab.

Field-level locking

Field-level locking locks only the fields modified by an editor on a first-come, first-served basis. For example, Worf opens an article and makes an edit in the sub-headline field. At this point, Brightspot locks the sub-headline field in favor of Worf. When Alice opens the same article, she sees a highlighted avatar in the editorial toolbar, indicating that another editor, Worf, is also working on the same item.

disable-lock-icon.svg

Whoever modifies a field first is the locking editor for the field, preventing the other editor from modifying it. For example, Alice tabs into the sub-headline field, and sees that the field is locked by Worf.

Field-level locking with option to unlock
Figure 34. Field-level locking with option to unlock


When Worf saves or publishes the item, Brightspot releases the field lock, and Alice can then edit the sub-headline field.

If another editor belongs to a role with permission to unlock a field, then the lock message includes an option to override the field lock (see previous illustration).

Rich-text editor toolbars

Brightspot has a number of different rich-text editor toolbars that provide different options to editors. This topic describes what each toolbar offers.

Large rich-text editor toolbar

The large rich-text editor toolbar is the default configuration that includes all rich-text elements and typically exists as the body field in asset types like article or listicle.

The following features are available in the large rich-text editor toolbar:

  • Formatting: Includes bold, italics, underline, strikethrough, superscript, subscript, and clear formatting.

  • Alignment: Includes left, center, and right.

  • Lists: Includes bullets, numeric, right indent, and left indent.

  • Hyperlink: Supports internal or external links.

  • Block quote: Includes Text and Attribution fields.

  • Format: Supports subhead font size.

  • Embed: Supports embedding of either HTML or Iframe module inside the rich-text editor.

  • Pull quote: Includes Text and Attribution fields, both of which are tiny rich-text editors.

  • Attachment: Adds a shared attachment (like a document, spreadsheet, or presentation).

  • Media: Supports the inclusion of the following items in the rich-text editor:

    • Image: Adds a shared image. Includes Alt Text, Caption, and Credit fields.

    • Gallery: Includes Title Override tiny rich-text editor field and an Items field that determines which images appear. The Items field has the following options:

      • Basic: Adds shared or one-off images.

      • Advanced: Adds shared or one-off images and determine whether they appear in a list view or grid view.

      • Use Existing: Uses an existing gallery.

      • Dynamic: Uses a number of options to create a dynamically populated gallery, such as the following:

        • Items Per Page: Determines the number of items per page.

        • Sort: Can be sorted by Newest, Oldest, or by Relevance.

        • Pinned Items: Allows some images to be pinned. These images may be shared or added as one-off images. If shared, you may input Title, Alt Text, Caption, and Credit, the latter two of of which are represented by small rich-text editors. You may also choose whether pinned items are presented in a list view or a grid view.

        • Time Period: Limits the gallery to images published within a determined number of days.

        • Sites: Determines which sites the gallery can pull images from.

        • Include All Locales: Toggles on or off whether all languages are supported.

        • Tags: Includes tags whose associated images are included in the gallery.

    • List (Pages): Includes an existing list of pages in the rich-text editor.

    • Playlist: Includes an existing playlist in the rich-text editor.

    • Video: Includes an existing video in the rich-text editor. The following fields are available:

      • Title: Tiny rich-text editor that auto-populates with the title of the existing video, but you may overwrite this field.

      • Hide Title: Determines whether title is hidden from view.

      • Description: Small rich-text editor field that you can use to enter a description for the video.

      • Hide Description: Determines whether the description is hidden from view.

      • Thumbnail Image: Auto-populates with the thumbnail of the video. You can overwrite this image by selecting a shared image.

      • Poster Image: Auto-populates with the poster image of the video. You can overwrite this image by selecting a shared image.

    • Embed: Embeds a URL, and includes Maximum Width and Maximum Height fields.

  • Table: Inserts a table.

  • Custom Keyboard: Opens a custom keyboard with Unicode characters.

  • Track Changes: Toggles track changes on or off. If on, the following options appear in the rich-text editor: Accept Changes, Reject Changes, Accept All, Reject All, and Preview.

  • Comments: Toggles comment mode on or off. If toggled on, you may type comments into the rich-text editor, which will be visible on the back end but will not appear on front end.

  • Ellipsis: Hides comments in the rich-text editor.

  • X: Available when comments are toggled on. An undo button that deletes most recent comment added to the rich-text editor.

  • Left-facing arrow: Click to undo an action.

  • Right-facing arrow: Click to redo an action.

  • Magnifying Glass: Opens word search. Includes ellipsis that opens a replace function, enabling a find and replace function for words or phrases.

  • Square: Opens a full-screen rich-text editing interface.

Medium rich-text editor toolbar

The medium rich-text editor toolbar is a configuration that is used when enhancements are required, but more advanced tools like track changes, comments, and find and replace are not, like an author's full biography.

The following features are available in the medium rich-text editor toolbar.

  • Formatting: Includes bold, italics, underline, strikethrough, superscript, subscript, and clear formatting.

  • Alignment: Includes left, center, and right.

  • Lists: Includes bullets, numeric, right indent, and left indent.

  • Code: Toggles code mode on or off. If toggled on, you can type code into the rich-text editor, and it will be formatted as such in the front end.

  • Hyperlink: Supports internal or external links.

  • Block quote: Includes Text and Attribution fields.

  • Format: Supports subhead font size.

  • Embed: Supports embedding of either HTML or Iframe module inside the rich-text editor.

  • Pull quote: Includes Text and Attribution fields, both of which are tiny rich-text editors.

  • Attachment: Adds a shared attachment (like a document, spreadsheet, or presentation).

  • Media: Supports the inclusion of the following items in the rich-text editor:

    • Image: Adds a shared image. Includes Alt Text, Caption, and Credit fields.

    • Gallery: Includes Title Override tiny rich-text editor field and an Items field that determines which images appear. The Items field has the following options:

      • Basic: Adds shared or one-off images.

      • Advanced: Adds shared or one-off images and determine whether they appear in a list view or grid view.

      • Use Existing: Uses an existing gallery.

      • Dynamic: Uses a number of options to create a dynamically populated gallery, such as the following:

        • Items Per Page: Determines the number of items per page.

        • Sort: Can be sorted by Newest, Oldest, or by Relevance.

        • Pinned Items: Allows some images to be pinned. These images may be shared or added as one-off images. If shared, you may input Title, Alt Text, Caption, and Credit, the latter two of of which are represented by small rich-text editors. You may also choose whether pinned items are presented in a list view or a grid view.

        • Time Period: Limits the gallery to images published within a determined number of days.

        • Sites: Determines which sites the gallery can pull images from.

        • Include All Locales: Toggles on or off whether all languages are supported.

        • Tags: Includes tags whose associated images are included in the gallery.

    • List (Pages): Includes an existing list of pages in the rich-text editor.

    • Playlist: Includes an existing playlist in the rich-text editor.

    • Video: Includes an existing video in the rich-text editor. The following fields are available:

      • Title: Tiny rich-text editor that auto-populates with the title of the existing video, but you may overwrite this field.

      • Hide Title: Determines whether title is hidden from view.

      • Description: Small rich-text editor field that you can use to enter a description for the video.

      • Hide Description: Determines whether the description is hidden from view.

      • Thumbnail Image: Auto-populates with the thumbnail of the video. You can overwrite this image by selecting a shared image.

      • Poster Image: Auto-populates with the poster image of the video. You can overwrite this image by selecting a shared image.

    • Embed: Embeds a URL, and includes Maximum Width and Maximum Height fields.

  • Table: Inserts a table.

  • Custom Keyboard: Opens a custom keyboard with Unicode characters.

  • Square: Opens a full-screen rich-text editing interface.

Small rich-text editor toolbar

The small rich-text editor toolbar is a basic configuration of the rich-text editor toolbar and limits elements to formatting and in-line elements, like you may want in a caption or credit field for an image.

The following features are available in the small rich-text editor toolbar.

  • Formatting: Includes bold, italics, underline, strikethrough, superscript, subscript, and clear formatting.

  • Alignment: Includes left, center, and right.

  • Lists: Includes bullets, numeric, right indent, and left indent.

  • Code: Toggles code mode on or off. If toggled on, you can type code into the rich-text editor, and it will be formatted as such in the front end.

  • Hyperlink: Supports internal or external links.

  • Custom Keyboard: Opens a custom keyboard with Unicode characters.

  • Square: Opens a full-screen rich-text editing interface.

Tiny rich-text editor toolbar

The tiny rich-text editor toolbar is the most limited configuration of rich-text editor toolbars in Brightspot and is used for fields where only very basic formatting tools are required, like a title field.

The following features are available in the tiny rich-text editor toolbar.

  • Formatting: Includes bold, italics, underline, strikethrough, superscript, subscript, and clear formatting.

  • Custom Keyboard: Opens a custom keyboard with Unicode characters.

  • Square: Opens a full-screen rich-text editing interface.

Drafts

The first state of an asset is Draft. You can create multiple drafts for an asset before publication, compare the changes between two drafts, republish an asset based on a previous draft, and merge a later draft into an earlier one.

Revisions

After you publish an asset for the first time, every subsequent version of that asset is a revision. The Revisions widget lists your currently published and previous revisions.

Scheduling

You can schedule items to be published at a future date. This feature is useful if you are preparing a series of items for an upcoming holiday, and you want to publish them a week before the holiday starts.

Archiving, deleting, and restoring

Brightspot provides two operations for removing content: archiving and deleting.

  • Archiving: Visitors cannot view the content, but the content is still in Brightspot's database. You can restore archived content so that visitors can view it again. Archiving is a handy way to temporarily remove content from view to make changes to it.

  • Deleting: Permanently removes content from Brightspot's database, so you cannot restore it. In Brightspot, only assets that are already archived may be permanently deleted.

  • Restoring: Assets that are archived can re-enter one of two states—draft or live. If an asset has been archived with the intention to be edited, it may be restored to a draft state. Here, edits may be made, just as if the asset were a new draft, and then pushed back to a live state again.

Bulk actions

Using bulk actions, you can modify or archive multiple items simultaneously. For example, if you have several dozen images of a safari, you can assign an identical photo credit to all of them using a bulk edit.

URL behavior

Brightspot automatically generates URL permalinks for assets you create. Below is an explainer about how this behavior works.

By default, assets created in Brightspot get an auto-created permalink URL based on these rules:

  • For assets that have a URL Slug field (like Article or Listicle, for example), this will be read first in order to create the URL.

  • For assets without a URL Slug field (like Page or Tag), the URL will be automatically generated from the asset’s primary field (like Display Name).

Sections affect URLs a little differently.

  • If no section is added to an asset, the end of the URL is /asset-title.

  • If you assign a section to an asset, the URL is /section-name/asset-title.

  • You can create a section hierarchy, in which one section is the parent of another. The below example illustrates how this affects URLs.

    • Create section 1.

      • URL: /section-1

    • Create section 2, and assign section 1 as its parent.

      • URL: /section-1/section-2

    • Create section 3, and assign section 2 as its parent.

      • URL: /section-1/section-2/section-3

If you add the section at any point in the asset’s workflow before publishing, it will change the auto-generated URL; however, once you publish the asset, this will not happen, and it will retain the URL path that was already generated for it.

. See also: