Index: topia/doc/manuelUtilisateur.rst diff -u /dev/null topia/doc/manuelUtilisateur.rst:1.1 --- /dev/null Fri Sep 24 15:47:17 2004 +++ topia/doc/manuelUtilisateur.rst Fri Sep 24 15:47:12 2004 @@ -0,0 +1,115 @@ +============================================= +Guide de création d'une application via topia +============================================= + +:Version: $id$ +:Author: Pierrick Thibault + + +Prérequis +========= + +- Avoir maven installé avec le plugin maven-topia-plugin. Voir sur Labs_ pour la récupération des projets. + + +Création du modèle +================== + +On peut utiliser n'importe quel outil UML permettant la génération de fichiers d'export au format XMI. + +Quelques conseils : + +- Seul le diagramme de classes sera pris en compte +- Les classes devant être persistées doivent avoir le stéréotype *entity* +- La documentation des objets UML se retrouve dans la javadoc. On a donc tout intérêt à enrichir celle-ci au maximum. + + +Etape préliminaire : génération du squelette du projet +====================================================== + +- Créer un répertoire racine du projet qu'on souhaite générer. On l'appellera *PROJECT_ROOT*. + +- Se placer dans *PROJECT_ROOT* et lancer la commande:: + + maven topia:genskel + + Et répondre aux questions posées par l'utilitaire (nom du projet ...) + +Cette opération va générer l'ensemble de l'arborescence du projet ainsi que le fichier ''project.xml'' contenant une bonne partie de la description du projet. On pourra éditer ce fichier pour renseigner le tag '''' du projet par exemple. + + +Paramétrages préliminaires +========================== + +Les modifications s'effectue dans le fichier project.xml. + +Base de données +--------------- + +Adaptez la rubrique de dépendance suivante à votre base de données. + +:: + + postgresql + postgresql + 7.4.1-jdbc3 + + + + + +Génération +========== + +*Points dus à des anomalies non corrigées de topia:genskel* +- Ouvrir maven .xml et ajouter les lignes suivantes : + + :: + + + + + note : modif commitée dans maven-topia-plugin +*fin Points dus à des anomalies non corrigées de topia:genskel* + +- Se placer dans *PROJECT_ROOT* et lancer la commande:: + maven + +Tout ce qui est généré par ToPIA se trouve dans le répertoire *PROJECT_ROOT*/target. On y trouvera l'arboresscence suivante : + +:: + + +--classes + +--gen + | +--java + | +--objectmodel + | +--uimodel + | +--xmi + +--src-build + | +--conception + | +--java + | +--objectmodel + | +--test + | +--uimodel + | +--xmi + +--test-classes + +--test-reports + +avec principalement : + +- à la racine un jar issu de la compilation des classes générées, + +- *classes* : compilation des classes générées + quelques fichiers de ressources (*.jdo par exemple) + +- gen/java : classes générées + + +Paramétrages +============= + +Paramétrage de la base de données +--------------------------------- + + + +.. _Labs: http://labs.libre-entreprise.org \ No newline at end of file