Guide pour décrire des données dans NAKALA
La qualité et la richesse de la description des données sont des critères centraux des principes FAIR. Cela constitue un moyen d’atteindre les objectifs visés (faire en sorte que les données soient faciles à trouver, accessibles, interopérables et réutilisables). La qualité se met en oeuvre, par exemple :
-
en utilisant des référentiels standardisés,
-
en respectant les mêmes normes intellectuelles de description pour un ensemble de données,
-
en choisissant des champs de métadonnées les plus adaptés à l’information donnée,
La richesse se met en oeuvre en complétant le plus grand nombre possible de champs afin d’optimiser la compréhension des données.
Dans NAKALA la description est basée sur un ensemble minimal de cinq informations qui peuvent être enrichies de manière étendue et cumulative.
Note
La description des collections dans Nakala suit les mêmes principes et utilise le même modèle que les données. La principale différence est que les métadonnées obligatoires sont le Statut de la collection (privé ou public) et le Titre.
Sommaire
- Statut du guide de description des données dans NAKALA
- Les métadonnées dans NAKALA
- Principes de description des données dans NAKALA
- Métadonnées obligatoires et fortement recommandées
- Publication des métadonnées après attribution du DOI
Statut du guide de description des données dans NAKALA
La version du guide actuelle propose un ensemble de conseils et bonnes pratiques pour les champs de métadonnées obligatoires et complémentaires de premier niveau. Il a vocation à être complété.
Il est possible d’effectuer des remarques pour le faire évoluer.
Les métadonnées dans NAKALA
- Les champs obligatoires de NAKALA :
En déposant une donnée dans NAKALA, vous devez compléter cinq champs de métadonnées obligatoires :
- Titre
- Auteur
- Date
- Type
- Licence
Ces champs inspirés du Dublin-Core permettent d’avoir une description minimale de chaque donnée.
- Les champs optionnels du vocabulaire Dublin-Core :
Aux cinq champs de la notice de description de NAKALA (inspirés du Dublin-Core), il est possible d’ajouter et/ou dupliquer tout autre champ issu du vocabulaire Dublin-Core qualifié.
Le vocabulaire Dublin-Core (“DC”) est composé de:
- une base (“DC simple”) de quinze rubriques de description très génériques (
contributor,coverage,creator,date,description,format,identifier,language,publisher,relation,rights,source,subject,title,type) -
une extension (“DC qualifié”) comportant
- des rubriques supplémentaires (
audience,provenance,rightsholder…) - des qualificatifs de raffinement permettant de préciser les rubriques de base (par exemple:
available,created,dateAccepted,dateCopyrighted,dateSubmitted,issued,modified,valid, sont tous des qualificatifs venant préciser la notion générique de date). - des schémas d’encodage et des vocabulaires contrôlés pour exprimer les valeurs d’une rubrique (par exemple:
DCMIType,W3CDTF…).
- des rubriques supplémentaires (
-
Les autres vocabulaires :
La possibilité d’implémenter dans son interface de dépôt un autre format que le Dublin-Core n’est pas disponible pour l’instant dans NAKALA. Le déposant peut néanmoins associer dans les fichiers d’une donnée, un fichier de métadonnées propre dans le format et le vocabulaire de son choix. Dans ce cas d’usage, il est possible d’exploiter cette description spécifique dans une exposition web externe à NAKALA.
Principes de description des données dans NAKALA
La description des données doit être la plus riche, précise et exacte possible.
Aux champs obligatoires, il est souhaitable de compléter la description par toute autre information connue sur la donnée :
- Privilégiez l’emploi des termes du DC qualifié quand c’est possible plutôt que ceux du DC simple
- Lorsque le contenu d’une rubrique est exprimé dans une langue, précisez celle-ci à l’aide de l’attribut lang
- Privilégiez, là où c’est pertinent, l’utilisation de syntaxes formelles ou de vocabulaires contrôlés plutôt que l’emploi de textes libres
- Quand plusieurs informations de même nature doivent être précisées, utilisez plusieurs fois le même terme.
- N’utilisez pas de système basé sur des caractères de type séparateurs.
Note
Huma-Num soutient des réseaux d’experts données disciplinaires ou métiers via son réseau de consortiums et dans les relais en région que représentent les MSH. La réflexion sur la description de données devrait inclure autant que faire se peut une harmonisation disciplinaire dans le choix des vocabulaires et dans la façon de compléter les informations. Les réseaux sont présentés dans l’onglet Consortiums et Réseaux
Métadonnées obligatoires et fortement recommandées
Type de donnée déposée (obligatoire)
Ce champ précise le type principal des données déposées. La liste des types disponible dans Nakala est fermée, elle est issue du référentiel types de COAR, la “confederation of open access repositories”. Il n’est pas répétable ici.
Liste des types de données :
Lien
Requête API pour interroger la liste des types :
curl -X GET "https://api.nakala.fr/vocabularies/datatypes" -H "accept: application/json"
Il est possible d’apporter des précisions sur la nature ou le genre du contenu de la ressource en utilisant le champ optionnel dcterms:type dans “ajouter une métadonnée”.
Titre (obligatoire)
Il s’agit de décrire la donnée par un titre ou un nom. Celui-ci devrait être précis et unique pour permettre au mieux de comprendre la donnée.
- Pour une photographie, le sujet principal de l’image : “Tour de la Défense : vue de la construction”
- Pour un article de presse, son titre : “Lancement de la construction de la Tour de la Défense”
Selon les besoins et usages des données concernées, le titre pourra comporter des mentions de date, de lieu, de personnes, etc.
Le champ titre obligatoire est répétable pour l’indiquer en différentes langues.
Pour mentionner un titre secondaire, un titre abrégé ou autre nom donné à la ressource, utilisez plutôt le champ dcterms:alternative.
Note
Le titre de la donnée est différent du nom du ou des fichier(s) associé(s) dans le dépôt. Une donnée dans NAKALA est constituée d’une notice de description accompagnée d’un ou plusieurs fichiers. Le nommage des fichiers de données est également à organiser et à planifier. Des règles sont explicitées dans la partie préparer les données
Auteurs (obligatoire)
Dans le champ Auteur proposé par défaut et obligatoire, nous recommandons d’indiquer le producteur de la donnée. Cependant, cela n’est pas toujours adapté à la donnée déposée, voire n’est pas possible (auteur inconnu).
Pour répondre aux différents besoins de description du rôle “Auteur”, il est possible de :
- Dupliquer le champ Auteur
- Ajouter un champ
dcterms:creator - Laisser le champ Auteur en anonyme et ajouter un champ optionnel
dcterms:creator, par exemple dans le cas d’une donnée dont l’auteur n’est pas connu sous la forme d’un nom/prénom
D’autres champs se rapportent à la description d’un rôle sur une donnée et peuvent répondre à un besoin de description dans “ajouter une métadonnée” :
dcterms:publisherdcterms:contributor
Il est important de prendre en compte ici la façon dont la donnée pourra être citée.
Date de création (obligatoire)
Mentionner ici la date de création du contenu de la ressource, et non pas la date de création de sa forme numérisée, en cas de numérisation a posteriori.
Si la ressource déposée ne représente qu’un avatar numérique de l’objet décrit, par exemple la numérisation d’un manuscrit ancien, indiquer la date de création de ce dernier.
Ce champ accepte les formes suivantes du W3CDTF :
YYYY-MM-DD(année-mois-jour). Exemple:2021-03-02YYYY-MM(année-mois). Exemple:2021-03YYYY(année). Exemple:2021
Ce champ accepte la valeur “Inconnue”.
Si les formes acceptées par W3CDTF sont trop contraignantes, il est possible de laisser le champ Date en valeur “Inconnue” et ajouter un champ optionnel dcterms:created dont le contenu n’est pas contrôlé.
Licence (obligatoire)
Le champ Licence précise les conditions de réutilisation possibles de la donnée.
Le formulaire de dépôt de NAKALA permet au déposant de sélectionner :
- les 6 licences Creatives Commons,
- la licence Etalab.
Pour répondre aux autres besoins, il est possible de mentionner d’autres licences. Dans ce cas, le champ Licence de NAKALA permet de rechercher par autocomplétion une licence dans une liste d’environ 400 licences.
Lien
Requête API pour interroger la liste des licences : curl -X GET "https://api.nakala.fr/vocabularies/licenses" -H "accept: application/json"
Si la licence voulue n’est pas trouvée, il est possible de demander l’ajout d’une licence en écrivant à nakala@huma-num.fr. Il faut alors donner l’intitulé de la licence et son uri.
Ressource
Voir Les licences de réutilisation dans le cadre de l’Open Data, par Doranum.
Description (recommandé)
Correspond à dcterms:description
Permet de décrire le contenu de la ressource sous la forme d’un texte libre. Préciser la langue de la description.
Précision sur le choix des champs de description dans les champs optionnels :
- Si la description est un résumé du contenu, utiliser
dcterms:abstract - Si la description est une table des matières, utiliser
dcterms:tableOfContents
Mots-clés (recommandé)
Correspond à dcterms:subject
Permet de décrire le ou les sujets du contenu de la ressource sous forme de mots-clés. Pour faciliter l’usage de ce champ, il est associé aux référentiels d’ISIDORE.
Les labels des concepts issus des référentiels utilisés par ISIDORE pour l’enrichissement des données (RAMEAU, Pactols, GEMET, LCSH, BNE, GéoEthno, ArchiRès, Geonames) sont recherchables par autocomplétion. Cette autocomplétion constitue une aide au choix, le déposant peut sélectionner le concept souhaité, mais peut également inscrire un concept spécifique non trouvé par autocomplétion. Il suffit de valider le mot (touche Entrée) pour qu’il soit pris en compte. Il est recommandé de préciser la langue des mots-clés.
Ce champ multivalué peut également être répété pour renseigner, par exemple, la même liste de mot-clés dans une autre langue.
Il est également possible d’utiliser le champ optionnel dcterms:subject dans “ajouter une métadonnée” pour par exemple, indiquer un code lié à un concept issu d’un référentiel de la bibliothèque du congrès (types: dcterms:LCSH ou dcterms:LCC), ou un code issu d’une classification (types: DDC ou UDC)
Langue (recommandé)
Correspond à dcterms:language
Quand c’est pertinent, le champ Langue permet de préciser la langue de la ressource. Ce champ est facultatif et répétable. L’identification de la langue se fait en la recherchant par autocomplétion dans le référentiel de Nakala (liste de plus de 7 000 langues vivantes ou éteintes selon les normes ISO-639-1 et ISO-639-3).
Il est également possible d’utiliser le champ dcterms:language dans “ajouter une métadonnée” pour indiquer une “langue” qui ne ferait pas partie de ce référentiel ou pour préciser par exemple, l’écriture utilisée (Code ISO-15924)
Publication des métadonnées après attribution du DOI
Chaque donnée publiée dans NAKALA se voit attribuer un Digital Object Identifier (DOI Datacite), un identifiant pérenne permettant la citation à long terme de la donnée. Cette attribution fait l’objet de l’enregistrement de métadonnées, et au titre de la pérennité des citations, ces informations ont vocation à être disponibles à long terme.
Ainsi une donnée publiée dans NAKALA est exposée par le serveur OAI-PMH de NAKALA et publiée dans Datacite.
Chaque collection dans NAKALA est un SET dans l’entrepôt OAI-PMH de NAKALA : https://api.nakala.fr/oai2.
Il est donc important d’avoir des descriptions aussi claires et précises que possible des données qui sont déposées dans NAKALA.
Liens
- Un outil pour formater, à partir d’un DOI, une citation dans différents modèles DOI Citation Formatter
- Un outil de recherche dans les métadonnées Datacite metadata search. Les métadonnées sont récupérables dans cette interface dans les formats (DataCite (XML ou JSON) et Schema.org (JSON-LD)).