La création de documents XML dans Xdepo

Xdepo propose un mécanisme basé sur des formulaires pour créer et Éventuellement modifier des documents XML et les stocker dans la base de données. Dans cette partie de la documentation, nous allons expliquer comment créer un document avec un formulaire et donner quelques indications sur les particularités les plus fréquentes des formulaires de saisie.

Il convient de rappeler, toutefois, que la nature exacte des formulaires de saisie vont dépendre du type de données à créer et seront probablement configurés de manière spécifique sur votre installation Xdepo. C'est pourquoi il n'est pas possible de créer une documentation complète sur le sujet.

1) Création d'un document

Pour créer un document vous devez avoir des permissions d'écriture dans le dossier en cours de consultation.

Trois objets entrent en ligne de compte lors de la création d'un document :

1. Le type de données, qui déterminer la structure XML du document qui sera créé
2. Le formulaire, qui déterminer les méthodes de saisie de cette structure XML
3. Le modèle de document, qui fournit des valeurs par défaut pour faciliter la saisie

Pour démarrer la création d'un document, vous devez naviguer dans le dossier où vous souhaitez le stocker, puis cliquer sur le bouton Ajouter un document au début de la zone des documents :

Une fois cette opération effectuée, vous verrez à l'écran un formulaire qui vous permet de préciser les trois objets déjà indiqués : type de données, formulaire et modèle. Le choix se fait de manière séquentielle : vous choisissez d'abord un type de données, ensuite la liste des formulaires sera mise à jour pour vous présenter uniquement les formulaires disponibles pour ce type de données ; vous sélectionnez alors un formulaire et la liste des modèles sera mise à jour pour proposer uniquement les modèles disponibles pour ce type de données et ce formulaire. Vous sélectionnez alors un modèle et vous êtes prêt à créer un document.

Une fois complété, le formulaire de sélection d'un type de données, d'un formulaire et d'un modèle ressemble à ceci :

Une fois des trois choix effectués, vous pouvez cliquer sur le bouton Créer le document et le formulaire de saisie sera présenté. Ce formulaire dépend de la configuration de votre installation Xdepo. Si vous utilisez l'un des formulaires prédéfinis, par exemple le formulaire standard pour le type de données Dublin Core (DC), comme dans l'exemple ci-dessus, vous obtiendrez un affichage semble à celui-ci :

A noter que ce formulaire n'est pas un modèle d'ergonomie, mais il permet de montrer un certain nombre de possibilité dans les formulaires de saisie construits avec Xdepo.

2) Caractéristiques communes des formulaires

Chaque formulaire est différent des autres car il est construit pour des raisons spécifiques. Vous y trouverez différents modes de saisie : zones de texte simple ou à plusieurs lignes ; cases à cocher, boutons de radio ; listes (déroulante, à hauteur fixe) ; listes doubles ; calendrier, etc. La plupart des contrôles de saisis communs à toutes les applications graphiques peuvent s'y trouver.

Il existe toutefois quelques aspects un peu particulier que nous souhaitons documenter ici. Le premier concerne les structures XML répétables , qui se matérialisent par des contrôles de formulaires répétés.

Prenons l'exemple d'un document XML qui peut avoir plusieurs éléments auteur , comme l'élément contributor en Dublin Core. Pour permettre une saisie structurée de plusieurs contributeurs, un contrôle de formulaire tel que celui-ci peut être envisagé :

Trois objets sont utiles ici :

1. La zone de texte elle-même, où l'on peut saisir un contributeur
2. Le bouton +, qui permet d'ajouter une occurrence, donc un nouveau contributeur
3. Le bouton -, qui permet de supprimer le contributeur situé à côté

Après la saisie du premier contributeur, il est possible d'en saisir un nouveau en cliquant sur le bouton +, comme ceci :

Une fois le bouton + cliqué, un aller-retour avec le serveur va s'effectuer et le formulaire sera affiché de nouveau, avec exactement les mêmes données, mais avec également une nouvelle zone de texte pour saisir un second contributeur :

Vous pouvez alors saisir ce second contributeur, et répéter les opérations pour tous les contributeurs à saisir. Si vous souhaitez en supprimer un, utiliser le bouton – devant le contributeur à supprimer, et un nouvel aller-retour avec le serveur supprimera cette entrée dans le formulaire – et dans les données sous-jacentes.

Les listes doubles avec ajout de termes constituent une autre forme commune de saisie dans les formulaires. Par exemple :

On y retrouve d'abord une liste double, avec à gauche les items de la liste et à droit ceux qui sont sélectionnés. Entre les deux listes, des boutons permettent de basculer les items aisément. Sous cette double liste, on retrouve une zone de texte pour éventuellement ajouter des termes qui ne sont pas offerts dans la liste.

3) Créer une liste de valeurs

Les listes de valeurs Xdepo sont des documents XML qui respectent un certain format. Ces listes peuvent ensuite être utilisées dans des formulaires de manière standard avec Xdepo. Pour savoir comment utiliser ces listes, consulter le document sur les listes de valeurs dans le guide implémenteur.

Ici, nous allons expliquer comment créer des listes en utilisant le formulaire de saisie proposé par Xdepo. Pour débuter vous devez naviguer dans le dossier où créer une liste. Cette liste sera un document XML comme tous les autres, que vous pourrez gérer par la suite. Ensuite, cliquez sur le bouton Ajouter un document et choisissez le type de données default/list avec les formulaire et modèle proposés, comme dans l'exemple ci-dessous :

Une fois que vous aurez cliqué sur le bouton Créer le document , vous obtiendrez un formulaire tel que celui-ci :

Si vous cliquez sur Enregistrer le document , vous allez créer le document XML avec aucune valeur. Mais auparavant, vous devez donner un identifiant à la liste avec le formulaire qui suit, comme dans cet exemple :

Il s'agit de la dernière étape de création de la liste. Une fois terminée, vous obtenez un nouveau document XML dans le dossier en cours, et ce document contient liste vide (sans aucun item).

Pour ajouter des items dans la liste ou modifier ceux qui existent, il suffit de cliquer sur l'icône de modification à côté de la liste dans la fenêtre de navigation. Vous aurez alors un formulaire qui ressemble à celui-ci :

La première partie du formulaire vous permet de modifier les items existants ou de les réorganiser. La seconde partie permet de saisir un code et une valeur ou de modifier les valeurs déjà saisies.

Commençons par créer une première valeur. Pour ce faire, saisissez un code tel que phys dans la zone de texte correspondante, et ensuite une valeur en français, par exemple Physique en sélectionnant fr dans la liste des langues à droite, comme ceci :

Vous pouvez ensuite cliquer sur le bouton +, comme dans l'exemple, pour saisir une valeur dans une autre langue, toujours pour l'item dont le code est phys , comme ceci :

Vous cliquez ensuite sur le bouton Ajouter pour que l'item avec deux valeurs, une en français et l'autre en anglais, soit ajouté.