Custom content edit forms

You can create custom content edit forms and assign them to role-site combinations. For example, you can assign a content edit form so that the form applies to either all sites or to specific sites that are accessible to the Editorial role.

Hierarchy of Custom Content Edit Forms

Brightspot generates default content edit forms based on the fields in the underlying content type. For example, if an article has fields for headline, author, body, and image, the default content edit form for articles displays those four fields. Whenever you create a new article, you see the default content edit form.

You can display different versions of content edit forms based on an editor’s role or role-site combination. Referring to the following diagram, when creating a new article—

  • An editor not assigned to any role sees the form’s default version with four fields.
  • An editor assigned to the role Contributor sees the version with three fields.
  • An editor assigned to the role Contributor and working on the site aliens.com sees the version with two fields.
../../../_images/content-edit-form-hierarchy.svg

Default and custom content edit forms

The following sections describe how to create custom content edit forms and then assign them to roles and role-site combinations.

Creating custom content edit forms

You can create a customized content edit form for a particular content type, and then assign the form to a role or role-site combination. This feature is useful when you want to show or hide certain tabs or fields, or make some tabs or fields read-only, depending on a user’s role. For example, for articles, you can have one version of the content edit form without the Overrides tab for editors in the reporter role, and another version of the form that includes the Overrides tab for your proofreaders.

To create a custom content edit form:

  1. From the Navigation menu, select Admin > Users & Roles. The Content Forms widget appears on the left side of the page.

    ../../../_images/content-forms-widget.png
  2. From the drop-down list, select the content type for which you want to create a customized content edit form, and then click New. The New Content Form widget appears.

    ../../../_images/new-content-edit-form.png
  3. In the Name field, type a name for the form.

  4. From the Scope list, select one of the following:

    • None—The customized content form is the default for all roles to which it is assigned.
    • Global—The customized content form is the global default for all roles, replacing the one automatically generated by Brightspot.
  5. From the Accesses list, select read or write access for all tabs and fields on the form. (This setting applies to the entire form; you can override this setting at the tab and field levels in the following steps.)

  6. Show, hide, and reorder items by doing the following:

    • Hide a visible tab by dragging it to the Hidden Items list. (Don’t hide tabs containing fields that are required in the default content edit form.)
    • Show a hidden tab by dragging it to the Visible Items list.
    • Reorder the visible tabs by dragging them to the required position.
    • Change the placement of widgets on the content edit form (described below).
  7. To add a new tab to the form, do the following:

    1. Under Visible Items, click add_circle_outline and select Tab. A Tab form appears.
    2. In the Name field, type a name for the tab.
    3. From the Access list, and using the table Access options as a reference, select one of the access options.
    4. Repeat steps a–c to add additional tabs.
  8. To customize a tab and its fields, do the following:

    1. Click the tab field to expand it. A form appears with the tab’s name, access level, and fields.

      ../../../_images/content-form-tab-open.png
    2. In the Name field, type a name for the tab.

    3. From the Access list, and using the table Access options as a reference, select one of the access options.

    4. To hide a visible field, drag it to the Hidden Items list. (Don’t hide a field that is required in the default content edit form.)

    5. To show a hidden field, drag it to the Visible Items list.

    6. To reorder visible items, drag them to the required position.

    7. To change a field’s name or access level, do the following:

      1. Click the field. A form appears.

        ../../../_images/content-form-customize-field.png
      2. In the Name field, type a name for the field.

      3. From the Access list, and using the table Access options as a reference, select one of the access options.

    8. Group fields within the tab by doing the following:

      1. Under Clusters, click Add Group. A Group form appears.

        ../../../_images/content-form-add-group.png
      2. In the Name field, type a name for the group.

      3. From the Access list, and using the table Access options as a reference, select one of the access options.

      4. From the Fields list, drag fields into the group and in the desired order.

  9. To change the placement of a widget on the content edit form:

    1. Click the widget field to expand it.

    2. From the Placement list, select one of the placement options.

      ../../../_images/widget-placement-dropdown.png
  10. Click Save.

Brightspot saves the custom content edit form, and the form appears in the Content Forms widget. You can assign the form to a role or role-site combination; for details, see Assigning custom content edit forms to a role.

The following table describes the access options at the tab and field level.

Access options
Access option Tab level Group level Field level
Inherited Fields in the tab have the same read and write access as the default form for the content type. Fields in the group have the same read and write access as the containing tab. Field has the same read and write access as the containing group or tab.
Read Only Fields in the tab have read-only access. Fields in the group have read-only access. Field has read-only access.
Read & Write Fields in the tab have read and write access. Fields in the group have read and write access. Field has read and write access.

Modifying custom content edit forms

To edit a custom content edit form:

  1. From the Navigation menu, select Admin > Users & Roles. The Content Forms widget appears on the left side of the page.
  2. Click the form you want to modify. Brightspot displays the form in the Edit Content Form widget.
  3. Modify the form; see Creating custom content edit forms for details.

Deleting custom content edit forms

To delete a custom content edit form:

  1. From the Navigation menu, select Admin > Users & Roles. The Content Forms widget appears on the left side of the page.
  2. Click the form you want to delete. The Edit Content Form widget appears.
  3. Click Delete Permanently.

Assigning custom content edit forms to a role

Assigning a custom content edit form to a role makes that form the default for that role for that content type. Referring to the illustration Default and custom content edit forms, when you assign a three-field form to the role Contributor, all users with that role see that form when working on articles.

You can override a role’s default content edit form at the site level. For example, in the illustration Default and custom content edit forms, editors with the role Contributor working on the site aliens.com see the two-field form when working on articles.

To assign a custom content edit form to a role or role-site combination:

  1. From the Navigation menu, select Admin > Users & Roles. The Roles widget appears on the left side of the page.

    ../../../_images/roles-widget.png
  2. Click the role to which you want to assign the form. The Edit Tool Role widget appears.

  3. To assign a custom content edit form to a role, do the following:

    1. Under Main, click Types and select All Except. A form appears with Excluded Types and Restricted Types.

      ../../../_images/types-all-except.png
    2. Skip to step 7.

  4. To assign a custom content edit form to a role-site combination, under Main, under Site Specific Permissions, click add_circle_outline. A form appears.

    ../../../_images/site-specific-content-edit-form.png
  5. From the Sites list, select the sites with which you want to associate the custom content edit form.

  6. From the Types list, select All Except. A form appears with Excluded Types and Restricted Types.

  7. In Restricted Types, click add_circle_outline and select Content Type. A form appears.

    ../../../_images/content-form.png
  8. From the Types list, select a content type.

  9. From the Form list, select the customized content edit form associated with the content type you selected in step 8. (If your select Default, the role sees the default content edit form for the selected content type.)

  10. To restrict additional content types that apply to all sites, repeat steps 7–9.

  11. To restrict additional content types for specific sites, repeat steps 4–10.

  12. Click Save.

When you assign a custom content edit form to a role or role-site combination, or if you change the default content edit form, the form’s name appears in the Create list in the search panel and in the Quick Start widget. For example, you created a custom content edit form Simplified Article for the role Junior Editor. The junior editors see Simplified Article in the Quick Start widget, and other editors see Article.

../../../_images/quick-start-default-cef.svg ../../../_images/quick-start-custom-cef.svg