You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@annotator.apache.org by ge...@apache.org on 2021/05/16 21:53:24 UTC
[incubator-annotator] 01/02: Make Readme point to docs on website
This is an automated email from the ASF dual-hosted git repository.
gerben pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-annotator.git
commit 9c18a78bb4bdb96bf072c9104c4279074a35dafe
Author: Gerben <ge...@treora.com>
AuthorDate: Sun May 16 23:47:30 2021 +0200
Make Readme point to docs on website
It is helpful there, but too easily gets outdated if we have content
duplicated in multiple places.
---
README.md | 91 ++-------------------------------------------------------------
1 file changed, 2 insertions(+), 89 deletions(-)
diff --git a/README.md b/README.md
index 5e0240a..121a3cd 100644
--- a/README.md
+++ b/README.md
@@ -4,29 +4,9 @@ Apache Annotator (incubating) provides libraries to enable annotation related
software, with an initial focus on identification of textual fragments in
browser environments.
-## Usage
+## Installation, usage, API documentation
-The Apache Annotator project is written in TypeScript, but the project is
-compiled and distributed in CommonJS and ECMAScript Module formats.
-
-The project is made up of multiple packages. Install the `apache-annotator`
-package, which includes all sub-packages, or install individual packages from
-the `@apache-annotator` scope.
-
-Import packages from either `apache-annotator/package` or
-`@apache-annotator/package`.
-
-Currently, the following sub-packages are part of the project:
-
-### `@apache-annotator/dom`
-
-This package contains functions for creating and resolving Web Annotation
-Selectors in DOM environments.
-
-### `@apache-annotator/selector`
-
-This package contains generic utilities for composing functions that create
-and resolve Web Annotation Selectors.
+See documentation on the website: <https://annotator.apache.org/docs/>
## Getting Involved
@@ -35,73 +15,6 @@ and resolve Web Annotation Selectors.
* Browse the [issue tracker](https://github.com/apache/incubator-annotator/issues) and file new issues if you encounter problems.
* Read or contribute to the [wiki](https://github.com/apache/incubator-annotator/wiki).
-### Requirements
-
-We use [Lerna](https://lernajs.io/) to juggle the various Apache Annotator
-libraries. If you'd like to contribute, you'll need the following:
-
-- [node](https://nodejs.org) ^12.20 || ^14.15 || ^15.4
-- [yarn](https://www.yarnpkg.com/) ^1.5
-
-#### Setup
-
-```sh
-$ yarn install
-```
-
-#### Test
-
-```sh
-$ yarn test
-```
-
-#### Start a local test project
-
-```sh
-$ yarn start
-```
-
-## Selectors
-
-Many Annotations refer to part of a resource, rather than all of it, as the Target. We call that part of the resource a Segment (of Interest). A Selector is used to describe how to determine the Segment from within the Source resource.
-
-The [W3C Web Annotation Data Model](https://www.w3.org/TR/annotation-model) outlines a number of different selectors. See table below for full list and status.
-
-| Selector | Description | Implementation Status |
-| ------------------------------------------------------------------------------: | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | --------------------: |
-| [Text Quote](https://www.w3.org/TR/annotation-model/#text-quote-selector) | This Selector describes a range of text, including some of the text immediately before (a prefix) and after (a suffix) it to distinguish between multiple copies of the same sequence of characters. | Yes |
-| [CSS](https://www.w3.org/TR/annotation-model/#css-selector) | CSS Selectors allow for a wide variety of well supported ways to describe the path to an element in a web page. | Yes |
-| [Text Position](https://www.w3.org/TR/annotation-model/#text-position-selector) | This Selector describes a range of text by recording the start and end positions of the selection in the stream. | No |
-| [Fragment](https://www.w3.org/TR/annotation-model/#fragment-selector) | Uses the fragment part of an IRI defined by the representation's media type. | No |
-| [XPath](https://www.w3.org/TR/annotation-model/#xpath-selector) | Implements an XPath based selection. | No |
-| [Data Postion](https://www.w3.org/TR/annotation-model/#data-position-selector) | Similar to the Text Position Selector, the Data Position Selector uses the same properties but works at the byte in bitstream level rather than the character in text level. | No |
-| [SVG](https://www.w3.org/TR/annotation-model/#svg-selector) | An SvgSelector defines an area through the use of the Scalable Vector Graphics standard. | No |
-| [Range](https://www.w3.org/TR/annotation-model/#range-selector) | A Range Selector can be used to identify the beginning and the end of the selection by using other Selectors. | Yes |
-| [Refinement](https://www.w3.org/TR/annotation-model/#refinement-of-selection) | Select a part of a selection, rather than as a selection of the complete resource. | |
-
-## Web Annotation Data Model Validation
-
-If you have any Web Annotation Data Model JSON documents, you can validate them
-using the `validate` script:
-
-```sh
-$ 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.
-
-### Examples
-
-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`
-
-[(More)](https://github.com/w3c/web-annotation-tests/tree/master/tools/samples)
-
# License
Apache License 2.0