ramigg / active_scaffold Goto Github PK

******************************************************************************************************
** For all documentation see the project website: http://github.com/vhochstein/active_scaffold/wiki **
******************************************************************************************************

ActiveScaffold Gem/Plugin by Scott Rutherford ([email protected]), Richard White ([email protected]), Lance Ivy ([email protected]), Ed Moss, Tim Harper and Sergio Cambra ([email protected])

Uses DhtmlHistory by Brad Neuberg ([email protected])
http://codinginparadise.org

Uses Querystring by Adam Vandenberg
http://adamv.com/dev/javascript/querystring

Uses Paginator by Bruce Williams
http://paginator.rubyforge.org/

Supports RecordSelect by Lance Ivy
http://code.google.com/p/recordselect/

== Version Information

Please note the following list of Active Scaffold branches and Rails versions. Master will not work with Rails < 3.1

Active Scaffold master currently supports rails-3.1, but incompatible changes can be introduced, if you want an stable version, use rails-3.0
Rails 3.0.*: Active Scaffold rails-3.0
Rails 2.3.*: Active Scaffold rails-2.3 and v2.4
Rails 2.2.*: Active Scaffold rails-2.2
Rails 2.1.*: Active Scaffold rails-2.1
Rails < 2.1: Active Scaffold 1-1-stable (no guarantees)

Since Rails 2.3, render_component plugin is needed for nested and embedded scaffolds. It works with rails-2.3 branch from ewildgoose repository:
script/plugin install git://github.com/ewildgoose/render_component.git -r rails-2.3

Since Rails 3.0 render_component is not used for nesting, but is optional for embedded scaffolds.
Since Rails 3.0, https://github.com/rails/verification.git is also needed.

If you want to install as plugins under vendor/plugins, install these versions:
  rails plugin install git://github.com/vhochstein/render_component.git
  rails plugin install git://github.com/rails/verification.git
  rails plugin install git://github.com/activescaffold/active_scaffold.git -r 'rails-3.0'

If you want to use the gem, add to your Gemfile:
  gem "active_scaffold"

In case you would like to use most recent commit:
  gem 'active_scaffold', :git => 'git://github.com/activescaffold/active_scaffold.git', :branch => 'rails-3.0'

== Pick your own javascript framework

The Rails 3.0 version uses unobtrusive Javascript, so you are free to pick your javascript framework.
Out of the box Prototype or JQuery are supported:

Prototype 1.7 (default js framework)
rails.js in git://github.com/vhochstein/prototype-ujs.git

JQuery 1.4.1, 1.4.2
https://github.com/vhochstein/jquery-ujs/raw/jquery1_4_2/src/rails.js

JQuery > 1.4.2
https://github.com/vhochstein/jquery-ujs/raw/master/src/rails.js

To configure the javascript framework when installed under vendor/plugins/
uncomment last line in config/initializers/active_scaffold.rb in order to use jquery instead of prototype.
That file is created when you install ActiveScaffold as a plugin.

To configure the javascript framework when installed as a gem:
Add a config/initializers/active_scaffold.rb containing:
ActiveScaffold.js_framework = :jquery # :prototype is the default

== Rails 3.1 compatible branch: 
under construction


Released under the MIT license (included)