[annotator-dev] linking to annotations within annotated document

Wed Feb 25 23:27:58 UTC 2015

Sounds great.  I'll hold off on messing with the annotator internals,
then.  :)

Do you have any kind of eta on when you'll have 1.2.10 published?  I'm not
in a rush, but it would be good to have an estimate for planning purposes.

On Wed, Feb 25, 2015 at 6:20 PM, Randall Leeds <tilgovi at hypothes.is> wrote:

> Quick response.
>
> I think you understood everything perfectly. As much as we'd like to have
> people testing out what will become Annotator 2.0, it's a bit different and
> not well documented yet, so I'm hesitant to suggest you move to that.
>
> On the other hand, the 1.2.x branch had a change (almost a year ago!) to
> add a data-annotation-id attribute to the highlights. This seems to be
> exactly what we just discussed and what would work for you.
>
> I'm going to try to publish v1.2.10 shortly since it's long overdue, which
> will have this change, and that should get you going.
>
> Cheers!
>
> On Wed, Feb 25, 2015 at 3:15 PM, Shauna Gordon-McKeon <shaunagm at gmail.com>
> wrote:
>
>> Thanks for the quick reply.
>>
>>
>>
>>>
>>> First question is whether you've built your own annotator from the
>>> source or if you've used a pre-packaged version. Since we haven't yet had a
>>> 2.0 release the code you linked to has not been published as a built
>>> annotator.js yet. If you've built it yourself from git, that's great and
>>> I'm really glad to see people kicking the tires on master. If you're
>>> working from a 1.2 series release, then the code is a bit different.
>>>
>>>
>>
>> I've been using the pre-packaged version.  It seems like there's no way
>> to do what I want with the existing code, so it probably makes sense for me
>> to try building from git.
>>
>>
>>
>>>> Do folks have any suggestions?  I'm new to JQuery and pretty
>>>> inexperienced with Javascript generally, so my apologies if these are
>>>> questions with obvious answers.
>>>>
>>>
>>> I've stayed away from assigning ids to highlights because there is
>>> sometimes more than one highlight span associated with an annotation. This
>>> happens frequently when annotations overlap and the text needs to be split
>>> into several spans. Technically, there should only be one element with a
>>> given id on any page. Browsers are pretty tolerant, but I've nonetheless
>>> avoided adding ids for this reason.
>>>
>>> However, it might be very reasonable to add another attribute. For
>>> instance, maybe using jQuery to select for a different attribute would make
>>> this work for you.
>>>
>>> $('[annotation-id^=12345]')
>>>
>>> or something like this.
>>>
>>
>> Are you suggesting that a new attribute, annotation-id, be added to
>> span?  I think that's what you're saying, but I want to make sure we're on
>> the same page.  If attribute-id got duplicated due to dicing and splitting
>> of spans, that would be fine for my purposes -- I could easily use the
>> first and ignore any subsequent ones.
>>
>>
>>
>>>
>>> Unfortunately, that would not get the scroll-to behavior that having an
>>> id / anchor gets, where the URL can simply be set to #someid. However,
>>> since Annotator loads after the page is rendered this would not allow
>>> linking users directly to an annotation using the built-in browser support
>>> for anchors anyway. That may not be a concern, though.
>>>
>>
>> That would be the simplest way to do it, but it seems like one could link
>> directly by using JQuery again, something like scrollIntoView?
>>
>>
>>>
>>> Hopefully, that helps explain the problem space a bit and gives you a
>>> sense of where to look next. If there's anything we can add to the
>>> highlighter to make this easier, I'd be glad to help with those
>>> modifications.
>>>
>>
>> It does help, thank you.  If an annotation-id was added to the
>> highlighted spans, then I think I could create the functionality I need via
>> a plugin.  Without it, I'm not sure where I'd begin.
>>
>> How would you like to proceed?  It seems like until 2.0 is released I'm
>> going to have to build from git to get this functionality, so I might as
>> well go ahead and do that.  I can take a stab at modifying the highlighter
>> once I've done that, although I'm also perfectly happy to have you add it
>> in - I bet you'd be much faster.  :)
>>
>> - Shauna
>>
>>
>>
>>
>>>
>>> Randall
>>>
>>>
>>
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.okfn.org/pipermail/annotator-dev/attachments/20150225/1b8ae6e7/attachment-0004.html>