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"
m |
|||
| (15 intermediate revisions by 3 users not shown) | |||
| Line 3: | Line 3: | ||
== Getting started == | == Getting started == | ||
| − | * Install Gendoc update site to your existing Eclipse | + | * Install Gendoc update site to your existing Eclipse platform from [http://eclipse.org/gendoc/downloads/download.php Downloads] page |
* Restart your Eclipse platform | * Restart your Eclipse platform | ||
* From a Papyrus model, right click and select "generate document with Gendoc". Select default template and choose between a Docx (MS Word) or Odt (OpenOffice Writer) document format. | * From a Papyrus model, right click and select "generate document with Gendoc". Select default template and choose between a Docx (MS Word) or Odt (OpenOffice Writer) document format. | ||
* Select target directory in your Eclipse workspace | * Select target directory in your Eclipse workspace | ||
* Refresh your workspace and open the generated file with default system application. | * Refresh your workspace and open the generated file with default system application. | ||
| − | |||
== Tutorial == | == Tutorial == | ||
| − | Download [https://www.eclipse.org/gendoc/documentation/Gendoc_v0. | + | * Download [https://www.eclipse.org/gendoc/documentation/Gendoc_v0.6_tutorial.pdf Gendoc tutorial ] in PDF format. |
| + | |||
| + | == Samples == | ||
| + | |||
| + | * [[gendoc/samples/genericTemplate | A generic Gendoc template for Papyrus]] | ||
| + | * [[gendoc/samples/genericTemplateEcore | A generic Gendoc template for Sirius/EcoreTools]] | ||
| + | |||
| + | == Extensions / Related projects == | ||
| + | * [https://github.com/opcoach/gendocIntegration/ gendoc Integration for template generation from GUI] | ||
| + | * [https://github.com/bmaggi/Eclipse-Gendoc-Templates/ gendoc templates for SysML and RobotML] | ||
| + | * [https://github.com/atosorigin/gendoc gendoc extensions] | ||
== Developer Resources == | == Developer Resources == | ||
| − | * Contribute to Gendoc | + | * [[gendoc/developerResources/contribute | Contribute to Gendoc]] |
| − | * Architecture presentation | + | * [[gendoc/developerResources/architecture | Architecture presentation]] |
| + | * [[gendoc/developerResources/PropertiesExample | Add a Tag - the Properties example]] | ||
| + | * [[gendoc/developerResources/CommittersMeeting | Committers Meetings]] | ||
| + | |||
| + | |||
| + | == Features to come == | ||
| + | * [https://bugs.eclipse.org/bugs/show_bug.cgi?id=515404 Tables from Papyrus or Sirius] :[[gendoc/developerResources/PapyrusSiriusTables | See sample usage]] | ||
| + | * [https://bugs.eclipse.org/bugs/show_bug.cgi?id=510173 XLSX, ODS and CSV document generation ] [[gendoc/developerResources/XSLXSample | See sample usage]] | ||
Latest revision as of 11:54, 21 June 2017
Welcome to Gendoc Wiki
Contents
Getting started
- Install Gendoc update site to your existing Eclipse platform from Downloads page
- Restart your Eclipse platform
- From a Papyrus model, right click and select "generate document with Gendoc". Select default template and choose between a Docx (MS Word) or Odt (OpenOffice Writer) document format.
- Select target directory in your Eclipse workspace
- Refresh your workspace and open the generated file with default system application.
Tutorial
- Download Gendoc tutorial in PDF format.
Samples
Extensions / Related projects
- gendoc Integration for template generation from GUI
- gendoc templates for SysML and RobotML
- gendoc extensions
Developer Resources
- Contribute to Gendoc
- Architecture presentation
- Add a Tag - the Properties example
- Committers Meetings