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

Moodle Tour/Walkthough/Instructional overlays for first time user on page (User tours)

    XMLWordPrintable

    Details

    • Testing Instructions:
      Hide
      Basic Functionality test
      1. Navigate to Site administration -> Appearance -> User Tours
      2. Create a new tour
      3. Apply it to /course/view.php%
      4. Create some steps - some visible, some for items not on the page and a mixture of blocks, CSS selectors, and Display in middle of page
      5. View a course page
        1. Confirm the tour works as expected
      6. Click the End Tour link
        1. Confirm that the Tour disappears
      7. Click the reset tour link in the footer
        1. Confirm that the tour restarts
      8. Refresh the page
        1. Confirm that the tour appears again
      9. Do not click the "End tour" button...
      10. View another page
        1. Confirm the tour doesn't display there
        2. Confirm that there is no "Reset user tour on this page" link for the tour in the footer
      11. Go back to the course view page
        1. Confirm that the tour appears again
      12. Click the End tour link
        1. Confirm that the Tour disappears
      13. Refresh the page
        1. Confirm that the tour does not appear again
      14. Navigate to Site administration -> Appearance -> User Tours
      15. Click on the name of the tour
      16. Select the "Force the tour to be displayed" link in the top section
      17. Go back to the course view page
        1. Confirm that the tour appears again
      Filter test
      1. Login as admin
      2. Navigate to Site administration -> Appearance -> User Tours
      3. Open the tour settings for the tour you created in the previous test
      4. Under the theme filter, select the theme you're currently using (Probably Boost or Clean)
      5. Save changes
      6. Open a second browser and login as a student
      7. View a Course
        1. Confirm that the tour is displayed - Do NOT end the tour
      8. Refresh the page
        1. Confirm that the tour is displayed - Do NOT end the tour
      9. Change your theme to a different theme (e.g. config.php)
      10. Refresh the Course
        1. Confirm that the tour is not displayed
        2. Confirm that there is no "Reset user tour on this page" link in the footer
      11. As admin change the theme filter to cover the current theme, and the previous theme (2 themes should now be selected)
      12. As student, Refresh the Course
        1. Confirm that the tour is displayed - Do NOT end the tour
      13. As admin, change the theme fitler to cover only the new theme, and another theme (e.g. More) but not the original theme
      14. As student, Refresh the Course
        1. Confirm that the tour is displayed - Do NOT end the tour
      15. Open a third browser, login as an editing teacher, and view the course
        1. Confirm that the tour is displayed - Do NOT end the tour
      16. As admin, set another filter so that the only Students see the tour and save changes
      17. As student:
        1. Confirm that the tour is displayed
      18. As teacher:
        1. Confirm that the tour is not displayed
      19. As admin, modify the filter so that students and editing teachers can view the tour
      20. As student:
        1. Confirm that the tour is displayed
      21. As teacher:
        1. Confirm that the tour is displayed
      22. As admin, modify the filter so that only editing teachers and non-editing teachers can view the tour
      23. As student:
        1. Confirm that the tour is not displayed
      24. As teacher:
        1. Confirm that the tour is displayed
      Import/Export test
      1. Navigate to Site administration -> Appearance -> User Tours
      2. Click on the tour export link for the tour you created in the previous test
        1. Confirm that the tour was exported without error
      3. Pass the file through a JSON linter (e.g. http://jsonlint.com/)
      4. Import the tour back again
        1. Confirm that there are now two tours
      5. Compare the tours - there should be no differences. key points to check:
        1. Tour defaults are correct
        2. Tour filters are correct
        3. Step settings are correct
      6. Delete the original tour
      Other things to test
      1. Use multilang content in a tour title and body (don't forget to apply enabel the Multilang filter at the site and course level)
      2. Try each of the settings for a tour at both tour and step level and ensure that they work as expected - e.g. orphan, moveonclick, etc.
        (Remember: The Display in middle of page target type ignores some of these because they don't makes sense for it)
      3. Check that events are created for each tour start, step view, tour end, and tour reset
      Upgrade test
      1. Install a new 31 site
      2. Install the latest version of the plugin from the plugins DB
      3. Add some tours
      4. Upgrade to master (with the plugin present)
      5. Run upgrade script
        1. Confirm that tours were moved over
      Upgrade from an old version
      1. Install a new 31 site
      2. Install an old version of the plugin (https://github.com/andrewnicols/moodle-local_usertours/archive/v2016052301.zip)
      3. Add some tours
      4. Upgrade to master (with the plugin present)
      5. Run upgrade script
        1. Confirm that tours were moved over
        2. Confirm that tours have the correct description set against them still
      Pending upgrade test
      1. Create a tour which will run on a known page and confirm that it works
      2. Bump the version of the tour on disk, but do not perform the upgrade
      3. Refresh that page
        1. Confirm that the tour is not started, and no link is added to the footer
      Show
      Basic Functionality test Navigate to Site administration -> Appearance -> User Tours Create a new tour Apply it to /course/view.php% Create some steps - some visible, some for items not on the page and a mixture of blocks, CSS selectors, and Display in middle of page View a course page Confirm the tour works as expected Click the End Tour link Confirm that the Tour disappears Click the reset tour link in the footer Confirm that the tour restarts Refresh the page Confirm that the tour appears again Do not click the "End tour" button... View another page Confirm the tour doesn't display there Confirm that there is no "Reset user tour on this page" link for the tour in the footer Go back to the course view page Confirm that the tour appears again Click the End tour link Confirm that the Tour disappears Refresh the page Confirm that the tour does not appear again Navigate to Site administration -> Appearance -> User Tours Click on the name of the tour Select the "Force the tour to be displayed" link in the top section Go back to the course view page Confirm that the tour appears again Filter test Login as admin Navigate to Site administration -> Appearance -> User Tours Open the tour settings for the tour you created in the previous test Under the theme filter, select the theme you're currently using (Probably Boost or Clean) Save changes Open a second browser and login as a student View a Course Confirm that the tour is displayed - Do NOT end the tour Refresh the page Confirm that the tour is displayed - Do NOT end the tour Change your theme to a different theme (e.g. config.php) Refresh the Course Confirm that the tour is not displayed Confirm that there is no "Reset user tour on this page" link in the footer As admin change the theme filter to cover the current theme, and the previous theme (2 themes should now be selected) As student, Refresh the Course Confirm that the tour is displayed - Do NOT end the tour As admin, change the theme fitler to cover only the new theme, and another theme (e.g. More) but not the original theme As student, Refresh the Course Confirm that the tour is displayed - Do NOT end the tour Open a third browser, login as an editing teacher, and view the course Confirm that the tour is displayed - Do NOT end the tour As admin, set another filter so that the only Students see the tour and save changes As student: Confirm that the tour is displayed As teacher: Confirm that the tour is not displayed As admin, modify the filter so that students and editing teachers can view the tour As student: Confirm that the tour is displayed As teacher: Confirm that the tour is displayed As admin, modify the filter so that only editing teachers and non-editing teachers can view the tour As student: Confirm that the tour is not displayed As teacher: Confirm that the tour is displayed Import/Export test Navigate to Site administration -> Appearance -> User Tours Click on the tour export link for the tour you created in the previous test Confirm that the tour was exported without error Pass the file through a JSON linter (e.g. http://jsonlint.com/ ) Import the tour back again Confirm that there are now two tours Compare the tours - there should be no differences. key points to check: Tour defaults are correct Tour filters are correct Step settings are correct Delete the original tour Other things to test Use multilang content in a tour title and body (don't forget to apply enabel the Multilang filter at the site and course level) Try each of the settings for a tour at both tour and step level and ensure that they work as expected - e.g. orphan, moveonclick, etc. (Remember: The Display in middle of page target type ignores some of these because they don't makes sense for it) Check that events are created for each tour start, step view, tour end, and tour reset Upgrade test Install a new 31 site Install the latest version of the plugin from the plugins DB Add some tours Upgrade to master (with the plugin present) Run upgrade script Confirm that tours were moved over Upgrade from an old version Install a new 31 site Install an old version of the plugin ( https://github.com/andrewnicols/moodle-local_usertours/archive/v2016052301.zip ) Add some tours Upgrade to master (with the plugin present) Run upgrade script Confirm that tours were moved over Confirm that tours have the correct description set against them still Pending upgrade test Create a tour which will run on a known page and confirm that it works Bump the version of the tour on disk, but do not perform the upgrade Refresh that page Confirm that the tour is not started, and no link is added to the footer
    • Affected Branches:
      MOODLE_30_STABLE, MOODLE_31_STABLE
    • Fixed Branches:
      MOODLE_32_STABLE
    • Epic Link:
    • Pull from Repository:
    • Pull Master Branch:
      MDL-52777-master
    • Pull Master Diff URL:

      Description

      There are quite a number of Tour/walkthough frameworks which can be used out-of-box to introduce new users to Moodle pages.

      Currently it is hard of non-computer savy user to start using Moodle and being LMS Moodle should make it easy for people to understand how contents are placed on the page.

      Some of the frameworks which can be used

      1. http://bootstraptour.com/
      2. http://usablica.github.io/intro.js/

        Attachments

        1. Screen Shot 2016-10-19 at 16.19.07.png
          Screen Shot 2016-10-19 at 16.19.07.png
          72 kB
        2. Screen Shot 2016-10-19 at 16.19.12.png
          Screen Shot 2016-10-19 at 16.19.12.png
          71 kB
        3. tour_export_dashboard.json
          6 kB
        4. tours-double-dialogue.png
          tours-double-dialogue.png
          59 kB
        5. View tour_1.png
          View tour_1.png
          181 kB
        6. View tour_2.png
          View tour_2.png
          207 kB

          Issue Links

          has a non-specific relationship to

          Improvement - An enhancement to an existing Moodle feature. MDL-53978 Add extra plugin callbacks for every major stage of page render + swap user tours to use them

          • Minor - Minor loss of function where workaround is possible
          • Closed
          has a QA test

          Functional Test - A test of a single Moodle feature MDLQA-9823 Create, Delete and Edit user tours

          • Major - Major loss of function, incorrect output
          • Open

          Functional Test - A test of a single Moodle feature MDLQA-9824 Import and Export user tour

          • Minor - Minor loss of function where workaround is possible
          • Open
          is duplicated by

          Bug - A problem which impairs or prevents Moodle from functioning correctly. MDL-56483 When editing a tour step some fields do not retain the original data.

          • Blocker - Blocks development and/or testing, prevents Moodle from running (applicable to bugs only)
          • Closed
          Testing discovered

          Bug - A problem which impairs or prevents Moodle from functioning correctly. MDL-56491 "force the tour to be displayed again" should not be a link

          • Minor - Minor loss of function where workaround is possible
          • Open

          Bug - A problem which impairs or prevents Moodle from functioning correctly. MDL-56493 Style issue when scrolling down during the tour

          • Minor - Minor loss of function where workaround is possible
          • Open

          Bug - A problem which impairs or prevents Moodle from functioning correctly. MDL-56483 When editing a tour step some fields do not retain the original data.

          • Blocker - Blocks development and/or testing, prevents Moodle from running (applicable to bugs only)
          • Closed

          Bug - A problem which impairs or prevents Moodle from functioning correctly. MDL-56487 User tours block list should be alphabetical

          • Minor - Minor loss of function where workaround is possible
          • Closed

          Bug - A problem which impairs or prevents Moodle from functioning correctly. MDL-56492 JS errors while using user tours

          • Minor - Minor loss of function where workaround is possible
          • Closed

          Bug - A problem which impairs or prevents Moodle from functioning correctly. MDL-56494 Edit step does not set selected block field value

          • Minor - Minor loss of function where workaround is possible
          • Closed

          Bug - A problem which impairs or prevents Moodle from functioning correctly. MDL-56496 step_shown events are not being triggered

          • Minor - Minor loss of function where workaround is possible
          • Closed

          Bug - A problem which impairs or prevents Moodle from functioning correctly. MDL-56497 On safari 5.1 tour popup points at wrong div

          • Minor - Minor loss of function where workaround is possible
          • Closed

          Bug - A problem which impairs or prevents Moodle from functioning correctly. MDL-56499 User tours tooltip shows on wrong side of selector in boost

          • Minor - Minor loss of function where workaround is possible
          • Closed

            Activity

              People

              • Votes:
                15 Vote for this issue
                Watchers:
                33 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved:
                  Fix Release Date:
                  5/Dec/16