Data

Tools

Indexes

Applications

Experiments

Open Source Science

https://github.com/chartes/dots

DoTS – BaseX DTS Tools

https://github.com/chartes/dots

Science Score: 26.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ○
    CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (4.7%) to scientific vocabulary
Last synced: 9 months ago · JSON representation

Repository

DoTS – BaseX DTS Tools

Basic Info
  • Host: GitHub
  • Owner: chartes
  • License: mit
  • Language: XQuery
  • Default Branch: dev
  • Size: 78.6 MB
Statistics
  • Stars: 8
  • Watchers: 5
  • Forks: 4
  • Open Issues: 10
  • Releases: 0
Created almost 3 years ago · Last pushed 10 months ago
Metadata Files
Readme License

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

La procédure d'installation est documentée ici.

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

xml !-- 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 conforme à 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 | ✅ | | totalItems | obligatoire | ✅ | | totalChildren | obligatoire | ✅ | | totalParents | obligatoire | ✅ | | maxCiteDepth | obligatoire (pour les resources) | ✅ | | description | optionnel | ✅ | | member | optionnel | ✅ | | dublincore | optionnel | ✅ | | extensions | optionnel | ✅ | | collection | obligatoire (pour les resources) | ✅ | | navigation | obligatoire (pour les resources) | ✅ | | document | obligatoire (pour les resources) | ✅ | | download | optionnel | 🚧 | | citationTrees | optionnel | 🚧 | | mediaTypes | optionnel (pour les resources) | ✅ |

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 | ✅ |

Propriétées JSON de resource

| Nom | Statut | Implémentation | | -------------- | ----------- | --------------- | | @id | obligatoire | ✅ | | @type | obligatoire | ✅ | | collection | obligatoire | ✅ | | navigation | obligatoire | ✅ | | document | obligatoire | ✅ | | citationTrees| obligatoire | 🔄 | | mediaTypes | optionnel | ✅ |

Propriétées JSON de CitationTree

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

Propriétées JSON de CiteStructure

| Nom | Statut | Implémentation | | -------------- | ----------- | --------------- | | @type | | ✅ | | citeType | optionnel | ✅ | | citeStructure| optionnel | ✅ |

Propriétées JSON de citableUnit

| Nom | Statut | Implémentation | | ------------ | ----------- | -------------- | | identifier | obligatoire | ✅ | | @type | obligatoire | ✅ | | level | obligatoire | ✅ | | parent | obligatoire | ✅ | | citeType | optionnel | ✅ | | 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

The installation procedure is documented here.

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 :

xml !-- 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 | ✅ | | totalItems | mandatory | ✅ | | totalChildren | mandatory | ✅ | | totalParents | mandatory | ✅ | | maxCiteDepth | mandatory (for resources) | ✅ | | description | optional | ✅ | | member | optional | ✅ | | dublincore | optional | ✅ | | extensions | optional | ✅ | | collection | mandatory (for resources) | ✅ | | navigation | mandatory (for resources) | ✅ | | document | mandatory (for resources) | ✅ | | download | optional | 🚧 | | citationTrees | optional | 🚧 | | mediaTypes | optional (for resources) | ✅ |

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 | ✅ |

JSON Properties of resource

| Name | Statut | Implementation | | -------------- | ----------- | --------------- | | @id | mandatory | ✅ | | @type | mandatory | ✅ | | collection | mandatory | ✅ | | navigation | mandatory | ✅ | | document | mandatory | ✅ | | citationTrees| mandatory | 🔄 | | mediaTypes | optional | ✅ |

JSON Properties of CitationTree

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

JSON Properties of CiteStructure

| Name | Statut | Implementation | | -------------- | ----------- | --------------- | | @type | | ✅ | | citeType | optional | ✅ | | citeStructure| optional | ✅ |

JSON Properties of citableUnit

| Name | Statut | Implementation | | ------------ | ----------- | -------------- | | identifier | mandatory | ✅ | | @type | mandatory | ✅ | | level | mandatory | ✅ | | parent | mandatory | ✅ | | citeType | optional | ✅ | | 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 | ✅ |

Owner

  • Name: École nationale des chartes
  • Login: chartes
  • Kind: organization
  • Location: 65 rue de Richelieu, 75002 Paris

Grand établissement d’enseignement supérieur dédié à la recherche historique

GitHub Events

Total
  • Issues event: 6
  • Watch event: 3
  • Delete event: 8
  • Member event: 1
  • Issue comment event: 4
  • Push event: 48
  • Pull request event: 4
  • Fork event: 4
  • Create event: 7
Last Year
  • Issues event: 6
  • Watch event: 3
  • Delete event: 8
  • Member event: 1
  • Issue comment event: 4
  • Push event: 48
  • Pull request event: 4
  • Fork event: 4
  • Create event: 7