Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "Gendoc/samples/genericTemplate"
< Gendoc
(→Import and Run) |
|||
| Line 13: | Line 13: | ||
To run the documentation generation you just have to right click on SampleProject/template/gendoc_generic.docx > Generate documentation using Gendoc | 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. | + | ''Don't forget to refresh the generated folder after generation.'' |
| + | ''Don't forget to update the document fields when you open the result of the generation (Ctrl + A, F9) | ||
| + | |||
| + | === 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, if this element has a diagram the will be displayed | ||
=== Template description === | === Template description === | ||
Revision as of 11:20, 30 November 2016
Contents
Generic gendoc template for Papyrus
Import and Run
if you are a Gendoc newcomer you can try to start using Gendoc with this project : File:SampleGendocProject.zip
This project can be imported in your workspace using File > Import ... > General > Existing Projects into Workspace
It exists 3 folders in this project :
- models : contains a sample Papyrus model
- template : contains the generic gendoc template and conf.properties can be used to change the input model or the output path
- generated : the default output path for generation
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. Don't forget to update the document fields when you open the result of the generation (Ctrl + A, F9)
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, if this element has a diagram the will be displayed