Camille Editor: Difference between revisions

From Event-B
Jump to navigationJump to search
imported>Fabian
imported>Fabian
Line 60: Line 60:


====Editing ====
====Editing ====
The TextEditor currently offers the following features:
* ''Syntax highlighting'': Keywords (structural and in formulas), labels and comments are highlighted.
*
[ToDo]
[ToDo]


==Bugs and Features ==
==Bugs and Features ==

Revision as of 12:29, 13 May 2009

The first version of the Text Editor will be released in a few weeks, that means in second half of June and not before the Rodin release 1.0 has been published.

Until then we are going to release a few testing releases (beta) for interested users. You will find instructions how to install and use these beta releases on this page.


Warning:

Don't use the TextEditor yet with your production models!

  • The TextEditor is still in development
  • It is based on a new Rodin version which uses a changed database model. Therefore its projects cannot be used in older Rodin versions.


Installing

The TextEditor relies on features of the Rodin release 1.0 which is not yet released. Therefore you will have to create a new Rodin installation. The following steps will guide you through this process:

  1. Download a build of Rodin from our CruiseControl server:
    1. Point your browser to [1]
    2. Download a zip file with a name starting with rodin-product and matching your platform. For example rodin-product-linux.gtk.x86.zip if you are working on a Linux system.
  2. Extract the downloaded zip file.
  3. Start Rodin from the folder where you extracted the zip file in the previous step.
  4. Install the TextEditor:
    1. In the menu choose Help -> Software Updates...
    2. Select the tab Available Software and click Add Site...
    3. Use the location URL: http://www.stups.uni-duesseldorf.de/update-beta/
    4. Back in Available Software open the update site you just added
    5. Select Event-B EMF Framework and Event-B TextEditor and click Install...
  5. Restart Rodin as suggested.


Now you are ready to use the TextEditor.


Updating

As often as possible we are going to publish updated beta releases. We recommend that you update your new Rodin installation with these updates for the TextEditor (and EMF Framework).

Although we will try to announce these updates on this site too, it is a lot easier if you setup Rodin to let you know when an update is available. The following steps guide you through this process:

  1. In Rodin open the preferences (Window -> Preferences or for Mac: Rodin -> Preferences)
  2. Find Install/Update -> Automatic Updates
  3. Select Automatically find new updates and notify me

As soon as Rodin finds a new update it will ask you if you would like to install it.


Usage

This section should help you to get started with the TextEditor.

Opening with the TextEditor

At the moment the TextEditor competes with the current graphical Event-B editor when it comes to the selection of a default editor for the double click action to open a model file.

Thus from time to time you might experience that an unexpected editor opens. If this happens you can right-click on the model file and select Open with TextEditor to use the text editor. Usually you should be able to just use a double-click to open a machine or context with the TextEditor.

Syntax

[ToDo]

Editing

The TextEditor currently offers the following features:

  • Syntax highlighting: Keywords (structural and in formulas), labels and comments are highlighted.

[ToDo]

Bugs and Features

Please use this section to report any bugs you find and let us know about features you would like to see in the TextEditor.

Regarding feature requests: Any feature request is welcome! But please keep in mind that we are preparing for a first stable release of the TextEditor. So we might not start working on your feature request in the next weeks. The focus until the first release is on stability!

Of course any feedback is welcome! We appreciate when you let us now what you think about the TextEditor.

Bugs

  • Multiline comments which are created with the graphical Event-B editor are not pretty-printed correctly. This results in a syntax error. Workaround: Correct the multiline comment manually.
  • Sometimes the order of elements, for example invariants, is changed without notice when saving or loading. Workaround: None so far.

Features