Add some documentation to SkoHub provider (#29)

gbv · Jun 23, 2022 · 64eebc4 · 64eebc4
1 parent cafc09e
commit 64eebc4
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -165,6 +165,8 @@ The following providers are also exported, but have to be added via `cdk.addProv
 - `SkosmosApi` - access to concept schemes and concepts via a [Skosmos](https://github.com/NatLibFi/Skosmos) API
 - `LocApi` - access to concept schemes and concepts via the [Library of Congress Linked Data Service](https://id.loc.gov/)
   - **This integration is currently experimental and only supports LCSH and LCNAF.**
+- `Skohub` - access to concept schemes and concepts via a [SkoHub Vocabs](https://blog.lobid.org/2019/09/27/presenting-skohub-vocabs.html)
+  - **This integration is currently experimental. Only vocabularies that use a [slash namespace pattern]([hash](https://www.w3.org/2001/sw/BestPractices/VM/http-examples/2006-01-18/#slash)) with dereferenceable URIs are supported.**
 - `ReconciliationApi` - access to mapping suggestions via a [OpenRefine Reconciliation API](https://github.com/OpenRefine/OpenRefine/wiki/Reconciliation-Service-API)
 - `OccurrencesApi` - access to concept occurrences via [occurrences-api](https://github.com/gbv/occurrences-api) (will be changed to [occurrences-server](https://github.com/gbv/occurrences-server) in the future)
 - `LabelSearchSuggestion` - access to mapping suggestions using other registries' search endpoints (using [jskos-server])

diff --git a/src/providers/skohub-provider.js b/src/providers/skohub-provider.js
@@ -15,6 +15,16 @@ function decodeUnicode(text) {
 }
 
 /**
+ * SkoHub Vocabs
+ *
+ * [SkoHub Vocabs](https://blog.lobid.org/2019/09/27/presenting-skohub-vocabs.html) is a static site generator that provides HTML/JSON versions of vocabularies as static files.
+ *
+ * Example vocabulary (configured below): https://w3id.org/class/esc/scheme
+ *
+ * It is important that a dereferenceable scheme URI is used. When configured via [BARTOC](https://bartoc.org/) in the `API` field, "http://bartoc.org/api-type/skohub" needs to be given as the type and the aforementioned dereferenceable scheme URI needs to be given as the URL.
+ *
+ * See also: https://github.com/gbv/cocoda-sdk/issues/29
+ *
  * ```json
  * {
  *  "uri": "http://coli-conc.gbv.de/registry/skohub.io",