Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 611 lines (443 sloc) 27.065 kB
420b4ce @justinfrench sick of updating the README with every version bump :)
authored
1 h1. Formtastic
dcf8beb Initial Commit
Justin French authored
2
3 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.
4
1bbe8ea @justinfrench add the pledgie badge back in, GH don't show them any more?
authored
5 <a href='http://www.pledgie.com/campaigns/2178'><img alt='Click here to lend your support to: formtastic and make a donation at www.pledgie.com !' src='http://www.pledgie.com/campaigns/2178.png?skin_name=chrome' border='0' /></a>
6
09d957d textilized the README so that it looks pretty pretty on GitHub
Justin French authored
7 h2. The Story
dcf8beb Initial Commit
Justin French authored
8
2d4a72b @justinfrench big update to the README
authored
9 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:
dcf8beb Initial Commit
Justin French authored
10
09d957d textilized the README so that it looks pretty pretty on GitHub
Justin French authored
11 <pre>
7e3874a @justinfrench trying to fix README formatting of <'s at the start of lines
authored
12 <% semantic_form_for @article do |form| %>
353618e @markmansour Extending Formtastic can be done by overriding the semantic_form_buil…
markmansour authored
13
0b370ba @justinfrench Renamed input_field_set() to just inputs() and added a shorthand vers…
authored
14 <% form.inputs :name => "Basic" do %>
353618e @markmansour Extending Formtastic can be done by overriding the semantic_form_buil…
markmansour authored
15 <%= form.input :title %>
16 <%= form.input :body %>
1db292f @sprsquish update README to reflect association attribute changes
sprsquish authored
17 <%= form.input :section %>
18 <%= form.input :publication_state, :as => :radio %>
9997ce6 @josevalim Added more information about inputs :for in README.
josevalim authored
19 <%= form.input :category %>
353618e @markmansour Extending Formtastic can be done by overriding the semantic_form_buil…
markmansour authored
20 <%= form.input :allow_comments, :label => "Allow commenting on this article" %>
21 <% end %>
22
0b370ba @justinfrench Renamed input_field_set() to just inputs() and added a shorthand vers…
authored
23 <% form.inputs :name => "Advanced" do %>
353618e @markmansour Extending Formtastic can be done by overriding the semantic_form_buil…
markmansour authored
24 <%= form.input :keywords, :required => false, :hint => "Example: ruby, rails, forms" %>
7e3874a @justinfrench trying to fix README formatting of <'s at the start of lines
authored
25 <%= form.input :extract, :required => false %>
26 <%= form.input :description, :required => false %>
353618e @markmansour Extending Formtastic can be done by overriding the semantic_form_buil…
markmansour authored
27 <%= form.input :url_title, :required => false %>
7e3874a @justinfrench trying to fix README formatting of <'s at the start of lines
authored
28 <% end %>
29
05ae54d @josevalim Fixed nested attributes example in README
josevalim authored
30 <% form.inputs :name => "Author", :for => :author do |author_form| %>
31 <%= author_form.input :first_name %>
32 <%= author_form.input :last_name %>
9997ce6 @josevalim Added more information about inputs :for in README.
josevalim authored
33 <% end %>
34
353618e @markmansour Extending Formtastic can be done by overriding the semantic_form_buil…
markmansour authored
35 <% form.buttons do %>
36 <%= form.commit_button %>
7e3874a @justinfrench trying to fix README formatting of <'s at the start of lines
authored
37 <% end %>
09d957d textilized the README so that it looks pretty pretty on GitHub
Justin French authored
38
dcf8beb Initial Commit
Justin French authored
39 <% end %>
09d957d textilized the README so that it looks pretty pretty on GitHub
Justin French authored
40 </pre>
41
6734cfd @justinfrench sme typos and cleanups in the readme
authored
42 I also wrote the accompanying HTML output I expected, favoring something very similar to the fieldsets, lists and other semantic elements Aaron Gustafson presented in "Learning to Love Forms":http://www.slideshare.net/AaronGustafson/learning-to-love-forms-web-directions-south-07, hacking together enough Ruby to prove it could be done.
dcf8beb Initial Commit
Justin French authored
43
44
9af5cc8 @justinfrench Big update and re-organization of the README:
authored
45 h2. It's better than _SomeOtherFormBuilder_ because...
46
6688887 @grimen More README-polishing.
grimen authored
47 * 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.
48 * 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.
49 * it's Rails 2.3-ready (including nested forms).
f02b136 @justinfrench rearranged and beefed up the 'it's better than...' README section
authored
50 * it has internationalization (I18n)!
6688887 @grimen More README-polishing.
grimen authored
51 * 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.
52 * there's heaps of elements, id and class attributes for you to hook in your CSS and JS.
53 * it handles real world stuff like inline hints, inline error messages & help text.
54 * 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).
55 * it's got absolutely awesome spec coverage.
56 * there's a bunch of people using and working on it (it's not just one developer building half a solution).
9af5cc8 @justinfrench Big update and re-organization of the README:
authored
57
58
15e0bd9 updated the README a little to match last night's slides
Justin French authored
59 h2. Why?
60
6688887 @grimen More README-polishing.
grimen authored
61 * web apps = lots of forms.
62 * forms are so friggin' boring to code.
63 * semantically rich & accessible forms really are possible.
64 * the "V" is way behind the "M" and "C" in Rails' MVC – it's the ugly sibling.
65 * best practices and common patterns have to start somewhere.
66 * i need a challenge.
dcf8beb Initial Commit
Justin French authored
67
68
15e0bd9 updated the README a little to match last night's slides
Justin French authored
69 h2. Opinions
70
6688887 @grimen More README-polishing.
grimen authored
71 * it should be easier to do things the right way than the wrong way.
72 * sometimes _more mark-up_ is better.
73 * elements and attribute hooks are _gold_ for stylesheet authors.
74 * make the common things we do easy, yet still ensure uncommon things are still possible.
15e0bd9 updated the README a little to match last night's slides
Justin French authored
75
dcf8beb Initial Commit
Justin French authored
76
3dd6455 @justinfrench Link to RDoc URL in README
authored
77 h2. Documentation
78
79 RDoc documentation _should_ be automatically generated after each commit and made available on the "rdoc.info website":http://rdoc.info/projects/justinfrench/formtastic.
80
81
e3f04f6 @justinfrench README installation instructions simlified and clarified to specific …
authored
82 h2. Installation
c89e985 @justinfrench updating README with gem/plugin installation instructions
authored
83
ebe4e51 @justinfrench updated the README to reflect the new gem versions and other compatib…
authored
84 Formtastic is now compatible with both Rails 2 and Rails 3, and the gem is "hosted":http://rubygems.org/gems/formtastic on RubyGems.org.
4036e74 @justinfrench pruning and cleaning up the README, it's been a while
authored
85
e3f04f6 @justinfrench README installation instructions simlified and clarified to specific …
authored
86 *You'll need to use Bundler (yes, even under Rails 2, due to the many ways gem dependencies suck). Follow "this tutorial":http://gembundler.com/rails23.html.*
557f929 @justinfrench updated README to reflect new 1.1.0.beta gem, etc
authored
87
ebe4e51 @justinfrench updated the README to reflect the new gem versions and other compatib…
authored
88 Simply add Formtastic to your Gemfile and bundle it up:
557f929 @justinfrench updated README to reflect new 1.1.0.beta gem, etc
authored
89
90 <pre>
ebe4e51 @justinfrench updated the README to reflect the new gem versions and other compatib…
authored
91 gem 'formtastic', '~> 1.1.0'
557f929 @justinfrench updated README to reflect new 1.1.0.beta gem, etc
authored
92 </pre>
93
e3f04f6 @justinfrench README installation instructions simlified and clarified to specific …
authored
94 Optionally, run the generator to copy some stylesheets and a configuration initializer into your application:
c89e985 @justinfrench updating README with gem/plugin installation instructions
authored
95
96 <pre>
e3f04f6 @justinfrench README installation instructions simlified and clarified to specific …
authored
97 # Rails 3:
98 $ rails generate formtastic:install
99
100 # Or Rails 2:
101 $ ./script/generate formtastic
c89e985 @justinfrench updating README with gem/plugin installation instructions
authored
102 </pre>
103
ebe4e51 @justinfrench updated the README to reflect the new gem versions and other compatib…
authored
104
105 h2. Stylesheets
c89e985 @justinfrench updating README with gem/plugin installation instructions
authored
106
127a6b9 @justinfrench Added a Formtastic::LayoutHelper with formtastic_stylesheets so that …
authored
107 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 with this helper:
c89e985 @justinfrench updating README with gem/plugin installation instructions
authored
108
5c1ce48 @justinfrench moved the stylesheets stuff up with installation
authored
109 <pre>
127a6b9 @justinfrench Added a Formtastic::LayoutHelper with formtastic_stylesheets so that …
authored
110 <head>
111 ...
112 <%= formtastic_stylesheet_link_tag %>
113 ...
114 </head>
5c1ce48 @justinfrench moved the stylesheets stuff up with installation
authored
115 </pre>
2526d2c @justinfrench Going back to generators instead of Rake tasks for copying stylesheet…
authored
116
4036e74 @justinfrench pruning and cleaning up the README, it's been a while
authored
117
9af5cc8 @justinfrench Big update and re-organization of the README:
authored
118 h2. Usage
119
120 Forms are really boring to code... you want to get onto the good stuff as fast as possible.
121
6688887 @grimen More README-polishing.
grimen authored
122 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:
9af5cc8 @justinfrench Big update and re-organization of the README:
authored
123
124 <pre>
125 <% semantic_form_for @user do |form| %>
126 <%= form.inputs %>
127 <%= form.buttons %>
128 <% end %>
129 </pre>
130
131 If you want to specify the order of the fields, skip some of the fields or even add in fields that Formtastic couldn't detect, you can pass in a list of field names to @inputs@ and list of button names to @buttons@:
132
133 <pre>
134 <% semantic_form_for @user do |form| %>
135 <%= form.inputs :title, :body, :section, :categories, :created_at %>
136 <%= form.buttons :commit %>
137 <% end %>
138 </pre>
139
6688887 @grimen More README-polishing.
grimen authored
140 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):
9af5cc8 @justinfrench Big update and re-organization of the README:
authored
141
142 <pre>
143 <% semantic_form_for @post do |form| %>
144 <% form.inputs do %>
145 <%= form.input :title %>
146 <%= form.input :body %>
147 <%= form.input :section, :as => :radio %>
148 <%= form.input :categories %>
149 <%= form.input :created_at, :as => :string %>
150 <% end %>
151 <% form.buttons do %>
152 <%= form.commit_button %>
153 <% end %>
154 <% end %>
155 </pre>
156
a45853c @justinfrench small README typo
authored
157 If you want to customize the label text, or render some hint text below the field, specify which fields are required/optional, or break the form into two fieldsets, the DSL is pretty comprehensive:
9af5cc8 @justinfrench Big update and re-organization of the README:
authored
158
159 <pre>
160 <% semantic_form_for @post do |form| %>
17f6668 @justinfrench Revert "This reverts commit 440bd2d8da117acdbca57fa199c115caefcd87c0."
authored
161 <% form.inputs "Basic", :id => "basic" do %>
9af5cc8 @justinfrench Big update and re-organization of the README:
authored
162 <%= form.input :title %>
163 <%= form.input :body %>
164 <% end %>
165 <% form.inputs :name => "Advanced Options", :id => "advanced" do %>
166 <%= form.input :slug, :label => "URL Title", :hint => "Created automatically if left blank", :required => false %>
167 <%= form.input :section, :as => :radio %>
d174db0 @asanghi change id_prefix to namespace; added documentation in README
asanghi authored
168 <%= form.input :user, :label => "Author", :label_method => :full_name %>
9af5cc8 @justinfrench Big update and re-organization of the README:
authored
169 <%= form.input :categories, :required => false %>
170 <%= form.input :created_at, :as => :string, :label => "Publication Date", :required => false %>
171 <% end %>
172 <% form.buttons do %>
173 <%= form.commit_button %>
174 <% end %>
175 <% end %>
176 </pre>
177
4db9cfe @justinfrench tweaked README to include accepts_nested_attributes_for mention
authored
178 Nested forms (Rails 2.3) are also supported (don't forget your models need to be setup correctly with accepts_nested_attributes_for – search the Rails docs). You can do it in the Rails way:
9af5cc8 @justinfrench Big update and re-organization of the README:
authored
179
180 <pre>
05ae54d @josevalim Fixed nested attributes example in README
josevalim authored
181 <% semantic_form_for @post do |form| %>
182 <%= form.inputs :title, :body, :created_at %>
41a6754 @josevalim Another README fix.
josevalim authored
183 <% form.semantic_fields_for :author do |author| %>
1fcc068 @grimen An effort to make the README somewhat more readable.
grimen authored
184 <%= author.inputs :first_name, :last_name, :name => "Author" %>
41a6754 @josevalim Another README fix.
josevalim authored
185 <% end %>
05ae54d @josevalim Fixed nested attributes example in README
josevalim authored
186 <%= form.buttons %>
9997ce6 @josevalim Added more information about inputs :for in README.
josevalim authored
187 <% end %>
188 </pre>
189
6fd1bd2 @justinfrench improving the documentation in README
authored
190 Or the Formtastic way with the @:for@ option:
9997ce6 @josevalim Added more information about inputs :for in README.
josevalim authored
191
192 <pre>
05ae54d @josevalim Fixed nested attributes example in README
josevalim authored
193 <% semantic_form_for @post do |form| %>
194 <%= form.inputs :title, :body, :created_at %>
195 <%= form.inputs :first_name, :last_name, :for => :author, :name => "Author" %>
196 <%= form.buttons %>
9af5cc8 @justinfrench Big update and re-organization of the README:
authored
197 <% end %>
198 </pre>
199
1fcc068 @grimen An effort to make the README somewhat more readable.
grimen authored
200 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:
d5e3b0a @josevalim Added nested child nindex support.
josevalim authored
201
202 <pre>
203 <% semantic_form_for @post do |form| %>
204 <%= form.inputs %>
205 <%= form.inputs :name => 'Category #%i', :for => :categories %>
206 <%= form.buttons %>
207 <% end %>
208 </pre>
209
d174db0 @asanghi change id_prefix to namespace; added documentation in README
asanghi authored
210 If you have more than one form on the same page, it may lead to HTML invalidation because of the way HTML element id attributes are assigned. You can provide
211 a namespace for your form to ensure uniqueness of id attributes on form elements. The namespace attribute will be prefixed with underscore on the generate html id. For example:
212
213 <pre>
214 <% semantic_form_for(@post, :namespace => 'cat_form') do |form| %>
215 <%= form.input :title %> # id="cat_form_post_title"
216 <%= form.input :body %> # id="cat_form_post_body"
217 <%= form.input :created_at %> # id="cat_form_post_created_at"
218 <%= form.buttons %>
219 <% end %>
220 </pre>
6fd1bd2 @justinfrench improving the documentation in README
authored
221
29133e1 @dougireton Fixed minor typo in README Usage section.
dougireton authored
222 Customize HTML attributes for any input using the @:input_html@ option. Typically this 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:
6fd1bd2 @justinfrench improving the documentation in README
authored
223
224 <pre>
225 <% semantic_form_for @post do |form| %>
226 <%= form.input :title, :input_html => { :size => 60 } %>
227 <%= form.input :body, :input_html => { :class => 'autogrow' } %>
228 <%= form.input :created_at, :input_html => { :disabled => true } %>
229 <%= form.buttons %>
230 <% end %>
231 </pre>
232
233 The same can be done for buttons with the @:button_html@ option:
234
235 <pre>
236 <% semantic_form_for @post do |form| %>
237 ...
238 <% form.buttons do %>
239 <%= form.commit_button :button_html => { :class => "primary" } %>
240 <% end %>
241 <% end %>
242 </pre>
243
d174db0 @asanghi change id_prefix to namespace; added documentation in README
asanghi authored
244 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"@).
1fcc068 @grimen An effort to make the README somewhat more readable.
grimen authored
245
6fd1bd2 @justinfrench improving the documentation in README
authored
246 <pre>
247 <% semantic_form_for @post do |form| %>
248 <%= form.input :title, :wrapper_html => { :class => "important" } %>
249 <%= form.input :body %>
250 <%= form.input :description, :wrapper_html => { :style => "display:none;" } %>
251 ...
252 <% end %>
253 </pre>
254
d174db0 @asanghi change id_prefix to namespace; added documentation in README
asanghi authored
255 Customize the default class used for hints on each attribute or globally in the @config/formtastic.rb@ file. Similarly you can customize the error classes on an attribute level or globally.
256
257 <pre>
258 <% semantic_form_for @post do |form| %>
259 <%= form.input :title, :hint_class => 'custom-html-class', :error_class => 'custom-error-class' %>
260 <% end %>
261 </pre>
262
a92cf7c @justinfrench added documentation for :collection option, resolves #181
authored
263 Many inputs provide a collection of options to choose from (like @:select@, @:radio@, @:check_boxes@, @:boolean@). In many cases, Formtastic can find choices through the model associations, but if you want to use your own set of choices, the @:collection@ option is what you want. You can pass in an Array of objects, an array of Strings, a Hash... Throw almost anything at it! Examples:
264
265 <pre>
266 f.input :authors, :as => :check_boxes, :collection => User.find(:all, :order => "last_name ASC")
267 f.input :authors, :as => :check_boxes, :collection => current_user.company.users.active
268 f.input :authors, :as => :check_boxes, :collection => [@justin, @kate]
269 f.input :authors, :as => :check_boxes, :collection => ["Justin", "Kate", "Amelia", "Gus", "Meg"]
270 f.input :author, :as => :select, :collection => Author.find(:all)
271 f.input :author, :as => :select, :collection => { @justin.name => @justin.id, @kate.name => @kate.id }
272 f.input :author, :as => :select, :collection => ["Justin", "Kate", "Amelia", "Gus", "Meg"]
273 f.input :author, :as => :radio, :collection => User.find(:all)
274 f.input :author, :as => :radio, :collection => [@justin, @kate]
275 f.input :author, :as => :radio, :collection => { @justin.name => @justin.id, @kate.name => @kate.id }
276 f.input :author, :as => :radio, :collection => ["Justin", "Kate", "Amelia", "Gus", "Meg"]
277 f.input :admin, :as => :radio, :collection => ["Yes!", "No"]
278 </pre>
279
6fd1bd2 @justinfrench improving the documentation in README
authored
280
5a39443 @justinfrench bulking up the documentation and readme with the different inputs ava…
authored
281 h2. The Available Inputs
282
d9a06fe @grimen README: Last set of polishing moves for now.
grimen authored
283 The Formtastic input types:
284
8577c18 @grimen More README-readability polishing.
grimen authored
285 * @:select@ - a select menu. Default for ActiveRecord associations: @belongs_to@, @has_many@, and @has_and_belongs_to_many@.
286 * @:check_boxes@ - a set of check_box inputs. Alternative to @:select@ for ActiveRecord-associations: @has_many@, and @has_and_belongs_to_many@.
287 * @:radio@ - a set of radio inputs. Alternative to @:select@ for ActiveRecord-associations: @belongs_to@.
288 * @:time_zone@ - a select input. Default for column types: @:string@ with name matching @"time_zone"@.
289 * @:password@ - a password input. Default for column types: @:string@ with name matching @"password"@.
290 * @:text@ - a textarea. Default for column types: @:text@.
291 * @:date@ - a date select. Default for column types: @:date@.
292 * @:datetime@ - a date and time select. Default for column types: @:datetime@ and @:timestamp@.
293 * @:time@ - a time select. Default for column types: @:time@.
294 * @:boolean@ - a checkbox. Default for column types: @:boolean@.
295 * @:string@ - a text field. Default for column types: @:string@.
296 * @:numeric@ - a text field (just like string). Default for column types: @:integer@, @:float@, and @:decimal@.
297 * @: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.
298 * @:country@ - a select menu of country names. Default for column types: :string with name @"country"@ - requires a *country_select* plugin to be installed.
e0a7874 @asanghi Added auto-guessing and updated some docs
asanghi authored
299 * @:email@ - a text field (just like string). Default for columns with name matching @"email"@. New in HTML5. Works on some mobile browsers already.
300 * @:url@ - a text field (just like string). Default for columns with name matching @"url"@. New in HTML5. Works on some mobile browsers already.
301 * @:phone@ - a text field (just like string). Default for columns with name matching @"phone"@ or @"fax"@. New in HTML5.
302 * @:search@ - a text field (just like string). Default for columns with name matching @"search"@. New in HTML5. Works on Safari.
6688887 @grimen More README-polishing.
grimen authored
303 * @:hidden@ - a hidden field. Creates a hidden field (added for compatibility).
304
fd23ef4 @justinfrench tiny README tweak
authored
305 The comments in the code are pretty good for each of these (what it does, what the output is, what the options are, etc.) so go check it out.
306
5a39443 @justinfrench bulking up the documentation and readme with the different inputs ava…
authored
307
06ff25d @lardawge Added section clarifying label lookup order.
lardawge authored
308 h2. Delegation for label lookups
309
310 Formtastic decides which label to use in the following order:
311
312 <pre>
313 1. :label # :label => "Choose Title"
314 2. Formtastic i18n # if either :label => true || i18n_lookups_by_default = true (see Internationalization)
315 3. Activerecord i18n # if localization file found for the given attribute
316 4. label_str_method # if nothing provided this defaults to :humanize but can be set to a custom method
317 </pre>
318
94ce3ec @grimen Documentation for the new I18n features for labels/hints.
grimen authored
319 h2. Internationalization (I18n)
320
49a18a5 @grimen README-update: I18n instructions are better structured, and easier to…
grimen authored
321 h3. Basic Localization
71ef99f @justinfrench nuked the configuration copy/paste from the README, linked to the gen…
authored
322
49a18a5 @grimen README-update: I18n instructions are better structured, and easier to…
grimen authored
323 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.
94ce3ec @grimen Documentation for the new I18n features for labels/hints.
grimen authored
324
75782e1 @grimen Updated I18n-instructions in README; on the I18n-support for fieldset…
grimen authored
325 Basic localization (labels only, with ActiveRecord):
94ce3ec @grimen Documentation for the new I18n features for labels/hints.
grimen authored
326
327 <pre>
328 <% semantic_form_for @post do |form| %>
329 <%= form.input :title %> # => :label => I18n.t('activerecord.attributes.user.title') or 'Title'
330 <%= form.input :body %> # => :label => I18n.t('activerecord.attributes.user.body') or 'Body'
331 <%= form.input :section %> # => :label => I18n.t('activerecord.attributes.user.section') or 'Section'
332 <% end %>
333 </pre>
334
49a18a5 @grimen README-update: I18n instructions are better structured, and easier to…
grimen authored
335 *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?
336
337 h3. Enhanced Localization (Formtastic I18n API)
94ce3ec @grimen Documentation for the new I18n features for labels/hints.
grimen authored
338
d9a06fe @grimen README: Last set of polishing moves for now.
grimen authored
339 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:
94ce3ec @grimen Documentation for the new I18n features for labels/hints.
grimen authored
340
49a18a5 @grimen README-update: I18n instructions are better structured, and easier to…
grimen authored
341 *1. Enable I18n lookups by default (@config/initializers/formtastic.rb@):*
94ce3ec @grimen Documentation for the new I18n features for labels/hints.
grimen authored
342
343 <pre>
344 Formtastic::SemanticFormBuilder.i18n_lookups_by_default = true
345 </pre>
346
49a18a5 @grimen README-update: I18n instructions are better structured, and easier to…
grimen authored
347 *2. Add some cool label-translations/variants (@config/locale/en.yml@):*
94ce3ec @grimen Documentation for the new I18n features for labels/hints.
grimen authored
348
349 <pre>
350 en:
351 formtastic:
75782e1 @grimen Updated I18n-instructions in README; on the I18n-support for fieldset…
grimen authored
352 titles:
353 post_details: "Post details"
94ce3ec @grimen Documentation for the new I18n features for labels/hints.
grimen authored
354 labels:
355 post:
356 title: "Choose a title..."
357 body: "Write something..."
75782e1 @grimen Updated I18n-instructions in README; on the I18n-support for fieldset…
grimen authored
358 edit:
359 title: "Edit title"
94ce3ec @grimen Documentation for the new I18n features for labels/hints.
grimen authored
360 hints:
361 post:
362 title: "Choose a good title for you post."
363 body: "Write something inspiring here."
4aca8cd @grimen New I18n-features:
grimen authored
364 actions:
743b26b @yabawock Revert "Reverting two i18n patches pulled in from the rails3 branch w…
yabawock authored
365 create: "Create my %{model}"
4aca8cd @grimen New I18n-features:
grimen authored
366 update: "Save changes"
367 dummie: "Launch!"
94ce3ec @grimen Documentation for the new I18n features for labels/hints.
grimen authored
368 </pre>
369
370 *Note:* We are using English here still, but you get the point.
371
49a18a5 @grimen README-update: I18n instructions are better structured, and easier to…
grimen authored
372 *3. ...and now you'll get:*
94ce3ec @grimen Documentation for the new I18n features for labels/hints.
grimen authored
373
374 <pre>
4aca8cd @grimen New I18n-features:
grimen authored
375 <% semantic_form_for Post.new do |form| %>
a8e2f2e @justinfrench fix README examples missing form.x prefix for buttons and inputs
authored
376 <% form.inputs do %>
75782e1 @grimen Updated I18n-instructions in README; on the I18n-support for fieldset…
grimen authored
377 <%= form.input :title %> # => :label => "Choose a title...", :hint => "Choose a good title for you post."
378 <%= form.input :body %> # => :label => "Write something...", :hint => "Write something inspiring here."
379 <%= form.input :section %> # => :label => I18n.t('activerecord.attributes.user.section') or 'Section'
380 <% end %>
a8e2f2e @justinfrench fix README examples missing form.x prefix for buttons and inputs
authored
381 <% form.buttons do %>
743b26b @yabawock Revert "Reverting two i18n patches pulled in from the rails3 branch w…
yabawock authored
382 <%= form.commit_button %> # => "Create my %{model}"
4aca8cd @grimen New I18n-features:
grimen authored
383 <% end %>
94ce3ec @grimen Documentation for the new I18n features for labels/hints.
grimen authored
384 <% end %>
385 </pre>
386
49a18a5 @grimen README-update: I18n instructions are better structured, and easier to…
grimen authored
387 *4. Localized titles (a.k.a. legends):*
75782e1 @grimen Updated I18n-instructions in README; on the I18n-support for fieldset…
grimen authored
388
17f6668 @justinfrench Revert "This reverts commit 440bd2d8da117acdbca57fa199c115caefcd87c0."
authored
389 _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._
75782e1 @grimen Updated I18n-instructions in README; on the I18n-support for fieldset…
grimen authored
390
391 <pre>
392 <% semantic_form_for @post do |form| %>
17f6668 @justinfrench Revert "This reverts commit 440bd2d8da117acdbca57fa199c115caefcd87c0."
authored
393 <% form.inputs :post_details do %> # => :title => "Post details"
75782e1 @grimen Updated I18n-instructions in README; on the I18n-support for fieldset…
grimen authored
394 # ...
395 <% end %>
396 # ...
397 <% end %>
398 </pre>
399
49a18a5 @grimen README-update: I18n instructions are better structured, and easier to…
grimen authored
400 *5. Override I18n settings:*
94ce3ec @grimen Documentation for the new I18n features for labels/hints.
grimen authored
401
402 <pre>
403 <% semantic_form_for @post do |form| %>
a8e2f2e @justinfrench fix README examples missing form.x prefix for buttons and inputs
authored
404 <% form.inputs do %>
75782e1 @grimen Updated I18n-instructions in README; on the I18n-support for fieldset…
grimen authored
405 <%= form.input :title %> # => :label => "Choose a title...", :hint => "Choose a good title for you post."
406 <%= form.input :body, :hint => false %> # => :label => "Write something..."
407 <%= form.input :section, :label => 'Some section' %> # => :label => 'Some section'
408 <% end %>
a8e2f2e @justinfrench fix README examples missing form.x prefix for buttons and inputs
authored
409 <% form.buttons do %>
4aca8cd @grimen New I18n-features:
grimen authored
410 <%= form.commit_button :dummie %> # => "Launch!"
411 <% end %>
94ce3ec @grimen Documentation for the new I18n features for labels/hints.
grimen authored
412 <% end %>
413 </pre>
414
415 If I18n-lookups is disabled, i.e.:
416
417 <pre>
418 Formtastic::SemanticFormBuilder.i18n_lookups_by_default = false
419 </pre>
420
421 ...then you can enable I18n within the forms instead:
422
423 <pre>
424 <% semantic_form_for @post do |form| %>
a8e2f2e @justinfrench fix README examples missing form.x prefix for buttons and inputs
authored
425 <% form.inputs do %>
75782e1 @grimen Updated I18n-instructions in README; on the I18n-support for fieldset…
grimen authored
426 <%= form.input :title, :label => true %> # => :label => "Choose a title..."
427 <%= form.input :body, :label => true %> # => :label => "Write something..."
428 <%= form.input :section, :label => true %> # => :label => I18n.t('activerecord.attributes.user.section') or 'Section'
429 <% end %>
a8e2f2e @justinfrench fix README examples missing form.x prefix for buttons and inputs
authored
430 <% form.buttons do %>
4aca8cd @grimen New I18n-features:
grimen authored
431 <%= form.commit_button true %> # => "Save changes" (if we are in edit that is...)
432 <% end %>
94ce3ec @grimen Documentation for the new I18n features for labels/hints.
grimen authored
433 <% end %>
434 </pre>
435
49a18a5 @grimen README-update: I18n instructions are better structured, and easier to…
grimen authored
436 *6. Advanced I18n lookups*
94ce3ec @grimen Documentation for the new I18n features for labels/hints.
grimen authored
437
438 For more flexible forms; Formtastic find translations using a bottom-up approach taking the following variables in account:
439
75782e1 @grimen Updated I18n-instructions in README; on the I18n-support for fieldset…
grimen authored
440 * @MODEL@, e.g. "post"
441 * @ACTION@, e.g. "edit"
4aca8cd @grimen New I18n-features:
grimen authored
442 * @KEY/ATTRIBUTE@, e.g. "title", :my_custom_key, ...
94ce3ec @grimen Documentation for the new I18n features for labels/hints.
grimen authored
443
444 ...in the following order:
445
6688887 @grimen More README-polishing.
grimen authored
446 1. @formtastic.{titles,labels,hints,actions}.MODEL.ACTION.ATTRIBUTE@ - by model and action
447 2. @formtastic.{titles,labels,hints,actions}.MODEL.ATTRIBUTE@ - by model
448 3. @formtastic.{titles,labels,hints,actions}.ATTRIBUTE@ - global default
94ce3ec @grimen Documentation for the new I18n features for labels/hints.
grimen authored
449
450 ...which means that you can define translations like this:
451
452 <pre>
453 en:
454 formtastic:
455 labels:
456 title: "Title" # Default global value
457 article:
458 body: "Article content"
459 post:
460 new:
461 title: "Choose a title..."
462 body: "Write something..."
463 edit:
464 title: "Edit title"
465 body: "Edit body"
466 </pre>
467
4aca8cd @grimen New I18n-features:
grimen authored
468 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.
75782e1 @grimen Updated I18n-instructions in README; on the I18n-support for fieldset…
grimen authored
469
71ef99f @justinfrench nuked the configuration copy/paste from the README, linked to the gen…
authored
470
c4ebcef * added semantic_errors method with specs
Wojciech Wnętrzak authored
471 h2. Semantic errors
472
473 You can show errors on base (by default) and any other attribute just passing it name to semantic_errors method:
474
475 <pre>
476 <% semantic_form_for @post do |form| %>
477 <%= form.semantic_errors :state %>
478 <% end %>
479 </pre>
480
481
94ce3ec @grimen Documentation for the new I18n features for labels/hints.
grimen authored
482 h2. ValidationReflection plugin
483
49a18a5 @grimen README-update: I18n instructions are better structured, and easier to…
grimen authored
484 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).
5a39443 @justinfrench bulking up the documentation and readme with the different inputs ava…
authored
485
486
71ef99f @justinfrench nuked the configuration copy/paste from the README, linked to the gen…
authored
487 h2. Configuration
5a39443 @justinfrench bulking up the documentation and readme with the different inputs ava…
authored
488
5f3d7a6 @justinfrench updated the generator docs in README to reflect both Rails 3 and 2
authored
489 Run @rails generate formtastic:install@ (Rails 3) or @./script/generate formtastic@ (Rails 2) 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
3a32b4a @josevalim Updated README with new configuration options.
josevalim authored
490
5a39443 @justinfrench bulking up the documentation and readme with the different inputs ava…
authored
491
fef3288 @grimen Added documentation for the form generator in README, and showing som…
grimen authored
492 h2. Form Generator
493
5f3d7a6 @justinfrench updated the generator docs in README to reflect both Rails 3 and 2
authored
494 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 your stuff.
fef3288 @grimen Added documentation for the form generator in README, and showing som…
grimen authored
495
5f3d7a6 @justinfrench updated the generator docs in README to reflect both Rails 3 and 2
authored
496 h3. Basic usage
497
498 Rails 3:
fef3288 @grimen Added documentation for the form generator in README, and showing som…
grimen authored
499
500 <pre>
5f3d7a6 @justinfrench updated the generator docs in README to reflect both Rails 3 and 2
authored
501 $ rails generate formtastic:form ModelName
502 </pre>
fef3288 @grimen Added documentation for the form generator in README, and showing som…
grimen authored
503
5f3d7a6 @justinfrench updated the generator docs in README to reflect both Rails 3 and 2
authored
504 Rails 2:
505
506 <pre>
507 $ ./script/generate form ModelName
508 </pre>
fef3288 @grimen Added documentation for the form generator in README, and showing som…
grimen authored
509
5f3d7a6 @justinfrench updated the generator docs in README to reflect both Rails 3 and 2
authored
510 The results are something like this, with the ERB code printed out to the terminal
511
512 <pre>
513 $ rails generate formtastic:form Post
514 # ---------------------------------------------------------
515 # GENERATED FORMTASTIC CODE
516 # ---------------------------------------------------------
517
518 <% f.inputs do %>
519 <%= f.input :title, :label => 'Title' %>
520 <%= f.input :body, :label => 'Body' %>
521 <%= f.input :published, :label => 'Published' %>
522 <% end %>
523
524 # ---------------------------------------------------------
525 Copied to clipboard - just paste it!
fef3288 @grimen Added documentation for the form generator in README, and showing som…
grimen authored
526 </pre>
527
5f3d7a6 @justinfrench updated the generator docs in README to reflect both Rails 3 and 2
authored
528 h3. Generating a partial with @--partial@
529
530 You can also ask Formtastic to *generate a partial* with the @--partial@ option, placing it in the correct location inside your @app/views@ directory:
fef3288 @grimen Added documentation for the form generator in README, and showing som…
grimen authored
531
532 <pre>
5f3d7a6 @justinfrench updated the generator docs in README to reflect both Rails 3 and 2
authored
533 $ rails generate formastic:form Post --partial
fef3288 @grimen Added documentation for the form generator in README, and showing som…
grimen authored
534 exists app/views/posts
535 create app/views/posts/_form.html.erb
536 </pre>
537
5f3d7a6 @justinfrench updated the generator docs in README to reflect both Rails 3 and 2
authored
538 h3. Specifying HAML instead of ERB with @--haml@
3f58f3a @justinfrench README update for --controller option form generator
authored
539
540 <pre>
5f3d7a6 @justinfrench updated the generator docs in README to reflect both Rails 3 and 2
authored
541 $ rails generate formastic:form Post --haml
3f58f3a @justinfrench README update for --controller option form generator
authored
542 exists app/views/admin/posts
543 create app/views/admin/posts/_form.html.haml
544 </pre>
545
5f3d7a6 @justinfrench updated the generator docs in README to reflect both Rails 3 and 2
authored
546 h3. Specifying controller namespace with @--controller@
3f58f3a @justinfrench README update for --controller option form generator
authored
547
548 <pre>
5f3d7a6 @justinfrench updated the generator docs in README to reflect both Rails 3 and 2
authored
549 $ rails generate formastic:form Post --partial --controller admin/posts
3f58f3a @justinfrench README update for --controller option form generator
authored
550 exists app/views/admin/posts
551 create app/views/admin/posts/_form.html.erb
552 </pre>
553
fef3288 @grimen Added documentation for the form generator in README, and showing som…
grimen authored
554
ce7da5e @justinfrench added the builder config to the config template and quick documentati…
authored
555 h2. Custom Inputs
556
557 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.
558
559 @Formtastic::SemanticFormHelper.builder = MyCustomBuilder@
560
5f3d7a6 @justinfrench updated the generator docs in README to reflect both Rails 3 and 2
authored
561
2d2d813 @yabawock More intelligent way to html_escape labels and hints (GH-299)
yabawock authored
562 h2. Security
ce7da5e @justinfrench added the builder config to the config template and quick documentati…
authored
563
2d2d813 @yabawock More intelligent way to html_escape labels and hints (GH-299)
yabawock authored
564 By default formtastic escapes html entities in both labels and hints unless a string is marked as html_safe. If you are using an older rails version which doesn't know html_safe, or you want to globally turn this feature off, you can set the following in your initializer:
565
566 Formtastic::SemanticFormBuilder.escape_html_entities_in_hints_and_labels = false
3f58f3a @justinfrench README update for --controller option form generator
authored
567
568
9af5cc8 @justinfrench Big update and re-organization of the README:
authored
569 h2. Dependencies
dcf8beb Initial Commit
Justin French authored
570
9af5cc8 @justinfrench Big update and re-organization of the README:
authored
571 There are none, but...
dcf8beb Initial Commit
Justin French authored
572
e9f27cf @grimen The most tiny README-update ever. =)
grimen authored
573 * 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).
1fcc068 @grimen An effort to make the README somewhat more readable.
grimen authored
574 * 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).
575 * "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.
dcf8beb Initial Commit
Justin French authored
576
0b370ba @justinfrench Renamed input_field_set() to just inputs() and added a shorthand vers…
authored
577
9af5cc8 @justinfrench Big update and re-organization of the README:
authored
578 h2. Compatibility
0b370ba @justinfrench Renamed input_field_set() to just inputs() and added a shorthand vers…
authored
579
ebe4e51 @justinfrench updated the README to reflect the new gem versions and other compatib…
authored
580 * We're only testing Formtastic with the latest Rails 2.x and 3.x stable releases. Patches are welcome to allow backwards compatibility with older versions of Rails, of course.
eab18fa @justinfrench prep README for 1.0
authored
581 * Formtastic, much like Rails 2, is very ActiveRecord-centric. Many people are using Formtastic (especially the rails3 branch) successfully with other ActiveModel-like ORMs and classes (DataMapper, MongoMapper, Mongoid, Authlogic, Devise...) but we're not guaranteeing anything at this stage. Patches are welcome, but it's not our core focus right now.
4036e74 @justinfrench pruning and cleaning up the README, it's been a while
authored
582
61d0056 @justinfrench * updated the status to reflect that this is a release candidate
authored
583
2079c59 @justinfrench added a section about contributing to README
authored
584 h2. How to contribute
585
4036e74 @justinfrench pruning and cleaning up the README, it's been a while
authored
586 Please ensure that you provide appropriate spec/test coverage and ensure the documentation is up-to-date. Bonus points if you perform your changes in a clean topic branch rather than master, and if you create an issue on GH for us to discuss your changes. Pull requests tend to get lost.
2079c59 @justinfrench added a section about contributing to README
authored
587
588 Please also keep your commits *atomic* so that they are more likely to apply cleanly. That means that each commit should contain the smallest possible logical change. Don't commit two features at once, don't update the gemspec at the same time you add a feature, don't fix a whole bunch of whitespace in a file at the same time you change a few lines, etc, etc.
589
590 For significant changes, you may wish to discuss your idea on the Formtastic Google group before coding to ensure that your change is likely to be accepted. Formtastic relies heavily on i18n, so if you're unsure of the impact this has on your changes, please discuss them with the group.
591
592
259a98c @justinfrench updated heading in README
authored
593 h2. Maintainers & Contributors
83b9eb1 @justinfrench updated the contributors list
authored
594
644d100 @yabawock Fix typo in Readme
yabawock authored
595 Formtastic is maintained by "Justin French":http://github.com/justinfrench, "Morton Jonuschat":http://github.com/yabawock and "Gabriel Sobrinho":http://github.com/sobrinho. "Denis Major":http://github.com/denismajor1 is doing some amazing documentation work in the wiki, and we very much appreciate the past efforts of "José Valim":http://github.com/josevalim and "Jonas Grimfelt":http://github.com/grimen and over 40 other contributors.
619ce6c @justinfrench added Grimen to the README, updated contributors list, etc
authored
596
597 @git shortlog -n -s --no-merges@
2d4a72b @justinfrench big update to the README
authored
598
5af0311 @justinfrench updated the README to pimp the google group more
authored
599
7a84a73 @justinfrench README heading tweak
authored
600 h2. Google Group
5af0311 @justinfrench updated the README to pimp the google group more
authored
601
602 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.
603
604
ba3ce05 @justinfrench updated the README a little with contributors and some other busy work
authored
605 h2. Project Info
606
1fcc068 @grimen An effort to make the README somewhat more readable.
grimen authored
607 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.
ba3ce05 @justinfrench updated the README a little with contributors and some other busy work
authored
608
609
ebe4e51 @justinfrench updated the README to reflect the new gem versions and other compatib…
authored
610 Copyright (c) 2007-2010 Justin French, released under the MIT license.
Something went wrong with that request. Please try again.