diff --git a/docs/cookbook/periodical.md b/docs/cookbook/periodical.md index 15b10f1..11db56a 100644 --- a/docs/cookbook/periodical.md +++ b/docs/cookbook/periodical.md @@ -98,7 +98,7 @@ Le corpus de test est disponible : ` ( \ No newline at end of file + +!!! warning + + Pour bénéficier d'une version HTML d'un document ou d'un fragment, il est indispensable de fournir une feuille XSLT dans le dossier `path/to/basex/webapp/static/transform/hteiml`. Le chemin peut être modifié en changeant la variable `$G:xsl` du fichier `globals.xqm`. Le nom de la feuille XSLT doit être `tei2html.xsl`. diff --git a/docs/index.md b/docs/index.md index cbabe27..d8805f5 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,79 +1,41 @@ -# DoTS +# Présentation dots-logo -## What is DoTS? +DoTS est une implémentation en XQuery de la spécification d'API DTS (Distributed Text Services), adossée au logiciel de base de données XML BaseX. -DoTS is an XQuery implementation of DTS using a BaseX backend. +Cet outil permet de publier aisément des sources en XML/TEI selon les principes FAIR (Findable, Accessible, Interoperable, Reusable). -!!! Note +La présente documentation indique : - **DoTS supports only DTS GET requests** for browsing collections, document retrieval and navigation. +- [comment installer DoTS](installation.md), +- et comment [organiser ses sources](dots-project-folder.md) TEI pour [publier un corpus](publishing-workflow.md). -## What is DTS? +## Code source -The Distributed Text Services (DTS) Specification defines an API for working with collections of text as machine-actionable data. +Le code source de **DoTS** est disponible sous license MIT sur github à l'adresse suivante : https://github.com/chartes/dots. -Publishers of digital text collections can use the DTS API to help them make their textual data Findable, Accessible, Interoperable and Reusable (FAIR). +La version actuelle respecte la dernière version 1-alpha de la spécification DTS. -## Capabilities +## Testez DoTS ! -Using DoTS, you can +Si vous souhaitez tester notre résolveur DTS, les différents endpoints sont présentés [ici](api.md). +Le serveur de démo est aussi directement accessible à l'adresse suivante : https://dots.chartes.psl.eu/demo/api/dts/. -- with the DTS Collection endpoint: - - Retrieve lists of collection members. - - Retrieve metadata about individual collection items. -- with the DTS Navigation endpoint: - - Retrieve lists of citeable passages within a text. - - Retrieve a range of citeable passages within a text. - - Retrieve metadata about the citation structure of a document. -- with the DTS Document endpoint: - - Retrieve a single text passage at any level of the citation hierarchy. - - Retrieve a range of text passages with a clearly defined start and end passage. - - Retrieve an entire text. +Les corpus qui s'y trouvent sont ceux présentés dans le [cookbook](cookbook/index.md) de cette documentation. -## Install +D'autres exemples vont venir en complément. -### BaseX +## Corpus disponibles -Download BaseX (>= 10.0): https://basex.org/download/ +### Corpus de l'école nationale des chartes -!!! info +Tous les corpus mis à disposition par l'école sont disponibles sur notre serveur DoTS. - - Prefer `ZIP Package`, which ensure that you will find the complete BaseX folder. - - Requirements : https://docs.basex.org/wiki/Startup#Startup +Actuellement,seul le corpus des Positions de thèses de l'École nationale des chartes est accessible, accompagné d'une application d'édition. +### Autres corpus -### DoTS +DoTS étant un outil libre, d'autres institutions (particulièrement nos partenaires de Biblissima+) peuvent mettre leur corpus à disposition. -DoTS must be installed and started directly in the BaseX folder. - -```Bash -cd path/to/basex/webapp -``` - -```{.Bash .copy} -git clone https://github.com/chartes/dots.git -``` - -The structure of your BaseX should be as follows: - - - basex/ # BaseX root dir. - bin/ # Start scripts (GUI, HTTP server, etc.). - data/ # Database directory. - webapp/ # Web Application directory. - dots/ # DoTS module (DTS reslover, etc.). - ... # Others BaseX files. - -## Start DTS resolver - -```Bash -cd path/to/basex/bin -``` - -```{.Bash .copy} -bash basexhttp -``` - -By default, the base DTS API enpoint is available at http://localhost:8080/api/dts/. \ No newline at end of file +Si vous avez partagé des corpus TEI grâce à DoTS, n'hésitez pas à nous le faire savoir ! \ No newline at end of file diff --git a/docs/installation.md b/docs/installation.md new file mode 100644 index 0000000..d234cd4 --- /dev/null +++ b/docs/installation.md @@ -0,0 +1,77 @@ +# DoTS + +## What is DoTS? + +DoTS is an XQuery implementation of DTS using a BaseX backend. + +!!! Note + + **DoTS supports only DTS GET requests** for browsing collections, document retrieval and navigation. + +## What is DTS? + +The Distributed Text Services (DTS) Specification defines an API for working with collections of text as machine-actionable data. + +Publishers of digital text collections can use the DTS API to help them make their textual data Findable, Accessible, Interoperable and Reusable (FAIR). + +## Capabilities + +Using DoTS, you can + +- with the DTS Collection endpoint: + - Retrieve lists of collection members. + - Retrieve metadata about individual collection items. +- with the DTS Navigation endpoint: + - Retrieve lists of citeable passages within a text. + - Retrieve a range of citeable passages within a text. + - Retrieve metadata about the citation structure of a document. +- with the DTS Document endpoint: + - Retrieve a single text passage at any level of the citation hierarchy. + - Retrieve a range of text passages with a clearly defined start and end passage. + - Retrieve an entire text. + +## Install + +### BaseX + +Download BaseX (>= 10.0): https://basex.org/download/ + +!!! info + + - Prefer `ZIP Package`, which ensure that you will find the complete BaseX folder. + - Requirements : https://docs.basex.org/wiki/Startup#Startup + + +### DoTS + +DoTS must be installed and started directly in the BaseX folder. + +```Bash +cd path/to/basex/webapp +``` + +```{.Bash .copy} +git clone https://github.com/chartes/dots.git +``` + +The structure of your BaseX should be as follows: + + + basex/ # BaseX root dir. + bin/ # Start scripts (GUI, HTTP server, etc.). + data/ # Database directory. + webapp/ # Web Application directory. + dots/ # DoTS module (DTS reslover, etc.). + ... # Others BaseX files. + +## Start DTS resolver + +```Bash +cd path/to/basex/bin +``` + +```{.Bash .copy} +bash basexhttp +``` + +By default, the base DTS API enpoint is available at http://localhost:8080/api/dts/. \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index 1e505e1..54e259c 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -4,7 +4,8 @@ site_url: https://dots-documentation.github.io/ copyright: © 2023-2024 DoTS nav: - - DoTS: index.md + - Présentation: index.md + - Installation: installation.md - Publier un corpus: publishing-workflow.md - Dossier de dépôt: dots-project-folder.md - Cookbook: