Manuel d'utilisation d'XmlEd
Date de publication : 12/02/2009 , Date de mise à jour : 30/04/2009
III. Vue d'ensemble d'XmlEd
III-A. Workspace et projets
III-B. Namespace et extension
III-C. Création d'un projet
III-D. Import d'un projet
III-E. Editeurs
III-E-1. Page Sources
III-E-1-a. Auto-complétion générique
III-E-1-b. Auto-complétion spécifique
III-E-2. Page Entête
III-E-3. Page Auteurs
III-E-4. Page Serveurs
III-F. Outline
III-G. Toolbars et menus
III-H. Validation
III-I. Génération
III-J. Upload
III-L. Historique
III-M. Diff
III. Vue d'ensemble d'XmlEd
III-A. Workspace et projets
XmlEd n'est autre qu'en ensemble d'extensions à
Eclipse Workbench. Ca permet de profiter
gratuitement de pleins de fonctionnalités, mais ça
limite aussi la marge de manoeuvre, dans la mesure
où XmlEd hérite et adhère aux notions d'Eclipse,
comme par exemple la notion de workspace.
Comme énoncé plus haut, Eclipse workbench repose sur
l'existence d'un workspace, un dossier spécifié au
démarrage et qui sert à contenir les projets crées
par l'utilisateur mais aussi des fichiers de
configuration internes (dans un dossier .metadata).
un projet Eclipse est un dossier dans le workspace
et aun fichier .project avec un contenu spécifique
situé dans ce dossier
Eclipse garde trace des projets dans ses fichiers de
configuration (dans le workspace).
Quand on crée un projet avec Eclipse, il crée le
dossier et le fichier .project de ce projet, mais il
met aussi à jour ses ficheirs de configuration dans
${workspace}/.metadata
Ainsi, faire un copier/coller du dossier d'un projet
dans un workspace ne sert pas à grande chose,
Eclipse ne le reconnait tout simplement pas.
De ce fait, il n'est dons pas possible d'utiliser le
dossier ${kit}/documents directemetnc omem
workspace. Si vous pointez XmlEd pour qu'il utilise
ce dossier comem workspace, il va créer un dossier
.metadata ladedans mais n'affichera aucun projet,
parceque déjà, il n'existe aucun projet au sens
d'Eclipse ladedans (dossier avec un fichier .project
valide ladedans). Mais même si on prenait soin de
placer des fichiers .project valides dans chacun des
dossiers correspondants aux documents, ça ne
changera rien car la configuration du workspace ne
référence pas ces projets.
Pour résumer, et même si vous ne comprenez pas ce
qui a précédé, veuillez suivre ces notices :
|
N'utilisez pas le dossier documents du kit comme
emplacement du workspace d'XmlEd
|
|
Ne manipulez (copier/couper/coller/renommer/etc.)
jamais à la main le contenu du (des) workspace(s)
d'XmlEd. Passez toujours pas XmlEd pour faire ça
|
|
Passez par les assistants d'import d'XmlEd pour
récupérez les documents existants du kit vers le
workspace d'XmlEd.
|
III-B. Namespace et extension
XmlEd utilise des extension spéciales pour les
fichiers xml des différents formats. Ainsi, le XML
d'un article aura l'extension .article, celui d'une
FAQ .
J'ai du procéder ainsi pour pouvoir associer un
éditeur différent à chacun des formats (limitation
venant d'Eclipse).
De plus, j'ai du ajouter une déclaration d'un
namespace aux différents formats pour pouvoir
profiter de l'auto-complétion de l'éditeur XML
d'Eclipse (SSE).
Ainsi, un article verra son élément racine modifié
comme ceci :
< document xmlns = " http://www.developpez.com/xmled/schemas/article/ " >
|
Pour une FAQ
< document xmlns = " http://www.developpez.com/xmled/schemas/faq/ " >
|
Pour une page Cours
< document xmlns = " http://www.developpez.com/xmled/schemas/cours/ " >
|
Pour une page Outils
< document xmlns = " http://www.developpez.com/xmled/schemas/outils/ " >
|
Pour une page Sources
< document xmlns = " http://www.developpez.com/xmled/schemas/sources/ " >
|
Pour une page Livres
< document xmlns = " http://www.developpez.com/xmled/schemas/livres/ " >
|
|
Toute altération ou suppression de ce namespace
bloquera l'auto-complétion et la validation (entre
autres).
|
Au même temps, ces changements (extension et
namespace) font que le document ne passe plus la
génération. XmlEd se charge donc de remettre
l'extension à xml et virer le namespace lors de la
génération
III-C. Création d'un projet
XmlEd offre des assistants (Wizards) pour la
création d'un nouvel document (article, faq, etc.).
Ces assistants peuvent être lancés via :
-
Clic droit dans la vue Project Explorer,
Nouveau
, puis
Projet
ou
Autre
-
Fichier
>
Nouveau
>
Projet
Sélectionnez l'assistant de création qui vous
intéresse depuis la catégorie « Developpez.com » et
cliquez sur « Suivant »
Saisissez un nom pour le document à créer et cliquez
sur « Finish ».
|
Il vous est possible d'utiliser un « modèle » pour
la création d'un nouveau document. Pour ce faire, il
vous faut cocher la case « Utiliser un modèle » et
sélectionner un modèle de la liste.
cliquez sur le lien « Configurer l'emplacement des
modèles » pour, vous l'aurez deviné, configurer
l'emplacement des modèles.
|
L'assistant va alors générer les fichiers du
document l'article et l'ouvrir dans son éditeur
spécifique:
Dans la vue « Explorateur de projets », vous pouvez
noter que les fichiers générés sont :
-
Le projet, avec le nom saisi dans l'assistant.
Notez qu'un overlay spécifique au format
s'affiche en haut et à droite de l'ocône du
projet.
- Dossier vide « fichiers »
- Dossier vide « images »
-
fichier xml du document (du même nom que le
project, avec l'extension correspondante au
format)
III-D. Import d'un projet
XmlEd offre des assistants (Wizards) pour l'import
d'un document (article, faq, etc.) du format
standard
au format modifé
d'XmlEd.
Veuillez utiliser ces assistants pour travailler sur
vos anciens documents avec XmlEd.
Ces assistants peuvent être lancés via :
-
Clic droit dans la vue Project Explorer, puis
Importer
-
Fichier
>
Importer
Sélectionnez l'assistant de création qui vous
intéresse depuis la catégorie « Developpez.com » et
cliquez sur « Suivant »
Localiser le fichier XML du document à importer
(optionnellement modifiez le nom du projet qui sera
crée et spécifiez si oui ou non il faut aussi
importer les images et les fichiers) et cliquez sur
« Terminer ».
L'assistant va alors générer les fichiers du
document importé en l'adaptant au format d'XmlEd et
l'ouvrir dans son éditeur spécifique:
III-E. Editeurs
XmlEd offre des éditeurs multi-pages spécifiques aux
différents formats. Vous pouvez passer d'une page à
une autre via les onglets affichés en bas à gauche
de l'éditeur :
Les pages varient d'un éditeur à un autre, mais tous
les éditeurs partagent les pages suivantes :
-
Page Source : permet de travailler directement
sur le xml du document
-
Page Entete : permet de renseigner les
différents champs de l'entête du document
(titre, auteur, etc.)
-
Page Serveurs : permet de renseigner les
serveurs vers lesquels le document sera uploadé
Il existe aussi d'autres pages, comme par exemple :
-
Page Auteurs : permet de gérer la liste des
auteurs d'un document
-
Aperçu : pour avoir un aperçu rapide sur le
rendu du document encours après génération
III-E-1. Page Sources
Tous les éditeurs incluent une page source, qui
permet de travailler directement sur l'xml du
document (en se basant sur le vénérable
Structured Source Editor de Webtools). Cet
éditeur offre la coloriation syntaxique,
l'autocomplétion, le support d'annulation, le
rechercher/remplacer avancé (avec support des
expressions régulières), le diff avec d'autres
documents ou avec d'autres versions de
l'historique du document, etc.
III-E-1-a. Auto-complétion générique
Etant donné que les documents au format
Developpez.com reposent sur un schéma (XSD),
l'éditeur XML (grace à SSE) permet de
proposer une autocomplétion contextuelle
pour les noms des éléments et des attributs
ainsi que pour les valeurs des attributs de
type énumération (comme le type de liste,
etc.).
Par contextuelle je désigne le fait que
l'autocomplétion n'offre que les
propositions valides dans un contexte donné.
Par exemple, positionnez vous dans l'élément
<entete> et faites « Ctrl + Espace »
(raccourci standard pour invoquer
l'autocomplétion) :
La liste de propositions ne contient que les
éléments valides selon le schéma comme fils
de l'élément <entete>.
Idem pour les noms des attributs, seuls les
attrbiuts déclarés pour un élément donné
sont proposés, comme le montre la capture
suivante (suite à un « Ctrl + Espace » dans
la zone d'attributs de l'élément section :
III-E-1-b. Auto-complétion spécifique
En plus de l'auto-complétion générique
décrite plus haut, XmlEd offre une
auto-complétion plus spécifique aux
documents au format Developpez.com.
-
Les rubriques : Faites « Ctrl +
Espace » dans l'élement
<rubrique> :
=> Ca propose la liste des
rubriques.
-
Les dates : Faites « Ctrl + Espace »
dans l'élement <date> ou
<miseajour>:
=> Ca propose la date courante.
-
Les types de licence : Faites « Ctrl +
Espace » dans l'élement <lictype>
:
=> Ca propose la liste des licences
usuelles.
-
Les noms des serveurs : Faites « Ctrl +
Espace » dans l'élement <serveur>
ou <serveurftp> (il vous faut
configurer la liste des serveurs au
préalable) :
=> Ca propose la liste des noms des
serveurs configurés.
-
Les auteurs : Faites « Ctrl + Espace »
dans l'élement
<authorDescriptions> ou dans
<licauteur> (il vous faut
configurer la liste des auteurs au
préalable) :
=> Ca propose la liste des noms des
auteurs configurés.
-
Les renvoies : Faites « Ctrl + Espace »
dans la valeur de l'attribut id d'un
<renvoi> :
=> Ca propose la liste de tous les
signets dans le document courant.
-
Les images : Faites « Ctrl + Espace »
dans la valeur de l'attribut « src »
d'une <image> :
=> Ca propose la liste de toutes les
fichiers se trouvant dans le dossier
images.
|
Veuillez notez que les éditeurs offrent plus
de possibilités d'auto-complétion
spécifiques au format. Veuillez consulter la
documentation de ces formats pour plus de
détails.
|
III-E-2. Page Entête
L'éditeur XML dispose d'un onglet « Entête » qui
permet d'éditer graphiquement quelques éléments
de l'entête du document en cours.
-
Rubrique : Cette zone de texte permet de
renseigner la rubrique de l'article. Elle
dispose d'un assistant qui s'active lorsque
vous commencez à saisir le nom de la
rubrique.
-
Titres : Permet de renseigner les titres de
la page et de l'article.
-
Dates : Permet de renseigner la date de
rédaction et la dernière mise à jour de
l'article
-
Meta : Permet de renseigner la description
et les mots clés de l'article
-
Licence : Permet de renseigner le type de la
licence (via une liste déroulante avec les
types usuels de licence), le nom de l'auteur
pour la licence (avec autocomplétion, depuis
la liste des auteurs configurés dans les
préférences) et son année.
-
Génération : Permet de contrôler les options
de génération et d'upload
III-E-3. Page Auteurs
Cette page permet d'éditer graphiquement le
auteurs du document en cours.
A gauche, la liste des auteurs du document est
affichée.
Cliquez sur le bouton "Ajouter" pour ajouter un
auteur.
Un menu s'affiche alors avec la liste des
auteurs prédéfinis (veuillez consulter
cette section
pour plus de détails sur la configuration des
auteurs)
Le second bouton permet de supprimer les auteurs
sélectionnés (après confirmation)
La partie à droite permet d'éditer les
différetns champs de l'auteur sélectionné
III-E-4. Page Serveurs
Cette page permet d'éditer graphiquement les
serveurs du document en cours.
Cette page est divisé en deux sections : Serveur
http et Serveur ftp.
Chacune de ces sections permet de :
-
Sélectionner le serveur via une liste
déroulante (il faut avoir configuré la liste
de serveurs au préalable)
-
Saisir le chemin de l'article sur le serveur
-
Prévisulaiser l'url résultante (qui est
automatiquement générée)
Il est possible de contraindre les chemins http
et ftp à avoir la même valeur, en cliquant sur
le bouton à gache de la zone de texte « Chemin
ftp ».
III-F. Outline
XmlEd offre une vue qui permet de naviguer
rapidement dans la structure du document de
l'éditeur actif (à base de l'outline view d'Eclipse)
(avec plein de zolies icones et tout) :
Cette vue permet de faire pleins de petits trucs,
genre :
-
Un simple clic sur un élément de cette vue
affiche l'élément correspondnt dans l'éditeur
-
Un double clic sélectionne la partie
correspondante dans l'éditeur
-
Le drag and drop permet de réordonner les
éléments, ou de déplacer un élément dans un
autre
-
Ca permet de supprimer des noeuds ou d'en créer
de nouveaux
- etc.
|
Veuillez notez que dans la version courante,
l'Outline souffre d'un bug qui fait qu'il arrive
qu'il soit plus synchronisé avec son éditeur.
L'origine de ce bug ne vient pas d'XmlEd mais de
l'infrastructure de l'éditeur XML de WST.
|
III-G. Toolbars et menus
Lorsque l'éditeur d'un document est activé, le
toolbar affiche les boutons suivants:
Ces boutons sont (dans l'ordre, de gauche à droite)
:
-
Formater : reformate le xml de la sélection de
l'éditeur courant ou tout le document si pas de
sélection (Ctrl + Alt + F).
-
Gras : si un texte est sélectionné, l'entoure
des balise <b> (gras), sinon insère la
balise <b> dans la position courante.
-
Italique : si un texte est sélectionné,
l'entoure des balise <i> (italique),
sinoninsère la balise <i> dans la position
courante.
-
Souligner : si un texte est sélectionné,
l'entoure des balise <u> (souligner),
sinon insère la balise <u> dans la
position courante.
-
Exposant : si un texte est sélectionné,
l'entoure des balise <sup> (superscript),
sinon insère la balise <sup> dans la
position courante.
-
Indice : si un texte est sélectionné, l'entoure
des balise <sub> (subscript), sinon insère
la balise <sub> dans la position courante.
-
Br : Insère un retour à la ligne (balise br)
dans la position courante.
-
Paragraphe : insère la balise
<paragraphe>. Si un texte est sélectionné,
le place dans un paragraphe dans la section.
-
Section : Ouvre une boite de dialogue pour
saisir le titre d'une section et génère un
nouvelle section (avec la balise <title>).
Si un texte est sélectionné, le place dans un
paragraphe dans la section.
-
Liste : insère les balises <liste> et
<element>. Si un texte est sélectionné, le
place dans le premier élément.
-
Tableau : insère les balises <tableau>,
<ligne> et <colonne>. Si un texte
est sélectionné, le place dans une colonne.
-
Validation : lance la validation du document
(F6)
-
Génération : lance la génération du document
(F9)
-
Upload Partiel: lance l'upload partiel du
document (F4)
-
Upload Complet: lance l'upload partiel du
document (F5)
Ces fonctiones sont aussi disponibles via les menus
Style, Insertion et ${Format}, où format désigne le
nom du format du document en cours (Article, FAQ,
Cours, etc.):
III-H. Validation
XmlEd offre une validation syntaxique des différents
formats (structure de l'xml, respect du schéma,
etc.) mais aussi une validation sémantique,
dépendante du format
Pour invoquer la validation, vous pouvez :
-
Cliquer sur le bouton de validation dans le
toolbar
-
Sélectionner l'entrée validation dans le menu du
format
-
Cliquer sur F6 quand l'éditeur est actif
-
Clic droit dans l'éditeur, valider
Les erreurs seront alors affichés dans l'éditeur
(dans la marge gauche):
En placant la souris sur un marqueur, l'intitulé de
l'erreur serait affiché.
Notez aussi que dans la marge à droite, des liens
vers les marqueurs sont affichés. Un clic dessus
positionne l'éditeur à l'emplacement de l'erreur.
Les erreurs sont aussi centralisés dans la vue
"Erreurs"
Un double clic sur une erreur positionne l'éditeur à
l'emplacement de l'erreur (en l'ouvrant si
nécessaire)
III-I. Génération
XmlEd supporte la génération des différents
formats(la transformation de l'xml vers les versions
php, html zippé et pdf) et ce en utilisant le kit.
Pour lancer la génération, il suffit de cliquer sur
le bouton « Générer (F9) » dans le toolbar lorsque
l'éditeur est actif, ou encore via le menu du
format.
|
Il n'est pas nécessaire d'enregistrer le document
pour pouvoir effectuer la génération.
|
XmlEd utilise la console d'Eclipse pour afficher les
détails du déroulement de la génération. Ceci inclut
ce qui est émis par le kit (sortie standard et
sortie des erreurs)
Si la généartion réussit, le fichier html généré
serait ouvert dans le navigateur.
Pour désactiver ceci, il faut aller dans « Window >
Preferences > Developpez.com > Génération » et
décocher l'option concernée.
Même si vous désactivez cette option, il vous est
toujours possible d'ouvrir le fichier généré en
cliquant sur le lien affiché dans la console à la
fin de la génération :
|
Vu qu'avec XmlEd vous travaillez sur un xml modifé
parapport au format original, et qui est situé en
dehors du dossier documents du kit, voici comment se
déroule la génération avec XmlEd:
|
-
XmlEd crée une copie de l'xml à partir du
workspace d'Eclipse vers un dossier portant le
même nom que le fichier sans l'extension dans le
dossier documents du kit, en supprimant la
déclaration du namespace et en restaurant
l'extension .xml. Par exemple, un fichier
djo.article va donner un fichier
${kit}/documents/djo/djo.xml.
-
XmlEd copie le dossier images et fichiers du
workspace vers le dossier crée dans le kit
(${kit}/documents/djo)
-
XmlEd lance les taches de génération du kit en
ligne de commande
III-J. Upload
XmlEd permet d'uploader le résultat de la génération
d'un document vers les domaines Developpez.com
spécifiés dans l'entête.
Pour lancer l'upload, il suffit de cliquer sur le
bouton « Uploade complet (F5) » ou « Uploade partiel
(F4) » dans le toolbar lorsque l'éditeur est actif
ou encore via le menu du format.
XmlEd utilise la console d'Eclipse pour afficher les
détails du déroulement de l'upload :
|
XmlEd fait l'upload du résultat de la dernière
génération réussi située dans dans le kit.
|
|
A l'inverse du comportement usuel du kit et de
l'éditeur de Nono qui n'uploade que les fichiers de
premier niveau dans les dossiers images et fichiers,
XmlEd supporte l'upload d'images et fichiers de
n'importe quelle profondeur. Toutefois, la version
zippé ne contiendra que les images du premier niveau
(car il est généré par le kit et non pas par XmlEd)
|
III-L. Historique
Les éditeurs des différents formats gardent trace de
l'historique du document en cours d'édition, vous
donnant la possilbité de revenir vers ces versions
Pour ce faire, il vous faut afficher la vue «
Historique ». Allez dans le menu « Fenêtre >
Afficher la vue > Autre > Equipe >
Historique »
Double cliquez sur une version pour afficher le
document tel qu'il était à cette date.
Faites un clic droit sur une version puis « Obtenir
le contenu » pour remplacer la version courante par
la version sélectionnée.
III-M. Diff
XmlEd permet d'afficher un diff visuel entre deux
fichiers ou entre deux versions dans le temps d'un
même fichier
Pour comparer deux fichiers entre eux, sélectionnez
les deux fichiers dans l'Explorateur de projets,
puis faites un clic droit sur l'un d'eux (la base)
et « Comparer > Reciproquement »
Pour comparer 2 versions dans le temps d'un même
fichier, sélectionnez les 2 versions à comparer dans
dans la vue « Historique », faites un clic droit sur
l'une d'elles et « Comparer entre elles »
Copyright © 2009 Jawher Moussa.
Aucune reproduction, même partielle, ne peut être faite
de ce site ni de l'ensemble de son contenu : textes, documents, images, etc.
sans l'autorisation expresse de l'auteur. Sinon vous encourez selon la loi jusqu'à
trois ans de prison et jusqu'à 300 000 € de dommages et intérêts.