ShadowBelmolve-formtastic 0.2.1 → 0.9.7

data/README.textile

@@ -2,9 +2,6 @@ h1. Formtastic
 
 Formtastic is a Rails FormBuilder DSL (with some other goodies) to make it far easier to create beautiful, semantically rich, syntactically awesome, readily stylable and wonderfully accessible HTML forms in your Rails applications.
 
-* This fork: http://github.com/ShadowBelmolve/formtastic
-* Forked from: http://github.com/justinfrench/formtastic/tree/master
-
 h2. The Story
 
 One day, I finally had enough, so I opened up my text editor, and wrote a DSL for how I'd like to author forms:
@@ -45,34 +42,34 @@ I also wrote the accompanying HTML output I expected, favoring something very si
 
 h2. It's better than _SomeOtherFormBuilder_ because...
 
-* it can handle @belongs_to@ associations (like Post belongs_to :author), rendering a select or set of radio inputs with choices from the parent model
-* it can handle @has_many@ and @has_and_belongs_to_many@ associations (like Post has_many :tags), rendering a multi-select with choices from the child models
-* it's Rails 2.3-ready (including nested forms)
+* it can handle @belongs_to@ associations (like Post belongs_to :author), rendering a select or set of radio inputs with choices from the parent model.
+* it can handle @has_many@ and @has_and_belongs_to_many@ associations (like: Post has_many :tags), rendering a multi-select with choices from the child models.
+* it's Rails 2.3-ready (including nested forms).
 * it has internationalization (I18n)!
-* it's _really_ quick to get started with a basic form in place (4 lines), then go back to add in more detail if you need it
-* there's heaps of elements, id and class attributes for you to hook in your CSS and JS
-* it handles real world stuff like inline hints, inline error messages & help text
-* it doesn't hijack or change any of the standard Rails form inputs, so you can still use them as expected (even mix and match)
-* it's got absolutely awesome spec coverage
-* there's a bunch of people using and working on it (it's not just one developer building half a solution)
+* it's _really_ quick to get started with a basic form in place (4 lines), then go back to add in more detail if you need it.
+* there's heaps of elements, id and class attributes for you to hook in your CSS and JS.
+* it handles real world stuff like inline hints, inline error messages & help text.
+* it doesn't hijack or change any of the standard Rails form inputs, so you can still use them as expected (even mix and match).
+* it's got absolutely awesome spec coverage.
+* there's a bunch of people using and working on it (it's not just one developer building half a solution).
 
 
 h2. Why?
 
-* web apps = lots of forms
-* forms are so friggin' boring to code
-* semantically rich & accessible forms really are possible
-* the "V" is way behind the "M" and "C" in Rails' MVC – it's the ugly sibling
-* best practices and common patterns have to start somewhere
-* i need a challenge
+* web apps = lots of forms.
+* forms are so friggin' boring to code.
+* semantically rich & accessible forms really are possible.
+* the "V" is way behind the "M" and "C" in Rails' MVC – it's the ugly sibling.
+* best practices and common patterns have to start somewhere.
+* i need a challenge.
 
 
 h2. Opinions
 
-* it should be easier to do things the right way than the wrong way
-* sometimes _more mark-up_ is better
-* elements and attribute hooks are _gold_ for stylesheet authors
-* make the common things we do easy, yet still ensure uncommon things are still possible
+* it should be easier to do things the right way than the wrong way.
+* sometimes _more mark-up_ is better.
+* elements and attribute hooks are _gold_ for stylesheet authors.
+* make the common things we do easy, yet still ensure uncommon things are still possible.
 
 
 h2. Documentation
@@ -82,24 +79,29 @@ RDoc documentation _should_ be automatically generated after each commit and mad
 
 h2. Installation
 
-You can (and should) get it as a gem:
+The gem is hosted on gemcutter, so *if you haven't already*, add it as a gem source:
 
 <pre>
-  gem install ShadowBelmolve-formtastic
+  sudo gem sources -a http://gemcutter.org/
 </pre>
 
-And then add it as a dependency in your environment.rb file:
+Then install the Formtastic gem:
 
 <pre>
-  config.gem "ShadowBelmolve-formtastic", 
-    :lib     => 'formtastic', 
-    :source  => 'http://gems.github.com'
+  sudo gem install formtastic
 </pre>
 
