DocFlex/Together (Lite), Version 1.1

Table Of Contents

• Overview
• Package Contents
• Technical Requirements
• Installation
  • Together 6.2 and Architect 1.x
  • Together 6.1 and 6.0
  • Together 5.x
• DocFlex Configuration Files
• Basic Templates Overview
• Getting Help

Overview

1. The freeware edition has no specific limitations on the size or content of processed Together projects nor on the output it generates.

2. The Template Designer is not included in the freeware edition. You can neither create new templates nor modify the existing ones.

3. The basic templates are built into the executable Java library as resources. So, you can use this software simply as a documentation generator for Borland® Together® without knowing much about how all this internally works.

4. The freeware edition is also able to execute any external template you have created with a licensed copy of the DocFlex Template Designer included in the full version. So, you can use DocFlex/Together (Lite) as a freeware player of your custom templates and redistribute them as you like.

Package Contents

Technical Requirements

• Borland® Together® Architect version 1.x
• Borland® Together® ControlCenter™ version 6.x or 5.x
• Borland® Together® Solo version 6.x or 5.x

Installation

Installation on Together 6.2 and Architect 1.x

The following applies to Together® ControlCenter™ 6.2, Together® Solo 6.2 and Together® Architect 1.x.

Let's the Together is installed at 'C:\Borland\Together6.2' directory on your system. Then, please follow these steps:

1. Create a folder:

   C:\Borland\Together6.2\modules\com\togethersoft\modules\docflex

   That is, 'docflex' folder within 'C:\Borland\Together6.2\modules\com\togethersoft\modules' which already exists and where most of the Together's stuff is located.

2. From the archive you've downloaded please, copy into that folder:

   lib/docflex-together-lite-1_4.jar

   As a result, you should see only one item there: docflex-together-lite-1_4.jar
   No other docflex-together-xxx.jar should be left after any previous testings!

3. Place in this folder the 'docflex.license' file (if you have one)

4. Find file:

   C:\Borland\Together6.2\config\action.config

   (This is a native Together's file!)

   Add to this file the following lines:

   action.group._docflexGroup = generic
   action.group._projectDocumentationPopup.child.30 = _docflexGroup

   Save it.

That's all. Now, Together can be started as usual.

DocFlex will install itself in the “Project | Documentation” submenu. Click “DocFlex Generator...” menu item to invoke the Generator Dialog. All necessary configuration files will be created automatically.

Installation on Together 6.1 and 6.0

The following applies to Together® ControlCenter™ or Solo version 6.1 or 6.0.

Let's the Together is installed at 'C:\Borland\Together6.1' directory on your system. Then, please follow these steps:

1. Create a folder:

   C:\Borland\Together6.1\modules\com\togethersoft\modules\docflex

   That is, 'docflex' folder within 'C:\Borland\Together6.1\modules\com\togethersoft\modules' which already exists and where most of the Together's stuff is located.

2. From the archive you've downloaded, please copy into that folder:

   lib/docflex-together-lite-1_3.jar

   As a result, you should see only one item there: docflex-together-lite-1_3.jar
   No other docflex-together-xxx.jar should be left after any previous testings!

3. Place in this folder the 'docflex.license' file (if you have one)

4. Find file:

   C:\Borland\Together6.1\config\action.config

   (This is a native Together's file!)

   Add to this file the following lines:

   action.group._docflexGroup = generic
   action.group._projectDocumentationPopup.child.30 = _docflexGroup

   Save it.

That's all. Now, Together can be started as usual.

DocFlex will install itself in the “Project | Documentation” submenu. Click “DocFlex Generator...” menu item to invoke the Generator Dialog. All necessary configuration files will be created automatically.

Installation on Together 5.x

The following applies to Together® ControlCenter™ or Solo version 5.x.

Let's the Together is installed at 'C:\Together5.5' directory on your system. Then, please follow these steps:

1. Create a folder:

   C:\Together5.5\modules\com\togethersoft\modules\docflex

   That is, 'docflex' folder within 'C:\Together5.5\modules\com\togethersoft\modules' which already exists and where most of the Together's stuff is located.

2. From the archive you've downloaded, please copy into that folder:

   lib/docflex-together-lite-1_3.jar

   As a result, you should see only one item there: docflex-together-lite-1_3.jar
   No other docflex-together-xxx.jar should be left after any previous testings!

3. Place in this folder the 'docflex.license' file (if you have one)

4. Find file:

   C:\Together5.5\config\action.config

   (This is a native Together's file!)

   Add to this file the following lines:

   action.group._docflexGroup = generic
   action.group._documentationGroup.child.10 = _docflexGroup

   Save it.

That's all. Now, Together can be started as usual.

DocFlex will install itself in the “Tools | Documentation” submenu. Click “DocFlex Generator...” menu item to invoke the Generator Dialog. All necessary configuration files will be created automatically.

DocFlex Configuration Files

docflex.config

This is the DocFlex main configuration file. It specifies:

• The locations of other configuration files used by DocFlex. Normally, they all are located in the same 'config' directory.

• The default templates directory

• The default output directory

• An external system command to open a URL. (In DocFlex/Together this command mostly not used, since when invoked from Together, DocFlex calls the Together's URL handler to launch a viewer for the generated documentation.)

When DocFlex starts, it searches the main config file in the same directory where the DocFlex Java library file 'docflex-xxx.jar' is located. If not found, docflex.config is created automatically with the default settings.

generator.config

This file is created automatically by the Documentation Generator (when started from Together). It contains all the settings specified when the generator dialog was invoked the last time. This includes:

• The last used template file
• The template parameters
• The last used output directory
• The output format options

When the generator dialog is invoked next time, those settings are restored from the generator.config, so you don't need to re-enter them again. The values of template parameters previously specified for one template will also be loaded into the equally named parameters of other templates.

You can also use generator.config file as a parameter when starting the Documentation Generator from the command line (or in a batch mode).

Basic Templates Overview

This is a batch template (it calls from itself many other templates) which allows 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)
• The Diagram Documentation for the following diagram types:
  • Class Diagram
  • Use-Case Diagram
  • Component Diagram
  • Deployment Diagram
  • Sequence Diagram
  • Collaboration Diagram
  • State Diagram
  • Activity Diagram
  • Entity Relationship Diagram
  • Business Process Diagram
  • Robustness Diagram
• The User Interface Documentation (Together 6.x or Together Architect 1.x only)

  Note:  To allow generation of UI Documentation:

  1. The Together UI Builder module should be activated (see 'Tools | Activate/Deactivate Feature')
  2. The template parameter 'Generate UI Documentation' should be selected

The ProjectDoc.tpl template supports the following generation scopes:

All	the whole project
Current package	relatively to the current diagram
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 only for specific classes or diagrams (for instance, you may document just a single class if you need).

This is a version of ProjectDoc.tpl template which allows to generates a framed interactive documentation for your project. This template is supported only by HTML output format.

These templates are reduced versions of ProjectDoc.tpl/ProjectDocFrames.tpl. They allow to generate only Class Documentation (Class Diagrams included).

The difference is that both templates are for free. That means, the documentation generated with those templates will not contain any evaluation markers.

(The ProjectDoc.tpl/ProjectDocFrames.tpl templates will produce documentation with the evaluation insets unless you purchase a commercial/academic license.)

Getting Help

Check the latest releases and documentation updates at: www.filigris.com.