PDF Annotation

Activities ::: mod_pdfannotator
Maintained by Bernd Decker, Tim Schroeder, Amrita Deb Dutta
The PDF annotator allows students to insert questions, comments and remarks on learning materials in PDF format directly into the document. Since all students, lecturers and tutors can read and answer the questions and comments asked, it is made easier to clarify open questions on lecture slides, scripts and other PDF learning materials quickly and in a concrete context.
Latest release:
2440 sites
1k downloads
82 fans
Current versions available: 4

What is the PDF-Annotator?

The PDF annotator allows students to insert questions, comments and remarks on learning materials in PDF format directly into the document. Since all students, lecturers and tutors can read and answer the questions and comments asked, it is made easier to clarify open questions on lecture slides, scripts and other PDF learning materials quickly and in a concrete context.

The PDF annotator is integrated into Moodle. You can recognize the PDF annotator by this  icon: The following screenshot (Fig. 1) gives you an impression of what the annotator looks like. On the left side of the PDF are the annotations, for which there are different tools. In the column to the right of the PDF you can write a comment on the annotation or respond to existing questions and comments from students. Comments may contain references to an important passage, an error, or a question to be answered by other students.

All annotations and comments are public and therefore visible to others. However, comments, as well as replies to existing comments, can also be posted anonymously.

Add PDF annotator to the course

To use the PDF annotator and add it to your course, click Turn On Edit at the top right of the Moodle page. Then click on ADD AN ACTIVITY OR RESOURCE in the desired area in which the PDF annotator is to be displayed and select PDF ANNOTATION from the list. Then click on ADD and you will be forwarded to the overview page where you can make further settings, such as the name and a description for the document. In the next step, please upload the intended PDF document. You can do this either using drag & drop or the file manager.  You also have the option of availability, prerequisites and activity completion.

to be determined. If you do not need these settings, simply leave them untouched, after uploading the file and clicking on SAVE AND TO COURSE your PDF document will be displayed directly in the desired area.

NOTE:  also drag and drop a PDF into a Section (editing on), you will be asked "Create file for PDF Annotation".

Toolbar for annotations

Use the toolbar to select the different annotation tools. With these you mark a place or area in the PDF, for which you can then write a comment or a question.

Ribbon


Fig. 2 The toolbar

  • Cursor: With the cursor you can select, comment or move existing annotations.
  • Pin: Use the pin to mark individual points in the PDF to ask questions or leave a comment.
  • Bounding box: Use the frame to select individual text or image areas and create comments for them.
  • Highlighter: Use the highlighter to highlight parts of the text and make comments on it.
  • Cross-Out: With this tool you can cross out and comment on incorrect parts of a text. 
  • Text: With this tool you can insert additional text into the PDF and comment on this insertion. In addition, you can select the font size and color before writing.
  • Pen: With the pen you can paint freehand in the PDF and create comments. You can also select the pen width and pen color before drawing.
  • Zoom: With the zoom you can display the PDF larger or smaller.
  • Hide annotations: To view the original document, you can hide all annotations. Note: With another click on the open eye, all annotations can be shown again.
  • Fullscreen: In full-screen mode, the entire PDF annotator is displayed across the width of the screen.
  • Page count: The page number shows you where you are in the PDF document.
  • print pdfDownload document: Download the PDF document
  • Download comments: Download all Discussions as PDF

Create annotations and comments


If you select an existing annotation or create a new one, a comment field opens on the right. Here you can enter your questions or comments.

If you want to post anonymously, activate the checkbox Post anonymusly. With a click on CREATE ANNOTATION or ANSWER you can send your text. However, it is recommended that you do not post anonymusly.

Overview all annotations



The Teacher Overview provides an overview of various elements of the PDF annotator. You will receive a presentation of the reported comments, new questions will be made directly accessible here and can be accessed via the link on the right-hand side, you can continue to view your contributions to comments of the students in this presentation and additionally administer entries.

Dependencies

Since v1.5.1, PDFAnnotator are supporting the Atto Editor. Another editor will not work for this plugin. Please make sure, that you are using atto editor as your standard editor.

Screenshots

Screenshot #0
Screenshot #1
Screenshot #2
Screenshot #3
Screenshot #4

Contributors

Bernd Decker (Lead maintainer)
Tim Schroeder: Developer
Amrita Deb Dutta: Developer
Please login to view contributors details and/or to contact them

Comments RSS

