[annotator-dev] Annotator and Meteor

Tue Sep 9 18:09:25 UTC 2014

On Sat, Sep 6, 2014 at 11:54 PM, Mitar <mmitar at gmail.com> wrote:

> Hi!
>
> > Mitar, I did discover your annotator package in peerlibrary while looking
> > through your work. However, Andrew and Bryan are correct that you're
> using
> > an older version than we are and that your approach unfortunately will
> not
> > work for us. I don't believe it is possible to just "ignore browserify",
> > because the most recent annotator code is making extensive use of the
> > CommonJS-like module system that browserify provides.
>
> OK. That's then different. That's more than just browserify. You can
> then use approach we are using to package Scribe:
>
>
> https://github.com/peerlibrary/peerlibrary/blob/development/packages/scribe/client.js
>

Ok, I see that you're using this: https://github.com/apendua/require in
order to use scribe, which is an AMD library. That's not really the case
that I'm working with - annotator uses CommonJS module constructs
(module.exports, synchronous require, etc), and can do so on the client
through browserify. It looks like the package that you're using will only
help with AMD libraries.

> > Essentially what needs to happen is that we need to have meteor call
> browserify during its build process.
>
> They claim that this is possible in the current new system:
>
>
> https://www.meteor.com/blog/2014/08/28/isobuild-why-meteor-created-a-new-package-system
>
> "And the build process itself is extensible and programmable, so you
> can add support for other languages and preprocessors just by linking
> in an isopack containing a plugin for the appropriate build phase.
> Plus, Isobuild can work not only with isopacks, but also packages from
> other package systems such as npm."
>
> But how to hook into this, I don't know.
>

Yes, I have read that. As far as I can tell, "isobuild" is simply a
marketing term that they came up with specifically for the 0.9 release
notes and for that blog post. There is nothing in the meteor source code
called "isobuild", and there are no commit messages that use that term. The
source code does have "unibuild" and "unipackage", but I can't tell how one
would hook into them either.

> > A possible alternative to using git submodules is to simply declare
> > annotator as an npm dependency of the meteor package. If that winds up
> > working, I think it would be the preferable approach.
>
> Npm dependency can work only on the server side, if they didn't do
> something magical in the new version. (I am not yet familiar with
> changes in 0.9.0.)
>

The npm dependency would only be for downloading the source so that it can
be built - the package would then make the resulting js file available to
the client in the usual way.

Ari

