digilib-old: webapp/src/main/webapp/jquery/jquery.digilib.annotations.js comparison

comparison webapp/src/main/webapp/jquery/jquery.digilib.annotations.js @ 1086:782593171adb

comments for annotations plugin.

author	robcast
date	Mon, 04 Jun 2012 11:09:41 +0200
parents	1d3e8f853b9c
children	ebdde1bbb026

comparison

equal deleted inserted replaced

-:53c61e3e64c7
+:782593171adb
 /**
 digilib plugin for annotations.
-currently only point-like (like marks).
+currently only point-like annotations (like marks).
+Annotations are stored on a Annotator http://annotateit.org compatible server.
 */
 (function($) {
 digilib.fn.redisplay(data);
 }
 },
 };
+/**
+* create a new annotation object
+*/
 var newAnnotation = function(mpos, text, id, uri, user) {
 var annot = {
 pos : mpos,
 text : text,
 id : id,
 */
 var getAnnotationPageUrl = function(data) {
 var url = data.settings.digilibBaseUrl + '/jquery/digilib.html?';
 url += digilib.fn.getParamString(data.settings, ['fn', 'pn'], digilib.defaults);
 return url;
-}
+};
 /**
 * add a mark-annotation where clicked.
-*
 */
 var setAnnotationMark = function(data) {
 var $scaler = data.$scaler;
 // unbind other handler TODO: do we need to do this?
 $scaler.off(".dlZoomDrag");
 $scaler.one('mousedown.dlSetAnnotationMark', function(evt) {
 // event handler adding a new mark
 console.log("setAnnotationMark at=", evt);
 var mpos = geom.position(evt);
 var pos = data.imgTrafo.invtransform(mpos);
+// Annotation text entered in JS-prompt
 var text = window.prompt("Annotation text:");
 if (text == null)
 return false;
 var annotation = newAnnotation(pos, text);
 storeAnnotation(data, annotation);
 });
 };
 /**
 * place annotations on the image
-*
 */
 var renderAnnotations = function(data) {
 if (data.annotations == null || data.$img == null || data.imgTrafo == null)
 return;
 var cssPrefix = data.settings.cssPrefix;
 mpos.adjustDiv($annotation);
 }
 }
 };
+/**
+* Get an authentication token from the token server.
+*
+* Stores the token and loads annotations on success.
+*/
 var loadAnnotationToken = function(data) {
 var settings = data.settings;
 var url = settings.annotationTokenUrl;
 // TODO: better error handling
 $.get(url, function(authToken, authStatus) {
 data.annotationToken = authToken;
 loadAnnotations(data);
 });
 };
+/**
+* loads all annotations for this url from the annotation server.
+*/
 var loadAnnotations = function(data) {
 var settings = data.settings;
+// we use the search API
 var url = settings.annotationServerUrl + '/search';
 var pageUrl = getAnnotationPageUrl(data);
 // send authentication token in header
 headers = {
 'x-annotator-auth-token' : data.annotationToken
 };
-// get only annotations with this url
+// get only 20 annotations with this url
 var query = {
 limit : 20,
 uri : pageUrl
 };
 $.ajax(url, {
 renderAnnotations(data);
 }
 });
 };
+/**
+* parse all JSON-annotations in annotationData.rows and put in data.annotations
+*/
 var parseAnnotations = function(data, annotationData) {
 var annotations = [];
 for (var i = 0; i < annotationData.rows.length; ++i) {
 var ann = annotationData.rows[i];
 var annot = parseAnnotation(ann)
 }
 }
 data.annotations = annotations;
 };
+/**
+* Parse a JSON-annotation.
+*
+* Returns an annotation object.
+*/
 var parseAnnotation = function(ann) {
 // TODO: check validity of annotation data
 if (ann.areas != null && ann.areas.length > 0) {
 var area = ann.areas[0];
+// currently only point annotations
 var pos = geom.position(area.x, area.y);
 return newAnnotation(pos, ann.text, ann.id, ann.uri, ann.user);
 }
 return null;
 };
+/**
+* Store an annotation on the annotation server.
+*/
 var storeAnnotation = function(data, annotation) {
 console.debug("storeAnnotation:", annotation);
 var settings = data.settings;
 var url = settings.annotationServerUrl + '/annotations';
 var pageUrl = getAnnotationPageUrl(data);
 // TODO: we have to add the returned data to the real annotation!
 //renderAnnotations(data);
 }
 });
-}
+};
-/** install additional buttons */
+/**
+* install additional buttons
+*/
 var installButtons = function(data) {
 var settings = data.settings;
 var mode = settings.interactionMode;
 var buttonSettings = settings.buttonSettings[mode];
 // configure buttons through digilib "annotationSet" option
 buttonSettings.annotationSet = buttonSet;
 buttonSettings.buttonSets.push('annotationSet');
 }
 };
-/** plugin installation called by digilib on plugin object. */
+/**
+* plugin installation. called by digilib on plugin object.
+*/
 var install = function(plugin) {
 digilib = plugin;
 console.debug('installing annotations plugin. digilib:', digilib);
 // import geometry classes
 geom = digilib.fn.geometry;
 // install event handler
 $data.bind('setup', handleSetup);
 $data.bind('update', handleUpdate);
 };
+/**
+* setup loads all annotations.
+*/
 var handleSetup = function(evt) {
 console.debug("annotations: handleSetup");
 var data = this;
 // load annotations from server
 loadAnnotationToken(data);
 };
+/**
+* update renders all annotations.
+*/
 var handleUpdate = function(evt) {
 console.debug("annotations: handleUpdate");
 var data = this;
 if (data.marks != null) {
 renderAnnotations(data);