In English

Jaxe sur SourceForge

Copies d'écran

Jaxe

Dans cette copie d'écran, on peut voir un dialogue d'édition d'attributs, le panneau d'insertion des éléments, et la zone de texte comportant plusieurs affichages possibles pour les éléments.

Une application de Bodo Tasche utilisant Jaxe

Le deuxième exemple montre Jaxe intégré à l'intérieur d'une autre application Java, avec des affichages personnalisés pour les éléments.

XML est une syntaxe, mais c'est surtout une philosophie dans l'écriture de documents qui consiste à expliciter le sens des informations par opposition à la forme. On écrira par exemple:

<TITRE>XML</TITRE>

au lieu de:

<GRAS><ITALIQUE><CENTRE>XML</CENTRE></ITALIQUE></GRAS>

Ce principe permet à la fois des traitements automatiques (par exemple l'extraction de tous les titres pour construire une table des matières), et la possibilité de définir plusieurs affichages pour un même contenu (par exemple un affichage sur le web et un autre sur papier).

Comme le contenu est bien séparé de la forme, les éditeurs XML comme Jaxe ne sont pas WYSIWYG ("What you see is what you get"). Pour ceux habitués aux traitements de texte comme Word, il faut faire attention à ne pas utiliser de styles comme gras ou italique quand il est possible d'indiquer le sens du texte à la place. Il ne faut pas non plus se fier à l'aperçu, étant donné qu'il peut y avoir plusieurs affichages possibles. Attention donc à utiliser des éléments correspondant à des paragraphes ou des sections plutôt que des éléments "saut de ligne", étant donné que l'espacement entre les paragraphes dépend de l'affichage et peut être un peu plus ou un peu moins qu'une ligne.

Un langage XML est défini de façon formelle, de manière à permettre la vérification automatique de la syntaxe. Cette description formelle comprend les noms des éléments du langage, les imbrications possibles entre les éléments, l'ordre autorisé des éléments, et leurs attributs (les attributs étant optionnels ou obligatoires).

Jaxe facilite la création des documents XML en utilisant les règles du langage pour proposer des éléments à insérer là où c'est possible. Cela permet de créer des documents valides (c'est à dire se conformant aux règles du langage) beaucoup plus facilement qu'avec un simple éditeur de texte. Cette introduction est générale pour tous les langages qui peuvent être utilisés, mais chaque utilisateur final doit apprendre un ou plusieurs langages XML particuliers, qui ne sont pas détaillés ici.

En plus des fichiers décrivant les langages XML (les schémas), Jaxe utilise des fichiers de configuration qui définissent la barre de menus et la façon d'afficher les éléments du langage. Ces fichiers se trouvent dans le répertoire config, et leur nom se termine en _config.xml.

Jaxe nécessite Java 1.5 ou une version ultérieure pour fonctionner. Pour savoir quelle version de Java est installée, il suffit de taper java -version sous la ligne de commande.

Jaxe se lance différemment suivant le système d'exploitation. Sur MacOS, il suffit de double-cliquer sur l'application, qui doit se trouver dans le répertoire Jaxe. Sur Windows, on lance Jaxe avec l'exécutable Jaxe.exe ou avec le script run.bat, et sur UNIX avec le script run.sh. Ces scripts peuvent être modifiés pour définir un fichier de configuration à utiliser par défaut.

Sur Windows on peut lancer le script assocXMLJaxe.bat pour associer l'extension ".xml" à Jaxe. Cela permet d'ouvrir les fichiers XML directement en double-cliquant dessus. Ce script ne fonctionne que si on a les droits pour modifier les associations de fichiers, et il faut donc être administrateur.

Sur MacOS X on peut choisir Jaxe plutôt qu'un autre programme pour ouvrir un fichier XML par un double-clic en choisissant le menu "Lire les informations" d'un fichier XML, en choisissant Jaxe dans "Ouvrir avec", et en cliquant sur "Tout modifier" pour que tous les fichiers XML s'ouvrent avec.

Il est aussi possible de lancer Jaxe avec les scripts jaxe.bat et jaxe.sh, en ajoutant le nom d'un fichier à ouvrir, par exemple en tapant ./jaxe.sh essai.xml.

Jaxe charge les fichiers XML en mémoire, et cela peut être difficile quand ils ont beaucoup de grandes images. Il est possible d'augmenter la mémoire allouée à Jaxe, suivant le système:

• sur Windows et UNIX, en modifiant le fichier run.bat ou run.sh: remplacer java par java -Xms128m -Xmx512m pour allouer 128 Mo de mémoire initialement, et autoriser un l'utilisation d'un maximum de 512 Mo.
• sur MacOS, éditer Jaxe/Jaxe.app/Contents/Info.plist, et ajouter les lignes <key>VMOptions</key> et <string>-Xms=128m -Xmx=512m</string> après les lignes <key>Java</key> et <dict>.

