commit | bc5e97d0e2991fedcc9f7db76bf373e3b23c9e29 | [log] [tgz] |
---|---|---|
author | Randall Leeds <randall@apache.org> | Sat Jun 08 21:57:40 2019 -0700 |
committer | Randall Leeds <randall@apache.org> | Sat Jun 08 21:57:40 2019 -0700 |
tree | b382b634bfba24ce235539266d1631db61324ebc | |
parent | 4efbcd4aa69c49456983bbdca581979caa6dd651 [diff] |
Refactor API Refactor the API so that creating a selector results in a function that accepts a scope against which to match the selector.
Apache Annotator provides annotation enabling code for browsers, servers, and humans.
We‘re currently pre-releasing development copies of each library that makes up the sum total of Apache Annotator’s code. You can grab any of them from our npm organization.
$ # for example... $ npm install --save @annotator/dom
We use Lerna to juggle the various Apache Annotator libraries. If you‘d like to contribute, you’ll need the following:
$ yarn install
$ yarn test
$ yarn start
Once the test server has started, you can browse a local demo, and run tests in a browser by visiting http://localhost:8080/
.
If you have any Web Annotation Data Model JSON documents, you can validate them using the validate
script:
$ yarn validate --url https://raw.githubusercontent.com/w3c/web-annotation-tests/master/tools/samples/correct/anno1.json
With the --url
option you can pass in a URL or a local path to a JSON file.
Valid:
https://raw.githubusercontent.com/w3c/web-annotation-tests/master/tools/samples/correct/anno1.json
Invalid:
https://raw.githubusercontent.com/w3c/web-annotation-tests/master/tools/samples/incorrect/anno1.json
Apache License 2.0