Extract relevant elements from a diagram

I would like to introduce in this post a new feature which will be available in the next release of Gendoc2.
This feature makes possible to extract elements you desire in a diagram.

This example will generate a part of the UML Metamodel documentation.
The diagram realized with MDT Papyrus is presented bellow:

This diagram displays some information about Events, Activity Nodes and Operations. For the documentation we only want to display the elements linked to the Signal Event and the Call Event meta classes.

This is now possible using new methods in TOPCASED and GMF bundles.
This is the code to use in your gendoc2 template :

1. The diagram is get using getPapyrusDiagrams() method
2. A list of visibleElements is computed using a focused class (SignalEvent or Call Event)
• [let visibleElements : Set(uml::Class) = Set{focus}->union(focus.superClass)->union(focus.superClass->closure(superClass)->union(focus.getAssociations().memberEnd->select(type <> focus).type->asSet()))]
3. The list of visible elements is used by the getDiagram method
4. Finally the elements visible in the diagram are listed and for each element the documentation is displayed

The result is visible bellow

Gendoc2 : New attribute to simplify debug

Why adding new ID attribute?

With next version of Gendoc2 (TOPCASED 5.0.0, July 2011), you can add an “Id” into each gendoc tags as an attribute.

It identifies the tag in the document, and allows tracing an error on the tag where it is declared in order to makes debugging easier. It captures most of the errors that can occur in a script. The ID can trace the following errors:

• Incomplete tags
• Script error
• Image not executed
  
• Configuration error

How to use ids?

The ID is used by writing the keyword “id” that assigns a string (of course between simple quotes) like this: <gendoc id='my id' >...</gendoc>
If during generation an error is found in one tag, its id will appear in the details of the warning message. Here are some screenshots to explain this:

The resulting error message allows to identify exactly which tag is in error:

New version of Gendoc2 is available

Gendoc2 news

Gendoc2 has been presented during the TOPCASED Days.
Presentation is available here

v1.3.0 available
New version of Gendoc2 is available :

• inside TOPCASED 4.3.0
  
  
• from Gendoc2 update site
  
  
• on Eclipse market place: installation is now fully available from Market place Client

What's new in v1.3.0 ?
This version includes a new external bundle for usage with Papyrus models.

Gendoc2 v1.2.0 is available

New version of Gendoc2 is available on the following update site : http://topcased-mm.gforge.enseeiht.fr/release/market-place/gendoc2/update-site/

It provides support for GMF models, EPF models.
A new tag for insertion of rich text content is also available and generations can now be launched in batch mode.

New and existing features are described inside the following tutorial :
TPC_GenDoc2_v1.2.0_tutorial




Gendoc2 v1.2.0 is also available on Eclipse Marketplace

TOPCASED Days, Program Available !

The program of TOPCASED Days is now available at this address :
http://www.topcased.org/index.php/content/view/53

The description of TOPCASED Days from Patrick FARAIL:
"TOPCASED (Toolkit in OPen-source for Critical Application and SystEms Development) is a modular, open-source, Eclipse-based software environment providing methods and tools for critical embedded systems development, ranging from system and architecture specifications to software and hardware implementation through equipment definition. TOPCASED promotes model-driven engineering and formal methods as key technologies. Find out more at www.topcased.org.

Share your experiences of the TOPCASED environment at the three-day TOPCASED Days conference, which is open to industry and research communities and is aimed at users of all levels including newcomers.
TOPCASED Days provides an opportunity to exchange views with other users, present your work, and learn more about TOPCASED capabilities. conference, which is open to industry and research communities and is aimed at users of all levels including newcomers.

• Are you working in industry, using TOPCASED in pilot or commercial projects? Present a case-study of how it is used.
• Are you creating development, training, support, packaging, or maintenance services around TOPCASED? Tell us about it, and hear how similar services are used.
• Are you a teacher or researcher developing new technologies around TOPCASED? Share your successes and ideas.
• Do you have ideas for enhancing TOPCASED? Discuss your ideas with future partners and collaborators.
• Are you new to TOPCASED? Learn about its capabilities and how you can use it in your work or research.

TOPCASED experts will be present throughout the conference, giving overviews and tutorials about TOPCASED tools for newcomers, and providing feedback on the use of TOPCASED tools in both incubator and mature projects."

Concerning Gendoc2 it will be a great opportunity to show our work to TOPCASED/Eclipse community.

If you are interested in embedded software development/eclipse technologies or both I think you can be interested by this event at Toulouse the 2,3, and 4th february 2011. Of course I will be present, do you plan to come ?

Gendoc2 is in the place

Gendoc2 is now available in Eclipse Market.
It's now very easy to install Gendoc2 from an Eclipse RCP.
From an Eclipse Helios Modeling, go to the Eclipse Market Place:

Search Gendoc2:

And it's okay you can install it !

You can choose to install Gendoc2 without TOPCASED.
If you want to install TOPCASED and use its different Modelers (UML/SysML/AADL...) please fill in these update sites before in your install configuration :
http://topcased-mm.gforge.enseeiht.fr/release/update-site3.6/
http://download.eclipse.org/modeling/emft/updates/

Gendoc2 market place link

Gendoc2

Gendoc2 is an opensource solution that allows you to insert in OpenOffice or Docx document, content from EMF datasources (Models or XMLs)

The leitmotiv of Gendoc2 is What You Write in your document Is What You will Get in the generated one (WYWIWYG).

Example for this code :







After generation :




As we can see the style (Heading) of the generated text is the same as the style used for the code.

Gendoc2 offers a lot of possibility to generate Images, tables, bullets etc... For more details about gendoc2 I recommend you to read the gendoc2 tutorials available at these addresses :
Gendoc2 Tutorial
Gendoc2 Developer Tutorial

Embedded tutorial:
TPC_GenDoc2_v1.1.0_tutorial

Gendoc 2 overview

Overview

Gendoc 2 is the new TOPCASED Document generation tool.
From a document template in ODT or DOCX format, containing generation scripts (Acceleo scripts for now) and referencing EMF models, it is possible to generate full ODT or DOCX documents, containing styles and information taken from models.

Overview of the document generation process

Download and usage

Gendoc2 will be available on TOPCASED 4.0 .
Version 1.0.2 of Gendoc2 is already available on gForge as an additional Eclipse feature : http://gforge.enseeiht.fr/frs/?group_id=102.

Videos and tutorials describing install, usage and advanced functionalities can be found on http://gforge.enseeiht.fr/docman/?group_id=102#, under "Gendoc2" section.