Gendoc project is a proposed open source project under the Eclipse Modeling Project.
This proposal is in the Project Proposal Phase (as defined in the Eclipse Development Process) and is written to declare its intent and scope. We solicit additional participation and input from the Eclipse community. Please send all feedback to the Eclipse Proposals Forum.
Model-driven engineering and Model-based development technologies are more and more used but documentation is still necessary as it is generally part of the contract agreement. The idea is to keep only one repository—the model—and to generate document from it.
The main issue of writing documentation linked to a model and diagrams is the synchronization between the document content and the model content, that can be solved by generation from models. The other issue is the style of the generated document, that must often fit exactly an industrial template.
Gendoc has been developed in order to offer an Open Source solution to both problems by generating a document from a document template written directly in the target format (OpenXML or OpenDocument), using EMF models as datasources : the generated document keeps both style and model content synchronization.
Gendoc generates documentation for EMF models using document templates in formats such as OpenOffice Writer (.odt) or Microsoft Word (.docx).
Generated documents display data extracted from the model with features such as:
The framework can be extended to add custom generation facilities.
Gendoc extracts data from EMF models and generates documents that fully respect the appearance of your document template.
The generation can be performed in a few steps:
|Get or write a standard template document in OpenOffice Writer (.odt) or Microsoft Word (.docx) format,|
|Add script sections to get dynamic content from models : each dynamic section of the template contains a script written in M2T Acceleo language,|
|Reference the model as datasource,|
|Launch the generation directly from the template|
|The generation result fully respects the template document, with all dynamic sections filled with model content|
Styles defined in the template are kept after generation, both on static and dynamic parts.
Gendoc is currently used in several contexts (avionics, space, public services) to produce various kinds of documentation:
This project is based on top of Eclipse-based technologies : EMF and M2T technologies (compatible with M2T Acceleo for now), and it is already compatible with Eclipse MDT Papyrus through a dedicated extension.
Gendoc has links with EMF and Acceleo as they are key technologies used to define queries and extract data from models. We can also mention links with GMF so that we can generate images from GMF editors. And links with Papyrus so that we can generate images from Papyrus diagrams or extract documentation from UML comments.
All contributions will be distributed under the Eclipse Public License.
The following individual is proposed as leader of the project:
The following individuals are proposed as initial committers to the project:
We welcome additional committers and contributions.
The following Architecture Council members will mentor this project:
The following individuals, organisations, companies and projects have expressed interest in this project:
|30-September-2013||Update description section|
|11-November-2013||Second mentor added|
Back to the top