Difference between pages "Camille Editor" and "Generic Instantiation Plug-in User Guide"

From Event-B
(Difference between pages)
Jump to navigationJump to search
imported>Fabian
(version 0.0.3)
 
imported>Asiehsalehi
 
Line 1: Line 1:
−
{| align="right"
+
== Introduction ==
−
| __TOC__
+
The Generic Instantiation (GI) Feature plug-in allows to instantiate and reuse generic developments in other formal developments..  
−
|}
 
−
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.
 
−
 
 
−
 
 
−
 
 
−
{| style="width:auto; background-color:#FFFF00; border:2px solid red;  padding:3px;"
 
−
|<b title="Usage warning"><font size="3"> Warning:</font size="3"></b><font size="1">
 
−
Don't use the TextEditor yet with your production models!
 
−
* The TextEditor is still in development
 
−
* It is based on latest SVN Rodin version which uses a changed database model. Therefore its projects cannot be used in older Rodin versions.
 
−
 
 
−
|}
 
−
 
 
−
 
 
−
 
 
−
==News ==
 
−
* ''29th May 2009'': '''Version 0.0.3''' - Fixing first reported bugs. '''Updated strongly recommended.'''
 
−
* ''27th May 2009'': '''Version 0.0.2''' - Update the page due to syntax changes and new version on update-site. Announcement on the DEPLOY tooling mailing list.
 
−
* ''13th May 2009'': '''Version 0.0.1''' - Creation of this page and publishing the beta update-site for the first time. Presentation at refocus meeting in Southampton.
 
  
−
==Installing ==
+
See the [http://wiki.event-b.org/index.php/Generic_Instantiation Generic Instantiation] page for technical details.
−
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:
 
  
−
# Download a build of Rodin from our [http://cruise.cs.uni-duesseldorf.de/dashboard/tab/builds CruiseControl server]:
+
== Installing and Updating ==
−
## Point your browser to http://cruise.cs.uni-duesseldorf.de/dashboard/tab/build/detail/org.rodinp.platform
+
=== Setup ===
−
## 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.
+
The following steps will guide you through the setup process:
 +
# Download Rodin for your platform.
 
# Extract the downloaded zip file.
 
# Extract the downloaded zip file.
 
# Start Rodin from the folder where you extracted the zip file in the previous step.
 
# Start Rodin from the folder where you extracted the zip file in the previous step.
−
# Install the TextEditor:
+
# Install the Generic Instantiation Feature plug-in:
−
## In the menu choose ''Help'' -> ''Software Updates...''
+
## In the menu choose ''Help'' -> ''Install New Software...''
−
## Select the tab ''Available Software'' and click ''Add Site...''
+
## In the ''Work with'' dropdown list, choose the location URL: Rodin
−
## Use the location URL: <tt>http://www.stups.uni-duesseldorf.de/update-beta/</tt>
+
## Select the ''Generic Instantiation Feature'' feature under the ''Utilities'' category, then click the check box
−
## Back in ''Available Software'' open the update site you just added
+
## Click ''Next'', after some time, the ''Install Details'' page appears
−
## Select ''Event-B EMF Framework'' and ''Event-B TextEditor'' and click ''Install...''
+
## Click ''Next'' and accept the license
 +
## Click ''Finish''
 +
## A ''Security Warning'' window may appear: click ''OK''
 
# Restart Rodin as suggested.
 
# Restart Rodin as suggested.
  
 +
[[Image:GI_Install.jpg|center]]
  
−
Now you are ready to use the TextEditor.
+
Now you are ready to use the Generic Instantiation Feature plug-in.
  
  
−
==Updating ==
+
=== Update ===
−
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).
+
The following steps will guide you through the update process:
−
 
 
−
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:
 
−
 
 
 
# In Rodin open the preferences (''Window'' -> ''Preferences'' or for Mac: ''Rodin'' -> ''Preferences'')
 
# In Rodin open the preferences (''Window'' -> ''Preferences'' or for Mac: ''Rodin'' -> ''Preferences'')
 
# Find ''Install/Update'' -> ''Automatic Updates''
 
# Find ''Install/Update'' -> ''Automatic Updates''
Line 54: Line 33:
 
As soon as Rodin finds a new update it will ask you if you would like to install it.
 
As soon as Rodin finds a new update it will ask you if you would like to install it.
  
 +
=== Release Notes ===
 +