-If you're a little more old school, install it as a plugin:
+Optionally, run @./script/generate formtastic@ to copy the following files into your app:
+
+* @config/initializers/formtastic.rb@ - a commented out Formtastic config initializer
+* @public/stylesheets/formtastic.css@
+* @public/stylesheets/formtastic_changes.css@
+
+A proof-of-concept stylesheet is provided which you can include in your layout. Customization is best achieved by overriding these styles in an additional stylesheet so that the Formtastic styles can be updated without clobbering your changes. If you want to use these stylesheets, add both to your layout:
 
 <pre>
-  ./script/plugin install git://github.com/justinfrench/formtastic.git
+  <%= stylesheet_link_tag "formtastic" %>
+  <%= stylesheet_link_tag "formtastic_changes" %>
 </pre>
 
 
@@ -107,7 +109,7 @@ h2. Usage
 
 Forms are really boring to code... you want to get onto the good stuff as fast as possible.
 
-This renders a set of inputs (one for _most_ columns in the database table, and one for each ActiveRecord belongs_to association), followed by a submit button:
+This renders a set of inputs (one for _most_ columns in the database table, and one for each ActiveRecord @belongs_to@-association), followed by a submit button:
 
 <pre>
   <% semantic_form_for @user do |form| %>
@@ -125,7 +127,7 @@ If you want to specify the order of the fields, skip some of the fields or even
   <% end %>
 </pre>
 
-If you want control over the input type Formtastic uses for each field, you can expand the @inputs@ and @buttons@ blocks.  This specifies the :section input should be a set of radio buttons (rather than the default select box), and that the :created_at field should be a string (rather than the default datetime selects):
+If you want control over the input type Formtastic uses for each field, you can expand the @inputs@ and @buttons@ blocks. This specifies the @:section@ input should be a set of radio buttons (rather than the default select box), and that the @:created_at@ field should be a string (rather than the default datetime selects):
 
 <pre>
   <% semantic_form_for @post do |form| %>
@@ -146,7 +148,7 @@ If you want to customize the label text, or render some hint text below the fiel
 
 <pre>
   <% semantic_form_for @post do |form| %>
-    <% form.inputs :name => "Basic", :id => "basic" do %>
+    <% form.inputs "Basic", :id => "basic" do %>
       <%= form.input :title %>
       <%= form.input :body %>
     <% end %>
@@ -163,14 +165,13 @@ If you want to customize the label text, or render some hint text below the fiel
   <% end %>
 </pre>
 
-
 Nested forms (Rails 2.3) are also supported. You can do it in the Rails way:
 
 <pre>
   <% semantic_form_for @post do |form| %>
     <%= form.inputs :title, :body, :created_at %>
     <% form.semantic_fields_for :author do |author| %>
-      <%= author.inputs :first_name, :last_name, :name => 'Author' %>
+      <%= author.inputs :first_name, :last_name, :name => "Author" %>
     <% end %>
     <%= form.buttons %>
   <% end %>
@@ -186,7 +187,7 @@ Or the Formtastic way with the @:for@ option:
   <% end %>
 </pre>
 
-When working in has many association, you can even supply "%i" in your fieldset name that it will be properly interpolated with the child index. For example:
+When working in has many association, you can even supply @"%i"@ in your fieldset name that it will be properly interpolated with the child index. For example:
 
 <pre>
   <% semantic_form_for @post do |form| %>
@@ -197,7 +198,7 @@ When working in has many association, you can even supply "%i" in your fieldset
 </pre>
 
 
-Customize HTML attributes for any input using the @:input_html@ option.  Typically his is used to disable the input, change the size of a text field, change the rows in a textarea, or even to add a special class to an input to attach special behavior like "autogrow":http://plugins.jquery.com/project/autogrow textareas:
+Customize HTML attributes for any input using the @:input_html@ option. Typically his is used to disable the input, change the size of a text field, change the rows in a textarea, or even to add a special class to an input to attach special behavior like "autogrow":http://plugins.jquery.com/project/autogrow textareas:
 
 <pre>
   <% semantic_form_for @post do |form| %>
@@ -219,8 +220,8 @@ The same can be done for buttons with the @:button_html@ option:
   <% end %>
 </pre>
 
