Changes between Version 3 and Version 4 of EclipseInterface


Ignore:
Timestamp:
Jan 26, 2015, 4:29:54 PM (10 years ago)
Author:
manualwiki
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • EclipseInterface

    v3 v4  
    1  
     1[[PageOutline]] 
    22= Introduction 
    3 Most 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//.  
     3Most 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//.  
    44The following functionalities are available from the Eclipse interface: 
    55* [#db Database management] 
    … …  
    1212A short description for each functionality can be found at the beginning of the relevant sections.  
    1313 
    14 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. 
     14While 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. 
    1515 
    1616[=#install] 
    … …  
    19191. Install the [#instdep dependencies]. 
    20201. To [#pluginst install the RefactorErl plugin in Eclipse], click on the **Help > Install new software** buttons in the Eclipse menu, click **Add...** in the appearing window, and paste the following link in the **Location** text field of the window named **Add Repository**: http://plc.inf.elte.hu/erlang/dl/update/ 
    21 1. [#firsttime After the installation], navigate to the preference pages by clicking **Window > Preferences > RefactorErl**, and 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. 
     211. [#firsttime After the installation], navigate to the preference pages by clicking **Window > Preferences > !RefactorErl**, and 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. 
    2222 
    2323[=#instdep] 
    … …  
    2525* Java 8 JRE/JDK or newer. 
    2626* Eclipse 4.4.0 Luna or newer. 
    27 * RefactorErl 0.9.14.09 or newer. (Not needed in case a remote RefactorErl node is available.) 
    28 * GraphViz (Optional. Needed for displaying dependency graphs in SVG.) 
     27* !RefactorErl 0.9.14.09 or newer. (Not needed in case a remote !RefactorErl node is available.) 
     28* !GraphViz (Optional. Needed for displaying dependency graphs in SVG.) 
    2929{{{#!comment 
    3030* GEF4/Zest 2.0 Eclipse plugin (Optional. Needed for drawing Zest graphical representations of dependency graphs) 
    … …  
    3535Please see the developers' site for instructions concerning the obtainment and installation of [https://www.oracle.com/java/ Java] and [https:/www.eclipse.org/ Eclipse]. 
    3636 
    37 === RefactorErl 
    38 Detailed 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, Erlang Wx, ...) listed on the referenced wiki page apart from the base system. 
    39  
    40 As a remainder, here are the steps you need to follow in order to install RefactorErl: 
    41 1. Install Erlang from your system package manager, or from an installer provided by [https://www.erlang-solutions.com/downloads/download-erlang-otp Erlang Solutions], or you can build [http://www.erlang.org/download.html Erlang from source]. Prior to installation make sure that the version of the Erlang package to be installed is supported by RefactorErl. 
     37=== !RefactorErl 
     38Detailed 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, Erlang Wx, ...) listed on the referenced wiki page apart from the base system. 
     39 
     40As a remainder, here are the steps you need to follow in order to install !RefactorErl: 
     411. Install Erlang from your system package manager, or from an installer provided by [https://www.erlang-solutions.com/downloads/download-erlang-otp Erlang Solutions], or you can build [http://www.erlang.org/download.html Erlang from source]. Prior to installation make sure that the version of the Erlang package to be installed is supported by !RefactorErl. 
    42421. Download [https://plc.inf.elte.hu/erlang/ RefactorErl].  
    43 1. Uncompress the archive to the directory where you want RefactorErl to reside.  
     431. Uncompress the archive to the directory where you want !RefactorErl to reside.  
    44441. Enter the `refactorerl-x.y.z.v` directory you just uncompressed (here `x.y.z.v` denotes a version number).  
    4545   Type the command `bin\referl -build tool` in a terminal window.  
    … …  
    47471. Test the tool by typing `bin\referl` in your terminal. If the build was succesful, an Erlang shell should appear.  
    4848 
    49 You will have to supply the location of the refactorerl-x.y.z.v directory (where we typed in the commands) to the RefactorErl plugin after the plugin is installed into Eclipse. 
    50  
    51 === GraphViz 
    52 Optional. GraphViz is used to draw SVG representations of dependency graphs. You will have to supply the location of the `dot` executable of an installed GraphViz application the first time you use the SVG drawing feature. 
     49You will have to supply the location of the refactorerl-x.y.z.v directory (where we typed in the commands) to the !RefactorErl plugin after the plugin is installed into Eclipse. 
     50 
     51=== !GraphViz 
     52Optional. !GraphViz is used to draw SVG representations of dependency graphs. You will have to supply the location of the `dot` executable of an installed !GraphViz application the first time you use the SVG drawing feature. 
    5353 
    5454Hint: On UNIX-like systems, you can use the `type -a dot` command to locate the `dot` executable on your system.  
    5555 
    56 GraphViz can be obtained from the [http://www.graphviz.org developers' website] or presumably from the package manager of your local system. 
     56!GraphViz can be obtained from the [http://www.graphviz.org developers' website] or presumably from the package manager of your local system. 
    5757 
    5858{{{#!comment 
    … …  
    6262The up-to-date version of the Zest 2.0 Eclipse plugin can be obtained from the [https://wiki.eclipse.org/GEF/GEF4 developers' website]. 
    6363 
    64 You can also download Zest 2.0 from the RefactorErl update site. Just select the **GEF4/Zest 2.0** entry besides the RefactorErl plugin entry in the list after you added the update site in Eclipse. See the [#pluginst relevant section] for more information. 
    65 Please note, that the version hosted on the RefactorErl update site might not be up-to-date. 
     64You can also download Zest 2.0 from the !RefactorErl update site. Just select the **GEF4/Zest 2.0** entry besides the !RefactorErl plugin entry in the list after you added the update site in Eclipse. See the [#pluginst relevant section] for more information. 
     65Please note, that the version hosted on the !RefactorErl update site might not be up-to-date. 
    6666}}} 
    6767 
    … …  
    7171The up-to-date version of the Erlide Eclipse plugin can be obtained from the [http://www.erlide.org developers' website].  
    7272 
    73 You can also download Erlide from the RefactorErl update site. Just select the **Erlang language tools IDE** entry besides the RefactorErl plugin entry in the list after you added the update site in Eclipse. See the [#pluginst relevant section] for more information.  
    74 Please note, that the version hosted on the RefactorErl update site might not be up-to-date. 
     73You can also download Erlide from the !RefactorErl update site. Just select the **Erlang language tools IDE** entry besides the !RefactorErl plugin entry in the list after you added the update site in Eclipse. See the [#pluginst relevant section] for more information.  
     74Please note, that the version hosted on the !RefactorErl update site might not be up-to-date. 
    7575 
    7676[=#pluginst] 
    77 == Installing the RefactorErl plugin in Eclipse 
    78  
    79 The RefactorErl plugin can be installed in Eclipse via our update site.  
     77== Installing the !RefactorErl plugin in Eclipse 
     78 
     79The !RefactorErl plugin can be installed in Eclipse via our update site.  
    8080 
    8181First copy the following link on the clipboard (eg. Right click > Copy Link Location): http://plc.inf.elte.hu/erlang/dl/update/ 
    … …  
    9393}}} 
    9494 
    95 In the original **Install** window select the RefactorErl group and a list should appear, containing the plugins available from the update site we specified in the last step. {{{ 
     95In the original **Install** window select the !RefactorErl group and a list should appear, containing the plugins available from the update site we specified in the last step.  
     96{{{ 
    9697#!comment  
    9798KÉP 
    9899}}}  
    99100 
    100 To install the RefactorErl plugin, select the **RefactorErl Eclipse UI** entry.  
    101 The list might contain additional entries for optional dependencies (Erlang language tools IDE {{{#!comment , GEF4/Zest 2.0}}}). Installing these plugins is not required, but it will enhance some features of the RefactorErl plugin. Please note, that the version of these dependencies hosted on the RefactorErl update site might not be up-to-date.  
     101To install the !RefactorErl plugin, select the **!RefactorErl Eclipse UI** entry.  
     102The list might contain additional entries for optional dependencies (Erlang language tools IDE). Installing these plugins is not required, but it will enhance some features of the !RefactorErl plugin. Please note, that the version of these dependencies hosted on the !RefactorErl update site might not be up-to-date.  
     103{{{ 
     104#!comment  
     105GEF4/Zest 2.0 
     106}}} 
    102107 
    103108After 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. 
    104109 
    105 == Uninstalling the RefactorErl plugin 
    106 The RefactorErl plugin can be uninstalled from Eclipse like most other Eclipse plugins.  
     110== Uninstalling the !RefactorErl plugin 
     111The !RefactorErl plugin can be uninstalled from Eclipse like most other Eclipse plugins.  
    1071121. Open Eclipse 
    1081131. Click on **Help > Installation Details**  
    109 1. In the appearing window select the **RefactorErl Eclipse UI** entry. Click on the **Uninstall** button. 
     1141. In the appearing window select the **!RefactorErl Eclipse UI** entry. Click on the **Uninstall** button. 
    110115 
    111116[=#firsttime] 
    112117== First time launch 
    113 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.  
    114 {{{ 
    115 #!comment  
    116 KÉP 
    117 }}} 
    118  
    119 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. 
    120 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. 
    121  
    122 Navigate to the preference pages by clicking **Window > Preferences > RefactorErl**.  
     118If 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.  
     119{{{ 
     120#!comment  
     121KÉP 
     122}}} 
     123 
     124The !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. 
     125It 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. 
     126 
     127Navigate to the preference pages by clicking **Window > Preferences > !RefactorErl**.  
    123128{{{ 
    124129#!comment  
    … …  
    126131}}}  
    127132 
    128 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.  
    129  
    130 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. 
    131  
    132 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.  
    133 {{{ 
    134 #!comment  
    135 KÉP 
    136 }}} 
    137  
    138 Congratulations, now you can start using RefactorErl with the Eclipse interface! 
    139  
    140 = Using the RefactorErl Eclipse interface 
     133In 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.  
     134 
     135In 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. 
     136 
     137Click **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.  
     138{{{ 
     139#!comment  
     140KÉP 
     141}}} 
     142 
     143Congratulations, now you can start using !RefactorErl with the Eclipse interface! 
     144 
     145= Using the !RefactorErl Eclipse interface 
    141146This 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.  
    142147 
    143 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. 
    144  
    145 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.  
     148If 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. 
     149 
     150For 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.  
    146151 
    147152[=#db] 
    148153== Database management 
    149 The RefactorErl server uses an internal database to store syntactic and semantic information on the source code. RefactorErl provides most of its services with the use of this information. In order for RefactorErl to be able to analyse a source file, that source file must be added to the database.  
    150  
    151 See the [wiki:ManagingFiles wiki page about database management] for a more detailed description of database management in RefactorErl. 
     154The !RefactorErl server uses an internal database to store syntactic and semantic information on the source code. !RefactorErl provides most of its services with the use of this information. In order for !RefactorErl to be able to analyse a source file, that source file must be added to the database.  
     155 
     156See the [wiki:ManagingFiles wiki page about database management] for a more detailed description of database management in !RefactorErl. 
    152157 
    153158Database management features available in the Eclipse interface include:  
    … …  
    162167* Resetting the database 
    163168 
    164 You can open a view containing the list of files, called the //Database view//, by clicking **RefactorErl > Database > Show Database** in the top menu.  
     169You can open a view containing the list of files, called the //Database view//, by clicking **!RefactorErl > Database > Show Database** in the top menu.  
    165170 
    166171{{{ 
    … …  
    170175 
    171176When you click in the //Database view// with the right mouse button, a context menu will appear, containing all database management features. Some of them, like the //drop// and //show// features, are dependent on the files or directories selected in the view. 
    172 Most database management features (the ones not depending on file selection) are also available in the **RefactorErl > Database** menu. 
     177Most database management features (the ones not depending on file selection) are also available in the **!RefactorErl > Database** menu. 
    173178 
    174179Source files can also be opened by double clicking on their name in the //Database view//. 
    … …  
    176181[=#sq] 
    177182== Semantic queries 
    178 RefactorErl provides a semantic query language as a straightforward way to query the information residing in the database. See the [wiki:SemanticQuery wiki page on semantic queries] for a detailed description of this feature. 
    179  
    180 The RefactorErl plugin for Eclipse provides an interface to 
     183!RefactorErl provides a semantic query language as a straightforward way to query the information residing in the database. See the [wiki:SemanticQuery wiki page on semantic queries] for a detailed description of this feature. 
     184 
     185The !RefactorErl plugin for Eclipse provides an interface to 
    181186* write and execute semantic queries with autocompletion support, 
    182187* show the results of the previously executed query, 
    … …  
    187192 
    188193You can execute a global query by writing your query in the textfield initially with the text `Semantic query` in the Eclipse toolbar and pressing the return key.  
    189 You can also execute global queries by clicking on **RefactorErl > Queries > Start query**. A dialog will appear, where you can type the global query. 
     194You can also execute global queries by clicking on **!RefactorErl > Queries > Start query**. A dialog will appear, where you can type the global query. 
    190195{{{ 
    191196#!comment  
    … …  
    202207After a successful query execution a view, called //Query result view// will appear with the results of your query. You can double click on a line of the result, and if it's possible, an editor tab will open with the file containing the content of that line, highlighting the content in question. 
    203208 
    204 The **RefactorErl > Queries > Show query history** button will open the //Query history view//. Double clicking on a query in the //Query history view// will show a results of this query in a //Query result view//. Please note, that these are historical results, it may or may not be consistent with the current content of the database. 
     209The **!RefactorErl > Queries > Show query history** button will open the //Query history view//. Double clicking on a query in the //Query history view// will show a results of this query in a //Query result view//. Please note, that these are historical results, it may or may not be consistent with the current content of the database. 
    205210 
    206211