Multi-level, Flexible Documentation Generation

Documentation generation is not supported in Together Whiteboard.

Direct diagram printing with preview

This is not exactly documentation generation, but you can print any open diagram, including linked diagrams, directly to a printer or plotter. To try it, open a diagram, choose File | Print Diagram, set printout specifications in the dialog, and you're done.

Direct documentation printing with preview

You can print project documentation directly to your printer or to a PDF file. You can select just the current diagram, the current package (optionally with its subpackages) or everything. To try it, open a project, choose Tools | Print Documentation, set printout specifications in the dialog, and you're done.

Net-ready documentation generation with Javadoc support

Generate on-line doc painlessly, delivering doc compatible with Java 2's Javadoc(tm) standard, adding all UML diagrams and all specification text. To try it out:

Open a project (for example $TGHOME$/samples/java/cashsales.tpr).
On the Main menu choose Tools | Documentation | Generate HTML.
Click OK in the dialog to generate doc to the specified target directory. By default, your browser launches on completion of doc gen. To view doc later, run your web browser and load the file index.html in the directory you specified for HTML output.

Generate high-quality, up-to-date, net-ready doc with results like this

RTF documentation generation

You can generate project documentation in Rich Text Format using any of the pre-fabricated doc-gen templates provided with Together. Of particular interest are the Class Report and Project Report templates.

To try it out:

Open a project
Choose Tools | Documentation | Generate using Template
Select the Current package option (this will speed things up for now)
In the Output format list, choose RTF.
Uncheck the Include Elements from Classpath option (again to speed things up)
Click OK.

The generated RTF document opens in the application registered on your system for editing RTF documents.

Template-based RTF documentation results

Visual template designer: create fully custom reports based on templates

The Project Report template, included with Together, was used to create the documentation shown in the figure above. That template was designed with Together's built-in Documentation Template Designer. Similar to a banded report writer, this tool enables you to create custom documentation content and formatting derived from information contained in your model (which is expressed in source code, don't forget!)

You will probably want to get to know Together's modeling features and API before you tackle this power tool in depth. Here's how you can check it out.

On the Main menu choose Tools | Documentation | Design Template to open the Template Designer.

In the Template Designer, choose File | Open.

Open any of the sample templates to see how they're constructed.

The integrated doc template designer showing one of the included sample templates

Docgen tips

Some diagrams may be so large that some HTML browsers cannot handle the size of generated GIF images in HTML doc output. In such cases, you can exclude diagrams from doc gen by unchecking the Include Diagrams option in the dialog. Note that when you save a diagram, Together generates a Metafile (with the extension .wmf), containing a graphical snapshot of the diagram, in the same folder. You can optionally insert those files into your documentation using a compatible application.
Using the Together API you can write custom modules to generate any output format you want- RTF, XML, or proprietary formats including templates. Because Java itself is the scripting language your possibilities are virtually limitless.
You can incorporate documentation generation into an automated daily build process by accessing Together's doc gen facility through the command-line interface.