Taj Operation Manual

 

A.        Installation

 

1.         Start up eclipse

 

2.         "File" -> "Close All"

 

3.         In the Resource perspective, in the Navigator, select "gt.taj", if present

3.1       Right click and select "Delete"; chose to delete source files as well

3.2       In the Plug-in Development perspective, in the Package explorer, select

            "gt.taj", if present

 

4.         "File" -> "New" -> "Project"

            4.1       "Plugin Development" -> "Next"

            4.2       "Name:" "gt.taj" -> "Next" -> "Next"

            4.3       "Create a blank plug-in project" -> "Finish"

 

5.         Using the file system, copy the source code (along with the directory structure) from "/src" into the Eclipse installation directory

".../eclipse/workspace/gt.taj/src"

 

6.         In Eclipse, right-click "gt.taj" in the Package Explorer and choose "Refresh"

            Note: now you will see a bunch of errors

7.         Right-click "gt.taj" and choose "Properties", then click on "Java Build Path"

7.1       Under the "Projects" tab, make sure the following are checked:

                        "org.eclipse.core.boot"

                        "org.eclipse.core.resources"

                        "org.eclipse.core.runtime"

                        "org.eclipse.jface"

                        "org.eclipse.jface.text"

                        "org.eclipse.ui"

Note: If you cannot see any of these choices, you need to import them into your workspace. For instructions on importing plugins, see the Hello World Plugin tutorial.

7.2       Copy the file "plugin.xml" into the ".../eclipse/workspace/gt.taj" folder and overwrite the existing "plugin.xml"

7.3       Click "OK" and rebuild the project. (Latest versions of Eclipse will do it

                        automatically)

 

9.         Select "File" from the menu bar and click "Export"

9.1       Choose "Jar File" and click "Next", "Finish". Confirm "Create" if necessary.

 

10. Now you can edit the source code by using normal Eclipse operations.

 

11. If you wish to export your modified code at any time, use step 9.

 

B.        Running Taj

 

1.         Click on "Run" from the menu bar and choose "Run...".

 

2.         Under "Configurations," Select "Run-time Workbench" and click the "New" button

 

3.         Under the "Plug-ins and Fragments Tab", choose "Choose Plug-ins and Fragments to Launch from List".  Make sure "gt.taj" is selected as an internal plugin.

3.1       Click "Apply", then "Run".

3.2       Switch to the "Eclipse Platform" window

 

C.        Operation Manual

 

Within the Taj environment, there are several tasks that you can perform. All operations can be accessed by right-clicking on the mouse. The following section explains each operation and how to use them.

 

Collapse          The highlighted lines of text will be collapsed into a single chunk. You will be prompted to give a description for the collapsed lines. This description will now visually take the place of the original lines of code.

 

Expand            All of the chunks within the highlighted lines of text will be expanded. You may select multiple chunks to be expanded. The descriptors will be replaced with the contents within the chunks. However, the expanded chunks still exists within the model. You can see this effect on the Treeviewer. Hence, you can re-collapse the expanded chunks in the future.

 

ExpandAll       All of the chunks in the entire document will be expanded. This will present the original document. However, all the chunks still exist, so you may re-collapse them at anytime.

 

HardExpand   All of the chunks within the highlighted lines of text will be expanded. Furthermore, these chunks will permanently be removed from the Taj system. You cannot re-collapse a hard-expanded chunk. Use this option carefully.

 

Recollapse       All chunks that contain any of the highlighted lines will be collapsed once more. Thus, their descriptors will display instead of their contents.

 

RecollapseAll   All chunks in the entire document will be collapsed. The user will only see top-level chunk descriptors and lines.

 

To save a Taj documentation, simply click the Save icon on the Eclipse toolbar and choose “Yes” when prompted.