README.md

DoTS

DoTS – BaseX DTS Tools 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.

1. Installation

• Télécharger et installer BaseX (>= 11.XX) (https://basex.org/)
• Télécharger DoTS (https://github.com/chartes/dots)
• Trouver le chemin où BaseX a été installé
• Copier le dossier DoTS dans /path/to/BaseX/webapp

2. Utilisation de DoTS

Pour avoir plus d'informations sur l'installation et l'utilisation de DoTS, vous pouvez consulter la documentation.

3. Usage depuis d'autres applications

En contexte Web, si d'autres applications ont besoin de faire appel aux routes de l'API DTS, il faut ajouter

  !-- Set Access-Control-Allow-Origin: * -->
  <filter>
    <filter-name>cross-origin</filter-name>
    <filter-class>org.eclipse.jetty.servlets.CrossOriginFilter</filter-class>
  </filter>
  <filter-mapping>
    <filter-name>cross-origin</filter-name>
    <url-pattern>/*</url-pattern>
  </filter-mapping>

à la fin du fichierbasex/webapp/WEB-INF/web.xml.

4. État d'avancement de l'implémentation de DTS

L'implémentation actuelle est en accord avec la version 1-alpha de la spécification DTS.

4.1 Endpoint Collections

Propriétées JSON

cf. Collections Endpoint - Distributed Text Services

Nom	Statut	Implémentation
@id	obligatoire	✅
@type	obligatoire	✅
dtsVersion	obligatoire	✅
title	obligatoire	✅
totalParents	obligatoire	✅
totalChildren	obligatoire	✅
description	optionnel	✅
maxCiteDepth	obligatoire (pour les resources)	✅
member	optionnel	✅
dublincore	optionnel	✅
extensions	optionnel	✅
collection	obligatoire	✅
navigation	obligatoire (pour les resources)	✅
document	obligatoire (pour les resources)	✅
download	optionnel	🚧
citationTrees	optionnel	🚧
view	optionnel	🚧

Paramètres de requête

cf. Collections Endpoint - Distributed Text Services

Nom	Méthode	Implémentation
id	GET	✅
page	GET	🚧
nav	GET	✅

4.2 Endpoint Navigation

Propriétées JSON

cf. Navigation Endpoint - Distributed Text Services

Nom	Statut	Implémentation
@id	obligatoire	✅
@type	obligatoire	✅
dtsVersion	obligatoire	✅
resource	obligatoire	✅
ref	optionnel	✅
start	optionnel	✅
end	optionnel	✅
member	optionnel	✅
view	optionnel	🚧

Propriétées JSON de resource

Nom	Statut	Implémentation
@id	obligatoire	✅
@type	obligatoire	✅
collection	obligatoire	✅
navigation	obligatoire	✅
document	obligatoire	✅
citationTrees	obligatoire	🔄

Propriétées JSON de CitationTree

Nom	Statut	Implémentation
identifier	optionnel	🚧
@type	obligatoire	✅
citeStructure	optionnel	✅
description	optionnel	🚧

Propriétées JSON de CiteStructure

Nom	Statut	Implémentation
@type	obligatoire	✅
citeType	obligatoire	✅
citeStructure	optionnel	✅

Propriétées JSON de citableUnit

Nom	Statut	Implémentation
identifier	obligatoire	✅
@type	obligatoire	✅
level	obligatoire	✅
parent	obligatoire	✅
citeType	obligatoire	✅
dublincore	optionnel	✅
extensions	optionnel	✅

Paramètres de requête

cf. Navigation Endpoint - Distributed Text Services

Nom	Méthode	Implémentation
resource	GET	✅
ref	GET	✅
start	GET	✅
end	GET	✅
down	GET	✅
tree	GET	🔄
page	GET	🚧

4.3 Endpoint Document

Paramètres de requête

cf. Document Endpoint - Distributed Text Services

Nom	Méthode	Implémentation
resource	GET	✅
ref	GET	✅
start	GET	✅
end	GET	✅
tree	GET	🔄
mediaType	GET	🚧

#######################

English version

#######################

DoTS

DoTS – BaseX DTS Tools is an XQuery implementation of the DTS (Distributed Text Services) API specification, integrated with the XML database software BaseX.

1. Installation

• Download and install BaseX (>= 11.XX) (https://basex.org/)
• Download DoTS (https://github.com/chartes/dots)
• Find the installation path of BaseX
• Copy the DoTS folder into /path/to/BaseX/webapp

2. Using DoTS

For more details on installing and using DoTS, see the documentation.

3. Usage depuis d'autres applications

In a web context, if other applications need to call the DTS API routes, you should add :

  !-- Set Access-Control-Allow-Origin: * -->
  <filter>
    <filter-name>cross-origin</filter-name>
    <filter-class>org.eclipse.jetty.servlets.CrossOriginFilter</filter-class>
  </filter>
  <filter-mapping>
    <filter-name>cross-origin</filter-name>
    <url-pattern>/*</url-pattern>
  </filter-mapping>

at the end of the file basex/webapp/WEB-INF/web.xml.

4. Progress of the DTS implementation

The current implementation is compliant with version 1-alpha of the DTS specification.

4.1 Endpoint Collections

JSON properties

cf. Collections Endpoint - Distributed Text Services

Name	Statut	Implementation
@id	mandatory	✅
@type	mandatory	✅
dtsVersion	mandatory	✅
title	mandatory	✅
totalParents	mandatory	✅
totalChildren	mandatory	✅
description	optional	✅
maxCiteDepth	mandatory (for resources)	✅
member	optional	✅
dublincore	optional	✅
extensions	optional	✅
collection	obligatoire	✅
navigation	mandatory (for resources)	✅
document	mandatory (for resources)	✅
download	optional	🚧
citationTrees	optional	🚧
view	optional	🚧

Request parameters

cf. Collections Endpoint - Distributed Text Services

Name	Method	Implementation
id	GET	✅
page	GET	🚧
nav	GET	✅

4.2 Endpoint Navigation

JSON properties

cf. Navigation Endpoint - Distributed Text Services

Name	Statut	Implementation
@id	mandatory	✅
@type	mandatory	✅
dtsVersion	mandatory	✅
resource	mandatory	✅
ref	optional	✅
start	optional	✅
end	optional	✅
member	optional	✅
view	optional	🚧

JSON Properties of resource

Name	Statut	Implementation
@id	mandatory	✅
@type	mandatory	✅
collection	mandatory	✅
navigation	mandatory	✅
document	mandatory	✅
citationTrees	mandatory	🔄

JSON Properties of CitationTree

Name	Statut	Implementation
identifier	optional	🚧
@type	mandatory	✅
citeStructure	optional	✅
description	optional	🚧

JSON Properties of CiteStructure

Name	Statut	Implementation
@type	mandatory	✅
citeType	mandatory	✅
citeStructure	optional	✅

JSON Properties of citableUnit

Name	Statut	Implementation
identifier	mandatory	✅
@type	mandatory	✅
level	mandatory	✅
parent	mandatory	✅
citeType	mandatory	✅
dublincore	optional	✅
extensions	optional	✅

Request parameters

cf. Navigation Endpoint - Distributed Text Services

Name	Method	Implementation
resource	GET	✅
ref	GET	✅
start	GET	✅
end	GET	✅
down	GET	✅
tree	GET	🔄
page	GET	🚧

4.3 Endpoint Document

Request parameters

cf. Document Endpoint - Distributed Text Services

Name	Method	Implementation
resource	GET	✅
ref	GET	✅
start	GET	✅
end	GET	✅
tree	GET	🔄
mediaType	GET	🚧