Jaxe utilise par défaut la langue du système, sachant que dans Jaxe 3.4 les seules langues définies sont le français, l'anglais, l'allemand, le portugais brésilien, le russe et l'espagnol. Si le système utilise une autre langue, Jaxe se lance en français. Pour changer la langue utilisée, on peut ajouter l'option -Duser.language=xx après la commande java dans les scripts, ou comme valeur de la clé VMOptions sur MacOS X. xx est un code correspondant à la langue, par exemple en pour l'anglais.

Un éditeur d'équation a été spécialement conçu pour Jaxe, afin d'ajouter et de modifier facilement des équations. Il fonctionne avec une zone de texte, où l'on entre une équation avec une syntaxe particulière, et l'image correspondant à l'équation s'affiche en temps réel au-dessus.

• Addition et soustraction

  opérateurs '+' et '-'

• Multiplication

  Opérateur '*', affiché seulement quand deux nombres sont multipliés.

  Exemple: 2*3*sin(1,5*pi) s'affiche :

• Division

  Opérateur '/' (affiché sous forme de fraction) et fonctions 'slash' et 'fraction'.

  Exemple: slash(a;b)/c s'affiche :

• Fonction

  Le séparateur des arguments est le point virgule pour dinstinguer ce caractère de la virgule, utilisée pour les décimales: nomfonction(arg1;arg2;...)

  Exemple: f(x;y) s'affiche :

• Exposant

  Opérateur '^'.

  Exemple: x^y s'affiche :

• Indice

  Opérateur '_'.

  Exemple: x_(ab) s'affiche :

• Exposant et indice

  Fonction 'subsup' avec le premier terme, et les éléments à mettre en indice et en exposant.

  Exemple: subsup(A;1;2) s'affiche :

• Racine carrée

  Fonction 'racine' ou 'sqrt'.

  Exemple: racine(x/2) s'affiche :

• Racine n-ième

  Fonction 'racine' avec le degré de la racine en deuxième argument.

  Exemple: racine(x;3) s'affiche :

• Valeurs absolues

  Fonction 'abs'.

  Exemple: abs(x^3) s'affiche :

• Puissance de e

  Fonction 'exp'.

  Exemple: exp(x^2) s'affiche :

• Intégrale

  Fonction 'intégrale', avec 4 arguments: la fonction à intégrer, la variable d'intégration, la borne minimum et la borne maximum.

  Exemple: intégrale(f(x);x;0;infini) s'affiche :

• Somme et produit

  Fonctions 'somme' et 'produit', avec 3 arguments: la fonction à sommer, la borne minimum et la borne maximum.

  Exemple: somme(ln(k)/k;k=1;10) s'affiche :

• Matrice

  Fonction 'matrice', avec les lignes en argument sous forme de fonction 'ligne'.

  Exemple: matrice(ligne(1;2;3);ligne(4;5;6)) s'affiche :

• Lettres grecques

  Variables avec le nom de la lettre, avec une majusucle au premier caractère du nom pour obtenir une lettre grecque majuscule.

  Exemple: alpha*Delta*thetasym*upsih*piv s'affiche :

• Caractères spéciaux

  Variable avec le nom du caractère spécial.

  soleil|étoile|terre|planck|infini|angström|petitl|chapeau|barre|astérisque|grandg|...

  Exemple: M_soleil/M_terre=3,329*10^5 s'affiche :

• Opérateurs spéciaux

  Code spécial. Il vaut mieux éviter les espaces, mais quand l'opérateur est un mot, un espace peut améliorer la lisibilité de l'équation (sans changer l'affichage).

  !=|~=|<=|>=|<<|>>|->|quelquesoit|ilexiste|drond|nabla|prop|croix|plusoumoins|cap|cup

  Exemple: quelquesoit a ilexiste b<<c~=d>=e!=f s'affiche :

• Accents

  Fonction 'accent' avec la lettre et l'accent à ajouter par-dessus.

  Exemple: accent(AB;->)+accent(ABC;chapeau)+accent(x;barre) s'affiche :

• Dérivée par rapport au temps

  Fonction 'dtemps' avec la variable et le nombre de points à mettre au-dessus.

  Exemple: dtemps(theta;2) s'affiche :

• Vecteurs

  Fonction 'vecteur' avec le nom du vecteur.

  Exemple: vecteur(u_theta) s'affiche :

• Produit scalaire

  Fonction 'pscalaire' avec les deux vecteurs en paramètre.

  Exemple: pscalaire(vecteur(AB);vecteur(CD)) s'affiche :

• Norme

  Fonction 'norme' avec le vecteur en paramètre.

  Exemple: norme(vecteur(AB)) s'affiche :

• Fonctions sans parenthèses

  Certaines fonctions s'affichent sans parenthèses quand elle n'ont qu'un argument avec une variable.

  Exemple: sin(a)*sin(b) s'affiche :

• Système d'équations

  Fonction 'système', avec les lignes en argument.

  Exemple: système(x+y=2;x-2*y=3) s'affiche :

• Unités

  Fonction 'unité', avec l'unité en deuxième argument.

  Exemple: grandg=unité(6,67259*10^(-11);m^3*kg^(-1)*s^(-2)) s'affiche :

  Notez que les unités s'affichent avec un style de caractères normal, alors qu'une variable comme s'affiche en italique.

• Factorielles

  Fonction 'factorielle'.

  Exemple: factorielle(x) s'affiche :

• Moyenne

  Fonction 'moyenne'.

  Exemple: moyenne(M_B) s'affiche :

Cet éditeur permet de créer un fichier de configuration afin de définir un environnement d'édition des éléments du langage XML. Grâce à son interface graphique simplifiée l'utilisateur peut facilement créer ou éditer des fichiers de config.

Menu initial

Ouvrir un fichier de config

Nouveau: créer un nouveau fichier de config

Ouvrir: ouvrir et éditer un fichier de config existant. Accédez au menu principal.

Quitter: quitter l'application

Définir une ou plusieures langues

Ajout d'une langue

Liste des langues

Il faut ajouter au moins une langue

Choix d'un type de schéma

Sélection d'un schéma xml dans le dossier config

Choisissez un type de schéma W3C, sélectionnez le fichier dans votre dossier config.

Choix d'une ou plusieures racines

La liste à gauche représente les éléments parents qui peuvent être des racines possibles. Sélectionnez un et ajoutez le dans la liste des racines. N'oubliez pas de valider les modifications en cliquant sur OK.

En cas d'ouverture d'un fichier de config existant, vous verrez les racines existantes dans la liste des Racines.

Il est nécessaire d'indiquer un ou plusieurs éléments racine utilisables pour les nouveaux documents.

Menu principal

Ce menu principal permet d'accéder aux différentes parties de l'éditeur:

• Racine : Choisir un ou plusieurs racines possibles pour votre fichier de config
• Enregistrement : Editer l'élément l'Enregistrement de votre document XML
• Editeur de Menus : Editer les menus, les menus d'insertion et les menus de fonction
• Editeur des Eléments : Editer les éléments XML
• Editeur des Exports : Editer un ou plusieurs exports en utilisant une ou plusieurs transformations XSLT successives
• Editeur des Textes Géneral : Editer les textes (appelés aussi chaînes de caractères ou strings) de l'interface créée avec la configuration

Choix d'un autre fichier de configuration

Une autre configuration Jaxe, à utiliser en plus de celle-là.

Créer un nouveau menu

Créer un nouveau menu

Ajout d'un menu d'insertion

Créer un nouveau menu de fonction

Créer un nouveau menu de fonction

Editer les textes d'un menu

Editer les textes d'un menu d'insertion

Les menus définis dans les fichiers de config s'affichent au-dessus de la zone de texte de Jaxe. Ils ne sont pas mélangés avec la barre de menus de Jaxe, qui se trouve au-dessus (en haut de l'écran sur Mac).

Edition d'un élément sélectionné

Edition des textes d'un élément

Filtrer la liste des éléments

Valeurs suggérées pour un attribut

Paramètre d'affichage

Edition des textes d'un attribut

Une fonctionnalité essentielle de Jaxe est la possibilité d'afficher et d'éditer les éléments XML de diverses façons, quelque soient leurs types dans le schéma XML. On pourra par exemple choisir d'afficher un élément représentant une table sous forme de table, ou un élément pointant vers une image sous forme d'image. L'objectif étant de faciliter l'édition des documents, sans pour autant perdre de vue leur aspect sémantique : on ne cherchera pas à afficher les éléments tels qu'on les verra sous forme de page web ou PDF, mais simplement avec une interface facilitant l'édition et mettant en évidence le sens des différents éléments.

Type	Description	Affichage
division	Deux barres allant jusqu'au bout de la fenêtre à droite, permettant de bien séparer de grandes parties du document.
zone	Deux balises et des retours à la ligne, pour séparer des parties plus petites qu'avec division.
string	Deux balises pour identifier une petite chaîne de caractères, sans retour à la ligne.
vide	Une seule balise, typiquement pour un élément vide.
tableau	Affichage de tableau de type tableur (avec le composant Swing JTable). Pratique pour des tableaux de nombres, mais ne permet pas d'utiliser des élements XML à l'intérieur des cellules (utiliser tabletexte pour cela).
tabletexte	Affichage d'une table permettant d'utiliser des éléments XML dans les cellules. Gère aussi les attributs rowspan et colspan pour regrouper les cellules verticalement et horizontalement.
style	A utiliser dans le cas (très rare si le langage XML code le sens par opposition à la forme) où un élément XML ne donne qu'une information de style. Affiche les caractères dans le style choisi (gras, italique, ...), sans aucune balise. Une alternative est d'utiliser le type string, qui permet aussi de choisir un style, mais affiche les balises.
fichier	Affiche une image à partir de son chemin sur le disque issu d'un attribut de l'élément XML (à préciser). Il est possible de faire des copier/coller d'images et Jaxe créera automatiquement l'élément XML et le fichier de l'image sur le disque, en utilisant le premier élément de type fichier.
symbole	Permet de choisir une image parmi un ensemble d'images situé dans un dossier.
liste	Pour un élément correspondant à une liste à points ou numérotée. Le sous-élément doit utiliser le type item. S'affiche comme zone, avec un bouton '+' pour créer de nouveaux éléments de la liste.
item	Elément d'une liste affichée avec le type liste. S'affiche avec des points ou des numéros, en fonction du type de liste.
typesimple	Affiche un élément ayant une simple valeur, dans une petite zone particulière. Utilisable uniquement pour les éléments ayant un type simple dans le schéma XML. L'affichage précis (zone de texte, menu ou boîte à cocher) et la validation se fait en utilisant les contraintes du schéma XML.
equation	Affiche l'image d'une équation. L'équation peut être éditée par un simple clic dessus, avec un dialogue présentant en même temps le texte de l'équation (avec une syntaxe très simple propre à Jaxe) et l'image correspondante.
formulaire	Affiche un élément et tous ses sous-éléments possibles sous la forme d'un formulaire, avec un champ par sous-élément. Attention à ne pas utiliser ce type avec des éléments pouvant avoir un sous-arbre infiniment profond !
plugin	Si vous voulez définir votre propre élément Jaxe, c'est possible ! Voir la partie Création de nouveaux éléments Jaxe de la documentation pour les développeurs pour plus de précisions. En outre, certains plugins sont téléchargeables depuis cette page.

Des paramètres peuvent être utilisés, en fonction des types d'affichage, avec l'élément PARAMETRE sous AFFICHAGE_ELEMENT.

Les affichages de type division et zone peuvent avoir un paramètre indiquant le nom de l'attribut à utiliser comme titre pour l'affichage.

Les affichages de type fichier et symbole doivent avoir un paramètre indiquant l'attribut repérant le nom du fichier.

Les affichages de type tableau et tabletexte doivent avoir des paramètres indiquant les éléments repérant les lignes et les cellules.

Les affichages de type style doivent avoir un paramètre indiquant le style.

Les affichages de type zone et string peuvent avoir un paramètre indiquant le style, un paramètre avec la police de caractères, et un paramètre avec la taille des caractères.

Les affichages de type equation doivent avoir des paramètres indiquant les attributs à utiliser pour le texte de l'équation et le nom de l'image.

Voilà la liste complète des paramètres possibles:

Editer les textes d'un menu

Editer les textes d'un élément

Editer les textes d'un export

Ajout d'une langue

Edition des textes pour l'ensemble de langues

On peut souhaiter modifier tous les textes (appelés aussi chaînes de caractères ou strings) de l'interface créée avec la configuration. Soit pour améliorer la lisibilité sans avoir à modifier le schéma, soit pour fournir une interface dans une autre langue pour le même schéma. On peut aussi souhaiter fournir les textes pour un ensemble de langues, de manière à ce que les utilisateurs puissent éditer les mêmes documents, avec la même configuration Jaxe, mais avec une interface entièrement dans leur langue.

• Vous pouvez ajouter une langue en cliquant sur Ajouter. La langue est ajoutée avec les mêmes menus que les autres langues. Il vous suffit de traduire.
• Pour supprimer une langue, il vous suffit de la séléctionner et cliquer sur Retirer.

Sauvegarde du fichier XML

Enregistrer le chemin du schéma

Enregistrement du chemin du schéma

Cliquer sur Enregistrer et choisissez le chemin de votre dossier config. Saisissez le nom du fichier (sans _config) sans l'extension .xml

Un dialogue vous demande d'enregistrer le chemin du schéma. le fichier de config et le schéma W3C doivent être dans le même dossier config.

Si vous quitter sans enregistrer votre fichier XML, un dialogue vous suggérera de le faire.

Lors de la création d'un nouveau document avec Jaxe, il est nécessaire de choisir un fichier de config.

Les fichiers de config de Jaxe permettent de spécifier l'interface d'édition des documents XML avec Jaxe pour un langage XML donné. Ceci recouvre les informations sur le langage XML, les options d'enregistrement, les menus (notamment pour insérer les éléments), les types d'affichage des éléments, les exports possibles, et toutes les chaînes de caractères utilisées dans l'interface, en fonction de la langue de l'utilisateur.

Les fichiers de config se trouvent dans le répertoire config de Jaxe, et leurs noms se terminent par "_config.xml". Les anciens fichiers de config (avant Jaxe 3.0) avaient un nom se terminant en "_Jaxe_cfg.xml". On peut les convertir dans la nouvelle version à partir d'un menu d'export dans le menu Fichier.

Il est possible d'ouvrir un schéma XML dans Jaxe et d'"exporter" vers un fichier de config. Cela crée automatiquement un fichier de config qui permettra l'édition dans Jaxe pour ce schéma, mais les choix automatiques pour les types d'affichage sont souvent mauvais ou insuffisants : cet export ne doit pas être considéré comme une méthode de création des fichiers de config, mais peut servir pour commencer la création d'un fichier de config à partir d'un schéma particulièrement complexe.

Les menus définis dans les fichiers de config s'affichent au-dessus de la zone de texte de Jaxe. Ils ne sont pas mélangés avec la barre de menus de Jaxe, qui se trouve au-dessus (en haut de l'écran sur Mac).

