[[PageOutline]]

[http://http://erlide.org/ ErlIDE] is an Eclipse-based development
environment, which aims to assist programming of large scale Erlang
applications. In order to integrate RefactorErl into Eclipse, we are
engaged in creating an Eclipse plugin based on ErlIDE, which can enable
access to all the functionality provided by RefactorErl, whilst
utilising ErlIDE features as well. A prototype of the Eclipse plugin is
already available.

= Installation =

== Software requirements ==
 * The plugin is being developed and tested in [http://www.eclipse.org/ Eclipse 3.5.2]. (It likely works with newer versions as well.)
 * This user interface is built upon [http://erlide.org/ ErlIDE], therefore it is required to have it with Eclipse. Inasmuch as the main structure
  of ErlIDE has been changed in its version
  ''v0.11.6.201107010651'', it is necessary to get the latest version.
 * Finally, you can download the plugin itself from the RefactorErl homepage.

== Deployment ==
To install this plugin you need to download the source code from the
home page of the [http://plc.inf.elte.hu/erlang/dl/ RefactorErl]. In
order to generate the binaryes of the plugin you can compile it using
'''''ant''''' or the compiler of Eclipse. Finally you have to copy the
generated jar files into your Eclipse plugin directory. In Eclipse 3.5.x:
{{{
<user home>/.eclipse/org.eclipse.platform_3.5.0_155965261/plugin
}}}

== Compiling the plugin in Eclipse ==
todo

== Compile plugin using Ant ==
todo

== Configuration ==
The plugin, in order to be able to access RefactorErl, has to be set
up before the first usage. For the configuration dialog, go to
'''Window/Preferences/RefactorErl'''.

 Start background process automatically::
   If set, the plugin launches a new instance of the tool, otherwise an
   already running RefactorErl process will be used.
 RefactorErl directory::
   The installation directory of the tool.
 Working directory::
   A temporary directory, used to store the configuration files of
   RefactorErl. It is assumed to be a writable directory.
 Waiting time::
   This parameter represents the waiting time (in seconds) after
   starting RefactorErl process (has to be set to greater than 1). The
   slower access is possible to Erlang nodes, the greater value is suggested.
 Synchronize workspace automatically then model changed::
   If a source file has been changed, the extension automatically updates
   its inner representation within the tool.
 Reset database before full synchronization::
   Resets the database and erases its contents in the case of a full
   synchronisation. The use of this feature is recommended for RefactorErl
   developers only.
  
= Database management =
todo

= Executing refactoring transformations =
todo

= Executing semantic queries =
todo

= Clustering =
todo