[annotator-dev] Using annotator.js for HTML doc review

Sat Sep 6 10:21:48 UTC 2014

Hi,
I guess I have been doing most of the recent commits, but I don't think
they help here directly. The main improvement is that they allow to use the
storage part of annotator-store without using the accompanying flask-based
web interface. So annotations can be retrieved, stored, and searched using
a Python API. The purpose here is to make it easier to use the storage part
of annotator-store from another web app/framework, with Hypothes.is being
my primary use case. But it does not at all make annotator-store more of a
complete app.

Please note I'm biased, but maybe Hypothes.is could be an option for the
documentation review process? It's in need of more documentation and it's
under heavy development, but I think it should at least soon be a suitable
solution for your use case. It provides annotations with a sidebar layout,
and includes account creation and authentication and such.
Cheers,

Gerben

On 6 September 2014 01:47, Andrew Magliozzi <andrew at finalsclub.org> wrote:

> Hey Warren,
>
> I wish I could help a bit more.  I do know that there have been lots of
> changes to the python annotator-store recently.  Not sure if they achieve
> what you're looking to do.  Perhaps you could take a look and someone else
> with more knowledge of the recent commit history could weigh in.
>
> Best,
> Andrew
>
>
>
> On Fri, Sep 5, 2014 at 7:51 AM, Warren Block <wblock at wonkity.com> wrote:
>
>> On Wed, 3 Sep 2014, Andrew Magliozzi wrote:
>>
>>  Hi Warren,
>>> It looks like no one responded to your message.  How is your project
>>> going?  Can we help out?
>>>
>>
>> My project is kind of stalled.  I found annotator-store and began a
>> process of porting it and the dependendencies to FreeBSD.  But even when
>> that is complete, it still has a "not for production use" comment in the
>> main code, and does not implement things like user authentication.
>>
>> Really, I want to use Annotator as an application, with my own local
>> storage and user database.  Based on other posts to the list, that seems to
>> be a common desire.  However, the existing components are a toolkit for
>> adding that functionality to a web framework, rather than being an
>> application itself.  It's worth pointing out that the examples shown in the
>> Annotator documents reflect this--there is no actual full example of an
>> HTML file, just fragments.  From those, and with an account at
>> annotateit.org, I managed to get a simple example working for myself,
>> but it was more involved than needed because of the unwritten assumptions.
>>
>> Thanks for the response!
>>
>>
>>  On Thu, Jul 24, 2014 at 12:40 PM, Warren Block <wblock at wonkity.com>
>>> wrote:
>>>       Hello.  I'm a documentation committer with FreeBSD,
>>> http://www.freebsd.org/.  Something we have wanted to do for quite some
>>> time is hold documentation review events.
>>>
>>>       There is a barrier to entry for reviewers because our
>>> documentation is either in DocBook or mdoc.  Reading the source is
>>> non-trivial and distracts from editing the content,
>>>       even if you are familiar with the markup language.  Reviewers
>>> currently have no easy way to annotate a rendered version.
>>>
>>>       Annotator can simplify this for us.  The plan is to take a single
>>> section of our HTML-rendered documents, like this example:
>>>       http://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/
>>> network-wireless.html
>>>
>>>       The necessary Javascript inclusions and a header with user
>>> instructions will be added to a copy of that file, and it will be set up on
>>> a web server temporarily.  Then we
>>>       have a limited-time event where we ask for user annotations.  At
>>> the end, editors go through the annotations and update the document.
>>>
>>>       I set up a simple test, which works for a single user and session
>>> but shows that user login and storage are needed.
>>>
>>>       What I'm looking for now is a complete, minimal example,
>>> preferably one that does not assume a web framework and uses local storage
>>> for the annotations.  The openshakespeare
>>>       example looks like a start.  What is needed for a storage service
>>> on port 5000?
>>>
>>>       Thank you!
>>>       _______________________________________________
>>>       annotator-dev mailing list
>>>       annotator-dev at lists.okfn.org
>>>       https://lists.okfn.org/mailman/listinfo/annotator-dev
>>>       Unsubscribe: https://lists.okfn.org/mailman/options/annotator-dev
>>>
>>>
>>>
>>>
>>> --
>>> Andrew Magliozzi Founder
>>> FinalsClub Foundation
>>> www.KarmaNotes.org
>>>
>>> T - 617-575-9369
>>> E - Andrew at FinalsClub.org
>>>
>>> FinalsClub exists thanks to funding from the William and Flora Hewlett
>>> Foundation and generous scholars like you.
>>>
>>>
>
>
> --
> Andrew Magliozzi
> Founder
> *FinalsClub Foundation*
> *www.KarmaNotes.org <http://www.KarmaNotes.org>*
>
> T - 617-575-9369
> E - Andrew at FinalsClub.org
>
> FinalsClub exists thanks to funding from the William and Flora Hewlett
> Foundation and generous scholars like you.
>
> _______________________________________________
> annotator-dev mailing list
> annotator-dev at lists.okfn.org
> https://lists.okfn.org/mailman/listinfo/annotator-dev
> Unsubscribe: https://lists.okfn.org/mailman/options/annotator-dev
>
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.okfn.org/pipermail/annotator-dev/attachments/20140906/d3f409d6/attachment-0004.html>