Une fonctionnalité essentielle de Jaxe est la possibilité d'afficher et d'éditer les éléments XML de diverses façons, quelque soient leurs types dans le schéma XML. On pourra par exemple choisir d'afficher un élément représentant une table sous forme de table, ou un élément pointant vers une image sous forme d'image. L'objectif étant de faciliter l'édition des documents, sans pour autant perdre de vue leur aspect sémantique : on ne cherchera pas à afficher les éléments tels qu'on les verra sous forme de page web ou PDF, mais simplement avec une interface facilitant l'édition et mettant en évidence le sens des différents éléments.

Type	Description	Affichage
division	Deux barres allant jusqu'au bout de la fenêtre à droite, permettant de bien séparer de grandes parties du document.
zone	Deux balises et des retours à la ligne, pour séparer des parties plus petites qu'avec division.
string	Deux balises pour identifier une petite chaîne de caractères, sans retour à la ligne.
vide	Une seule balise, typiquement pour un élément vide.
tableau	Affichage de tableau de type tableur (avec le composant Swing JTable). Pratique pour des tableaux de nombres, mais ne permet pas d'utiliser des élements XML à l'intérieur des cellules (utiliser tabletexte pour cela).
tabletexte	Affichage d'une table permettant d'utiliser des éléments XML dans les cellules. Gère aussi les attributs rowspan et colspan pour regrouper les cellules verticalement et horizontalement.
style	A utiliser dans le cas (très rare si le langage XML code le sens par opposition à la forme) où un élément XML ne donne qu'une information de style. Affiche les caractères dans le style choisi (gras, italique, ...), sans aucune balise. Une alternative est d'utiliser le type string, qui permet aussi de choisir un style, mais affiche les balises.
fichier	Affiche une image à partir de son chemin sur le disque issu d'un attribut de l'élément XML (à préciser). Il est possible de faire des copier/coller d'images et Jaxe créera automatiquement l'élément XML et le fichier de l'image sur le disque, en utilisant le premier élément de type fichier.
symbole	Permet de choisir une image parmi un ensemble d'images situé dans un dossier.
liste	Pour un élément correspondant à une liste à points ou numérotée. Le sous-élément doit utiliser le type item. S'affiche comme zone, avec un bouton '+' pour créer de nouveaux éléments de la liste.
item	Elément d'une liste affichée avec le type liste. S'affiche avec des points ou des numéros, en fonction du type de liste.
typesimple	Affiche un élément ayant une simple valeur, dans une petite zone particulière. Utilisable uniquement pour les éléments ayant un type simple dans le schéma XML. L'affichage précis (zone de texte, menu ou boîte à cocher) et la validation se fait en utilisant les contraintes du schéma XML.
equation	Affiche l'image d'une équation. L'équation peut être éditée par un simple clic dessus, avec un dialogue présentant en même temps le texte de l'équation (avec une syntaxe très simple propre à Jaxe) et l'image correspondante.
formulaire	Affiche un élément et tous ses sous-éléments possibles sous la forme d'un formulaire, avec un champ par sous-élément. Attention à ne pas utiliser ce type avec des éléments pouvant avoir un sous-arbre infiniment profond !
plugin	Si vous voulez définir votre propre élément Jaxe, c'est possible ! Voir la partie Création de nouveaux éléments Jaxe de la documentation pour les développeurs pour plus de précisions. En outre, certains plugins sont téléchargeables depuis cette page.

Des paramètres peuvent être utilisés, en fonction des types d'affichage, avec l'élément PARAMETRE sous AFFICHAGE_ELEMENT.

Les affichages de type division et zone peuvent avoir un paramètre indiquant le nom de l'attribut à utiliser comme titre pour l'affichage.

Les affichages de type fichier et symbole doivent avoir un paramètre indiquant l'attribut repérant le nom du fichier.

Les affichages de type tableau et tabletexte doivent avoir des paramètres indiquant les éléments repérant les lignes et les cellules.

Les affichages de type style doivent avoir un paramètre indiquant le style.

Les affichages de type zone et string peuvent avoir un paramètre indiquant le style, un paramètre avec la police de caractères, et un paramètre avec la taille des caractères.

Les affichages de type equation doivent avoir des paramètres indiquant les attributs à utiliser pour le texte de l'équation et le nom de l'image.

Voilà la liste complète des paramètres possibles:

On peut souhaiter modifier tous les textes (appelés aussi chaînes de caractères ou strings) de l'interface créée avec la configuration. Soit pour améliorer la lisibilité sans avoir à modifier le schéma, soit pour fournir une interface dans une autre langue pour le même schéma. On peut aussi souhaiter fournir les textes pour un ensemble de langues, de manière à ce que les utilisateurs puissent éditer les mêmes documents, avec la même configuration Jaxe, mais avec une interface entièrement dans leur langue.

Pour ces raisons, l'élément STRINGS représente un ensemble de textes pour une langue et un pays donné, et il est possible d'en spécifier plusieurs dans le même fichier de config. On mettra par exemple langue="pt" pays="BR" pour le portugais brésilien, ou juste langue="fr" pour spécifier la langue française sans précision sur le pays.

Si vous avez d'autres plugins à proposer, n'hésitez pas !

