L-electron-Rare/moodle
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

MDL-60008 assign: Info messages

Browse Source 
Better support for information messages from the conversion process.
This commit is contained in:
Damyon Wiese
2018-12-06 13:33:12 +08:00
parent 86c577093b
commit e3511e7978
10 changed files with 215 additions and 90 deletions
Download Patch File Download Diff File Expand all files Collapse all files
mod/assign/feedback/editpdf/classes/renderer.php
+8 -8
View File
@@ -217,15 +217,14 @@ class assignfeedback_editpdf_renderer extends plugin_renderer_base {
$canvas = html_writer::div($loading, 'drawingcanvas');
$canvas = html_writer::div($canvas, 'drawingregion');
$changesmessage = html_writer::tag('div',
get_string('draftchangessaved', 'assignfeedback_editpdf'),
array(
'class' => 'assignfeedback_editpdf_unsavedchanges warning label label-info'
));
$changesmessage = html_writer::div($changesmessage, 'unsaved-changes');
// Place for messages, but no warnings displayed yet.
$changesmessage = html_writer::div('', 'warningmessages');
$canvas .= $changesmessage;
$infoicon = $this->image_icon('i/info', '');
$infomessage = html_writer::div($infoicon, 'infoicon');
$canvas .= $infomessage;
$body .= $canvas;
$footer = '';
@@ -269,7 +268,8 @@ class assignfeedback_editpdf_renderer extends plugin_renderer_base {
'stamppicker',
'cannotopenpdf',
'pagenumber',
'partialwarning'
'partialwarning',
'draftchangessaved'
), 'assignfeedback_editpdf');
return $html;
mod/assign/feedback/editpdf/lang/en/assignfeedback_editpdf.php
+1 -1
View File
@@ -72,7 +72,7 @@ $string['output'] = 'Output:';
$string['pagenumber'] = 'Page {$a}';
$string['pagexofy'] = 'Page {$a->page} of {$a->total}';
$string['pen'] = 'Pen';
$string['partialwarning'] = 'Some of the submission files must be downloaded.';
$string['partialwarning'] = 'Some of the files in this submission can only be accessed by direct download.';
$string['pluginname'] = 'Annotate PDF';
$string['privacy:metadata:colourpurpose'] = 'Colour of the comment or annotation';
$string['privacy:metadata:conversionpurpose'] = 'Files are converted to PDFs to allow for annotations.';
mod/assign/feedback/editpdf/styles.css
+11 -11
View File
@@ -26,6 +26,17 @@
cursor: move;
}
.assignfeedback_editpdf_widget .infoicon {
display: none;
}
.assignfeedback_editpdf_widget .warningmessages {
position: absolute;
margin-left: 20px;
margin-right: 20px;
bottom: 20px;
}
.assignfeedback_editpdf_widget .drawingregion {
border: 1px solid #ccc;
left: 1em;
@@ -59,17 +70,6 @@
padding: 0;
}
.assignfeedback_editpdf_widget .assignfeedback_editpdf_unsavedchanges.haschanges {
display: inline-block;
}
.assignfeedback_editpdf_widget .assignfeedback_editpdf_unsavedchanges {
display: none;
position: absolute;
left: 20px;
top: 120px;
}
.yui3-colourpicker-hidden,
.yui3-commentsearch-hidden,
.yui3-commentmenu-hidden {
mod/assign/feedback/editpdf/yui/build/moodle-assignfeedback_editpdf-editor/moodle-assignfeedback_editpdf-editor-debug.js
Vendored
+58 -17
View File
@@ -43,7 +43,9 @@ var AJAXBASE = M.cfg.wwwroot + '/mod/assign/feedback/editpdf/ajax.php',
COMMENTMENU: '.commentdrawable a',
ANNOTATIONCOLOURBUTTON: '.annotationcolourbutton',
DELETEANNOTATIONBUTTON: '.deleteannotationbutton',
UNSAVEDCHANGESDIV: '.assignfeedback_editpdf_unsavedchanges',
WARNINGMESSAGECONTAINER: '.warningmessages',
ICONMESSAGECONTAINER: '.infoicon',
UNSAVEDCHANGESDIV: '.assignfeedback_editpdf_warningmessages',
UNSAVEDCHANGESINPUT: 'input[name="assignfeedback_editpdf_haschanges"]',
STAMPSBUTTON: '.currentstampbutton',
DIALOGUE: '.' + CSS.DIALOGUE
@@ -3756,7 +3758,7 @@ EDITOR.prototype = {
// The combined document is still waiting for input to be ready.
poll = true;
} else if (data.status === 1) {
} else if (data.status === 1 || data.status === 3) {
// The combine document is ready for conversion into a single PDF.
poll = true;
@@ -3833,15 +3835,41 @@ EDITOR.prototype = {
* Display an error in a small part of the page (don't block everything).
*
* @param string The error text.
* @param boolean dismissable Not critical messages can be removed after a short display.
* @protected
* @method warning
*/
warning: function(message) {
var drawingregion = this.get_dialogue_element(SELECTOR.DRAWINGREGION);
warning: function(message, dismissable) {
var icontemplate = this.get_dialogue_element(SELECTOR.ICONMESSAGECONTAINER);
var warningregion = this.get_dialogue_element(SELECTOR.WARNINGMESSAGECONTAINER);
var delay = 15, duration = 1;
var messageclasses = 'assignfeedback_editpdf_warningmessages alert alert-warning';
if (dismissable) {
delay = 4;
messageclasses = 'assignfeedback_editpdf_warningmessages alert alert-info';
}
var warningelement = Y.Node.create('<div class="' + messageclasses + '" role="alert"></div>');
var warningelement = Y.Node.create('<div class="alert alert-warning" role="alert"></div>');
warningelement.setHTML(message);
drawingregion.prepend(warningelement);
// Copy info icon template.
warningelement.append(icontemplate.one('*').cloneNode());
// Append the message.
warningelement.append(message);
// Add the entire warning to the container.
warningregion.prepend(warningelement);
// Remove the message after a short delay.
warningelement.transition(
{
duration: duration,
delay: delay,
opacity: 0
},
function() {
warningelement.remove();
}
);
},
/**
@@ -3887,7 +3915,7 @@ EDITOR.prototype = {
readonly = this.get('readonly');
if (!readonly && data.partial) {
// Warn about non converted files, but only for teachers.
this.warning(M.util.get_string('partialwarning', 'assignfeedback_editpdf'));
this.warning(M.util.get_string('partialwarning', 'assignfeedback_editpdf'), false);
}
// Update the ui.
@@ -4476,6 +4504,7 @@ EDITOR.prototype = {
* @method save_current_page
*/
save_current_page: function() {
this.clear_warnings(false);
if (this.get('destroyed')) {
return;
}
@@ -4503,16 +4532,9 @@ EDITOR.prototype = {
if (jsondata.error) {
return new M.core.ajaxException(jsondata);
}
// Show warning that we have not saved the feedback.
Y.one(SELECTOR.UNSAVEDCHANGESINPUT).set('value', 'true');
Y.one(SELECTOR.UNSAVEDCHANGESDIV).setStyle('opacity', 1);
Y.one(SELECTOR.UNSAVEDCHANGESDIV).setStyle('display', 'inline-block');
Y.one(SELECTOR.UNSAVEDCHANGESDIV).transition({
duration: 1,
delay: 2,
opacity: 0
}, function() {
Y.one(SELECTOR.UNSAVEDCHANGESDIV).setStyle('display', 'none');
});
this.warning(M.util.get_string('draftchangessaved', 'assignfeedback_editpdf'), true);
} catch (e) {
return new M.core.exception(e);
}
@@ -4587,6 +4609,22 @@ EDITOR.prototype = {
}
},
/**
* Clear all current warning messages from display.
* @protected
* @method clear_warnings
* @param {Boolean} allwarnings If true, all previous warnings are removed.
*/
clear_warnings: function(allwarnings) {
// Remove all warning messages, they may not relate to the current document or page anymore.
var warningregion = this.get_dialogue_element(SELECTOR.WARNINGMESSAGECONTAINER);
if (allwarnings) {
warningregion.empty();
} else {
warningregion.all('.alert-info').remove(true);
}
},
/**
* Load the image for this pdf page and remove the loading icon (if there).
* @protected
@@ -4653,6 +4691,7 @@ EDITOR.prototype = {
pageselect.removeAttribute('disabled');
pageselect.on('change', function() {
this.currentpage = pageselect.get('value');
this.clear_warnings(false);
this.change_page();
}, this);
@@ -4676,6 +4715,7 @@ EDITOR.prototype = {
if (this.currentpage < 0) {
this.currentpage = 0;
}
this.clear_warnings(false);
this.change_page();
},
@@ -4690,6 +4730,7 @@ EDITOR.prototype = {
if (this.currentpage >= this.pages.length) {
this.currentpage = this.pages.length - 1;
}
this.clear_warnings(false);
this.change_page();
},
mod/assign/feedback/editpdf/yui/build/moodle-assignfeedback_editpdf-editor/moodle-assignfeedback_editpdf-editor-min.js
Vendored
+9 -9
View File
File diff suppressed because one or more lines are too long
mod/assign/feedback/editpdf/yui/build/moodle-assignfeedback_editpdf-editor/moodle-assignfeedback_editpdf-editor.js
Vendored
+58 -17
View File
@@ -43,7 +43,9 @@ var AJAXBASE = M.cfg.wwwroot + '/mod/assign/feedback/editpdf/ajax.php',
COMMENTMENU: '.commentdrawable a',
ANNOTATIONCOLOURBUTTON: '.annotationcolourbutton',
DELETEANNOTATIONBUTTON: '.deleteannotationbutton',
UNSAVEDCHANGESDIV: '.assignfeedback_editpdf_unsavedchanges',
WARNINGMESSAGECONTAINER: '.warningmessages',
ICONMESSAGECONTAINER: '.infoicon',
UNSAVEDCHANGESDIV: '.assignfeedback_editpdf_warningmessages',
UNSAVEDCHANGESINPUT: 'input[name="assignfeedback_editpdf_haschanges"]',
STAMPSBUTTON: '.currentstampbutton',
DIALOGUE: '.' + CSS.DIALOGUE
@@ -3756,7 +3758,7 @@ EDITOR.prototype = {
// The combined document is still waiting for input to be ready.
poll = true;
} else if (data.status === 1) {
} else if (data.status === 1 || data.status === 3) {
// The combine document is ready for conversion into a single PDF.
poll = true;
@@ -3833,15 +3835,41 @@ EDITOR.prototype = {
* Display an error in a small part of the page (don't block everything).
*
* @param string The error text.
* @param boolean dismissable Not critical messages can be removed after a short display.
* @protected
* @method warning
*/
warning: function(message) {
var drawingregion = this.get_dialogue_element(SELECTOR.DRAWINGREGION);
warning: function(message, dismissable) {
var icontemplate = this.get_dialogue_element(SELECTOR.ICONMESSAGECONTAINER);
var warningregion = this.get_dialogue_element(SELECTOR.WARNINGMESSAGECONTAINER);
var delay = 15, duration = 1;
var messageclasses = 'assignfeedback_editpdf_warningmessages alert alert-warning';
if (dismissable) {
delay = 4;
messageclasses = 'assignfeedback_editpdf_warningmessages alert alert-info';
}
var warningelement = Y.Node.create('<div class="' + messageclasses + '" role="alert"></div>');
var warningelement = Y.Node.create('<div class="alert alert-warning" role="alert"></div>');
warningelement.setHTML(message);
drawingregion.prepend(warningelement);
// Copy info icon template.
warningelement.append(icontemplate.one('*').cloneNode());
// Append the message.
warningelement.append(message);
// Add the entire warning to the container.
warningregion.prepend(warningelement);
// Remove the message after a short delay.
warningelement.transition(
{
duration: duration,
delay: delay,
opacity: 0
},
function() {
warningelement.remove();
}
);
},
/**
@@ -3887,7 +3915,7 @@ EDITOR.prototype = {
readonly = this.get('readonly');
if (!readonly && data.partial) {
// Warn about non converted files, but only for teachers.
this.warning(M.util.get_string('partialwarning', 'assignfeedback_editpdf'));
this.warning(M.util.get_string('partialwarning', 'assignfeedback_editpdf'), false);
}
// Update the ui.
@@ -4476,6 +4504,7 @@ EDITOR.prototype = {
* @method save_current_page
*/
save_current_page: function() {
this.clear_warnings(false);
if (this.get('destroyed')) {
return;
}
@@ -4503,16 +4532,9 @@ EDITOR.prototype = {
if (jsondata.error) {
return new M.core.ajaxException(jsondata);
}
// Show warning that we have not saved the feedback.
Y.one(SELECTOR.UNSAVEDCHANGESINPUT).set('value', 'true');
Y.one(SELECTOR.UNSAVEDCHANGESDIV).setStyle('opacity', 1);
Y.one(SELECTOR.UNSAVEDCHANGESDIV).setStyle('display', 'inline-block');
Y.one(SELECTOR.UNSAVEDCHANGESDIV).transition({
duration: 1,
delay: 2,
opacity: 0
}, function() {
Y.one(SELECTOR.UNSAVEDCHANGESDIV).setStyle('display', 'none');
});
this.warning(M.util.get_string('draftchangessaved', 'assignfeedback_editpdf'), true);
} catch (e) {
return new M.core.exception(e);
}
@@ -4587,6 +4609,22 @@ EDITOR.prototype = {
}
},
/**
* Clear all current warning messages from display.
* @protected
* @method clear_warnings
* @param {Boolean} allwarnings If true, all previous warnings are removed.
*/
clear_warnings: function(allwarnings) {
// Remove all warning messages, they may not relate to the current document or page anymore.
var warningregion = this.get_dialogue_element(SELECTOR.WARNINGMESSAGECONTAINER);
if (allwarnings) {
warningregion.empty();
} else {
warningregion.all('.alert-info').remove(true);
}
},
/**
* Load the image for this pdf page and remove the loading icon (if there).
* @protected
@@ -4653,6 +4691,7 @@ EDITOR.prototype = {
pageselect.removeAttribute('disabled');
pageselect.on('change', function() {
this.currentpage = pageselect.get('value');
this.clear_warnings(false);
this.change_page();
}, this);
@@ -4676,6 +4715,7 @@ EDITOR.prototype = {
if (this.currentpage < 0) {
this.currentpage = 0;
}
this.clear_warnings(false);
this.change_page();
},
@@ -4690,6 +4730,7 @@ EDITOR.prototype = {
if (this.currentpage >= this.pages.length) {
this.currentpage = this.pages.length - 1;
}
this.clear_warnings(false);
this.change_page();
},
mod/assign/feedback/editpdf/yui/src/editor/js/editor.js
Vendored
+55 -16
View File
@@ -483,7 +483,7 @@ EDITOR.prototype = {
// The combined document is still waiting for input to be ready.
poll = true;
} else if (data.status === 1) {
} else if (data.status === 1 || data.status === 3) {
// The combine document is ready for conversion into a single PDF.
poll = true;
@@ -560,15 +560,41 @@ EDITOR.prototype = {
* Display an error in a small part of the page (don't block everything).
*
* @param string The error text.
* @param boolean dismissable Not critical messages can be removed after a short display.
* @protected
* @method warning
*/
warning: function(message) {
var drawingregion = this.get_dialogue_element(SELECTOR.DRAWINGREGION);
warning: function(message, dismissable) {
var icontemplate = this.get_dialogue_element(SELECTOR.ICONMESSAGECONTAINER);
var warningregion = this.get_dialogue_element(SELECTOR.WARNINGMESSAGECONTAINER);
var delay = 15, duration = 1;
var messageclasses = 'assignfeedback_editpdf_warningmessages alert alert-warning';
if (dismissable) {
delay = 4;
messageclasses = 'assignfeedback_editpdf_warningmessages alert alert-info';
}
var warningelement = Y.Node.create('<div class="' + messageclasses + '" role="alert"></div>');
var warningelement = Y.Node.create('<div class="alert alert-warning" role="alert"></div>');
warningelement.setHTML(message);
drawingregion.prepend(warningelement);
// Copy info icon template.
warningelement.append(icontemplate.one('*').cloneNode());
// Append the message.
warningelement.append(message);
// Add the entire warning to the container.
warningregion.prepend(warningelement);
// Remove the message after a short delay.
warningelement.transition(
{
duration: duration,
delay: delay,
opacity: 0
},
function() {
warningelement.remove();
}
);
},
/**
@@ -614,7 +640,7 @@ EDITOR.prototype = {
readonly = this.get('readonly');
if (!readonly && data.partial) {
// Warn about non converted files, but only for teachers.
this.warning(M.util.get_string('partialwarning', 'assignfeedback_editpdf'));
this.warning(M.util.get_string('partialwarning', 'assignfeedback_editpdf'), false);
}
// Update the ui.
@@ -1203,6 +1229,7 @@ EDITOR.prototype = {
* @method save_current_page
*/
save_current_page: function() {
this.clear_warnings(false);
if (this.get('destroyed')) {
return;
}
@@ -1230,16 +1257,9 @@ EDITOR.prototype = {
if (jsondata.error) {
return new M.core.ajaxException(jsondata);
}
// Show warning that we have not saved the feedback.
Y.one(SELECTOR.UNSAVEDCHANGESINPUT).set('value', 'true');
Y.one(SELECTOR.UNSAVEDCHANGESDIV).setStyle('opacity', 1);
Y.one(SELECTOR.UNSAVEDCHANGESDIV).setStyle('display', 'inline-block');
Y.one(SELECTOR.UNSAVEDCHANGESDIV).transition({
duration: 1,
delay: 2,
opacity: 0
}, function() {
Y.one(SELECTOR.UNSAVEDCHANGESDIV).setStyle('display', 'none');
});
this.warning(M.util.get_string('draftchangessaved', 'assignfeedback_editpdf'), true);
} catch (e) {
return new M.core.exception(e);
}
@@ -1314,6 +1334,22 @@ EDITOR.prototype = {
}
},
/**
* Clear all current warning messages from display.
* @protected
* @method clear_warnings
* @param {Boolean} allwarnings If true, all previous warnings are removed.
*/
clear_warnings: function(allwarnings) {
// Remove all warning messages, they may not relate to the current document or page anymore.
var warningregion = this.get_dialogue_element(SELECTOR.WARNINGMESSAGECONTAINER);
if (allwarnings) {
warningregion.empty();
} else {
warningregion.all('.alert-info').remove(true);
}
},
/**
* Load the image for this pdf page and remove the loading icon (if there).
* @protected
@@ -1380,6 +1416,7 @@ EDITOR.prototype = {
pageselect.removeAttribute('disabled');
pageselect.on('change', function() {
this.currentpage = pageselect.get('value');
this.clear_warnings(false);
this.change_page();
}, this);
@@ -1403,6 +1440,7 @@ EDITOR.prototype = {
if (this.currentpage < 0) {
this.currentpage = 0;
}
this.clear_warnings(false);
this.change_page();
},
@@ -1417,6 +1455,7 @@ EDITOR.prototype = {
if (this.currentpage >= this.pages.length) {
this.currentpage = this.pages.length - 1;
}
this.clear_warnings(false);
this.change_page();
},
mod/assign/feedback/editpdf/yui/src/editor/js/globals.js
Vendored
+3 -1
View File
@@ -41,7 +41,9 @@ var AJAXBASE = M.cfg.wwwroot + '/mod/assign/feedback/editpdf/ajax.php',
COMMENTMENU: '.commentdrawable a',
ANNOTATIONCOLOURBUTTON: '.annotationcolourbutton',
DELETEANNOTATIONBUTTON: '.deleteannotationbutton',
UNSAVEDCHANGESDIV: '.assignfeedback_editpdf_unsavedchanges',
WARNINGMESSAGECONTAINER: '.warningmessages',
ICONMESSAGECONTAINER: '.infoicon',
UNSAVEDCHANGESDIV: '.assignfeedback_editpdf_warningmessages',
UNSAVEDCHANGESINPUT: 'input[name="assignfeedback_editpdf_haschanges"]',
STAMPSBUTTON: '.currentstampbutton',
DIALOGUE: '.' + CSS.DIALOGUE
theme/boost/scss/moodle/modules.scss
+2 -2
View File
@@ -639,8 +639,8 @@ $popout-header-height: 4rem;
}
.assignfeedback_editpdf_widget .label {
@extend .tag;
@extend .tag-info;
@extend .alert;
@extend .alert-info;
}
.assignfeedback_editpdf_menu {
theme/boost/style/moodle.css
+10 -8
View File
@@ -5792,7 +5792,7 @@ tbody.collapse.show {
#page-admin-index .adminwarning,
#page-admin-index .adminerror, .que .formulation,
.que .outcome,
.que .comment {
.que .comment, .assignfeedback_editpdf_widget .label {
position: relative;
padding: 0.75rem 1.25rem;
margin-bottom: 1rem;
@@ -5841,13 +5841,13 @@ tbody.collapse.show {
.alert-success .alert-link, .que .comment .alert-link {
color: #1f3e1f; }
.alert-info, #page-admin-index .releasenoteslink, #adminsettings .form-overridden, .que .formulation {
.alert-info, #page-admin-index .releasenoteslink, #adminsettings .form-overridden, .que .formulation, .assignfeedback_editpdf_widget .label {
color: #2f6473;
background-color: #def2f8;
border-color: #d1edf6; }
.alert-info hr, #page-admin-index .releasenoteslink hr, #adminsettings .form-overridden hr, .que .formulation hr {
.alert-info hr, #page-admin-index .releasenoteslink hr, #adminsettings .form-overridden hr, .que .formulation hr, .assignfeedback_editpdf_widget .label hr {
border-top-color: #bce5f2; }
.alert-info .alert-link, #page-admin-index .releasenoteslink .alert-link, #adminsettings .form-overridden .alert-link, .que .formulation .alert-link {
.alert-info .alert-link, #page-admin-index .releasenoteslink .alert-link, #adminsettings .form-overridden .alert-link, .que .formulation .alert-link, .assignfeedback_editpdf_widget .label .alert-link {
color: #20454f; }
.alert-warning,
@@ -8524,7 +8524,7 @@ a.dimmed_text:visited,
/* stylelint-disable function-url-scheme-blacklist */
/* stylelint-enable function-url-scheme-blacklist */
.tag, .statusok, .statuswarning, .statusserious,
.statuscritical, .que .correctness, .assignfeedback_editpdf_widget .label, .label, .badge {
.statuscritical, .que .correctness, .label, .badge {
display: inline-block;
padding: 0.25rem 0.4em;
font-size: 75%;
@@ -8570,9 +8570,9 @@ a.dimmed_text:visited,
#page-admin-report-backups-index .backup-notyetrun[href]:focus {
background-color: #449d44; }
.tag-info, #page-admin-index .adminwarning.availableupdatesinfo .moodleupdateinfo.maturity200 .info.release, .assignfeedback_editpdf_widget .label {
.tag-info, #page-admin-index .adminwarning.availableupdatesinfo .moodleupdateinfo.maturity200 .info.release {
background-color: #5bc0de; }
.tag-info[href]:hover, #page-admin-index .adminwarning.availableupdatesinfo .moodleupdateinfo.maturity200 .info.release[href]:hover, .assignfeedback_editpdf_widget .label[href]:hover, .tag-info[href]:focus, #page-admin-index .adminwarning.availableupdatesinfo .moodleupdateinfo.maturity200 .info.release[href]:focus, .assignfeedback_editpdf_widget .label[href]:focus {
.tag-info[href]:hover, #page-admin-index .adminwarning.availableupdatesinfo .moodleupdateinfo.maturity200 .info.release[href]:hover, .tag-info[href]:focus, #page-admin-index .adminwarning.availableupdatesinfo .moodleupdateinfo.maturity200 .info.release[href]:focus {
background-color: #31b0d5; }
.tag-warning, .statuswarning, #page-admin-report-backups-index .backup-warning, #page-admin-index .updateplugin .updatepluginconfirmexternal, #page-admin-index .adminwarning.availableupdatesinfo .moodleupdateinfo.maturity100 .info.release,
@@ -12424,7 +12424,9 @@ span.editinstructions {
#course-category-listings .select-a-category .que .outcome,
.que #course-category-listings .select-a-category .outcome,
#course-category-listings .select-a-category .que .comment,
.que #course-category-listings .select-a-category .comment {
.que #course-category-listings .select-a-category .comment,
#course-category-listings .select-a-category .assignfeedback_editpdf_widget .label,
.assignfeedback_editpdf_widget #course-category-listings .select-a-category .label {
margin: 1em; }
#course-category-listings #course-listing .listitem .drag-handle {