https://github.com/kba/anno-common
Node.JS/Browser Web Annotation Framework
https://github.com/kba/anno-common
annotation-framework webannotation
Last synced: 8 months ago
JSON representation
Node.JS/Browser Web Annotation Framework
- Host: GitHub
- URL: https://github.com/kba/anno-common
- Owner: kba
- License: mit
- Created: 2017-03-10T22:49:20.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2023-01-10T11:37:12.000Z (about 3 years ago)
- Last Synced: 2025-06-30T13:27:36.552Z (8 months ago)
- Topics: annotation-framework, webannotation
- Language: JavaScript
- Homepage: https://kba.github.io/anno
- Size: 7.12 MB
- Stars: 12
- Watchers: 5
- Forks: 2
- Open Issues: 104
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# anno
[](https://travis-ci.org/kba/anno-common)
[](https://snyk.io/test/github/kba/anno-common?targetFile=anno-server%2Fpackage.json)
Look here for the [documentation](https://kba.github.io/anno-common)
This monorepo contains packages that provide the building blocks for annotation
software implementing the [Web Annotation Data
Model](http://www.w3.org/TR/annotation-model/) and [Web Annotation
Protocol](http://www.w3.org/TR/annotation-protocol/).
Each repository is designed to provide a single feature to allow for broad
reuse of components.
* [Concepts](#concepts)
* [Store](#store)
* [Authentication](#authentication)
* [Revisions](#revisions)
* [Comments / Replies / Nesting](#comments--replies--nesting)
* [URL schema](#url-schema)
* [Extensions to Web Annotation Data Model](#extensions-to-web-annotation-data-model)
* [Hacking](#hacking)
## Concepts
### Store
A store provides persistent storage of annotations. A store exposes methods
that reflect the [Web Annotation
Protocol](http://www.w3.org/TR/annotation-protocol/) and the [extensions
implemented of this framework](#extensions-to-web-annotation-data-model).
The [`store`](./anno-store) module is a
[proxy](https://en.wikipedia.org/wiki/Proxy_pattern) to the actual
implementation. It handles method dispatch and middleware and allows
instantiation from the environemnt. Actual stores must implement [its
interface](./store/README.md#interface).
The [`store-mongolike`](./anno-store-mongolike) module implements most of the
[`store` interface ](./anno-store/README.md#interface) for document databases,
such as [mongodb](https://mongodb.com) or
[NeDB](https://github.com/louischatriot/nedb).
### Authentication
Authentication is based on [JSON Web Tokens](https://jwt.io/).
To inspect your tokens, try [jwtinspector browser
extension](https://www.jwtinspector.io/#) which will detect JWT in HTTP traffic
and localStorage.
### Revisions
An `oa:Annotation` has `1..n` `annox:hasVersion` `annox:AnnotationRevision`.
`annox:hasVersion` is an ordered List.
The top-level `oa:Annotation` has the data from the latest revision as
* `body`
* `target`
* `creator`
The `modified` of the top-level `oa:Annotation` is the `created` of the latest
revision.
`hasVersion` is part of the
[`getMetadata`](https://github.com/kba/anno/tree/master/anno-store/#getmetadata)
store call/`HEAD` HTTP call.
### Comments / Replies / Nesting
### URL schema
ID is a [nice slugid](https://www.npmjs.com/package/slugid), based on uuid v4
without leading dash
```
/[.]*[~]
```
E.g.
* `http://localhost:3000/ewnfkjewnfew~2` Second revision
* `http://localhost:3000/ewnfkjewnfew.2.1~5` Fifth revision of first answer to second answer
Replies reply to the generic not versioned annotation (for sanity)
### Extensions to Web Annotation Data Model
Namespace for extensions is `https://kba.github.io/anno/#`, short `annox`.
Context is at `https://anno.github.io/anno/context.jsonld`
## Hacking
Modules are managed by [lerna](https://github.com/lerna/lerna)
```
npm install -g lerna
lerna bootstrap
```