You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@annotator.apache.org by Benjamin Young <by...@bigbluehat.com> on 2017/07/03 16:14:32 UTC
RE: Precise-links browser extension
This is fabulous work, Gerben! Apologies for only just now following up.
I'm curious--from both you and Randall--what it would take to make Apache Annotator be the source of the libraries this Web extension depends on.
I know we still need to bring Randall's dom-anchor things "into the fold." However, I'm also curious what's different between your packaged version of the fragment identifier library and the one Randall did here. I'm guessing at least the ES6-ification?
The next steps--we seem to be having a hard time taking--is getting these libraries wrapped or added to the Apache Annotator repo + a similar factory style wrapper like the one you and Sasha have both created.
Help narrowing in on the differences will be useful.
Also, pull requests more than welcome! :)
Cheers!
Benjamin
-----Original Message-----
From: Gerben [mailto:gerben@treora.com]
Sent: Monday, May 29, 2017 3:20 PM
To: dev@annotator.incubator.apache.org
Subject: Precise-links browser extension
Hi all,
I have been silent here so far, but have been working a bit with Randall & Benjamin on our shared webby ambitions, and thought I'll share this one for your interests. At the I Annotate <https://iannotate.org> conference last month I made a simple browser extension to support Web Annotation Selectors in fragment identifiers, as specified in this W3C note <https://www.w3.org/TR/2017/NOTE-selectors-states-20170223/#frags>.
A location such
ashttps://en.wikipedia.org/w/index.php?title=Koala&oldid=781295795#selector(type=TextQuoteSelector,exact=fluffy%20ears)
<https://en.wikipedia.org/w/index.php?title=Koala&oldid=781295795#selector%28type=TextQuoteSelector,exact=fluffy%20ears%29>
will scroll to the words /fluffy ears/ and select them.
*Technicalities:*
The extension currently only supports TextQuoteSelectors using dom-anchor-text-quote <https://github.com/tilgovi/dom-anchor-text-quote>, which I abstracted through a minimal library I dub dom-anchor-selector <https://github.com/Treora/dom-anchor-selector>, with the intention of adding support for other selector types. I would be glad to have this library moved or rewritten under the Apache Annotator umbrella if there is interest.
The conversion between the selector as a javascript object and as a fragment identifier is done by code borrowed from Ivan Herman's converter <http://w3c.github.io/web-annotation/selector-note/converter/>, packaged as a module first by me here <https://github.com/Treora/selector-state-frags>, and again by Randall here <https://github.com/apache/incubator-annotator/tree/master/packages/fragment-identifier>
under the Apache Annotator project.
*Try it:*
For Firefox, available here
<https://addons.mozilla.org/en-US/firefox/addon/precise-links/>.
For Chromium, I yet only published it on my own server, here <https://temp.treora.com/precise-links.crx> for now. To install, download it and drag&drop the file to your list of extensions (chrome://extensions).
To create link to a segment of text, right-click the selection and choose 'Copy link to selected text'.
*Improve it:*
Extension code is here <https://github.com/Treora/precise-links>, though most improvements are to be done in the dependencies mentioned above.
It may be nice to also create a version of this code that people can easily include in their web pages, something I did previously with quoteurl <https://github.com/Treora/quoteurl>.
Cheers,
Gerben
Re: initial scope & API
Posted by Benjamin Young <by...@bigbluehat.com>.
Sorry for the top post kids...Outlook. >_<
Randall, great work on this new build system! I'll have some follow-up issues/questions soon!
Gerben, I'm super glad you're still here! :D My July (like Randall's) was full of unexpected things--travel, a death in the family, and more... Consequently, that meant I fell behind on my duties here. Apologies.
I do think we're getting close to being ready for a bi-weekly check-in style approach.
Also, anyone (and everyone) should feel free to contribute ideas/thoughts/hopes/concerns here and on the repos: http://annotator.apache.org/
More emails to follow. :)
Benjamin
--
http://bigbluehat.com/
http://linkedin.com/in/benjaminyoung
________________________________
From: Randall Leeds <ra...@apache.org>
Sent: Saturday, August 12, 2017 9:05:26 PM
To: dev@annotator.incubator.apache.org
Subject: Re: initial scope & API
On Fri, Aug 11, 2017 at 5:12 AM Gerben <ge...@treora.com> wrote:
>
> Two weeks passed without response, I guess my suggestion for biweekly
> progress is rather hopeless. Perhaps a more likely productive approach
> could be to try meet up again somewhere sometime, and spend a day or two
> on creating a basic outline and setup?
>
My apologies, Gerben. I had a really busy July and then I was a bit sick
for a week.
I've just pushed a PR to refresh the build system and hopefully unblock us
all starting to contribute more. The tooling should be more familiar to
others now, using webpack. A demo page is set up in the repo just to sketch
how we might start writing.
I'll look over the overview in the wiki. Thanks for starting that!
We can continue to discuss API, but concrete next steps for me are going to
probably be to import existing repos (dom-anchor-*) and get the test
infrastructure and CI ported over for those.
If there's anything I can do to unblock others, please feel free to poke me
repeatedly here or on IRC.
R
Re: initial scope & API
Posted by Randall Leeds <ra...@apache.org>.
On Fri, Aug 11, 2017 at 5:12 AM Gerben <ge...@treora.com> wrote:
>
> Two weeks passed without response, I guess my suggestion for biweekly
> progress is rather hopeless. Perhaps a more likely productive approach
> could be to try meet up again somewhere sometime, and spend a day or two
> on creating a basic outline and setup?
>
My apologies, Gerben. I had a really busy July and then I was a bit sick
for a week.
I've just pushed a PR to refresh the build system and hopefully unblock us
all starting to contribute more. The tooling should be more familiar to
others now, using webpack. A demo page is set up in the repo just to sketch
how we might start writing.
I'll look over the overview in the wiki. Thanks for starting that!
We can continue to discuss API, but concrete next steps for me are going to
probably be to import existing repos (dom-anchor-*) and get the test
infrastructure and CI ported over for those.
If there's anything I can do to unblock others, please feel free to poke me
repeatedly here or on IRC.
R
Re: initial scope & API
Posted by Gerben <ge...@treora.com>.
On 2017-07-26 17:56, Gerben wrote:
> On 2017-07-11 02:29, Gerben wrote:
>> Sure, on the wiki could work. Just to get the ball rolling, I drafted a
>> possible outline with some questions:
>> https://github.com/apache/incubator-annotator/wiki/Overview-(WIP)
>>
>>
>> On 2017-07-09 02:22, Benjamin Young wrote:
>>> Agreed. Let's begin working on some API design while Randall finishes sorting out the build kit and importing his libraries.
>>>
>>> We can do that on the wiki, if that works:
>>> https://github.com/apache/incubator-annotator/wiki
>>>
>>> Cool? :)
>>>
> Any thoughts from your side on scope and API? (quite related, issue 7
> <https://github.com/apache/incubator-annotator/issues/7>: "Make the
> purpose of this tool clear(er)") Would be nice to hear from at least
> both of you (Benjamin, Randall) what you are roughly thinking of making
> here.
>
> My (possibly wrong) impression is that everybody waits for others to
> start doing something. Would it help to give ourselves some homework and
> try schedule a first few milestones and progress calls? E.g. settle on
> an initial scope & API outline in the next two weeks, then call to both
> round that up and decide what we try implement in the two subsequent weeks?
>
> Gerben
>
> (also, perhaps better to switch to bottom-posting, if we grow a longer
> thread)
Two weeks passed without response, I guess my suggestion for biweekly
progress is rather hopeless. Perhaps a more likely productive approach
could be to try meet up again somewhere sometime, and spend a day or two
on creating a basic outline and setup?
Re: initial scope & API (was: Precise-links browser extension)
Posted by Gerben <ge...@treora.com>.
On 2017-07-11 02:29, Gerben wrote:
> Sure, on the wiki could work. Just to get the ball rolling, I drafted a
> possible outline with some questions:
> https://github.com/apache/incubator-annotator/wiki/Overview-(WIP)
>
>
> On 2017-07-09 02:22, Benjamin Young wrote:
>> Agreed. Let's begin working on some API design while Randall finishes sorting out the build kit and importing his libraries.
>>
>> We can do that on the wiki, if that works:
>> https://github.com/apache/incubator-annotator/wiki
>>
>> Cool? :)
>>
Any thoughts from your side on scope and API? (quite related, issue 7
<https://github.com/apache/incubator-annotator/issues/7>: "Make the
purpose of this tool clear(er)") Would be nice to hear from at least
both of you (Benjamin, Randall) what you are roughly thinking of making
here.
My (possibly wrong) impression is that everybody waits for others to
start doing something. Would it help to give ourselves some homework and
try schedule a first few milestones and progress calls? E.g. settle on
an initial scope & API outline in the next two weeks, then call to both
round that up and decide what we try implement in the two subsequent weeks?
Gerben
(also, perhaps better to switch to bottom-posting, if we grow a longer
thread)
Re: Precise-links browser extension
Posted by Gerben <ge...@treora.com>.
Sure, on the wiki could work. Just to get the ball rolling, I drafted a
possible outline with some questions:
https://github.com/apache/incubator-annotator/wiki/Overview-(WIP)
On 2017-07-09 02:22, Benjamin Young wrote:
> Agreed. Let's begin working on some API design while Randall finishes sorting out the build kit and importing his libraries.
>
> We can do that on the wiki, if that works:
> https://github.com/apache/incubator-annotator/wiki
>
> Cool? :)
>
> -----Original Message-----
> From: Gerben [mailto:gerben@treora.com]
> Sent: Saturday, July 8, 2017 7:47 PM
> To: dev@annotator.incubator.apache.org
> Subject: Re: Precise-links browser extension
>
> On 2017-07-03 18:14, Benjamin Young wrote:
>> This is fabulous work, Gerben! Apologies for only just now following up.
>>
>> I'm curious--from both you and Randall--what it would take to make Apache Annotator be the source of the libraries this Web extension depends on.
> I think it would take a rough consensus on how packages should be organised (with what scope and APIs etc.), and then a bit of coding to implement them. I'm happy to code some things, but don't want to waste time making stuff that others would consider e.g. out of scope. Perhaps we could start drafting API docs together to align our plans.
>> I know we still need to bring Randall's dom-anchor things "into the fold." However, I'm also curious what's different between your packaged version of the fragment identifier library and the one Randall did here. I'm guessing at least the ES6-ification?
> They are nearly the same, but Randall did some more refactoring of the original code <https://github.com/w3c/web-annotation/tree/gh-pages/selector-note/converter>
> by Ivan Herman. I think we should agree on the desired API and merge them into one.
>> The next steps--we seem to be having a hard time taking--is getting these libraries wrapped or added to the Apache Annotator repo + a similar factory style wrapper like the one you and Sasha have both created.
>>
>> Help narrowing in on the differences will be useful.
>>
>> Also, pull requests more than welcome! :)
>>
>> Cheers!
>> Benjamin
>>
>> -----Original Message-----
>> From: Gerben [mailto:gerben@treora.com]
>> Sent: Monday, May 29, 2017 3:20 PM
>> To: dev@annotator.incubator.apache.org
>> Subject: Precise-links browser extension
>>
>> Hi all,
>>
>> I have been silent here so far, but have been working a bit with Randall & Benjamin on our shared webby ambitions, and thought I'll share this one for your interests. At the I Annotate <https://iannotate.org> conference last month I made a simple browser extension to support Web Annotation Selectors in fragment identifiers, as specified in this W3C note <https://www.w3.org/TR/2017/NOTE-selectors-states-20170223/#frags>.
>> A location such
>> ashttps://en.wikipedia.org/w/index.php?title=Koala&oldid=781295795#sel
>> ector(type=TextQuoteSelector,exact=fluffy%20ears)
>> <https://en.wikipedia.org/w/index.php?title=Koala&oldid=781295795#sele
>> ctor%28type=TextQuoteSelector,exact=fluffy%20ears%29>
>> will scroll to the words /fluffy ears/ and select them.
>>
>> *Technicalities:*
>>
>> The extension currently only supports TextQuoteSelectors using dom-anchor-text-quote <https://github.com/tilgovi/dom-anchor-text-quote>, which I abstracted through a minimal library I dub dom-anchor-selector <https://github.com/Treora/dom-anchor-selector>, with the intention of adding support for other selector types. I would be glad to have this library moved or rewritten under the Apache Annotator umbrella if there is interest.
>>
>> The conversion between the selector as a javascript object and as a
>> fragment identifier is done by code borrowed from Ivan Herman's
>> converter
>> <http://w3c.github.io/web-annotation/selector-note/converter/>,
>> packaged as a module first by me here
>> <https://github.com/Treora/selector-state-frags>, and again by Randall
>> here
>> <https://github.com/apache/incubator-annotator/tree/master/packages/fr
>> agment-identifier>
>> under the Apache Annotator project.
>>
>> *Try it:*
>>
>> For Firefox, available here
>> <https://addons.mozilla.org/en-US/firefox/addon/precise-links/>.
>>
>> For Chromium, I yet only published it on my own server, here <https://temp.treora.com/precise-links.crx> for now. To install, download it and drag&drop the file to your list of extensions (chrome://extensions).
>>
>> To create link to a segment of text, right-click the selection and choose 'Copy link to selected text'.
>>
>> *Improve it:*
>>
>> Extension code is here <https://github.com/Treora/precise-links>, though most improvements are to be done in the dependencies mentioned above.
>>
>> It may be nice to also create a version of this code that people can easily include in their web pages, something I did previously with quoteurl <https://github.com/Treora/quoteurl>.
>>
>> Cheers,
>>
>> Gerben
>>
RE: Precise-links browser extension
Posted by Benjamin Young <by...@bigbluehat.com>.
Agreed. Let's begin working on some API design while Randall finishes sorting out the build kit and importing his libraries.
We can do that on the wiki, if that works:
https://github.com/apache/incubator-annotator/wiki
Cool? :)
-----Original Message-----
From: Gerben [mailto:gerben@treora.com]
Sent: Saturday, July 8, 2017 7:47 PM
To: dev@annotator.incubator.apache.org
Subject: Re: Precise-links browser extension
On 2017-07-03 18:14, Benjamin Young wrote:
> This is fabulous work, Gerben! Apologies for only just now following up.
>
> I'm curious--from both you and Randall--what it would take to make Apache Annotator be the source of the libraries this Web extension depends on.
I think it would take a rough consensus on how packages should be organised (with what scope and APIs etc.), and then a bit of coding to implement them. I'm happy to code some things, but don't want to waste time making stuff that others would consider e.g. out of scope. Perhaps we could start drafting API docs together to align our plans.
> I know we still need to bring Randall's dom-anchor things "into the fold." However, I'm also curious what's different between your packaged version of the fragment identifier library and the one Randall did here. I'm guessing at least the ES6-ification?
They are nearly the same, but Randall did some more refactoring of the original code <https://github.com/w3c/web-annotation/tree/gh-pages/selector-note/converter>
by Ivan Herman. I think we should agree on the desired API and merge them into one.
> The next steps--we seem to be having a hard time taking--is getting these libraries wrapped or added to the Apache Annotator repo + a similar factory style wrapper like the one you and Sasha have both created.
>
> Help narrowing in on the differences will be useful.
>
> Also, pull requests more than welcome! :)
>
> Cheers!
> Benjamin
>
> -----Original Message-----
> From: Gerben [mailto:gerben@treora.com]
> Sent: Monday, May 29, 2017 3:20 PM
> To: dev@annotator.incubator.apache.org
> Subject: Precise-links browser extension
>
> Hi all,
>
> I have been silent here so far, but have been working a bit with Randall & Benjamin on our shared webby ambitions, and thought I'll share this one for your interests. At the I Annotate <https://iannotate.org> conference last month I made a simple browser extension to support Web Annotation Selectors in fragment identifiers, as specified in this W3C note <https://www.w3.org/TR/2017/NOTE-selectors-states-20170223/#frags>.
> A location such
> ashttps://en.wikipedia.org/w/index.php?title=Koala&oldid=781295795#sel
> ector(type=TextQuoteSelector,exact=fluffy%20ears)
> <https://en.wikipedia.org/w/index.php?title=Koala&oldid=781295795#sele
> ctor%28type=TextQuoteSelector,exact=fluffy%20ears%29>
> will scroll to the words /fluffy ears/ and select them.
>
> *Technicalities:*
>
> The extension currently only supports TextQuoteSelectors using dom-anchor-text-quote <https://github.com/tilgovi/dom-anchor-text-quote>, which I abstracted through a minimal library I dub dom-anchor-selector <https://github.com/Treora/dom-anchor-selector>, with the intention of adding support for other selector types. I would be glad to have this library moved or rewritten under the Apache Annotator umbrella if there is interest.
>
> The conversion between the selector as a javascript object and as a
> fragment identifier is done by code borrowed from Ivan Herman's
> converter
> <http://w3c.github.io/web-annotation/selector-note/converter/>,
> packaged as a module first by me here
> <https://github.com/Treora/selector-state-frags>, and again by Randall
> here
> <https://github.com/apache/incubator-annotator/tree/master/packages/fr
> agment-identifier>
> under the Apache Annotator project.
>
> *Try it:*
>
> For Firefox, available here
> <https://addons.mozilla.org/en-US/firefox/addon/precise-links/>.
>
> For Chromium, I yet only published it on my own server, here <https://temp.treora.com/precise-links.crx> for now. To install, download it and drag&drop the file to your list of extensions (chrome://extensions).
>
> To create link to a segment of text, right-click the selection and choose 'Copy link to selected text'.
>
> *Improve it:*
>
> Extension code is here <https://github.com/Treora/precise-links>, though most improvements are to be done in the dependencies mentioned above.
>
> It may be nice to also create a version of this code that people can easily include in their web pages, something I did previously with quoteurl <https://github.com/Treora/quoteurl>.
>
> Cheers,
>
> Gerben
>
Re: Precise-links browser extension
Posted by Gerben <ge...@treora.com>.
On 2017-07-03 18:14, Benjamin Young wrote:
> This is fabulous work, Gerben! Apologies for only just now following up.
>
> I'm curious--from both you and Randall--what it would take to make Apache Annotator be the source of the libraries this Web extension depends on.
I think it would take a rough consensus on how packages should be
organised (with what scope and APIs etc.), and then a bit of coding to
implement them. I'm happy to code some things, but don't want to waste
time making stuff that others would consider e.g. out of scope. Perhaps
we could start drafting API docs together to align our plans.
> I know we still need to bring Randall's dom-anchor things "into the fold." However, I'm also curious what's different between your packaged version of the fragment identifier library and the one Randall did here. I'm guessing at least the ES6-ification?
They are nearly the same, but Randall did some more refactoring of the
original code
<https://github.com/w3c/web-annotation/tree/gh-pages/selector-note/converter>
by Ivan Herman. I think we should agree on the desired API and merge
them into one.
> The next steps--we seem to be having a hard time taking--is getting these libraries wrapped or added to the Apache Annotator repo + a similar factory style wrapper like the one you and Sasha have both created.
>
> Help narrowing in on the differences will be useful.
>
> Also, pull requests more than welcome! :)
>
> Cheers!
> Benjamin
>
> -----Original Message-----
> From: Gerben [mailto:gerben@treora.com]
> Sent: Monday, May 29, 2017 3:20 PM
> To: dev@annotator.incubator.apache.org
> Subject: Precise-links browser extension
>
> Hi all,
>
> I have been silent here so far, but have been working a bit with Randall & Benjamin on our shared webby ambitions, and thought I'll share this one for your interests. At the I Annotate <https://iannotate.org> conference last month I made a simple browser extension to support Web Annotation Selectors in fragment identifiers, as specified in this W3C note <https://www.w3.org/TR/2017/NOTE-selectors-states-20170223/#frags>.
> A location such
> ashttps://en.wikipedia.org/w/index.php?title=Koala&oldid=781295795#selector(type=TextQuoteSelector,exact=fluffy%20ears)
> <https://en.wikipedia.org/w/index.php?title=Koala&oldid=781295795#selector%28type=TextQuoteSelector,exact=fluffy%20ears%29>
> will scroll to the words /fluffy ears/ and select them.
>
> *Technicalities:*
>
> The extension currently only supports TextQuoteSelectors using dom-anchor-text-quote <https://github.com/tilgovi/dom-anchor-text-quote>, which I abstracted through a minimal library I dub dom-anchor-selector <https://github.com/Treora/dom-anchor-selector>, with the intention of adding support for other selector types. I would be glad to have this library moved or rewritten under the Apache Annotator umbrella if there is interest.
>
> The conversion between the selector as a javascript object and as a fragment identifier is done by code borrowed from Ivan Herman's converter <http://w3c.github.io/web-annotation/selector-note/converter/>, packaged as a module first by me here <https://github.com/Treora/selector-state-frags>, and again by Randall here <https://github.com/apache/incubator-annotator/tree/master/packages/fragment-identifier>
> under the Apache Annotator project.
>
> *Try it:*
>
> For Firefox, available here
> <https://addons.mozilla.org/en-US/firefox/addon/precise-links/>.
>
> For Chromium, I yet only published it on my own server, here <https://temp.treora.com/precise-links.crx> for now. To install, download it and drag&drop the file to your list of extensions (chrome://extensions).
>
> To create link to a segment of text, right-click the selection and choose 'Copy link to selected text'.
>
> *Improve it:*
>
> Extension code is here <https://github.com/Treora/precise-links>, though most improvements are to be done in the dependencies mentioned above.
>
> It may be nice to also create a version of this code that people can easily include in their web pages, something I did previously with quoteurl <https://github.com/Treora/quoteurl>.
>
> Cheers,
>
> Gerben
>