Together Control Center Together Enterprise Together Solo Together Whiteboard
Version 4.2

Thank you for choosing the Together family of enterprise development solutions from TogetherSoft... and welcome to the fast-growing community of system architects, object and component designers, engineers, and project leaders who are adopting Together as the control center for their eCommerce development. For latest version updates, product sales and tech support information, please visit: www.togethersoft.com.

Using the Documentation

This topic provides basic information about Together's documentation. There is information about the choices of formats and organization of volumes. There's also information about other documentation provided separately from Help.

Available formats

Together provides a choice of electronic Help documentation formats.

JavaHelp(tm)	Installed with all products. Provides Table of Contents, Index, and Full-text Search. Requires the Sun JRE and JavaHelp runtime (both installed with Together).*
Adobe Acrobat (PDF)	Available for download at www.togethercommunity.com. Requires Adobe Actobat Reader, available free at www.adobe.com. Same content as Together Help documentation for those who want to print hard copy. (No internal hyperlinking.)

* (Note: URLs for Web resources are provided as text only, as JavaHelp does not currently support hyperlinking to external targets.)

Help documentation volumes

On-line Help documentation is organized into several "volumes" each with a particular focus.

Getting Started Guide	Covers general installation issues and tells you where to find the latest platform-specific installation help on-line. There is also a quick tour section to help you get acquainted with the user interface, plus a high-level overview of Together's key features (with a brief "how-to" section when appropriate). This volume also features a strategic set of task-oriented links to topics in the User Guide.
User's Guide	Provides in-depth explanations about how to accomplish your work using Together. Part 1 is about using Together for modeling. Includes topics on how to set up a custom configuration, UML support, and creating, working on, and generating doc for projects and diagrams. There are sections on working with patterns and API extension modules, and importing and exporting information. Also covered are documentation generation and custom doc template design. Part 2 is about using Together for development. You'll find sections on Together's integrated development tools (GUI builder, Code Editor, Debugger) and how to compile and make projects right from Together itself. This is also where to find information on Together's EJB features, including the new assembly diagram and hot-deployment support for major app servers.
Reference	Technical, system, UI, and other reference information related to Together's architecture, User Interface, and API. Also includes copies of rlevant license agreements.

Other documentation

Help documentation is your main source of information, but it is not the only documentation provided. In addition to Help, you will find:

• Readme file: Resides in same directory as the installer program (before you install Together from CD) and in the root directory of your Together installation. It contains pre-installation information and tips, and/or late-breaking information not yet incorporated into documentation.

• What's New: The file whats_new.html is written to the root directory of your installation and contains information about new features and enhancements for the current release. There's also a version history file in the same location if you're interested.

• API Documentation: JavaDoc(tm) technical reference for the Together Open API. To acces the main index file, open %TOGETHER_HOME$/doc/api/index.html

• Module Documentation: the %TOGETHER_HOME$/modules/com/togethersoft/modules directory tree contains documentation for modules that implement some integration or interoperability with third-party software products. Such modules include a documentation subdirectory. (Not all module directories contain documentation: system modules, for example, do not.)

• Comments in files: Files in the installation contain comments that you will find useful in the specific context. These include:

  • Source files for modules

  • Example projects (source and diagrams)

  • All the configuration properties files (./config/*.config, *.properties)

  • Example batch and command files (*.bat, *.cmd, *,sh) for launching Together.