Plan documentation EUGene 2.0
=============================

:Authors: jruchaud, fdesbois
:Date: 18 fév. 2010
:Version: 1.1

- Introduction

  * C'est quoi le MDA
  * Philosophie d'Eugene
  * Comparaison avec les solutions existantes (acceleo)

- MétaModel: ObjectModel

  * Présentation
  * Comparaison EMF/MOF

- Processus de génération

  * Générateur
  * Transformation de modèle

- Template

  * Syntaxe des générateurs
  * Implantation d'une transformation de modèle
  * Générateur en Java

- Fonctionnalités avancées

  * Writer
  * Reader
  * Extension

- Build

  * Ant
  * Maven

- Glossaire

- Tutoriels
  
  * Tutoriel 1 : Création d'un modèle UML avec résultat ObjectModel
  * Tutoriel 2 : Création d'une template de génération (Generator)
  * Tutoriel 3 : Création d'un transformer de modèle pour Java (ObjectModel to ObjectModel)
  * Tutoriel 4 : Création d'un reader pour charger l'ObjectModel
  * Tutoriel 5 : Création d'un transformer pour un autre modèle que l'ObjectModel (ObjectModel to ?)
  * Tutoriel 6 : ...

- FAQ

Introduction
------------

Ressource : jruchaud?

- Revoir DiscussionSurTypeDeGeneration.rst

MétaModel : ObjectModel
-----------------------

Présentation
~~~~~~~~~~~~

Ressources : jruchaud?, fdesbois

- Revoir ObjectModel.rst
- Diagramme de classes vu MetaModel (ObjectModel.png)
- Diagramme de classes réel (implantation) (ObjectModel_interfaces.png)

Comparaison EMF/MOF
~~~~~~~~~~~~~~~~~~~

Ressource : jruchaud?

Processus de génération
~~~~~~~~~~~~~~~~~~~~~~~

Ressource : fdesbois

- Diagrammes d'activités : processus standard, processus avec transformer, processus java

Template
--------

- Diagramme de classes sur l'héritage entre Template, Generator, Transformer, ...

Syntaxe des générateurs
~~~~~~~~~~~~~~~~~~~~~~~

Ressource : jruchaud?

- Utilisation de nuiton-processor
- Pattern generateFrom ...


Implantation d'une transformation de modèle
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Ressource : fdesbois

- Entrée du transformer (model)
- Sortie du transformer (template, model)
- Pattern transformFrom
- ObjectModelTransformer
- ObjectModelBuilder

Générateur en java
~~~~~~~~~~~~~~~~~~

Ressource : fdesbois

- JavaGenerator
- ObjectModelTransformerToJava
- JavaBuilder
- ImportsManager

Fonctionnalités avancées
------------------------

Writer
~~~~~~

Ressource : tchemit?

- Principe de chaînage

Reader
~~~~~~

Ressources : fdesbois, echatellier?

- Utilisation de digester
- ObjectModelReader / StateModelReader

Extension
~~~~~~~~~

Ressources : tchemit?, fdesbois

- extension de l'ObjectModel
- extensions pour Java : imports, annotations, constantes, ...

Build
-----

Ant
~~~

Ressource : echatellier?

- plugin eclipse ???

Maven
~~~~~

Ressource : tchemit?

- Documentation existante : maven-eugene-plugin

Divers
------

Glossaire
~~~~~~~~~

Ressources : tout le monde

- A compléter au fur et à mesure

FAQ
~~~

- Reprendre existant + compléments si besoin

Tutoriels
~~~~~~~~~

- Cas concrets, en attente car très long à produire

Traduction anglais
~~~~~~~~~~~~~~~~~~

Ressource : jcouteau?