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

Make annotated PDF comments collapsible

    XMLWordPrintable

    Details

    • Testing Instructions:
      Hide
      1. Create a new assignment with file submissions enabled.
      2. As a student, submit a multi-page file (of a format that can be converted to PDF).
      3. As a teacher, annotate the submission with several comments on different pages.
      4. Make sure the comments collapse to a marker icon after being added.
      5. Make sure comments are expanded briefly on mouseover (as long as the 'Comments' or 'Select' tool is selected) and collapse again on mouseout.
      6. Make sure comments are expanded on click (with any tool selected) for as long as they are being edited.
      7. Make sure comments collapse again on losing focus after being edited.
      8. Click the 'Expand/collapse all comments' button and make sure all comments are expanded, and stay expanded.
      9. Click the 'Expand/collapse all comments' button again and make sure all comments collapse again.
      10. Check that tabbing between comments still works, and that the each comment expands on focus.
      11. Check that the comment menu items (e.g. quicklist) all function as expected.
      12. Check that the 'Search comments' function works as expected, and that comments are expanded and focused when selected.
      13. Add a few annotations of other types and save the changes.
      14. Release the feedback.
      15. As a student, view the annotated PDF using the online viewer.
      16. Make sure all comments are collapsed to a marker icon when the viewer loads.
      17. Make sure comments are expanded briefly on mouseover and collapse again on mouseout.
      18. Make sure comments are expanded on click for as long as they have focus.
      19. Make sure comments collapse again on losing focus.
      20. Click the 'Expand/collapse all comments' button and make sure all comments are expanded, and stay expanded.
      21. Click the 'Expand/collapse all comments' button again and make sure all comments collapse again.
      22. Check that tabbing between comments still works, and that the each comment expands on focus.
      23. Check that the 'Search comments' function works as expected, and that comments are expanded and focused when selected.
      24. Download the annotated PDF and open it offline.
      25. Make sure all comments are represented by markers containing an index in the format:

        {pagenumber}.{commentnumber}

      26. Make sure all the comments have been appended to the end of the document in full, along with their correct indices.
      27. Check that the markers link to the correct comments and vice-versa.
      Show
      Create a new assignment with file submissions enabled. As a student, submit a multi-page file (of a format that can be converted to PDF). As a teacher, annotate the submission with several comments on different pages. Make sure the comments collapse to a marker icon after being added. Make sure comments are expanded briefly on mouseover (as long as the 'Comments' or 'Select' tool is selected) and collapse again on mouseout. Make sure comments are expanded on click (with any tool selected) for as long as they are being edited. Make sure comments collapse again on losing focus after being edited. Click the 'Expand/collapse all comments' button and make sure all comments are expanded, and stay expanded. Click the 'Expand/collapse all comments' button again and make sure all comments collapse again. Check that tabbing between comments still works, and that the each comment expands on focus. Check that the comment menu items (e.g. quicklist) all function as expected. Check that the 'Search comments' function works as expected, and that comments are expanded and focused when selected. Add a few annotations of other types and save the changes. Release the feedback. As a student, view the annotated PDF using the online viewer. Make sure all comments are collapsed to a marker icon when the viewer loads. Make sure comments are expanded briefly on mouseover and collapse again on mouseout. Make sure comments are expanded on click for as long as they have focus. Make sure comments collapse again on losing focus. Click the 'Expand/collapse all comments' button and make sure all comments are expanded, and stay expanded. Click the 'Expand/collapse all comments' button again and make sure all comments collapse again. Check that tabbing between comments still works, and that the each comment expands on focus. Check that the 'Search comments' function works as expected, and that comments are expanded and focused when selected. Download the annotated PDF and open it offline. Make sure all comments are represented by markers containing an index in the format: {pagenumber}.{commentnumber} Make sure all the comments have been appended to the end of the document in full, along with their correct indices. Check that the markers link to the correct comments and vice-versa.
    • Affected Branches:
      MOODLE_31_STABLE, MOODLE_32_STABLE
    • Fixed Branches:
      MOODLE_33_STABLE
    • Pull from Repository:
    • Pull Master Branch:
      MDL-55459-master

      Description

      Currently, annotated PDF comments tend to cover up large areas of the submitted text. This patch attempts to improve the usability of this feature by adding an option to collapse each comment to a small marker icon when it is not selected for editing or viewing.

      With the option switched on, the behaviour for the online PDF editor/viewer is that all comments are collapsed to a marker icon by default, but expand momentarily when moused over, or for a longer period when clicked/selected for editing. For the downloadable/printable PDF each comment is represented by a marker icon within the submitted text itself, and the full comments are appended to the end of the document with links between the two (in both directions).

      This option can be configured per mod_assign instance and there is also a site-wide default setting for new assignment instances. The overall default preserves exiting behaviour.

        Attachments

        1. Comment area from crocodoc.png
          Comment area from crocodoc.png
          23 kB
        2. crocodoc screen shot.png
          crocodoc screen shot.png
          11 kB
        3. point comment from crocodoc.png
          point comment from crocodoc.png
          14 kB
        4. screenshot-1.png
          screenshot-1.png
          21 kB
        5. screenshot-2.png
          screenshot-2.png
          25 kB
        6. screenshot-3.png
          screenshot-3.png
          14 kB

          Issue Links

            Activity

              People

              • Votes:
                21 Vote for this issue
                Watchers:
                20 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved:
                  Fix Release Date:
                  15/May/17