icon in the Explorer. At a later time, you can modify the project,
adding additional resource roots, etc. from the Project
Properties dialog (File | Project Properties).This section explains how to open an existing Together project and create new projects. If you are new to Together, please read Project basics before you create or open a project.
IMPORTANT: If you are opening a project that was created with Together 2.x using version 3.x (or above) for the first time, do not open any project until you have read Important Info for Together 2.x Users.
To open an existing Together project:
Start Together if not already running.
From the Main
menu, choose File
| Open Project to
display the file selection dialog for your operating system.
Navigate to the
primary root directory containing the project (.tpr) file.
Select the project file (e.g. myProject.tpr) and click Open or Save (depending on OS)
Together opens the project and displays the contents in the Model tab of the Explorer. If the Saved Desktop option is enabled in your configuration options, any diagrams that were open when the project was closed re-open in the Diagram pane.
Tip: You can also navigate to a project file in the Directory tab of the Explorer
and double-click to open it (or use the speedmenu).
You can create a new Togeher project "from scratch", from an existing code base, or some of both.
When there is no extsting code to reverse engineer, project creation is quite simple. In many cases you need only specify a primary root directory for the project. You can do this in the defaulot mode of the New Project dialog. If you decide you want the new project under version control, or if you want any external resources (headers, libraries, etc.) to be available to the project, you'll need to specify this in the dialog's Advanced mode (see Advanced Mode below).
When creating a Together project for an existing code base, think first about what you want as modifiable content, and what you want as read-only content, i.e., shown in diagrams but not modified from within Together. Also think about what content should be round-trip engineered.
For example, in a Java project where some of your classes extend Java classes or some component classes, you might want to show those dependencies in your visual model, but you would not modify the parent classes. You might also want to include some or all of the classes residing on your Java classpath in your diagrams, or you might want to see classes or diagrams from another Together project but not modify them in the new project. If you compile classes from inside Together, you need all the recources required by your compiler available to the project, but not necessarily parsed during round-trip engineering.
The resources available to the project are specified as paths. Content can include classes and/or Together diagrams residing in different physical directories on one device, or on different devices. For each resource you define, you can specify whether or not to allow modification. If you want classes form a physical directory but not all of the subdirectories under it, you can exclude specific
Together provides this kind of flexibility when creating new projects, and when modifying existing projects. You can add or remove project resources as needed (without deleting any physical files), and you can control what resources can be modified within the context of the project. You will find this especially useful when dealing with extremely large code bases with dozens of directories and hundreds of classes. (See User's Guide: Project Management: Large Projects).
The New Project dialog offers two modes: basic (the default mode) and Advanced. Use basic mode when...
all the resources for the new project will reside in and under the
directory where you will create the project, and...
you want all resources included in the project, and...
you want all resources to be modifiable and round-trip engineered.
Use Advanced mode to...
specify multiple resource roots (directories or archives)
add or remove resource roots (directories or archives)
exclude subdirectories or file types in resource
roots from parsing
control modifiability of content in resource roots
specify EJB proerties (if project will contain EJBs)
set up version control for the project
To begin creating a new project:
From the Main menu choose File | New Project to display the New Project dialog. The dialog displays in Basic mode.
The basic mode of the New Project dialog is fairly self-explanatory.
Enter a name for the project in the Project Name field. This should be a legal filename for your operating system. The Location field now displays a default path. This is where Together will create the project file and initial and default diagrams. If you want to change the location click Browse and navigate to an existing directory where you want to store the project file and default project diagram. You can also use the dialog to create a new directory for the project (on most OS platforms).
If necessary use Browse to specify the location of the project directory. This can be any existing directory, or you can use the dialog to create a new one. Remember that basic mode's default means everything in and under the project directory is at least reverse engineered, and is modifiable (unless it's read-only at the OS level).
If you want to create an initial diagram (other than the <default> package view diagram) along with the new project, select the type in the Initial diagram list. Otherwise, select None. (Note: Together Whiteboard will only create a Class diagram.)
If you have a multi-language product, specify the target programming language for the project in Default Language. When you choose a language, any language-specific options available display next to the language selection.
The project now contains one root directory- the primary root as specified in steps 1 and 2. If you don't need to include any other directories as part of the project, click OK to create the project. If you want to specify other directories as part of the project or remove some added with language options, proceed to Advanced mode.
If you clicked OK at this point, the project file with the filename
you specified and the initial diagram (with the same name) are
created in the specified directory (called the project
directory). The project file has a .tpr extension and
displays with the
icon in the Explorer. At a later time, you can modify the project,
adding additional resource roots, etc. from the Project
Properties dialog (File | Project Properties).
The New Project dialog's Advanced mode lets you control what resources are available to, and included as part of, the new project and how these resources are treated dring round-trip engineering. You can also specify which project in your configured version control system to use for source files that are part of the new Together project.
To use Advanced mode:
Follow steps 1-4 in Basic Mode above.
Click the Advanced button in the New Project dialog to toggle Advanced mode.
The Project Paths and Search/Classpath tabs display the lists of the directories and/or archive files currently included as resources available to the project. By default, the path specified in Location (near the top of the dialog) is present in the Project Paths, and the path to the standard libraries are present in the Search/Classpath list. Checking "Include Classpath" adds your classpath directories to the list. For editions that include components, the Include Components box is enabled and checking it adds the component directories to the list.
Items in the Project Paths list are considered as project roots. Roots contain compiled or source classes and/or Together diagrams. Project roots are parsed during reverse engineering and treated as modifiable unless you specify otherwise in the other controls (see Resource options below).
The Search/Classpath list displays resources that reside on the classpath (as defined in your envionemt) and on any other paths you want Together to search for resources. These resources are available to show in diagrams but are not part of the project. They are not parsed, and do not show as project content in the Explorer unless they are added to a diagram as a shortcut. Also, their content is not modifiable within the project context.
Tip: If you will use an integrated compiler/debugger, make sure all the resources needed by the tool are included in the Search/Classpath list .
To add a resource directory to the project:
Click the Add Path button to
display the Select Path dialog.
Navigate to the
directory you want to include in the project.
Click Open or Select, depending on the OS you are running on.
Note that all subdirectories of the specified resource directory are included by default. You can exclude some specific subdirectories by either of two following ways.
If you want them to be skipped
over by the parsing engine, but still tracked with the project by Together,
you can add the individual subdirectories with the Add Path button,
as described above, and then choose the radiobutton Skip
(see Skip below).
If you want some subdirectories to be excluded completely, use Ignore Files and Folders option on the General page of the Project Options dialog (Options | Project) to specify the ignored directories.
In Java projects, some project resources may reside in compressed Zip or JAR archive files.
To add an archive file as a project resource:
Slelect either the Project Paths or Search/Classpath tab of the
Resources section of New Project (or Project Properties) dialog
Click the Add Zip/JAR button to display the Select Path dialog.
Navigate to the directory
containing the archive file.
Select the
desired file.
Click Open or Select, depending on the OS you are running on.
You can remove any resource from the Project Paths list or the Search/Classpath list by selecting it and clicking the Remove button. This is useful if, for example, you included your full Java classpath but that contains some directories that you really don't need in the new project. Removed resources are not deleted from disk... they are just not available to the project. If you need them again, you can add them later using File | Project Properties (Advanced mode).
After you have added resources to the project you can set some options that control how they are parsed and how you access them when modeling. By default, parsing of all the paths in the Project Paths list includes all recognized file types, and all resources are parsed as part of the project and display in the Explorer's Model tab. If that default behavior is not what you want, you can modify the treatment of each of the resources in the Project Paths list.
To set options for a resource, select it in the Project Paths list and modify any or all of the following:
Access: Selecting this option gives the parsing engine access to the selected resource.
Read only: Checking this box makes the contents of the resource a read-only part of the project. It displays as project content in the Explorer's Model tab but is not modifiable from within the project. When checked, File Types and Package Prefix are disabled.
File types: Check only those file types you want the parsing engine to work on. This can speed parsing of resources having different types of content. Use the default (all file types) unless you have a multi-language product version and want to skip source files not in the project's target language, or you want to specifically exclude compiled classes.
Package prefix: Specify the exact name you want Together to use for package statements referencing the selected resource.
Version Control project: Checking this box enables the version control integration defined in your configuration for the new/current project. The Select button enables you to select the project or repository of the currently configured version control system that you want the project to use.
Skip: Selecting this option causes the parsing engine to skip the selected resource, but the resource is still tracked with the project by Together and may be included in documentation generation or accessed as part of model information by modules.
See also: