Uploaded image for project: 'Moodle'
  1. Moodle
  2. MDL-69739

User tours: Add tour-level CSS selector

    XMLWordPrintable

    Details

    • Affected Branches:
      MOODLE_310_STABLE
    • Fixed Branches:
      MOODLE_310_STABLE
    • Pull from Repository:
    • Pull Master Branch:
      MDL-69739-master
    • Testing Instructions:
      Hide

      1. Log in as Admin
      2. Navigate to Site Administration > Appearance > User tours
      3. Click 'Create a new tour'
      4. Give the tour a name and tick the 'Tour is enabled' checkbox
      5. In the Tour filters section, fill in the 'CSS selector' text box with '#page-my-index'
      6. Save the changes
      7. Click on the name of your new tour
      8. Click the new step link
      9. Set Target type to 'Display in middle of page', and add a Title and Content
      10. Save the changes
      11. Navigate to Dashboard and you should see the tour
      12. Navigate to any other page and the tour should not appear

      Show
      1. Log in as Admin 2. Navigate to Site Administration > Appearance > User tours 3. Click 'Create a new tour' 4. Give the tour a name and tick the 'Tour is enabled' checkbox 5. In the Tour filters section, fill in the 'CSS selector' text box with '#page-my-index' 6. Save the changes 7. Click on the name of your new tour 8. Click the new step link 9. Set Target type to 'Display in middle of page', and add a Title and Content 10. Save the changes 11. Navigate to Dashboard and you should see the tour 12. Navigate to any other page and the tour should not appear

      Description

      To be able to have greater control of how user tours are enabled on websites, we need an additional level of control at the tour level so a tour can be made visible to only certain pages within a website, rather than all pages on the site, or any page on the website containing the specified URL for that tour. 
       
      This could be useful when needing a tour to display on a homepage of a website only (if homepage CSS exists), or if you have a tour about a particular interface component (for example you want a tour to start on a course home page but only if that interface is present).

       
      CSS selector is available at tour level as well as at individual step level, so a tour can be made visible on a website, or for a specified URL, and the tour will only start for users if the CSS criteria set (if option enabled) is matched.
       
      If the CSS criterion isn't matched, then the tour does not start and it is also not counted as 'done', i.e. if the user later visits another page where the CSS does match, the tour will start at that point.

        Attachments

          Issue Links

            Activity

              People

              Assignee:
              kransom Katie Ransom
              Reporter:
              kransom Katie Ransom
              Peer reviewer:
              Sam Marshall Sam Marshall
              Integrator:
              Andrew Lyons Andrew Lyons
              Tester:
              Janelle Barcega Janelle Barcega
              Participants:
              Component watchers:
              Andrew Lyons, Dongsheng Cai, Huong Nguyen, Jun Pataleta, Michael Hawkins, Shamim Rezaie, Simey Lameze
              Votes:
              1 Vote for this issue
              Watchers:
              8 Start watching this issue

                Dates

                Created:
                Updated:
                Resolved:
                Fix Release Date:
                9/Nov/20

                  Time Tracking

                  Estimated:
                  Original Estimate - 0 minutes
                  0m
                  Remaining:
                  Remaining Estimate - 0 minutes
                  0m
                  Logged:
                  Time Spent - 1 hour, 50 minutes
                  1h 50m