Gitlab CSE Unil

Commit f992c5db authored by Nicolas.Dunand's avatar Nicolas.Dunand
Browse files

Updated README

parent f71887af
# EditPdfPlus : fork of Moodle/editpdf, with customs options
Welcome to EditPdfPlus: fork of Moodle/editpdf module, developped by UNIL/RISET
# Annotate PDF advanced, fork of Moodle's standard 'Annotate PDF' plugin for assignment feedback
Compatible with Moodle v3.3
This plugin is a fork of assignfeedback_editpdf, and is developed and maintained by RISET/University of Lausanne.
## Synopsis
### Description
This tool is a moodle plugin wich allows:
- to use different correction axes (parameterizable in base)
- to use several types of customizable tools (simple annotation, comment, buffer, highlighting, margin annotation, chained annotations - eg repetition)
- to have different tool palettes (configurable in base)
- to create question / answer interactions with the student
- the student to consult and manage annotations
- to generate a PDF with annotations, and questions / answers
Author: Marion Chardon, <marion.chardon@unil.ch>
### Screenshots
See <a href="https://gitlabriset.unil.ch/Marion.Chardon/editpdfplus/wikis/home">wiki page</a> for this part.
Compatible with Moodle versions: 3.3
## Easy start
### Install a release
#### On frontend
- Download zip sources
- Open moodle on web
- Go to administration site, into plugin menu
- Install plugin from zip
## Description
This tool is a Moodle plugin wich allows:
#### On server
Patch editpdf plugin files
- to use different correction axes (i.e. groups of tools)
- to use several types of customizable tools: simple annotation, comment, stamp, highlighting, margin annotation, chained annotations
- to have different tool palettes depending on the Moodle context (course, course category, site default)
- to create question / answer interactions with the student
- the student to consult and manage annotations
- to generate a PDF including annotations and questions / answers
This patch allow users to use either editpdf or editpdfplus.
At the moment, sample tools are installed with the plugin and tools can be added/modified directly as database records only. Current development will provide an UI for teachers to build their annotation palettes.
By default, it's the origin editpdf annotation tool which will be activated for all courses.
See this <a href="https://gitlabriset.unil.ch/Marion.Chardon/editpdfplus/wikis/home">wiki page</a> for screenshots.
//TODO patch or script on editpdf files
## Installation
### Configuration
See <a href="https://gitlabriset.unil.ch/Marion.Chardon/editpdfplus/wikis/configuration">wiki page</a> for this part.
1. Download as a ZIP file
2. Extract the ZIP file
3. Rename the extracted root directory to 'editpdfplus'
4. Copy the 'editpdfplus' directory to your Moodle server into <your-moodle-root-directory>/mod/assign/feedback/
5. Apply patch file 'editpdfplus.patch' :
a. `cd <your-moodle-root-directory>`
b. `patch -p1 < mod/assign/feedback/editpdfplus/editpdfplus.patch`
By default, the standard 'Edit PDF' annotation tool will stay active over all your Moodle site. See below for instructions about activating this plugin in select places (courses, course categories), or on your whole Moodle site.
## Configuration
You can test-drive this plugin using the provided annotation tools that come pre-installed, or create your own annotation tool sets (palettes).
At the moment, tools can be added/modified directly as database records only. Current development will provide an UI for teachers to build their annotation palettes.
See this <a href="https://gitlabriset.unil.ch/Marion.Chardon/editpdfplus/wikis/configuration">wiki page</a> for more details about creating new tool palettes.
## Activation of the plugin
### Active and use EditPdfPlus
An administrator profile will be able to give to a course the right to use this plugin or not.
- go to the permissions course
- look for ***mod/assignfeedback_editpdf:use***
- add manager, teacher and student roles to it
When a student give back a homework, the editpdfplus will automatically be used.
1. Go to the course (or course category) permissions settings
2. Look for the ***mod/assignfeedback_editpdfplus:use*** capability
3. Add the manager, teacher and student roles to it
The 'Annotate PDF advanced' plugin will then be used in place of the standard 'Annotate PDF' plugin in the corresponding course (or course category), or wherever you give users this capability.
For usage application, please follow <a href="https://gitlabriset.unil.ch/Marion.Chardon/editpdfplus/wikis/user-guide">this documentation</a>.
## What's next?
Develop interface for teacher, in order to allow them to customize their own palettes.
Upcoming developments include building an interface allowing teachers to customize their own annotation tool sets.
## Contributors and Licenses
RISET @ UNIL
EditPdfPlus is a free software released under GPL3 licence.
\ No newline at end of file
Copyright: University of Lausanne, RISET
Author: Marion Chardon, <marion.chardon@unil.ch>
'Annotate PDF advanced' is a free software released under the GNU GPL licence, version 3.
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment