Difference between pages "B2Latex" and "Camille Editor"

From Event-B
(Difference between pages)
Jump to navigationJump to search
imported>Tommy
 
imported>Fabian
 
Line 1: Line 1:
−
B2Latex is a plug-in for Rodin that allows you to export Event-B contexts and machines in Latex files that can then be further rendered.
+
{| align="right"
 +
| __TOC__
 +
|}
 +
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.
  
−
Current Version : 0.5.3
+
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.
  
−
== Installation/Upgrade ==
 
−
The B2latex plugin or "Event-B to Latex exporter" is available from the Main Rodin update site.
 
−
Select the main Rodin Update site from the "work with:" field in the Help > Install New Software menu in Rodin.
 
  
−
== How to use B2Latex? ==
 
−
Righ click on a machine or a context directly from the project explorer and select 'Generate Latex Document' command to produce latex documents.
 
−
The latex docs are generated in the 'latex' folder in your Event-B project directory (i.e. ...\workspaceName\projectName\latex\*.tex) together
 
−
with a style file named ''b2latex.sty''. bsymb.sty and b2latex.sty are required to process the latex.
 
−
You can then run Latex on the source files using your own latex installation.
 
  
−
bsymb.sty can be dowloaded from http://www.event-b.org or https://sourceforge.net/projects/rodin-b-sharp/files/Doc_%20Event%20B%20LaTeX%20style/1.9/
+
{| style="width:auto; background-color:#FFFF00; border:2px solid red;  padding:3px;"
−
== News? ==
+
|<b title="Usage warning"><font size="3"> Warning:</font size="3"></b><font size="1">
−
The B2Latex 0.5.3 is now available from the Rodin update site. It is compatible with Rodin 2.4 and Rodin 2.5.
+
Don't use the TextEditor yet with your production models!
−
Since B2Latex 0.5.1, the command to export files has been moved to the Event-B project explorer. Users can select a machine or a context to produce latex documents directly from
+
* The TextEditor is still in development
−
the project explorer by pressing right click and then select menu 'Generate Latex Document' on the component of their choice. The latex documents are generated in the 'latex' folder like it was done in other previous releases.
+
* It is based on latest SVN Rodin version which uses a changed database model. Therefore its projects cannot be used in older Rodin versions.
  
−
== Tips ==
+
|}
  
−
- If you wish to have math formulas or B code in a comment, you need to put them in $..$.
 
  
−
- The file ''b2latex.sty'' which is generated in the ''latex'' directory can be modified to change the style of the documentation.
 
  
−
- To avoid copying ''bsymb.sty'' to every folder where it is used, please follow the procedure below:
+
==News ==
−
  (If you have used MikTex)
+
* ''27th May 2009'': Update the page due to syntax changes and new version on update-site ('''version 0.0.2''')
−
  (1) copy the bsmb.sty file into the MikTex directory
+
* ''13th May 2009'': Creation of this page and publishing the beta update-site for the first time ('''version 0.0.1'''). Presentation at refocus meeting in Southampton.
−
      (somewhere like C:\Program Files\MiKTeX 2.7\tex\latex),
 
−
  (2) select start -> program -> MikTex 2.x -> setting.
 
−
      You will see a dialog box "MikTeX Options".
 
−
  (3) Select "General" tab and then click "Refresh FNDB" to update to the miktex database.
 
−
 
 
−
  This process makes the bsymb.sty can be used everywhere without copying to any folders.
 
  
−
== Old releases ==
 
−
B2Latex 0.5.1, is now available from the Rodin update site.
 
−
This release is for the Rodin 2.4.x or higher
 
  
−
B2Latex 0.5.0, is now available from the Rodin update site.
+
==Installing ==
−
This release is for the Rodin 0.9.2.x or higher.  
+
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:
  
−
B2Latex 0.4.1 is required for the Rodin 0.9.1.  
+
# Download a build of Rodin from our [http://cruise.cs.uni-duesseldorf.de/dashboard/tab/builds CruiseControl server]:
−
If you want to use the Rodin 0.8.x, you need to install the release 0.3.0 instead.
+
## Point your browser to http://cruise.cs.uni-duesseldorf.de/dashboard/tab/build/detail/org.rodinp.platform
 +
## 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.
 +
# Extract the downloaded zip file.
 +
# Start Rodin from the folder where you extracted the zip file in the previous step.
 +
# Install the TextEditor:
 +
## In the menu choose ''Help'' -> ''Software Updates...''
 +
## Select the tab ''Available Software'' and click ''Add Site...''
 +
## Use the location URL: <tt>http://www.stups.uni-duesseldorf.de/update-beta/</tt>
 +
## Back in ''Available Software'' open the update site you just added
 +
## Select ''Event-B EMF Framework'' and ''Event-B TextEditor'' and click ''Install...''
 +
# Restart Rodin as suggested.
  
−
''How to use old versions?''
 
−
After installation, releases 0.3.x up to 0.5.0, you will see an LX entry in the context menu in the Event-B perspective.
 
−
Select the Machine or Context you want to translate to Latex and then press the LX button.
 
−
A latex source file will be generated in a folder named ''latex''
 
−
in your Event-B project directory (i.e. ...\workspaceName\projectName\latex\*.tex) together
 
−
with a style file named ''b2latex.sty''. bsymb.sty and b2latex.sty are required to process the latex.
 
−
Run latex on the source files using your own latex installation.
 
  
−
bsymb.sty can be dowloaded from http://www.event-b.org or http://sourceforge.net/projects/rodin-b-sharp/
+
Now you are ready to use the TextEditor.
  
  
−
[[Category:User documentation]]
+
==Updating ==
−
[[Category:Plugin]]
+
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:
 +
 
 +
# In Rodin open the preferences (''Window'' -> ''Preferences'' or for Mac: ''Rodin'' -> ''Preferences'')
 +
# Find ''Install/Update'' -> ''Automatic Updates''
 +
# 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 ====
 +
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.
 +
 
 +
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:08, 27 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 latest SVN Rodin version which uses a changed database model. Therefore its projects cannot be used in older Rodin versions.


News

  • 27th May 2009: Update the page due to syntax changes and new version on update-site (version 0.0.2)
  • 13th May 2009: Creation of this page and publishing the beta update-site for the first time (version 0.0.1). Presentation at refocus meeting in Southampton.


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 http://cruise.cs.uni-duesseldorf.de/dashboard/tab/build/detail/org.rodinp.platform
    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

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 EBNF for details.

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 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

Comments

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

Retrieved from ‘https://wiki.event-b.org/index.php?title=B2Latex&oldid=1092’