Does DocGen solve your problem? Does it fits to your needs? Is it useful? Any suggestion? Please tell us your opinion and needs and we will study them.
DocGen Wiki¶
| Name | DocGen Plugout for Bouml |
| Authors | Nicolas Bertet (Project Manager / Function Responsible) |
| José Manuel Portero García (Designer / Developer) | |
| Most recent version | Version 1.0.3 |
| Availability | Bouml 4.13.1 / OpenOffice 2.4 |
| State | Improving functionality |
| License | GNU General Public License v.3 |
| Download sources | Sources Subversion URL login: anonymous password: anonymous |
| Download binaries | Binaries |
Compatibility¶
| Compatibility with Bouml | ||||
| Plugout version | 4.11 | 4.12.x | 4.13.x | 4.16.2 |
| 1.0.3 |  |
|
 |
|
| Compatibility with OpenOffice | |||
| Plugout version | 2.4 | 3.0 | 3.1 |
| 1.0.3 | |
|
|
| Compatibility with Java | |||
| Plugout version | J2SDK/J2RE - 1.4 | JDK/JRE - 5.0 | JDK/JRE - 6 |
| 1.0.3 | |
|
|
| Compatibility with Operating Systems | |||||||
| Plugout version | Windows XP | Windows Vista | Windows 7 | MacOS | Ubuntu | Debian | Other Linux Distributions |
| 1.0.3 | |
|
 |
|
|
|
|
Description / Features¶
DocGen is a Bouml plugout that allows you to generate automatically OpenUP documentation. It's a practical tool that allows you to update dynamically the documentation of your project.
DocGen extracts text and diagrams from a Bouml project and inserts them in a OpenOffice Document. It's preconfigured with a generic template and three definition files of Analysis, Design and Architecture OpenUP based documents. It allows to insert predefined tables and link external images to insert in the document.
You can define your own template and file definitions. It's as easy as writing a OpenOffice Writer document and editing a XML file respectively.
Requirements¶
- Ubuntu / Debian (maybe others but not tested) or Windows XP/Vista
- Java Runtime Environment. Version 5 or Version 6.
- OpenOffice 2.4 / OpenOffice 3.1
- Bouml >=4.13.1
Installation¶
Copy docgen.jar in your Bouml directory (usually /usr/lib/bouml if you use Linux or C:\Program Files\Bouml if you use Windows). Open Template_UP and save a copy for your use. It contains several classes, text, and contents to test the document generator. You can delete and replace some of them to generate the documents of your software project.
- docgen.jar contains source code, document template and document definitions. It's able tu run on Windows and Linux (Ubuntu and Debian tested).
- Template_UP is a project compatible with the definitions of the generic template. It's configured with tools to generate documents, link images and launch user interface extensions to fill tables. If you use Windows, replace the tools file for the Windows adapted version.
Screenshots and results¶
You can see several screenshots of this application:
Bouml browser with template.¶
User interface extension.¶
Image linker.¶
Generating analysis document.¶
Resulting documents:¶
These are examples of generated documents: Analysis_Document.odt, Design_Document.odt, Architecture_Document.odt
Source code¶
The last version is version:1.0.2 and you can download source code from Functionality is divided in two projects: OpenOfficeAPI and DocumentGenerator.
- OpenOfficeAPI: It's a simple API to insert contents in a OO Writer documents. It uses the classes explained in StarOffice Programming Guide. Originally, it needs to copy four jars in OpenOffice lib directory, but we have modified Bootstrap.java class to avoid it.
- Document Generator: It includes an Java empty plugout to implement communication with Bouml and packages to implement definition readers. It reads XML definitions, searches contents in Bouml browser and write them in a ODT document. You can modify the document afterwards.
Definition files¶
Definition files tells you how to fill the document. You define:- Document properties and variables.
- Static text.
- Descriptions (long text in item).
- Diagrams (PNG images).
- Images (External images).
- Tables.
Sample use¶
- Open template and select options "Generate Analysis Document", "Generate Design Document" or "Generate Architecture Document".
- Images can be added in the XML file as <image> item. You can also add one in a "view". You should do this:
- Create a package and stereotype it as "image".
- Call plugout "Link External Image". (NOTE: Sometimes it fails if it's in home folder).
- If you want, you can add a description of the image in the package description.
- Try to open a user interface extension in one of these paths:
/Documents/Analysis Model /Documents/Design Model /Documents/Architecture Model /Documents/Analysis Model/Documents /Documents/Design Model/Documents /Documents/Architecture Model/Documents /Analysis Model/Logic View/Use Case Analysis/Mapping Analysis Mechanisms to Analysis Classes /Design Model/Architecture Design/Mechanisms and Frameworks/Analysis, Design and Implementation Mechanisms /Design Model/Architecture Design/Logic View/Design Elements/Mapping Analysis Classes to Design Elements /Design Model/Architecture Design/Logic View/Design Elements/Mapping Design Elements to Proprietary Packages /Design Model/Architecture Design/Quality Factors
Known bugs and TODO¶
- Sometimes images are generated with an incorrect size.
- Sometimes index pages are not correctly updated.
- Sections "Changes Register" and "Document Distribution" of the document extension are not printed in the document.
- Implement configuration windows to select an external XML definition file and template.
Guides and documents¶
Detailed installation guide for Ubuntu and Debian
Interpret Definition Files
How to implement OpenUP with Bouml and DocGen
