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:30:45 UTC
[incubator-annotator-website] branch asf-site updated (8d9d7fb ->
fce80f9)
This is an automated email from the ASF dual-hosted git repository.
gerben pushed a change to branch asf-site
in repository https://gitbox.apache.org/repos/asf/incubator-annotator-website.git.
from 8d9d7fb Tweak layout, change navigation menu, …
new 5df5575 Add table of contents to doc pages
new c4e0728 tiny fixes
new 2bcd3cd Add actual documentation
new fce80f9 Update website
The 4 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
Summary of changes:
.eleventy.js | 7 +
content/docs/api/index.html | 117 ++++++++++------
content/docs/api/interfaces/selector.chunk.html | 139 +++++++++++--------
content/docs/api/interfaces/selector.chunker.html | 139 +++++++++++--------
.../docs/api/interfaces/selector.chunkrange.html | 139 +++++++++++--------
.../docs/api/interfaces/selector.cssselector.html | 139 +++++++++++--------
.../selector.describetextquoteoptions.html | 139 +++++++++++--------
content/docs/api/interfaces/selector.matcher.html | 139 +++++++++++--------
.../api/interfaces/selector.rangeselector.html | 139 +++++++++++--------
.../docs/api/interfaces/selector.selector-1.html | 139 +++++++++++--------
.../interfaces/selector.textpositionselector.html | 139 +++++++++++--------
.../api/interfaces/selector.textquoteselector.html | 139 +++++++++++--------
content/docs/api/modules/dom.html | 133 +++++++++++-------
content/docs/api/modules/selector.html | 133 +++++++++++-------
content/docs/{ => develop}/index.html | 90 +++++++++---
content/docs/getting-started/index.html | 122 +++++++++++++---
content/docs/index.html | 128 ++++++++++++++---
content/index.html | 16 +--
package.json | 5 +-
src/_includes/docs_nav.hbs | 7 +-
src/_layouts/docs.hbs | 22 ++-
src/docs/develop.md | 62 +++++++++
src/docs/getting-started.md | 96 ++++++++++++-
src/docs/index.md | 44 +++++-
yarn.lock | 154 +++++++++++++++++++++
25 files changed, 1734 insertions(+), 792 deletions(-)
copy content/docs/{ => develop}/index.html (57%)
create mode 100644 src/docs/develop.md
[incubator-annotator-website] 03/04: Add actual documentation
Posted by ge...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
gerben pushed a commit to branch asf-site
in repository https://gitbox.apache.org/repos/asf/incubator-annotator-website.git
commit 2bcd3cd534f9cd09693bb728b109cea29370c4f9
Author: Gerben <ge...@treora.com>
AuthorDate: Sun May 16 23:24:28 2021 +0200
Add actual documentation
Partly derived from the code repo’s README, partly new.
---
src/_includes/docs_nav.hbs | 3 +-
src/docs/develop.md | 62 +++++++++++++++++++++++++++++
src/docs/getting-started.md | 96 ++++++++++++++++++++++++++++++++++++++++++++-
src/docs/index.md | 44 +++++++++++++++++++--
4 files changed, 200 insertions(+), 5 deletions(-)
diff --git a/src/_includes/docs_nav.hbs b/src/_includes/docs_nav.hbs
index 29cc66d..134da78 100644
--- a/src/_includes/docs_nav.hbs
+++ b/src/_includes/docs_nav.hbs
@@ -4,6 +4,7 @@
--}}
<nav class="ui secondary stackable pointing menu" style="justify-content: center;">
<a href="/docs/" class="{{#if isDocsIndex}}active {{/if}}item">Overview</a>
- <a href="/docs/getting-started" class="{{#if isGettingStarted}}active {{/if}}item">Getting Started</a>
+ <a href="/docs/getting-started/" class="{{#if isGettingStarted}}active {{/if}}item">Getting Started</a>
+ <a href="/docs/develop/" class="{{#if isDevelop}}active {{/if}}item">Develop</a>
<a href="/docs/api/" class="{{#if isApiReference}}active {{/if}}item">API reference</a>
</nav>
diff --git a/src/docs/develop.md b/src/docs/develop.md
new file mode 100644
index 0000000..a0cdf4f
--- /dev/null
+++ b/src/docs/develop.md
@@ -0,0 +1,62 @@
+---
+title: Develop Apache Annotator
+isDevelop: true
+layout: docs
+---
+
+## Install from source
+
+This project’s source code is available directly [from the ASF](https://gitbox.apache.org/repos/asf?p=incubator-annotator.git) or [via GitHub](https://github.com/apache/incubator-annotator).
+
+### Requirements
+
+If you’d like to code on the project, you will need the following:
+
+- [git](https://git-scm.com/)
+- [node](https://nodejs.org) version ^12.20 || ^14.15 || ^15.4
+- [yarn](https://www.yarnpkg.com/) version ^1.5
+
+### Install
+
+To retrieve the code using git:
+
+```
+$ git clone https://gitbox.apache.org/repos/asf/incubator-annotator.git apache-annotator
+```
+
+Then install dependencies using yarn:
+
+```sh
+$ cd apache-annotator
+$ yarn install
+```
+
+## Build
+
+To compile (‘transpile’) the code:
+
+```sh
+$ yarn build
+```
+
+For each module, the TypeScript source code is in `packages/…/src` and the Javascript is output in `packages/…/lib`.
+
+To use your local build of the code in an application that depends on annotator, have a look at the [`yarn link`](https://yarnpkg.com/cli/link) or [`npm link`](https://docs.npmjs.com/cli/v7/commands/npm-link) command.
+
+## Play
+
+To run a webserver running [the demo](https://annotator.apache.org/demo/):
+
+```
+$ yarn start
+```
+
+Now open `http://localhost:8080/` (or whichever address the command prints) in your web browser to play with the demo. The server continuously rebuilds and hot-reloads to the source code after any edits, so you can directly try out any changes you make to the features it demonstrates.
+
+## Run tests
+
+This runs the tests for all packages and reports their code coverage:
+
+```sh
+$ yarn test
+```
diff --git a/src/docs/getting-started.md b/src/docs/getting-started.md
index 5941fd3..1b110d9 100644
--- a/src/docs/getting-started.md
+++ b/src/docs/getting-started.md
@@ -4,4 +4,98 @@ isGettingStarted: true
layout: docs
---
-Please checkout the [demo](/demo/) for now, but we'll explain it here soon.
+## Install via NPM
+
+Currently we only support installation through NPM packages. You will need to use a bundler (such as [webpack](https://webpack.js.org/)) to use the modules in a web browser.
+
+The project is made up of multiple modules. Each module is [available on the NPM registry](https://www.npmjs.com/org/apache-annotator) as individual packages in the `@apache-annotator` scope, and all of them together in the [`apache-annotator`](https://www.npmjs.com/package/apache-annotator) ‘meta-package’. You can install either and then import packages in your code as `@apache-annotator/package` or `apache-annotator/package`, respectively.
+
+For example:
+
+```sh
+$ yarn add @apache-annotator/dom
+```
+
+…with in your code:
+
+```js
+import { highlightRange } from '@apache-annotator/dom';
+```
+
+
+## Install from source
+
+See [Develop](/docs/develop/).
+
+
+## Usage example: a text quote highlighter
+
+A typical goal of web annotation is to let users highlight a phrase of text in a web page, and perhaps add a note to it. The example code below enables this use case.
+
+First, we define the way to describe the user’s selection as a TextQuoteSelector.
+
+```js
+import { describeTextQuote } from '@apache-annotator/dom';
+
+async function describeCurrentSelection() {
+ const userSelection = window.getSelection()?.getRangeAt(0);
+ if (!userSelection || userSelection.isCollapsed) return;
+ return describeTextQuote(userSelection);
+}
+```
+
+If the user had selected the word *“ipsum”* in the befamed *“Lorem ipsum dolor amet …”*, the return value of describeCurrentSelection() might resolve to this:
+
+```
+{
+ type: 'TextQuoteSelector',
+ exact: 'ipsum',
+ prefix: 'Lorem ',
+ suffix: ' dolor'
+}
+```
+
+The *prefix* and *suffix* attributes are there to know which of multiple occurrences of *“ipsum”* the Selector points to. They will include just enough surrounding words to make the selector unambiguous.
+
+Next, we define roughly the inverse function: given a TextQuoteSelector, we highlight the text it points to.
+
+```js
+import { createTextQuoteSelectorMatcher, highlightRange } from '@apache-annotator/dom';
+
+async function highlightSelectorTarget(textQuoteSelector) {
+ // Search in the whole document
+ const scope = document.createRange();
+ scope.selectNodeContents(document);
+
+ const matches = createTextQuoteSelectorMatcher(textQuoteSelector)(scope);
+ for await (const match of matches) {
+ highlightRange(match);
+ }
+}
+```
+
+As the [`for await … of`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/for-await...of) statement suggests, the matcher does not return just one match, but a stream (an async iterable) of matches. This is because it cannot be certain that a selector only has a single match (even when it includes a prefix & suffix, perhaps the document changed!).
+
+We could use the functions defined above in many ways; keeping highlighted quotes in local storage, or in one’s bookmarks, or sharing them with others, and so on. For this example, we keep it simple and highlight each selection upon release of the mouse button; and store the selector to make it appear again after a page reload.
+
+```js
+document.addEventListener('mouseup', async () => {
+ const selector = await describeCurrentSelection();
+ const existingSelectors = JSON.parse(localStorage[document.URL] || '[]');
+ localStorage[document.URL] = JSON.stringify([...existingSelectors, selector]);
+ await highlightSelectorTarget(selector);
+});
+
+// Highlight the last selection that was stored, if any.
+async function highlightStoredSelectors() {
+ if (localStorage[document.URL]) {
+ const selectors = JSON.parse(localStorage[document.URL]);
+ for (const selector of selectors) {
+ await highlightSelectorTarget(selector);
+ }
+ }
+}
+highlightStoredSelectors();
+```
+
+To see similar pieces of code in action, have a look at [the demo](/demo/).
diff --git a/src/docs/index.md b/src/docs/index.md
index 7101932..c533e42 100644
--- a/src/docs/index.md
+++ b/src/docs/index.md
@@ -4,7 +4,45 @@ isDocsIndex: true
layout: docs
---
-We're working on some initial documentation for getting started with Apache
-Annotator, and to help folks understand how it fits in their projects.
+Apache Annotator provides software modules to facilitate annotation tools in web browser environments. For example, it could be used in web-based document viewers or browser extensions that let users highlight phrases and place virtual sticky notes on the pages they visit.
-Stay tuned for more!
+The modules are written in [TypeScript](https://www.typescriptlang.org/), and distributed as Javascript/ECMAScript modules [on NPM](https://www.npmjs.com/org/apache-annotator). Read further for a high-level description of the code functionality, or [get started](/docs/getting-started/) with it directly!
+
+
+## What is in the box
+
+### Selector tools
+
+The main functionality Apache Annotator offers is to map a [Web Annotation Selector](https://www.w3.org/TR/2017/REC-annotation-model-20170223/#selector) to the segment of a document it corresponds to, sometimes called ‘anchoring’ a Selector; and, vice versa, to create a Selector that describes a given selection in the document precisely and unambiguously, such that other Web Annotation software knows exactly where it points to. The purpose of Selectors is to point at any part of a docume [...]
+
+The [W3C Web Annotation Data Model](https://www.w3.org/TR/annotation-model) outlines a number of different selectors types, to accomodate various use case on different types of documents and selections (e.g. an annotation may target a phrase of text, or a region within an image). The table below shows the full list of defined types and the implementation status of each.
+
+| Selector | Description | Implemented? |
+| ------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |
+| [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 |
+| [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. | [Partly](/docs/api/modules/dom.html#createcssselectormatcher) |
+| [XPath](https://www.w3.org/TR/annotation-model/#xpath-selector) | Implements an XPath based selection. | No |
+| [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, both [for DOM](/docs/api/modules/dom.html#describetextquote) and [generic](/docs/api/modules/selector.html#textquoteselectormatcher) |
+| [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. | Yes, both [for DOM](/docs/api/modules/dom.html#describetextposition) and [generic](/docs/api/modules/selector.html#textpositionselectormatcher) |
+| [Data Position](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, [for DOM](/docs/api/modules/dom.html#makecreaterangeselectormatcher) |
+| [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. | [Yes](/docs/api/modules/selector.html#makerefinable) |
+
+
+### Web Annotation JSON validator
+
+The source code also includes a script for validating Web Annotation Data Model JSON documents against the data model schema. Having [installed from source](/docs/develop/#install-from-source), one can run:
+
+```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.
+
+See some [example JSON files](https://github.com/w3c/web-annotation-tests/tree/master/tools/samples) from the W3C. Note that this validator only tests the data model is followed, and not e.g. whether its target actually exists.
+
+
+## What Apache Annotator it not
+
+Apache Annotator is **not an all-in-one annotation tool**; rather, it *helps others create* annotation tools. It does not have opinions regarding in which database on which computer annotations are stored, nor how they are made, exchanged or displayed. Those questions are considered application-specific and left to the developer. Our goal is that the developer can focus on exactly those questions, and forget about issues that are common among annotation tools: finding the part in the doc [...]
[incubator-annotator-website] 02/04: tiny fixes
Posted by ge...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
gerben pushed a commit to branch asf-site
in repository https://gitbox.apache.org/repos/asf/incubator-annotator-website.git
commit c4e0728a595cd8e20bfd5ffb15a9a10391c27f6a
Author: Gerben <ge...@treora.com>
AuthorDate: Sat May 15 18:26:02 2021 +0200
tiny fixes
---
src/_includes/docs_nav.hbs | 4 +---
src/_layouts/docs.hbs | 2 +-
2 files changed, 2 insertions(+), 4 deletions(-)
diff --git a/src/_includes/docs_nav.hbs b/src/_includes/docs_nav.hbs
index c25703b..29cc66d 100644
--- a/src/_includes/docs_nav.hbs
+++ b/src/_includes/docs_nav.hbs
@@ -5,7 +5,5 @@
<nav class="ui secondary stackable pointing menu" style="justify-content: center;">
<a href="/docs/" class="{{#if isDocsIndex}}active {{/if}}item">Overview</a>
<a href="/docs/getting-started" class="{{#if isGettingStarted}}active {{/if}}item">Getting Started</a>
- <div class="ui secondary menu">
- <a href="/docs/api/" class="{{#if isApiReference}}active {{/if}}item">API reference</a>
- </div>
+ <a href="/docs/api/" class="{{#if isApiReference}}active {{/if}}item">API reference</a>
</nav>
diff --git a/src/_layouts/docs.hbs b/src/_layouts/docs.hbs
index 4c3c2c6..5d9a68f 100644
--- a/src/_layouts/docs.hbs
+++ b/src/_layouts/docs.hbs
@@ -6,7 +6,7 @@ isDocs: true
{{> docs_nav }}
<main class="ui basic segment container">
- <h1>{{title}}</h1>
+ <h1 style="margin-bottom: 2rem">{{title}}</h1>
<div class="ui mobile reversed stackable grid">
<div class="twelve wide column">
{{{content}}}
[incubator-annotator-website] 04/04: Update website
Posted by ge...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
gerben pushed a commit to branch asf-site
in repository https://gitbox.apache.org/repos/asf/incubator-annotator-website.git
commit fce80f95fa745dd6abe3b4ec0f37904fcb2cf1eb
Author: Gerben <ge...@treora.com>
AuthorDate: Sun May 16 23:29:10 2021 +0200
Update website
---
content/docs/api/index.html | 117 ++++++++++-------
content/docs/api/interfaces/selector.chunk.html | 139 ++++++++++++---------
content/docs/api/interfaces/selector.chunker.html | 139 ++++++++++++---------
.../docs/api/interfaces/selector.chunkrange.html | 139 ++++++++++++---------
.../docs/api/interfaces/selector.cssselector.html | 139 ++++++++++++---------
.../selector.describetextquoteoptions.html | 139 ++++++++++++---------
content/docs/api/interfaces/selector.matcher.html | 139 ++++++++++++---------
.../api/interfaces/selector.rangeselector.html | 139 ++++++++++++---------
.../docs/api/interfaces/selector.selector-1.html | 139 ++++++++++++---------
.../interfaces/selector.textpositionselector.html | 139 ++++++++++++---------
.../api/interfaces/selector.textquoteselector.html | 139 ++++++++++++---------
content/docs/api/modules/dom.html | 133 ++++++++++++--------
content/docs/api/modules/selector.html | 133 ++++++++++++--------
content/docs/{ => develop}/index.html | 90 +++++++++----
content/docs/getting-started/index.html | 122 +++++++++++++++---
content/docs/index.html | 128 +++++++++++++++----
content/index.html | 16 +--
17 files changed, 1349 insertions(+), 780 deletions(-)
diff --git a/content/docs/api/index.html b/content/docs/api/index.html
index 6767ede..de3e77f 100644
--- a/content/docs/api/index.html
+++ b/content/docs/api/index.html
@@ -1,5 +1,5 @@
<!DOCTYPE html>
-<html prefix="og: http://ogp.me/ns#">
+<html prefix="og: http://ogp.me/ns#" class="default">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
@@ -18,6 +18,15 @@
<meta name="msapplication-TileColor" content="#da532c">
<meta name="theme-color" content="#ffffff">
<link rel="alternate" title="DOAP" href="doap.rdf" type="application/rdf+xml" />
+ <link rel="stylesheet" href="assets/css/main.css">
+ <style>
+ /* Avoid TypeDoc style messing up the page around it. Why oh why did scoped CSS die? */
+ .ui.container {
+ padding: unset;
+ }
+ </style>
+ <script async src="assets/js/search.js" id="search-script"></script>
+ <script defer src="assets/js/main.js"></script>
<link rel="stylesheet" href="//semantic-ui.com/dist/semantic.min.css" />
</head>
<body>
@@ -26,54 +35,73 @@
<a class="item" href="/" style="color: rgba(0,0,0,.87);">
<img class="ui small image" src="/images/annotator-logo.svg" alt="Apache Annotator (incubating)" />
</a>
- <div class="right menu">
+ <nav class="right menu">
+ <a class="item" href="/">Home</a>
<a class="item" href="/demo/"><span class="ui positive button">Demo!</span></a>
- <a class="item" rel="external" href="https://www.npmjs.com/package/apache-annotator">NPM</a>
- <a class="item" rel="external" href="https://github.com/apache?q=annotator#org-repositories">Code</a>
- <a class="item" rel="external" href="https://github.com/apache/incubator-annotator/issues">Issues</a>
- <a class="active item" href="/docs/">Docs</a>
- <a class="item" rel="external" href="https://mail-archives.apache.org/mod_mbox/incubator-annotator-dev/">Mailing List</a>
- </div>
+ <a class="active item" href="/docs/">Documentation</a>
+ <a class="item" rel="external" href="https://github.com/apache/incubator-annotator">Code <i class="small external icon"></i></a>
+ <a class="item" rel="external" href="https://github.com/apache/incubator-annotator/issues">Issue tracker <i class="small external icon"></i></a>
+ </nav>
</div>
</div>
<div class="ui basic segment container">
- <link rel="stylesheet" href="assets/css/main.css">
- <script async src="assets/js/search.js" id="search-script"></script>
- <aside>
- <style>
- #tsd-search {
- position: relative;
- }
- #tsd-search input {
- border: 1px solid grey;
- border-radius: 2px;
- padding: 0.2em;
- }
- #tsd-search .results {
- z-index: 1;
- position: absolute;
- }
- </style>
- <div id="tsd-search" data-index="assets/js/search.json" data-base=".">
- <div>
- <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
- <input id="tsd-search-field" type="text" />
+ <nav class="ui secondary stackable pointing menu" style="justify-content: center;">
+ <a href="/docs/" class="item">Overview</a>
+ <a href="/docs/getting-started/" class="item">Getting Started</a>
+ <a href="/docs/develop/" class="item">Develop</a>
+ <a href="/docs/api/" class="active item">API reference</a>
+ </nav>
+ <div class="ui basic segment container">
+ <div class="ui stackable grid">
+ <div class="eight wide column">
+ <h1>
+ API reference
+ </h1>
+ </div>
+ <div class="eight wide column">
+ <aside>
+ <style>
+ #tsd-search {
+ position: relative;
+ text-align: right;
+ }
+ #tsd-search input {
+ border: 1px solid grey;
+ border-radius: 4px;
+ padding: 0.4em;
+ }
+ #tsd-search label,
+ #tsd-search label::before,
+ #tsd-search input {
+ vertical-align: middle;
+ }
+ #tsd-search .results {
+ z-index: 1;
+ position: absolute;
+ box-shadow: 0px 20px 20px #00000066;
+ }
+ </style>
+ <div id="tsd-search" data-index="assets/js/search.json" data-base=".">
+ <div>
+ <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
+ <input id="tsd-search-field" type="text" />
+ </div>
+ <ul class="results">
+ <li class="state loading">Preparing search index...</li>
+ <li class="state failure">The search index is not available</li>
+ </ul>
+ </div>
+ </aside>
</div>
- <ul class="results">
- <li class="state loading">Preparing search index...</li>
- <li class="state failure">The search index is not available</li>
- </ul>
</div>
- </aside>
- <header style="margin: 2em 0;" id="typedoc-title">
- <style>
- #typedoc-title h1 {
- margin-top: 0;
- }
- </style>
- <h1>apache-annotator</h1>
- </header>
- <main>
+ <header style="margin: 2em 0;" id="typedoc-title">
+ <style>
+ #typedoc-title h1 {
+ margin-top: 0;
+ }
+ </style>
+ <h1>apache-annotator</h1>
+ </header>
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel-group tsd-index-group">
@@ -111,8 +139,7 @@
</nav>
</div>
</div>
- </main>
- <script src="assets/js/main.js"></script>
+ </div>
</div>
<footer class="ui bottom attached segment">
<div class="ui container">
diff --git a/content/docs/api/interfaces/selector.chunk.html b/content/docs/api/interfaces/selector.chunk.html
index 2900760..3b57fee 100644
--- a/content/docs/api/interfaces/selector.chunk.html
+++ b/content/docs/api/interfaces/selector.chunk.html
@@ -1,5 +1,5 @@
<!DOCTYPE html>
-<html prefix="og: http://ogp.me/ns#">
+<html prefix="og: http://ogp.me/ns#" class="default">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
@@ -18,6 +18,15 @@
<meta name="msapplication-TileColor" content="#da532c">
<meta name="theme-color" content="#ffffff">
<link rel="alternate" title="DOAP" href="doap.rdf" type="application/rdf+xml" />
+ <link rel="stylesheet" href="../assets/css/main.css">
+ <style>
+ /* Avoid TypeDoc style messing up the page around it. Why oh why did scoped CSS die? */
+ .ui.container {
+ padding: unset;
+ }
+ </style>
+ <script async src="../assets/js/search.js" id="search-script"></script>
+ <script defer src="../assets/js/main.js"></script>
<link rel="stylesheet" href="//semantic-ui.com/dist/semantic.min.css" />
</head>
<body>
@@ -26,65 +35,84 @@
<a class="item" href="/" style="color: rgba(0,0,0,.87);">
<img class="ui small image" src="/images/annotator-logo.svg" alt="Apache Annotator (incubating)" />
</a>
- <div class="right menu">
+ <nav class="right menu">
+ <a class="item" href="/">Home</a>
<a class="item" href="/demo/"><span class="ui positive button">Demo!</span></a>
- <a class="item" rel="external" href="https://www.npmjs.com/package/apache-annotator">NPM</a>
- <a class="item" rel="external" href="https://github.com/apache?q=annotator#org-repositories">Code</a>
- <a class="item" rel="external" href="https://github.com/apache/incubator-annotator/issues">Issues</a>
- <a class="active item" href="/docs/">Docs</a>
- <a class="item" rel="external" href="https://mail-archives.apache.org/mod_mbox/incubator-annotator-dev/">Mailing List</a>
- </div>
+ <a class="active item" href="/docs/">Documentation</a>
+ <a class="item" rel="external" href="https://github.com/apache/incubator-annotator">Code <i class="small external icon"></i></a>
+ <a class="item" rel="external" href="https://github.com/apache/incubator-annotator/issues">Issue tracker <i class="small external icon"></i></a>
+ </nav>
</div>
</div>
<div class="ui basic segment container">
- <link rel="stylesheet" href="../assets/css/main.css">
- <script async src="../assets/js/search.js" id="search-script"></script>
- <aside>
- <style>
- #tsd-search {
- position: relative;
- }
- #tsd-search input {
- border: 1px solid grey;
- border-radius: 2px;
- padding: 0.2em;
- }
- #tsd-search .results {
- z-index: 1;
- position: absolute;
- }
- </style>
- <div id="tsd-search" data-index="../assets/js/search.json" data-base="..">
- <div>
- <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
- <input id="tsd-search-field" type="text" />
+ <nav class="ui secondary stackable pointing menu" style="justify-content: center;">
+ <a href="/docs/" class="item">Overview</a>
+ <a href="/docs/getting-started/" class="item">Getting Started</a>
+ <a href="/docs/develop/" class="item">Develop</a>
+ <a href="/docs/api/" class="active item">API reference</a>
+ </nav>
+ <div class="ui basic segment container">
+ <div class="ui stackable grid">
+ <div class="eight wide column">
+ <h1>
+ API reference
+ </h1>
+ </div>
+ <div class="eight wide column">
+ <aside>
+ <style>
+ #tsd-search {
+ position: relative;
+ text-align: right;
+ }
+ #tsd-search input {
+ border: 1px solid grey;
+ border-radius: 4px;
+ padding: 0.4em;
+ }
+ #tsd-search label,
+ #tsd-search label::before,
+ #tsd-search input {
+ vertical-align: middle;
+ }
+ #tsd-search .results {
+ z-index: 1;
+ position: absolute;
+ box-shadow: 0px 20px 20px #00000066;
+ }
+ </style>
+ <div id="tsd-search" data-index="../assets/js/search.json" data-base="..">
+ <div>
+ <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
+ <input id="tsd-search-field" type="text" />
+ </div>
+ <ul class="results">
+ <li class="state loading">Preparing search index...</li>
+ <li class="state failure">The search index is not available</li>
+ </ul>
+ </div>
+ </aside>
</div>
- <ul class="results">
- <li class="state loading">Preparing search index...</li>
- <li class="state failure">The search index is not available</li>
- </ul>
</div>
- </aside>
- <header style="margin: 2em 0;" id="typedoc-title">
- <style>
- #typedoc-title h1 {
- margin-top: 0;
- }
- </style>
- <ul class="tsd-breadcrumb">
- <li>
- <a href="../index.html">apache-annotator</a>
- </li>
- <li>
- <a href="../modules/selector.html">selector</a>
- </li>
- <li>
- <a href="selector.chunk.html">Chunk</a>
- </li>
- </ul>
- <h1>Interface Chunk<TData></h1>
- </header>
- <main>
+ <header style="margin: 2em 0;" id="typedoc-title">
+ <style>
+ #typedoc-title h1 {
+ margin-top: 0;
+ }
+ </style>
+ <ul class="tsd-breadcrumb">
+ <li>
+ <a href="../index.html">apache-annotator</a>
+ </li>
+ <li>
+ <a href="../modules/selector.html">selector</a>
+ </li>
+ <li>
+ <a href="selector.chunk.html">Chunk</a>
+ </li>
+ </ul>
+ <h1>Interface Chunk<TData></h1>
+ </header>
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-comment">
@@ -261,8 +289,7 @@
</nav>
</div>
</div>
- </main>
- <script src="../assets/js/main.js"></script>
+ </div>
</div>
<footer class="ui bottom attached segment">
<div class="ui container">
diff --git a/content/docs/api/interfaces/selector.chunker.html b/content/docs/api/interfaces/selector.chunker.html
index 4a48ca0..c841861 100644
--- a/content/docs/api/interfaces/selector.chunker.html
+++ b/content/docs/api/interfaces/selector.chunker.html
@@ -1,5 +1,5 @@
<!DOCTYPE html>
-<html prefix="og: http://ogp.me/ns#">
+<html prefix="og: http://ogp.me/ns#" class="default">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
@@ -18,6 +18,15 @@
<meta name="msapplication-TileColor" content="#da532c">
<meta name="theme-color" content="#ffffff">
<link rel="alternate" title="DOAP" href="doap.rdf" type="application/rdf+xml" />
+ <link rel="stylesheet" href="../assets/css/main.css">
+ <style>
+ /* Avoid TypeDoc style messing up the page around it. Why oh why did scoped CSS die? */
+ .ui.container {
+ padding: unset;
+ }
+ </style>
+ <script async src="../assets/js/search.js" id="search-script"></script>
+ <script defer src="../assets/js/main.js"></script>
<link rel="stylesheet" href="//semantic-ui.com/dist/semantic.min.css" />
</head>
<body>
@@ -26,65 +35,84 @@
<a class="item" href="/" style="color: rgba(0,0,0,.87);">
<img class="ui small image" src="/images/annotator-logo.svg" alt="Apache Annotator (incubating)" />
</a>
- <div class="right menu">
+ <nav class="right menu">
+ <a class="item" href="/">Home</a>
<a class="item" href="/demo/"><span class="ui positive button">Demo!</span></a>
- <a class="item" rel="external" href="https://www.npmjs.com/package/apache-annotator">NPM</a>
- <a class="item" rel="external" href="https://github.com/apache?q=annotator#org-repositories">Code</a>
- <a class="item" rel="external" href="https://github.com/apache/incubator-annotator/issues">Issues</a>
- <a class="active item" href="/docs/">Docs</a>
- <a class="item" rel="external" href="https://mail-archives.apache.org/mod_mbox/incubator-annotator-dev/">Mailing List</a>
- </div>
+ <a class="active item" href="/docs/">Documentation</a>
+ <a class="item" rel="external" href="https://github.com/apache/incubator-annotator">Code <i class="small external icon"></i></a>
+ <a class="item" rel="external" href="https://github.com/apache/incubator-annotator/issues">Issue tracker <i class="small external icon"></i></a>
+ </nav>
</div>
</div>
<div class="ui basic segment container">
- <link rel="stylesheet" href="../assets/css/main.css">
- <script async src="../assets/js/search.js" id="search-script"></script>
- <aside>
- <style>
- #tsd-search {
- position: relative;
- }
- #tsd-search input {
- border: 1px solid grey;
- border-radius: 2px;
- padding: 0.2em;
- }
- #tsd-search .results {
- z-index: 1;
- position: absolute;
- }
- </style>
- <div id="tsd-search" data-index="../assets/js/search.json" data-base="..">
- <div>
- <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
- <input id="tsd-search-field" type="text" />
+ <nav class="ui secondary stackable pointing menu" style="justify-content: center;">
+ <a href="/docs/" class="item">Overview</a>
+ <a href="/docs/getting-started/" class="item">Getting Started</a>
+ <a href="/docs/develop/" class="item">Develop</a>
+ <a href="/docs/api/" class="active item">API reference</a>
+ </nav>
+ <div class="ui basic segment container">
+ <div class="ui stackable grid">
+ <div class="eight wide column">
+ <h1>
+ API reference
+ </h1>
+ </div>
+ <div class="eight wide column">
+ <aside>
+ <style>
+ #tsd-search {
+ position: relative;
+ text-align: right;
+ }
+ #tsd-search input {
+ border: 1px solid grey;
+ border-radius: 4px;
+ padding: 0.4em;
+ }
+ #tsd-search label,
+ #tsd-search label::before,
+ #tsd-search input {
+ vertical-align: middle;
+ }
+ #tsd-search .results {
+ z-index: 1;
+ position: absolute;
+ box-shadow: 0px 20px 20px #00000066;
+ }
+ </style>
+ <div id="tsd-search" data-index="../assets/js/search.json" data-base="..">
+ <div>
+ <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
+ <input id="tsd-search-field" type="text" />
+ </div>
+ <ul class="results">
+ <li class="state loading">Preparing search index...</li>
+ <li class="state failure">The search index is not available</li>
+ </ul>
+ </div>
+ </aside>
</div>
- <ul class="results">
- <li class="state loading">Preparing search index...</li>
- <li class="state failure">The search index is not available</li>
- </ul>
</div>
- </aside>
- <header style="margin: 2em 0;" id="typedoc-title">
- <style>
- #typedoc-title h1 {
- margin-top: 0;
- }
- </style>
- <ul class="tsd-breadcrumb">
- <li>
- <a href="../index.html">apache-annotator</a>
- </li>
- <li>
- <a href="../modules/selector.html">selector</a>
- </li>
- <li>
- <a href="selector.chunker.html">Chunker</a>
- </li>
- </ul>
- <h1>Interface Chunker<TChunk></h1>
- </header>
- <main>
+ <header style="margin: 2em 0;" id="typedoc-title">
+ <style>
+ #typedoc-title h1 {
+ margin-top: 0;
+ }
+ </style>
+ <ul class="tsd-breadcrumb">
+ <li>
+ <a href="../index.html">apache-annotator</a>
+ </li>
+ <li>
+ <a href="../modules/selector.html">selector</a>
+ </li>
+ <li>
+ <a href="selector.chunker.html">Chunker</a>
+ </li>
+ </ul>
+ <h1>Interface Chunker<TChunk></h1>
+ </header>
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-comment">
@@ -326,8 +354,7 @@
</nav>
</div>
</div>
- </main>
- <script src="../assets/js/main.js"></script>
+ </div>
</div>
<footer class="ui bottom attached segment">
<div class="ui container">
diff --git a/content/docs/api/interfaces/selector.chunkrange.html b/content/docs/api/interfaces/selector.chunkrange.html
index e577e68..04bb16d 100644
--- a/content/docs/api/interfaces/selector.chunkrange.html
+++ b/content/docs/api/interfaces/selector.chunkrange.html
@@ -1,5 +1,5 @@
<!DOCTYPE html>
-<html prefix="og: http://ogp.me/ns#">
+<html prefix="og: http://ogp.me/ns#" class="default">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
@@ -18,6 +18,15 @@
<meta name="msapplication-TileColor" content="#da532c">
<meta name="theme-color" content="#ffffff">
<link rel="alternate" title="DOAP" href="doap.rdf" type="application/rdf+xml" />
+ <link rel="stylesheet" href="../assets/css/main.css">
+ <style>
+ /* Avoid TypeDoc style messing up the page around it. Why oh why did scoped CSS die? */
+ .ui.container {
+ padding: unset;
+ }
+ </style>
+ <script async src="../assets/js/search.js" id="search-script"></script>
+ <script defer src="../assets/js/main.js"></script>
<link rel="stylesheet" href="//semantic-ui.com/dist/semantic.min.css" />
</head>
<body>
@@ -26,65 +35,84 @@
<a class="item" href="/" style="color: rgba(0,0,0,.87);">
<img class="ui small image" src="/images/annotator-logo.svg" alt="Apache Annotator (incubating)" />
</a>
- <div class="right menu">
+ <nav class="right menu">
+ <a class="item" href="/">Home</a>
<a class="item" href="/demo/"><span class="ui positive button">Demo!</span></a>
- <a class="item" rel="external" href="https://www.npmjs.com/package/apache-annotator">NPM</a>
- <a class="item" rel="external" href="https://github.com/apache?q=annotator#org-repositories">Code</a>
- <a class="item" rel="external" href="https://github.com/apache/incubator-annotator/issues">Issues</a>
- <a class="active item" href="/docs/">Docs</a>
- <a class="item" rel="external" href="https://mail-archives.apache.org/mod_mbox/incubator-annotator-dev/">Mailing List</a>
- </div>
+ <a class="active item" href="/docs/">Documentation</a>
+ <a class="item" rel="external" href="https://github.com/apache/incubator-annotator">Code <i class="small external icon"></i></a>
+ <a class="item" rel="external" href="https://github.com/apache/incubator-annotator/issues">Issue tracker <i class="small external icon"></i></a>
+ </nav>
</div>
</div>
<div class="ui basic segment container">
- <link rel="stylesheet" href="../assets/css/main.css">
- <script async src="../assets/js/search.js" id="search-script"></script>
- <aside>
- <style>
- #tsd-search {
- position: relative;
- }
- #tsd-search input {
- border: 1px solid grey;
- border-radius: 2px;
- padding: 0.2em;
- }
- #tsd-search .results {
- z-index: 1;
- position: absolute;
- }
- </style>
- <div id="tsd-search" data-index="../assets/js/search.json" data-base="..">
- <div>
- <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
- <input id="tsd-search-field" type="text" />
+ <nav class="ui secondary stackable pointing menu" style="justify-content: center;">
+ <a href="/docs/" class="item">Overview</a>
+ <a href="/docs/getting-started/" class="item">Getting Started</a>
+ <a href="/docs/develop/" class="item">Develop</a>
+ <a href="/docs/api/" class="active item">API reference</a>
+ </nav>
+ <div class="ui basic segment container">
+ <div class="ui stackable grid">
+ <div class="eight wide column">
+ <h1>
+ API reference
+ </h1>
+ </div>
+ <div class="eight wide column">
+ <aside>
+ <style>
+ #tsd-search {
+ position: relative;
+ text-align: right;
+ }
+ #tsd-search input {
+ border: 1px solid grey;
+ border-radius: 4px;
+ padding: 0.4em;
+ }
+ #tsd-search label,
+ #tsd-search label::before,
+ #tsd-search input {
+ vertical-align: middle;
+ }
+ #tsd-search .results {
+ z-index: 1;
+ position: absolute;
+ box-shadow: 0px 20px 20px #00000066;
+ }
+ </style>
+ <div id="tsd-search" data-index="../assets/js/search.json" data-base="..">
+ <div>
+ <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
+ <input id="tsd-search-field" type="text" />
+ </div>
+ <ul class="results">
+ <li class="state loading">Preparing search index...</li>
+ <li class="state failure">The search index is not available</li>
+ </ul>
+ </div>
+ </aside>
</div>
- <ul class="results">
- <li class="state loading">Preparing search index...</li>
- <li class="state failure">The search index is not available</li>
- </ul>
</div>
- </aside>
- <header style="margin: 2em 0;" id="typedoc-title">
- <style>
- #typedoc-title h1 {
- margin-top: 0;
- }
- </style>
- <ul class="tsd-breadcrumb">
- <li>
- <a href="../index.html">apache-annotator</a>
- </li>
- <li>
- <a href="../modules/selector.html">selector</a>
- </li>
- <li>
- <a href="selector.chunkrange.html">ChunkRange</a>
- </li>
- </ul>
- <h1>Interface ChunkRange<TChunk></h1>
- </header>
- <main>
+ <header style="margin: 2em 0;" id="typedoc-title">
+ <style>
+ #typedoc-title h1 {
+ margin-top: 0;
+ }
+ </style>
+ <ul class="tsd-breadcrumb">
+ <li>
+ <a href="../index.html">apache-annotator</a>
+ </li>
+ <li>
+ <a href="../modules/selector.html">selector</a>
+ </li>
+ <li>
+ <a href="selector.chunkrange.html">ChunkRange</a>
+ </li>
+ </ul>
+ <h1>Interface ChunkRange<TChunk></h1>
+ </header>
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-comment">
@@ -250,8 +278,7 @@
</nav>
</div>
</div>
- </main>
- <script src="../assets/js/main.js"></script>
+ </div>
</div>
<footer class="ui bottom attached segment">
<div class="ui container">
diff --git a/content/docs/api/interfaces/selector.cssselector.html b/content/docs/api/interfaces/selector.cssselector.html
index c740788..486b777 100644
--- a/content/docs/api/interfaces/selector.cssselector.html
+++ b/content/docs/api/interfaces/selector.cssselector.html
@@ -1,5 +1,5 @@
<!DOCTYPE html>
-<html prefix="og: http://ogp.me/ns#">
+<html prefix="og: http://ogp.me/ns#" class="default">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
@@ -18,6 +18,15 @@
<meta name="msapplication-TileColor" content="#da532c">
<meta name="theme-color" content="#ffffff">
<link rel="alternate" title="DOAP" href="doap.rdf" type="application/rdf+xml" />
+ <link rel="stylesheet" href="../assets/css/main.css">
+ <style>
+ /* Avoid TypeDoc style messing up the page around it. Why oh why did scoped CSS die? */
+ .ui.container {
+ padding: unset;
+ }
+ </style>
+ <script async src="../assets/js/search.js" id="search-script"></script>
+ <script defer src="../assets/js/main.js"></script>
<link rel="stylesheet" href="//semantic-ui.com/dist/semantic.min.css" />
</head>
<body>
@@ -26,65 +35,84 @@
<a class="item" href="/" style="color: rgba(0,0,0,.87);">
<img class="ui small image" src="/images/annotator-logo.svg" alt="Apache Annotator (incubating)" />
</a>
- <div class="right menu">
+ <nav class="right menu">
+ <a class="item" href="/">Home</a>
<a class="item" href="/demo/"><span class="ui positive button">Demo!</span></a>
- <a class="item" rel="external" href="https://www.npmjs.com/package/apache-annotator">NPM</a>
- <a class="item" rel="external" href="https://github.com/apache?q=annotator#org-repositories">Code</a>
- <a class="item" rel="external" href="https://github.com/apache/incubator-annotator/issues">Issues</a>
- <a class="active item" href="/docs/">Docs</a>
- <a class="item" rel="external" href="https://mail-archives.apache.org/mod_mbox/incubator-annotator-dev/">Mailing List</a>
- </div>
+ <a class="active item" href="/docs/">Documentation</a>
+ <a class="item" rel="external" href="https://github.com/apache/incubator-annotator">Code <i class="small external icon"></i></a>
+ <a class="item" rel="external" href="https://github.com/apache/incubator-annotator/issues">Issue tracker <i class="small external icon"></i></a>
+ </nav>
</div>
</div>
<div class="ui basic segment container">
- <link rel="stylesheet" href="../assets/css/main.css">
- <script async src="../assets/js/search.js" id="search-script"></script>
- <aside>
- <style>
- #tsd-search {
- position: relative;
- }
- #tsd-search input {
- border: 1px solid grey;
- border-radius: 2px;
- padding: 0.2em;
- }
- #tsd-search .results {
- z-index: 1;
- position: absolute;
- }
- </style>
- <div id="tsd-search" data-index="../assets/js/search.json" data-base="..">
- <div>
- <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
- <input id="tsd-search-field" type="text" />
+ <nav class="ui secondary stackable pointing menu" style="justify-content: center;">
+ <a href="/docs/" class="item">Overview</a>
+ <a href="/docs/getting-started/" class="item">Getting Started</a>
+ <a href="/docs/develop/" class="item">Develop</a>
+ <a href="/docs/api/" class="active item">API reference</a>
+ </nav>
+ <div class="ui basic segment container">
+ <div class="ui stackable grid">
+ <div class="eight wide column">
+ <h1>
+ API reference
+ </h1>
+ </div>
+ <div class="eight wide column">
+ <aside>
+ <style>
+ #tsd-search {
+ position: relative;
+ text-align: right;
+ }
+ #tsd-search input {
+ border: 1px solid grey;
+ border-radius: 4px;
+ padding: 0.4em;
+ }
+ #tsd-search label,
+ #tsd-search label::before,
+ #tsd-search input {
+ vertical-align: middle;
+ }
+ #tsd-search .results {
+ z-index: 1;
+ position: absolute;
+ box-shadow: 0px 20px 20px #00000066;
+ }
+ </style>
+ <div id="tsd-search" data-index="../assets/js/search.json" data-base="..">
+ <div>
+ <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
+ <input id="tsd-search-field" type="text" />
+ </div>
+ <ul class="results">
+ <li class="state loading">Preparing search index...</li>
+ <li class="state failure">The search index is not available</li>
+ </ul>
+ </div>
+ </aside>
</div>
- <ul class="results">
- <li class="state loading">Preparing search index...</li>
- <li class="state failure">The search index is not available</li>
- </ul>
</div>
- </aside>
- <header style="margin: 2em 0;" id="typedoc-title">
- <style>
- #typedoc-title h1 {
- margin-top: 0;
- }
- </style>
- <ul class="tsd-breadcrumb">
- <li>
- <a href="../index.html">apache-annotator</a>
- </li>
- <li>
- <a href="../modules/selector.html">selector</a>
- </li>
- <li>
- <a href="selector.cssselector.html">CssSelector</a>
- </li>
- </ul>
- <h1>Interface CssSelector</h1>
- </header>
- <main>
+ <header style="margin: 2em 0;" id="typedoc-title">
+ <style>
+ #typedoc-title h1 {
+ margin-top: 0;
+ }
+ </style>
+ <ul class="tsd-breadcrumb">
+ <li>
+ <a href="../index.html">apache-annotator</a>
+ </li>
+ <li>
+ <a href="../modules/selector.html">selector</a>
+ </li>
+ <li>
+ <a href="selector.cssselector.html">CssSelector</a>
+ </li>
+ </ul>
+ <h1>Interface CssSelector</h1>
+ </header>
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-comment">
@@ -242,8 +270,7 @@
</nav>
</div>
</div>
- </main>
- <script src="../assets/js/main.js"></script>
+ </div>
</div>
<footer class="ui bottom attached segment">
<div class="ui container">
diff --git a/content/docs/api/interfaces/selector.describetextquoteoptions.html b/content/docs/api/interfaces/selector.describetextquoteoptions.html
index a9ed51f..0cb86ac 100644
--- a/content/docs/api/interfaces/selector.describetextquoteoptions.html
+++ b/content/docs/api/interfaces/selector.describetextquoteoptions.html
@@ -1,5 +1,5 @@
<!DOCTYPE html>
-<html prefix="og: http://ogp.me/ns#">
+<html prefix="og: http://ogp.me/ns#" class="default">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
@@ -18,6 +18,15 @@
<meta name="msapplication-TileColor" content="#da532c">
<meta name="theme-color" content="#ffffff">
<link rel="alternate" title="DOAP" href="doap.rdf" type="application/rdf+xml" />
+ <link rel="stylesheet" href="../assets/css/main.css">
+ <style>
+ /* Avoid TypeDoc style messing up the page around it. Why oh why did scoped CSS die? */
+ .ui.container {
+ padding: unset;
+ }
+ </style>
+ <script async src="../assets/js/search.js" id="search-script"></script>
+ <script defer src="../assets/js/main.js"></script>
<link rel="stylesheet" href="//semantic-ui.com/dist/semantic.min.css" />
</head>
<body>
@@ -26,65 +35,84 @@
<a class="item" href="/" style="color: rgba(0,0,0,.87);">
<img class="ui small image" src="/images/annotator-logo.svg" alt="Apache Annotator (incubating)" />
</a>
- <div class="right menu">
+ <nav class="right menu">
+ <a class="item" href="/">Home</a>
<a class="item" href="/demo/"><span class="ui positive button">Demo!</span></a>
- <a class="item" rel="external" href="https://www.npmjs.com/package/apache-annotator">NPM</a>
- <a class="item" rel="external" href="https://github.com/apache?q=annotator#org-repositories">Code</a>
- <a class="item" rel="external" href="https://github.com/apache/incubator-annotator/issues">Issues</a>
- <a class="active item" href="/docs/">Docs</a>
- <a class="item" rel="external" href="https://mail-archives.apache.org/mod_mbox/incubator-annotator-dev/">Mailing List</a>
- </div>
+ <a class="active item" href="/docs/">Documentation</a>
+ <a class="item" rel="external" href="https://github.com/apache/incubator-annotator">Code <i class="small external icon"></i></a>
+ <a class="item" rel="external" href="https://github.com/apache/incubator-annotator/issues">Issue tracker <i class="small external icon"></i></a>
+ </nav>
</div>
</div>
<div class="ui basic segment container">
- <link rel="stylesheet" href="../assets/css/main.css">
- <script async src="../assets/js/search.js" id="search-script"></script>
- <aside>
- <style>
- #tsd-search {
- position: relative;
- }
- #tsd-search input {
- border: 1px solid grey;
- border-radius: 2px;
- padding: 0.2em;
- }
- #tsd-search .results {
- z-index: 1;
- position: absolute;
- }
- </style>
- <div id="tsd-search" data-index="../assets/js/search.json" data-base="..">
- <div>
- <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
- <input id="tsd-search-field" type="text" />
+ <nav class="ui secondary stackable pointing menu" style="justify-content: center;">
+ <a href="/docs/" class="item">Overview</a>
+ <a href="/docs/getting-started/" class="item">Getting Started</a>
+ <a href="/docs/develop/" class="item">Develop</a>
+ <a href="/docs/api/" class="active item">API reference</a>
+ </nav>
+ <div class="ui basic segment container">
+ <div class="ui stackable grid">
+ <div class="eight wide column">
+ <h1>
+ API reference
+ </h1>
+ </div>
+ <div class="eight wide column">
+ <aside>
+ <style>
+ #tsd-search {
+ position: relative;
+ text-align: right;
+ }
+ #tsd-search input {
+ border: 1px solid grey;
+ border-radius: 4px;
+ padding: 0.4em;
+ }
+ #tsd-search label,
+ #tsd-search label::before,
+ #tsd-search input {
+ vertical-align: middle;
+ }
+ #tsd-search .results {
+ z-index: 1;
+ position: absolute;
+ box-shadow: 0px 20px 20px #00000066;
+ }
+ </style>
+ <div id="tsd-search" data-index="../assets/js/search.json" data-base="..">
+ <div>
+ <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
+ <input id="tsd-search-field" type="text" />
+ </div>
+ <ul class="results">
+ <li class="state loading">Preparing search index...</li>
+ <li class="state failure">The search index is not available</li>
+ </ul>
+ </div>
+ </aside>
</div>
- <ul class="results">
- <li class="state loading">Preparing search index...</li>
- <li class="state failure">The search index is not available</li>
- </ul>
</div>
- </aside>
- <header style="margin: 2em 0;" id="typedoc-title">
- <style>
- #typedoc-title h1 {
- margin-top: 0;
- }
- </style>
- <ul class="tsd-breadcrumb">
- <li>
- <a href="../index.html">apache-annotator</a>
- </li>
- <li>
- <a href="../modules/selector.html">selector</a>
- </li>
- <li>
- <a href="selector.describetextquoteoptions.html">DescribeTextQuoteOptions</a>
- </li>
- </ul>
- <h1>Interface DescribeTextQuoteOptions</h1>
- </header>
- <main>
+ <header style="margin: 2em 0;" id="typedoc-title">
+ <style>
+ #typedoc-title h1 {
+ margin-top: 0;
+ }
+ </style>
+ <ul class="tsd-breadcrumb">
+ <li>
+ <a href="../index.html">apache-annotator</a>
+ </li>
+ <li>
+ <a href="../modules/selector.html">selector</a>
+ </li>
+ <li>
+ <a href="selector.describetextquoteoptions.html">DescribeTextQuoteOptions</a>
+ </li>
+ </ul>
+ <h1>Interface DescribeTextQuoteOptions</h1>
+ </header>
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-hierarchy">
@@ -239,8 +267,7 @@
</nav>
</div>
</div>
- </main>
- <script src="../assets/js/main.js"></script>
+ </div>
</div>
<footer class="ui bottom attached segment">
<div class="ui container">
diff --git a/content/docs/api/interfaces/selector.matcher.html b/content/docs/api/interfaces/selector.matcher.html
index 9d244c8..b30a635 100644
--- a/content/docs/api/interfaces/selector.matcher.html
+++ b/content/docs/api/interfaces/selector.matcher.html
@@ -1,5 +1,5 @@
<!DOCTYPE html>
-<html prefix="og: http://ogp.me/ns#">
+<html prefix="og: http://ogp.me/ns#" class="default">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
@@ -18,6 +18,15 @@
<meta name="msapplication-TileColor" content="#da532c">
<meta name="theme-color" content="#ffffff">
<link rel="alternate" title="DOAP" href="doap.rdf" type="application/rdf+xml" />
+ <link rel="stylesheet" href="../assets/css/main.css">
+ <style>
+ /* Avoid TypeDoc style messing up the page around it. Why oh why did scoped CSS die? */
+ .ui.container {
+ padding: unset;
+ }
+ </style>
+ <script async src="../assets/js/search.js" id="search-script"></script>
+ <script defer src="../assets/js/main.js"></script>
<link rel="stylesheet" href="//semantic-ui.com/dist/semantic.min.css" />
</head>
<body>
@@ -26,65 +35,84 @@
<a class="item" href="/" style="color: rgba(0,0,0,.87);">
<img class="ui small image" src="/images/annotator-logo.svg" alt="Apache Annotator (incubating)" />
</a>
- <div class="right menu">
+ <nav class="right menu">
+ <a class="item" href="/">Home</a>
<a class="item" href="/demo/"><span class="ui positive button">Demo!</span></a>
- <a class="item" rel="external" href="https://www.npmjs.com/package/apache-annotator">NPM</a>
- <a class="item" rel="external" href="https://github.com/apache?q=annotator#org-repositories">Code</a>
- <a class="item" rel="external" href="https://github.com/apache/incubator-annotator/issues">Issues</a>
- <a class="active item" href="/docs/">Docs</a>
- <a class="item" rel="external" href="https://mail-archives.apache.org/mod_mbox/incubator-annotator-dev/">Mailing List</a>
- </div>
+ <a class="active item" href="/docs/">Documentation</a>
+ <a class="item" rel="external" href="https://github.com/apache/incubator-annotator">Code <i class="small external icon"></i></a>
+ <a class="item" rel="external" href="https://github.com/apache/incubator-annotator/issues">Issue tracker <i class="small external icon"></i></a>
+ </nav>
</div>
</div>
<div class="ui basic segment container">
- <link rel="stylesheet" href="../assets/css/main.css">
- <script async src="../assets/js/search.js" id="search-script"></script>
- <aside>
- <style>
- #tsd-search {
- position: relative;
- }
- #tsd-search input {
- border: 1px solid grey;
- border-radius: 2px;
- padding: 0.2em;
- }
- #tsd-search .results {
- z-index: 1;
- position: absolute;
- }
- </style>
- <div id="tsd-search" data-index="../assets/js/search.json" data-base="..">
- <div>
- <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
- <input id="tsd-search-field" type="text" />
+ <nav class="ui secondary stackable pointing menu" style="justify-content: center;">
+ <a href="/docs/" class="item">Overview</a>
+ <a href="/docs/getting-started/" class="item">Getting Started</a>
+ <a href="/docs/develop/" class="item">Develop</a>
+ <a href="/docs/api/" class="active item">API reference</a>
+ </nav>
+ <div class="ui basic segment container">
+ <div class="ui stackable grid">
+ <div class="eight wide column">
+ <h1>
+ API reference
+ </h1>
+ </div>
+ <div class="eight wide column">
+ <aside>
+ <style>
+ #tsd-search {
+ position: relative;
+ text-align: right;
+ }
+ #tsd-search input {
+ border: 1px solid grey;
+ border-radius: 4px;
+ padding: 0.4em;
+ }
+ #tsd-search label,
+ #tsd-search label::before,
+ #tsd-search input {
+ vertical-align: middle;
+ }
+ #tsd-search .results {
+ z-index: 1;
+ position: absolute;
+ box-shadow: 0px 20px 20px #00000066;
+ }
+ </style>
+ <div id="tsd-search" data-index="../assets/js/search.json" data-base="..">
+ <div>
+ <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
+ <input id="tsd-search-field" type="text" />
+ </div>
+ <ul class="results">
+ <li class="state loading">Preparing search index...</li>
+ <li class="state failure">The search index is not available</li>
+ </ul>
+ </div>
+ </aside>
</div>
- <ul class="results">
- <li class="state loading">Preparing search index...</li>
- <li class="state failure">The search index is not available</li>
- </ul>
</div>
- </aside>
- <header style="margin: 2em 0;" id="typedoc-title">
- <style>
- #typedoc-title h1 {
- margin-top: 0;
- }
- </style>
- <ul class="tsd-breadcrumb">
- <li>
- <a href="../index.html">apache-annotator</a>
- </li>
- <li>
- <a href="../modules/selector.html">selector</a>
- </li>
- <li>
- <a href="selector.matcher.html">Matcher</a>
- </li>
- </ul>
- <h1>Interface Matcher<TScope, TMatch></h1>
- </header>
- <main>
+ <header style="margin: 2em 0;" id="typedoc-title">
+ <style>
+ #typedoc-title h1 {
+ margin-top: 0;
+ }
+ </style>
+ <ul class="tsd-breadcrumb">
+ <li>
+ <a href="../index.html">apache-annotator</a>
+ </li>
+ <li>
+ <a href="../modules/selector.html">selector</a>
+ </li>
+ <li>
+ <a href="selector.matcher.html">Matcher</a>
+ </li>
+ </ul>
+ <h1>Interface Matcher<TScope, TMatch></h1>
+ </header>
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-comment">
@@ -215,8 +243,7 @@
</nav>
</div>
</div>
- </main>
- <script src="../assets/js/main.js"></script>
+ </div>
</div>
<footer class="ui bottom attached segment">
<div class="ui container">
diff --git a/content/docs/api/interfaces/selector.rangeselector.html b/content/docs/api/interfaces/selector.rangeselector.html
index 7d57bbb..ba2cc9a 100644
--- a/content/docs/api/interfaces/selector.rangeselector.html
+++ b/content/docs/api/interfaces/selector.rangeselector.html
@@ -1,5 +1,5 @@
<!DOCTYPE html>
-<html prefix="og: http://ogp.me/ns#">
+<html prefix="og: http://ogp.me/ns#" class="default">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
@@ -18,6 +18,15 @@
<meta name="msapplication-TileColor" content="#da532c">
<meta name="theme-color" content="#ffffff">
<link rel="alternate" title="DOAP" href="doap.rdf" type="application/rdf+xml" />
+ <link rel="stylesheet" href="../assets/css/main.css">
+ <style>
+ /* Avoid TypeDoc style messing up the page around it. Why oh why did scoped CSS die? */
+ .ui.container {
+ padding: unset;
+ }
+ </style>
+ <script async src="../assets/js/search.js" id="search-script"></script>
+ <script defer src="../assets/js/main.js"></script>
<link rel="stylesheet" href="//semantic-ui.com/dist/semantic.min.css" />
</head>
<body>
@@ -26,65 +35,84 @@
<a class="item" href="/" style="color: rgba(0,0,0,.87);">
<img class="ui small image" src="/images/annotator-logo.svg" alt="Apache Annotator (incubating)" />
</a>
- <div class="right menu">
+ <nav class="right menu">
+ <a class="item" href="/">Home</a>
<a class="item" href="/demo/"><span class="ui positive button">Demo!</span></a>
- <a class="item" rel="external" href="https://www.npmjs.com/package/apache-annotator">NPM</a>
- <a class="item" rel="external" href="https://github.com/apache?q=annotator#org-repositories">Code</a>
- <a class="item" rel="external" href="https://github.com/apache/incubator-annotator/issues">Issues</a>
- <a class="active item" href="/docs/">Docs</a>
- <a class="item" rel="external" href="https://mail-archives.apache.org/mod_mbox/incubator-annotator-dev/">Mailing List</a>
- </div>
+ <a class="active item" href="/docs/">Documentation</a>
+ <a class="item" rel="external" href="https://github.com/apache/incubator-annotator">Code <i class="small external icon"></i></a>
+ <a class="item" rel="external" href="https://github.com/apache/incubator-annotator/issues">Issue tracker <i class="small external icon"></i></a>
+ </nav>
</div>
</div>
<div class="ui basic segment container">
- <link rel="stylesheet" href="../assets/css/main.css">
- <script async src="../assets/js/search.js" id="search-script"></script>
- <aside>
- <style>
- #tsd-search {
- position: relative;
- }
- #tsd-search input {
- border: 1px solid grey;
- border-radius: 2px;
- padding: 0.2em;
- }
- #tsd-search .results {
- z-index: 1;
- position: absolute;
- }
- </style>
- <div id="tsd-search" data-index="../assets/js/search.json" data-base="..">
- <div>
- <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
- <input id="tsd-search-field" type="text" />
+ <nav class="ui secondary stackable pointing menu" style="justify-content: center;">
+ <a href="/docs/" class="item">Overview</a>
+ <a href="/docs/getting-started/" class="item">Getting Started</a>
+ <a href="/docs/develop/" class="item">Develop</a>
+ <a href="/docs/api/" class="active item">API reference</a>
+ </nav>
+ <div class="ui basic segment container">
+ <div class="ui stackable grid">
+ <div class="eight wide column">
+ <h1>
+ API reference
+ </h1>
+ </div>
+ <div class="eight wide column">
+ <aside>
+ <style>
+ #tsd-search {
+ position: relative;
+ text-align: right;
+ }
+ #tsd-search input {
+ border: 1px solid grey;
+ border-radius: 4px;
+ padding: 0.4em;
+ }
+ #tsd-search label,
+ #tsd-search label::before,
+ #tsd-search input {
+ vertical-align: middle;
+ }
+ #tsd-search .results {
+ z-index: 1;
+ position: absolute;
+ box-shadow: 0px 20px 20px #00000066;
+ }
+ </style>
+ <div id="tsd-search" data-index="../assets/js/search.json" data-base="..">
+ <div>
+ <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
+ <input id="tsd-search-field" type="text" />
+ </div>
+ <ul class="results">
+ <li class="state loading">Preparing search index...</li>
+ <li class="state failure">The search index is not available</li>
+ </ul>
+ </div>
+ </aside>
</div>
- <ul class="results">
- <li class="state loading">Preparing search index...</li>
- <li class="state failure">The search index is not available</li>
- </ul>
</div>
- </aside>
- <header style="margin: 2em 0;" id="typedoc-title">
- <style>
- #typedoc-title h1 {
- margin-top: 0;
- }
- </style>
- <ul class="tsd-breadcrumb">
- <li>
- <a href="../index.html">apache-annotator</a>
- </li>
- <li>
- <a href="../modules/selector.html">selector</a>
- </li>
- <li>
- <a href="selector.rangeselector.html">RangeSelector</a>
- </li>
- </ul>
- <h1>Interface RangeSelector</h1>
- </header>
- <main>
+ <header style="margin: 2em 0;" id="typedoc-title">
+ <style>
+ #typedoc-title h1 {
+ margin-top: 0;
+ }
+ </style>
+ <ul class="tsd-breadcrumb">
+ <li>
+ <a href="../index.html">apache-annotator</a>
+ </li>
+ <li>
+ <a href="../modules/selector.html">selector</a>
+ </li>
+ <li>
+ <a href="selector.rangeselector.html">RangeSelector</a>
+ </li>
+ </ul>
+ <h1>Interface RangeSelector</h1>
+ </header>
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-comment">
@@ -253,8 +281,7 @@
</nav>
</div>
</div>
- </main>
- <script src="../assets/js/main.js"></script>
+ </div>
</div>
<footer class="ui bottom attached segment">
<div class="ui container">
diff --git a/content/docs/api/interfaces/selector.selector-1.html b/content/docs/api/interfaces/selector.selector-1.html
index 7b747e9..2e0a77f 100644
--- a/content/docs/api/interfaces/selector.selector-1.html
+++ b/content/docs/api/interfaces/selector.selector-1.html
@@ -1,5 +1,5 @@
<!DOCTYPE html>
-<html prefix="og: http://ogp.me/ns#">
+<html prefix="og: http://ogp.me/ns#" class="default">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
@@ -18,6 +18,15 @@
<meta name="msapplication-TileColor" content="#da532c">
<meta name="theme-color" content="#ffffff">
<link rel="alternate" title="DOAP" href="doap.rdf" type="application/rdf+xml" />
+ <link rel="stylesheet" href="../assets/css/main.css">
+ <style>
+ /* Avoid TypeDoc style messing up the page around it. Why oh why did scoped CSS die? */
+ .ui.container {
+ padding: unset;
+ }
+ </style>
+ <script async src="../assets/js/search.js" id="search-script"></script>
+ <script defer src="../assets/js/main.js"></script>
<link rel="stylesheet" href="//semantic-ui.com/dist/semantic.min.css" />
</head>
<body>
@@ -26,65 +35,84 @@
<a class="item" href="/" style="color: rgba(0,0,0,.87);">
<img class="ui small image" src="/images/annotator-logo.svg" alt="Apache Annotator (incubating)" />
</a>
- <div class="right menu">
+ <nav class="right menu">
+ <a class="item" href="/">Home</a>
<a class="item" href="/demo/"><span class="ui positive button">Demo!</span></a>
- <a class="item" rel="external" href="https://www.npmjs.com/package/apache-annotator">NPM</a>
- <a class="item" rel="external" href="https://github.com/apache?q=annotator#org-repositories">Code</a>
- <a class="item" rel="external" href="https://github.com/apache/incubator-annotator/issues">Issues</a>
- <a class="active item" href="/docs/">Docs</a>
- <a class="item" rel="external" href="https://mail-archives.apache.org/mod_mbox/incubator-annotator-dev/">Mailing List</a>
- </div>
+ <a class="active item" href="/docs/">Documentation</a>
+ <a class="item" rel="external" href="https://github.com/apache/incubator-annotator">Code <i class="small external icon"></i></a>
+ <a class="item" rel="external" href="https://github.com/apache/incubator-annotator/issues">Issue tracker <i class="small external icon"></i></a>
+ </nav>
</div>
</div>
<div class="ui basic segment container">
- <link rel="stylesheet" href="../assets/css/main.css">
- <script async src="../assets/js/search.js" id="search-script"></script>
- <aside>
- <style>
- #tsd-search {
- position: relative;
- }
- #tsd-search input {
- border: 1px solid grey;
- border-radius: 2px;
- padding: 0.2em;
- }
- #tsd-search .results {
- z-index: 1;
- position: absolute;
- }
- </style>
- <div id="tsd-search" data-index="../assets/js/search.json" data-base="..">
- <div>
- <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
- <input id="tsd-search-field" type="text" />
+ <nav class="ui secondary stackable pointing menu" style="justify-content: center;">
+ <a href="/docs/" class="item">Overview</a>
+ <a href="/docs/getting-started/" class="item">Getting Started</a>
+ <a href="/docs/develop/" class="item">Develop</a>
+ <a href="/docs/api/" class="active item">API reference</a>
+ </nav>
+ <div class="ui basic segment container">
+ <div class="ui stackable grid">
+ <div class="eight wide column">
+ <h1>
+ API reference
+ </h1>
+ </div>
+ <div class="eight wide column">
+ <aside>
+ <style>
+ #tsd-search {
+ position: relative;
+ text-align: right;
+ }
+ #tsd-search input {
+ border: 1px solid grey;
+ border-radius: 4px;
+ padding: 0.4em;
+ }
+ #tsd-search label,
+ #tsd-search label::before,
+ #tsd-search input {
+ vertical-align: middle;
+ }
+ #tsd-search .results {
+ z-index: 1;
+ position: absolute;
+ box-shadow: 0px 20px 20px #00000066;
+ }
+ </style>
+ <div id="tsd-search" data-index="../assets/js/search.json" data-base="..">
+ <div>
+ <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
+ <input id="tsd-search-field" type="text" />
+ </div>
+ <ul class="results">
+ <li class="state loading">Preparing search index...</li>
+ <li class="state failure">The search index is not available</li>
+ </ul>
+ </div>
+ </aside>
</div>
- <ul class="results">
- <li class="state loading">Preparing search index...</li>
- <li class="state failure">The search index is not available</li>
- </ul>
</div>
- </aside>
- <header style="margin: 2em 0;" id="typedoc-title">
- <style>
- #typedoc-title h1 {
- margin-top: 0;
- }
- </style>
- <ul class="tsd-breadcrumb">
- <li>
- <a href="../index.html">apache-annotator</a>
- </li>
- <li>
- <a href="../modules/selector.html">selector</a>
- </li>
- <li>
- <a href="selector.selector-1.html">Selector</a>
- </li>
- </ul>
- <h1>Interface Selector</h1>
- </header>
- <main>
+ <header style="margin: 2em 0;" id="typedoc-title">
+ <style>
+ #typedoc-title h1 {
+ margin-top: 0;
+ }
+ </style>
+ <ul class="tsd-breadcrumb">
+ <li>
+ <a href="../index.html">apache-annotator</a>
+ </li>
+ <li>
+ <a href="../modules/selector.html">selector</a>
+ </li>
+ <li>
+ <a href="selector.selector-1.html">Selector</a>
+ </li>
+ </ul>
+ <h1>Interface Selector</h1>
+ </header>
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-comment">
@@ -228,8 +256,7 @@
</nav>
</div>
</div>
- </main>
- <script src="../assets/js/main.js"></script>
+ </div>
</div>
<footer class="ui bottom attached segment">
<div class="ui container">
diff --git a/content/docs/api/interfaces/selector.textpositionselector.html b/content/docs/api/interfaces/selector.textpositionselector.html
index 0a02e4a..7530b2e 100644
--- a/content/docs/api/interfaces/selector.textpositionselector.html
+++ b/content/docs/api/interfaces/selector.textpositionselector.html
@@ -1,5 +1,5 @@
<!DOCTYPE html>
-<html prefix="og: http://ogp.me/ns#">
+<html prefix="og: http://ogp.me/ns#" class="default">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
@@ -18,6 +18,15 @@
<meta name="msapplication-TileColor" content="#da532c">
<meta name="theme-color" content="#ffffff">
<link rel="alternate" title="DOAP" href="doap.rdf" type="application/rdf+xml" />
+ <link rel="stylesheet" href="../assets/css/main.css">
+ <style>
+ /* Avoid TypeDoc style messing up the page around it. Why oh why did scoped CSS die? */
+ .ui.container {
+ padding: unset;
+ }
+ </style>
+ <script async src="../assets/js/search.js" id="search-script"></script>
+ <script defer src="../assets/js/main.js"></script>
<link rel="stylesheet" href="//semantic-ui.com/dist/semantic.min.css" />
</head>
<body>
@@ -26,65 +35,84 @@
<a class="item" href="/" style="color: rgba(0,0,0,.87);">
<img class="ui small image" src="/images/annotator-logo.svg" alt="Apache Annotator (incubating)" />
</a>
- <div class="right menu">
+ <nav class="right menu">
+ <a class="item" href="/">Home</a>
<a class="item" href="/demo/"><span class="ui positive button">Demo!</span></a>
- <a class="item" rel="external" href="https://www.npmjs.com/package/apache-annotator">NPM</a>
- <a class="item" rel="external" href="https://github.com/apache?q=annotator#org-repositories">Code</a>
- <a class="item" rel="external" href="https://github.com/apache/incubator-annotator/issues">Issues</a>
- <a class="active item" href="/docs/">Docs</a>
- <a class="item" rel="external" href="https://mail-archives.apache.org/mod_mbox/incubator-annotator-dev/">Mailing List</a>
- </div>
+ <a class="active item" href="/docs/">Documentation</a>
+ <a class="item" rel="external" href="https://github.com/apache/incubator-annotator">Code <i class="small external icon"></i></a>
+ <a class="item" rel="external" href="https://github.com/apache/incubator-annotator/issues">Issue tracker <i class="small external icon"></i></a>
+ </nav>
</div>
</div>
<div class="ui basic segment container">
- <link rel="stylesheet" href="../assets/css/main.css">
- <script async src="../assets/js/search.js" id="search-script"></script>
- <aside>
- <style>
- #tsd-search {
- position: relative;
- }
- #tsd-search input {
- border: 1px solid grey;
- border-radius: 2px;
- padding: 0.2em;
- }
- #tsd-search .results {
- z-index: 1;
- position: absolute;
- }
- </style>
- <div id="tsd-search" data-index="../assets/js/search.json" data-base="..">
- <div>
- <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
- <input id="tsd-search-field" type="text" />
+ <nav class="ui secondary stackable pointing menu" style="justify-content: center;">
+ <a href="/docs/" class="item">Overview</a>
+ <a href="/docs/getting-started/" class="item">Getting Started</a>
+ <a href="/docs/develop/" class="item">Develop</a>
+ <a href="/docs/api/" class="active item">API reference</a>
+ </nav>
+ <div class="ui basic segment container">
+ <div class="ui stackable grid">
+ <div class="eight wide column">
+ <h1>
+ API reference
+ </h1>
+ </div>
+ <div class="eight wide column">
+ <aside>
+ <style>
+ #tsd-search {
+ position: relative;
+ text-align: right;
+ }
+ #tsd-search input {
+ border: 1px solid grey;
+ border-radius: 4px;
+ padding: 0.4em;
+ }
+ #tsd-search label,
+ #tsd-search label::before,
+ #tsd-search input {
+ vertical-align: middle;
+ }
+ #tsd-search .results {
+ z-index: 1;
+ position: absolute;
+ box-shadow: 0px 20px 20px #00000066;
+ }
+ </style>
+ <div id="tsd-search" data-index="../assets/js/search.json" data-base="..">
+ <div>
+ <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
+ <input id="tsd-search-field" type="text" />
+ </div>
+ <ul class="results">
+ <li class="state loading">Preparing search index...</li>
+ <li class="state failure">The search index is not available</li>
+ </ul>
+ </div>
+ </aside>
</div>
- <ul class="results">
- <li class="state loading">Preparing search index...</li>
- <li class="state failure">The search index is not available</li>
- </ul>
</div>
- </aside>
- <header style="margin: 2em 0;" id="typedoc-title">
- <style>
- #typedoc-title h1 {
- margin-top: 0;
- }
- </style>
- <ul class="tsd-breadcrumb">
- <li>
- <a href="../index.html">apache-annotator</a>
- </li>
- <li>
- <a href="../modules/selector.html">selector</a>
- </li>
- <li>
- <a href="selector.textpositionselector.html">TextPositionSelector</a>
- </li>
- </ul>
- <h1>Interface TextPositionSelector</h1>
- </header>
- <main>
+ <header style="margin: 2em 0;" id="typedoc-title">
+ <style>
+ #typedoc-title h1 {
+ margin-top: 0;
+ }
+ </style>
+ <ul class="tsd-breadcrumb">
+ <li>
+ <a href="../index.html">apache-annotator</a>
+ </li>
+ <li>
+ <a href="../modules/selector.html">selector</a>
+ </li>
+ <li>
+ <a href="selector.textpositionselector.html">TextPositionSelector</a>
+ </li>
+ </ul>
+ <h1>Interface TextPositionSelector</h1>
+ </header>
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-comment">
@@ -253,8 +281,7 @@
</nav>
</div>
</div>
- </main>
- <script src="../assets/js/main.js"></script>
+ </div>
</div>
<footer class="ui bottom attached segment">
<div class="ui container">
diff --git a/content/docs/api/interfaces/selector.textquoteselector.html b/content/docs/api/interfaces/selector.textquoteselector.html
index 42cf915..7074dbe 100644
--- a/content/docs/api/interfaces/selector.textquoteselector.html
+++ b/content/docs/api/interfaces/selector.textquoteselector.html
@@ -1,5 +1,5 @@
<!DOCTYPE html>
-<html prefix="og: http://ogp.me/ns#">
+<html prefix="og: http://ogp.me/ns#" class="default">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
@@ -18,6 +18,15 @@
<meta name="msapplication-TileColor" content="#da532c">
<meta name="theme-color" content="#ffffff">
<link rel="alternate" title="DOAP" href="doap.rdf" type="application/rdf+xml" />
+ <link rel="stylesheet" href="../assets/css/main.css">
+ <style>
+ /* Avoid TypeDoc style messing up the page around it. Why oh why did scoped CSS die? */
+ .ui.container {
+ padding: unset;
+ }
+ </style>
+ <script async src="../assets/js/search.js" id="search-script"></script>
+ <script defer src="../assets/js/main.js"></script>
<link rel="stylesheet" href="//semantic-ui.com/dist/semantic.min.css" />
</head>
<body>
@@ -26,65 +35,84 @@
<a class="item" href="/" style="color: rgba(0,0,0,.87);">
<img class="ui small image" src="/images/annotator-logo.svg" alt="Apache Annotator (incubating)" />
</a>
- <div class="right menu">
+ <nav class="right menu">
+ <a class="item" href="/">Home</a>
<a class="item" href="/demo/"><span class="ui positive button">Demo!</span></a>
- <a class="item" rel="external" href="https://www.npmjs.com/package/apache-annotator">NPM</a>
- <a class="item" rel="external" href="https://github.com/apache?q=annotator#org-repositories">Code</a>
- <a class="item" rel="external" href="https://github.com/apache/incubator-annotator/issues">Issues</a>
- <a class="active item" href="/docs/">Docs</a>
- <a class="item" rel="external" href="https://mail-archives.apache.org/mod_mbox/incubator-annotator-dev/">Mailing List</a>
- </div>
+ <a class="active item" href="/docs/">Documentation</a>
+ <a class="item" rel="external" href="https://github.com/apache/incubator-annotator">Code <i class="small external icon"></i></a>
+ <a class="item" rel="external" href="https://github.com/apache/incubator-annotator/issues">Issue tracker <i class="small external icon"></i></a>
+ </nav>
</div>
</div>
<div class="ui basic segment container">
- <link rel="stylesheet" href="../assets/css/main.css">
- <script async src="../assets/js/search.js" id="search-script"></script>
- <aside>
- <style>
- #tsd-search {
- position: relative;
- }
- #tsd-search input {
- border: 1px solid grey;
- border-radius: 2px;
- padding: 0.2em;
- }
- #tsd-search .results {
- z-index: 1;
- position: absolute;
- }
- </style>
- <div id="tsd-search" data-index="../assets/js/search.json" data-base="..">
- <div>
- <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
- <input id="tsd-search-field" type="text" />
+ <nav class="ui secondary stackable pointing menu" style="justify-content: center;">
+ <a href="/docs/" class="item">Overview</a>
+ <a href="/docs/getting-started/" class="item">Getting Started</a>
+ <a href="/docs/develop/" class="item">Develop</a>
+ <a href="/docs/api/" class="active item">API reference</a>
+ </nav>
+ <div class="ui basic segment container">
+ <div class="ui stackable grid">
+ <div class="eight wide column">
+ <h1>
+ API reference
+ </h1>
+ </div>
+ <div class="eight wide column">
+ <aside>
+ <style>
+ #tsd-search {
+ position: relative;
+ text-align: right;
+ }
+ #tsd-search input {
+ border: 1px solid grey;
+ border-radius: 4px;
+ padding: 0.4em;
+ }
+ #tsd-search label,
+ #tsd-search label::before,
+ #tsd-search input {
+ vertical-align: middle;
+ }
+ #tsd-search .results {
+ z-index: 1;
+ position: absolute;
+ box-shadow: 0px 20px 20px #00000066;
+ }
+ </style>
+ <div id="tsd-search" data-index="../assets/js/search.json" data-base="..">
+ <div>
+ <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
+ <input id="tsd-search-field" type="text" />
+ </div>
+ <ul class="results">
+ <li class="state loading">Preparing search index...</li>
+ <li class="state failure">The search index is not available</li>
+ </ul>
+ </div>
+ </aside>
</div>
- <ul class="results">
- <li class="state loading">Preparing search index...</li>
- <li class="state failure">The search index is not available</li>
- </ul>
</div>
- </aside>
- <header style="margin: 2em 0;" id="typedoc-title">
- <style>
- #typedoc-title h1 {
- margin-top: 0;
- }
- </style>
- <ul class="tsd-breadcrumb">
- <li>
- <a href="../index.html">apache-annotator</a>
- </li>
- <li>
- <a href="../modules/selector.html">selector</a>
- </li>
- <li>
- <a href="selector.textquoteselector.html">TextQuoteSelector</a>
- </li>
- </ul>
- <h1>Interface TextQuoteSelector</h1>
- </header>
- <main>
+ <header style="margin: 2em 0;" id="typedoc-title">
+ <style>
+ #typedoc-title h1 {
+ margin-top: 0;
+ }
+ </style>
+ <ul class="tsd-breadcrumb">
+ <li>
+ <a href="../index.html">apache-annotator</a>
+ </li>
+ <li>
+ <a href="../modules/selector.html">selector</a>
+ </li>
+ <li>
+ <a href="selector.textquoteselector.html">TextQuoteSelector</a>
+ </li>
+ </ul>
+ <h1>Interface TextQuoteSelector</h1>
+ </header>
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-comment">
@@ -264,8 +292,7 @@
</nav>
</div>
</div>
- </main>
- <script src="../assets/js/main.js"></script>
+ </div>
</div>
<footer class="ui bottom attached segment">
<div class="ui container">
diff --git a/content/docs/api/modules/dom.html b/content/docs/api/modules/dom.html
index dca8c7c..f26abbf 100644
--- a/content/docs/api/modules/dom.html
+++ b/content/docs/api/modules/dom.html
@@ -1,5 +1,5 @@
<!DOCTYPE html>
-<html prefix="og: http://ogp.me/ns#">
+<html prefix="og: http://ogp.me/ns#" class="default">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
@@ -18,6 +18,15 @@
<meta name="msapplication-TileColor" content="#da532c">
<meta name="theme-color" content="#ffffff">
<link rel="alternate" title="DOAP" href="doap.rdf" type="application/rdf+xml" />
+ <link rel="stylesheet" href="../assets/css/main.css">
+ <style>
+ /* Avoid TypeDoc style messing up the page around it. Why oh why did scoped CSS die? */
+ .ui.container {
+ padding: unset;
+ }
+ </style>
+ <script async src="../assets/js/search.js" id="search-script"></script>
+ <script defer src="../assets/js/main.js"></script>
<link rel="stylesheet" href="//semantic-ui.com/dist/semantic.min.css" />
</head>
<body>
@@ -26,62 +35,81 @@
<a class="item" href="/" style="color: rgba(0,0,0,.87);">
<img class="ui small image" src="/images/annotator-logo.svg" alt="Apache Annotator (incubating)" />
</a>
- <div class="right menu">
+ <nav class="right menu">
+ <a class="item" href="/">Home</a>
<a class="item" href="/demo/"><span class="ui positive button">Demo!</span></a>
- <a class="item" rel="external" href="https://www.npmjs.com/package/apache-annotator">NPM</a>
- <a class="item" rel="external" href="https://github.com/apache?q=annotator#org-repositories">Code</a>
- <a class="item" rel="external" href="https://github.com/apache/incubator-annotator/issues">Issues</a>
- <a class="active item" href="/docs/">Docs</a>
- <a class="item" rel="external" href="https://mail-archives.apache.org/mod_mbox/incubator-annotator-dev/">Mailing List</a>
- </div>
+ <a class="active item" href="/docs/">Documentation</a>
+ <a class="item" rel="external" href="https://github.com/apache/incubator-annotator">Code <i class="small external icon"></i></a>
+ <a class="item" rel="external" href="https://github.com/apache/incubator-annotator/issues">Issue tracker <i class="small external icon"></i></a>
+ </nav>
</div>
</div>
<div class="ui basic segment container">
- <link rel="stylesheet" href="../assets/css/main.css">
- <script async src="../assets/js/search.js" id="search-script"></script>
- <aside>
- <style>
- #tsd-search {
- position: relative;
- }
- #tsd-search input {
- border: 1px solid grey;
- border-radius: 2px;
- padding: 0.2em;
- }
- #tsd-search .results {
- z-index: 1;
- position: absolute;
- }
- </style>
- <div id="tsd-search" data-index="../assets/js/search.json" data-base="..">
- <div>
- <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
- <input id="tsd-search-field" type="text" />
+ <nav class="ui secondary stackable pointing menu" style="justify-content: center;">
+ <a href="/docs/" class="item">Overview</a>
+ <a href="/docs/getting-started/" class="item">Getting Started</a>
+ <a href="/docs/develop/" class="item">Develop</a>
+ <a href="/docs/api/" class="active item">API reference</a>
+ </nav>
+ <div class="ui basic segment container">
+ <div class="ui stackable grid">
+ <div class="eight wide column">
+ <h1>
+ API reference
+ </h1>
+ </div>
+ <div class="eight wide column">
+ <aside>
+ <style>
+ #tsd-search {
+ position: relative;
+ text-align: right;
+ }
+ #tsd-search input {
+ border: 1px solid grey;
+ border-radius: 4px;
+ padding: 0.4em;
+ }
+ #tsd-search label,
+ #tsd-search label::before,
+ #tsd-search input {
+ vertical-align: middle;
+ }
+ #tsd-search .results {
+ z-index: 1;
+ position: absolute;
+ box-shadow: 0px 20px 20px #00000066;
+ }
+ </style>
+ <div id="tsd-search" data-index="../assets/js/search.json" data-base="..">
+ <div>
+ <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
+ <input id="tsd-search-field" type="text" />
+ </div>
+ <ul class="results">
+ <li class="state loading">Preparing search index...</li>
+ <li class="state failure">The search index is not available</li>
+ </ul>
+ </div>
+ </aside>
</div>
- <ul class="results">
- <li class="state loading">Preparing search index...</li>
- <li class="state failure">The search index is not available</li>
- </ul>
</div>
- </aside>
- <header style="margin: 2em 0;" id="typedoc-title">
- <style>
- #typedoc-title h1 {
- margin-top: 0;
- }
- </style>
- <ul class="tsd-breadcrumb">
- <li>
- <a href="../index.html">apache-annotator</a>
- </li>
- <li>
- <a href="dom.html">dom</a>
- </li>
- </ul>
- <h1>Module dom</h1>
- </header>
- <main>
+ <header style="margin: 2em 0;" id="typedoc-title">
+ <style>
+ #typedoc-title h1 {
+ margin-top: 0;
+ }
+ </style>
+ <ul class="tsd-breadcrumb">
+ <li>
+ <a href="../index.html">apache-annotator</a>
+ </li>
+ <li>
+ <a href="dom.html">dom</a>
+ </li>
+ </ul>
+ <h1>Module dom</h1>
+ </header>
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel-group tsd-index-group">
@@ -604,8 +632,7 @@
</nav>
</div>
</div>
- </main>
- <script src="../assets/js/main.js"></script>
+ </div>
</div>
<footer class="ui bottom attached segment">
<div class="ui container">
diff --git a/content/docs/api/modules/selector.html b/content/docs/api/modules/selector.html
index d2fde26..24cee23 100644
--- a/content/docs/api/modules/selector.html
+++ b/content/docs/api/modules/selector.html
@@ -1,5 +1,5 @@
<!DOCTYPE html>
-<html prefix="og: http://ogp.me/ns#">
+<html prefix="og: http://ogp.me/ns#" class="default">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
@@ -18,6 +18,15 @@
<meta name="msapplication-TileColor" content="#da532c">
<meta name="theme-color" content="#ffffff">
<link rel="alternate" title="DOAP" href="doap.rdf" type="application/rdf+xml" />
+ <link rel="stylesheet" href="../assets/css/main.css">
+ <style>
+ /* Avoid TypeDoc style messing up the page around it. Why oh why did scoped CSS die? */
+ .ui.container {
+ padding: unset;
+ }
+ </style>
+ <script async src="../assets/js/search.js" id="search-script"></script>
+ <script defer src="../assets/js/main.js"></script>
<link rel="stylesheet" href="//semantic-ui.com/dist/semantic.min.css" />
</head>
<body>
@@ -26,62 +35,81 @@
<a class="item" href="/" style="color: rgba(0,0,0,.87);">
<img class="ui small image" src="/images/annotator-logo.svg" alt="Apache Annotator (incubating)" />
</a>
- <div class="right menu">
+ <nav class="right menu">
+ <a class="item" href="/">Home</a>
<a class="item" href="/demo/"><span class="ui positive button">Demo!</span></a>
- <a class="item" rel="external" href="https://www.npmjs.com/package/apache-annotator">NPM</a>
- <a class="item" rel="external" href="https://github.com/apache?q=annotator#org-repositories">Code</a>
- <a class="item" rel="external" href="https://github.com/apache/incubator-annotator/issues">Issues</a>
- <a class="active item" href="/docs/">Docs</a>
- <a class="item" rel="external" href="https://mail-archives.apache.org/mod_mbox/incubator-annotator-dev/">Mailing List</a>
- </div>
+ <a class="active item" href="/docs/">Documentation</a>
+ <a class="item" rel="external" href="https://github.com/apache/incubator-annotator">Code <i class="small external icon"></i></a>
+ <a class="item" rel="external" href="https://github.com/apache/incubator-annotator/issues">Issue tracker <i class="small external icon"></i></a>
+ </nav>
</div>
</div>
<div class="ui basic segment container">
- <link rel="stylesheet" href="../assets/css/main.css">
- <script async src="../assets/js/search.js" id="search-script"></script>
- <aside>
- <style>
- #tsd-search {
- position: relative;
- }
- #tsd-search input {
- border: 1px solid grey;
- border-radius: 2px;
- padding: 0.2em;
- }
- #tsd-search .results {
- z-index: 1;
- position: absolute;
- }
- </style>
- <div id="tsd-search" data-index="../assets/js/search.json" data-base="..">
- <div>
- <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
- <input id="tsd-search-field" type="text" />
+ <nav class="ui secondary stackable pointing menu" style="justify-content: center;">
+ <a href="/docs/" class="item">Overview</a>
+ <a href="/docs/getting-started/" class="item">Getting Started</a>
+ <a href="/docs/develop/" class="item">Develop</a>
+ <a href="/docs/api/" class="active item">API reference</a>
+ </nav>
+ <div class="ui basic segment container">
+ <div class="ui stackable grid">
+ <div class="eight wide column">
+ <h1>
+ API reference
+ </h1>
+ </div>
+ <div class="eight wide column">
+ <aside>
+ <style>
+ #tsd-search {
+ position: relative;
+ text-align: right;
+ }
+ #tsd-search input {
+ border: 1px solid grey;
+ border-radius: 4px;
+ padding: 0.4em;
+ }
+ #tsd-search label,
+ #tsd-search label::before,
+ #tsd-search input {
+ vertical-align: middle;
+ }
+ #tsd-search .results {
+ z-index: 1;
+ position: absolute;
+ box-shadow: 0px 20px 20px #00000066;
+ }
+ </style>
+ <div id="tsd-search" data-index="../assets/js/search.json" data-base="..">
+ <div>
+ <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
+ <input id="tsd-search-field" type="text" />
+ </div>
+ <ul class="results">
+ <li class="state loading">Preparing search index...</li>
+ <li class="state failure">The search index is not available</li>
+ </ul>
+ </div>
+ </aside>
</div>
- <ul class="results">
- <li class="state loading">Preparing search index...</li>
- <li class="state failure">The search index is not available</li>
- </ul>
</div>
- </aside>
- <header style="margin: 2em 0;" id="typedoc-title">
- <style>
- #typedoc-title h1 {
- margin-top: 0;
- }
- </style>
- <ul class="tsd-breadcrumb">
- <li>
- <a href="../index.html">apache-annotator</a>
- </li>
- <li>
- <a href="selector.html">selector</a>
- </li>
- </ul>
- <h1>Module selector</h1>
- </header>
- <main>
+ <header style="margin: 2em 0;" id="typedoc-title">
+ <style>
+ #typedoc-title h1 {
+ margin-top: 0;
+ }
+ </style>
+ <ul class="tsd-breadcrumb">
+ <li>
+ <a href="../index.html">apache-annotator</a>
+ </li>
+ <li>
+ <a href="selector.html">selector</a>
+ </li>
+ </ul>
+ <h1>Module selector</h1>
+ </header>
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel-group tsd-index-group">
@@ -613,8 +641,7 @@
</nav>
</div>
</div>
- </main>
- <script src="../assets/js/main.js"></script>
+ </div>
</div>
<footer class="ui bottom attached segment">
<div class="ui container">
diff --git a/content/docs/index.html b/content/docs/develop/index.html
similarity index 57%
copy from content/docs/index.html
copy to content/docs/develop/index.html
index 73ff931..ee1fca0 100644
--- a/content/docs/index.html
+++ b/content/docs/develop/index.html
@@ -1,5 +1,5 @@
<!DOCTYPE html>
-<html prefix="og: http://ogp.me/ns#">
+<html prefix="og: http://ogp.me/ns#" class="default">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
@@ -22,6 +22,7 @@
<link rel="alternate" title="DOAP" href="doap.rdf" type="application/rdf+xml" />
+
<link rel="stylesheet" href="//semantic-ui.com/dist/semantic.min.css" />
</head>
@@ -32,31 +33,78 @@
<img class="ui small image" src="/images/annotator-logo.svg" alt="Apache Annotator (incubating)" />
</a>
- <div class="right menu">
+ <nav class="right menu">
+ <a class="item" href="/">Home</a>
<a class="item" href="/demo/"><span class="ui positive button">Demo!</span></a>
- <a class="item" rel="external" href="https://www.npmjs.com/package/apache-annotator">NPM</a>
- <a class="item" rel="external" href="https://github.com/apache?q=annotator#org-repositories">Code</a>
- <a class="item" rel="external" href="https://github.com/apache/incubator-annotator/issues">Issues</a>
- <a class="active item" href="/docs/">Docs</a>
- <a class="item" rel="external" href="https://mail-archives.apache.org/mod_mbox/incubator-annotator-dev/">Mailing List</a>
- </div>
+ <a class="active item" href="/docs/">Documentation</a>
+ <a class="item" rel="external" href="https://github.com/apache/incubator-annotator">Code <i class="small external icon"></i></a>
+ <a class="item" rel="external" href="https://github.com/apache/incubator-annotator/issues">Issue tracker <i class="small external icon"></i></a>
+ </nav>
</div>
</div>
<div class="ui basic segment container">
- <div class="ui grid">
- <div class="three wide column">
- <div class="ui vertical secondary menu">
- <div class="item"><a href="/docs/getting-started/">Getting Started</a></div>
- <div class="active item"><a href="/docs/">Documentation</a></div>
- </div>
- </div>
- <div class="nine wide column">
- <p>We're working on some initial documentation for getting started with Apache
-Annotator, and to help folks understand how it fits in their projects.</p>
-<p>Stay tuned for more!</p>
+
+<nav class="ui secondary stackable pointing menu" style="justify-content: center;">
+ <a href="/docs/" class="item">Overview</a>
+ <a href="/docs/getting-started/" class="item">Getting Started</a>
+ <a href="/docs/develop/" class="active item">Develop</a>
+ <a href="/docs/api/" class="item">API reference</a>
+</nav>
- </div>
- </div>
+<main class="ui basic segment container">
+ <h1 style="margin-bottom: 2rem">Develop Apache Annotator</h1>
+ <div class="ui mobile reversed stackable grid">
+ <div class="twelve wide column">
+ <h2 id="install-from-source">Install from source</h2>
+<p>This project’s source code is available directly <a href="https://gitbox.apache.org/repos/asf?p=incubator-annotator.git">from the ASF</a> or <a href="https://github.com/apache/incubator-annotator">via GitHub</a>.</p>
+<h3 id="requirements">Requirements</h3>
+<p>If you’d like to code on the project, you will need the following:</p>
+<ul>
+<li><a href="https://git-scm.com/">git</a></li>
+<li><a href="https://nodejs.org">node</a> version ^12.20 || ^14.15 || ^15.4</li>
+<li><a href="https://www.yarnpkg.com/">yarn</a> version ^1.5</li>
+</ul>
+<h3 id="install">Install</h3>
+<p>To retrieve the code using git:</p>
+<pre><code>$ git clone https://gitbox.apache.org/repos/asf/incubator-annotator.git apache-annotator
+</code></pre>
+<p>Then install dependencies using yarn:</p>
+<pre><code class="language-sh">$ cd apache-annotator
+$ yarn install
+</code></pre>
+<h2 id="build">Build</h2>
+<p>To compile (‘transpile’) the code:</p>
+<pre><code class="language-sh">$ yarn build
+</code></pre>
+<p>For each module, the TypeScript source code is in <code>packages/…/src</code> and the Javascript is output in <code>packages/…/lib</code>.</p>
+<p>To use your local build of the code in an application that depends on annotator, have a look at the <a href="https://yarnpkg.com/cli/link"><code>yarn link</code></a> or <a href="https://docs.npmjs.com/cli/v7/commands/npm-link"><code>npm link</code></a> command.</p>
+<h2 id="play">Play</h2>
+<p>To run a webserver running <a href="https://annotator.apache.org/demo/">the demo</a>:</p>
+<pre><code>$ yarn start
+</code></pre>
+<p>Now open <code>http://localhost:8080/</code> (or whichever address the command prints) in your web browser to play with the demo. The server continuously rebuilds and hot-reloads to the source code after any edits, so you can directly try out any changes you make to the features it demonstrates.</p>
+<h2 id="run-tests">Run tests</h2>
+<p>This runs the tests for all packages and reports their code coverage:</p>
+<pre><code class="language-sh">$ yarn test
+</code></pre>
+
+ </div>
+ <aside class="ui four wide column">
+ <style>
+ .toc ol {
+ list-style-type: none;
+ padding-left: 1em;
+ }
+ .toc ol li {
+ margin: 0.25em 0;
+ }
+ </style>
+ <h1 class="ui small dividing header" style="margin: 0;">Contents</h1>
+ <nav class="toc">
+ <ol><li><a href="#install-from-source">Install from source</a><ol><li><a href="#requirements">Requirements</a></li><li><a href="#install">Install</a></li></ol></li><li><a href="#build">Build</a></li><li><a href="#play">Play</a></li><li><a href="#run-tests">Run tests</a></li></ol></nav>
+ </aside>
+ </div>
+</main>
</div>
<footer class="ui bottom attached segment">
diff --git a/content/docs/getting-started/index.html b/content/docs/getting-started/index.html
index fc5a842..c6e25a3 100644
--- a/content/docs/getting-started/index.html
+++ b/content/docs/getting-started/index.html
@@ -1,5 +1,5 @@
<!DOCTYPE html>
-<html prefix="og: http://ogp.me/ns#">
+<html prefix="og: http://ogp.me/ns#" class="default">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
@@ -22,6 +22,7 @@
<link rel="alternate" title="DOAP" href="doap.rdf" type="application/rdf+xml" />
+
<link rel="stylesheet" href="//semantic-ui.com/dist/semantic.min.css" />
</head>
@@ -32,29 +33,112 @@
<img class="ui small image" src="/images/annotator-logo.svg" alt="Apache Annotator (incubating)" />
</a>
- <div class="right menu">
+ <nav class="right menu">
+ <a class="item" href="/">Home</a>
<a class="item" href="/demo/"><span class="ui positive button">Demo!</span></a>
- <a class="item" rel="external" href="https://www.npmjs.com/package/apache-annotator">NPM</a>
- <a class="item" rel="external" href="https://github.com/apache?q=annotator#org-repositories">Code</a>
- <a class="item" rel="external" href="https://github.com/apache/incubator-annotator/issues">Issues</a>
- <a class="active item" href="/docs/">Docs</a>
- <a class="item" rel="external" href="https://mail-archives.apache.org/mod_mbox/incubator-annotator-dev/">Mailing List</a>
- </div>
+ <a class="active item" href="/docs/">Documentation</a>
+ <a class="item" rel="external" href="https://github.com/apache/incubator-annotator">Code <i class="small external icon"></i></a>
+ <a class="item" rel="external" href="https://github.com/apache/incubator-annotator/issues">Issue tracker <i class="small external icon"></i></a>
+ </nav>
</div>
</div>
<div class="ui basic segment container">
- <div class="ui grid">
- <div class="three wide column">
- <div class="ui vertical secondary menu">
- <div class="active item"><a href="/docs/getting-started/">Getting Started</a></div>
- <div class="item"><a href="/docs/">Documentation</a></div>
- </div>
- </div>
- <div class="nine wide column">
- <p>Please checkout the <a href="/demo/">demo</a> for now, but we'll explain it here soon.</p>
+
+<nav class="ui secondary stackable pointing menu" style="justify-content: center;">
+ <a href="/docs/" class="item">Overview</a>
+ <a href="/docs/getting-started/" class="active item">Getting Started</a>
+ <a href="/docs/develop/" class="item">Develop</a>
+ <a href="/docs/api/" class="item">API reference</a>
+</nav>
- </div>
- </div>
+<main class="ui basic segment container">
+ <h1 style="margin-bottom: 2rem">Getting Started</h1>
+ <div class="ui mobile reversed stackable grid">
+ <div class="twelve wide column">
+ <h2 id="install-via-npm">Install via NPM</h2>
+<p>Currently we only support installation through NPM packages. You will need to use a bundler (such as <a href="https://webpack.js.org/">webpack</a>) to use the modules in a web browser.</p>
+<p>The project is made up of multiple modules. Each module is <a href="https://www.npmjs.com/org/apache-annotator">available on the NPM registry</a> as individual packages in the <code>@apache-annotator</code> scope, and all of them together in the <a href="https://www.npmjs.com/package/apache-annotator"><code>apache-annotator</code></a> ‘meta-package’. You can install either and then import packages in your code as <code>@apache-annotator/package</code> or <code>apache-annotator/package [...]
+<p>For example:</p>
+<pre><code class="language-sh">$ yarn add @apache-annotator/dom
+</code></pre>
+<p>…with in your code:</p>
+<pre><code class="language-js">import { highlightRange } from '@apache-annotator/dom';
+</code></pre>
+<h2 id="install-from-source">Install from source</h2>
+<p>See <a href="/docs/develop/">Develop</a>.</p>
+<h2 id="usage-example%3A-a-text-quote-highlighter">Usage example: a text quote highlighter</h2>
+<p>A typical goal of web annotation is to let users highlight a phrase of text in a web page, and perhaps add a note to it. The example code below enables this use case.</p>
+<p>First, we define the way to describe the user’s selection as a TextQuoteSelector.</p>
+<pre><code class="language-js">import { describeTextQuote } from '@apache-annotator/dom';
+
+async function describeCurrentSelection() {
+ const userSelection = window.getSelection()?.getRangeAt(0);
+ if (!userSelection || userSelection.isCollapsed) return;
+ return describeTextQuote(userSelection);
+}
+</code></pre>
+<p>If the user had selected the word <em>“ipsum”</em> in the befamed <em>“Lorem ipsum dolor amet …”</em>, the return value of describeCurrentSelection() might resolve to this:</p>
+<pre><code>{
+ type: 'TextQuoteSelector',
+ exact: 'ipsum',
+ prefix: 'Lorem ',
+ suffix: ' dolor'
+}
+</code></pre>
+<p>The <em>prefix</em> and <em>suffix</em> attributes are there to know which of multiple occurrences of <em>“ipsum”</em> the Selector points to. They will include just enough surrounding words to make the selector unambiguous.</p>
+<p>Next, we define roughly the inverse function: given a TextQuoteSelector, we highlight the text it points to.</p>
+<pre><code class="language-js">import { createTextQuoteSelectorMatcher, highlightRange } from '@apache-annotator/dom';
+
+async function highlightSelectorTarget(textQuoteSelector) {
+ // Search in the whole document
+ const scope = document.createRange();
+ scope.selectNodeContents(document);
+
+ const matches = createTextQuoteSelectorMatcher(textQuoteSelector)(scope);
+ for await (const match of matches) {
+ highlightRange(match);
+ }
+}
+</code></pre>
+<p>As the <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/for-await...of"><code>for await … of</code></a> statement suggests, the matcher does not return just one match, but a stream (an async iterable) of matches. This is because it cannot be certain that a selector only has a single match (even when it includes a prefix & suffix, perhaps the document changed!).</p>
+<p>We could use the functions defined above in many ways; keeping highlighted quotes in local storage, or in one’s bookmarks, or sharing them with others, and so on. For this example, we keep it simple and highlight each selection upon release of the mouse button; and store the selector to make it appear again after a page reload.</p>
+<pre><code class="language-js">document.addEventListener('mouseup', async () => {
+ const selector = await describeCurrentSelection();
+ const existingSelectors = JSON.parse(localStorage[document.URL] || '[]');
+ localStorage[document.URL] = JSON.stringify([...existingSelectors, selector]);
+ await highlightSelectorTarget(selector);
+});
+
+// Highlight the last selection that was stored, if any.
+async function highlightStoredSelectors() {
+ if (localStorage[document.URL]) {
+ const selectors = JSON.parse(localStorage[document.URL]);
+ for (const selector of selectors) {
+ await highlightSelectorTarget(selector);
+ }
+ }
+}
+highlightStoredSelectors();
+</code></pre>
+<p>To see similar pieces of code in action, have a look at <a href="/demo/">the demo</a>.</p>
+
+ </div>
+ <aside class="ui four wide column">
+ <style>
+ .toc ol {
+ list-style-type: none;
+ padding-left: 1em;
+ }
+ .toc ol li {
+ margin: 0.25em 0;
+ }
+ </style>
+ <h1 class="ui small dividing header" style="margin: 0;">Contents</h1>
+ <nav class="toc">
+ <ol><li><a href="#install-via-npm">Install via NPM</a></li><li><a href="#install-from-source">Install from source</a></li><li><a href="#usage-example%3A-a-text-quote-highlighter">Usage example: a text quote highlighter</a></li></ol></nav>
+ </aside>
+ </div>
+</main>
</div>
<footer class="ui bottom attached segment">
diff --git a/content/docs/index.html b/content/docs/index.html
index 73ff931..9fcb7b6 100644
--- a/content/docs/index.html
+++ b/content/docs/index.html
@@ -1,5 +1,5 @@
<!DOCTYPE html>
-<html prefix="og: http://ogp.me/ns#">
+<html prefix="og: http://ogp.me/ns#" class="default">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
@@ -22,6 +22,7 @@
<link rel="alternate" title="DOAP" href="doap.rdf" type="application/rdf+xml" />
+
<link rel="stylesheet" href="//semantic-ui.com/dist/semantic.min.css" />
</head>
@@ -32,31 +33,116 @@
<img class="ui small image" src="/images/annotator-logo.svg" alt="Apache Annotator (incubating)" />
</a>
- <div class="right menu">
+ <nav class="right menu">
+ <a class="item" href="/">Home</a>
<a class="item" href="/demo/"><span class="ui positive button">Demo!</span></a>
- <a class="item" rel="external" href="https://www.npmjs.com/package/apache-annotator">NPM</a>
- <a class="item" rel="external" href="https://github.com/apache?q=annotator#org-repositories">Code</a>
- <a class="item" rel="external" href="https://github.com/apache/incubator-annotator/issues">Issues</a>
- <a class="active item" href="/docs/">Docs</a>
- <a class="item" rel="external" href="https://mail-archives.apache.org/mod_mbox/incubator-annotator-dev/">Mailing List</a>
- </div>
+ <a class="active item" href="/docs/">Documentation</a>
+ <a class="item" rel="external" href="https://github.com/apache/incubator-annotator">Code <i class="small external icon"></i></a>
+ <a class="item" rel="external" href="https://github.com/apache/incubator-annotator/issues">Issue tracker <i class="small external icon"></i></a>
+ </nav>
</div>
</div>
<div class="ui basic segment container">
- <div class="ui grid">
- <div class="three wide column">
- <div class="ui vertical secondary menu">
- <div class="item"><a href="/docs/getting-started/">Getting Started</a></div>
- <div class="active item"><a href="/docs/">Documentation</a></div>
- </div>
- </div>
- <div class="nine wide column">
- <p>We're working on some initial documentation for getting started with Apache
-Annotator, and to help folks understand how it fits in their projects.</p>
-<p>Stay tuned for more!</p>
+
+<nav class="ui secondary stackable pointing menu" style="justify-content: center;">
+ <a href="/docs/" class="active item">Overview</a>
+ <a href="/docs/getting-started/" class="item">Getting Started</a>
+ <a href="/docs/develop/" class="item">Develop</a>
+ <a href="/docs/api/" class="item">API reference</a>
+</nav>
- </div>
- </div>
+<main class="ui basic segment container">
+ <h1 style="margin-bottom: 2rem">Overview</h1>
+ <div class="ui mobile reversed stackable grid">
+ <div class="twelve wide column">
+ <p>Apache Annotator provides software modules to facilitate annotation tools in web browser environments. For example, it could be used in web-based document viewers or browser extensions that let users highlight phrases and place virtual sticky notes on the pages they visit.</p>
+<p>The modules are written in <a href="https://www.typescriptlang.org/">TypeScript</a>, and distributed as Javascript/ECMAScript modules <a href="https://www.npmjs.com/org/apache-annotator">on NPM</a>. Read further for a high-level description of the code functionality, or <a href="/docs/getting-started/">get started</a> with it directly!</p>
+<h2 id="what-is-in-the-box">What is in the box</h2>
+<h3 id="selector-tools">Selector tools</h3>
+<p>The main functionality Apache Annotator offers is to map a <a href="https://www.w3.org/TR/2017/REC-annotation-model-20170223/#selector">Web Annotation Selector</a> to the segment of a document it corresponds to, sometimes called ‘anchoring’ a Selector; and, vice versa, to create a Selector that describes a given selection in the document precisely and unambiguously, such that other Web Annotation software knows exactly where it points to. The purpose of Selectors is to point at any pa [...]
+<p>The <a href="https://www.w3.org/TR/annotation-model">W3C Web Annotation Data Model</a> outlines a number of different selectors types, to accomodate various use case on different types of documents and selections (e.g. an annotation may target a phrase of text, or a region within an image). The table below shows the full list of defined types and the implementation status of each.</p>
+<table>
+<thead>
+<tr>
+<th>Selector</th>
+<th>Description</th>
+<th>Implemented?</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td><a href="https://www.w3.org/TR/annotation-model/#fragment-selector">Fragment</a></td>
+<td>Uses the fragment part of an IRI defined by the representation’s media type.</td>
+<td>No</td>
+</tr>
+<tr>
+<td><a href="https://www.w3.org/TR/annotation-model/#css-selector">CSS</a></td>
+<td>CSS Selectors allow for a wide variety of well supported ways to describe the path to an element in a web page.</td>
+<td><a href="/docs/api/modules/dom.html#createcssselectormatcher">Partly</a></td>
+</tr>
+<tr>
+<td><a href="https://www.w3.org/TR/annotation-model/#xpath-selector">XPath</a></td>
+<td>Implements an XPath based selection.</td>
+<td>No</td>
+</tr>
+<tr>
+<td><a href="https://www.w3.org/TR/annotation-model/#text-quote-selector">Text Quote</a></td>
+<td>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.</td>
+<td>Yes, both <a href="/docs/api/modules/dom.html#describetextquote">for DOM</a> and <a href="/docs/api/modules/selector.html#textquoteselectormatcher">generic</a></td>
+</tr>
+<tr>
+<td><a href="https://www.w3.org/TR/annotation-model/#text-position-selector">Text Position</a></td>
+<td>This Selector describes a range of text by recording the start and end positions of the selection in the stream.</td>
+<td>Yes, both <a href="/docs/api/modules/dom.html#describetextposition">for DOM</a> and <a href="/docs/api/modules/selector.html#textpositionselectormatcher">generic</a></td>
+</tr>
+<tr>
+<td><a href="https://www.w3.org/TR/annotation-model/#data-position-selector">Data Position</a></td>
+<td>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.</td>
+<td>No</td>
+</tr>
+<tr>
+<td><a href="https://www.w3.org/TR/annotation-model/#svg-selector">SVG</a></td>
+<td>An SvgSelector defines an area through the use of the Scalable Vector Graphics standard.</td>
+<td>No</td>
+</tr>
+<tr>
+<td><a href="https://www.w3.org/TR/annotation-model/#range-selector">Range</a></td>
+<td>A Range Selector can be used to identify the beginning and the end of the selection by using other Selectors.</td>
+<td>Yes, <a href="/docs/api/modules/dom.html#makecreaterangeselectormatcher">for DOM</a></td>
+</tr>
+<tr>
+<td><a href="https://www.w3.org/TR/annotation-model/#refinement-of-selection">Refinement</a></td>
+<td>Select a part of a selection, rather than as a selection of the complete resource.</td>
+<td><a href="/docs/api/modules/selector.html#makerefinable">Yes</a></td>
+</tr>
+</tbody>
+</table>
+<h3 id="web-annotation-json-validator">Web Annotation JSON validator</h3>
+<p>The source code also includes a script for validating Web Annotation Data Model JSON documents against the data model schema. Having <a href="/docs/develop/#install-from-source">installed from source</a>, one can run:</p>
+<pre><code class="language-sh">$ yarn validate --url https://raw.githubusercontent.com/w3c/web-annotation-tests/master/tools/samples/correct/anno1.json
+</code></pre>
+<p>With the <code>--url</code> option you can pass in a URL or a local path to a JSON file.</p>
+<p>See some <a href="https://github.com/w3c/web-annotation-tests/tree/master/tools/samples">example JSON files</a> from the W3C. Note that this validator only tests the data model is followed, and not e.g. whether its target actually exists.</p>
+<h2 id="what-apache-annotator-it-not">What Apache Annotator it not</h2>
+<p>Apache Annotator is <strong>not an all-in-one annotation tool</strong>; rather, it <em>helps others create</em> annotation tools. It does not have opinions regarding in which database on which computer annotations are stored, nor how they are made, exchanged or displayed. Those questions are considered application-specific and left to the developer. Our goal is that the developer can focus on exactly those questions, and forget about issues that are common among annotation tools: find [...]
+
+ </div>
+ <aside class="ui four wide column">
+ <style>
+ .toc ol {
+ list-style-type: none;
+ padding-left: 1em;
+ }
+ .toc ol li {
+ margin: 0.25em 0;
+ }
+ </style>
+ <h1 class="ui small dividing header" style="margin: 0;">Contents</h1>
+ <nav class="toc">
+ <ol><li><a href="#what-is-in-the-box">What is in the box</a><ol><li><a href="#selector-tools">Selector tools</a></li><li><a href="#web-annotation-json-validator">Web Annotation JSON validator</a></li></ol></li><li><a href="#what-apache-annotator-it-not">What Apache Annotator it not</a></li></ol></nav>
+ </aside>
+ </div>
+</main>
</div>
<footer class="ui bottom attached segment">
diff --git a/content/index.html b/content/index.html
index d0730d9..4c48de0 100644
--- a/content/index.html
+++ b/content/index.html
@@ -1,5 +1,5 @@
<!DOCTYPE html>
-<html prefix="og: http://ogp.me/ns#">
+<html prefix="og: http://ogp.me/ns#" class="default">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
@@ -22,6 +22,7 @@
<link rel="alternate" title="DOAP" href="doap.rdf" type="application/rdf+xml" />
+
<link rel="stylesheet" href="//semantic-ui.com/dist/semantic.min.css" />
</head>
@@ -32,14 +33,13 @@
<img class="ui small image" src="/images/annotator-logo.svg" alt="Apache Annotator (incubating)" />
</a>
- <div class="right menu">
+ <nav class="right menu">
+ <a class="item" href="/">Home</a>
<a class="item" href="/demo/"><span class="ui positive button">Demo!</span></a>
- <a class="item" rel="external" href="https://www.npmjs.com/package/apache-annotator">NPM</a>
- <a class="item" rel="external" href="https://github.com/apache?q=annotator#org-repositories">Code</a>
- <a class="item" rel="external" href="https://github.com/apache/incubator-annotator/issues">Issues</a>
- <a class="item" href="/docs/">Docs</a>
- <a class="item" rel="external" href="https://mail-archives.apache.org/mod_mbox/incubator-annotator-dev/">Mailing List</a>
- </div>
+ <a class="item" href="/docs/">Documentation</a>
+ <a class="item" rel="external" href="https://github.com/apache/incubator-annotator">Code <i class="small external icon"></i></a>
+ <a class="item" rel="external" href="https://github.com/apache/incubator-annotator/issues">Issue tracker <i class="small external icon"></i></a>
+ </nav>
</div>
</div>
<div class="ui basic segment container">
[incubator-annotator-website] 01/04: Add table of contents to doc
pages
Posted by ge...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
gerben pushed a commit to branch asf-site
in repository https://gitbox.apache.org/repos/asf/incubator-annotator-website.git
commit 5df55752e03902ffc10feba89a2a84dfbb34d1ac
Author: Gerben <ge...@treora.com>
AuthorDate: Sat May 15 18:16:47 2021 +0200
Add table of contents to doc pages
---
.eleventy.js | 7 +++
package.json | 5 +-
src/_layouts/docs.hbs | 20 ++++++-
yarn.lock | 154 ++++++++++++++++++++++++++++++++++++++++++++++++++
4 files changed, 183 insertions(+), 3 deletions(-)
diff --git a/.eleventy.js b/.eleventy.js
index bd4a104..d31afc8 100644
--- a/.eleventy.js
+++ b/.eleventy.js
@@ -23,6 +23,13 @@ module.exports = function(eleventyConfig) {
eleventyConfig.addShortcode('eq', function(a, b) { return a === b });
eleventyConfig.addShortcode('not-eq', function(a, b) { return a !== b });
+ // To add table of contents to docs: {{{ toc content }}}
+ const markdownIt = require('markdown-it');
+ const markdownItAnchor = require('markdown-it-anchor');
+ eleventyConfig.setLibrary('md', markdownIt().use(markdownItAnchor));
+ const pluginTOC = require('eleventy-plugin-toc');
+ eleventyConfig.addPlugin(pluginTOC, { tags: ['h2', 'h3'] });
+
return {
dir: {
input: 'src',
diff --git a/package.json b/package.json
index 6ce24f1..d6f5bd3 100644
--- a/package.json
+++ b/package.json
@@ -20,6 +20,9 @@
},
"homepage": "https://github.com/apache/incubator-annotator-website#readme",
"devDependencies": {
- "@11ty/eleventy": "^0.11.0"
+ "@11ty/eleventy": "^0.11.0",
+ "eleventy-plugin-toc": "^1.1.0",
+ "markdown-it": "^12.0.6",
+ "markdown-it-anchor": "^7.1.0"
}
}
diff --git a/src/_layouts/docs.hbs b/src/_layouts/docs.hbs
index ee9f3d3..4c3c2c6 100644
--- a/src/_layouts/docs.hbs
+++ b/src/_layouts/docs.hbs
@@ -7,6 +7,22 @@ isDocs: true
<main class="ui basic segment container">
<h1>{{title}}</h1>
-
- {{{content}}}
+ <div class="ui mobile reversed stackable grid">
+ <div class="twelve wide column">
+ {{{content}}}
+ </div>
+ <aside class="ui four wide column">
+ <style>
+ .toc ol {
+ list-style-type: none;
+ padding-left: 1em;
+ }
+ .toc ol li {
+ margin: 0.25em 0;
+ }
+ </style>
+ <h1 class="ui small dividing header" style="margin: 0;">Contents</h1>
+ {{{ toc content }}}
+ </aside>
+ </div>
</main>
diff --git a/yarn.lock b/yarn.lock
index a353c3e..56ce785 100644
--- a/yarn.lock
+++ b/yarn.lock
@@ -192,6 +192,11 @@ argparse@^1.0.7:
dependencies:
sprintf-js "~1.0.2"
+argparse@^2.0.1:
+ version "2.0.1"
+ resolved "https://registry.yarnpkg.com/argparse/-/argparse-2.0.1.tgz#246f50f3ca78a3240f6c997e8a9bd1eac49e4b38"
+ integrity sha512-8+9WqebbFzpX9OR+Wa6O29asIogeRMzcGtAINdpMHHyAg10f05aSFVBbcEqGf/PXw1EjAZ+q2/bEBg3DvurK3Q==
+
array-differ@^1.0.0:
version "1.0.0"
resolved "https://registry.yarnpkg.com/array-differ/-/array-differ-1.0.0.tgz#eff52e3758249d33be402b8bb8e564bb2b5d4031"
@@ -327,6 +332,11 @@ blob@0.0.5:
resolved "https://registry.yarnpkg.com/blob/-/blob-0.0.5.tgz#d680eeef25f8cd91ad533f5b01eed48e64caf683"
integrity sha512-gaqbzQPqOoamawKg0LGVd7SzLgXS+JH61oWprSLH+P+abTczqJbhTR8CmJ2u9/bUYNmHTGJx/UEmn6doAvvuig==
+boolbase@^1.0.0:
+ version "1.0.0"
+ resolved "https://registry.yarnpkg.com/boolbase/-/boolbase-1.0.0.tgz#68dff5fbe60c51eb37725ea9e3ed310dcc1e776e"
+ integrity sha1-aN/1++YMUes3cl6p4+0xDcwed24=
+
brace-expansion@^1.1.7:
version "1.1.11"
resolved "https://registry.yarnpkg.com/brace-expansion/-/brace-expansion-1.1.11.tgz#3c7fcbf529d87226f3d2f52b966ff5271eb441dd"
@@ -473,6 +483,30 @@ character-parser@^2.1.1:
dependencies:
is-regex "^1.0.3"
+cheerio-select@^1.4.0:
+ version "1.4.0"
+ resolved "https://registry.yarnpkg.com/cheerio-select/-/cheerio-select-1.4.0.tgz#3a16f21e37a2ef0f211d6d1aa4eff054bb22cdc9"
+ integrity sha512-sobR3Yqz27L553Qa7cK6rtJlMDbiKPdNywtR95Sj/YgfpLfy0u6CGJuaBKe5YE/vTc23SCRKxWSdlon/w6I/Ew==
+ dependencies:
+ css-select "^4.1.2"
+ css-what "^5.0.0"
+ domelementtype "^2.2.0"
+ domhandler "^4.2.0"
+ domutils "^2.6.0"
+
+cheerio@^1.0.0-rc.2:
+ version "1.0.0-rc.9"
+ resolved "https://registry.yarnpkg.com/cheerio/-/cheerio-1.0.0-rc.9.tgz#a3ae6b7ce7af80675302ff836f628e7cb786a67f"
+ integrity sha512-QF6XVdrLONO6DXRF5iaolY+odmhj2CLj+xzNod7INPWMi/x9X4SOylH0S/vaPpX+AUU6t04s34SQNh7DbkuCng==
+ dependencies:
+ cheerio-select "^1.4.0"
+ dom-serializer "^1.3.1"
+ domhandler "^4.2.0"
+ htmlparser2 "^6.1.0"
+ parse5 "^6.0.1"
+ parse5-htmlparser2-tree-adapter "^6.0.1"
+ tslib "^2.2.0"
+
chokidar@^3.3.0, chokidar@^3.4.0, chokidar@^3.4.1:
version "3.4.2"
resolved "https://registry.yarnpkg.com/chokidar/-/chokidar-3.4.2.tgz#38dc8e658dec3809741eb3ef7bb0a47fe424232d"
@@ -633,6 +667,22 @@ core-js@^2.4.0:
resolved "https://registry.yarnpkg.com/core-js/-/core-js-2.6.11.tgz#38831469f9922bded8ee21c9dc46985e0399308c"
integrity sha512-5wjnpaT/3dV+XB4borEsnAYQchn00XSgTAWKDkEqv+K8KevjbzmofK6hfJ9TZIlpj2N0xQpazy7PiRQiWHqzWg==
+css-select@^4.1.2:
+ version "4.1.2"
+ resolved "https://registry.yarnpkg.com/css-select/-/css-select-4.1.2.tgz#8b52b6714ed3a80d8221ec971c543f3b12653286"
+ integrity sha512-nu5ye2Hg/4ISq4XqdLY2bEatAcLIdt3OYGFc9Tm9n7VSlFBcfRv0gBNksHRgSdUDQGtN3XrZ94ztW+NfzkFSUw==
+ dependencies:
+ boolbase "^1.0.0"
+ css-what "^5.0.0"
+ domhandler "^4.2.0"
+ domutils "^2.6.0"
+ nth-check "^2.0.0"
+
+css-what@^5.0.0:
+ version "5.0.0"
+ resolved "https://registry.yarnpkg.com/css-what/-/css-what-5.0.0.tgz#f0bf4f8bac07582722346ab243f6a35b512cfc47"
+ integrity sha512-qxyKHQvgKwzwDWC/rGbT821eJalfupxYW2qbSJSAtdSTimsr/MlaGONoNLllaUPZWf8QnbcKM/kPVYUQuEKAFA==
+
date-time@^0.1.1:
version "0.1.1"
resolved "https://registry.yarnpkg.com/date-time/-/date-time-0.1.1.tgz#ed2f6d93d9790ce2fd66d5b5ff3edd5bbcbf3b07"
@@ -702,6 +752,36 @@ doctypes@^1.1.0:
resolved "https://registry.yarnpkg.com/doctypes/-/doctypes-1.1.0.tgz#ea80b106a87538774e8a3a4a5afe293de489e0a9"
integrity sha1-6oCxBqh1OHdOijpKWv4pPeSJ4Kk=
+dom-serializer@^1.0.1, dom-serializer@^1.3.1:
+ version "1.3.1"
+ resolved "https://registry.yarnpkg.com/dom-serializer/-/dom-serializer-1.3.1.tgz#d845a1565d7c041a95e5dab62184ab41e3a519be"
+ integrity sha512-Pv2ZluG5ife96udGgEDovOOOA5UELkltfJpnIExPrAk1LTvecolUGn6lIaoLh86d83GiB86CjzciMd9BuRB71Q==
+ dependencies:
+ domelementtype "^2.0.1"
+ domhandler "^4.0.0"
+ entities "^2.0.0"
+
+domelementtype@^2.0.1, domelementtype@^2.2.0:
+ version "2.2.0"
+ resolved "https://registry.yarnpkg.com/domelementtype/-/domelementtype-2.2.0.tgz#9a0b6c2782ed6a1c7323d42267183df9bd8b1d57"
+ integrity sha512-DtBMo82pv1dFtUmHyr48beiuq792Sxohr+8Hm9zoxklYPfa6n0Z3Byjj2IV7bmr2IyqClnqEQhfgHJJ5QF0R5A==
+
+domhandler@^4.0.0, domhandler@^4.2.0:
+ version "4.2.0"
+ resolved "https://registry.yarnpkg.com/domhandler/-/domhandler-4.2.0.tgz#f9768a5f034be60a89a27c2e4d0f74eba0d8b059"
+ integrity sha512-zk7sgt970kzPks2Bf+dwT/PLzghLnsivb9CcxkvR8Mzr66Olr0Ofd8neSbglHJHaHa2MadfoSdNlKYAaafmWfA==
+ dependencies:
+ domelementtype "^2.2.0"
+
+domutils@^2.5.2, domutils@^2.6.0:
+ version "2.6.0"
+ resolved "https://registry.yarnpkg.com/domutils/-/domutils-2.6.0.tgz#2e15c04185d43fb16ae7057cb76433c6edb938b7"
+ integrity sha512-y0BezHuy4MDYxh6OvolXYsH+1EMGmFbwv5FKW7ovwMG6zTPWqNPq3WF9ayZssFq+UlKdffGLbOEaghNdaOm1WA==
+ dependencies:
+ dom-serializer "^1.0.1"
+ domelementtype "^2.2.0"
+ domhandler "^4.2.0"
+
easy-extender@^2.3.4:
version "2.3.4"
resolved "https://registry.yarnpkg.com/easy-extender/-/easy-extender-2.3.4.tgz#298789b64f9aaba62169c77a2b3b64b4c9589b8f"
@@ -736,6 +816,13 @@ ejs@^2.7.4:
resolved "https://registry.yarnpkg.com/ejs/-/ejs-2.7.4.tgz#48661287573dcc53e366c7a1ae52c3a120eec9ba"
integrity sha512-7vmuyh5+kuUyJKePhQfRQBhXV5Ce+RnaeeQArKu1EAMpL3WbgMt5WG6uQZpEVvYSSsxMXRKOewtDk9RaTKXRlA==
+eleventy-plugin-toc@^1.1.0:
+ version "1.1.0"
+ resolved "https://registry.yarnpkg.com/eleventy-plugin-toc/-/eleventy-plugin-toc-1.1.0.tgz#7308d0332ac020c29a77c125ff27cef65fe020af"
+ integrity sha512-5wOls2nvGrmi2Gq6pxp522ig9B/bwN2mMu9pakN6GUemQXZrHNLyfIsfdNkbCeel+AZ+doV1N2slSMRQ4EziiQ==
+ dependencies:
+ cheerio "^1.0.0-rc.2"
+
emitter-mixin@0.0.3:
version "0.0.3"
resolved "https://registry.yarnpkg.com/emitter-mixin/-/emitter-mixin-0.0.3.tgz#5948cb286f2e48edc3b251a7cfc1f7883396d65c"
@@ -824,11 +911,21 @@ engine.io@~3.2.0:
engine.io-parser "~2.1.0"
ws "~3.3.1"
+entities@^2.0.0:
+ version "2.2.0"
+ resolved "https://registry.yarnpkg.com/entities/-/entities-2.2.0.tgz#098dc90ebb83d8dffa089d55256b351d34c4da55"
+ integrity sha512-p92if5Nz619I0w+akJrLZH0MX0Pb5DX39XOwQTtXSdQQOaYH03S1uIQp4mhOZtAXrxq4ViO67YTiLBo2638o9A==
+
entities@~2.0.0:
version "2.0.3"
resolved "https://registry.yarnpkg.com/entities/-/entities-2.0.3.tgz#5c487e5742ab93c15abb5da22759b8590ec03b7f"
integrity sha512-MyoZ0jgnLvB2X3Lg5HqpFmn1kybDiIfEQmKzTb5apr51Rb+T3KdmMiqa70T+bhGnyv7bQ6WMj2QMHpGMmlrUYQ==
+entities@~2.1.0:
+ version "2.1.0"
+ resolved "https://registry.yarnpkg.com/entities/-/entities-2.1.0.tgz#992d3129cf7df6870b96c57858c249a120f8b8b5"
+ integrity sha512-hCx1oky9PFrJ611mf0ifBLBRW8lUUVRlFolb5gWRfIELabBlbp9xZvrqZLZAs+NxFnbfQoeGd8wDkygjg7U85w==
+
errno@^0.1.2:
version "0.1.7"
resolved "https://registry.yarnpkg.com/errno/-/errno-0.1.7.tgz#4684d71779ad39af177e3f007996f7c67c852618"
@@ -1074,6 +1171,16 @@ has-symbols@^1.0.1:
resolved "https://registry.yarnpkg.com/has-symbols/-/has-symbols-1.0.1.tgz#9f5214758a44196c406d9bd76cebf81ec2dd31e8"
integrity sha512-PLcsoqu++dmEIZB+6totNFKq/7Do+Z0u4oT0zKOJNl3lYK6vGwwu2hjHs+68OEZbTjiUE9bgOABXbP/GvrS0Kg==
+htmlparser2@^6.1.0:
+ version "6.1.0"
+ resolved "https://registry.yarnpkg.com/htmlparser2/-/htmlparser2-6.1.0.tgz#c4d762b6c3371a05dbe65e94ae43a9f845fb8fb7"
+ integrity sha512-gyyPk6rgonLFEDGoeRgQNaEUvdJ4ktTmmUh/h2t7s+M8oPpIPxgNACWa+6ESR57kXstwqPiCut0V8NRpcwgU7A==
+ dependencies:
+ domelementtype "^2.0.1"
+ domhandler "^4.0.0"
+ domutils "^2.5.2"
+ entities "^2.0.0"
+
http-errors@1.7.3:
version "1.7.3"
resolved "https://registry.yarnpkg.com/http-errors/-/http-errors-1.7.3.tgz#6c619e4f9c60308c38519498c14fbb10aacebb06"
@@ -1366,6 +1473,13 @@ linkify-it@^2.0.0:
dependencies:
uc.micro "^1.0.1"
+linkify-it@^3.0.1:
+ version "3.0.2"
+ resolved "https://registry.yarnpkg.com/linkify-it/-/linkify-it-3.0.2.tgz#f55eeb8bc1d3ae754049e124ab3bb56d97797fb8"
+ integrity sha512-gDBO4aHNZS6coiZCKVhSNh43F9ioIL4JwRjLZPkoLIY4yZFwg264Y5lu2x6rb1Js42Gh6Yqm2f6L2AJcnkzinQ==
+ dependencies:
+ uc.micro "^1.0.1"
+
liquidjs@^6.4.3:
version "6.4.3"
resolved "https://registry.yarnpkg.com/liquidjs/-/liquidjs-6.4.3.tgz#c7caf7a3f6c87dc6a22a5a351328cf8f7298c243"
@@ -1429,6 +1543,11 @@ map-cache@^0.2.0:
resolved "https://registry.yarnpkg.com/map-cache/-/map-cache-0.2.2.tgz#c32abd0bd6525d9b051645bb4f26ac5dc98a0dbf"
integrity sha1-wyq9C9ZSXZsFFkW7TyasXcmKDb8=
+markdown-it-anchor@^7.1.0:
+ version "7.1.0"
+ resolved "https://registry.yarnpkg.com/markdown-it-anchor/-/markdown-it-anchor-7.1.0.tgz#30fb21497bf59e83ff4d1ddc052d821962e2489e"
+ integrity sha512-loQggrwsIkkP7TOrESvmYkV2ikbQNNKhHcWyqC7/C2CmfHl1tkUizJJU8C5aGgg7J6oXVQJx17gk7i47tNn/lQ==
+
markdown-it@^10.0.0:
version "10.0.0"
resolved "https://registry.yarnpkg.com/markdown-it/-/markdown-it-10.0.0.tgz#abfc64f141b1722d663402044e43927f1f50a8dc"
@@ -1440,6 +1559,17 @@ markdown-it@^10.0.0:
mdurl "^1.0.1"
uc.micro "^1.0.5"
+markdown-it@^12.0.6:
+ version "12.0.6"
+ resolved "https://registry.yarnpkg.com/markdown-it/-/markdown-it-12.0.6.tgz#adcc8e5fe020af292ccbdf161fe84f1961516138"
+ integrity sha512-qv3sVLl4lMT96LLtR7xeRJX11OUFjsaD5oVat2/SNBIb21bJXwal2+SklcRbTwGwqWpWH/HRtYavOoJE+seL8w==
+ dependencies:
+ argparse "^2.0.1"
+ entities "~2.1.0"
+ linkify-it "^3.0.1"
+ mdurl "^1.0.1"
+ uc.micro "^1.0.5"
+
maximatch@^0.1.0:
version "0.1.0"
resolved "https://registry.yarnpkg.com/maximatch/-/maximatch-0.1.0.tgz#86cd8d6b04c9f307c05a6b9419906d0360fb13a2"
@@ -1567,6 +1697,13 @@ normalize-path@^3.0.0, normalize-path@~3.0.0:
resolved "https://registry.yarnpkg.com/normalize-path/-/normalize-path-3.0.0.tgz#0dcd69ff23a1c9b11fd0978316644a0388216a65"
integrity sha512-6eZs5Ls3WtCisHWp9S2GUy8dqkpGi4BVSz3GaqiE6ezub0512ESztXUwUB6C6IKbQkY2Pnb/mD4WYojCRwcwLA==
+nth-check@^2.0.0:
+ version "2.0.0"
+ resolved "https://registry.yarnpkg.com/nth-check/-/nth-check-2.0.0.tgz#1bb4f6dac70072fc313e8c9cd1417b5074c0a125"
+ integrity sha512-i4sc/Kj8htBrAiH1viZ0TgU8Y5XqCaV/FziYK6TBczxmeKm3AEFWqqF3195yKudrarqy7Zu80Ra5dobFjn9X/Q==
+ dependencies:
+ boolbase "^1.0.0"
+
nunjucks@^3.2.1:
version "3.2.2"
resolved "https://registry.yarnpkg.com/nunjucks/-/nunjucks-3.2.2.tgz#45f915fef0f89fbab38c489dc85025f64859f466"
@@ -1659,6 +1796,18 @@ parse-ms@^0.1.0:
resolved "https://registry.yarnpkg.com/parse-ms/-/parse-ms-0.1.2.tgz#dd3fa25ed6c2efc7bdde12ad9b46c163aa29224e"
integrity sha1-3T+iXtbC78e93hKtm0bBY6opIk4=
+parse5-htmlparser2-tree-adapter@^6.0.1:
+ version "6.0.1"
+ resolved "https://registry.yarnpkg.com/parse5-htmlparser2-tree-adapter/-/parse5-htmlparser2-tree-adapter-6.0.1.tgz#2cdf9ad823321140370d4dbf5d3e92c7c8ddc6e6"
+ integrity sha512-qPuWvbLgvDGilKc5BoicRovlT4MtYT6JfJyBOMDsKoiT+GiuP5qyrPCnR9HcPECIJJmZh5jRndyNThnhhb/vlA==
+ dependencies:
+ parse5 "^6.0.1"
+
+parse5@^6.0.1:
+ version "6.0.1"
+ resolved "https://registry.yarnpkg.com/parse5/-/parse5-6.0.1.tgz#e1a1c085c569b3dc08321184f19a39cc27f7c30b"
+ integrity sha512-Ofn/CTFzRGTTxwpNEs9PP93gXShHcTq255nzRYSKe8AkVpZY7e1fpmTfOyoIvjP5HG7Z2ZM7VS9PPhQGW2pOpw==
+
parseqs@0.0.5:
version "0.0.5"
resolved "https://registry.yarnpkg.com/parseqs/-/parseqs-0.0.5.tgz#d5208a3738e46766e291ba2ea173684921a8b89d"
@@ -2353,6 +2502,11 @@ token-stream@0.0.1:
resolved "https://registry.yarnpkg.com/token-stream/-/token-stream-0.0.1.tgz#ceeefc717a76c4316f126d0b9dbaa55d7e7df01a"
integrity sha1-zu78cXp2xDFvEm0LnbqlXX598Bo=
+tslib@^2.2.0:
+ version "2.2.0"
+ resolved "https://registry.yarnpkg.com/tslib/-/tslib-2.2.0.tgz#fb2c475977e35e241311ede2693cee1ec6698f5c"
+ integrity sha512-gS9GVHRU+RGn5KQM2rllAlR3dU6m7AcpJKdtH8gFvQiC4Otgk98XnmMU+nZenHt/+VhnBPWwgrJsyrdcw6i23w==
+
ua-parser-js@^0.7.18:
version "0.7.22"
resolved "https://registry.yarnpkg.com/ua-parser-js/-/ua-parser-js-0.7.22.tgz#960df60a5f911ea8f1c818f3747b99c6e177eae3"