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

Fri Sep 5 22:47:23 UTC 2014

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.
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.okfn.org/pipermail/annotator-dev/attachments/20140905/e2401a2d/attachment-0004.html>