The Annotation Field Module

Events happening in the community are now at Drupal community events on www.drupal.org.
bonobo's picture

I just saw this: http://drupal.org/project/annotationfield

From the description:

Want to highlight text, clip a video, or select a section of an image? This module is CCK nodereference on steroids. Annotation Field references not just a node, but a specific revision, field, and intra-field information (like a portion of text).

This module is authored by schuyler1d, who showcased the Multisite Manager at Drupalcon Boston -- the annotationfield module is still in development, but looks like it will deliver some great functionality wrt giving feedback on work/collaboratively editing documents.

Comments

(for text) vs annotate module?

SamRose's picture

It's amazing that you noted this, because I was just about to re-install http://drupal.org/project/annotate on a test site and explore changes to it.

For text annotation, I wonder how this module with line up against annotate? I am really looking for something that will emulate functionality of http://www.djangobook.com/en/1.0/chapter03/ (django inline comments) or http://www.futureofthebook.org/commentpress/about/ for drupal, for inline ("folded") text annotation.

The other stuff mentioned on http://drupal.org/project/annotationfield of course looks fantastic.

Sam Rose
Social Synergy
Open Source Ecology
P2P Foundation

this would be a great comparison

bonobo's picture

I'm sure that there are many others (and I include myself here) that would love to see this comparison --

Would you consider sharing your notes?

Cheers,

Bill


FunnyMonkey
Tools for Teachers

Any movement on text annotation modules for Drupal 8?

hazit's picture

Hi there,

Thanks for this thread - it least gives me some hope this kind of thing might be do-able in Drupal 8.

Just wondering if anyone knows of anything use-able out there.

A quick scan comes up with the following:
- https://www.drupal.org/project/co_ment
- https://www.drupal.org/project/recogito_integration
- https://www.drupal.org/project/annotationfield
- https://www.drupal.org/project/annotator
- https://www.drupal.org/project/annotate

All of which seem to be stalled. Does anyone have any updates or insights?

Cheers and thanks

We created a module using the

bryantt's picture

We created a module using the AnnotatorJS library https://www.drupal.org/sandbox/bryantt/2528442. You can see it working here, https://michaelfield.dickinson.edu/book/l-indiff%C3%A9rent It's getting a bit long in the tooth, though, and a major drawback was if that html changes at all, the annotations would no longer appear. I know they are also working on a new version of AnnotatorJS. http://annotator.apache.org/

We also created a module for Drupal 9, but it's more inline comments than annotation. https://www.drupal.org/project/annotate_node If that works for you, it wouldn't take much to make it work on Drupal 8. The only major difference I remember is that popperJS is in core in Drupal 9 and wasn't in Drupal 8, so you'd have to add it as a library.

cool, i hope it's more advanced though

btopro's picture

Is annotate just like private (or public) log messages per node? We're currently integrating diigo (www.diigo.com) into the workflow for course collaboration between instructional designer and instructor. Not sure what annotationfield will become until a demo's released but I hope it's hovering around this concept cause diigo's pretty insanely powerful when it comes to collaborating on a document.

Well, it's silly to comment

schuyler1d's picture

