Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

The top navigation menu can be customized. Once customized, the default menu installed with your system will no longer be applicableIt's very important to understand however that once you customize it, any further modifications that Dual Code may make to the menu will no longer apply to your system. In other words, if Dual Code releases a new report for Supervisors and adds it to the "My Team" section of the top menu, this link will appear for learning environment that use the default menu, but it will not appear automatically if you're customized the menu

Step-by-step Guide

To customize the menu:

  1. Go to Site Administration > Appearance > Themes > English (or French) > Settings
  2. Go to the "Other" tab
  3. Define your own custom menu (see the "Structure of the Menu Entries" below).
  4. Click on the "Save changes" button at the bottom of the page
Excerpt

Structure of the Menu Entries

Each line consists of required and optional parameters separated by the pipe “|” character. The parameters include:

  • The menu text
  • A link URL (optional)
  • A tooltip title (optional)
  • A language code (en or fr_ca) or comma-separated list of both codes for displaying the menu entry to users of the specified language only (optional)
  • A capability or comma-separated list of capabilities for displaying the menu entry to users with the specified system capability only (optional).

Following is an example of a menu entry with all available options.

FAQ|/our-lms-faq |FAQ|en|local/dualcode:authenticated

In this example, a menu entry named "FAQ" will display HTML page called “our-lms-faq” when the site is viewed in English and the user is logged in.

Creating Submenus

Submenu entries are created by putting a dash “-“ at the start of the line. For example:

FAQ
-Standard Topics|/standard_topics
-Special Topics|/special_topics


In this case, FAQ would be the main menu entry and “Standard Topics” and “Special Topics” would appear in the drop-down menu when you click FAQ. 

Restricting Access to a Menu

Custom menus items will be visible to all users, including users who haven't logged in, unless you restrict access to them by specifying required capabilities.

A common requirement is to show different menus to authenticated users and non-authenticated users.  To facilitate this requirement, you should be aware of the following common capabilities:

User Group

Menu Option

Logged in users only

local/dualcode:authenticated

Users with supervisor capabilities (e.g. VPs, directors, supervisors)

moodle/site:viewreports

Everyone

no option is required

Note:

  • When a custom menu item is associated with local/dualcode:authenticated, users will need to log into the system to see it.  
  • Any capability in the system can be used to restrict access to a menu item as long as it's assigned to a user in the context of the system.  For an exhaustive list of capabilities, see https://docs.moodle.org/39/en/Category:Capabilities

Creating Submenus

Submenu entries are created by putting a dash “-“ at the start of the line. For example:

FAQ
-Standard Topics|/standard_topics
-Special Topics|/special_topics

...

Capability

Everyone (including users who are not yet logged in)

No option is required to show a menu item to everyone

All logged in users

local/dualcode:authenticated

System Administrators

local/serverhealth:view

Supervisors & System Administrators

moodle/site:viewreports


Default Menu

The following is the default menu installed on your system as a reference. Note that this menu may vary depending on your version of the software.

Course Catalogue|#|Course Catalogue|en
-By title (A to Z)|/local/coursecatalog/index.php?catalog=1|By title (A to Z)|en
-By themetopic|/local/coursecatalog/index.php?catalog=2|By themetopic|en
-By deliveryformat|/local/coursecatalog/index.php?catalog=3|By deliveryformat|en
-By date|/local/coursecatalog/index.php?catalog=4|By date|en
-By keyword|/local/coursecatalog/index.php?catalog=5|By keyword|en
-OCI Marketplace|/local/oci/marketplace.php|OCI Marketplace|en|local/ocihub:view

Catalogue de cours|#|Catalogue de cours|fr_ca
-Par titre (A à Z)|/local/coursecatalog/index.php?catalog=1|Par titre (A à Z)|fr_ca
-Par sujet|/local/coursecatalog/index.php?catalog=2|Par sujet|fr_ca
-Par modalité|/local/coursecatalog/index.php?catalog=3|Par modalité|fr_ca
-Par date|/local/coursecatalog/index.php?catalog=4|Par date|fr_ca
-Par mot clé|/local/coursecatalog/index.php?catalog=5|Par mot clé|fr_ca
-Marché OCI|/local/oci:viewmarketplaceMy Progress/marketplace.php|Marché OCI|fr_ca|local/ocihub:view

Compliance Overview|/local/program/progressreport.php|My ProgressCompliance Overview|en|local/dualcode:authenticated

Aperçu de la conformité|/local/program/progressreport.php|Aperçu de la conformité|fr_ca|local/dualcode:authenticated

[[mycourses]]

My Team|#|My Team|en|report/coursescompliance:viewreportview
-Compliance Summary|/report/compliance/summary.php|Compliance Summary|en|report/compliance:view
-Program Completion|/local/program/report.php|Program Completion|en|report/courses:viewreport
-Learning Records|/report/lrsdata/index.php|Learning Records|en|local/lrsdata:view
-Performance Appraisals|/local/appraisal/appraisal/index.php|Performance Appraisals|en|local/appraisal:appraiseusers
-Epic Systems|#|Epic Systems|en|local/epic:view
--Training Tracks > Registrations|/report/epic_trainingtracks/report.php|Registrations|en|report/epic_trainingtracks:view
--Training Tracks > Change Requests|/report/epic_trainingtracks/requests.php|Change Requests|en|report/epic_trainingtracks:managerequests
-Program Completion|/--Completion|/report/epic_completion/index.php|Completion|en|report/epic_completion:view
--Class Registration Rates|/report/epic_registrationrate/index.php|Class Registration Rates|en|report/epic_registrationrate:view


Mon équipe|#|Mon équipe|fr_ca|report/compliance:view
-Sommaire de la conformité|/report/compliance/summary.php|Sommaire de la conformité|fr_ca|report/compliance:view
-Achèvement des programmes|/local/program/report.php|Program Completion|enAchèvement des programmes|fr_ca|report/courses:viewreport
-Records d'apprentissages|/report/lrsdata/index.php|Records d'apprentissages|fr_ca|local/lrsdata:view
-Évaluations du rendement|/local/appraisal/appraisal/index.php|Évaluations du rendement|fr_ca|local/appraisal:appraiseusers
-Epic Systems|#|Epic Systems|fr_ca|local/epic:view
--Programmes > Enregistrements|/report/epic_trainingtracks/report.php|Enregistrements|fr_ca|report/epic_trainingtracks:view
--Programmes > Requêtes de changements|/report/epic_trainingtracks/requests.php|Requêtes de changements|fr_ca|report/epic_trainingtracks:managerequests
--Achèvement|/report/epic_completion/index.php|Achèvement|fr_ca|report/epic_completion:view
--Taux d'enregistrement des classes|/report/epic_registrationrate/index.php|Taux d'enregistrement des classes|fr_ca|report/epic_registrationrate:view

Contact Us|/contactus|Contact Us|en
FAQNous joindre|/faqcontactus|FAQ|en|moodle/site:uploadcoursesNous joindre|fr_ca