Rédaction de documents en docbook dans ESUP
Utilisation de XML SPY

Ce document a pour but de décrire la prise en main de XML SPY


Sébastien  GAUDIN 
université nancy 2

Dates de modification
Revision 1.1 2 février 2006 Remise en forme de la page (Yohan Colmant)
1. XML SPY
1.1. Téléchargement
1.2. Pourquoi Xml Spy ?
1.3. Les points faibles de cette saisie
2. Utilisation
2.1. Installation du masque
2.2. Utilisation proprement dite

1. XML SPY

1.1. Téléchargement

La version home est une version gratuite qui permet d'utiliser un masque de saisie. C'est la vesion qui sera décrite dans cette documentation.

1.2. Pourquoi Xml Spy ?

Ce logiciel a la possibilité d'utiliser un masque de saisie pour créer le fichier xml. Mais ceci n'empeche pas d'avoir une interface pour modifier le fichier xml en lui même.

Les ajouts/suppressions de tags est nettement plus facile à gérer avec Xml Spy. En effet, les sous-éléments disponibles sont soit à droite soit dans le menu "insertion" du click droit.

Quant à la suppression de block, on peut effacer un ensemble de blocs directement.

Dans le masque de saisie, il est possible de faire apparaître les tags xml pour naviguer avec plus de précision dans le fichier.

Le masque de saisie est un fichier xml, donc modifiable facilement.

Xml Spy permet de d'utiliser non seulement la dtd en ligne pour vérifier la saisie, mais aussi la feuille xsl pour avoir le véritable rendu html en 1 click. Ce rendu est bien sûr enregistrable d'où une extrème facilité pour créer les pages de documentation.

1.3. Les points faibles de cette saisie

Le masque ne se base pas sur une css. Celà implique que si la feuille de style esup est modifiée, si on veut garder un masque cohérent, il faut modifier le masque. De la meme façon, si la dtd évolue, il faut bien sûr penser à faire évoluer le masque.

Xml Spy ne sais pas faire évoluer le numéro de puces dans le masque de saisie. Il est tout de même possible de se repérer de part les couleurs.

Il existe un logiciel de création de masque mais il est payant. (Il y a une évaluation de 30 jours, ce qui m'a permis de faire ce masque.) Ce logiciel est StyleVision, et est téléchargeable ici.

2. Utilisation

2.1. Installation du masque

Dans le répertoire d'installation d'Xml Spy, créez le répertoire "sps/Template". A l'intérieur, créez un répertoire "esup" pour y déposer le masque.

Le masque est diponible ici . C'est un fichier .sps (StyleVision Power Stylesheet). C'est une extension spécifique à Altova, l'entreprise développant Xml Spy et le StyleVision. Le masque fonctionne avec un fichier de template (saisie par défaut) à télécharger dans le même répertoire. (template disponible ici)

Démarez Xml Spy, File/New. Une fenetre s'ouvre vous demandant quel type de fichier vous voulez créer.

Cliquez sur le bouton "Select a StyleVision Stylesheet" pour avoir accès au masque de saisie. Dans la version "home" de Xml Spy, il n'y a aucun sps disponible. Le choix est donc très facile.

Sélectionnez le sps "esup" et la saisie peut commencer.

2.2. Utilisation proprement dite

Une fois que vous avez sélectionné le sps, le template par défaut se déssine pour vous proposer différentes parties à saisir. Les parties "add ..." sont des parties obligatoires. En cliquant dessus, Xml Spy soit vous positionne le tag à saisir, soit vous demande lequel vous voulez insérer.