Difference between revisions of "B2Latex"

From Event-B
Jump to: navigation, search
m (Tips)
 
(16 intermediate revisions by 4 users not shown)
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.
 
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.
 +
 +
Current Version : 0.7.0
  
 
== Installation/Upgrade ==
 
== Installation/Upgrade ==
The B2latex plugin is available from the Main Rodin update site.
+
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.
 
Select the main Rodin Update site from the "work with:" field in the Help > Install New Software menu in Rodin.
 +
The plug-in is available under the ''Utilities'' category.
 +
 +
== How to use B2Latex? ==
 +
Right click on a machine, a context or an Event-B project 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.
 +
 +
The file ''b2latex.sty'' which is generated in the ''latex'' directory can be modified to change the style of the documentation.
  
== How to use B2Latex ==
+
Since B2Latex 0.6.1, this file won't be overwritten if already exists, so no user modifications are accidentally lost.
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 http://sourceforge.net/projects/rodin-b-sharp/
+
Note: B2Latex 0.7.0 has changed the structure of the ''b2latex.sty''. For upgrade to new format simple delete this file and
 +
B2Latex will regenerate it again. However, any custom modifications are lost and you have to apply them again.
  
 +
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/
 
== News? ==
 
== News? ==
B2Latex 0.5.1 is now available from the Rodin update site. This
+
The B2Latex 0.7.0 is now available from the Rodin update site and has been tested with the Rodin 3.2.
release is for Rodin 0.9.2 or later. The interface of the release
+
 
has been moved to the Event-B project explorer. Users can select  
+
Since B2Latex 0.5.1, the command to export files has been moved to the Event-B project explorer.
(right click and then select menu 'Generate Latex Document') a machine or a context to produce latex documents directly from
+
Users can select a machine, a context or a whole Event-B project to produce latex documents directly from
the project explorer. The latex docs are generated in the 'latex' folder as same as other previous releases.
+
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.
  
 
== Tips ==
 
== Tips ==
  
 
- If you wish to have math formulas or B code in a comment, you need to put them in $..$.
 
- 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:
 
- To avoid copying ''bsymb.sty'' to every folder where it is used, please follow the procedure below:
Line 37: Line 44:
  
 
== Old releases ==
 
== Old releases ==
 +
B2Latex 0.5.5, is now available from the Rodin update site.
 +
This release is for the Rodin 2.5 up to Rodin 3.x.
 +
 +
B2Latex 0.5.4, is now available from the Rodin update site.
 +
This release is for the Rodin 2.4.x or higher
 +
 +
B2Latex 0.5.3, is now available from the Rodin update site.
 +
This release is for the Rodin 2.4.x or higher
 +
 +
B2Latex 0.5.2, is now available from the Rodin update site.
 +
This release is for the Rodin 2.4.x or higher
 +
 +
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.
 
B2Latex 0.5.0, is now available from the Rodin update site.
 
This release is for the Rodin 0.9.2.x or higher.  
 
This release is for the Rodin 0.9.2.x or higher.  

Latest revision as of 17:22, 8 July 2016

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.

Current Version : 0.7.0

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. The plug-in is available under the Utilities category.

How to use B2Latex?

Right click on a machine, a context or an Event-B project 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.

The file b2latex.sty which is generated in the latex directory can be modified to change the style of the documentation.

Since B2Latex 0.6.1, this file won't be overwritten if already exists, so no user modifications are accidentally lost.

Note: B2Latex 0.7.0 has changed the structure of the b2latex.sty. For upgrade to new format simple delete this file and B2Latex will regenerate it again. However, any custom modifications are lost and you have to apply them again.

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/

News?

The B2Latex 0.7.0 is now available from the Rodin update site and has been tested with the Rodin 3.2.

Since B2Latex 0.5.1, the command to export files has been moved to the Event-B project explorer. Users can select a machine, a context or a whole Event-B project to produce latex documents directly from 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.

Tips

- If you wish to have math formulas or B code in a comment, you need to put them in $..$.

- To avoid copying bsymb.sty to every folder where it is used, please follow the procedure below:

 (If you have used MikTex) 
  (1) copy the bsmb.sty file into the MikTex directory
     (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.5, is now available from the Rodin update site. This release is for the Rodin 2.5 up to Rodin 3.x.

B2Latex 0.5.4, is now available from the Rodin update site. This release is for the Rodin 2.4.x or higher

B2Latex 0.5.3, is now available from the Rodin update site. This release is for the Rodin 2.4.x or higher

B2Latex 0.5.2, is now available from the Rodin update site. This release is for the Rodin 2.4.x or higher

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. This release is for the Rodin 0.9.2.x or higher.

B2Latex 0.4.1 is required for the Rodin 0.9.1. If you want to use the Rodin 0.8.x, you need to install the release 0.3.0 instead.

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/