Skip to content

Commit

Permalink
update cookbook
Browse files Browse the repository at this point in the history
  • Loading branch information
philippepons committed Feb 15, 2024
1 parent a8418fc commit cf21806
Showing 1 changed file with 17 additions and 7 deletions.
24 changes: 17 additions & 7 deletions docs/cookbook.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,12 @@ Le corpus de test est disponible : <a href="https://github.com/chartes/dots_docu

- Les documents (les fichiers XML/TEI) DOIVENT être regroupés dans un dossier `/data`.
- La structure de ce dossier `/data` permet de représenter les collections par défaut du corpus : ici, le document `ENCPOS_1849_04.xml` appartient **par défaut** à la collection `ENCPOS_1849`.

{{ macro_collapse_card_api_doc(
verb_http="get",
url="https://dev.chartes.psl.eu/dots/api/dts/collection?id=ENCPOS_1849")
}}

- Nous verrons qu’un document peut appartenir à plusieurs collections.


Expand Down Expand Up @@ -150,7 +156,7 @@ Exemples :

{{ macro_collapse_card_api_doc(
verb_http="get",
url="http://localhost:8080/api/dts/collection?id=ENCPOS_1972")
url="https://dev.chartes.psl.eu/dots/api/dts/collection?id=ENCPOS_1972")
}}

???+ note
Expand All @@ -174,7 +180,7 @@ Il permet de déclarer la structure du document TEI et de retrouver des fragment

{{ macro_collapse_card_api_doc(
verb_http="get",
url="http://localhost:8080/api/dts/navigation?id=ENCPOS_1972_18")
url="https://dev.chartes.psl.eu/dots/api/dts/navigation?id=ENCPOS_1972_18")
}}


Expand All @@ -193,12 +199,12 @@ bash basex -b srcPath=/path/to/tsv ../webapp/dots/scripts/create_custom_collecti
```
{{ macro_collapse_card_api_doc(
verb_http="get",
url="http://localhost:8080/api/dts/collection?id=normandy")
url="https://dev.chartes.psl.eu/dots/api/dts/collection?id=normandy")
}}

{{ macro_collapse_card_api_doc(
verb_http="get",
url="http://localhost:8080/api/dts/collection?id=ENCPOS_1849_04&nav=parents")
url="https://dev.chartes.psl.eu/dots/api/dts/collection?id=ENCPOS_1849_04&nav=parents")
}}

### Cas 2. Un article est un fragment
Expand Down Expand Up @@ -284,13 +290,13 @@ Le corpus de test est disponible : <a href="https://github.com/chartes/dots_docu
- Ici, le document `ENCPOS_1849_c2.xml`, par exemple, regroupe toutes les positions de 1849.
{{ macro_collapse_card_api_doc(
verb_http="get",
url="http://localhost:8080/api/dts/collection?id=ENCPOS_1972_c2")
url="https://dev.chartes.psl.eu/dots/api/dts/collection?id=ENCPOS_1972_c2")
}}

- Chaque position est dans ce cas un fragment du document.
{{ macro_collapse_card_api_doc(
verb_http="get",
url="http://localhost:8080/api/dts/navigation?id=ENCPOS_1972_c2&ref=ENCPOS_1972_18")
url="https://dev.chartes.psl.eu/dots/api/dts/navigation?id=ENCPOS_1972_c2&ref=ENCPOS_1972_18")
}}

#### Dossier `metadata/`
Expand All @@ -301,7 +307,7 @@ Il contient les métadonnées descriptives : `default_resources_titles.tsv` per

{{ macro_collapse_card_api_doc(
verb_http="get",
url="http://localhost:8080/api/dts/collection?id=ENCPOS_c2")
url="https://dev.chartes.psl.eu/dots/api/dts/collection?id=ENCPOS_c2")
}}

#### Déclaration des fragments
Expand All @@ -319,3 +325,7 @@ L'élément `<citeStructure>` ( <a href="https://www.tei-c.org/release/doc/tei-p
</citeStructure>
```

{{ 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")
}}

0 comments on commit cf21806

Please sign in to comment.