Notice: This Wiki is now read only and edits are no longer possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Gendoc/samples/genericTemplateEcore
< Gendoc
Contents
Generic gendoc template for Sirius / Ecore tools
Gendoc version prerequisites
To run the template, Gendoc 0.6.0 or higher is required (because of properties tag usage)
Sirius Gendoc Bundle is also required
Import and Run
if you are a Gendoc newcomer you can try to start using Gendoc with this project : File:SampleGendocProjectSiriusEcore.zip
This project can be imported in your workspace using File > Import ... > General > Existing Projects into Workspace
It exists 2 important folders in this project :
- model : contains the ecore model and representation
- template : contains the generic gendoc template and conf.properties can be used to change the input model or the output path
To run the documentation generation you just have to right click on SampleProject/template/gendoc_generic.docx > Generate documentation using Gendoc
Don't forget to
- refresh the generated folder after generation
- update the document fields when you open the result of the generation (Ctrl + A, F9)
Template description
This template uses Gendoc capabilities :
- take the root element of the model
- for each package and their children insert the diagram and the associated comment of the package
- for each element displayed in each diagram, the documentation is displayed in a table