ruby script/plugin install http://publicsvn.carpeliam.com/tableau_engine/

== Installation

1. Create your Rails application, set up your databases, grab the Engines plugin and the TableauEngine, and install them.

2. Install the TableauEngine into your vendor/plugins directory

3. Modify your Engines.start call in config/environment.rb

    Engines.start :tableau # or :tableau_engine

4. Edit your application.rb file so it looks something like the following (optional):

    class ApplicationController < ActionController::Base
      include TableauEngine
    end

5. Edit your application_helper.rb file (optional):

    module ApplicationHelper
      include TableauEngine
    end

6. Perform any configuration you might need. You'll probably want to set these values in environment.rb (before the call to Engines.start):

    module TableauEngine
      config :some_option, "some_value"
    end

7. Initialize the database tables. You can either use the engine migrations by calling:

    rake engine_migrate

to move all engines to their latest versions, or

    rake engine_migrate ENGINE=tableau

to migrate only this engine.

8. The TableauEngine provides a default stylesheet and a small javascript helper file, so you'll probably want to include the former and almost certainly the latter in your application's layout. Add the following lines:

      <%= engine_stylesheet "tableau_engine" %>
      <%= engine_javascript "tableau_engine" %>

== Configuration

A number of configuration parameters are available to allow to you control how the data is stored, should you be unhappy with the defaults. These are outlined below.

  module TableauEngine
    config :some_option, "some_value"
  end

=== Configuration Options
+some_option+:: This option will set some_value

There is currently no advanced documentation for this plugin.