Changes between Version 7 and Version 8 of EclipseInterface


Ignore:
Timestamp:
Mar 13, 2015, 7:21:00 PM (10 years ago)
Author:
manualwiki
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • EclipseInterface

    v7 v8  
    11[[PageOutline]] 
     2= Disclaimer 
     3The 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. 
     4 
    25= Introduction 
    36Most services provided by !RefactorErl are accessible from the Eclipse IDE after installing the !RefactorErl plugin in Eclipse. In this guide, we also refer to this plugin as the //Eclipse interface//.  
    … …  
    3740 
    3841=== !RefactorErl 
     42{{{#!comment 
     43On Debian based systems, the most straightforward way to install !RefactorErl and its dependencies is to use the [wiki:DebInstall RefactorErl Debian Package].  
     44}}} 
    3945Detailed instructions for installing !RefactorErl can be found on the [wiki:Install related wiki page]. Of the various dependencies listed in the guide, the !RefactorErl plugin depends only on the !RefactorErl base system. This means that if you do not intend to use other interfaces besides the Eclipse interface, you don't need to install any other dependencies (Yaws, Wx, ...) listed on the referenced wiki page apart from the base system.  
    4046 
    … …  
    102108}}} 
    103109 
    104 After clicking **Next** on this window, Eclipse will lead you through a series of simple steps before the installation. After the installation is finished, you will need to restart Eclipse. 
     110After clicking **Next** on this window, Eclipse will lead you through a series of simple steps before the installation. After the installation is finished, you will need to restart Eclipse.  
     111 
     112To start using !RefactorErl, open the **!RefactorErl Perspective** by clicking **Window > Open Perspective > Other > !RefactorErl** in the top menu. 
     113 
     114[=#firsttime] 
     115== First time launch 
     116If the plugin installation was successful in the last step, an error message will appear the first time the **!RefactorErl Perspective** is opened. This happens because we didn't set the path to !RefactorErl yet.  
     117{{{ 
     118#!comment  
     119KÉP 
     120}}} 
     121 
     122The !RefactorErl plugin can automatically start a local !RefactorErl application and connect to it. Please, see the corresponding section of this guide, if !RefactorErl is not yet installed on your system. 
     123It is also possible to connect to a !RefactorErl application running on a remote server. You do not need to install !RefactorErl on your local system to do this. 
     124 
     125Navigate to the preference pages by clicking **Window > Preferences > !RefactorErl**.  
     126 
     127[[Image(prefs.png, align=center)]] 
     128 
     129In 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.  
     130 
     131In 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. 
     132 
     133Click **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.  
     134 
     135Congratulations, now you can start using !RefactorErl with the Eclipse interface! 
     136 
     137= Using the !RefactorErl Eclipse interface 
     138This section will guide you through the most important interface features. While we include a basic description for each feature group, it may be neccessary for you to read the corresponding wiki pages for an in-depth understanding of the feature group in question.  
     139 
     140If you open the !RefactorErl perspective or the Erlang perspective (if Erlide is installed) inside Eclipse, a new menu button, with the text **!RefactorErl** on it, will appear in the Eclipse top menu. Much of the features are accessible through the **!RefactorErl** menu, and some features can be accessed in more than one way. 
     141 
     142For the rest of this guide we will assume that you have the !RefactorErl or the Erlang perspective opened and one of these is the active perspective. As a reminder, perspectives can be opened via the **Window > Open Perspective > Other** button in the Eclipse top menu.  
    105143 
    106144== Uninstalling the !RefactorErl plugin 
    … …  
    1091471. Click on **Help > Installation Details**  
    1101481. In the appearing window select the **!RefactorErl Eclipse UI** entry. Click on the **Uninstall** button. 
    111  
    112 [=#firsttime] 
    113 == First time launch 
    114 If the plugin installation was successful in the last step, an error message will appear the first time Eclipse is launched. This happens because we didn't set the path to !RefactorErl yet.  
    115 {{{ 
    116 #!comment  
    117 KÉP 
    118 }}} 
    119  
    120 The !RefactorErl plugin can automatically start a local !RefactorErl application and connect to it. Please, see the corresponding section of this guide, if !RefactorErl is not yet installed on your system. 
    121 It is also possible to connect to a !RefactorErl application running on a remote server. You do not need to install !RefactorErl on your local system to do this. 
    122  
    123 Navigate to the preference pages by clicking **Window > Preferences > !RefactorErl**.  
    124  
    125 [[Image(prefs.png, align=center)]] 
    126  
    127 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.  
    128  
    129 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. 
    130  
    131 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.  
    132  
    133 Congratulations, now you can start using !RefactorErl with the Eclipse interface! 
    134  
    135 = Using the !RefactorErl Eclipse interface 
    136 This section will guide you through the most important interface features. While we include a basic description for each feature group, it may be neccessary for you to read the corresponding wiki pages for an in-depth understanding of the feature group in question.  
    137  
    138 If you open the !RefactorErl perspective or the Erlang perspective (if Erlide is installed) inside Eclipse, a new menu button, with the text **!RefactorErl** on it, will appear in the Eclipse top menu. Much of the features are accessible through the **!RefactorErl** menu, and some features can be accessed in more than one way. 
    139  
    140 For the rest of this guide we will assume that you have the !RefactorErl or the Erlang perspective opened and one of these is the active perspective. As a reminder, perspectives can be opened via the **Window > Open Perspective > Other** button in the Eclipse top menu.  
    141149 
    142150[=#db] 
    … …  
    235243This search can be conducted using different algorithms and parameterizations. See the [wiki:CloneIdentifiErl wiki page about duplicated code analysis] for the complete list of these algorithms and parameterizations. 
    236244 
    237 To use this feature, click **!RefactorErl > Clone !IdentifiErl** in the top menu to open the //Clone !IdentifiErl //view. You can select an algorithm from the box on the tip part of the view, and fill in the parameters in the bottom part. To start the search, click on the **Run analysis** button. Note that this may take a long time, depending on how much data is stored in the database. 
     245To use this feature, click **!RefactorErl > Clone !IdentifiErl** in the top menu to open the //Clone !IdentifiErl //view. You can select an algorithm from the box on the top part of the view, and fill in the parameters in the bottom part. To start the search, click on the **Run analysis** button. Note that this may take a long time, depending on how much data is stored in the database. 
    238246 
    239247[[Image(dupcode.png, width=800, align=center)]] 
    240248 
    241 The results will be presented as a list of pairs of file positions in a view called //Duplicated code analysis results//. Double clicking on an item of that list will show the duplicated code sections side by side in a dual-pane editor. 
     249The results will be presented as a list of records of file positions in a view called //Duplicated code analysis results//. Double clicking on an item of that list will show the duplicated code sections side by side in a multi-pane editor. 
     250 
     251=== Duplicate code elimination 
     252This feature only works with duplicate searches launched with `Suffix tree (providing only relevant results)` algorithm.  
     253 
     254By right clicking on a record in the results view and selecting **Eliminate Group** in the context menu, you can introduce a new function in place of the duplicate group represented by the selected record. Since duplicate code elimination (and more generally, any refactoring or other kind of modifying operation) invalidates the results of former duplicate searches, all views and editors related to previous searches will be closed after a successful operation. 
    242255 
    243256[=#inv]