-Customize the HTML attributes for the @<li>@ wrapper around every input with the @:wrapper_html@ option hash.  There's one special key in the hash (:class), which will actually _append_ your string of classes to the existing classes provided by Formtastic (like "required string error")
-  
+Customize the HTML attributes for the @<li>@ wrapper around every input with the @:wrapper_html@ option hash. There's one special key in the hash (@:class@), which will actually _append_ your string of classes to the existing classes provided by Formtastic (like @"required string error"@)
+
 <pre>
   <% semantic_form_for @post do |form| %>
     <%= form.input :title, :wrapper_html => { :class => "important" } %>
@@ -231,37 +232,35 @@ Customize the HTML attributes for the @<li>@ wrapper around every input with the
 </pre>
 
 
-
 h2. The Available Inputs
 
-* :select (a select menu) - default for ActiveRecord associations (belongs_to, has_many, has_and_belongs_to_many)
-* :check_boxes (a set of check_box inputs) - alternative to :select has_many and has_and_belongs_to_many associations
-* :radio (a set of radio inputs) - alternative to :select for ActiveRecord belongs_to associations
-* :time_zone (a select input) - default for :string column types with 'time_zone' in the method name
-* :password (a password input) - default for :string column types with 'password' in the method name
-* :text (a textarea) - default for :text column types
-* :date (a date select) - default for :date column types
-* :datetime (a date and time select) - default for :datetime and :timestamp column types
-* :time (a time select) - default for :time column types
-* :boolean (a checkbox) - default for :boolean column types
-* :string (a text field) - default for :string column types
-* :numeric (a text field, like string) - default for :integer, :float and :decimal column types
-* :file (a file field) - default for paperclip or attachment_fu attributes
-* :country (a select menu of country names) - default for :string columns named "country", requires a country_select plugin to be installed
-* :hidden (a hidden field) - creates a hidden field (added for compatibility)
-
-
-The documentation is pretty good for each of these (what it does, what the output is, what the options are, etc) so go check it out.
+The Formtastic input types:
+
+* @:select@ - a select menu. Default for ActiveRecord associations: @belongs_to@, @has_many@, and @has_and_belongs_to_many@.
+* @:check_boxes@ - a set of check_box inputs. Alternative to @:select@ for ActiveRecord-associations: @has_many@, and @has_and_belongs_to_many@.
+* @:radio@ - a set of radio inputs. Alternative to @:select@ for ActiveRecord-associations: @belongs_to@.
+* @:time_zone@ - a select input. Default for column types: @:string@ with name matching @"time_zone"@.
+* @:password@ - a password input. Default for column types: @:string@ with name matching @"password"@.
+* @:text@ - a textarea. Default for column types: @:text@.
+* @:date@ - a date select. Default for column types: @:date@.
+* @:datetime@ - a date and time select. Default for column types: @:datetime@ and @:timestamp@.
+* @:time@ - a time select. Default for column types: @:time@.
+* @:boolean@ - a checkbox. Default for column types: @:boolean@.
+* @:string@ - a text field. Default for column types: @:string@.
+* @:numeric@ - a text field (just like string). Default for  column types: @:integer@, @:float@, and @:decimal@.
+* @:file@ - a file field. Default for file-attachment attributes matching: "paperclip":http://github.com/thoughtbot/paperclip or "attachment_fu":http://github.com/technoweenie/attachment_fu.
+* @:country@ - a select menu of country names. Default for column types: :string with name @"country"@ - requires a *country_select* plugin to be installed.
+* @:hidden@ - a hidden field. Creates a hidden field (added for compatibility).
+
+The documentation is pretty good for each of these (what it does, what the output is, what the options are, etc.) so go check it out.
 
 h2. Internationalization (I18n)
 
-Formtastic got some neat I18n-features. ActiveRecord object names and attributes are, by default, taken from calling @object.human_name and @object.human_attribute_name(attr) respectively. There are a few words specific to Formtastic that can be translated. See lib/locale/en.yml for more information.
+h3. Basic Localization
 
-h3. Label/Hint-localization
+Formtastic got some neat I18n-features. ActiveRecord object names and attributes are, by default, taken from calling @@object.human_name@ and @@object.human_attribute_name(attr)@ respectively. There are a few words specific to Formtastic that can be translated. See @lib/locale/en.yml@ for more information.
 
-Formtastic supports localized *labels* and *hints* using the I18n API for more advanced usage. Your forms can now be DRYer and more flexible than ever, and still fully localized. This is how:
-
-Basic localization (labels only):
+Basic localization (labels only, with ActiveRecord):
 
 <pre>
   <% semantic_form_for @post do |form| %>
@@ -271,50 +270,83 @@ Basic localization (labels only):
   <% end %>
 </pre>
 
-*Note:* This is perfectly fine if you just want your labels to be translated using *ActiveRecord I18n attribute translations*, and you don't use input hints. But what if you do? And what if you don't want same labels in all forms?
+*Note:* This is perfectly fine if you just want your labels/attributes and/or models to be translated using *ActiveRecord I18n attribute translations*, and you don't use input hints and legends. But what if you do? And what if you don't want same labels in all forms?
+
+h3. Enhanced Localization (Formtastic I18n API)
 
-Enhanced localization (labels and hints):
+Formtastic supports localized *labels*, *hints*, *legends*, *actions* using the I18n API for more advanced usage. Your forms can now be DRYer and more flexible than ever, and still fully localized. This is how:
 
-1. Enable I18n lookups by default (@config/initializers/formtastic.rb@):
+*1. Enable I18n lookups by default (@config/initializers/formtastic.rb@):*
 
 <pre>
   Formtastic::SemanticFormBuilder.i18n_lookups_by_default = true
 </pre>
 
-2. Add some cool label-translations/variants (@config/locale/en.yml@):
+*2. Add some cool label-translations/variants (@config/locale/en.yml@):*
 
 <pre>
   en:
     formtastic:
+      titles:
+        post_details: "Post details"
       labels:
         post:
           title: "Choose a title..."
           body: "Write something..."
+          edit:
+            title: "Edit title"
       hints:
         post:
           title: "Choose a good title for you post."
           body: "Write something inspiring here."
+      actions:
+        create: "Create my {{model}}"
+        update: "Save changes"
+        dummie: "Launch!"
 </pre>
 
 *Note:* We are using English here still, but you get the point.
 
-3. ...and now you'll get:
+*3. ...and now you'll get:*
 
 <pre>
-  <% semantic_form_for @post do |form| %>
-    <%= form.input :title %>      # => :label => "Choose a title...", :hint => "Choose a good title for you post."
-    <%= form.input :body %>       # => :label => "Write something...", :hint => "Write something inspiring here."
-    <%= form.input :section %>    # => :label => I18n.t('activerecord.attributes.user.section')  or 'Section'
+  <% semantic_form_for Post.new do |form| %>
+    <% form.inputs do %>
+      <%= form.input :title %>      # => :label => "Choose a title...", :hint => "Choose a good title for you post."
+      <%= form.input :body %>       # => :label => "Write something...", :hint => "Write something inspiring here."
+      <%= form.input :section %>    # => :label => I18n.t('activerecord.attributes.user.section')  or 'Section'
+    <% end %>
+    <% form.buttons do %>
+      <%= form.commit_button %>     # => "Create my {{model}}"
+    <% end %>
   <% end %>
 </pre>
 
-4. Override I18n settings:
+*4. Localized titles (a.k.a. legends):*
+
+_Note: Slightly different because Formtastic can't guess how you group fields in a form. Legend text can be set with first (as in the sample below) specified value, or :name/:title options - depending on what flavor is preferred._
+
+<pre>
+  <% semantic_form_for @post do |form| %>
+    <% form.inputs :post_details do %>   # => :title => "Post details"
+      # ...
+    <% end %>
+    # ...
+<% end %>
+</pre>
+
+*5. Override I18n settings:*
 
 <pre>
   <% semantic_form_for @post do |form| %>
-    <%= form.input :title %>      # => :label => "Choose a title...", :hint => "Choose a good title for you post."
-    <%= form.input :body, :hint => false %>     # => :label => "Write something..."
-    <%= form.input :section %>    # => :label => I18n.t('activerecord.attributes.user.section')  or 'Section'
+    <% form.inputs do %>
+      <%= form.input :title %>      # => :label => "Choose a title...", :hint => "Choose a good title for you post."
+      <%= form.input :body, :hint => false %>                 # => :label => "Write something..."
+      <%= form.input :section, :label => 'Some section' %>    # => :label => 'Some section'
+    <% end %>
+    <% form.buttons do %>
+      <%= form.commit_button :dummie %>     # => "Launch!"
+    <% end %>
   <% end %>
 </pre>
 
@@ -328,25 +360,30 @@ If I18n-lookups is disabled, i.e.:
 
 <pre>
   <% semantic_form_for @post do |form| %>
