Together 4.0 Readme

CONTENTS:
What's new
Supported operating platforms
Java Virtual Machine and Together system requirements
  -JVM Information
  -Together system requirements
Important information for Together 2.x users
Installation and startup information
    -On-line Installation & startup notes
   -Launching Together Help
  -Where to get installation support
Late additions

What's New

Together 4.0 has a number of new features and improvements to existing features... all too numerous for a readme file. See whats new and what's changed in Together 4.0.

Supported operating platforms

Together has been tested on Linux, Sun Solaris (SPARC), and Microsoft Windows (95/98/NT/2000). Together may run on other platforms that support Java (tm), but TogetherSoft supports the product only when running on one of the above operating systems under a recommended Java Virtual Machine (JVM).

Java Virtual Machine  and Together system requirements

The information in this file and related linked files is current as of date of release. Releases of new JVM builds or third party integrations may necessitate changes to information about system requirements or JVM recommendations between releases of Together.

TogetherSoft posts details on system requirements and virtual machine recommendations on the Worldwide Web. For the latest system requirements and virtual machine recommendations for all supported platforms, please visit: www.togethersoft.com/together/sysrequire.htm. At the time of release the following information is current:

JVM Information

Together 4.0 installs the Java(TM) 2 SDK, Standard Edition, Version 1.3.0 on Windows platforms. Together runs by default on this JVM.

Other operating systems require that you obtain the necessary JDK. As of release time, the following JVMs are required for these specific platforms:

You can obtain these as separate downloads from various sources on the Web, including www.togethersoft.com.

Together system requirements

For Together system requirements-- recommended processors, RAM, disk space, etc. please see sysrequire.html . Information in that file is current as of release date. Changes that may occur between releases are posted to www.togethersoft.com/together/sysrequire.htm.

Important Information for Together 2.x Users

The information in this section applies only to users of Together version 2.x who have never upgraded to version 3.x, who are now upgrading to version 4. Users of Together version 3.0 or higher can skip this section.

Changed project file format: The file format of project files has changed from version 2.x. Together recognizes the version 2.x project file format and converts it to a new format after saving the old version as ~oldname.tpr. If you will still want to open the same project in version 2.x, you should open the .tpr file with the "~" prefix. Note the information in the next paragraph, however.

Changed diagram file format: The file format of diagram files has also changed from version 2.x. The file extension of Together diagrams has changed from.vfDiagramType to .dfDiagramType. Together recognizes your version 2.x diagrams and creates copies in the new format with the same file name and the .df* extension. These copies appear in the Model tab of the Explorer, and you can open and edit them using Together 3.0 or above. Your version 2.x diagrams are unaffected. If you keep your diagram files under version control, you will need to add the new .df* files to your version control project.

IMPORTANT:
When you modify diagrams (having .df extensions) that were converted from 2.x diagrams (having .vf extensions), the version 2.x diagrams are not updated. Anyone using version 2.x and opening the 2.x project file (~oldname.tpr) will not see such modifications. Therefore, you should restrict your critical development to version 2.x until you are ready to upgrade all users on a given project at the same time. If you are using version 2.x and are only evaluating Together (3.0 or above) to see if you want to upgrade, do not use the new version to modify anything that is critical to your development until your are ready to upgrade.

Installation & Startup Information

Together installation is designed to be easy and straightforward. For Windows installation, an executable installation program guides you through the process, and the Together.exe launcher is written to the bin directory of the installation.

Installation for other operating systems is a tar.gz archive containing the entire Together directory structure. You extract the archive into a directory on your computer. Launcher file Together.sh is written to the bin directory of the installation. To run Together, you should review Together.sh to see how your environment variables need to be set so that the launcher will run Together.

If you want to do a server-based installation, please install on a local drive first and review the installation topic in Together Help.

On-line Installation & startup notes

Installation Help for all supported platforms is on-line at www.togethersoft.com/readme/. You'll also find information on how to start Together on each of the supported operating systems.

Launching Together Help

Together on-line Help is implemented under JavaHelp 1.1. After installation, you can either run Help from Together's Help menu when Together is running, or launch it with specially provided command files when Together is not running.

Where to get installation support

Support is provided by TogetherSoft and a fast-growing international network of Together Exclusive Distributors. If you need installation support, you may contact the Together support center most convenient for you. For complete up-to-date contact information, please visit www.togethersoft.com/support/. 

Late additions

Inspector customization model has changed

The implementation of the Inspector has moved from configuration properties to the Open API. If you have customized the inspector.config file from version 3.x, your customizations will not appear in the new Inspector in version 4.0. Documentation on how to port a customized inspector configuration is provided from a link on the Help menu. If this change will be a major issue for you, please contact TogetherSoft support for assistance.

New include directives for C++ headers

Two include files are added to the installation:

%TGH%/lib/pi_vc_stl.inc
%TGH%/lib/pi_vc_stdlib.inc

They contain set of #include directives for certain Microsoft Visual C++ headers.

pi_vc_stl.inc: 13 headers related only VC's STL (according to MSDN)
pi_vc_stdlib.inc: complete VC's Standard c++ library (according to MSDN)

With appropriately modified preinclude.inc files, these provide the possibility to make defines and symbols from Visual C++ STL or Standard C++ Library available in a Together model.

To incude this support, should add the folder with VC headers to the  Search/Classpath (File | Project Properties - Advanced) if a Together project. Then define the wrapped Together macros TS_PREINCLUDE_VC_STL or TS_PREINCLUDE_VC_STDLIB respectively, using Options | [level] - Source Code page - C++ -

Recommended PVCS version

Together has problems when using PVCS 6.5 as SCC provider for version control. PVCS VM 6.6 has demonstrated no problems working with Together and is recommended for those planning to integrate PCVS for version control.

Required project configuration for CodeSense & Debugger

In order for the new CodeSense (code completion) and Debugger features to work properly, the Include Standard Libraries option MUST be checked in your project properties. To set the option use File | Project Properties and select Advanced mode if necessary to expose the Search/Classpath page tab.

COM IDL is not supported

COM IDL is not yet supported, but is planned for a subsequent release. Some documentation may refer to COM IDL support. Only CORBA (OMG) IDL is supported in this release (round-trip and export).

CVS version control integration note

This note applies only  if you use CVS Client-Server for version control. The version of jcvs used by Together's version control integration module appears not to read Entries.log files. These files are created by command-line cvs at checkout time and seem to be merged in regular Entries after update. Thus, to ensure there are no Entries.log files in your working directory, you need to run cvs update from project root after checking out sources. This problem only occurs on a freshly checked out source tree, not if it was updated at least once. Thus, it cannot be remedied using only Together... run update on your freshly checked-out sources before using Together's CVS integration.