> Mitar
>
> > On Fri, Sep 5, 2014 at 9:13 PM, Mitar <mmitar at gmail.com> wrote:
> >>
> >> Hi!
> >>
> >> You can package xpath-range as additional package as well, if you want.
> >>
> >> If you want to add xpath-range, you can always just add it inside the
> >> Meteor package for Annotator as a field of top-level object. So you
> >> create one more file which you add at the end of all files from
> >> Annotator and do something like:
> >>
> >> Annotator['xpath-range'] = xpath-range;
> >>
> >> Please start a repository and then we can look into the real code you
> >> have. Now it is a bit too abstract which issues you and how to advise
> >> you.
> >>
> >>
> >> Mitar
> >>
> >> On Fri, Sep 5, 2014 at 12:24 PM, Bryan <btbonval at gmail.com> wrote:
> >> > Thanks Mitar, a git submodule might be a good approach for us.
> >> >
> >> > One of our issues is with respect to the encoding of Annotator xpath
> >> > offsets. We would rather not duplicate this code, but we do need
> access
> >> > to
> >> > xpath-range. As Annotator works now, it appears to include xpath-range
> >> > via
> >> > browserify, but browserify does not expose xpath-range to the greater
> >> > Meteor
> >> > application.
> >> > -Bryan
> >> >
> >> >
> >> > On Fri, Sep 5, 2014 at 3:13 PM, Mitar <mmitar at gmail.com> wrote:
> >> >>
> >> >> Hi!
> >> >>
> >> >> Yes, we are still using the old version, but I am not sure it
> matters.
> >> >> You can package it in the same way, I believe. So you add Annotator
> as
> >> >> a git submodule, you ignore browserify, and just add all CoffeeScript
> >> >> files to the package. Meteor will then convert them into JavaScript
> >> >> files and package them into one namespace automatically. Sometimes
> you
> >> >> have just to add one more file which exposes globally the symbols you
> >> >> want to have globally.
> >> >>
> >> >> I don't have time to do it myself now, but you can start with a
> GitHub
> >> >> repository for it now and let's see where you get stuck.
> >> >>
> >> >>
> >> >> Mitar
> >> >>
> >> >> On Fri, Sep 5, 2014 at 5:16 AM, Andrew - FinalsClub
> >> >> <andrew at finalsclub.org> wrote:
> >> >> > Thanks Mitar,
> >> >> >
> >> >> > I notice you are using an older version of Annotator (before
> >> >> > browserify
> >> >> > was added). Would the same thing be possible with Annotator 2.0?
> We
> >> >> > are
> >> >> > currently a bit stumped. Ari can share more details on our efforts
> if
> >> >> > you're
> >> >> > curious.
> >> >> >
> >> >> > Eventually, it would be useful to make a Meteor package so others
> can
> >> >> > easily use Annotator in their meteor projects. If you have any
> >> >> > suggestions,
> >> >> > we would love guidance / help.
> >> >> >
> >> >> > Warmly,
> >> >> > Andrew
> >> >> >
> >> >> >
> >> >> >
> >> >> >
> >> >> >> On Sep 5, 2014, at 3:39 AM, Mitar <mmitar at gmail.com> wrote:
> >> >> >>
> >> >> >> Hi!
> >> >> >>
> >> >> >> You can see here how we are bundling Annotator for Meteor:
> >> >> >>
> >> >> >>
> >> >> >>
> >> >> >>
> https://github.com/peerlibrary/peerlibrary/tree/development/packages/annotator
> >> >> >>
> >> >> >> And here how we are using it:
> >> >> >>
> >> >> >>
> >> >> >>
> >> >> >>
> https://github.com/peerlibrary/peerlibrary/tree/development/client/lib/annotator
> >> >> >>
> >> >> >>
> >> >> >> Mitar
> >> >> >>
> >> >> >> On Wed, Sep 3, 2014 at 7:04 AM, Andrew - FinalsClub
> >> >> >> <andrew at finalsclub.org> wrote:
> >> >> >>> Hey All,
> >> >> >>>
> >> >> >>> Especially @Mitar. At FinalsClub, we have been working on a new
> >> >> >>> social
> >> >> >>> reading site built using Meteor (a newfangled JavaScript
> >> >> >>> framework). Meteor
> >> >> >>> is nice, because it offers isomorphic JavaScript - that is, the
> >> >> >>> same code to
> >> >> >>> run on the client and server. It also provides the magic of
> >> >> >>> reactive data
> >> >> >>> binding between clients and server.
> >> >> >>>
> >> >> >>> We have gotten a basic working version of Annotator with a
> >> >> >>> meteor-specific store plugin. (I can share the code if anyone is
> >> >> >>> curious.).
> >> >> >>> However, there are some aspects of Annotator that we are
> grappling
> >> >> >>> with.
> >> >> >>>
> >> >> >>> For instance, we were wondering how the XPath-Range plugin is
> >> >> >>> currently being used. Also, we want to include the coffeescript
> >> >> >>> (not
> >> >> >>> compiled JS) of Annotator in our project, but aren't sure how to
> >> >> >>> accomplish
> >> >> >>> that using Meteor's custom package system.
> >> >> >>>
> >> >> >>> @Mitar, I've seen your handle on a few meteor github issues and
> >> >> >>> wonder
> >> >> >>> if could help us. I've cc'd Bryan and Ari from our team if they
> >> >> >>> have
> >> >> >>> anything to add.
> >> >> >>>
> >> >> >>> Also, if anyone else is interested in helping, just say so. We'd
> be
> >> >> >>> glad to put our work on the OpenAnnotation organization if you'd
> >> >> >>> like as
> >> >> >>> well.
> >> >> >>>
> >> >> >>> Best,
> >> >> >>> Andrew
> >> >> >>
> >> >> >>
> >> >> >>
> >> >> >> --
> >> >> >> http://mitar.tnode.com/
> >> >> >> https://twitter.com/mitar_m
> >> >>
> >> >>
> >> >>
> >> >> --
> >> >> http://mitar.tnode.com/
> >> >> https://twitter.com/mitar_m
> >> >
> >> >
> >>
> >>
> >>
> >> --
> >> http://mitar.tnode.com/
> >> https://twitter.com/mitar_m
> >
> >
>
>
>
> --
> http://mitar.tnode.com/
> https://twitter.com/mitar_m
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.okfn.org/pipermail/annotator-dev/attachments/20140909/7a3eb866/attachment-0004.html>