-    <%= form.input :title, :label => true %>      # => :label => "Choose a title..."
-    <%= form.input :body, :label => true %>       # => :label => "Write something..."
-    <%= form.input :section, :label => true %>    # => :label => I18n.t('activerecord.attributes.user.section')  or 'Section'
+    <% form.inputs do %>
+      <%= form.input :title, :label => true %>      # => :label => "Choose a title..."
+      <%= form.input :body, :label => true %>       # => :label => "Write something..."
+      <%= form.input :section, :label => true %>    # => :label => I18n.t('activerecord.attributes.user.section')  or 'Section'
+    <% end %>
+    <% form.buttons do %>
+      <%= form.commit_button true %>                # => "Save changes" (if we are in edit that is...)
+    <% end %>
   <% end %>
 </pre>
 
-5. Advanced I18n lookups
+*6. Advanced I18n lookups*
 
 For more flexible forms; Formtastic find translations using a bottom-up approach taking the following variables in account:
 
-* @model@, e.g. "post"
-* @action@, e.g. "edit"
-* @attribute@, e.g. "title"
+* @MODEL@, e.g. "post"
+* @ACTION@, e.g. "edit"
+* @KEY/ATTRIBUTE@, e.g. "title", :my_custom_key, ...
 
 ...in the following order:
 
-1. @formtastic.{labels,hints}.MODEL.ACTION.ATTRIBUTE@       # By model and action
-2. @formtastic.{labels,hints}.MODEL.ATTRIBUTE@              # By model
-3. @formtastic.{labels,hints}.ATTRIBUTE@                    # Global default
+1. @formtastic.{titles,labels,hints,actions}.MODEL.ACTION.ATTRIBUTE@ - by model and action
+2. @formtastic.{titles,labels,hints,actions}.MODEL.ATTRIBUTE@ - by model
+3. @formtastic.{titles,labels,hints,actions}.ATTRIBUTE@ - global default
 
 ...which means that you can define translations like this:
 
@@ -364,139 +401,117 @@ For more flexible forms; Formtastic find translations using a bottom-up approach
           edit:
             title: "Edit title"
             body: "Edit body"
-      ...
 </pre>
 
+Values for @labels@/@hints@/@actions@ are can take values: @String@ (explicit value), @Symbol@ (i18n-lookup-key relative to the current "type", e.g. actions:), @true@ (force I18n lookup), @false@ (force no I18n lookup). Titles (legends) can only take: @String@ and @Symbol@ - true/false have no meaning.
+
+
 h2. ValidationReflection plugin
 
-If you have the "ValidationReflection":http://github.com/redinger/validation_reflection plugin installed, you won't have to specify the :required option (it checks the validations on the model instead).
+If you have the "ValidationReflection":http://github.com/redinger/validation_reflection plugin installed, you won't have to specify the @:required@ option (it checks the validations on the model instead).
+
 
 h2. Configuration
 
-If you wish, put something like this in config/initializers/formtastic_config.rb:
+Run @./script/generate formtastic@ to copy a commented out config file into @config/initializers/formtastic.rb@. You can "view the configuration file on GitHub":http://github.com/justinfrench/formtastic/blob/master/generators/formtastic/templates/formtastic.rb
+
+
+h2. Form Generator
+
+There's a Formtastic form code generator to make your transition to Formtastic easier. All you have to do is to *specify an existing model name*, and optionally specify view template framework (ERB/HAML), and you are good to go. *Note:* This won't overwrite any of you stuff. This is how you use it:
+
+*Alt. 1: Generate in terminal:*
 
 <pre>
-  # Set the default text field size when input is a string. Default is 50
-  Formtastic::SemanticFormBuilder.default_text_field_size = 30
-
-  # Should all fields be considered "required" by default
-  # Defaults to true, see ValidationReflection notes below
-  Formtastic::SemanticFormBuilder.all_fields_required_by_default = false
-  
-  # Set the string that will be appended to the labels/fieldsets which are required
-  # It accepts string or procs and the default is a localized version of
-  # '<abbr title="required">*</abbr>'. In other words, if you configure formtastic.required
-  # in your locale, it will replace the abbr title properly. But if you don't want to use
-  # abbr tag, you can simply give a string as below
-  Formtastic::SemanticFormBuilder.required_string = "(required)"
-  
-  # Set the string that will be appended to the labels/fieldsets which are optional
-  # Defaults to an empty string ("") and also accepts procs (see required_string above)
-  Formtastic::SemanticFormBuilder.optional_string = "(optional)"
-
-  # Set the way inline errors will be displayed.
-  # Defaults to :sentence, valid options are :sentence, :list and :none
-  Formtastic::SemanticFormBuilder.inline_errors = :list
-
-  # Set the method to call on label text to transform or format it for human-friendly
-  # reading when formtastic is user without object. Defaults to :humanize.
-  Formtastic::SemanticFormBuilder.label_str_method = :titleize
-
-  # Set the array of methods to try calling on parent objects in :select and :radio inputs
-  # for the text inside each @<option>@ tag or alongside each radio @<input>@.  The first method
-  # that is found on the object will be used.
-  # Defaults to ["to_label", "display_name", "full_name", "name", "title", "username", "login", "value", "to_s"]
-  Formtastic::SemanticFormBuilder.collection_label_methods = ["title_and_author", "display_name", "login", "to_s"]
-
-  # Formtastic by default renders inside li tags the input, hints and then
-  # errors messages. Sometimes you want the hints to be rendered first than
-  # the input, in the following order: hints, input and errors. You can
-  # customize it doing just as below:
-  Formtastic::SemanticFormBuilder.inline_order = [:hints, :input, :errors]
-  
-  # Set the default "priority countries" to suit your user base when using :as => :country
-  Formtastic::SemanticFormBuilder.priority_countries = ["Australia", "New Zealand"]
-  
-  # Specifies if labels/hints for input fields automatically be looked up using I18n.
-  # Default value: false. Overridden for specific fields by setting value to true,
-  # i.e. :label => true, or :hint => true (or opposite depending on initialized value)
-  # Formtastic::SemanticFormBuilder.i18n_lookups_by_default = false
+$ ./script/generate form Post
+# ---------------------------------------------------------
+#  GENERATED FORMTASTIC CODE
+# ---------------------------------------------------------
+
+<% form.inputs do %>
+  <%= form.input :title, :label => 'Title' %>
+  <%= form.input :body, :label => 'Body' %>
+  <%= form.input :published, :label => 'Published' %>
+<% end %>
+
+# ---------------------------------------------------------
+ Copied to clipboard - just paste it!
 </pre>
 
-h2. Status
+*Alt. 2: Generate partial:*
 
-*THINGS ARE GOING TO CHANGE A BIT BEFORE WE HIT 1.0.*
+<pre>
+$ ./script/generate form Post --partial
+      exists  app/views/posts
+      create  app/views/posts/_form.html.erb
+</pre>
 
-It's a work in progress and a bit rough around the edges still, but I hope you try it and offer some suggestions and improvements anyway.
+To generate *HAML* markup, just add the @--haml@ as argument:
 
-On the plus side, it has a comprehensive spec suite and contributions from at least ten independent developers.
+<pre>
+$ ./script/generate form Post --haml
+      exists  app/views/admin/posts
+      create  app/views/admin/posts/_form.html.haml
+</pre>
 
-"Wishlist":http://wiki.github.com/justinfrench/formtastic/wishlist on the wiki is serving as pretty good documentation for the roadmap to 1.0 and beyond right now, but I'll work on getting a real tracking system or something happening soon.
+To specify the controller in a namespace (eg admin/posts instead of posts), use the --controller argument:
 
+<pre>
+$ ./script/generate form Post --partial --controller admin/posts
+      exists  app/views/admin/posts
+      create  app/views/admin/posts/_form.html.erb
+</pre>
 
-h2. Dependencies
 
-There are none, but...
+h2. Custom Inputs
 
-* if you have the "ValidationReflection":http://github.com/redinger/validation_reflection plugin is installed, you won't have to specify the :required option (it checks the validations on the model instead)
-* if you want to use the :country input, you'll need to install the "iso-3166-country-select plugin":http://github.com/rails/iso-3166-country-select (or any other country_select plugin with the same API)
-* rspec, rspec_hpricot_matchers and rcov gems (plus any of their own dependencies) are required for the test suite
+If you want to add your own input types to encapsulate your own logic or interface patterns, you can do so by subclassing SemanticFormBuilder and configuring Formtastic to use your custom builder class.
 
+@Formtastic::SemanticFormHelper.builder = MyCustomBuilder@
 
-h2. Compatibility
 
