Skip to content

Commit

Permalink
update dots project folder and cookbook
Browse files Browse the repository at this point in the history
  • Loading branch information
philippepons committed Mar 25, 2024
1 parent 072b2a7 commit d30f83a
Show file tree
Hide file tree
Showing 4 changed files with 53 additions and 16 deletions.
42 changes: 38 additions & 4 deletions docs/cookbook/periodical.md
Original file line number Diff line number Diff line change
Expand Up @@ -169,6 +169,16 @@ Il permet de déclarer la structure du document TEI et de retrouver des fragment
url="https://dev.chartes.psl.eu/dots/api/dts/navigation?id=ENCPOS_1972_18")
}}

#### Créer la base de données

Pour créer la base de données, il suffit de saisir la commande :

```bash
bash project_create.sh
--project_dir_path 'path/to/dots_documentation/data_test/periodiques/encpos_by_abstract'
--top_collection_id 'ENCPOS'
--db_name 'encpos'
```

#### Ajout d’une collection thématique

Expand All @@ -178,11 +188,19 @@ Il est nécessaire pour cela de préparer un tableur TSV sur le modèle de `cust

Argument à spécifier :

- `srcPath` : chemin vers le tableur TSV
- `collections_tsv_path` : chemin absolu vers le fichier TSV de métadonnées de collections

```{.Bash .copy}
bash basex -b srcPath=/path/to/tsv ../webapp/dots/scripts/create_custom_collections.xq
usage: custom_collections.sh
--collections_tsv_path string
```

Exemple

```{Bash}
bash custom_collections.sh --collections_tsv_path 'path/to/tsv/file'
```

{{ macro_collapse_card_api_doc(
verb_http="get",
url="https://dev.chartes.psl.eu/dots/api/dts/collection?id=normandy")
Expand Down Expand Up @@ -280,5 +298,21 @@ L'élément `<citeStructure>` ( <a href="https://www.tei-c.org/release/doc/tei-p

{{ macro_collapse_card_api_doc(
verb_http="get",
url="https://dev.chartes.psl.eu/dots/api/dts/navigation?id=ENCPOS_1972_c2&ref=3.1")
}}
url="https://dev.chartes.psl.eu/dots/api/dts/navigation?id=ENCPOS_1972_c2&ref=2320")
}}

{{ macro_collapse_card_api_doc(
verb_http="get",
url="https://dev.chartes.psl.eu/dots/api/dts/document?id=ENCPOS_1972_c2&ref=2320")
}}

#### Créer la base de données

Pour créer la base de données, il suffit de saisir la commande :

```bash
bash project_create.sh
--project_dir_path 'path/to/dots_documentation/data_test/periodiques/encpos_by_volume'
--top_collection_id 'ENCPOS_c2'
--db_name 'encpos_c2'
```
4 changes: 2 additions & 2 deletions docs/cookbook/theater.md
Original file line number Diff line number Diff line change
Expand Up @@ -192,7 +192,7 @@ Une structure documentaire déclarée peut avoir plusieurs métadonnées. Ici, u

#### XQuery

Les *Guidelines TEI* précisent que la valeur attendue de l’attribut [`@use`](https://www.tei-c.org/release/doc/tei-p5-doc/en/html/ref-att.citeStructurePart.html) de l’élément [`citeData`](https://www.tei-c.org/release/doc/tei-p5-doc/en/html/ref-citeData.html) est une expression XPath pointant vers la valeur de la métadonnée définie.
Les *Guidelines TEI* précisent que la valeur attendue de l’attribut <a target="_blank" href="https://www.tei-c.org/release/doc/tei-p5-doc/en/html/ref-att.citeStructurePart.html">`@use`</a> de l’élément <a target="_blank" href="https://www.tei-c.org/release/doc/tei-p5-doc/en/html/ref-citeData.html">`citeData`</a> est une expression XPath pointant vers la valeur de la métadonnée définie.

Prenons l’exemple des tours de parole (`sp`) de *Phèdre* :

Expand Down Expand Up @@ -288,7 +288,7 @@ Puis de lancer la commande suivante.

Argument à spécifier :

- `srcPath` : chemin vers le tableur TSV
- `collections_tsv_path` : chemin absolu vers le fichier TSV de métadonnées de collections

```{.Bash .copy}
bash custom_collections.sh --collections_tsv_path path/to/tsv/file
Expand Down
19 changes: 10 additions & 9 deletions docs/dots-project-folder.md
Original file line number Diff line number Diff line change
Expand Up @@ -169,7 +169,7 @@ Identifiant :

