Rédaction de documents en docbook dans ESUP
Utilisation de XXE

Ce document a pour but de décrire la prise en main de XXE (XMLMind XML Editor)


Yohan  Colmant 
Université de Valenciennes et du Hainaut Cambrésis

Dates de modification
Revision 1.0 2 février 2006
1. Configuration de XXE
2. Création d'un nouveau document
3. Adaptation d'un document docbook vers le docbook allégé de ESUP

Afin de faciliter la rédaction de documents en docbook, plusieurs modules de configuration de XXE sont disponibles. XXE est téléchargeable ici en xxe-std-xxx.tar.gz pour linux et en xxe-std-xxx.zip pour windows. Il permet la rédaction de documents de différents types:

1. Configuration de XXE

Pour utiliser la DTD allégée pour ESUP dans XXE, il suffit de télécharger l'archive config_docbookEsup_XXE_xxx.zip correspondant à votre version de XXE. Ensuite, le dézipper, suivant la version de XXE que vous utilisez, dans le dossier:

Vous avez alors l'une des arborescences suivantes:

L'ajout de cette configuration sera prise en compte après avoir redémarré XXE.

XXE active par défaut le cache sur les DTD, pour désactiver cette option, décocher "Activer le cache" dans le menu Options>Option>Schéma.

2. Création d'un nouveau document

En choisissant la création d'un nouveau document, vous obtenez l'interface suivante:

Chaque type de document est associé à une structure prédéfinie pour simplifier la rédaction.

Des exemples de documents sont disponibles:

Important

Si vous avez activé le cache des DTD, étant donné que la DTD utilisée est distante, lors de votre première création de documents, vous devez impérativement être connecté au réseau.

Si vous n'avez pas activé le cache, vous devez être connecté à chaque création de document.

3. Adaptation d'un document docbook vers le docbook allégé de ESUP

Pour les personnes qui ont déja créé des documents en docbook ou en docbook allégé simple. Si vous ne voulez pas refaire tout le document, voici comment faire pour l'adapter à la DTD allégée ESUP.

Ouvrir le XML dans un éditeur texte et remplacer 

<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
    "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
    <article>
par 
<!DOCTYPE article PUBLIC
    "-//UR1//DTD docbookAllegeEsup//FR"
    "https://www.esup-portail.org/consortium/espace/docbook/xxe/dtd/docbook_allege_esup.dtd">
    <article lang="FR">
en haut du fichier.

Ensuite, ouvrez ce fichier dans XXE. Si ce document utilise des balises non déclarées dans la DTD de ESUP, une icône rouge apparaît en bas à gauche de la fenêtre. En cliquant dessus, vous pourrez voir d'où vient l'erreur et le cas échéant utiliser des balises différentes. Si le document est conforme, une icône verte apparaît.