Assignment submissions : PDF submission

assignsubmission_pdf
Maintained by Davo Davo Smith
This allows a teacher to annotate and return PDF files that have been submitted by students. Teachers can add and position comments and draw lines, ovals, stamps, rectangles and highlights onto the student's work, from within the browser.
1144 sites
999 downloads
15 fans
Moodle 2.6, 2.7, 2.8, 2.9, 3.0, 3.1, 3.2

This plugin and the associated feedback plugin, do still, technically, work with Moodle 3.1, but they sit very awkwardly alongside the new grading layout. If you haven't switched over yet, now is the time to do so.

Important note - PDF annotation (based on the PDF feedback part of this plugin) is now part of Moodle core (from Moodle 2.6 onwards). 

There is currently no code available to migrate existing assignments using my plugin to the core version. However, I would recommend that all future assignments are created using the core Moodle functionality - I do not intend to maintain this version indefinitely (although I will attempt to fix any major compatibility bugs that arise in future versions).

Note also that there are a number of significant differences between the plugin version and the Moodle 2.6 built-in version of PDF annotation. The documentation below is only relevant to the plugin version; questions or problems about the built-in version should be directed to the Moodle forums or tracker.moodle.org


These plugins for the assignment module allows a teacher to annotate and return PDF files that have been submitted by students. It is based on my previous 'UploadPDF' assignment type, updated to work with the Moodle 2.3+ 'assign' module (rather than the Moodle 2.0-2.2 'assignment' module).

Teachers can add and position comments and draw lines, ovals, stamps, rectangles and highlights onto the student's work, from within the browser, before returning the work to the student.

This plugin is available in Moodle 2.3+, Moodle 2.0-2.2 and Moodle 1.9 versions.
This is the Moodle 2.3+ version - you can download the Moodle 1.9 version from here:
https://github.com/davosmith/moodle-uploadpdf/zipball/MOODLE_19_STABLE
and the Moodle 2.0-2.2 version here:
https://github.com/davosmith/moodle-uploadpdf/zipball/master

!! THERE ARE A FEW IMPORTANT ITEMS TO NOTE IN THE INSTALLATION, PLEASE READ CAREFULLY !!

Installation

