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
The following commit(s) were added to refs/heads/asf-site by this push:
new f32394a Update annotator submodule to include @module docs.
f32394a is described below
commit f32394ac81c7564086ac66f76886144cdf2687c0
Author: Gerben <[email protected]>
AuthorDate: Sun May 16 23:54:31 2021 +0200
Update annotator submodule to include @module docs.
---
annotator | 2 +-
content/demo/main.js | 2 +-
content/docs/api/modules/dom.html | 11 +++++++++++
content/docs/api/modules/selector.html | 11 +++++++++++
4 files changed, 24 insertions(+), 2 deletions(-)
diff --git a/annotator b/annotator
index 846870a..b0413a6 160000
--- a/annotator
+++ b/annotator
@@ -1 +1 @@
-Subproject commit 846870adf4c1b344b4da66548b57ee57f5d3b51a
+Subproject commit b0413a6dbf6729ea636ca0cc829121303eb3828e
diff --git a/content/demo/main.js b/content/demo/main.js
index 4f6e0c8..05196dd 100644
--- a/content/demo/main.js
+++ b/content/demo/main.js
@@ -3766,7 +3766,7 @@ eval("__webpack_require__.r(__webpack_exports__);\n/*
harmony default export */
/***/ (function(module, __webpack_exports__, __webpack_require__) {
"use strict";
-eval("__webpack_require__.r(__webpack_exports__);\n/* harmony import */ var
_babel_runtime_corejs3_helpers_esm_asyncToGenerator__WEBPACK_IMPORTED_MODULE_0__
= __webpack_require__(/*! @babel/runtime-corejs3/helpers/esm/asyncToGenerator
*/
\"../node_modules/@babel/runtime-corejs3/helpers/esm/asyncToGenerator.js\");\n/*
harmony import */ var
_babel_runtime_corejs3_helpers_esm_asyncIterator__WEBPACK_IMPORTED_MODULE_1__ =
__webpack_require__(/*! @babel/runtime-corejs3/helpers/esm/asyncIterato [...]
+eval("__webpack_require__.r(__webpack_exports__);\n/* harmony import */ var
_babel_runtime_corejs3_helpers_esm_asyncToGenerator__WEBPACK_IMPORTED_MODULE_0__
= __webpack_require__(/*! @babel/runtime-corejs3/helpers/esm/asyncToGenerator
*/
\"../node_modules/@babel/runtime-corejs3/helpers/esm/asyncToGenerator.js\");\n/*
harmony import */ var
_babel_runtime_corejs3_helpers_esm_asyncIterator__WEBPACK_IMPORTED_MODULE_1__ =
__webpack_require__(/*! @babel/runtime-corejs3/helpers/esm/asyncIterato [...]
/***/ }),
diff --git a/content/docs/api/modules/dom.html
b/content/docs/api/modules/dom.html
index f26abbf..1803efc 100644
--- a/content/docs/api/modules/dom.html
+++ b/content/docs/api/modules/dom.html
@@ -112,6 +112,17 @@
</header>
<div class="row">
<div class="col-8 col-content">
+ <section class="tsd-panel tsd-comment">
+ <div class="tsd-comment tsd-typography">
+ <div class="lead">
+ <p>This module provides
functions for handling annotations in the context of an
+ HTML DOM; in other
words, a web page.</p>
+ </div>
+ <p>The main functionality is
finding which selection of the web page a <a
href="https://www.w3.org/TR/2017/REC-annotation-model-20170223/#selectors";
class="external">Selector</a> refers to; and, vice versa, describing a
selection of the page as
+ a Selector.</p>
+ <p>The primary way to express
selections in the web page is by <a
href="https://developer.mozilla.org/en-US/docs/Web/API/Range";
class="external">Range</a> objects.</p>
+ </div>
+ </section>
<section class="tsd-panel-group
tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel
tsd-index-panel">
diff --git a/content/docs/api/modules/selector.html
b/content/docs/api/modules/selector.html
index 24cee23..666afe5 100644
--- a/content/docs/api/modules/selector.html
+++ b/content/docs/api/modules/selector.html
@@ -112,6 +112,17 @@
</header>
<div class="row">
<div class="col-8 col-content">
+ <section class="tsd-panel tsd-comment">
+ <div class="tsd-comment tsd-typography">
+ <div class="lead">
+ <p>This module provides
types and generic functions for handling <a
href="https://www.w3.org/TR/2017/REC-annotation-model-20170223/#selectors";
class="external">Selector</a>s.</p>
+ </div>
+ <p>Annotation tool developers
should not need most of the functions contained
+ in this module, but
would instead mainly use the module made for the specific
+ context (document type)
they are dealing with. See <a href="dom.html">dom</a>, currently the
+ only such module.</p>
+ </div>
+ </section>
<section class="tsd-panel-group
tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel
tsd-index-panel">
