Skip to main content


Eclipse Community Forums
Forum Search:

Search      Help    Register    Login    Home
Home » Modeling » Papyrus » Image / document generation from model
Image / document generation from model [message #881718] Tue, 05 June 2012 06:41 Go to next message
Konstantin Ribel is currently offline Konstantin RibelFriend
Messages: 7
Registered: May 2012
Junior Member
Hello all,

at work I am using IBM Rational Rhapsody RerporterPLUS to generate a good readable documentation from my Rhapsody model.

Is there a way do generate images from diagrams or even full documentation form Papyrus models?

Many thanks,
Konstantin
Re: Image / document generation from model [message #881739 is a reply to message #881718] Tue, 05 June 2012 07:20 Go to previous messageGo to next message
Tristan Faure is currently offline Tristan FaureFriend
Messages: 443
Registered: July 2009
Senior Member
Hi !
There is a tool able to generate documentation (odt/docx) from EMF Models and Papyrus diagrams.
It is named Gendoc2.

Gendoc2 works using M2T Acceleo code in a docx or odt template. Gendoc2 is able to keep the styles you have inserted in your dynamic parts.

You can find information and screenshots at this website : http://eclipseatos.blogspot.fr/search/label/Gendoc2
and documentation here : http://www.topcased.org/index.php?documentsSynthesis=y&Itemid=59
You can download it using Eclipse Market Place : http://marketplace.eclipse.org/content/gendoc2 but the version is not yet the latest one.
I recommend you to test it using TOPCASED which integrates Papyrus : http://www.topcased.org/index.php?idd_projet_pere=52&Itemid=60

If you have questions or remarks feel free to ask




Re: Image / document generation from model [message #1795780 is a reply to message #881739] Fri, 28 September 2018 13:54 Go to previous messageGo to next message
pxDoc Team is currently offline pxDoc TeamFriend
Messages: 7
Registered: September 2018
Junior Member
No Message Body

[Updated on: Fri, 28 September 2018 14:11]

Report message to a moderator

Re: Image / document generation from model [message #1795783 is a reply to message #881739] Fri, 28 September 2018 14:09 Go to previous message
pxDoc Team is currently offline pxDoc TeamFriend
Messages: 7
Registered: September 2018
Junior Member
Hi,

You can also use pxDoc and its integration with Papyrus.

pxDoc is a new way of generating documents with a dedicated language (only ~30 keywords) integrated with the Java world. Since pxDoc works on the Java level directly, you can take any Java object as input for your generation. You can have a look at the pxDoc documentation, and the pxDoc-Papyrus integration.

Querying diagrams is very simple with pxDoc:
// diagrams owned by the 'model' object
var List<Diagram> ownedDiagrams = queryDiagrams(model).execute;
                                 
// all diagrams owned directly and indirectly by the 'model' object
var allOwnedDiagrams = queryDiagrams(model).searchNested.execute;
                                 
// diagrams owned by the 'model' object, with some content
var ownedNonEmptyDiagrams = queryDiagrams(model).notEmpty.execute;
                                 
// look for a diagram owned by 'model' and named 'A diagram name'
var diagramsByName = queryDiagrams(model).name('A diagram name').execute;
                                 
// look for a diagram owned by 'model' with name staring with 'ABC'
var diagramsByNameStartingWith = queryDiagrams(model).nameStartsWith('ABC').execute;


as well as inserting diagrams:
// Get a list of matching diagrams
var List<Diagram> myDiagrams = queryDiagrams(model).execute;
                                 
// insert the list of diagrams with the provided 'includeDiagram' template from the DiagramServices common module
apply includeDiagram(myDiagrams)

// or insert the diagram by yourself with a custom script:
for (diagram : myDiagrams) {
    // use the pxdoc 'image' keyword with diagram image file path 
    image path:diagram.path  
    // add a title with a style 'Figure'
    #Figure keepWithNext align:center {
        diagram.name
    }
    // include the diagram documentation if any
    if (!diagram.documentation.empty) {
        #BodyText {diagram.documentation}
    }
}


Note that you will need to install Xtext and pxDoc before installing the pxDoc-Papyrus integration.

Have fun with pxDoc !

Kind regards,
the pxDoc Team
Previous Topic:Generation of Documentation
Next Topic:Generate a property view from a UML Profile
Goto Forum:
  


Current Time: Tue Jan 28 06:48:39 GMT 2020

Powered by FUDForum. Page generated in 0.01488 seconds
.:: Contact :: Home ::.

Powered by: FUDforum 3.0.2.
Copyright ©2001-2010 FUDforum Bulletin Board Software

Back to the top