Recent changes to User's Guide

User's Guide modified by Jacek Rosik

Jacek Rosik — Tue, 10 Dec 2013 20:12:45 -0000

--- v10
+++ v11
@@ -14,7 +14,7 @@

 [[img src=jittac-import.png]]

-##Using the Plug-In##
+##Configuring the Plug-In##

 ###Enabling the Source-Code Analysis###

@@ -23,8 +23,19 @@

 >**NOTE:** Due to a bug in the current version of the plugin you may need to re-start the IDE after enabling the code analysis to fully initialise the plug-in. This only has to be done once after the code analysis is enabled.

+
 ###Enabling Architectural Problems###

 Right click on the model file **model.xam** and select **Properties**, then select **Architecture Consistency**. Mark the project(s) (jConverter) for which you want to report architectural inconsistencies. You can also change the level of the architectural problems: *Info*, *Warning* or *Error* (NOTE: In order to see the architectural problems in the problem view the level has to be *Warning* or *Error*).

 [[img src=jittac-model-properties.png]]
+
+###Enabling Content Assist###
+
+Select **Window>Preferences** from the menu and then select **Java>Editor>Content Assist** from the left pane. In the **Sorting and Filtering** pane you can set proposal sorting to either *by consistency, then aphabeticaly* or *by consistency, then by relevance*. This will enable content assist sorting and coloring.
+
+[[img src=jittac-contentassiste-properties.png]]
+
+##Tool Demonstration##
+
+

User's Guide modified by Jacek Rosik

Jacek Rosik — Tue, 10 Dec 2013 19:58:46 -0000

User's Guide modified by Jacek Rosik

Jacek Rosik — Tue, 10 Dec 2013 19:46:09 -0000

--- v8
+++ v9
@@ -25,4 +25,6 @@

 ###Enabling Architectural Problems###

-Right click on the model file **model.xam** and select **Properties**, then select **Architecture Consistency**. Mark the project(s) (jConverter) for which you want to report architectural inconsistencies.
+Right click on the model file **model.xam** and select **Properties**, then select **Architecture Consistency**. Mark the project(s) (jConverter) for which you want to report architectural inconsistencies. You can also change the level of the architectural problems: *Info*, *Warning* or *Error* (NOTE: In order to see the architectural problems in the problem view the level has to be *Warning* or *Error*).
+
+[[img src=jittac-model-properties.png]]

User's Guide modified by Jacek Rosik

Jacek Rosik — Tue, 10 Dec 2013 19:42:03 -0000

--- v7
+++ v8
@@ -8,15 +8,21 @@

 [[img src=jittac-install.png]]

-###Importing the Sample Project: jConverter###
+###Importing the Sample Project (optional)###

 Download the sample project from [here](https://sourceforge.net/projects/actool/files/sample/jConverter.zip). Import it in to the workspace by selecting **File->Import...** and then **Existing Projects into Workspace**. Select the previously downloaded archive file and mark the **jConverter** project.

 [[img src=jittac-import.png]]
+
+##Using the Plug-In##
+
+###Enabling the Source-Code Analysis###

 After the project is imported into the workspace you need to right click on the project folder and select **JITTAC>Enable Code Analysis**, and then **Project>Clean** from the menu. This will enable architecture consistency checking for the jConverter project.

 >**NOTE:** Due to a bug in the current version of the plugin you may need to re-start the IDE after enabling the code analysis to fully initialise the plug-in. This only has to be done once after the code analysis is enabled.

-##Using the Plug-In##
+###Enabling Architectural Problems###
+
+Right click on the model file **model.xam** and select **Properties**, then select **Architecture Consistency**. Mark the project(s) (jConverter) for which you want to report architectural inconsistencies.

User's Guide modified by Jacek Rosik

Jacek Rosik — Tue, 10 Dec 2013 19:03:41 -0000

--- v6
+++ v7
@@ -1,12 +1,14 @@
 #JITTAC User's Guide#

-##Install the Plug-In##
+##Preparation of the IDE##
+
+###Installing the Plug-In###

 To install the plug-in select **Help->Install New Software...** and use the project's update site: . Select **Just-In-Time Tool for Architecture Consistency** plug-in and install it. Then re-start the IDE for the plug-in to initialise.

 [[img src=jittac-install.png]]

-##Import the Sample Project: jConverter##
+###Importing the Sample Project: jConverter###

 Download the sample project from [here](https://sourceforge.net/projects/actool/files/sample/jConverter.zip). Import it in to the workspace by selecting **File->Import...** and then **Existing Projects into Workspace**. Select the previously downloaded archive file and mark the **jConverter** project.

@@ -16,3 +18,5 @@

 >**NOTE:** Due to a bug in the current version of the plugin you may need to re-start the IDE after enabling the code analysis to fully initialise the plug-in. This only has to be done once after the code analysis is enabled.
+
+##Using the Plug-In##

User's Guide modified by Jacek Rosik

Jacek Rosik — Tue, 10 Dec 2013 19:01:39 -0000

--- v5
+++ v6
@@ -8,4 +8,11 @@

 ##Import the Sample Project: jConverter##

+Download the sample project from [here](https://sourceforge.net/projects/actool/files/sample/jConverter.zip). Import it in to the workspace by selecting **File->Import...** and then **Existing Projects into Workspace**. Select the previously downloaded archive file and mark the **jConverter** project.
+
 [[img src=jittac-import.png]]
+
+After the project is imported into the workspace you need to right click on the project folder and select **JITTAC>Enable Code Analysis**, and then **Project>Clean** from the menu. This will enable architecture consistency checking for the jConverter project.
+
+
+>**NOTE:** Due to a bug in the current version of the plugin you may need to re-start the IDE after enabling the code analysis to fully initialise the plug-in. This only has to be done once after the code analysis is enabled.

User's Guide modified by Jacek Rosik

Jacek Rosik — Tue, 10 Dec 2013 17:12:27 -0000

--- v4
+++ v5
@@ -1,7 +1,11 @@
-JITTAC User's Guide
-===
+#JITTAC User's Guide#

-Installation
----
+##Install the Plug-In##
+
+To install the plug-in select **Help->Install New Software...** and use the project's update site: . Select **Just-In-Time Tool for Architecture Consistency** plug-in and install it. Then re-start the IDE for the plug-in to initialise.

 [[img src=jittac-install.png]]
+
+##Import the Sample Project: jConverter##
+
+[[img src=jittac-import.png]]

User's Guide modified by Jacek Rosik

Jacek Rosik — Tue, 10 Dec 2013 16:35:30 -0000

--- v3
+++ v4
@@ -4,4 +4,4 @@
 Installation
 ---

-[[img alt=jittac-install.png]]
+[[img src=jittac-install.png]]

User's Guide modified by Jacek Rosik

Jacek Rosik — Tue, 10 Dec 2013 16:35:07 -0000

--- v2
+++ v3
@@ -0,0 +1,7 @@
+JITTAC User's Guide
+===
+
+Installation
+---
+
+[[img alt=jittac-install.png]]

User's Guide modified by Jacek Rosik

Jacek Rosik — Tue, 10 Dec 2013 16:34:12 -0000