On supposera ici que le lecteur a déjà lu les documentations utilisateur, administrateur et sur les fichiers de configuration, et qu'il est familier de la programmation en Java.

Cette documentation explique comment utiliser Jaxe au sein d'une autre application, et comment lui ajouter des extensions pour l'affichage des éléments.

La classe de lancement de Jaxe est (sans surprise) jaxe.Jaxe. Cette classe rassemble la gestion des évènements externes à l'application (ouverture de fichier, fermeture, etc...), et on peut donc y jeter un œil pour voir comment un nouveau document Jaxe est créé ou comment un document est ouvert.

Une autre classe importante est jaxe.JaxeFrame. Cette classe correspond à une fenêtre de document XML. Elle utilise la classe jaxe.JaxeMenuBar pour la gestion de la barre de menus, celle-ci étant malheureusement (à cause d'une limitation de Java) liée à la fenêtre.

Le plus simple, pour utiliser Jaxe dans une autre application, est probablement de se servir de la classe jaxe.JaxeTextPane, qui correspond à la zone de texte dans la fenêtre XML. Comme cette classe est dérivée de java.swing.JTextPane, elle peut facilement être ajoutée où on le souhaite selon le layout de l'application hôte. Le constructeur requiert un JaxeDocument (lié au DOM) et une JFrame (la fenêtre parent).

L'objet de classe jaxe.JaxeDocument doit être initialisé avec un fichier de configuration de Jaxe (géré par la classe jaxe.Config) et éventuellement avec un fichier XML ou avec un objet DOM.

Pour récapituler, voilà une série d'instructions permettant d'incorporer une zone de texte Jaxe dans un Container parent se trouvant dans une fenêtre frame:

JaxeDocument jaxeDoc = new JaxeDocument("monlangage_config.xml");
JaxeTextPane jaxeTextPane = new JaxeTextPane(jaxeDoc, frame);
jaxeDoc.lire(urlFichierXML);
// ou jaxeDoc.setDOMDoc(documentDOM);
parent.add(jaxeTextPane);

Les éléments peuvent être insérés avec le menu contextuel, ou avec des actions jaxe.ActionInsertionBalise. Le constructeur de ActionInsertionBalise demande le document Jaxe, et l'élément DOM correspondant à la définition de l'élément dans le fichier de configuration de Jaxe.

On peut plus tard enregistrer le document avec la méthode JaxeDocument.ecrire(File f).

On appelle élément Jaxe une classe dérivée de la classe jaxe.JaxeElement, décrivant un affichage pour un élément XML donné. Les éléments Jaxe standard sont regroupés dans le package jaxe.elements. Ils correspondent à des types d'affichage des fichiers de configuration (par exemple, le type string correspond à l'élément Jaxe jaxe.elements.JEString).

La création d'un nouvel élément Jaxe se fait en créant une nouvelle classe dérivée de jaxe.JaxeElement. Il peut ensuite être utilisé dans un fichier de configuration avec le type plugin, en précisant la classe à utiliser. Par exemple:

<AFFICHAGE_ELEMENT element="BOUBOULE" type="plugin">
  <PARAMETRE nom="classe" valeur="JEBooleen"/>
</AFFICHAGE_ELEMENT>

Deux méthodes doivent impérativement être définies dans l'élément Jaxe: init et nouvelElement. Deux autres ne sont utiles que si on utilise des balises de début et de fin (comme expliqué plus loin): insPosition et (si l'élément a des attributs) majAffichage.

init est utilisé pour l'initialisation et l'insertion du composant Swing dans la zone de texte. On trouve en paramètres la position à laquelle l'élément doit être inséré, et le nœud DOM. A partir de ces paramètres, il faut insérer le composant avec la méthode JaxeElement.insertComponent(Position pos, JComponent comp).

Les choses se compliquent si on veut utiliser un composant pour une balise de départ et un composant pour une balise de fin, en laissant Jaxe traiter récursivement les sous-éléments. Il faut alors récupérer la position dans le texte après l'insertion de la balise de départ (elle est retournée par insertComponent), ajouter les enfants avec creerEnfants(Position), puis insérer la balise de fin avec un nouvel appel à insertComponent (avec l'objet Position passé en paramètre à creerEnfants. Il faut ensuite mettre à jour le style des caractères pour les balises et le texte des enfants, ce qui nécessite d'avoir conservé la position de départ avant le premier insertComponent. Voilà un exemple:

int offsetdebut = pos.getOffset();
Position newpos = insertComponent(pos, composantBaliseDebut);
creerEnfants(newpos);
insertComponent(newpos, composantBaliseFin);
if (newpos.getOffset() - offsetdebut - 1 > 0) {
  SimpleAttributeSet style = attStyle(null);
  if (style != null)
    doc.setCharacterAttributes(offsetdebut, newpos.getOffset() - offsetdebut - 1, style, false);
}

La méthode nouvelElement est appelée quand l'utilisateur insère un nouvel élément. Elle doit éventuellement demander des informations à l'utilisateur (comme par exemples les attributs), et renvoyer l'élément DOM correspondant. On peut se servir de jaxe.DialogueAttributs pour demander les attributs à l'utilisateur.