Note - the assignsubmission_pdf plugin can, theoretically, be used without the assignfeedback_pdf plugin (https://moodle.org/plugins/view.php?plugin=assignfeedback_pdf). On its own, however, it has little advantage over the standard 'file' submission plugin (other than coversheet handling). The assignfeedback_pdf will not do anything on its own (and cannot be installed without the submission plugin).

  1. Download and install GhostScript ( http://www.ghostscript.com/ ) - or install from standard respositories, if using Linux.
    Under Windows, do not install to a path with a space in it - that means you should install to something like 'c:\gs' NOT 'c:\Program Files\gs' (note you only need the files 'gswin32c.exe' and the dll file from the 'bin' folder, all other files are unnecessary for this to work).
  2. Unzip the submission pdf and feedback pdf plugin files to folders on your local machine
  3. Upload the plugin files to <siteroot>/mod/assign/submission/pdf and <siteroot>/mod/assign/feedback/pdf
  4. Log in to Moodle as administrator, then click on 'Home'.
  5. Visit 'Site admin > Plugins > Assignment plugins > Feedback Plugins > PDF Feedback'. Adjust the 'Ghostscript path' to where ghostscript is installed (should not need changing on a Linux install).

All being well, you should now be able to add submission and feedback type 'pdf' to assignments.

How to use

  • Add a new Assignment to a course.
  • Configure all the usual settings - you should be aware of the following additions:
    • PDF submission - set to 'Yes' to allow students to submit PDFs for annotation
    • PDF feedback - set to 'Yes' to allow the submitted PDFs to be annotated (note this ONLY works with PDFs submitted via the 'PDF submission' plugin).
    • Coversheet - this is a PDF that will be automatically added to the start of any files submitted by your students
    • Template - before submission your students can be (optionally) asked to fill in some text fields, the template is used to add these entries to the coversheet (this is ignored, if no coversheet is selected).
    • Edit Templates... - see section below

It is recommended this is used with the 'Require students click submit button' option, as then the processing and combining of the submission PDFs is only done once they click that button. Otherwise, the processing is done every time the student updates their submission.

  • When a student uploads their files and clicks 'Submit' they will be combined them together into a single submission (along with the coversheet).

(Hint: to help students generate PDF files, install a PDF printer, such as PDF Creator - http://sourceforge.net/projects/pdfcreator ).

  •  The teacher can then log in, go to the usual marking screen and click on 'Annotate submission', which will bring up the first page of the student's work on screen.
  • Click anywhere on the image of the PDF to add a comment. Use the resize handle in the bottom-right corner of a comment to resize it, click & drag on a comment to move it. Click (without dragging) on a comment to edit it, delete all the text in a comment to remove it.
  • Right-click on a comment to add it to a 'Comment Quicklist'. You can then right-click anywhere on a page to insert comments from this 'Comment Quicklist' (with the same text, width and background as the original). Comments can be deleted from the 'Comment Quicklist' by clicking on the 'X' to the right of the comment.
  • You can add lines to the PDF by holding 'Ctrl' ('Alt' on Apple Macs) whilst you click and drag with the mouse (or alternatively hold 'Ctrl' then click once for the start and once for the end of the line).
  • You can also choose different drawing tools by clicking on the icons or by using the keys c (comments), l (lines), r (rectangles), o (ovals), f (freehand lines), e (erase lines), [ & ] (change comment colour), { & } (change line colour)
  • Navigate between the pages by clicking on the 'Next' and 'Prev' buttons or by pressing 'n' and 'p' on the keyboard.
  • Click on 'Save Draft and Close' (or just navigate to a different page) to save the work in progress.
  • Click on the 'Generate Response' icon to create a new PDF with all your annotations present (that the student will be able to access).
  • You can view the comments you have made on a student's previous submissions by choosing that submission from the 'compare to' list
  • You can quickly find comments you have previously made by clicking on the 'find comment' list.
  • Add any feedback / grades to the usual form and save them.

Edit Templates

  • Click on the 'Edit Templates...' link on the 'Settings' page
  • Choose the name of the Template to edit (or select 'New Template...')
  • You can change the name of the template, delete the template or make it available to everyone on the site (administrators only, for this last option). Only administrators can edit site templates.
    Note: you cannot delete templates that are in use (click 'show' to find out where it is currently being used)
  • The list at the bottom allows you to choose an item in the template to edit, or choose 'New Item...' to add a new one.
  • The types of item you can add are:
    • text - a block of text, which will re-flow at 'width' pixels, 'value' will be the prompt the student sees to fill this in
    • shorttext - similar to text, but without word-wrapping useful for 'name' or 'type your initials to state this is all your own work'
    • date - fills in the date that the assignment was submitted, 'value' is the format to record the date
  • To position the items on the template, upload an example PDF coversheet (using the bottom form) then type in the position you want to place the PDF (x position, y position, in pixels).
    Alternatively, click on the coversheet image to set the position of that template item.
  • When you are finished, save any items you have changed, then close the window. The list of templates on the 'settings' page should have been updated.

Known issues

There is no way to annotate the PDFs without JavaScript.

Backup & restore will not transfer coversheet templates to a different site (it will work fine on a single site). This is a limitation of the assignment backup & restore process.

Thanks

This makes use of GhostScript and the FPDI and TCPDF libraries for PDF manipulation; Mootools is used to help with the JavaScript and Raphael provides the cross-browser annotation support.

Thanks to the creators of all those libraries, as this wouldn't have been possible without their hard work (and their free software licensing)

Sets

This plugin is part of set Assignment: PDF.

Screenshots

Screenshot #0
Screenshot #1

Contributors

Davo
Davo Smith (Lead maintainer)
Please login to view contributors details and/or to contact them

Comments RSS

Show comments
  • Davo
    Fri, 12 Dec 2014, 6:44 AM
    I've not seen any other complaints about it, but I am not on the receiving end of them (as I'm not responsible for the maintenance of the core version of the plugin - it was extensively rewritten when it was put into core).

    The preprocessing is the responsibility of ghostscript, so it may be possible that a newer version of ghostscript may manage the conversion more accurately. The alternative would be to remove the pre-processing step and buy a copy of the commercial FPDI PDF parser ( http://www.setasign.com/products/fpdi-pdf-parser/details/#p-500 ).

    Short of writing an open-source PDF parser for versions > 1.4 (a really massive job), there probably ins't a lot that Moodle HQ can do.
  • Picture of Nick Phillips
    Thu, 2 Jun 2016, 8:34 AM
    Is there a recommended way to uninstall these, other than editing the version.pdf in each (submission, feedback) part to remove the dependency line? (as each depends on the other, neither is allowed to be uninstalled by standard uninstall process)
  • Picture of Nick Phillips
    Thu, 2 Jun 2016, 8:34 AM
    I mean version.php, of course. PDF on the brain.
  • Davo
    Tue, 7 Jun 2016, 1:20 AM
    Hi Nick,

    Sorry - I've been away, so only just able to reply to your message now. I've not tried to uninstall these plugins through the UI. It sounds like a core Moodle bug that you can't do so without editing version.php, but, for the moment, that's probably the best solution.
  • Picture of Jürg Hoerner
    Tue, 27 Sep 2016, 3:29 AM
    Hi Davo

    How I can uninstall this plugin with the assignfeedback_pdf in moodle 3.1?

    Thank you for your answer.
    Jürg
  • Davo
    Tue, 27 Sep 2016, 3:39 AM
    You should be able to uninstall from the plugins overview page - then delete the code from the directories on your server.
  • Picture of Jürg Hoerner
    Tue, 27 Sep 2016, 4:18 AM
    This is not possible in my installation: PDF submission and PDF Feedback are the only two plugins, with no uninstall Link.
  • Davo
    Tue, 27 Sep 2016, 4:22 AM
    I think that is a bug in Moodle, because the two plugins depend on each other, so you can never uninstall one without the other complaining. I suggest you edit the version.php file for one (or both) of the plugins and delete the '$dependencies' section at the bottom of the file - you should then be able to delete one, then the other plugin.
  • Picture of Laurent Labidi
    Wed, 12 Oct 2016, 3:42 AM
    Hello Davo

    Thanks for the tips...i had the same pb than Jürg.

    Good job !
  • Picture of Bei Chapman
    Tue, 1 Nov 2016, 10:31 PM
    Hi,

    Can anyone out there tell me what the status values mean? For example, status=1 or status=3?

    Thanks,
    Bei
  • Davo
    Tue, 1 Nov 2016, 10:35 PM
    What status do you mean? There are at least 3 status values I can find from a quick search of the code (the submission status, the pdf submission status and the ghostscript ready status).

    Assuming it is the PDF submission status, they are listed here:
    https://github.com/davosmith/moodle-assignsubmission_pdf/blob/master/lib.php#L39
  • Picture of Bei Chapman
    Tue, 1 Nov 2016, 11:01 PM
    Hi Davo,

    Thank you so much for the quick response.

    Yes, I was asking for PDF submission status in the M_ASSIGNSUBMISSION_PDF table smile

    What situation will cause the following case: PDF submission status=3 (empty) but the contenthash value still valid/exist (I can retrieve that particular pdf file from moodledata filedir no problem)?

    Cheers,
    Bei
  • Davo
    Tue, 1 Nov 2016, 11:03 PM
    Sorry I can't remember exactly how it reaches each status (it has been a long time since I wrote this plugin and I rarely do any work on it these days). You'd have to take a look through the code to work out what that status means.
  • Picture of Bei Chapman
    Tue, 1 Nov 2016, 11:18 PM
    Ok, no problem. Thanks Davo.
  • Davo
    Thu, 24 Nov 2016, 4:49 AM
    Automated tests (contained in assignfeedback_pdf) are all passing in Moodle 3.2
1 2 3 4 5 6
Please login to post comments