Titre (`dc:title`) :

1. valeur référencée dans `metadata/dots_metadata_mapping.xml` (voir [surcharge]())
1. valeur référencée dans `metadata/dots_metadata_mapping.xml` (voir [surcharge](#surcharge-et-metadonnees-optionnelles))
1. nom du dossier de collection dans `data/`

???+ note
Expand All @@ -185,7 +185,7 @@ Identifiant :

Titre (`dc:title`) :

1. valeur référencée dans `metadata/dots_metadata_mapping.xml` (voir surcharge)
1. valeur référencée dans `metadata/dots_metadata_mapping.xml` (voir [surcharge](#surcharge-et-metadonnees-optionnelles))
1. valeur de `/TEI/teiHeader/fileDesc/titleStmt/title[@type='main']`
1. valeur de `/TEI/teiHeader/fileDesc/titleStmt/title[1]`

Expand All @@ -203,7 +203,10 @@ DTS impose la déclaration d’un identifiant. DoTS attribue automatiquement aux

Pour les collections et les documents, le fichier `metadata/dots_metadata_mapping.xml` permet :

- de surcharger le titre (`dc:title`) attribué par défaut par DoTS ;
- de surcharger le titre (`dc:title`) attribué par défaut par DoTS

Pour les collections, les documents et les passages, le fichier `metadata/dots_metadata_mapping.xml` permet :

- d’appeler optionnellement toutes les métadonnées souhaitées. Et ces métadonnées peuvent être inscrites directement dans le fichier `metadata/dots_metadata_mapping.xml` et/ou dans le `teiHeader` des documents et/ou déportées dans un tableur.


Expand Down Expand Up @@ -261,7 +264,7 @@ Certaines métadonnées, telle qu’une licence, peuvent être partagées par l

|attribut|définition|valeur|commentaire|
|--------|----------|------|-----------|
|`@scope`|type des ressources décrites|`collection` ou `document`||
|`@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|

<!--
Expand All @@ -280,13 +283,13 @@ Certaines métadonnées, telle qu’une licence, peuvent être partagées par l

#### Métadonnées déportées dans un tableur TSV

Les métadonnées des documents et des collections peuvent être déportées dans un tableur. `dots_metadata_mapping.xml` permet de les appeler.
Les métadonnées des documents, des collections et des fragments peuvent être déportées dans un tableur. `dots_metadata_mapping.xml` permet de les appeler.

!!! abstract "Template"

```xml
<ns:property
scope="collection|document"
scope="collection|document|fragment"
format="tsv"
source="./metadata_file.tsv"
resourceId="resourceId_column-header"
Expand Down Expand Up @@ -315,14 +318,12 @@ Les métadonnées des documents et des collections peuvent être déportées dan

|attribut|définition|valeur|commentaire|
|--------|----------|------|-----------|
|`@scope`|type des ressources décrites|`collection` ou `document`||
|`@scope`|type des ressources décrites|`collection` ou `document` ou `fragment`||
|`@format`|format du fichier de métadonnées appelé|`tsv`||
|`@source`|chemin vers le fichier de métadonnées|`path/to/file`||
|`@resourceId`|nom de la colonne référençant l’id de la ressource décrite|||
|`@value`|nom de la colonne contenant la valeur de la métadonnée|||



#### Métadonnées inscrites dans la source XML/TEI

Les métadonnées d’un document peuvent être inscrites dans son `teiHeader`. `dots_metadata_mapping.xml` permet de les appeler en spécifiant un chemin XPath.
Expand Down
4 changes: 3 additions & 1 deletion docs/publishing-workflow.md
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,9 @@ bash project_create.sh --project_dir_path '/path/to/import/folder' --top_collect

NB. La base de données *projet* est créée en conservant la structure du dossier de dépôt en collections et sous-collections.

NB. Les ressources de votre projet sont désormais décrites et accessibles via les endpoints DTS fournis par DoTS. Les *endpoints* ouverts sont documentés dans la section [DTS API](api.md).
!!! success

Les ressources de votre projet sont désormais décrites et accessibles via les endpoints DTS fournis par DoTS. Les *endpoints* ouverts sont documentés dans la section [DTS API](api.md).


### Création de nouvelles collections
Expand Down

0 comments on commit d30f83a

Please sign in to comment.