update urls

chartes · Sep 24, 2024 · 7153577 · 7153577
1 parent 8803de3
commit 7153577
Show file tree

Hide file tree

Showing 4 changed files with 28 additions and 16 deletions.
diff --git a/docs/cookbook/theater.md b/docs/cookbook/theater.md
@@ -17,7 +17,7 @@ Pour des besoins de recherche, on peut également chercher à extraire automatiq
 
 Nous prenons ici l’exemple de pièces de Molière et de Racine.
 
-Les fichiers partagés du corpus de tests sont issus du site [Théâtre classique](https://www.theatre-classique.fr/). Ils ont été modifiés pour garantir la validation XML/TEI et enrichis avec des identifiants et des liages pour servir la démonstration DoTS.
+Les fichiers partagés du corpus de tests sont issus du site <a target="_blank" href="https://www.theatre-classique.fr/">Théâtre classique</a>. Ils ont été modifiés pour garantir la validation XML/TEI et enrichis avec des identifiants et des liages pour servir la démonstration DoTS.
 
 
 ## Définition du modèle documentaire
@@ -158,7 +158,7 @@ L'élément <a href="https://www.tei-c.org/release/doc/tei-p5-doc/fr/html/ref-ci
 
 Cependant, dans le cas d’une édition théâtrale, sa déclaration permet de tirer parti du balisage éditorial XML/TEI. Grâce à DTS, chaque acte, scène, tour de parole, vers peut être cité et republié.
 
-Prenons l’exemple de *Phèdre* de Racine. La structure imbriquée du `citeStructure` rend compte de la hiérarchie éditoriale : acte > scène > tout de parole > vers.
+Prenons l’exemple de *Phèdre* de Racine. La structure imbriquée du `citeStructure` rend compte de la hiérarchie éditoriale : acte > scène > tour de parole > vers.
 
 ???+ example "Déclaration de la structure éditoriale de *Phèdre* de Racine"
 
@@ -326,7 +326,8 @@ Quelques exemples :
   url="https://dev.chartes.psl.eu/dots/api/dts/navigation?resource=moliere_tartuffe&down=3&filter=tei:role=Tartuffe")
 }}
 
-
+<!--
+Mettre à jour DoTS sur le serveur de dev avant de décommenter ces lignes (code actuellement non fonctionnel)
 **Le texte de tous les tours de parole de Tartuffe**
 
 {{ macro_collapse_card_api_doc(
@@ -341,3 +342,4 @@ Quelques exemples :
   verb_http="get", 
   url="https://dev.chartes.psl.eu/dots/api/dts/document?resource=moliere_tartuffe&filter=tei:role=Tartuffe&format=html")
 }}
+-->
diff --git a/docs/dots-project-folder.md b/docs/dots-project-folder.md
@@ -30,7 +30,7 @@ Des [cookbooks](./cookbook/index.md) illustrent la mise en œuvre de ces recomma
 	```
 
 
-- `nom_projet/`: racine du dossier de dépôt. Son nom est libre. Au chargement en base, vous pourrez spécifier le nom de la base de données BaseX, ainsi que l’identifiant DTS attribué à la collection racine. Vous pourrez aussi lui attribuer un titre.
+- `nom_projet/`: racine du dossier de dépôt. Son nom est libre. Au chargement en base, vous pourrez spécifier le nom de la base de données BaseX, ainsi que l’identifiant DTS attribué à la collection racine.
 
 - `data/`: les documents XML/TEI. Ce dossier est **obligatoire**. Il contient les sources XML/TEI de votre projet organisées selon la hiérarchie de votre choix. Cette hiérarchie représente les collections **par défaut** de votre projet. Par exemple, ici, les documents `file_1.xml` et `file_2.xml` appartiennent à la collection `collection_1`.
 
@@ -174,7 +174,9 @@ Titre (`dc:title`) :
 
 ???+ note
 
-	Il est recommandé de déclarer dans un fichier TSV le titre des collections (ainsi que toutes les métadonnées utiles à leur description).
+	Il est recommandé de déclarer dans un fichier TSV le titre des collections (ainsi que toutes les métadonnées utiles à leur description). 
+
+    Il est utile de donner aussi le titre du projet (collection de premier niveau).
 
 #### Pour un document
 
@@ -236,7 +238,7 @@ Pour déclarer une métadonnée, c'est le nom de l’élément XML avec le préf
 Ces métadonnées peuvent être inscrites :
 
 - dans le fichier `dots_metadata_mapping.xml` pour les valeurs communes à l’ensemble des collections ou à l’ensemble des documents.
-- dans un fichier TSV (pour les collections et les documents)
+- dans un fichier TSV (pour les collections, les documents et les passages)
 - dans le fichier XML/TEI (pour les seuls documents)
 
 #### Métadonnées inscrites dans `dots_metadata_mapping.xml`
@@ -248,7 +250,7 @@ Certaines métadonnées, telle qu’une licence, peuvent être partagées par l
 
 	```xml
 	<ns:property
