Welcome, Guest! Log In | Create Account

Install Instructions

From textuml

Jump to: navigation, search

You might be interested in this animated demo showing how to install and configure the TextUML Toolkit.

Contents

Requirements

Install Eclipse

Add the TextUML Toolkit update site

  • Open the Software Updates dialog (Help > Software Updates...), and select the "Available Software" tab:

Image:Petstore-software-updates.png

Install the TextUML Toolkit and EclipseGraphviz features

  • Now that you have added the TextUML Toolkit update site, select the following features from the TextUML Toolkit update site (see picture below):
    • TextUML Front-End feature
    • EclipseGraphviz (optional, only needed if you want graphical visualization)
  • Push the "Install..." button

Image:Update-step2.png

Accept to restart Eclipse to make the changes effective.

Further steps for graphical diagram rendering

Diagram rendering is optional. If you decided not to install EclipseGraphviz in the previous step, skip this section.

Download and install Graphviz

If you don't have it yet, download and install Graphviz for your platform.

Note to Windows users: you might need to download and install the "Microsoft Visual C++ 2005 Redistributable Package (x86)" as mentioned in the Graphviz for Windows download page. From user reports, it seems XP usually requires that package to be installed, while Vista does not.

Configure EclipseGraphviz

Once Graphviz is installed, you need to tell EclipseGraphviz where to find it. Open the Graphviz preference page (shown below) and enter the location for the dot executable.

Image:Update-step3.png

How are diagrams rendered?

EclipseGraphviz provides an "Image Viewer" view that will show a rendered class diagram whenever a .uml file is selected or a TextUML Viewer editor is currently selected. To open the Image Viewer, go Window > Show view > Other... > EclipseGraphviz > Image viewer.

See also