Annotation and context-sensitive copy for forums

Annotation and context-sensitive copy for forums

by Geoffrey Glass -
Number of replies: 20

I hope this is the right place to post this.

With support from BC Campus and Simon Fraser University, I've been working on an annotation feature for Moodle forums. It allows readers to highlight passages of text and add annotation in a margin next to each post. A summary page lists all annotations on a per-discussion basis, along with the associated highlighted text and a link back to the annotated post. Annotations are specific to each user; there's no way to share them yet.

I'm also working on a context-sensitive copy function. It automatically includes context information when text is copied from a forum post. This includes the author, title, and date of the post, and a link back to the post (this last only works if the target of the paste operation accepts HTML). The purpose here is to improve facilities for quoting within discussions.

There's a stand-alone demo of these features on my project page, along with a screenshot, screencast, and source code (this last is a few weeks old - I recommend waiting for my next update). I have also discussed several of the technical issues in my blog.

The implementation is AJAX-heavy - annotation highlighting and editing is in-place, with no need to reload the page. The implementation is dependent on the W3C Range specification, which as far as I know limits it to Mozilla for now. There is no need for any browser extensions or the like.

This project is still under development, and a number of significant bugs and limitations remain to be fixed (e.g. the annotation syndication feed is a security hole, Moodle is stripping URL paths in contextual copies, and I haven't dealt with messages that are deleted, edited, or split to another discussion). I am working on improved support for others browsers. It may be possible to add annotation creation support for Internet Explorer, but not for anything else that doesn't support the W3C Range spec. Displaying annotations (and possibly editing and deleting them as well) should be possible in all major browsers.

Average of ratings: -
In reply to Geoffrey Glass

Re: Annotation and context-sensitive copy for forums

by Martin Dougiamas -
Picture of Core developers Picture of Documentation writers Picture of Moodle HQ Picture of Particularly helpful Moodlers Picture of Plugin developers Picture of Testers
Ooo, nice.  This would be a perfect fit for the Online Assignment module.  approve
In reply to Martin Dougiamas

Re: Annotation and context-sensitive copy for forums

by Tom Murdock -
Yes, yes, this is great, Geoffrey!
In reply to Geoffrey Glass

Annotation for forums: Internet Explorer support

by Geoffrey Glass -

I have released a newer version of the annotation tool for the Moodle discussion forums. This includes many new features and bug fixes. An up-to-date online demo and source code are available on my site.

  • Internet Explorer support. Users of IE can create, view, edit, and delete annotations. Safari users can view them.
  • Smart copy (Firefox only). This includes citation information when a user copies and pastes from a forum post.
  • A search facility on the annotation summary page. The search includes the text of the annotation, the quote (i.e. the highlighted text), the title and author of the quoted passage, and the author of the annotation.
  • Annotations can be flagged as public (the default) or private. Public annotations are searchable by other users.
  • Permanent links to forum posts. Annotations and links to forum posts (e.g. from the summary page) are unaffected if a post is moved to another forum.
  • Detection of changes to a post. If annotations cannot be shown there, they are still available on the summary page, as are they if the post is deleted. (Users own their annotations.)
  • A summary page redesign means it should be relatively straightforward to add annotation support to other Moodle modules. I have included documentation explaining how this would work.
  • A simpler install and better diagnostic facilities in case of problems.
  • The system no longer requires Apache or mod_rewrite.

There are a few things that remain to be done if and when I have the time:

  • The system is not localized for other languages.
  • The annotation margin color is hard-coded.
  • Other users' annotations are only visible on the summary page, not on forum post pages.
  • Moodle's HTML editor strips the URLs created by smart copy, so they will not work outside the forum.
In reply to Geoffrey Glass

Re: Annotation for forums: Internet Explorer support

by Josep M. Fontana -
Cool! Would it be possible to extend this functionality to other modules/activities such as Lesson or to resources? There it would be also very useful.

Josep M.
In reply to Geoffrey Glass

Re: Annotation for forums: Internet Explorer support

by Tim Allen -
This looks exciting. Thanks for your work and I will give feedback as soon as I have tested it! smile

PS I think this tool would be even better allowing annotation on "non-communicative" texts such as text resources (eg. in the book module, text resources, even websites; also on assignment).

Tim.
In reply to Geoffrey Glass

Re: Annotation for forums: Internet Explorer support

by Geoffrey Glass -

Thank you for the enthusiasm smile I hope it's useful for you. If you have any trouble, drop me a line and I'll try to help.

I would like to see annotation in other Moodle modules, but I'll be busy for the next while and won't have as much time to devote to development. What time I do spend will likely focus on core features and any bug fixes.

It is very easy to add annotation to a page (view the HTML source for my online demo if you're curious - I have added some explanatory comments). For someone with some experience with a Moodle module I don't think it would be too hard.

In reply to Geoffrey Glass

Re: Annotation for forums: Internet Explorer support

by Ger Tielemans -

I try to install annotate under 1.5.2+ but:

  • test is on laptop with xampp 1.4.15/windows2000
    (Apache/2.0.54 (Win32) mod_ssl/2.0.54 OpenSSL/0.9.8 PHP/5.0.4 mod_autoindex_color mod_perl/1.999.21 Perl/v5.8.6)
  • I do not see any annotate buttons
  • First, if I press the show annotations button, I get a big error box, if I clcik that away, I can press the annoation summary link:
    • on the next screen IE6 thinks there is a missing icon /annotation/images/atomicon.gif
    • (while firefox shows on the same spot the word ATOM and suggests that there is atom 1.0 feed)
    • there is no back button on the annotation summary screen
Attachment vraag018.jpg
In reply to Ger Tielemans

Re: Annotation for forums: Internet Explorer support

by Geoffrey Glass -
Thanks for the report Ger. I see I didn't notice the missing icon in my install test (probably because FIrefox degrades nicely). I'll you answer through email for speed, then post here in case it can help anyone else. Geof
In reply to Ger Tielemans

Annotation Install Fix

by Geoffrey Glass -

I have uploaded an updated version of the annotation code with some fixes to the install process. These should resolve the missing icon and error message experienced by Ger. Anyone who has already downloaded annotation should get this latest version.

I am not sure I understand the other two issues Ger raised, which are the lack of a back button and no annotation buttons. I will assume my interpretations are correct:

The summary screen starts specific - e.g. showing annotations for a particular discussion - but provides a link to a more general list of annotations. There is no button to return to the more specific list.

The button for creating annotations is on the left of the annotation margin with faint outlines. It lights up in bright yellow (the highlight color) when the mouse hovers over it, shows a right angle bracket, and displays a tooltip explaining what it does. Unfortunately, the yellow does not appear in IE due to an IE bug.

I agree that I would like this to be more obvious, but I haven't figured out an interface which is a) obvious and b) non-intrusive. (I considered a right-click menu, but rejected it because of the added code complexity. I also tried to make a button appear only when text is selected, but there's no sure-fire way I can find to make it disappear when the text is deselected.)

In both cases, I am open to suggestions for how to improve the interface.

In reply to Geoffrey Glass

Re: Annotation Install Fix

by Ger Tielemans -
OK, works fine now. Thanks for the quick response, now I can explore it... smile

I can select a piece of text and then push the bar between the textfield an the annotation field: I could not see that bar because it was "grey" in my theme, sorry.

The "buttons" for delete and make public are very small.. hard to hit smile
 
This option of sharing notes, offers the students a way of sharing "meta-notes" during a discussion! Again a refinement of Moodle as communication support tool:
Kagan can rewrite his books about coop learning!!

In Moodle you usually do not use the back button of your browser (IE sad!) to go back. There are normally two options:
  1. the navigation bar offers you several return options
  2. there is often an extra ("back") button that brings you back to the previous page.
In the first Annotation Summary page you offer the navigation bar option, but you did loose the options: >>forums>>forumName (I would like to press ForumName or visit one of the other forums to inspect my annotations there.. )

If I press on the Annotation Summary screen on the link "Show all annotations in all discussions" then I loose this navigation bar complete (only the mainpage of the website survives...

(I realise now that this only disturbing as long as I have no annotations: in that case I can click on an annotation and come back along that route...)
In reply to Ger Tielemans

Re: Annotation Install Fix

by Ger Tielemans -

As Josep said: if you could make this a shared annotation tool for all kind of Moodle pages, you would fulfill my old wish to have a collab annotation tool in the spirit of good old Y-notes!!

But no misunderstandings: I like already very much what you have created here ! 

In reply to Ger Tielemans

Re: Annotation Install Fix

by Geoffrey Glass -
Thank you for the suggestions. I do need to do something about the create annotations button and margin colors - for now it's not picking up the theme as it should.

I agree completely about the delete and share buttons. I am particularly worried that users might hit the delete button when they need to share. However, I wasn't able to come up with an alternative I liked so I went ahead with what you see. There is no technical reason why they can't look different. In particular, I need icons for the share button. I was going to go with sun (public) and moon (private) unicode characters, but they don't display properly in Firefox. Others have suggested a lock symbol.

I see what you're saying about the lack of a back link. At the time, this was because it would have been quite complex to add. Now I have implemented most of the required infrastructure. However, if you go to a more general summary (e.g. all annotations) then I can't think of a sensible way to bring you back (since in theory you could have got there from any one of many discussions, or in future perhaps from other modules altogether).

Incidentally, the other thing that bugs me is the repeated summary links alongside each message. I would like this to be in the drop-down navigation menu at the top of the screen. But I've tried to make this as independent of the rest of Moodle as possible, both to limit scope and because I have to keep up with changes in the standard distribution (I'm not familiar with most of the Moodle code).

Incidentally, I discovered today that there's an incompatibility between annotations and the forum rating system. I'll be looking into finding a fix.
In reply to Geoffrey Glass

Re: Annotation Install Fix

by Geoffrey Glass -

I have released a new version (2005-08-20) with the ratings conflict fixed. I have also fixed the width of the annotation edit box to take advantage of the full width of the margin (the tiny box was bugging me).

I am keeping my fingers crossed that this will be the last update for some time. Heh.

In reply to Geoffrey Glass

Re: Annotation Install Fix

by Julian Ridden -
I allready installed your old version.

What are the differences between ###823 and ###820?
In reply to Geoffrey Glass

Re: Annotation and context-sensitive copy for forums

by Julian Ridden -
I installed your annotation patch into The Playpen and am having an issue.

I am not sure if I am just misunderstanding the concept or if it is a bug.

Annotations can be added successfully and viewed both in the left annotation pane through the "annotation summary".

However, once added. If I leave that page and come back, the annotation pane is now empty. The annotations are however still visible in the "annotation summary" window.

You can log in and check it out if you like. My demo for annotation is within the "New Features" course

Is this how it is meant to work? Or is something screwy

Julian
In reply to Julian Ridden

Re: Annotation and context-sensitive copy for forums

by Geoffrey Glass -
Hi Julian,

Absolutely, when you return to the page annotations should still be visible.

By pure chance, I made an improvement in my most recent release (20050823) which I believe will remedy your problem. If you like, I can instead send you the specific code which needs to be changed.

Your site is different because Moodle is installed in the site root (http://playpen.monte.nsw.edu.au instead of, say, http://playpen.monte.nsw.edu.au/moodle). My code didn't work when there is no path between the site and /mod. I changed the behavior a couple of days ago to make migration to new servers easier, but it should fix this bug too.

I have no server set up like yours to test on, but I was able to visit your site and examine what was going on. Everything looks good to me, so I think this will resolve your problem.

The main point of the 2005-08-23 release is a fix to the summary page, which was showing other users' shared annotations when it shouldn't.

By the way, nice looking site.

Geof
In reply to Geoffrey Glass

Re: Annotation and context-sensitive copy for forums

by Julian Ridden -
Thanks for that geof.

If you could email me the changes to put a fix in place I would be greatful.

The playen is built as a test/demo site. If you want to test in there I can give you teacher access if you like.
In reply to Geoffrey Glass

Re: Annotation and context-sensitive copy for forums

by Jon Bolton -
Picture of Testers
Hi Geoffrey.

I really like this code, and have included it on my site. Just one question... on the forum post heading, a number appears, unique to each forum post. It appears under the title of the post, and above the name (see screenshot). It's not hyperlinked.

I'm guessing it's something to do with the permalink, but it looks a bit out of place, and I am bound to get questions about what it is, why it's there, etc.

Also, there appears to be a slight issue with the public/private toggle. On the main discussion page, clicking on the button appears to do nothing, ie. it stays as a circle. If, however, you view the Annotations Summary page, it does appear as private.

Can you shed any light on either issue?
Attachment Image1.jpg
In reply to Jon Bolton

Re: Annotation and context-sensitive copy for forums

by Geoffrey Glass -
Hello Jon,

I apologize for not replying sooner:  I have been focused on supporting the local user community, so haven't been here often.  I should have received your message in my email, but I must have missed it.

I am not able to reproduce your problems on current versions of the system; it's possible they were bugs that were fixed. Although I certainly don't remember ever seeing a number where you indicate. If you happen to install a more recent release and encounter similar problems (or others for that matter) please let me know.