[doc] Add some doc about vocabularies handling
authorSylvain Thénault <sylvain.thenault@logilab.fr>
Tue, 31 Oct 2017 16:10:03 +0100
changeset 2792 ed7eccb2e8db
parent 2791 4b7d28df3c52
child 2793 ad99b2a9c295
[doc] Add some doc about vocabularies handling
doc/vocabulaires.rst
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/vocabulaires.rst	Tue Oct 31 16:10:03 2017 +0100
@@ -0,0 +1,60 @@
+Administration des vocabulaires SEDA
+====================================
+
+Le cube SEDA vient avec un certain nombre de vocabulaires utilisés pour
+contrôler les valeurs possibles pour différents champs des profils. Cette
+section détaille quelques points à noter à ce sujet.
+
+Paramétrage des vocabulaires
+----------------------------
+
+Tout d'abord, le vocabulaire associé par défaut à un champ du SEDA est configuré
+via des enregistrements dans la base de données, mais cela n'est pas à ce jour
+configurable via l'interface Web. Dans le cas des profils complet, on peut en
+configurer certains via l'onglet "vocabulaires". Dans le cas des profils
+simplifiés ou des composants unités d'archives, les vocabulaires par défaut sont
+utilisés et il n'est pas encore possible de faire autrement.
+
+Le champ "type de descripteur" d'un vocabulaire permet de contrôler l'interface
+de saisie des mots-clés associés à une unité d'archive, en ne rendant disponible
+que les vocabulaires d'un type données en fonction du type choisie dans
+l'interface.
+
+Contrôle des valeurs entre les différents versions de SEDA
+----------------------------------------------------------
+
+Lors de l'export SEDA, la valeur à utiliser dans le cas d'un champ non
+"sémantisé" (i.e. pour lequel on cherche à exporter une valeur et non une URL)
+est cherchée de la manière suivante. Étant donné un concept lié, on va chercher
+le libellé préféré dans la langue :
+
+#. spécifique à la version du SEDA exportée : 'seda-2', 'seda-1', 'seda-02',
+#. générique au SEDA : 'seda'
+#. anglais : 'en'
+#. français : 'fr'
+
+Gestion du vocabulaire "Catégories de fichier"
+----------------------------------------------
+
+Ce vocabulaire est un peu particulier car il ne sert que dans l'interface
+utilisateur. En fonction de la valeur saisie, le profil sera lié à différents
+concepts correpondants pour les champs "type MIME" et "identifiant de format" du
+SEDA.
+
+La structure de ce vocabulaire est la suivante : ::
+
+  + catégorie
+   \
+    + extension
+     \
+      + type MIME
+       \
+        - identifiant de format (PRONOM)
+
+Lorsqu'une ou plusieurs valeurs sont sélectionnées pour la catégorie de fichier
+d'un objet-données d'un profil, une jointure est effectuée sur le nom des type
+MIME et identifiants de format sous-jacent avec les vocabulaires "types MIME" et
+"formats de fichier" sélectionnés pour ce profil (donc des vocabulaires "Types
+MIME" et "Formats de fichier (PRONOM)" dans le cas des profils simplifiés). Lors
+de la maintenance de ce vocabulaire il convient donc de s'assurer de sa
+cohérence avec les vocabulaires adéquats (a minima les deux sus-cités).