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
| Line 1: | Line 1: | ||
== Generic gendoc template for Papyrus == | == Generic gendoc template for Papyrus == | ||
| − | if you are a Gendoc newcomer you can try to start using Gendoc with this project : [[File:SampleGendocProject.zip]] | + | === Import and Run === |
| + | if you are a Gendoc newcomer you can try to start using Gendoc with this project : [[File:SampleGendocProject.zip | A sample Eclipse Project]] | ||
| + | |||
| + | 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. | ||
| + | |||
| + | === Template description === | ||
Revision as of 11:17, 30 November 2016
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.