User tour settings
- 05 Jul 2023
- 1 minute to read
User tour settings
- Updated on 05 Jul 2023
- 1 minute to read
Article Summary
Share feedback
Thanks for sharing your feedback!
When adding or editing a user tour, you can configure the following settings.
| Setting | Description | Notes |
|---|---|---|
| Name | The name of the tour. This should be unique and descriptive. | - |
| Description | A brief description of the purpose of the tour. | - |
| Apply to URL match | Tours will be displayed on any page whose URL matches this value. You can use the % character as a wildcard to mean anything. Some example values include:
If you wish to display a tour on the site home page, you can use the value FRONTPAGE. | - |
| Tour is enabled | Tick to enable the user tour. | - |
| Placement | A step may be placed above, below, left or right of the target. Above or below is recommended, as these adjust better for mobile display. If the step does not fit on a particular page in the specified place, it will be automatically placed elsewhere. | - |
| Show if target not found | Show the step if the target could not be found on the page. | - |
| Show with backdrop | You can use a backdrop to highlight the part of the page that you are pointing to. | Backdrops are not compatible with some parts of the page, such as the navigation bar. |
| Proceed on click | Proceed to the next step when the target is clicked on. | - |
| Category | Show the tour on a page that is associated with a course in the selected category. | Requires Totara Learn. |
| Courses | Show the tour on a page that is associated with the selected course. | Requires Totara Learn. |
| Course format | Show the tour on a page that is associated with a course using the selected course format. | Requires Totara Learn. |
| Role | A tour may be restricted to users with selected roles in the context where the tour is shown. A dashboard tour can only be restricted to users with a system role. | - |
| Theme | Show the tour when the user is using one of the selected themes. | - |
© Copyright 2024 Totara Learning Solutions. All rights reserved. Some content originally obtained via GPLv3 license and continues to be available under GPLv3. All other content is the sole copyright of Totara Learning Solutions.
Was this article helpful?
