1. Getting started

1.1. Installation guide

  • Install Erlang R10 or later, if it isn't already present on your system. On Windows systems, use a path with no spaces in it.

  • Install Eclipse. The recommended Eclipse version is 3.2.

  • If your network uses a proxy, fill in the appropriate data in Window->Preferences->Install/Update->Proxy settings.

  • Download Erlide by going to Window->Software Updates->Find and Install...->Search for new features to install. In the dialog, choose New remote site and enter Erlide as name and http://erlide.sourceforge.net/update32 as URL. Follow the dialogs with the obvious choices and in the end you will be asked to restart.

  • Restart. A dialog will pop up, asking for the path to your Erlang instalation. Enter the path to the top level directory (i.e. $ERL_TOP). Now restart again.

  • Done! You're ready to start exploring

Note

For Eclipse 3.1.2, use http://erlide.sourceforge.net/update. The 3.1.2 version is no longer supported and is 0.3.20.

1.2. Quick intro

Note

This chapter is just a quick-and-dirty version of a more complete documentation, whose outline you see below and which will follow when time permits.

  • Create projects with the File->New->Erlang project wizard. If the project isn't new, you can do an automatic search for source files, by using the "Discover paths" option. Review the result and add other needed directories

  • Create files by right-clicking on the desired directory in the resource view, and choosing either File->New->Other->File and entering a name ending with erl, or File->New->Erlang->Module and following the instructions in the wizard. Leave empty any fields you don't understand the meaning of.

  • The Erlang perspective should open.

  • The editor works as usual. Can be configured in Window-Preferences->Erlang. Note that not all options are functional.

  • Some useful commands in the editor are

    • put cursor on a function call (only standard OTP modules are supported currently) and its documentation will pop up

    • put cursor in a function name and press F3 and the source of the function's definition will be shown (if available)

    • writing for example "lists:r" will pop up a list of possible completions of the function call.

    • right clicking in the editor will show a menu where some Erlang options are at the bottom. "Correct indentation" is still not so good yet.

  • The outline view allows navigation in a module and an overview of the functions in it. Clicking on an item will show its definition in the editor.

  • The console lets you interact with the Erlang node that is behind the scenes.

  • Ther is a "Live expressions" view where you can enter expressions that will be reeevaluated every time a file is recompiled or when you press "refresh" in the view. You have to create a new entry, then go to the expression field and edit it. Don't use expressions that might kill the runtime or crash things (for example "init:stop()"), because there's no restriction yet.

  • The "Process list" view is just what it says,

  • Opening a "Edoc" view (in Window->Show view->Erlang) will display the documentation for the function where the cursor is (only OTP libraries)

  • Building is automatic whenever a file is saved (if Project->Build automatically is enabled) and the modified module is also reloaded in the Erlang backend.

  • The problems view will show all errors and warnings from the compiler. Clicking them opens the file in the editor at the right line.

  • There is also a builder that uses Make files --- TBD

For those not familiar with Eclipse, some short tips and tricks:

  • Ctrl-Shift-L will display a list of key bindings to the various commands

1.3. Tutorials

1.3.1. Installation tutorial

There is a preliminary presentation here (requires Flash)

1.3.2. Basic tutorial

This Getting Started tutorial is designed to help you learn about using the Erlang IDE (Erlide) in the workbench. This tutorial assumes the following:

  • That you are starting with a brand new workbench installation with all the default settings and preferences.

  • That the Erlide plugin is properly installed and running, see the Installation guide.

  • That you are familiar with the basic workbench mechanisms (e.g., views, text searching, perspectives, etc.)

There is also a preliminary presentation here (requires Flash)

1.3.2.1. Preparing the workbench

In this section, you will verify that the workbench is properly set up for Erlang development. See the installation guide.

TBD

1.3.2.2. Creating your first Erlang project

In this section, you will create a new Erlang project.

Creating the project

Inside Eclipse select the menu item File > New > Project.... to open the New Project wizard. Select Erlang Project then click Next to start the New Erlang Project wizard: On this page, type "ErlDemo" in the Project name field.

In the Resource Explorer, make sure that the src directory under the ErlDemo project is selected. Select the menu item File > New... > File and enter "mytest.erl".

Related concepts: Erlang projects,Erlang views

Related tasks: Working with build paths,Creating a new Erlang project,Using the Package Explorer

Related reference: New Erlang Project Wizard

1.3.2.3. Browsing Erlang elements using the resource explorer

TBD

1.3.2.4. Editing Erlang elements
1.3.2.4.1. Opening an Erlang editor

TBD

1.3.2.4.2. Adding new functions

TBD

1.3.2.4.3. Using content assist

TBD

1.3.2.4.4. Identifying problems in your code

TBD

1.3.2.4.5. Using code templates

TBD

1.3.2.4.6. Using the local history

TBD

1.3.2.5. Creating an Erlang module

TBD

1.3.2.6. Renaming Erlang elements

TBD

1.3.2.7. Moving and copying Erlang elements

TBD

1.3.2.8. Navigate to an Erlang element's declaration

TBD

1.3.2.9. Searching the workbench

TBD

1.3.2.10. Running your programs

TBD

1.3.2.11. Debugging your programs

TBD

1.3.2.12. Evaluating expressions

TBD

1.3.3. Configuration tutorial

TBD