Gitlab CSE Unil

Commit 5f129657 authored by M. Chardon's avatar M. Chardon
Browse files

documentation php et maj readme

parent 5297095c
......@@ -10,14 +10,18 @@ Compatible with Moodle versions: 3.3
This tool is a Moodle plugin wich allows:
- 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
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.
- 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.
See this <a href="https://gitlabriset.unil.ch/Marion.Chardon/editpdfplus/wikis/home">wiki page</a> for screenshots.
......@@ -59,7 +63,9 @@ For usage application, please follow <a href="https://gitlabriset.unil.ch/Marion
## What's next?
Upcoming developments include building an interface allowing teachers to customize their own annotation tool sets.
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.
## Contributors and Licenses
......
......@@ -19,7 +19,7 @@
* This file contains the editor class for the assignfeedback_editpdfplus plugin
*
* @package assignfeedback_editpdfplus
* @copyright 2016 Université de Lausanne
* @copyright 2017 Université de Lausanne
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
......
<?php
// This file is part of Moodle - http://moodle.org/
//
// Moodle is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Moodle is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
/**
*
* This file contains the axis_del_form class for the assignfeedback_editpdfplus plugin
*
* @package assignfeedback_editpdfplus
* @copyright 2017 Université de Lausanne
......@@ -15,25 +30,20 @@ require_once("$CFG->libdir/formslib.php");
use moodleform;
/**
* Description of formslib
* Form to delete an axis
*
* @author kury
* @package assignfeedback_editpdfplus
* @copyright 2017 Université de Lausanne
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class axis_del_form extends moodleform {
protected function definition() {
$mform = $this->_form;
$mform->addElement('hidden', 'label', ''); // Add elements to your form
$mform->setType('hidden', PARAM_TEXT); //Set type of element
$mform->setType('hidden', PARAM_TEXT); //Set type of element
$mform->addElement('hidden', 'axeid', ''); // Add elements to your form
$mform->setType('hidden', PARAM_INT); //Set type of element
/*$buttonarray[] = &$mform->createElement('submit', 'submitbutton', 'Enregistrer');
$mform->addGroup($buttonarray, 'buttonar', '', array(' '), false);
$mform->closeHeaderBefore('buttonar');*/
//$this->add_action_buttons();
$mform->setType('hidden', PARAM_INT); //Set type of element
}
//Custom validation should be added here
......
<?php
// This file is part of Moodle - http://moodle.org/
//
// Moodle is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Moodle is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
/**
*
* This file contains the axis_form class for the assignfeedback_editpdfplus plugin
*
* @package assignfeedback_editpdfplus
* @copyright 2017 Université de Lausanne
......@@ -15,27 +30,21 @@ require_once("$CFG->libdir/formslib.php");
use moodleform;
/**
* Description of formslib
* Form to add or edit an axis
*
* @author kury
* @package assignfeedback_editpdfplus
* @copyright 2017 Université de Lausanne
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class axis_form extends moodleform {
protected function definition() {
global $CFG;
$mform = $this->_form;
$mform->_formName="tutu";
$mform->_formName = "tutu";
$mform->addElement('text', 'label', 'Nom'); // Add elements to your form
$mform->setType('label', PARAM_TEXT); //Set type of element
$mform->addElement('hidden', 'axeid', ''); // Add elements to your form
$mform->setType('hidden', PARAM_INT); //Set type of element
/*$buttonarray[] = &$mform->createElement('submit', 'submitbutton', 'Enregistrer');
$mform->addGroup($buttonarray, 'buttonar', '', array(' '), false);
$mform->closeHeaderBefore('buttonar');*/
//$this->add_action_buttons();
$mform->setType('label', PARAM_TEXT); //Set type of element
$mform->addElement('hidden', 'axeid', ''); // Add elements to your form
$mform->setType('hidden', PARAM_INT); //Set type of element
}
//Custom validation should be added here
......
<?php
// This file is part of Moodle - http://moodle.org/
//
// Moodle is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Moodle is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
/**
*
* This file contains the axis_import_form class for the assignfeedback_editpdfplus plugin
*
* @package assignfeedback_editpdfplus
* @copyright 2017 Université de Lausanne
......@@ -17,16 +32,18 @@ use moodleform;
/**
* Description of formslib
*
* @author kury
* Form to import an axis
*
* @package assignfeedback_editpdfplus
* @copyright 2017 Université de Lausanne
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class axis_import_form extends moodleform {
protected function definition() {
global $CFG;
$mform = $this->_form;
$mform->addElement('hidden', 'axeid', '');
$mform->setType('axeid', PARAM_INTEGER);
$mform->setType('axeid', PARAM_INTEGER);
}
//Custom validation should be added here
......
<?php
// This file is part of Moodle - http://moodle.org/
//
// Moodle is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Moodle is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
/**
*
* This file contains the tool_form class for the assignfeedback_editpdfplus plugin
*
* @package assignfeedback_editpdfplus
* @copyright 2017 Université de Lausanne
......@@ -15,18 +30,20 @@ require_once("$CFG->libdir/formslib.php");
use moodleform;
/**
* Description of formslib
* Form to add and edit a tool
*
* @author kury
* @package assignfeedback_editpdfplus
* @copyright 2017 Université de Lausanne
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class tool_form extends moodleform {
protected function definition() {
$mform = $this->_form;
$mform->addElement('text', 'colors', 'Couleur'); // Add elements to your form
$mform->setType('label', PARAM_TEXT); //Set type of element
$mform->addElement('hidden', 'toolid', ''); // Add elements to your form
$mform->setType('hidden', PARAM_INT); //Set type of element
$mform->setType('label', PARAM_TEXT); //Set type of element
$mform->addElement('hidden', 'toolid', ''); // Add elements to your form
$mform->setType('hidden', PARAM_INT); //Set type of element
}
//Custom validation should be added here
......
......@@ -53,22 +53,22 @@ class type_tool {
/** @var int ending location of cartridge in pixels. Image resolution is 100 pixels per inch */
public $cartridge_y = 0;
/** @var type */
/** @var bool true if this typetool is configurable or not */
public $configurable = 1;
/** @var type */
/** @var bool true if the label of the cartridge is configurable or not */
public $configurable_cartridge = 1;
/** @var type */
/** @var bool true if this color of the cartridge is configurable or not */
public $configurable_cartridge_color = 1;
/** @var type */
/** @var bool true if the color is configurable or not */
public $configurable_color = 1;
/** @var type */
/** @var bool true if the attached texts are configurable or not */
public $configurable_texts = 1;
/** @var type */
/** @var bool true if the fact that an user can attach a question/answer when he use this tool is configurable or not */
public $configurable_question = 1;
/**
......
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