search

openannotation / annotator

Annotation tools for the web. Select text, images, or (nearly) anything else, and add your notes.
http://annotatorjs.org
Other
2.68k stars 530 forks source link

2.0 Migration Documentation #308

Open tilgovi opened 10 years ago

tilgovi commented 10 years ago
jamiefolsom commented 9 years ago

Hey @tilgovi,

Great to see so much activity on 2.0!

It would be great if the migration documentation were to make explicit all of Annotator 2.0's assumptions about features available in the data store. Or if the data store is going to be bumped to 2.0 in sync with Annotator, is it fair to assume that its API will be documented? Those of us who've implemented alternative data stores (ahem) will need to know what changes if any would be required.

I would be glad to take on that task, if there's something I could do.

Thanks!

tilgovi commented 9 years ago

Noted, @jamiefolsom.

I don't see any data store changes yet, but we'll keep it in mind.

jamiefolsom commented 9 years ago

Much appreciated @tilgovi. To be clear, it was @nickstenning's email to the mailing list this morning about OA compatibility, which of course would be awesome, that occasioned this suggestion.

In particular: the proposed changes to the Annotator's own data format, and to the data store to accommodate that, to be closer to the OA spec would seem to be rather major ones.

Possibly, that was not related to the 2.0 milestone, in which case, of course, it's not relevant here.

Thanks!

tilgovi commented 9 years ago

Here's the upgrading guide, there are a few things still missing that I listed above: http://docs.annotatorjs.org/en/latest/upgrading.html

tilgovi commented 9 years ago

We just need to mention and link to the viewer/editor extensions docs, document the schema-free-ness of the model (it's mostly up to the UI now), the lack of events, and talk more about the abstract store interface.

jamiefolsom commented 9 years ago

Thanks, Randall. I look forward to learning more. Let me know if I can help!