From e095204bd5399e73dabd6c5f612bfc2248924d84 Mon Sep 17 00:00:00 2001 From: philippepons Date: Thu, 15 Feb 2024 11:16:42 +0100 Subject: [PATCH] update documentation: 'collection' instead of 'collections' --- docs/cookbook.md | 49 +------------------------------------ docs/dots-project-folder.md | 2 +- docs/index.md | 2 +- docs/openapi.json | 4 +-- 4 files changed, 5 insertions(+), 52 deletions(-) diff --git a/docs/cookbook.md b/docs/cookbook.md index d8efc0c..39beec8 100644 --- a/docs/cookbook.md +++ b/docs/cookbook.md @@ -65,20 +65,6 @@ Il convient de déclarer chacune de ces unités documentaires. |position |document |TEI file |`data/ENCPOS_AAAA/ENCPOS_AAAA_NN.xml`| |section |fragment |TEI node |`/TEI/text/boby/div`| - #### Corpus de test Le corpus de test est disponible : https://github.com/chartes/dots_documentation/tree/dev/data_test/periodiques/encpos_by_abstract. @@ -126,7 +112,7 @@ Il contient les métadonnées descriptives des ressources : `default_collections Le fichier `dots_metadata_mapping.xml` est important. Il permet de : -- lister et qualifier les métadonnées partagées via le endpoint DTS Collections ; +- lister et qualifier les métadonnées partagées via le endpoint DTS Collection ; - déclarer leur localisation. Ces métadonnées peuvent être inscrites "en dure" dans le document `dots_metadata_mapping.xml`. Autrement dit, la valeur est inscrite directement dans le document XML. @@ -233,39 +219,6 @@ Il convient de déclarer chacune de ces unités documentaires. |position |fragment |TEI node |`/TEI/text/boby/div[@type='position]'`| |section |fragment |TEI node |`/TEI/text/boby/div[@type='position]/div`| - - #### Corpus de test Le corpus de test est disponible : https://github.com/chartes/dots_documentation/tree/dev/data_test/periodiques/encpos_by_volume. diff --git a/docs/dots-project-folder.md b/docs/dots-project-folder.md index 6ed6b1d..ba803b9 100644 --- a/docs/dots-project-folder.md +++ b/docs/dots-project-folder.md @@ -59,7 +59,7 @@ Vous pouvez structurer vos documents en collections et sous-collections hiérarc tartuffe.xml ``` -??? example "Le projet contient des collections" +??? example "Le projet contient des sous-collections" ``` theater_project/ diff --git a/docs/index.md b/docs/index.md index ee1bd54..d234cd4 100644 --- a/docs/index.md +++ b/docs/index.md @@ -18,7 +18,7 @@ Publishers of digital text collections can use the DTS API to help them make the Using DoTS, you can -- with the DTS Collections endpoint: +- with the DTS Collection endpoint: - Retrieve lists of collection members. - Retrieve metadata about individual collection items. - with the DTS Navigation endpoint: diff --git a/docs/openapi.json b/docs/openapi.json index 0eb2313..c70f74b 100644 --- a/docs/openapi.json +++ b/docs/openapi.json @@ -2,7 +2,7 @@ "openapi": "3.0.3", "info": { "title": "DoTS - OpenAPI 3.0", - "description": "**Documentation and specification of the [DTS API](https://distributed-text-services.github.io/specifications/) implementation by [DoTS](https://github.com/chartes/dots).** \n\n DoTS is a suite of XQuery tools in [BaseX](https://basex.org/) designed to provide a resolver for the DTS API. \n \n This API offers an access to the endpoints :\n * Base API Endpoint \n * collections (navigating collections) \n * navigation (list of passages accessible for navigation from a given reference within a resource) \n * document (acces to the content of document) ", + "description": "**Documentation and specification of the [DTS API](https://distributed-text-services.github.io/specifications/) implementation by [DoTS](https://github.com/chartes/dots).** \n\n DoTS is a suite of XQuery tools in [BaseX](https://basex.org/) designed to provide a resolver for the DTS API. \n \n This API offers an access to the endpoints :\n * Base API Endpoint \n * collection (navigating collections) \n * navigation (list of passages accessible for navigation from a given reference within a resource) \n * document (acces to the content of document) ", "license": { "name": "MIT", "url": "https://opensource.org/licenses/MIT" @@ -51,7 +51,7 @@ } } }, - "/dts/collections": { + "/dts/collection": { "get": { "tags": [ "default"