Catalogue: Difference between revisions

From MoodleDocs
No edit summary
No edit summary
Line 36: Line 36:
** '''User-defined course fields filter''': If any of the shown results contain any course user-defined course fields, these will be available for selection. If more than 5 fields are available, a '''Show more''' link lets users display all course fields. In the screenshot above, the Level attribute is a user-defined course field.
** '''User-defined course fields filter''': If any of the shown results contain any course user-defined course fields, these will be available for selection. If more than 5 fields are available, a '''Show more''' link lets users display all course fields. In the screenshot above, the Level attribute is a user-defined course field.


The filters available to users and the order in which they are arranged can be specified in the <mark>catalogue configuration</mark>.
The filters available to users and the order in which they are arranged can be specified in filter section of the [[Catalogue#Fields to display in the learning catalogue filter|catalogue configuration]].


== Course cards ==
== Course cards ==
Course cards show details about each course. While course cards on the main page look slightly different from course cards on the results page, they can both show the same fields. The attributes displayed, depend on the <mark>catalogue configuration</mark> and can differ for each course card type.
Course cards show details about each course. While course cards on the main page look slightly different from course cards on the results page, they can both show the same fields. The attributes displayed, depend on the [[Catalogue#Fields to display in the 'list' (detailed) view of learning catalogue|catalogue configuration]] and can differ for each course card type.


The screenshot below shows an annotated course card from the main page.
The screenshot below shows an annotated course card from the main page.
Line 63: Line 63:
| colspan="1" rowspan="1" |Course settings → Course summary
| colspan="1" rowspan="1" |Course settings → Course summary


The max. length can be specified via the '''Truncate course summary''' setting in the <mark>Learning catalogue settings</mark>.
The max. length can be specified via the '''Truncate course summary''' setting in the [[Catalogue#Learning catalogue settings|Learning catalogue settings.]]
|-
|-
| colspan="1" rowspan="1" |'''Course tags'''
| colspan="1" rowspan="1" |'''Course tags'''
Line 117: Line 117:


# '''Learning catalogue settings''': Generic settings impacting the entire catalogue
# '''Learning catalogue settings''': Generic settings impacting the entire catalogue
# '''Fields to display in the 'tiles' (compact) view <mark>of learning catalogue</mark>''': Fields shown on the main page
# '''Fields to display in the 'tiles' (compact) view''' '''of learning catalogue''': Fields shown on the main page
# '''Fields to display in the 'list' (detailed) view <mark>of learning catalogue</mark>''': Fields shown on the results page
# '''Fields to display in the 'list' (detailed) view of learning catalogue''': Fields shown on the results page
# '''Fields to display in the learning catalogue filter''': Fields shown in the filter pane
# '''Fields to display in the learning catalogue filter''': Fields shown in the filter pane


Line 128: Line 128:


* '''Enable learning catalogue''': see dedicated section above
* '''Enable learning catalogue''': see dedicated section above
* '''Number of courses per page, site home page''': Maximum number of courses shown on the <mark>public learning catalogue</mark>. If the number exceeds the number of courses to be shown, the page navigator will be made available.
* '''Number of courses per page, site home page''': Maximum number of courses shown on the [[Catalogue#Making the Learning Catalogue Public|public learning catalogue]]. If the number exceeds the number of courses to be shown, the page navigator will be made available.
* '''Number of courses per page, main catalogue page''': Maximum number of courses shown on the main page. If the number exceeds the number of courses to be shown, the page navigator will be made available.
* '''Number of courses per page, main catalogue page''': Maximum number of courses shown on the main page. If the number exceeds the number of courses to be shown, the page navigator will be made available.
* '''Number of courses per page, search results''': Maximum number of courses shown on the results page. If the number exceeds the number of courses to be shown, the page navigator will be made available.
* '''Number of courses per page, search results''': Maximum number of courses shown on the results page. If the number exceeds the number of courses to be shown, the page navigator will be made available.
Line 135: Line 135:
* '''Safe HTML tags in summary and text fields''': List of the HTML tags that will be kept when displaying text fields (course summary and course custom fields). This might conflict with “'''Truncate course summary'''”.
* '''Safe HTML tags in summary and text fields''': List of the HTML tags that will be kept when displaying text fields (course summary and course custom fields). This might conflict with “'''Truncate course summary'''”.
* '''Truncate course summary''': Number of characters shown in the course summary. This might conflict with “'''Safe HTML tags in summary and text fields'''”. Set 0 for no truncation.
* '''Truncate course summary''': Number of characters shown in the course summary. This might conflict with “'''Safe HTML tags in summary and text fields'''”. Set 0 for no truncation.
* '''<mark>Course search method</mark>''': The '''Simple Search''' option will only search for fullname, shortname and course summary, whereas '''Extended Search''' will also include course content.
* '''Course search method:''' The '''Simple Search''' option will only search for fullname, shortname and course summary, whereas '''Extended Search''' will also include course content.


{| class="wikitable"
{| class="wikitable"
Line 170: Line 170:
| colspan="1" rowspan="1" |super fast  
| colspan="1" rowspan="1" |super fast  
|}
|}
Note: when you switch from Simple search to Extended search, you need to save changes before the '''<mark>Fields to search for keywords</mark>''' section will be shown.
Note: when you switch from Simple search to Extended search, you need to save changes before the '''[[Catalogue#Fields to search for keywords|Fields to search for keywords]]''' section will be shown.


=== <mark>Fields to display in the 'tiles' (compact) view of learning catalogue</mark> ===
=== Fields to display in the 'tiles' (compact) view of the learning catalogue ===
In this section, you can configure which fields are shown in cards on the catalogue’s main page. There are two types of fields you can select:
In this section, you can configure which fields are shown in cards on the catalogue’s main page. There are two types of fields you can select:


Line 193: Line 193:
* Level: Another custom field
* Level: Another custom field


=== Fields to display in the 'list' (detailed) view of learning catalogue ===
=== Fields to display in the 'list' (detailed) view of the learning catalogue ===
In this section, you can configure which fields are shown in cards on the catalogue’s results page. The fields available for selection and the rules and restrictions that apply are the same as for the configuration of the compact view.
In this section, you can configure which fields are shown in cards on the catalogue’s results page. The fields available for selection and the rules and restrictions that apply are the same as for the configuration of the compact view.


Line 201: Line 201:
The following fields are available:
The following fields are available:


# '''<mark>Subcategory</mark>''': If the selected category contains subcategories, these will be shown in the filter pane.
# '''Subcategories''': If the selected category contains subcategories, these will be shown in the filter pane.
# '''Tags''': If <mark>course tags</mark> have been configured, these will be shown in the filter pane.
# '''Tags''': If [[Tags|course tags]] have been configured, these will be shown in the filter pane.
# '''Custom fields (optional)''': Any <mark>custom course fields</mark> of type Drop-down will appear in the filter pane.
# '''Custom fields (optional)''': Any [[Course settings#Course custom fields|course custom fields]] of type Drop-down will appear in the filter pane.


In the example below, ''Level'' is a custom course field with configured menu options ''Beginner'', ''Intermediate'', ''Advanced''.
In the example below, ''Level'' is a custom course field with configured menu options ''Beginner'', ''Intermediate'', ''Advanced''.

Revision as of 06:14, 27 April 2024

Learning Catalogue Overview

The learning catalogue contains all courses available in your Moodle Workplace tenant. It can be accessed via the top-level Catalogue menu item or directly via https://<site>/course.

The catalogue comprises of two different pages:

  1. Main page This is the main view when navigating to the catalogue. It shows all courses available to the current user.
  2. Results page The results are shown once a category has been selected or a search has been executed. The filter sidebar, if configured, displayed on the left, lets you narrow down the course search.

Learning catalogue main page

The following is an annotated view of the learning catalogue’s main page:

Learning Catalogue - Main Page.png
  • The category selector lets you choose a single category or sub-category. Once selected, the results page will be displayed. The number of category levels shown can be specified in the learning catalogue settings.
  • The catalogue search lets you narrow down the search using Moodle’s standard search operators. Once executed, the results page will be displayed.
  • The course cards show details about each course. The attributes displayed, depend on the the learning catalogue settings.

If the number of courses exceeds the number specified in the the learning catalogue settings, the page navigation is shown at the bottom of the catalogue.

Learning Catalogue - Navigation.png

Learning catalogue results page

The results page is shown if one of the following two actions has been carried out:

  • A search has been executed using the catalogue search
  • A category or sub-category has been selected

The following is an annotated view of the learning catalogue’s results page:

Learning Catalogue - Results Page.png
  • The category selector lets you choose a single category or sub-category. Once selected, the results page will be refreshed.
  • The catalogue search lets you narrow down the search using Moodle’s standard search operators. Once executed, the results page will be displayed.
  • The course cards show details about each course. The attributes shown, depend on the learning catalogue settings.
  • The filter lets you narrow down the shown results further. There are up to three types of filters that will be displayed:
    • Subcategory filter: If the shown courses are spread across multiple courses or the selected category contains sub-categories, these will be available for selection. If more than 5 subcategories are available, a Show more link lets users display all categories.
    • Tags filter: If any of the shown results contain any course tags, these will be available for selection. If more than 5 tags are available, a Show more link lets users display all tags.
    • User-defined course fields filter: If any of the shown results contain any course user-defined course fields, these will be available for selection. If more than 5 fields are available, a Show more link lets users display all course fields. In the screenshot above, the Level attribute is a user-defined course field.

The filters available to users and the order in which they are arranged can be specified in filter section of the catalogue configuration.

Course cards

Course cards show details about each course. While course cards on the main page look slightly different from course cards on the results page, they can both show the same fields. The attributes displayed, depend on the catalogue configuration and can differ for each course card type.

The screenshot below shows an annotated course card from the main page.

Learning Catalogue - Course card I.png


The same course card on the results page looks as follows:

Learning Catalogue - Course card II.png


The following fields are available on course cards:

Field Source and description
Course image Course settings → Course image
Course title Course settings → Course full name
Course description Course settings → Course summary

The max. length can be specified via the Truncate course summary setting in the Learning catalogue settings.

Course tags Course settings → Tags
Course contact All course users with the XXX capability, by default the Trainer role.
Course category Course settings → Course category
Course start date Course settings → Course start date
Course end date Course settings → Course end date

If the setting is disabled, the field will be hidden.

Course custom fields Course settings → <fields>

These field have to be specified in Learning > Default settings > Course custom fields.

Programs Course settings → Programs

List of program(s) that this course belongs to. They can be linked to the relevant program(s).

Note: If a course belongs to a program, the course is not listed automatically; it has to be specified in the course settings.

Price Course settings → Price

A custom course field with the name price has to be specified in Learning > Default settings > Course custom fields. Its field type has be ‘Short text’.

The configuration of these fields, for instance in which order they will appear, takes place in the Catalogue settings.

Enabling / Disabling the Learning Catalogue

The learning catalogue is disabled by default. To change this setting, navigate to Learning > Learning catalogue settings and tick the Enable learning catalogue option.

Learning Catalogue - Enable.png


Alternatively, you can permanently enable the learning catalogue by adding the following setting to your config.php:

$CFG->tool_catalogue = true;

Once the learning catalogue has been enabled, administrators can access its configuration from the Workplace Launcher via the catalogue icon.

Catalogue Settings

To configure the learning catalogue, navigate to Learning > Default settings > Learning catalogue settings where you will find the following sections:

  1. Learning catalogue settings: Generic settings impacting the entire catalogue
  2. Fields to display in the 'tiles' (compact) view of learning catalogue: Fields shown on the main page
  3. Fields to display in the 'list' (detailed) view of learning catalogue: Fields shown on the results page
  4. Fields to display in the learning catalogue filter: Fields shown in the filter pane

The four areas are described in detail in the following subsections:

Learning catalogue settings

The following options are available in the learning catalogue settings:

Learning catalogue settings I.png
  • Enable learning catalogue: see dedicated section above
  • Number of courses per page, site home page: Maximum number of courses shown on the public learning catalogue. If the number exceeds the number of courses to be shown, the page navigator will be made available.
  • Number of courses per page, main catalogue page: Maximum number of courses shown on the main page. If the number exceeds the number of courses to be shown, the page navigator will be made available.
  • Number of courses per page, search results: Maximum number of courses shown on the results page. If the number exceeds the number of courses to be shown, the page navigator will be made available.
  • Maximum number of same-level categories: Specifies the maximum number of same-level categories shown in the category selector. Categories will be displayed in the same order as they have been defined in the course management page. Categories exceeding this maximum number will be hidden, but courses will appear in the search results.
  • Maximum number of nested category levels: Specifies the maximum number of nested category levels in the category selector. Categories below this level will be hidden, but courses will appear in the search results.
  • Safe HTML tags in summary and text fields: List of the HTML tags that will be kept when displaying text fields (course summary and course custom fields). This might conflict with “Truncate course summary”.
  • Truncate course summary: Number of characters shown in the course summary. This might conflict with “Safe HTML tags in summary and text fields”. Set 0 for no truncation.
  • Course search method: The Simple Search option will only search for fullname, shortname and course summary, whereas Extended Search will also include course content.
Simple Search Extended Search
Case-sensitivity no yes
Support for wildcards (% and _) yes yes
Requires cron process no yes
Uses index no (on-the-fly search) yes (must be built before first use)
Supports field selection no yes
Supports field prioritisation no yes
Performance fast super fast

Note: when you switch from Simple search to Extended search, you need to save changes before the Fields to search for keywords section will be shown.

Fields to display in the 'tiles' (compact) view of the learning catalogue

In this section, you can configure which fields are shown in cards on the catalogue’s main page. There are two types of fields you can select:

  1. Built-in course fields: Standard course fields, namely Course summary, Course category, Tags, Start date, and End date.
  2. Course custom fields: Fields which have been added via Learning > Default settings > Course custom fields. If the visibility of a field is set to Trainers or Nobody, the field can still be shown in the learning catalogue. However, a warning icon is displayed in the configuration, indicating that “This field has restricted visibility on the course information and enrolment pages, however it can still be made available in the learning catalogue. If enabled here, the field will be visible to everybody.”

Any fields of type Text area, whether built-in or custom, have an additional setting Allow HTML tags with the options Only safe HTML tags (default), Allow any HTML tags (no filtering), and Strip all HTML tags (full filtering).

The order of the fields shown in the compact view can be arranged via the up and down arrows in the Order column.

Learning catalogue settings II.png


In the sample configuration shown, seven fields have been configured as follows:

  • Price: Custom field, indicating the cost of the course
  • Tags: Built-in field, showing any course tags
  • Start date: Built-in field, showing when the course begins
  • End date: Built-in field, showing when the course ends (will be hidden, if the field is not set)
  • Estimated learning time: Custom field with a warning, since its visibility is not set to Everyone
  • Level: Another custom field

Fields to display in the 'list' (detailed) view of the learning catalogue

In this section, you can configure which fields are shown in cards on the catalogue’s results page. The fields available for selection and the rules and restrictions that apply are the same as for the configuration of the compact view.

Fields to display in the learning catalogue filter

You can select any available fields that should be displayed as filters in the catalogue and arrange them in the appropriate order.

The following fields are available:

  1. Subcategories: If the selected category contains subcategories, these will be shown in the filter pane.
  2. Tags: If course tags have been configured, these will be shown in the filter pane.
  3. Custom fields (optional): Any course custom fields of type Drop-down will appear in the filter pane.

In the example below, Level is a custom course field with configured menu options Beginner, Intermediate, Advanced.

Learning catalogue settings III.png

Fields to search for keywords

When the Course search method has been set to Extended search, you can specify which course fields should be included in the search and arrange them in the order of priority. After changing the configuration, the search index has to be rebuilt, which takes place in the background (via cron) and might take some time to show the expected results.

Learning catalogue settings IV.png

Making the Learning Catalogue Public

By default, the learning catalogue is only available to logged in users. To make the catalogue public, that is, to make it accessible to users not logged in to your Moodle Workplace site, configure the following settings:

  1. Show courses on the Frontpage Go to General > Site home > Site home page and add "List of courses" to the Site home setting ($CFG->frontpage).
  2. Disable Force Login Ensure that the Force users to log in setting in General > Security > Site security settings is disabled ($CFG->forcelogin).
  3. Allow viewing of course categories and courses Go to Users > Permissions > Define roles. Select the Guest role and enable the capability to browse the list of courses (moodle/category:viewcourselist). Repeat the same step for the Authenticated user role.

Once these steps have been completed, your learning catalogue will be available online. However, to view course details or enrol on a course, users have to be logged in to your site.

The Learning Catalogue and Multi-tenancy

The learning catalogue shows all courses available to the user.

Additionally, courses that are part of programs or certifications in the shared space which have been allocated to the user, will also be shown.