FlexDoc/Together - Templates
Most of the Together-specific features found in the generated documentation come from templates being used. Here, we shall discuss the basic templates provided with the FlexDoc/Together and what documentation can be generated with them.
1. ProjectDoc.tpl
This batch template (it calls from itself a lot of other templates) was designed to generate a single-file documentation for almost everything contained in your project. It is supported by all available output formats and may be especially useful when the generated documentation is intended for printing (RTF output).A lot of parameters provided by this template allow to adjust the documentation generation within a wide range of included details (from the most detailed project documentation to just overview with summaries of the contained packages and diagrams).
Currently, the following kinds of documentation can be generated with this template:
- The detailed Class Documentation (similar to that produced by Javadoc). See screenshots.
-
The Diagram Documentation for the following diagram types:
The remarkable feature of the Diagram Documentation generated in RTF output format is that, at last, all diagram images are properly scaled to fit the page size. Moreover, the big diagrams will be automatically rotated into "landscape" orientation in order to minimize the image scaling (this feature can be disabled, of course). See screenshot to find how it looks.UML Diagrams Class Diagram screenshots Use-Case Diagram screenshots Component Diagram same as Deployment Diagram Deployment Diagram screenshots Sequence Diagram The Objects are sorted according to the sequence numbers and the sequences themselves are highlighted in a separate section. See screenshots. Collaboration Diagram same as Sequence Diagram State Diagram screenshots Activity Diagram screenshots UML Extension Diagrams Entity Relationship Diagram screenshots Business Process Diagram Robustness Diagram screenshots - The User Interface Documentation (Together 6.x or Together Architect 1.x only). See screenshots.
| All | the whole project |
| Current package | relatively to the current diagram selected in Together |
| Current package with subpackages | relatively to the current diagram |
| Current diagram | |
| Selected elements on current diagram | The selected elements may be Class nodes or shortcuts to other diagrams. This allows to generate documentation for only specific classes or diagrams (for instance, you may document just a single class if you need). |
2. ProjectDocFrames.tpl
A yet another batch template, which is basically a version of the ProjectDoc.tpl template that allows to generates an interactive framed documentation for your Together projects. This template is supported only by HTML output format.The generated framed documentation is extensively hyper-linked, so you can traverse it all around. Some hyperlinks may load several frame windows at once.
See a live example of such a documentation.
3. ClassDoc.tpl / ClassDocFrames.tpl
These two templates are reduced versions of ProjectDoc.tpl and ProjectDocFrames.tpl templates.
They allow to generate only Class Documentation (Class Diagrams are included).
The purpose of those templates is that in the Lite Edition of this product both are provided for free. That means, you can use them without having to pay anything. The documentation generated with those templates will not contain any evaluation markers!