See the [http://wiki.event-b.org/index.php/Generic_Instantiation_Release_History Generic Instantiation Feature Release History].
  
−
==Usage ==
+
== Instantiating ==
−
This section should help you to get started with the TextEditor.
+
=== Running the Instantiate Action ===
−
 
+
The <tt>Instantiate</tt> action launches the instantiation wizard, which will perform the generic instantiation according to the preferences. It is available:
−
====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.
+
|-
−
 
+
|1. Either from the toolbar of the Event-B explorer.  
−
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.
+
|2. Or from the contextual menu, when right-clicking on a machine.
−
 
+
|-
−
====Syntax ====
+
| valign="top" | [[Image:Ins_Explorer.jpg|center]]  
−
The text syntax for machines and contexts is closely related with the pretty-print you might know from the graphical Event-B editor. See the grammar's [[TextEditor_EBNF|EBNF]] for details.
+
| valign="top" | [[Image:Ins_Contextual.jpg|center]]
−
 
+
|}
−
As you might notice in the grammar it only describes the structure of machines and contexts. For the terminals ''predicate'', ''expression'' and ''action'' you can use the syntax for formulas which you already know from editing models with the graphical Event-B editor. You can use the ASCII representation of mathematical symbols or their unicode. See the Rodin help for details about the mathematical symbols and their ASCII counterparts.
 
−
 
 
−
====Editing ====
 
−
The TextEditor currently offers the following features:
 
−
* ''Syntax error marking'': Syntactical errors are highlighted in the input text.
 
−
 
 
−
* ''Mathmatical language'': You can type formulas in ASCII syntax and the TextEditor will replace ASCII symbols with their unicode counterparts as soon as you stop typing for a short while.
 
−
 
 
−
* ''Syntax highlighting'': Keywords (structural and in formulas), labels and comments are highlighted. This happends directly when typing
 
−
 
 
−
* ''Semantic highlighting'': Identifiers are highlighted based on their semantic meaning, i.e., as variables, constants, parameters, sets, local variables. This highlighting is updated when you stop typing for a short while.
 
−
 
 
−
* ''Code completion'': The following elements are available for code completion (invoked by Ctrl+Space on the most computers)
 
−
** ''Keywords''
 
−
** ''Identifiers''
 
−
** ''Templates'' (very few so far, please let us know which templates you would like to add)
 
−
 
 
−
* ''Outline View'': An outline view gives you an overview of the model's structure.
 
−
 
 
−
* ''Quick Navigation'': The outline view allows clicking on an element to jump to its position within the text.
 
−
 
 
−
 
 
−
Of course the TextEditor offers the common features you know from other text editors, such as: copy, paste, moving of text (try Alt+Up or Alt+Down), undo, redo, ...
 
−
 
 
−
====Restrictions ====
 
−
Due to some design decisions and its combination with the Rodin platform the TextEditor comes with a few restrictions:
 
−
* Semantic analysis (for highlighting and code completion for example) can only performed if the overall structure of the input is parsable. Therefore you might experience situtions when the semantic highlighting or the code completion produces unexpected results because it is based on outdated parsing information.
 
−
 
 
−
* Parsing for formulas, i.e., predicates, actions and expressions can only be performed if the overall structure of the input is parsable. If the structure is not parsable ascii symbols will not be replaced until you correct the overall structure.
 
−
 
 
−
* Also see the [[TextEditor_EBNF|EBNF page]] for some restrictions in the syntax.
 
−
 
 
−
 
 
−
==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!''
 
−
 
 
−
 
 
−
====Bugs ====
 
−
* ''please add it when you fine one''
 
−
 
 
−
====Feature Requests ====
 
−
* Make TextEditor an [http://en.wikipedia.org/wiki/Eierlegende_Wollmilchsau Eierlegende Wollmilchsau]... ;-)
 
−
 
 
−
====Comments ====
 
−
Of course any other feedback is welcome too! We appreciate when you let us now what you think about the TextEditor.
 

Revision as of 14:45, 17 December 2012

Introduction

The Generic Instantiation (GI) Feature plug-in allows to instantiate and reuse generic developments in other formal developments..

See the Generic Instantiation page for technical details.

Installing and Updating

Setup

The following steps will guide you through the setup process:

  1. Download Rodin for your platform.
  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 Generic Instantiation Feature plug-in:
    1. In the menu choose Help -> Install New Software...
    2. In the Work with dropdown list, choose the location URL: Rodin
    3. Select the Generic Instantiation Feature feature under the Utilities category, then click the check box
    4. Click Next, after some time, the Install Details page appears
    5. Click Next and accept the license
    6. Click Finish
    7. A Security Warning window may appear: click OK
  5. Restart Rodin as suggested.
GI Install.jpg

Now you are ready to use the Generic Instantiation Feature plug-in.


Update

The following steps will guide you through the update 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.

Release Notes

See the Generic Instantiation Feature Release History.

Instantiating

Running the Instantiate Action

The Instantiate action launches the instantiation wizard, which will perform the generic instantiation according to the preferences. It is available:

1. Either from the toolbar of the Event-B explorer. 2. Or from the contextual menu, when right-clicking on a machine.
Ins Explorer.jpg
Ins Contextual.jpg
Retrieved from ‘https://wiki.event-b.org/index.php?title=Camille_Editor&oldid=5347’