insPosition peut être appelée pour obtenir la position à laquelle sera placé le curseur après l'insertion d'un nouvel élément. Par défaut le curseur sera placé après l'élément, mais il peut être utile de le placer entre les balises de début et de fin quand celles-ci sont utilisées.

Enfin, majAffichage est appelée pour mettre à jour l'affichage quand les attributs ont été modifiés dans le panneau d'attributs.

On peut facilement ajouter un menu opérant une fonction particulière au lieu d'une insertion d'élément. Il suffit pour cela de créer une classe dérivant de jaxe.Fonction et implémentant la méthode appliquer, qui fournit le document Jaxe sur lequel on travaille, et les positions de début et de fin de la sélection dans le texte.

public void appliquer(JaxeDocument doc, int start, int end)

On peut obtenir le document DOM à partir du document Jaxe en utilisant doc.DOMdoc. On peut aussi obtenir un élément Jaxe à partir d'une position du texte avec doc.elementA(int pos), ou les éléments dans l'intervalle [start,end] avec rootJE.elementsDans(start, end). Le noeud DOM correspondant est obtenu avec JaxeElement.noeud.

<MENU nom="plugins">
  <MENU_FONCTION classe="pluginsjaxe.FonctionStatistiques" nom="Statistiques"/>
</MENU>

Les documents XPAGES comportent un élément racine, XPAGES, qui est utilisé dans tous les documents comme élément de premier niveau. Sous cet élément, on trouve les éléments INFORMATIONS, PAGE, REFXPAGES et XPAGES.

• INFORMATIONS est un bloc de métadonnées, c'est à dire des informations sur le document. Il est décrit plus loin.
• PAGE correspond à une page web, et comporte un titre et un label permettant de faire des liens vers la page.
• REFXPAGES correspond à un référence (via le label) vers un autre document XPAGES, qui doit être inclus à l'endroit de l'élément. Ceci permet de créer un site avec plusieurs niveaux : on peut par exemple créer un site avec une page d'introduction, et plusieurs ensembles de pages. Pour cela on crée un document XPAGES pour le site, contenant la page d'introduction et des références REFXPAGES vers les ensembles de pages qui constituront le site.
• XPAGES sous XPAGES permet d'ajouter un niveau à l'arborescence, comme avec REFXPAGES, mais sans créer de nouveau document.

A l'intérieur d'une page, il est possible de créer des sections avec l'élément SECTION. Cet élément comporte un titre, un rôle qui spécifie le sens de la section et peut permettre un affichage différent en fonction, et une importance qui permet de mettre en valeur la section si celle-ci est importante.

Le texte est ajouté à l'intérieur de paragraphes, avec l'élément PARAGRAPHE. Il est facile d'insérer un nouveau paragraphe avec le raccourci-clavier commande-P ou contrôle-P dans Jaxe.

Il possible de créer plusieurs contributions, chacune comprenant un fichier XML XPAGES et les fichiers attachés (images, applets Java, ...). Chaque contribution doit alors correspondre à un dossier dont le nom est égal au label donné dans le bloc INFORMATIONS du fichier XML. Ce dossier contient le fichier XML et les fichiers associés.

Le bloc d'informations renseigne sur le document, et permet aussi de choisir un habillage pour les pages qui seront générées. Il est obligatoire, et se place au début du document. Il comporte les éléments suivants :

• LABEL  : un nom permettant de référencer ensuite le document avec l'élément REFXPAGES, pour l'inclure dans un ensemble plus grand. Le label est obligatoire, et doit correspondre au nom du fichier XML sans l'extension ".xml". Dans WebJaxe, le label doit être le nom de la contribution.
• TITRE  : le titre du document (obligatoire).
• AUTEUR  : un auteur du document. Il est bien sûr possible d'en spécifier plusieurs, en mettant plusieurs éléments AUTEUR.
• DATECRE  : la date de création du document, sous la forme JJ/MM/AAAA.
• DATEMAJ  : la date de mise à jour du document, sous la forme JJ/MM/AAAA.
• LOGO  : chemin vers un fichier d'image avec un logo à utiliser pour l'affichage du site. L'image doit être dans un format standard du web (JPEG, PNG ou GIF). Il est possible d'ajouter un lien à utiliser si l'on clique sur le logo.
• INTERFACE  : choix d'un habillage pour les pages qui seront générées pour le document.
• RUBRIQUES  : permet de choisir si on veut afficher des boutons en haut des pages pour naviguer vers les sous-ensembles référencées avec REFXPAGES.
• LANGUE  : le code de la langue du document (fr pour Français).

XPAGES comporte les éléments de bloc suivants :

