Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 559 lines (402 sloc) 23.156 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
09d957d textilized the README so that it looks pretty pretty on GitHub
Justin French authored
5 h2. The Story
dcf8beb Initial Commit
Justin French authored
6
2d4a72b @justinfrench big update to the README
authored
7 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
8
09d957d textilized the README so that it looks pretty pretty on GitHub
Justin French authored
9 <pre>
7e3874a @justinfrench trying to fix README formatting of <'s at the start of lines
authored
10 <% semantic_form_for @article do |form| %>
353618e @markmansour Extending Formtastic can be done by overriding the semantic_form_buil…
markmansour authored
11
0b370ba @justinfrench Renamed input_field_set() to just inputs() and added a shorthand vers…
authored
12 <% form.inputs :name => "Basic" do %>
353618e @markmansour Extending Formtastic can be done by overriding the semantic_form_buil…
markmansour authored
13 <%= form.input :title %>
14 <%= form.input :body %>
1db292f @sprsquish update README to reflect association attribute changes
sprsquish authored
15 <%= form.input :section %>
16 <%= form.input :publication_state, :as => :radio %>
9997ce6 @josevalim Added more information about inputs :for in README.
josevalim authored
17 <%= form.input :category %>
353618e @markmansour Extending Formtastic can be done by overriding the semantic_form_buil…
markmansour authored
18 <%= form.input :allow_comments, :label => "Allow commenting on this article" %>
19 <% end %>
20
0b370ba @justinfrench Renamed input_field_set() to just inputs() and added a shorthand vers…
authored
21 <% form.inputs :name => "Advanced" do %>
353618e @markmansour Extending Formtastic can be done by overriding the semantic_form_buil…
markmansour authored
22 <%= 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
23 <%= form.input :extract, :required => false %>
24 <%= form.input :description, :required => false %>
353618e @markmansour Extending Formtastic can be done by overriding the semantic_form_buil…
markmansour authored
25 <%= form.input :url_title, :required => false %>
7e3874a @justinfrench trying to fix README formatting of <'s at the start of lines
authored
26 <% end %>
27
05ae54d @josevalim Fixed nested attributes example in README
josevalim authored
28 <% form.inputs :name => "Author", :for => :author do |author_form| %>
29 <%= author_form.input :first_name %>
30 <%= author_form.input :last_name %>
9997ce6 @josevalim Added more information about inputs :for in README.
josevalim authored
31 <% end %>
32
353618e @markmansour Extending Formtastic can be done by overriding the semantic_form_buil…
markmansour authored
33 <% form.buttons do %>
34 <%= form.commit_button %>
7e3874a @justinfrench trying to fix README formatting of <'s at the start of lines
authored
35 <% end %>
09d957d textilized the README so that it looks pretty pretty on GitHub
Justin French authored
36
dcf8beb Initial Commit
Justin French authored
37 <% end %>
09d957d textilized the README so that it looks pretty pretty on GitHub
Justin French authored
38 </pre>
39
6734cfd @justinfrench sme typos and cleanups in the readme
authored
40 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
41
42
9af5cc8 @justinfrench Big update and re-organization of the README:
authored
43 h2. It's better than _SomeOtherFormBuilder_ because...
44
6688887 @grimen More README-polishing.
grimen authored
45 * 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.
46 * 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.
47 * it's Rails 2.3-ready (including nested forms).
f02b136 @justinfrench rearranged and beefed up the 'it's better than...' README section
authored
48 * it has internationalization (I18n)!
6688887 @grimen More README-polishing.
grimen authored
49 * 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.
50 * there's heaps of elements, id and class attributes for you to hook in your CSS and JS.
51 * it handles real world stuff like inline hints, inline error messages & help text.
52 * 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).
53 * it's got absolutely awesome spec coverage.
54 * 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
55
56
15e0bd9 updated the README a little to match last night's slides
Justin French authored
57 h2. Why?
58
6688887 @grimen More README-polishing.
grimen authored
59 * web apps = lots of forms.
60 * forms are so friggin' boring to code.
61 * semantically rich & accessible forms really are possible.
62 * the "V" is way behind the "M" and "C" in Rails' MVC – it's the ugly sibling.
63 * best practices and common patterns have to start somewhere.
64 * i need a challenge.
dcf8beb Initial Commit
Justin French authored
65
66
15e0bd9 updated the README a little to match last night's slides
Justin French authored
67 h2. Opinions
68
6688887 @grimen More README-polishing.
grimen authored
69 * it should be easier to do things the right way than the wrong way.
70 * sometimes _more mark-up_ is better.
71 * elements and attribute hooks are _gold_ for stylesheet authors.
72 * 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
73
dcf8beb Initial Commit
Justin French authored
74
3dd6455 @justinfrench Link to RDoc URL in README
authored
75 h2. Documentation
76
77 RDoc documentation _should_ be automatically generated after each commit and made available on the "rdoc.info website":http://rdoc.info/projects/justinfrench/formtastic.
78
79
c89e985 @justinfrench updating README with gem/plugin installation instructions
authored
80 h2. Installation
81
1fcc068 @grimen An effort to make the README somewhat more readable.
grimen authored
82 The gem is hosted on gemcutter, so *if you haven't already*, add it as a gem source:
c89e985 @justinfrench updating README with gem/plugin installation instructions
authored
83
84 <pre>
2bf5b23 @justinfrench updated README to reflect gemcutter gem source
authored
85 sudo gem sources -a http://gemcutter.org/
c89e985 @justinfrench updating README with gem/plugin installation instructions
authored
86 </pre>
87
1fcc068 @grimen An effort to make the README somewhat more readable.
grimen authored
88 Then install the Formtastic gem:
c89e985 @justinfrench updating README with gem/plugin installation instructions
authored
89
90 <pre>
2bf5b23 @justinfrench updated README to reflect gemcutter gem source
authored
91 sudo gem install formtastic
c89e985 @justinfrench updating README with gem/plugin installation instructions
authored
92 </pre>
93
6ae6675 @justinfrench adding config.gem instructions to README, thanks Tom White
authored
94 And add it to your environment.rb configuration as a gem dependency:
95
96 <pre>
97 config.gem 'formtastic'
98 </pre>
99
2bf5b23 @justinfrench updated README to reflect gemcutter gem source
authored
100 Optionally, run @./script/generate formtastic@ to copy the following files into your app:
fc29eaa @justinfrench Combined the "formtastic_config" and "formtastic_stylesheets" generat…
authored
101
b4fc852 @justinfrench Revert "generated config file is now called formtastic_config.rb rath…
authored
102 * @config/initializers/formtastic.rb@ - a commented out Formtastic config initializer
1fcc068 @grimen An effort to make the README somewhat more readable.
grimen authored
103 * @public/stylesheets/formtastic.css@
104 * @public/stylesheets/formtastic_changes.css@
c89e985 @justinfrench updating README with gem/plugin installation instructions
authored
105
127a6b9 @justinfrench Added a Formtastic::LayoutHelper with formtastic_stylesheets so that …
authored
106 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
107
5c1ce48 @justinfrench moved the stylesheets stuff up with installation
authored
108 <pre>
127a6b9 @justinfrench Added a Formtastic::LayoutHelper with formtastic_stylesheets so that …
authored
109 <head>
110 ...
111 <%= formtastic_stylesheet_link_tag %>
112 ...
113 </head>
5c1ce48 @justinfrench moved the stylesheets stuff up with installation
authored
114 </pre>
2526d2c @justinfrench Going back to generators instead of Rake tasks for copying stylesheet…
authored
115
9af5cc8 @justinfrench Big update and re-organization of the README:
authored
116 h2. Usage
117
118 Forms are really boring to code... you want to get onto the good stuff as fast as possible.
119
6688887 @grimen More README-polishing.
grimen authored
120 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
121
122 <pre>
123 <% semantic_form_for @user do |form| %>
124 <%= form.inputs %>
125 <%= form.buttons %>
126 <% end %>
127 </pre>
128
129 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@:
130
131 <pre>
132 <% semantic_form_for @user do |form| %>
133 <%= form.inputs :title, :body, :section, :categories, :created_at %>
134 <%= form.buttons :commit %>
135 <% end %>
136 </pre>
137
6688887 @grimen More README-polishing.
grimen authored
138 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
139
140 <pre>
141 <% semantic_form_for @post do |form| %>
142 <% form.inputs do %>
143 <%= form.input :title %>
144 <%= form.input :body %>
145 <%= form.input :section, :as => :radio %>
146 <%= form.input :categories %>
147 <%= form.input :created_at, :as => :string %>
148 <% end %>
149 <% form.buttons do %>
150 <%= form.commit_button %>
151 <% end %>
152 <% end %>
153 </pre>
154
a45853c @justinfrench small README typo
authored
155 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
156
157 <pre>
158 <% semantic_form_for @post do |form| %>
17f6668 @justinfrench Revert "This reverts commit 440bd2d8da117acdbca57fa199c115caefcd87c0."
authored
159 <% form.inputs "Basic", :id => "basic" do %>
9af5cc8 @justinfrench Big update and re-organization of the README:
authored
160 <%= form.input :title %>
161 <%= form.input :body %>
162 <% end %>
163 <% form.inputs :name => "Advanced Options", :id => "advanced" do %>
164 <%= form.input :slug, :label => "URL Title", :hint => "Created automatically if left blank", :required => false %>
165 <%= form.input :section, :as => :radio %>
166 <%= form.input :user, :label => "Author", :label_method => :full_name, %>
167 <%= form.input :categories, :required => false %>
168 <%= form.input :created_at, :as => :string, :label => "Publication Date", :required => false %>
169 <% end %>
170 <% form.buttons do %>
171 <%= form.commit_button %>
172 <% end %>
173 <% end %>
174 </pre>
175
9997ce6 @josevalim Added more information about inputs :for in README.
josevalim authored
176 Nested forms (Rails 2.3) are also supported. You can do it in the Rails way:
9af5cc8 @justinfrench Big update and re-organization of the README:
authored
177
178 <pre>
05ae54d @josevalim Fixed nested attributes example in README
josevalim authored
179 <% semantic_form_for @post do |form| %>
180 <%= form.inputs :title, :body, :created_at %>
41a6754 @josevalim Another README fix.
josevalim authored
181 <% form.semantic_fields_for :author do |author| %>
1fcc068 @grimen An effort to make the README somewhat more readable.
grimen authored
182 <%= author.inputs :first_name, :last_name, :name => "Author" %>
41a6754 @josevalim Another README fix.
josevalim authored
183 <% end %>
05ae54d @josevalim Fixed nested attributes example in README
josevalim authored
184 <%= form.buttons %>
9997ce6 @josevalim Added more information about inputs :for in README.
josevalim authored
185 <% end %>
186 </pre>
187
6fd1bd2 @justinfrench improving the documentation in README
authored
188 Or the Formtastic way with the @:for@ option:
9997ce6 @josevalim Added more information about inputs :for in README.
josevalim authored
189
190 <pre>
05ae54d @josevalim Fixed nested attributes example in README
josevalim authored
191 <% semantic_form_for @post do |form| %>
192 <%= form.inputs :title, :body, :created_at %>
193 <%= form.inputs :first_name, :last_name, :for => :author, :name => "Author" %>
194 <%= form.buttons %>
9af5cc8 @justinfrench Big update and re-organization of the README:
authored
195 <% end %>
196 </pre>
197
1fcc068 @grimen An effort to make the README somewhat more readable.
grimen authored
198 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
199
200 <pre>
201 <% semantic_form_for @post do |form| %>
202 <%= form.inputs %>
203 <%= form.inputs :name => 'Category #%i', :for => :categories %>
204 <%= form.buttons %>
205 <% end %>
206 </pre>
207
6fd1bd2 @justinfrench improving the documentation in README
authored
208
1fcc068 @grimen An effort to make the README somewhat more readable.
grimen authored
209 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:
6fd1bd2 @justinfrench improving the documentation in README
authored
210
211 <pre>
212 <% semantic_form_for @post do |form| %>
213 <%= form.input :title, :input_html => { :size => 60 } %>
214 <%= form.input :body, :input_html => { :class => 'autogrow' } %>
215 <%= form.input :created_at, :input_html => { :disabled => true } %>
216 <%= form.buttons %>
217 <% end %>
218 </pre>
219
220 The same can be done for buttons with the @:button_html@ option:
221
222 <pre>
223 <% semantic_form_for @post do |form| %>
224 ...
225 <% form.buttons do %>
226 <%= form.commit_button :button_html => { :class => "primary" } %>
227 <% end %>
228 <% end %>
229 </pre>
230
1fcc068 @grimen An effort to make the README somewhat more readable.
grimen authored
231 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"@)
232
6fd1bd2 @justinfrench improving the documentation in README
authored
233 <pre>
234 <% semantic_form_for @post do |form| %>
235 <%= form.input :title, :wrapper_html => { :class => "important" } %>
236 <%= form.input :body %>
237 <%= form.input :description, :wrapper_html => { :style => "display:none;" } %>
238 ...
239 <% end %>
240 </pre>
241
242
5a39443 @justinfrench bulking up the documentation and readme with the different inputs ava…
authored
243 h2. The Available Inputs
244
d9a06fe @grimen README: Last set of polishing moves for now.
grimen authored
245 The Formtastic input types:
246
8577c18 @grimen More README-readability polishing.
grimen authored
247 * @:select@ - a select menu. Default for ActiveRecord associations: @belongs_to@, @has_many@, and @has_and_belongs_to_many@.
248 * @:check_boxes@ - a set of check_box inputs. Alternative to @:select@ for ActiveRecord-associations: @has_many@, and @has_and_belongs_to_many@.
249 * @:radio@ - a set of radio inputs. Alternative to @:select@ for ActiveRecord-associations: @belongs_to@.
250 * @:time_zone@ - a select input. Default for column types: @:string@ with name matching @"time_zone"@.
251 * @:password@ - a password input. Default for column types: @:string@ with name matching @"password"@.
252 * @:text@ - a textarea. Default for column types: @:text@.
253 * @:date@ - a date select. Default for column types: @:date@.
254 * @:datetime@ - a date and time select. Default for column types: @:datetime@ and @:timestamp@.
255 * @:time@ - a time select. Default for column types: @:time@.
256 * @:boolean@ - a checkbox. Default for column types: @:boolean@.
257 * @:string@ - a text field. Default for column types: @:string@.
258 * @:numeric@ - a text field (just like string). Default for column types: @:integer@, @:float@, and @:decimal@.
259 * @: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.
260 * @:country@ - a select menu of country names. Default for column types: :string with name @"country"@ - requires a *country_select* plugin to be installed.
f59f898 @liangzan updated the README for currency select
liangzan authored
261 * @:currency@ - a select menu of currencies. Default for column types: :string with name @"currency"@ - requires a *currency_select* plugin to be installed.
6688887 @grimen More README-polishing.
grimen authored
262 * @:hidden@ - a hidden field. Creates a hidden field (added for compatibility).
263
264 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.
5a39443 @justinfrench bulking up the documentation and readme with the different inputs ava…
authored
265
06ff25d @lardawge Added section clarifying label lookup order.
lardawge authored
266 h2. Delegation for label lookups
267
268 Formtastic decides which label to use in the following order:
269
270 <pre>
271 1. :label # :label => "Choose Title"
272 2. Formtastic i18n # if either :label => true || i18n_lookups_by_default = true (see Internationalization)
273 3. Activerecord i18n # if localization file found for the given attribute
274 4. label_str_method # if nothing provided this defaults to :humanize but can be set to a custom method
275 </pre>
276
94ce3ec @grimen Documentation for the new I18n features for labels/hints.
grimen authored
277 h2. Internationalization (I18n)
278
49a18a5 @grimen README-update: I18n instructions are better structured, and easier to…
grimen authored
279 h3. Basic Localization
71ef99f @justinfrench nuked the configuration copy/paste from the README, linked to the gen…
authored
280
49a18a5 @grimen README-update: I18n instructions are better structured, and easier to…
grimen authored
281 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
282
75782e1 @grimen Updated I18n-instructions in README; on the I18n-support for fieldset…
grimen authored
283 Basic localization (labels only, with ActiveRecord):
94ce3ec @grimen Documentation for the new I18n features for labels/hints.
grimen authored
284
285 <pre>
286 <% semantic_form_for @post do |form| %>
287 <%= form.input :title %> # => :label => I18n.t('activerecord.attributes.user.title') or 'Title'
288 <%= form.input :body %> # => :label => I18n.t('activerecord.attributes.user.body') or 'Body'
289 <%= form.input :section %> # => :label => I18n.t('activerecord.attributes.user.section') or 'Section'
290 <% end %>
291 </pre>
292
49a18a5 @grimen README-update: I18n instructions are better structured, and easier to…
grimen authored
293 *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?
294
295 h3. Enhanced Localization (Formtastic I18n API)
94ce3ec @grimen Documentation for the new I18n features for labels/hints.
grimen authored
296
d9a06fe @grimen README: Last set of polishing moves for now.
grimen authored
297 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
298
49a18a5 @grimen README-update: I18n instructions are better structured, and easier to…
grimen authored
299 *1. Enable I18n lookups by default (@config/initializers/formtastic.rb@):*
94ce3ec @grimen Documentation for the new I18n features for labels/hints.
grimen authored
300
301 <pre>
302 Formtastic::SemanticFormBuilder.i18n_lookups_by_default = true
303 </pre>
304
49a18a5 @grimen README-update: I18n instructions are better structured, and easier to…
grimen authored
305 *2. Add some cool label-translations/variants (@config/locale/en.yml@):*
94ce3ec @grimen Documentation for the new I18n features for labels/hints.
grimen authored
306
307 <pre>
308 en:
309 formtastic:
75782e1 @grimen Updated I18n-instructions in README; on the I18n-support for fieldset…
grimen authored
310 titles:
311 post_details: "Post details"
94ce3ec @grimen Documentation for the new I18n features for labels/hints.
grimen authored
312 labels:
313 post:
314 title: "Choose a title..."
315 body: "Write something..."
75782e1 @grimen Updated I18n-instructions in README; on the I18n-support for fieldset…
grimen authored
316 edit:
317 title: "Edit title"
94ce3ec @grimen Documentation for the new I18n features for labels/hints.
grimen authored
318 hints:
319 post:
320 title: "Choose a good title for you post."
321 body: "Write something inspiring here."
4aca8cd @grimen New I18n-features:
grimen authored
322 actions:
323 create: "Create my {{model}}"
324 update: "Save changes"
325 dummie: "Launch!"
94ce3ec @grimen Documentation for the new I18n features for labels/hints.
grimen authored
326 </pre>
327
328 *Note:* We are using English here still, but you get the point.
329
49a18a5 @grimen README-update: I18n instructions are better structured, and easier to…
grimen authored
330 *3. ...and now you'll get:*
94ce3ec @grimen Documentation for the new I18n features for labels/hints.
grimen authored
331
332 <pre>
4aca8cd @grimen New I18n-features:
grimen authored
333 <% semantic_form_for Post.new do |form| %>
a8e2f2e @justinfrench fix README examples missing form.x prefix for buttons and inputs
authored
334 <% form.inputs do %>
75782e1 @grimen Updated I18n-instructions in README; on the I18n-support for fieldset…
grimen authored
335 <%= form.input :title %> # => :label => "Choose a title...", :hint => "Choose a good title for you post."
336 <%= form.input :body %> # => :label => "Write something...", :hint => "Write something inspiring here."
337 <%= form.input :section %> # => :label => I18n.t('activerecord.attributes.user.section') or 'Section'
338 <% end %>
a8e2f2e @justinfrench fix README examples missing form.x prefix for buttons and inputs
authored
339 <% form.buttons do %>
4aca8cd @grimen New I18n-features:
grimen authored
340 <%= form.commit_button %> # => "Create my {{model}}"
341 <% end %>
94ce3ec @grimen Documentation for the new I18n features for labels/hints.
grimen authored
342 <% end %>
343 </pre>
344
49a18a5 @grimen README-update: I18n instructions are better structured, and easier to…
grimen authored
345 *4. Localized titles (a.k.a. legends):*
75782e1 @grimen Updated I18n-instructions in README; on the I18n-support for fieldset…
grimen authored
346
17f6668 @justinfrench Revert "This reverts commit 440bd2d8da117acdbca57fa199c115caefcd87c0."
authored
347 _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
348
349 <pre>
350 <% semantic_form_for @post do |form| %>
17f6668 @justinfrench Revert "This reverts commit 440bd2d8da117acdbca57fa199c115caefcd87c0."
authored
351 <% form.inputs :post_details do %> # => :title => "Post details"
75782e1 @grimen Updated I18n-instructions in README; on the I18n-support for fieldset…
grimen authored
352 # ...
353 <% end %>
354 # ...
355 <% end %>
356 </pre>
357
49a18a5 @grimen README-update: I18n instructions are better structured, and easier to…
grimen authored
358 *5. Override I18n settings:*
94ce3ec @grimen Documentation for the new I18n features for labels/hints.
grimen authored
359
360 <pre>
361 <% semantic_form_for @post do |form| %>
a8e2f2e @justinfrench fix README examples missing form.x prefix for buttons and inputs
authored
362 <% form.inputs do %>
75782e1 @grimen Updated I18n-instructions in README; on the I18n-support for fieldset…
grimen authored
363 <%= form.input :title %> # => :label => "Choose a title...", :hint => "Choose a good title for you post."
364 <%= form.input :body, :hint => false %> # => :label => "Write something..."
365 <%= form.input :section, :label => 'Some section' %> # => :label => 'Some section'
366 <% end %>
a8e2f2e @justinfrench fix README examples missing form.x prefix for buttons and inputs
authored
367 <% form.buttons do %>
4aca8cd @grimen New I18n-features:
grimen authored
368 <%= form.commit_button :dummie %> # => "Launch!"
369 <% end %>
94ce3ec @grimen Documentation for the new I18n features for labels/hints.
grimen authored
370 <% end %>
371 </pre>
372
373 If I18n-lookups is disabled, i.e.:
374
375 <pre>
376 Formtastic::SemanticFormBuilder.i18n_lookups_by_default = false
377 </pre>
378
379 ...then you can enable I18n within the forms instead:
380
381 <pre>
382 <% semantic_form_for @post do |form| %>
a8e2f2e @justinfrench fix README examples missing form.x prefix for buttons and inputs
authored
383 <% form.inputs do %>
75782e1 @grimen Updated I18n-instructions in README; on the I18n-support for fieldset…
grimen authored
384 <%= form.input :title, :label => true %> # => :label => "Choose a title..."
385 <%= form.input :body, :label => true %> # => :label => "Write something..."
386 <%= form.input :section, :label => true %> # => :label => I18n.t('activerecord.attributes.user.section') or 'Section'
387 <% end %>
a8e2f2e @justinfrench fix README examples missing form.x prefix for buttons and inputs
authored
388 <% form.buttons do %>
4aca8cd @grimen New I18n-features:
grimen authored
389 <%= form.commit_button true %> # => "Save changes" (if we are in edit that is...)
390 <% end %>
94ce3ec @grimen Documentation for the new I18n features for labels/hints.
grimen authored
391 <% end %>
392 </pre>
393
49a18a5 @grimen README-update: I18n instructions are better structured, and easier to…
grimen authored
394 *6. Advanced I18n lookups*
94ce3ec @grimen Documentation for the new I18n features for labels/hints.
grimen authored
395
396 For more flexible forms; Formtastic find translations using a bottom-up approach taking the following variables in account:
397
75782e1 @grimen Updated I18n-instructions in README; on the I18n-support for fieldset…
grimen authored
398 * @MODEL@, e.g. "post"
399 * @ACTION@, e.g. "edit"
4aca8cd @grimen New I18n-features:
grimen authored
400 * @KEY/ATTRIBUTE@, e.g. "title", :my_custom_key, ...
94ce3ec @grimen Documentation for the new I18n features for labels/hints.
grimen authored
401
402 ...in the following order:
403
6688887 @grimen More README-polishing.
grimen authored
404 1. @formtastic.{titles,labels,hints,actions}.MODEL.ACTION.ATTRIBUTE@ - by model and action
405 2. @formtastic.{titles,labels,hints,actions}.MODEL.ATTRIBUTE@ - by model
406 3. @formtastic.{titles,labels,hints,actions}.ATTRIBUTE@ - global default
94ce3ec @grimen Documentation for the new I18n features for labels/hints.
grimen authored
407
408 ...which means that you can define translations like this:
409
410 <pre>
411 en:
412 formtastic:
413 labels:
414 title: "Title" # Default global value
415 article:
416 body: "Article content"
417 post:
418 new:
419 title: "Choose a title..."
420 body: "Write something..."
421 edit:
422 title: "Edit title"
423 body: "Edit body"
424 </pre>
425
4aca8cd @grimen New I18n-features:
grimen authored
426 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
427
71ef99f @justinfrench nuked the configuration copy/paste from the README, linked to the gen…
authored
428
c4ebcef * added semantic_errors method with specs
Wojciech Wnętrzak authored
429 h2. Semantic errors
430
431 You can show errors on base (by default) and any other attribute just passing it name to semantic_errors method:
432
433 <pre>
434 <% semantic_form_for @post do |form| %>
435 <%= form.semantic_errors :state %>
436 <% end %>
437 </pre>
438
439
94ce3ec @grimen Documentation for the new I18n features for labels/hints.
grimen authored
440 h2. ValidationReflection plugin
441
49a18a5 @grimen README-update: I18n instructions are better structured, and easier to…
grimen authored
442 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
443
444
71ef99f @justinfrench nuked the configuration copy/paste from the README, linked to the gen…
authored
445 h2. Configuration
5a39443 @justinfrench bulking up the documentation and readme with the different inputs ava…
authored
446
1fcc068 @grimen An effort to make the README somewhat more readable.
grimen authored
447 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
3a32b4a @josevalim Updated README with new configuration options.
josevalim authored
448
5a39443 @justinfrench bulking up the documentation and readme with the different inputs ava…
authored
449
fef3288 @grimen Added documentation for the form generator in README, and showing som…
grimen authored
450 h2. Form Generator
451
452 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:
453
454 *Alt. 1: Generate in terminal:*
455
456 <pre>
457 $ ./script/generate form Post
458 # ---------------------------------------------------------
459 # GENERATED FORMTASTIC CODE
460 # ---------------------------------------------------------
461
e57b9d1 @grimen Form generator: |f| is a better default for |form|. Also works better…
grimen authored
462 <% f.inputs do %>
463 <%= f.input :title, :label => 'Title' %>
464 <%= f.input :body, :label => 'Body' %>
465 <%= f.input :published, :label => 'Published' %>
fef3288 @grimen Added documentation for the form generator in README, and showing som…
grimen authored
466 <% end %>
467
468 # ---------------------------------------------------------
469 Copied to clipboard - just paste it!
470 </pre>
471
472 *Alt. 2: Generate partial:*
473
474 <pre>
475 $ ./script/generate form Post --partial
476 exists app/views/posts
477 create app/views/posts/_form.html.erb
478 </pre>
479
3f58f3a @justinfrench README update for --controller option form generator
authored
480 To generate *HAML* markup, just add the @--haml@ as argument:
481
482 <pre>
483 $ ./script/generate form Post --haml
484 exists app/views/admin/posts
485 create app/views/admin/posts/_form.html.haml
486 </pre>
487
488 To specify the controller in a namespace (eg admin/posts instead of posts), use the --controller argument:
489
490 <pre>
491 $ ./script/generate form Post --partial --controller admin/posts
492 exists app/views/admin/posts
493 create app/views/admin/posts/_form.html.erb
494 </pre>
495
fef3288 @grimen Added documentation for the form generator in README, and showing som…
grimen authored
496
ce7da5e @justinfrench added the builder config to the config template and quick documentati…
authored
497 h2. Custom Inputs
498
499 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.
500
501 @Formtastic::SemanticFormHelper.builder = MyCustomBuilder@
502
503
3f58f3a @justinfrench README update for --controller option form generator
authored
504
505
09d957d textilized the README so that it looks pretty pretty on GitHub
Justin French authored
506 h2. Status
dcf8beb Initial Commit
Justin French authored
507
6688887 @grimen More README-polishing.
grimen authored
508 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.
c5d02e6 @justinfrench link to the wiki for the roadmap to 1.0 in README
authored
509
dcf8beb Initial Commit
Justin French authored
510
9af5cc8 @justinfrench Big update and re-organization of the README:
authored
511 h2. Dependencies
dcf8beb Initial Commit
Justin French authored
512
9af5cc8 @justinfrench Big update and re-organization of the README:
authored
513 There are none, but...
dcf8beb Initial Commit
Justin French authored
514
e9f27cf @grimen The most tiny README-update ever. =)
grimen authored
515 * 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
516 * 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).
f59f898 @liangzan updated the README for currency select
liangzan authored
517 * if you want to use the @:currency@ input, you'll need to install the "currency_select plugin":http://github.com/gavinlaking/currency_select (or any other currency_select plugin with the same API).
1fcc068 @grimen An effort to make the README somewhat more readable.
grimen authored
518 * "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
519
0b370ba @justinfrench Renamed input_field_set() to just inputs() and added a shorthand vers…
authored
520
9af5cc8 @justinfrench Big update and re-organization of the README:
authored
521 h2. Compatibility
0b370ba @justinfrench Renamed input_field_set() to just inputs() and added a shorthand vers…
authored
522
d7fff76 @justinfrench updated compatability guidelines
authored
523 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!
0b370ba @justinfrench Renamed input_field_set() to just inputs() and added a shorthand vers…
authored
524
67a799f @grimen Made method_required? respect the :if conditional on validates_presen…
grimen authored
525 h2. Got TextMate?
526
6688887 @grimen More README-polishing.
grimen authored
527 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:
67a799f @grimen Made method_required? respect the :if conditional on validates_presen…
grimen authored
528
529 "Formtastic.tmbundle":http://github.com/grimen/formtastic_tmbundle
2d4a72b @justinfrench big update to the README
authored
530
61d0056 @justinfrench * updated the status to reflect that this is a release candidate
authored
531
2079c59 @justinfrench added a section about contributing to README
authored
532 h2. How to contribute
533
534 *Before you send a pull request*, 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.
535
536 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.
537
538 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.
539
540
259a98c @justinfrench updated heading in README
authored
541 h2. Maintainers & Contributors
83b9eb1 @justinfrench updated the contributors list
authored
542
4ac2f58 @justinfrench we now have over 40 contributors
authored
543 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 40 contributors.
619ce6c @justinfrench added Grimen to the README, updated contributors list, etc
authored
544
545 @git shortlog -n -s --no-merges@
2d4a72b @justinfrench big update to the README
authored
546
5af0311 @justinfrench updated the README to pimp the google group more
authored
547
7a84a73 @justinfrench README heading tweak
authored
548 h2. Google Group
5af0311 @justinfrench updated the README to pimp the google group more
authored
549
550 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.
551
552
ba3ce05 @justinfrench updated the README a little with contributors and some other busy work
authored
553 h2. Project Info
554
1fcc068 @grimen An effort to make the README somewhat more readable.
grimen authored
555 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
556
557
25d0c7a @justinfrench fleshed out a 'roadmap to 1.0' in the README
authored
558 Copyright (c) 2007-2008 Justin French, released under the MIT license.
Something went wrong with that request. Please try again.