Show comments
  • Tim Schroeder
    गुरु, 18 जुल॰ 2024, 7:26 PM
    Hi Dharshana Salwathura,
    what would be the advantage of having an eraser tool over the current way of deleting annotation by selecting them with the hand tool and then clicking "X"?
  • Tim Schroeder
    शुक्र, 19 जुल॰ 2024, 1:12 AM
    Hi Viplava Joshy,
    you can currently only download (and then print)
    a) the PDF itself without annotations and
    b) a list of the annotations and replies as a separate PDF.
    Downloading both in one file is currently not implemented.
  • Tim Schroeder
    बुध, 24 जुल॰ 2024, 11:14 PM
    Hi Mona Sleem-Amer,
    that bug has been fixed with Release 1.5.5
  • Tim Schroeder
    बुध, 24 जुल॰ 2024, 11:17 PM
    Hi Елена MISIS,
    to delete an annotation:
    1. select the hand tool,
    2. click on the annotation to select it and
    3. click on the "X".
  • Tim Schroeder
    बुध, 24 जुल॰ 2024, 11:36 PM
    Hi Michelle Doyle,
    thanks for the suggestions. I've created an issue on GitHub for the custom completion condition feature. I'll put that into our backlog. However, I don't understand what you mean by "a rating for interaction". Can you explain what that would look like?
  • Katja Derr
    सोम, 26 अग॰ 2024, 5:28 PM
    Hi, we just tested an upgrade to Moodle 4.4.2+, and are getting an error message in the PDF Annotation Frontend:
    Click on "Overview" returns the following message:
    core\formatting::format_text(): Argument #2 ($format) must be of type string, array given, called in [dirroot]/lib/weblib.php on line 1449
    I understand the PDF Annotation Plugin is maintained for Moodle 4.1, could that be the reason? If yes: Will there be an update for the plugin, or could you advise us how to fix this issue? (otherwise it seems to work ok on 4.4....)
    Thank you and kind regards,
    Katja
  • Rainer Winkler
    सोम, 23 सित॰ 2024, 8:30 PM
    Hi everyone,
    Is there any way to let the right area (question, etc.) disappear and show the PDF in Full width? That would be a huge benefit in terms of user friendliness. Thanks, Rainer
  • C’est moi (il y a quelques années) :-)
    मंगल, 24 सित॰ 2024, 10:01 PM
    Hi,
    Would it be possible to add reset function to this useful plugin?
  • Friedhelm
    मंगल, 1 अक्तू॰ 2024, 2:29 PM
    Hello!

    When debugging pdfannotator we get the following message in Moodle 4.4.3
    Callback before_standard_html_head in mod_pdfannotator component should be migrated to new hook callback for core\hook\output\before_standard_head_html_generation

    We always get the latest version from the plugin repository.

    Best regards
    Friedhelm
  • 曰国 张
    शुक्र, 20 दिस॰ 2024, 3:37 PM
    异常 - core\formatting::format_text(): Argument #2 ($format) must be of type string, array given, called in [dirroot]/lib/weblib.php on line 618

    关于这个错误的更多信息

    调试信息:
    Error code: generalexceptionmessage×‎关闭此通知‎
    堆栈跟踪:
    line 162 of /lib/classes/formatting.php: TypeError thrown
    line 618 of /lib/weblib.php: call to core\formatting->format_text()
    line 1098 of /mod/pdfannotator/locallib.php: call to format_text()
    line 173 of /mod/pdfannotator/controller.php: call to pdfannotator_get_questions()
    line 89 of /mod/pdfannotator/view.php: call to require_once() 如何处理
  • MURAT SR
    सोम, 30 दिस॰ 2024, 3:37 PM
    Hi. I am attaching the PDF file. In the homepage view, only the toolbar of the plugin is visible, but the PDF file is not showing.
  • Amrita Deb Dutta
    गुरु, 2 जन॰ 2025, 8:11 PM
    Hello Murat ...this is a Moodle 4.4+ issue which we have fixed it with the latest version (2024121200). It was available since December in our Git repository and is now available here on plugin page as well. I suggest please install the new version and report back if the problem persists
  • MURAT SR
    शुक्र, 3 जन॰ 2025, 3:11 PM
    Thank you for your response. However, I am already using the latest version of Moodle (4.5.1+). Perhaps that is the issue. I don't know. (on pdf annotation 1.5.7)
1 2 3 4 5 6 7
Please login to post comments