B2HTML

• Introduction
• État du projet
• Compilation et exécution
• Fonctionnement
• Documentation
• Notes

Introduction

L'application B2HTML a pour but de créer une représentation HTML d'un projet B.
Elle prend en entrée les fichiers XML résultants de la compilation d'un projet B et fournit en sortie un ensemble de fichiers HTML.
De plus, la représentation produite est affichée au sein de l'application une fois la génération des fichiers HTML achevée.

État du projet

Bien que l'application fonctionne, voici quelques "bugs" connus :

• L'affichage de la représentation HTML ne se fait pas si le chemin de sortie comporte des espaces, bien que les fichiers y soient tout de même produits. Cette limite provient du fonctionnement de la classe java URL.
  

• On peut bien évidemment utiliser l'application pour générer successivement des représentations HTML de différents projets B, cependant, si deux projets différents sont générés successivement dans le même répertoire de sortie, l'affichage de la page HTML au sein de l'application ne sera pas rafraîchie. Cette limite semble inhérente au composant Java qui affiche les pages HTML. Dans le cas où le répertoire de sortie est différent, l'affichage se fera sans problèmes.

Compilation et exécution

Les fichiers sources sont situés dans les sous-répertoires du répertoire Src :

• le lanceur se trouve dans le répertoire Main (Lanceur.java)
• la B Object Library se trouve dans le répertoire BClasses (bol.java)

Les fichiers class sont placés dans le répertoire Bin.

Compilation :

Pour faciliter les choses, une compilation automatique à été définie :

A partir du répertoire racine du projet :

Ces commandes vont lancer la compilation automatique du projet par l'intermédiaire de l'outil de compilation JMK (Java MaKer).
Les fichiers sources vont être compilés, et une archive JAR (Java ARchive) exécutable va être produite.

Exécution :

A partir du répertoire Bin ou vous vous trouviez pour compiler le projet :

Fonctionnement :

L'application est composée de trois boutons et d'un panneau d'affichage :

Comme indiqué sur la figure ci-dessus, vous devez choisir le répertoire où se trouvent les fichiers XML de votre projet et celui où les fichiers HTML doivent être produits.
Cela se fait simplement via les deux boutons correspondants (i.e : 'Choose source directory' et 'Choose destination directory')

Le choix de ces répertoires se fait par l'intermédiaire d'un explorateur de fichiers :

Finalement, le lancement de la création des fichiers HTML se fait par l'intermédiaire du bouton 'Go!'.
La liste des fichiers traités est affichée sur la sortie standard. Une fois les fichiers produits, la page d'index de l'ensemble des pages HTML est affichée dans le panneau :

Il est possible de naviguer au travers des différentes pages via les liens hypertextes.
En bas de chaque page se trouve un lien 'Back to main page' pour revenir à la page principale.

Documentation :

Pour créer la documentation de l'application au format Javadoc, à partir du répertoire Bin :

Le paramètre indiqué entre crochets est facultatif.

La documentation sera alors créée dans un répertoire javadoc dans la racine du projet.

Pour plus de simplicité, deux scripts nommés respectivement doc.bat et doc.sh peuvent être utilisés pour créer la documentation selon l'environnment utilisé (Windows ou Linux).

Notes :

La version de Java utilisée pour le développement de ce projet est la 1.4.0-rc (Sun Microsystems Inc.)
L'application a été testée sous Windows XP.

Retour