Gitlab CSE Unil

README.md 3.32 KB
Newer Older
Nicolas.Dunand's avatar
Nicolas.Dunand committed
1
# Annotate PDF advanced, fork of Moodle's standard 'Annotate PDF' plugin for assignment feedback
M. Chardon's avatar
M. Chardon committed
2

Nicolas.Dunand's avatar
Nicolas.Dunand committed
3
This plugin is a fork of assignfeedback_editpdf, and is developed and maintained by RISET/University of Lausanne.
M. Chardon's avatar
M. Chardon committed
4

Nicolas.Dunand's avatar
Nicolas.Dunand committed
5
Author: Marion Chardon, <marion.chardon@unil.ch>
M. Chardon's avatar
M. Chardon committed
6

M. Chardon's avatar
M. Chardon committed
7
8
9
10
11
Compatible with Moodle versions: 3.3, 3.5, 3.7

Note:
 - for 3.3, please check tag "3.3", not master version.
 - for 3.5, please check branch "mdl_3.5", not master version.
M. Chardon's avatar
M. Chardon committed
12

Nicolas.Dunand's avatar
Nicolas.Dunand committed
13
## Description
M. Chardon's avatar
M. Chardon committed
14

Nicolas.Dunand's avatar
Nicolas.Dunand committed
15
This tool is a Moodle plugin wich allows:
M. Chardon's avatar
M. Chardon committed
16

M. Chardon's avatar
M. Chardon committed
17
18
19
20
21
22
23
24
25
26
27
28
 - a work part:
  - 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
 - a configuration part:
  - to allow configuration of toolbars for a course
  - to import existing toolbars into a course

At the moment, sample tools are installed with the plugin and type's tool can be added/modified directly as database records only. Current development will provide an UI for managers and administrators to custom tool's family.
M. Chardon's avatar
M. Chardon committed
29

Nicolas.Dunand's avatar
Nicolas.Dunand committed
30
See this <a href="https://gitlabriset.unil.ch/Marion.Chardon/editpdfplus/wikis/home">wiki page</a> for screenshots.
M. Chardon's avatar
M. Chardon committed
31

M. Chardon's avatar
M. Chardon committed
32

Nicolas.Dunand's avatar
Nicolas.Dunand committed
33
## Installation
M. Chardon's avatar
M. Chardon committed
34

Nicolas.Dunand's avatar
Nicolas.Dunand committed
35
36
37
38
39
40
41
42
43
44
45
46
 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/

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).

M. Chardon's avatar
M. Chardon committed
47
Teachers can build their annotation palettes. 
Nicolas.Dunand's avatar
Nicolas.Dunand committed
48
49
50
51
52

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
M. Chardon's avatar
M. Chardon committed
53

M. Chardon's avatar
M. Chardon committed
54
55
An administrator profile will be able to give to a course the right to use this plugin or not.

M. Chardon's avatar
M. Chardon committed
56
57
 1. Create an assignement activity
 2. Uncheck "standard PDF annotations" feedback type and check "advanced PDF annotations"
Nicolas.Dunand's avatar
Nicolas.Dunand committed
58

M. Chardon's avatar
M. Chardon committed
59
The 'Annotate PDF advanced' plugin will then be used in place of the standard 'Annotate PDF' plugin in the corresponding course (or course category).
M. Chardon's avatar
M. Chardon committed
60

M. Chardon's avatar
M. Chardon committed
61
For usage application, please follow <a href="https://gitlabriset.unil.ch/Marion.Chardon/editpdfplus/wikis/user-guide">this documentation</a>.
M. Chardon's avatar
M. Chardon committed
62

M. Chardon's avatar
M. Chardon committed
63
64
Note: by default, only teacher profile has the right to access to the palettes creation view.

Nicolas.Dunand's avatar
Nicolas.Dunand committed
65

M. Chardon's avatar
M. Chardon committed
66
## What's next?
Nicolas.Dunand's avatar
Nicolas.Dunand committed
67

M. Chardon's avatar
M. Chardon committed
68
69
70
Upcoming developments include:
 - improve the interface allowing teachers to customize their own annotation tool sets
 - build an interface for manager and administrator to allow them to manage toolbars and type's tool.
Nicolas.Dunand's avatar
Nicolas.Dunand committed
71

M. Chardon's avatar
M. Chardon committed
72
73

## Contributors and Licenses
M. Chardon's avatar
M. Chardon committed
74

Nicolas.Dunand's avatar
Nicolas.Dunand committed
75
76
77
78
79
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.