Changes between Version 8 and Version 9 of EclipseInterface

Timestamp:

Apr 19, 2015, 7:59:32 PM (10 years ago)

Author:

manualwiki

Comment:

--

EclipseInterface

@@ -1 +1 @@
 [[PageOutline]]
 = Disclaimer
-The currently available !RefactorErl plugin for Eclipse is an operational first prototype of the proposed tool. Most features are supposed to improve in future versions. Questions, suggestions, bug reports, feature requests and any other kind of well-intentioned feedback [https://plc.inf.elte.hu/erlang/refactorerl-contact.html sent to our team] are all welcome and will be considered.
+The currently available !RefactorErl plugin for Eclipse is an operational first prototype of the proposed tool. Most features are to be improved in future versions. Questions, suggestions, bug reports, feature requests and any other kind of well-intentioned feedback [https://plc.inf.elte.hu/erlang/refactorerl-contact.html sent to our team] are all welcome.
 
 = Introduction
@@ -17 +17 @@
 While not required, it's recommended to install [http://www.erlide.org the Erlide plugin] in Eclipse. Erlide enhances features of the !RefactorErl plugin and transforms Eclipse into a complete Erlang IDE.
 
+A short list of frequently experienced problems relating to the installation can be found in the [#troubleshooting troubleshooting] section.
+
 [=#install]
 = Installation
@@ -26 +28 @@
 [=#instdep]
 == Dependencies
-* Java 8 JRE/JDK or newer.
+* Java 7 JRE/JDK or newer. (Tested with Oracle and OpenJDK).
 * Eclipse 4.4.0 Luna or newer.
 * !RefactorErl 0.9.14.09 or newer. (Not needed in case a remote !RefactorErl node is available.)
@@ -36 +38 @@
 * //Erlide 0.29 or newer (Optional. Enhances features of the !RefactorErl plugin.)//
 
-=== Java & Eclipse
+=== Java 7 & Eclipse 4.4.0
 Please see the developers' site for instructions concerning the obtainment and installation of [https://www.oracle.com/java/ Java] and [https://www.eclipse.org/ Eclipse].
 
@@ -127 +129 @@
 [[Image(prefs.png, align=center)]]
 
+
 In case you would like to connect to a local !RefactorErl application, fill in the **!RefactorErl Base Directory** field with the path to the base directory of a locally installed !RefactorErl application. 
 
-In case you would like to connect to a remotely located !RefactorErl node instead, fill in the node address of this node in the **Server address** field.
-
-Click **OK**. Click **Yes** on the dialog inquiring wheter you want to reconnect to !RefactorErl. If the connection was successful, a `Connected to RefactorErl` message will appear in the left side of the status bar at the bottom of the Eclipse window. 
+In case you would like to connect to a remotely located !RefactorErl node instead, fill in the node address of this node in the **Server address** field. 
+
+The arbitrary directory specified in the **Logs directory** field will contain the error logs. The arbitrary directory specified in **Data directory** field will contain the files (eg. graph drawings) you create with the plugin. (There is also a **!Refactorerl data directory** which will contain the files created by the !RefactorErl process. You can leave this field blank.)
+
+Click **OK**. Click **Yes** on the dialog inquiring whether you want to reconnect to !RefactorErl. If the connection was successful, a `Connected to RefactorErl` message will appear in the left side of the status bar at the bottom of the Eclipse window. 
 
 Congratulations, now you can start using !RefactorErl with the Eclipse interface!
@@ -289 +294 @@
 * **New investigation with node** - Creates a new investigation tree with the selected node as its only element (and root).
 * **New investigation with subtree** - Copies the whole subtree, rooted in the selected node, to a new investigation.
+
+[=#troubleshooting]
+= Troubleshooting
+This section describes some of the most frequently experienced problems relating to the installation and starting of the plugin. If the proposed solutions aren't working or you have a problem not in this list, feel free to [https://plc.inf.elte.hu/erlang/refactorerl-contact.html contact us.]
+* **The installation won't finish and shows an error message** - Make sure you have the correct Eclipse version listed in the [#instdep dependencies section].
+* **There is no !RefactorErl menu after the installation** - You need to open the !RefactorErl perspective or the Erlide perspective to access the !RefactorErl menu. 
+* **There is no !RefactorErl perspective nor is there a !RefactorErl entry in the Preferences window.** - You either did not have installed the plugin, or you have installed it, but the Eclipse platform could not run the plugin. This is commonly caused by unsuitable Java versions. Check if the version of your JRE/JDK environment on your system matches the one listed in the [#instdep dependencies section].
+* **The plugin runs, but I'm unable to connect to the !RefactorErl tool** - This can happen for various reasons, you can try taking the following steps:
+  1. Make sure the tool is installed properly and can be run from the command line. (Take care, because Mnesia can only be start with one name per data directory, and this also stands for the default values!)
+  1. Try ticking the **Debug mode** button in the **Preferences** window. When you attempt to connect, a console view will appear, where you can check the output of the process. If there is no output, you're likely not supplied the correct path to the !RefactorErl process.
+  1. If the process starts, but the connection doesn't, you can try checking the logs. These files are containing the Erlang-formatted communication between the plugin and the !RefactorErl process.