Syllabus Builder Documentation

Creating New Fields

Importance

The site administrator is responsible for configuring the fields that will be used by all instances of the Syllabus builder activity module. If the default fields are not sufficient, custom fields may be added to the template.

Location

The template for the Syllabus Builder activity module can be found by navigating to Site administration ► Plugins ► Activity modules ► Syllabus Builder, and by selecting the Fields tab.

Steps

Selecting "New custom field" from the Add Field drop-down will open the Add Field panel. which will contain the following fields:

  • Field name: The name of the field as it appears in the template, Note, depending on the field Type, the Field name may or may not be displayed on the syllabus for instructors and learners.
  • Type: Defines the type of field. Options include the following.
    • "Activities": Fields of this type will offer the ability to select one or more course activities to be displayed within the syllabus.
    • "Calendar Event": Fields of this type will offer the ability to select one or more calendar events to be displayed within the syllabus. Note, this only presents manually created course-level events.
    • "Header": This type acts as a label rather than a data entry field, and is useful to separate major sections of the syllabus. This type will not have the Required and Locked options available after being added to the syllabus template. The <.strong>Field name is not the text that will be displayed on the syllabus. This field has an additional Header Text field where the text to be displayed on the syllabus should be entered.
    • "Mapped": This type pulls and displays information directly from the course settings. When this type is selected, a Course Field drop-down will appear with the following choices, each of which is defined in the course settings:
      • "Course ID"
      • "Full name"
      • "Short name"
      • "ID number"
      • "Summary"
      • "Start date"

    • "Text": This field type is a one-line plain text entry field. When selected a Default Entry field will become available where the site administrator can enter text to be displayed by default.
    • "Long Text": This field type provides a full HTML text editor as the field for text, image, or media entry. When selected a Default Entry field will become available where the site administrator can enter text, images, or media to be displayed by default.

Once a new field has been created, the syllabus template must still be saved and published to be viewable by users. To commit any newly created fields to the server, select Save changes at the bottom of the screen.

Important Note

Custom fields added to the template will be denoted with an asterisk visible only to the site administrator. This is to distinguish custom fields from the default fields available on the syllabus template. If a default field is deleted from the template, it may be re-added to the template by selecting the default field's name from the Add Field drop-down.