From b1dd5e42c3b69751e8d9cc8cff69276df520df1b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Erik=20K=C3=B6rner?= Date: Mon, 11 Mar 2024 16:41:19 +0100 Subject: [PATCH] Just store changes --- README.md | 16 +++++++++++----- fcs-endpoint-dev-tutorial/index.adoc | 2 +- .../java/configuration.adoc | 2 +- 3 files changed, 13 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 90614a7..533d960 100644 --- a/README.md +++ b/README.md @@ -4,12 +4,12 @@ This repo contains AsciiDoc sources, images, examples and schema files for the C ## Specification Documents -* [CLARIN Federated Content Search - FCS **Core 2.0**: `fcs-core-2.0/index.adoc`](fcs-core-2.0/index.adoc) -* [CLARIN Federated Content Search - FCS **Core 1.0**: `fcs-core-1.0/index.adoc`](fcs-core-1.0/index.adoc) -* [CLARIN Federated Content Search - FCS **Data Views 1.0**: `fcs-dataviews-1.0/index.adoc`](fcs-dataviews-1.0/index.adoc) -* _WIP_ [CLARIN Federated Content Search - FCS **AAI 1.0**: `fcs-aai/index.adoc`](fcs-aai/index.adoc) +- [CLARIN Federated Content Search - FCS **Core 2.0**: `fcs-core-2.0/index.adoc`](fcs-core-2.0/index.adoc) +- [CLARIN Federated Content Search - FCS **Core 1.0**: `fcs-core-1.0/index.adoc`](fcs-core-1.0/index.adoc) +- [CLARIN Federated Content Search - FCS **Data Views 1.0**: `fcs-dataviews-1.0/index.adoc`](fcs-dataviews-1.0/index.adoc) +- _WIP_ [CLARIN Federated Content Search - FCS **AAI 1.0**: `fcs-aai/index.adoc`](fcs-aai/index.adoc) -### Folder structure +### Folder Structure All the specification documents are structured as follows in their sub folders: - `index.adoc` -- AsciiDoc entrypoint document that bundles and includes single chapters into one @@ -55,6 +55,12 @@ docker run --rm -it -v $(pwd):/documents asciidoctor/docker-asciidoctor # then run your build commands ``` +## Tutorial Documents + +* [CLARIN Federated Content Search - FCS **Endpoint Developer's Tutorial**: `fcs-endpoint-dev-tutorial/index.adoc`](fcs-endpoint-dev-tutorial/index.adoc) + +For build instructions, see section [Specification Documents "How to build"](#how-to-build). + ## Historical Resources To be found under [`historical/`](historical/): diff --git a/fcs-endpoint-dev-tutorial/index.adoc b/fcs-endpoint-dev-tutorial/index.adoc index 2ccc642..8f08b8a 100644 --- a/fcs-endpoint-dev-tutorial/index.adoc +++ b/fcs-endpoint-dev-tutorial/index.adoc @@ -1,5 +1,5 @@ = FCS 2.0 Endpoint Developer's Tutorial -Oliver Schonefeld ; Erik Körner +Oliver Schonefeld ; Leif-Jöran Olsson ; Erik Körner v1.0, 2016-01 // more metadata :description: This is a tutorial on how to develop CLARIN FCS endpoints. diff --git a/fcs-endpoint-dev-tutorial/java/configuration.adoc b/fcs-endpoint-dev-tutorial/java/configuration.adoc index 199be44..92dc89e 100644 --- a/fcs-endpoint-dev-tutorial/java/configuration.adoc +++ b/fcs-endpoint-dev-tutorial/java/configuration.adoc @@ -65,7 +65,7 @@ Makes sure capabilities and declared dataviews actually match otherwise it will * Supported Layers, checks that `` elements have: ** a proper `@id` attribute and that the value is unique. -** a proper `@result-id` attribute and that is is encoded as a proper URI, ant that the child text node is "text", "lemma", "pos", "orth", "norm", "phonetic", or other value starting with "x-". +** a proper `@result-id` attribute and that is is encoded as a proper URI, and that the child text node is "text", "lemma", "pos", "orth", "norm", "phonetic", or other value starting with "x-". ** if a `@alt-value-info-uri` attribute that is encoded as proper URI, e.g. tag description ** if _advanced search_ is given in capabilities that it is also available.