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

User tours: Display number of steps

    XMLWordPrintable

Details

    • MOODLE_311_STABLE, MOODLE_400_STABLE
    • MOODLE_400_STABLE
    • MDL-71938-master
    • Hide

      Initial setup

      1. Create a course or use an existing one.
      2. Create a Quiz activity or use an existing one.

      Check for a new tour

      1. Navigate to Site administration -> Appearance -> User Tours.
      2. Create a new tour.
      3. Verify that the "Display step numbers" option is checked.

      Import

      1. Navigate to Site administration -> Appearance -> User Tours.
      2. Click on Import tour.
      3. Import the attached tour in the attachment.
      4. Verify that you can import it normally without any errors.
      5. Edit the imported tour.
      6. Verify that the "Display step numbers" option is unchecked.

      Display

      1. Edit the imported tour.
      2. Check on the "Display step numbers" option and save the tour.
      3. Navigate to the created Quiz activity.
      4. Click on Edit Quiz.
      5. Verify that you will see the "Next (1/5)" button.
      6. Click on the "Next (1/5)" button.
      7. Verify that you will see the next step of the tour.
      8. Verify that you will see the "Next (2/5)" button.
      9. Click on the "Next (2/5)" button.
      10. Verify that you will see the "Next (3/5)" button.
      11. Click on the "Next (3/5)" button.
      12. Verify that you will see the "Next (4/5)" button.
      13. Click on the "Next (4/5)" button.
      14. Verify that you will not see the "Next (5/5)" button.
      15. Verify that you will see the End tour button.

      Export

      1. Navigate to Site administration -> Appearance -> User Tours.
      2. Export the imported tour.
      3. Open the exported JSON file with your preferred text editor.
      4. Verify that you will see a value called displaystepnumbers with a value is 1
      Show
      Initial setup Create a course or use an existing one. Create a Quiz activity or use an existing one. Check for a new tour Navigate to Site administration -> Appearance -> User Tours. Create a new tour. Verify that the "Display step numbers" option is checked. Import Navigate to Site administration -> Appearance -> User Tours. Click on Import tour. Import the attached tour in the attachment. Verify that you can import it normally without any errors. Edit the imported tour. Verify that the "Display step numbers" option is unchecked. Display Edit the imported tour. Check on the "Display step numbers" option and save the tour. Navigate to the created Quiz activity. Click on Edit Quiz. Verify that you will see the "Next (1/5)" button. Click on the "Next (1/5)" button. Verify that you will see the next step of the tour. Verify that you will see the "Next (2/5)" button. Click on the "Next (2/5)" button. Verify that you will see the "Next (3/5)" button. Click on the "Next (3/5)" button. Verify that you will see the "Next (4/5)" button. Click on the "Next (4/5)" button. Verify that you will not see the "Next (5/5)" button. Verify that you will see the End tour button. Export Navigate to Site administration -> Appearance -> User Tours. Export the imported tour. Open the exported JSON file with your preferred text editor. Verify that you will see a value called  displaystepnumbers with a value is 1

    Description

      In order for users to clearly see how far through a user tour they are, we should implement a visual indicator of the current step, and how many steps there are in total.

      Specifics:

      • The count should be displayed on the "Next" button, in the format "Next (1/5)".
      • The total number should only count those steps that will be displayed.
      • Single step tours, and the final step of multi-step tours, should not show this count.
      • This should be a configurable setting that can be enabled/disabled on each tour.
      • Existing tours should continue as they are (with it disabled, but with the ability to enable if an admin wishes).
      • Tours that are imported should have this setting disabled, so they reflect the same visual behaviour as when they were exported.
      • The create tours functionality should have this option ticked by default, to encourage its use on new tours as they are created.
      • The user tours included with Moodle (currently only those relating to course completion) should be updated so this is enabled by default, so new sites have the counts on those tours.

      Attachments

        1. image-2021-07-02-11-23-20-466.png
          image-2021-07-02-11-23-20-466.png
          62 kB
        2. image-2021-09-28-09-12-45-223.png
          image-2021-09-28-09-12-45-223.png
          92 kB
        3. MDL-71938_Check for a new tour.png
          MDL-71938_Check for a new tour.png
          96 kB
        4. MDL-71938_Display_1.png
          MDL-71938_Display_1.png
          94 kB
        5. MDL-71938_Display_2.png
          MDL-71938_Display_2.png
          86 kB
        6. MDL-71938_Display_3.png
          MDL-71938_Display_3.png
          87 kB
        7. MDL-71938_Display_4.png
          MDL-71938_Display_4.png
          86 kB
        8. MDL-71938_Display_5.png
          MDL-71938_Display_5.png
          111 kB
        9. MDL-71938_Export.png
          MDL-71938_Export.png
          89 kB
        10. MDL-71938_Import_1.png
          MDL-71938_Import_1.png
          153 kB
        11. MDL-71938_Import_2.png
          MDL-71938_Import_2.png
          105 kB
        12. next-button-with-steps.png
          next-button-with-steps.png
          64 kB
        13. Screenshot 2021-06-28 164746.png
          Screenshot 2021-06-28 164746.png
          9 kB
        14. tour_export_quiz_edit.json
          1 kB

        Issue Links

          Activity

            People

              huongn@moodle.com Huong Nguyen
              quen Sam Marshall
              Michael Hawkins Michael Hawkins
              Shamim Rezaie Shamim Rezaie
              Angelia Dela Cruz Angelia Dela Cruz
              David Woloszyn, Huong Nguyen, Jake Dallimore, Michael Hawkins, Stevani Andolo
              Votes:
              2 Vote for this issue
              Watchers:
              11 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved:
                19/Apr/22

                Time Tracking

                  Estimated:
                  Original Estimate - 0 minutes
                  0m
                  Remaining:
                  Remaining Estimate - 0 minutes
                  0m
                  Logged:
                  Time Spent - 2 days, 5 hours, 16 minutes
                  2d 5h 16m