Well, it's silly to comment too much on what I haven't released :-(
I'm working on putting together something releasable, but I can answer some basic questions.

For text annotations, I'm using the javascript library marginalia. Starting with his old version which supports IE 6. The main thing though is that text annotations are recorded by highlighting specific text (rather than paragraphs).

However, the general framework would also support a paragraph annotation module similar to what I've seen at comment press.

The first alpha release will be quite humble--better UI and discussion group-type features is what I'm working on now.

Installed both..

SamRose's picture

Right now I am just analyzing annotate_bl and annotationfield/textfield (not yet looked at video or image annotate).

Basically, neither annotate_bl nor annotationfield/textfield are finished or ready for use at this point in their current state, but of course they are not represented to be a release either.

annotate_bl

see screenshot http://www.socialsynergyweb.com/cgi-bin/wiki2/Temp/download/annotatebm.jpg

I like the direction this is going in. Annotations become nodes, but also displayed in the overlay window that is present when you click on "block level marker" tab on a node. The form for annotations at this time presents a space to denote the paragraph you wish to annotate, which is mapped by number, and a title and space for annotation. Annotations are then listed above the form. The two markers next to the paragraph are not yet functional at this time.

annotationfield/textfield

screenshot http://www.socialsynergyweb.com/cgi-bin/wiki2/Temp/annotationfieldtext.jpg

Basically this one also creates a node as annotation. I like the direction this one is going in, too. Works with code from http://www.geof.net/code/annotation. Although, the function is as of yet incomplete (you click on a tab on an annotatable node, you highlight text, click "grab selection", then fill in your annotation, which then at this point in the modules evolution becomes part of a new node. Now the full text of highlighted node, plus your indistinguishable annotations now become part of a new node.)

Would be cool for this one, if annotations stay with node being annotated. Assuming that will be part of future development. I like the idea of highlighting, and the functionality that is present on http://www.geof.net/code/annotation. I'm evaluating these two modules with some other folks, to consider which we might want to try and pour some labor into. So far annotationfield/textfield seems to be the best looking for us. One of the things we want to explore is the idea of "merging" in content from annotations into a revision of a node. After spending years workign with wikis, and 'refactoring' pages, we think this could be a more natural way for people to first note while reading, but also combine desired changes into work (preferrably without having to edit the whole body of the page). I actually like the highlighting vs. paragraph ("block-level") annotation. Highlighting first of all shows readers exactly where annotation exists with a quick glance. Plus, it allows users to work with specific text content sections. There is more flexibility when you can highlight parts of text exactly. Plus, it could ultimately work with more types of text content (beyond just text content that is sectioned off into paragraphs). Like code, for instance...plus engineering materials, tabled documents that contain text (like parts lists, certain kinds of catalogues, etc) So this could really be useful for a wide swath of people. Thanks for making it!

Sam Rose
Social Synergy
Open Source Ecology
P2P Foundation

much obliged that you took

schuyler1d's picture

much obliged that you took the time to evaluate. WRT, node revision integration, I'm also excited about that possibility. I think it would be pretty doable, especially, if revisions begin storing diffs:
http://groups.drupal.org/node/9510

Internally, I should note that we have more use cases for the media/image annotation features to move forward, but I'm committed to moving the text annotation along with the rest.

If there are a few specific features that would get this module to where you could begin developing for it (like a 'view all the annotations on a node' view), then I can try to prioritize those.

I think I/"we" (people

SamRose's picture

I think I/"we" (people working with me) would like to help you, if we can.

"view all the annotations on a node" view is definitely a specific feature that could be immediately useful. Infact, the only thing you are really missing that I can see, to make this module immediately useful is that view on the node, and accompanying interface.

Along the lines of http://groups.drupal.org/node/9510 this was actually a really cool idea http://drupal.org/node/50682 could also be done with revision control like hg (mercurial) which can also "branch" a page, and clone itself entirely. Could be an option for storage and handling of diffs, for those who have heavy revision of text. This is like what we are doing in python with http://dandelion.sheep.art.pl/ (dandelion wiki engine)

Please feel free to contact me directly, or keep us all updated here, let me know what kind of help you need to move forward with text annotation, is some of the burden can be taken off of you, so that you could concentrate on the other included modules. Folks that I am working with are interested in text, image, and video annotation in drupal very much like http://voicethread.com/#home and I will very likely be able to acquire and offer funding for the development of your module(s) later on this year (wanting to work with your license/module so that code can be released under open license and part of Drupal.org community).

In the meantime, please let me know what, if anything we can do to help with text. Thanks!!

Sam Rose
Social Synergy
Open Source Ecology
P2P Foundation

very very cool

kyle_mathews's picture

I would love to have access to an annotation module for Drupal. I seen tons of potential uses in education/academia (peer-review of papers, peer-grading, etc.), the newsroom, and elsewhere.

Kyle Mathews

Kyle Mathews

annotationfield update

schuyler1d's picture

This is an update on the annotationfield module to this community.

Unfortunately, not much work has happened over the last month due to other projects, but I'm coming back to annotationfield for this month.

There is now a demo site, where you can see the current capabilities of the module:
http://drupaldemo.ccnmtl.columbia.edu/

The one significant thing that has been added since I last commented here is that video/images 'highlight' the annotated area in their own respective ways: annotating the time track or a box around the highlighted section. Obviously tons more to do, but this was necessary before all the annotations on a particular object could be shown at once.

Marginalia

lejon's picture

Hi,

As part of your building of this module, did you experiment with using MArginalia with Drupal as it stands?

If so, did you get it to work? And if so, errr, do you have time to explain how?

Also, have you contacted the guy in charge of the Annotate module: http://drupal.org/project/annotate - Clemens? He did have a group up here in drupal groups but it seemed to disappear. However, I noticed he just put out a new release of his annotate module, so he must still be working on it.

I'm looking for a simple way for multiple commentators to put multiple comments in the margin of a document to make document collaboration simpler.

Currently the obvious thing is to use google docs instead, but I can't find any way of incorporating that into Drupal - unless anyone else has somehow tried this?

I'm using Marginalia for

schuyler1d's picture

I'm using Marginalia for text annotation. As for marginalia's full interface, the more modern code base is abstracted to be able to consider it, but does not support IE6/7. The IE6-working version, which I'm using does not have the abstraction necessary. It would be a significant project, either way.

I've contacted Clemens, and we have exchanged notes. He and I have different short-term goals, but my hope is that our work can be integrated a bit later when I have some more scaffolding in place. I'm very happy he's still working on it.

As for ultimate goals, I'm looking for the same thing as you, with the twist that 'document' needs to be possibly an image or a video as well.

If you're familiar with the marginalia code and have some spare cycles, please contact me directly.

Sorry, I'm a code dunce.

lejon's picture

Sorry, I'm a code dunce. I've been looking around and there seems to be some work on tying in Google Docs with Drupal.

There's a basic publish-googledoc-as-blog: http://driesknapen.net/taxonomy/term/9/0

but also some talk on jodconverter: http://drupal.org/node/191700 which will convert stuff to be viewed in Drupal and this module: http://drupal.org/project/fileframework which is really interesting, but only for Drupal 6, which will allow you to display all sorts of stuff directly in Drupal (media files, Office files etc.).

I don't know if there's something tying all this stuff together but I'd like to be able to publish the draft of a book (which will be printed hard-copy and has to look good) as a Drupal book/nodes for editing and commenting on, then export it back to OpenOffice or whatever and get it into a final, print-ready version.

I think this is all a looooong way off...

Possible new life, in a different direction

patrickmj's picture

Hi all,

kyle_mathews reminded me of this thread when I posted about an Open Review module I'm working on. It's not aiming to meet all the functionality, but it might hit some of it.

Hoping that there's lurking interest here. Thanks!

Patrick

Suggestion for Annotate

akayani's picture

Jeditable
http://www.appelsiini.net/projects/jeditable/default.html

This might be worth building into the annotate module as a way to establish inline text markers for comments which is what is lacking.

Also this...

akayani's picture

http://drupal.org/project/co_ment

That looks promising but there are fees attached and the trial is only 2 days long. I'm not sure I can even trouble-shoot the issues with this in 2 days. ;)

You can compile a Python version and run that on your sever. That's a bit beyond what I feel like doing.

I am trying to implement some

dwangba's picture

I am trying to implement some kind of annotations too and came up with this idea :
it would be awesome to have Range objects defined as entities. You could then relate the created entity to any other entity (a node or a comment) to build an annotation system.
This would give integration with contributed modules "out of the box" and one could even come up with crazy ideas such as annotations annotating other annotations!
As I am fairly new to drupal concepts, this might as well be a stupid idea...

It was not such a stupid idea after all!

dwangba's picture

I spent the past 2 months learning the Drupal framework and working on such a module. You can find my sandbox here :
http://drupal.org/sandbox/dwangba/1431876
Please be aware that I am not a developer and that this module still needs a lot of work. Any help and feedback is more than welcomed!

no it seems pretty cool actually

scottrigby's picture

wil try to check it out more closely soon