• SECTION  : permet d'identifier une zone à l'intérieur d'une page, en lui donnant un titre, un rôle sémantique et une importance. Le rôle est facultatif, mais est important pour donner du sens aux différentes parties du document. Il peut aussi être utilisé plus tard pour afficher les sections ayant un même rôle d'une même façon, pour les différencier visuellement.
• PARAGRAPHE  : un paragraphe est une suite de phrases. Pour "sauter une ligne" (cette idée correspondant plus à la forme qu'au contenu, elle est mise entre guillemets), il faut créer un nouveau paragraphe.
• LISTE  : une liste d'éléments (ITEM). Les éléments de la liste peuvent contenir du texte, mais aussi des paragraphes ou des sous-listes.
• TABLEAU  : un tableau constitué d'un certain nombre de lignes et de colonnes. Il est possible de spécifier une ligne de titres (la première ligne du tableau). On peut aussi fusionner des cellules, et spécifier un alignement à l'intérieur des cellules.
• ENVIMAGE  : une zone regroupant les informations liées à une image, et le fichier de l'image. En plus de l'image, on peut spécifier le crédit (l'origine de l'image, obligatoire de nos jours), et la légende. Il est également possible de spécifier un lien sur l'image, pour qu'un clic dessus redirige vers une autre partie du site ou une page externe.
• APPLET  : une applet Java, par exemple pour des simulations interactives.
• FLASH  : un objet Flash, qui peut comme une applet Java être utilisé pour ajouter de l'interactivité au site.
• COMMENTAIRE  : un commentaire de l'auteur qui ne sera pas affiché sur le site. Très utile pour indiquer par exemple des parties à développer ou corriger au moment de la rédaction.
• CODE  : un bloc de code informatique, donc le formattage doit être préservé.
• EXERCICE  : un exercice (voir plus loin).
• QCM  : un QCM (voir plus loin).
• BIBLIOGRAPHIE  : une liste de références bibliographiques et webographiques.

Certains éléments de XPAGES peuvent être mélangés avec du texte, par exemple à l'intérieur d'un paragraphe. Ce sont les éléments suivants :

• LIENPAGE  : lien vers une page du même site. Pour identifier la page vers laquelle on veut pointer, il faut renseigner le label de la contribution, et le label de la page. Si on n'indique que le label de la page, il est supposée qu'elle est dans la même contribution. Si on n'indique que le label de la contribution, le lien pointe vers la première page de cette contribution.
• LIENWEB  : lien vers une page web externe au site. L'adresse (URL) donnée doit donc commencer par "http://".
• FICHIER  : fichier d'image ou d'animation. Normalement utilisé à l'intérieur d'un élément ENVIMAGE, ce qui permet notamment de spécifier une légende, mais peut également être utilisé dans le texte (par exemple pour inclure un symbole qu'il ne serait pas possible de créer avec une équation).
• SYMBOLE  : lettre grecque ou symbole mathématique.
• EQUATION  : équation basée sur la syntaxe de l'éditeur d'équations de Jaxe.
• EQUATEX  : équation basée sur la syntaxe TeX.
• GLOSSAIRE  : mot qui renvoit au glossaire. On spécifie le mot affiché avec l'attribut mot, et la définition de ce mot à l'intérieur des balises GLOSSAIRE.
• EM  : emphase (permet de mettre en valeur un ou plusieurs mots).
• SUP  : texte en exposant
• SUB  : texte en indice
• CODE  : code informatique (généralement affiché avec une police dont toutes les lettres ont la même taille)
• NBSP  : espace insécable

XPAGES peut être utilisé pour de nombreuses applications, mais il est en particulier pratique pour créer un cours en ligne, et a été créé dans ce contexte. Pour ces raisons, le langage contient des éléments spécifiques à la définition d'exercices, même si ces éléments ne seront pas forcément utiles en-dehors du contexte des cours en ligne.

Il existe deux types d'exercices : les exercices de type question-réponse, et les QCM. Dans les deux cas, un exercice peut avoir un titre (attribut titre), un énoncé (élement ENONCE), une indication de la difficulté (élément DIFFICULTE), une indication du temps nécessaire (élément TEMPS), et des questions (élements QUESTION et QUESTIONQCM).

Chaque question peut avoir un énoncé et une ou plusieurs aides (élement AIDE). Les questions des exercices de type question-réponses ont une solution (élément SOLUTION) et un nombre de points qui peuvent être accordés si la réponse est correcte (élément POINTS). Les questions de QCM ont des réponses possibles (élément REPONSEQCM), chaque réponse pouvant être bonne ou pas (attribut bonne), avec à chaque fois le texte de la réponse (élément TEXTEREP) et un commentaire qui sera affiché si l'utilisateur choisit cette réponse, par exemple pour lui expliquer en quoi la réponse est fausse (élément COMMENTAIREREP).

Dans Jaxe, les réponses des exercices d'évaluations ne sont pas ajoutées aux fichiers HTML quand on génère le "site public". Elles ne sont ajoutées que lorsque l'on génère le "site de production". Dans WebJaxe, c'est toujours le site de production qui est généré; il faut donc exporter la contribution et l'ouvrir dans Jaxe pour générer le site public. On peut ainsi, à partir des mêmes fichiers XML, générer un site pour les étudiants, et un site pour les tuteurs d'une formation à distance.

Le document suivant présente l'ensemble des éléments du langage XPAGES, avec un index et un arbre des éléments. Il a été généré automatiquement à partir du schéma XML de XPAGES.