-I'm only testing Formtastic with the latest Rails 2.2.x stable release, and it should be fine under Rails 2.3 as well (including nested forms).  Patches are welcome to allow backwards compatibility, but I don't have the energy!
 
 
+h2. Status
 
-h2. What about Stylesheets?
+Formtastic has been in active development for about a year. We've just recently jumped to an 0.9 version number, signaling that we consider this a 1.0 release candidate, and that the API won't change significantly for the 1.x series.
 
-A proof-of-concept (very much a work-in-progress) stylesheet is provided which you can include in your layout.  Customization is best achieved by overriding these styles in an additional stylesheet so that the Formtastic styles can be updated without clobbering your changes.
 
-1. Use the generator to copy the formtastic.css and formtastic_changes.css into your public directory
+h2. Dependencies
 
-<pre>
-./script/generate formtastic_stylesheets
-</pre>
+There are none, but...
 
-2. Add both formtastic.css and formtastic_changes.css to your layout:
+* if you have the "ValidationReflection":http://github.com/redinger/validation_reflection plugin is installed, you won't have to specify the @:required@ option (it checks the validations on the model instead).
+* if you want to use the @:country@ input, you'll need to install the "iso-3166-country-select plugin":http://github.com/rails/iso-3166-country-select (or any other country_select plugin with the same API).
+* "rspec":http://github.com/dchelimsky/rspec/, "rspec_hpricot_matchers":http://rubyforge.org/projects/rspec-hpricot/ and "rcov":http://github.com/relevance/rcov gems (plus any of their own dependencies) are required for the test suite.
 
-<pre>
-<%= stylesheet_link_tag "formtastic" %>
-<%= stylesheet_link_tag "formtastic_changes" %>
-</pre>
+
+h2. Compatibility
+
+I'm only testing Formtastic with the latest Rails 2.4.x stable release, and it should be fine under Rails 2.3.x as well (including nested forms). Patches are welcome to allow backwards compatibility, but I don't have the energy!
+
+h2. Got TextMate?
+
+Well...there's a TextMate-bundle in town, dedicated to make usage of Formtastic in the "TextMate":http://macromates.com/ editor even more of a breeze:
+
+"Formtastic.tmbundle":http://github.com/grimen/formtastic_tmbundle
 
 
 h2. Contributors
 
-Formtastic is maintained by "Justin French":http://justinfrench.com and "José Valim":http://github.com/josevalim, but it wouldn't be as awesome as it is today if it weren't for the wonderful contributions of these fine, fine coders.
+Formtastic is maintained by "Justin French":http://justinfrench.com, "José Valim":http://github.com/josevalim and "Jonas Grimfelt":http://github.com/grimen, but it wouldn't be as awesome as it is today without help from over 30 contributors.
 
-* "Jeff Smick":http://github.com/sprsquish
-* "Tien Dung":http://github.com/tiendung
-* "Mark Mansour":http://stateofflux.com
-* "Andy Pearson":http://github.com/andypearson
-* "negonicrac":http://github.com/negonicrac
-* "Xavier Shay":http://rhnh.net
-* "Pat Allan":http://github.com/freelancing-god
-* "Gareth Townsend":http://github.com/quamen
-* "Sascha Hoellger":http://github.com/mitnal
-* "Andrew Carpenter":http://github.com/andrewcarpenter
-* "Jack Dempsey":http://github.com/jackdempsey/
-* "Greg Fitzgerald":http://github.com/gregf/
-* "Hector E. Gomez Morales":http://github.com/hectoregm
-* "Ben Hamill":http://blog.benhamill.com/
-* "Simon Chiu":http://github.com/tolatomeow
-* "Bin Dong":http://github.com/dongbin
+@git shortlog -n -s --no-merges@
 
 
-h2. Hey, join the Google group!
+h2. Google Group
 
 Please join the "Formtastic Google Group":http://groups.google.com.au/group/formtastic, especially if you'd like to talk about a new feature, or report a bug.
 
 
 h2. Project Info
 
-Formtastic is hosted on Github: http://github.com/justinfrench/formtastic/, where your contributions, forkings, comments and feedback are greatly welcomed.
+Formtastic is hosted on Github: "http://github.com/justinfrench/formtastic":http://github.com/justinfrench/formtastic, where your contributions, forkings, comments and feedback are greatly welcomed.
 
 
 Copyright (c) 2007-2008 Justin French, released under the MIT license.