=== EBNFer ===
Contributors: pajtai
Donate link: http://netlumination.com/
Tags: ebnf, diagrams, railroad diagrams, Extended Backus–Naur Form
Requires at least: 2.5
Tested up to: 3.2.1
Stable tag: 0.2

EBNFer is a railroad diagram generator for Wordpress. It lets you use Wordpress shortcodes to parse and render Extended Backus–Naur Form diagrams.

== Description ==

The EBNF parser and renderer is built off of the one created by Vincent Tscherter ( http://karmin.ch/ebnf/index ).

The diagrams are stored / cached as PNG images.

Enclose your grammar defintions within `[ebnf]` shortcodes using the form: `[ebnf] GRAMMAR [/ebnf]`

You can use any of three optional addtributes

* title - Define the generated image title
* alt   - Define the generated image alt tag
* link  - Set to, "no" if you don't want the image tag to link to the image file

For the grammar group things with parentheses `()`. Use `|` for "or", use `[...]` for one or more times,
and `{...}` for zero or more times. 

Enclose the entire grammar in `{...}` and included and optional title with `"..."`

For example here is how you would create railroad diagrams for JSON with EBNFer:
<pre>
[ebnf title="JSON RR Diagram"]
"JSON" {
object = "{" [ ( string ':' value ) { ',' string ':' value }  ] "}".
array = '['  [ value { ',' value } ] ']'.
}
[/ebnf]
</pre>

= Stay tuned for =

* Smarter image caching
* Smarter renderer
* Switch out bracket styled grammar definitions with Regex styled grammar definitions

== Installation ==

* Download EBNFer
* Unzip the file
* Upload the "plugeshin" directory and contents to the wp-content/plugins directory on your server.
* In the WP-Admin panel navigate to the Plugins page.
* Click the `Activate` option for PluGeSHin.

== Frequently Asked Questions ==

= Will the PNG image be updated if I update my grammer? =

* Yes. The PNG images are stored with file names that are MD5 hashes of your grammer, so if you change your
grammer, a new image will be created.

= Can I delete the PNG images in the `plugins/ebnfer/images` folder? =

* Yes. If an image is not there EBNFer will just render and cache it again.

== Screenshots ==

1. JSON RR diagram created using the example code in the description.
2. A RR diagram explaining the grammar to create RR diagrams with EBNFer

== Changelog ==

= 0.1 =

* First release

= 0.2 =

* Remove arrows and replace with contours. 

== Upgrade Notice ==

= 0.2 =

* Arrows replaced with line contours. All your images will be re-rendered and re-cached after this upgrade.