Read Me

/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
/* READ ME                                                                    */
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/

BNF4OOo, 2011-06-06
===================
Mag. Franz Hohenegger

Goals:
======

This software can handle different BNF variations (BNF from ALGOL_60,
EBNF from XML Specification, ABNF from RFC 2234,..) and allows the user to
create own customized standards. Raildiagrams of different formats
(Ascii Image, Unicode Image, "boxed-Unicode image") can be generated from each
standard. For further purposes each format can be transfered to an XML structure
based on IBMs DITA standard. Diagrams can also be generated from this standard.

This transferring processes are done either in a command shell (tested with
Windows CMD and Linux bash) or embedded in OpenOffice.

Important Notes:
================

.) Due to coding issues in windows, only elements with ASCII characters can be printed into diagrams.

System Requirements:
====================

.) Windows XP or a newer Version (may work with older versions, but not tested)
   or
.) Linux Distribution (tested with Ubuntu 10.04 and Fedora 12)
   you can get Ubuntu here:
   http://www.ubuntu.com/

.) ooRexx4.x
   you can get it here:
   http://www.oorexx.org/

.) bsf4oorexx
   you can get it here:
   http://wi.wu.ac.at/rgf/rexx/bsf4oorexx/archive/2011/2011-03-27/

.) OpenOffice 2.x (if you want to use the program embedded in Open Office)

.) log4rexx
   this program is embedded in BSF4OOo, for the newest version see:
   http://wi.wu.ac.at/rgf/rexx/orx18/log4r/

BSF4Shell
=========

Installation
------------

.) Download the source code in any folder you prefer on your system.


Usage
-----

.) The program is started with executing BNF4Shell.rex

      Command: rexx BNF4Shell.rex


BSF4OOo
=======


Install BNF4OOo
---------------

System requirements:

BNF4OOo should run on any Desktop with Windows(XP or newer) or Linux.
I personally tested it with Linux Ubuntu (9.04+).

-> Sofware requirements:

Before Installing BNF4OOo you need to install this programs:

	ooRexx4.1 or higher
	http://www.oorexx.org/

 	BSF4ooRexx (bridges ooRexx and Java)
	http://sourceforge.net/projects/bsf4oorexx/files/

 	OpenOffice 2.x or higher
	http://www.openoffice.org/

	Java SDK
	http://www.java.com/

-> Installation:

To install BNF4OOo simply:

   1) Open your CMD (Windows) or a shell (Linux) and go into the BNF4OOo
      directory (the directory where this readme is stored in).

   2) Run installBNF4OOo.rex
	rexx installBNF4OOo.rex

	Thats all!

Now you can start BNF4OOo either from the CMD/shell or from inside OOo.

-> Uninstall:

Same thing as the installation, just change the parameter -i to -u.

	rexx installBNF4OOo.rex -u

Or, even simpler, click the "Uninstall BNF4OOo" button.