-		scope="collection|document"
+		scope="collection|document|fragment"
 		resourceId="all"
 		value=".">property value</ns:property>
 	```
@@ -262,10 +264,10 @@ Certaines métadonnées, telle qu’une licence, peuvent être partagées par l
 		resourceId="all">https://creativecommons.org/licenses/by-nc-sa/4.0/</dct:license>
 	```
 
-|attribut|définition|valeur|commentaire|
-|--------|----------|------|-----------|
-|`@scope`|type des ressources décrites|`collection` ou `document` ou `fragment`||
-|`resourceId`|ids des ressources décrites|`all`|la métadonnée décrit toutes les ressources d’un type|
+|attribut|définition|valeur| commentaire                                                |
+|--------|----------|------|------------------------------------------------------------|
+|`@scope`|type des ressources décrites|`collection` ou `document` ou `fragment`|                                                            |
+|`resourceId`|ids des ressources décrites|`all`| la métadonnée décrit toutes les ressources d’un type donné |
 
 <!--
 **Modèle**
@@ -374,7 +376,7 @@ Mais il est toujours possible de préciser le type de valeur attendue pour la m
 
 L'utilisateur peut vouloir plusieurs valeurs pour une même métadonnée. Par exemple, utiliser plusieurs fois la métadonnée `dc:creator` afin de renvoyer à plusieurs référentiels.
 
-Dans ce cas de figure, il est **obligatoire** d'ajouter un attribut supplémentaire `@key` qui permet de créer une **liste** de valeurs dans la réponse d'API en JSON. Chaque élément de cette liste est précédée d'une *clef* dont la valeur est définie dans cet attribut `@key`.
+Dans ce cas de figure, il est **obligatoire** d'ajouter un attribut supplémentaire `@key` qui permet de créer une **liste** de valeurs dans la réponse d'API en JSON. Chaque élément de cette liste est précédée d'une *clef* dont la valeur est spécifiée dans cet attribut `@key`.
 
 
 ##### Concaténation de chaînes de caractères

diff --git a/docs/openapi.json b/docs/openapi.json
@@ -109,7 +109,7 @@
         "operationId": "read_navigation_get",
         "parameters": [
           {
-            "name": "id",
+            "name": "resource",
             "in": "query",
             "required": true,
             "schema": {
@@ -178,7 +178,7 @@
         "operationId": "read_document_get",
         "parameters": [
           {
-            "name": "id",
+            "name": "resource",
             "in": "query",
             "required": true,
             "schema": {
@@ -210,7 +210,15 @@
             }
           },
           {
-            "name": "format",
+            "name": "tree",
+            "in": "query",
+            "required": false,
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "name": "mediaType",
             "in": "query",
             "required": false,
             "schema": {

diff --git a/docs/publishing-workflow.md b/docs/publishing-workflow.md
@@ -79,7 +79,7 @@ Pour bien illustrer toutes les potentialités offertes par DTS et DoTS, un [cook
 
 ## Gestion d’un projet
 
-Pour lancer les commandes, il est nécessaire se déplacer dans le dossier `dots/scripts`.
+Pour lancer les commandes, il est nécessaire de se déplacer dans le dossier `dots/scripts`.
 
 ```bash
 cd path/to/basex/webapp/dots/scripts