Eclipse Gendoc 0.5.0 Release Review

Type
Release
State
Successful
End Date of the Review Period

Reviews run for a minimum of one week. The outcome of the review is decided on this date. This is the last day to make comments or ask questions about this review.

Project
Eclipse Gendoc
Release

0.5.0

Description

 

Gendoc extracts data from EMF or GMF models and generates DOCX and ODT documents that fully respect the appearance of initial document template.

  • Styles defined in the template are kept after generation, both on static parts from template and from dynamic parts (generated from EMF model data)

     
  • Through dedicated tags in template, Gendoc handles:

    - Pictures

    - Tables

    - Hyperlink
  • Gendoc template scripts are written using Acceleo syntax. 

     
  • Gendoc extends the generation possibilities in adding the possibility to create their own Acceleo services, used in templates and may call Java library.

 

Architectural Issues

Gendoc generator provides extensibility through extension point mechanism for the following points :

Output document format : DOCX and ODT

Template script language : Acceleo only for now

Gendoc template tags : each tag is referenced through an extension and is associated to a dedicated TagHandler

Gendoc services  : each document service (logger, document parser, tag parser, tag handler, …) is referenced through an extension and services implementations are also referenced through extensions

Note : this mechanism has been developed on Eclipse 3.X and is not compatible with Eclipse 4.X service injection mechanism.

Security Issues

Nothing to report

Non-Code Aspects

The user documentation, how-to and tutorial for gendoc is provided and maintained in wiki https://wiki.eclipse.org/Gendoc. 

 

Usability Details

Gendoc extracts data from EMF or GMF models and generates DOCX and ODT documents in order to :

Specificy or design document from models

Get test plan from a model containing Test scenarii

Get interface configuration document

Describe data structure from specific EMF models

 

Gendoc template scripts are written using Acceleo syntax.

 

End of Life

N/A

Standards

Gendoc requires Java 1.6 or later and is based on EMF, Acceleo and MDT Papyrus components.

Communities

Developers

4 committers

1 contributor: CEA

Users

Gendoc is currently used in several contexts (avionics, space, public services) to produce various kinds of documentation. User feedback is used to plan new features and maintenance issues.