Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 613 lines (444 sloc) 27.337 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
cd0a1ba @justinfrench pledgie image URL is a redirect, so here's the real URL
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://pledgie.com/campaigns/2178.png?skin_name=chrome' border='0' /></a>
1bbe8ea @justinfrench add the pledgie badge back in, GH don't show them any more?
authored
6
dc5857b @justinfrench moved compatibility note in README further up
authored
7
8 h2. Compatibility
9
10 * Formtastic 1.x is compatible with both Rails 2 and 3, and is being maintained for bug fixes in the the "1.2-stable branch":https://github.com/justinfrench/formtastic/tree/1.2-stable.
11 * Formtastic 2.0 will be Rails 3.x compatible only
12 * If you're bundling Formtastic from edge/master, get ready for a bumpy ride. Try the "1.2-stable branch":https://github.com/justinfrench/formtastic/tree/1.2-stable.
13 * Formtastic, much like Rails, is very ActiveRecord-centric. Many are successfully using other ActiveModel-like ORMs and objects (DataMapper, MongoMapper, Mongoid, Authlogic, Devise...) but we're not guaranteeing full compatibility at this stage. Patches are welcome!
14
15
09d957d textilized the README so that it looks pretty pretty on GitHub
Justin French authored
16 h2. The Story
dcf8beb Initial Commit
Justin French authored
17
2d4a72b @justinfrench big update to the README
authored
18 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
19
09d957d textilized the README so that it looks pretty pretty on GitHub
Justin French authored
20 <pre>
7e3874a @justinfrench trying to fix README formatting of <'s at the start of lines
authored
21 <% semantic_form_for @article do |form| %>
353618e @markmansour Extending Formtastic can be done by overriding the semantic_form_buil…
markmansour authored
22
0b370ba @justinfrench Renamed input_field_set() to just inputs() and added a shorthand vers…
authored
23 <% form.inputs :name => "Basic" do %>
353618e @markmansour Extending Formtastic can be done by overriding the semantic_form_buil…
markmansour authored
24 <%= form.input :title %>
25 <%= form.input :body %>
1db292f @sprsquish update README to reflect association attribute changes
sprsquish authored
26 <%= form.input :section %>
27 <%= form.input :publication_state, :as => :radio %>
9997ce6 @josevalim Added more information about inputs :for in README.
josevalim authored
28 <%= form.input :category %>
353618e @markmansour Extending Formtastic can be done by overriding the semantic_form_buil…
markmansour authored
29 <%= form.input :allow_comments, :label => "Allow commenting on this article" %>
30 <% end %>
31
0b370ba @justinfrench Renamed input_field_set() to just inputs() and added a shorthand vers…
authored
32 <% form.inputs :name => "Advanced" do %>
353618e @markmansour Extending Formtastic can be done by overriding the semantic_form_buil…
markmansour authored
33 <%= 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
34 <%= form.input :extract, :required => false %>
35 <%= form.input :description, :required => false %>
353618e @markmansour Extending Formtastic can be done by overriding the semantic_form_buil…
markmansour authored
36 <%= form.input :url_title, :required => false %>
7e3874a @justinfrench trying to fix README formatting of <'s at the start of lines
authored
37 <% end %>
38
05ae54d @josevalim Fixed nested attributes example in README
josevalim authored
39 <% form.inputs :name => "Author", :for => :author do |author_form| %>
40 <%= author_form.input :first_name %>
41 <%= author_form.input :last_name %>
9997ce6 @josevalim Added more information about inputs :for in README.
josevalim authored
42 <% end %>
43
353618e @markmansour Extending Formtastic can be done by overriding the semantic_form_buil…
markmansour authored
44 <% form.buttons do %>
45 <%= form.commit_button %>
7e3874a @justinfrench trying to fix README formatting of <'s at the start of lines
authored
46 <% end %>
09d957d textilized the README so that it looks pretty pretty on GitHub
Justin French authored
47
dcf8beb Initial Commit
Justin French authored
48 <% end %>
09d957d textilized the README so that it looks pretty pretty on GitHub
Justin French authored
49 </pre>
50
6734cfd @justinfrench sme typos and cleanups in the readme
authored
51 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
52
53
9af5cc8 @justinfrench Big update and re-organization of the README:
authored
54 h2. It's better than _SomeOtherFormBuilder_ because...
55
6688887 @grimen More README-polishing.
grimen authored
56 * 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.
57 * 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.
3340c53 @justinfrench Remove Rails 2 stuff from README
authored
58 * it's Rails 3 compatible (including nested forms).
f02b136 @justinfrench rearranged and beefed up the 'it's better than...' README section
authored
59 * it has internationalization (I18n)!
6688887 @grimen More README-polishing.
grimen authored
60 * 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.
61 * there's heaps of elements, id and class attributes for you to hook in your CSS and JS.
62 * it handles real world stuff like inline hints, inline error messages & help text.
63 * 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).
64 * it's got absolutely awesome spec coverage.
65 * 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
66
67
15e0bd9 updated the README a little to match last night's slides
Justin French authored
68 h2. Why?
69
6688887 @grimen More README-polishing.
grimen authored
70 * web apps = lots of forms.
71 * forms are so friggin' boring to code.
72 * semantically rich & accessible forms really are possible.
73 * the "V" is way behind the "M" and "C" in Rails' MVC – it's the ugly sibling.
74 * best practices and common patterns have to start somewhere.
75 * i need a challenge.
dcf8beb Initial Commit
Justin French authored
76
77
15e0bd9 updated the README a little to match last night's slides
Justin French authored
78 h2. Opinions
79
6688887 @grimen More README-polishing.
grimen authored
80 * it should be easier to do things the right way than the wrong way.
81 * sometimes _more mark-up_ is better.
82 * elements and attribute hooks are _gold_ for stylesheet authors.
83 * 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
84
dcf8beb Initial Commit
Justin French authored
85
3dd6455 @justinfrench Link to RDoc URL in README
authored
86 h2. Documentation
87
88 RDoc documentation _should_ be automatically generated after each commit and made available on the "rdoc.info website":http://rdoc.info/projects/justinfrench/formtastic.
89
90
e3f04f6 @justinfrench README installation instructions simlified and clarified to specific …
authored
91 h2. Installation
c89e985 @justinfrench updating README with gem/plugin installation instructions
authored
92
dc5857b @justinfrench moved compatibility note in README further up
authored
93 Formtastic edge (2.0) will be compatible with Rails 3 only, and the gem is "hosted":http://rubygems.org/gems/formtastic on RubyGems.org.
557f929 @justinfrench updated README to reflect new 1.1.0.beta gem, etc
authored
94
ebe4e51 @justinfrench updated the README to reflect the new gem versions and other compatib…
authored
95 Simply add Formtastic to your Gemfile and bundle it up:
557f929 @justinfrench updated README to reflect new 1.1.0.beta gem, etc
authored
96
97 <pre>
3340c53 @justinfrench Remove Rails 2 stuff from README
authored
98 gem 'formtastic', '~> 2.0.0'
557f929 @justinfrench updated README to reflect new 1.1.0.beta gem, etc
authored
99 </pre>
100
e3f04f6 @justinfrench README installation instructions simlified and clarified to specific …
authored
101 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
102
103 <pre>
e3f04f6 @justinfrench README installation instructions simlified and clarified to specific …
authored
104 $ rails generate formtastic:install
c89e985 @justinfrench updating README with gem/plugin installation instructions
authored
105 </pre>
106
ebe4e51 @justinfrench updated the README to reflect the new gem versions and other compatib…
authored
107
108 h2. Stylesheets
c89e985 @justinfrench updating README with gem/plugin installation instructions
authored
109
127a6b9 @justinfrench Added a Formtastic::LayoutHelper with formtastic_stylesheets so that …
authored
110 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
111
5c1ce48 @justinfrench moved the stylesheets stuff up with installation
authored
112 <pre>
127a6b9 @justinfrench Added a Formtastic::LayoutHelper with formtastic_stylesheets so that …
authored
113 <head>
114 ...
cd39b4b @sobrinho Remove formtastic_stylesheet_link_tag
sobrinho authored
115 <%= stylesheet_link_tag 'formtastic', 'formtastic_changes' %>
127a6b9 @justinfrench Added a Formtastic::LayoutHelper with formtastic_stylesheets so that …
authored
116 ...
117 </head>
5c1ce48 @justinfrench moved the stylesheets stuff up with installation
authored
118 </pre>
2526d2c @justinfrench Going back to generators instead of Rake tasks for copying stylesheet…
authored
119
4036e74 @justinfrench pruning and cleaning up the README, it's been a while
authored
120
9af5cc8 @justinfrench Big update and re-organization of the README:
authored
121 h2. Usage
122
123 Forms are really boring to code... you want to get onto the good stuff as fast as possible.
124
6688887 @grimen More README-polishing.
grimen authored
125 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
126
127 <pre>
128 <% semantic_form_for @user do |form| %>
129 <%= form.inputs %>
130 <%= form.buttons %>
131 <% end %>
132 </pre>
133
5018ed0 @justinfrench clarified the differences in Rails 2 and 3 ERB blocks, and some other…
authored
134 This is a great way to get something up fast, but like scaffolding, it's not recommended for production.
135
136 You probably 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@:
9af5cc8 @justinfrench Big update and re-organization of the README:
authored
137
138 <pre>
139 <% semantic_form_for @user do |form| %>
140 <%= form.inputs :title, :body, :section, :categories, :created_at %>
141 <%= form.buttons :commit %>
142 <% end %>
143 </pre>
144
5018ed0 @justinfrench clarified the differences in Rails 2 and 3 ERB blocks, and some other…
authored
145 You probably 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
146
147 <pre>
148 <% semantic_form_for @post do |form| %>
149 <% form.inputs do %>
150 <%= form.input :title %>
151 <%= form.input :body %>
152 <%= form.input :section, :as => :radio %>
153 <%= form.input :categories %>
154 <%= form.input :created_at, :as => :string %>
155 <% end %>
156 <% form.buttons do %>
157 <%= form.commit_button %>
158 <% end %>
159 <% end %>
160 </pre>
161
a45853c @justinfrench small README typo
authored
162 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
163
164 <pre>
165 <% semantic_form_for @post do |form| %>
17f6668 @justinfrench Revert "This reverts commit 440bd2d8da117acdbca57fa199c115caefcd87c0."
authored
166 <% form.inputs "Basic", :id => "basic" do %>
9af5cc8 @justinfrench Big update and re-organization of the README:
authored
167 <%= form.input :title %>
168 <%= form.input :body %>
169 <% end %>
170 <% form.inputs :name => "Advanced Options", :id => "advanced" do %>
171 <%= form.input :slug, :label => "URL Title", :hint => "Created automatically if left blank", :required => false %>
172 <%= form.input :section, :as => :radio %>
d174db0 @asanghi change id_prefix to namespace; added documentation in README
asanghi authored
173 <%= form.input :user, :label => "Author", :label_method => :full_name %>
9af5cc8 @justinfrench Big update and re-organization of the README:
authored
174 <%= form.input :categories, :required => false %>
175 <%= form.input :created_at, :as => :string, :label => "Publication Date", :required => false %>
176 <% end %>
177 <% form.buttons do %>
178 <%= form.commit_button %>
179 <% end %>
180 <% end %>
181 </pre>
182
4033f27 @nathanl Small addition to documentation
nathanl authored
183 You can create forms for nested resources:
184
185 <pre>
186 <% semantic_form_for [@author, @post] do |form| %>
187 </pre>
188
bcd3ba9 @justinfrench some README updates
authored
189 Nested forms are also supported (don't forget your models need to be setup correctly with @accepts_nested_attributes_for@). You can do it in the Rails way:
9af5cc8 @justinfrench Big update and re-organization of the README:
authored
190
191 <pre>
05ae54d @josevalim Fixed nested attributes example in README
josevalim authored
192 <% semantic_form_for @post do |form| %>
193 <%= form.inputs :title, :body, :created_at %>
41a6754 @josevalim Another README fix.
josevalim authored
194 <% form.semantic_fields_for :author do |author| %>
1fcc068 @grimen An effort to make the README somewhat more readable.
grimen authored
195 <%= author.inputs :first_name, :last_name, :name => "Author" %>
41a6754 @josevalim Another README fix.
josevalim authored
196 <% end %>
05ae54d @josevalim Fixed nested attributes example in README
josevalim authored
197 <%= form.buttons %>
9997ce6 @josevalim Added more information about inputs :for in README.
josevalim authored
198 <% end %>
199 </pre>
200
6fd1bd2 @justinfrench improving the documentation in README
authored
201 Or the Formtastic way with the @:for@ option:
9997ce6 @josevalim Added more information about inputs :for in README.
josevalim authored
202
203 <pre>
05ae54d @josevalim Fixed nested attributes example in README
josevalim authored
204 <% semantic_form_for @post do |form| %>
205 <%= form.inputs :title, :body, :created_at %>
206 <%= form.inputs :first_name, :last_name, :for => :author, :name => "Author" %>
207 <%= form.buttons %>
9af5cc8 @justinfrench Big update and re-organization of the README:
authored
208 <% end %>
209 </pre>
210
1fcc068 @grimen An effort to make the README somewhat more readable.
grimen authored
211 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
212
213 <pre>
214 <% semantic_form_for @post do |form| %>
215 <%= form.inputs %>
216 <%= form.inputs :name => 'Category #%i', :for => :categories %>
217 <%= form.buttons %>
218 <% end %>
219 </pre>
220
d174db0 @asanghi change id_prefix to namespace; added documentation in README
asanghi authored
221 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
222 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:
223
224 <pre>
225 <% semantic_form_for(@post, :namespace => 'cat_form') do |form| %>
226 <%= form.input :title %> # id="cat_form_post_title"
227 <%= form.input :body %> # id="cat_form_post_body"
228 <%= form.input :created_at %> # id="cat_form_post_created_at"
229 <%= form.buttons %>
230 <% end %>
231 </pre>
6fd1bd2 @justinfrench improving the documentation in README
authored
232
29133e1 @dougireton Fixed minor typo in README Usage section.
dougireton authored
233 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
234
235 <pre>
236 <% semantic_form_for @post do |form| %>
237 <%= form.input :title, :input_html => { :size => 60 } %>
238 <%= form.input :body, :input_html => { :class => 'autogrow' } %>
239 <%= form.input :created_at, :input_html => { :disabled => true } %>
240 <%= form.buttons %>
241 <% end %>
242 </pre>
243
244 The same can be done for buttons with the @:button_html@ option:
245
246 <pre>
247 <% semantic_form_for @post do |form| %>
248 ...
249 <% form.buttons do %>
250 <%= form.commit_button :button_html => { :class => "primary" } %>
251 <% end %>
252 <% end %>
253 </pre>
254
d174db0 @asanghi change id_prefix to namespace; added documentation in README
asanghi authored
255 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
256
6fd1bd2 @justinfrench improving the documentation in README
authored
257 <pre>
258 <% semantic_form_for @post do |form| %>
259 <%= form.input :title, :wrapper_html => { :class => "important" } %>
260 <%= form.input :body %>
261 <%= form.input :description, :wrapper_html => { :style => "display:none;" } %>
262 ...
263 <% end %>
264 </pre>
265
d174db0 @asanghi change id_prefix to namespace; added documentation in README
asanghi authored
266 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.
267
268 <pre>
269 <% semantic_form_for @post do |form| %>
270 <%= form.input :title, :hint_class => 'custom-html-class', :error_class => 'custom-error-class' %>
271 <% end %>
272 </pre>
273
a92cf7c @justinfrench added documentation for :collection option, resolves #181
authored
274 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:
275
276 <pre>
277 f.input :authors, :as => :check_boxes, :collection => User.find(:all, :order => "last_name ASC")
278 f.input :authors, :as => :check_boxes, :collection => current_user.company.users.active
279 f.input :authors, :as => :check_boxes, :collection => [@justin, @kate]
280 f.input :authors, :as => :check_boxes, :collection => ["Justin", "Kate", "Amelia", "Gus", "Meg"]
281 f.input :author, :as => :select, :collection => Author.find(:all)
282 f.input :author, :as => :select, :collection => { @justin.name => @justin.id, @kate.name => @kate.id }
283 f.input :author, :as => :select, :collection => ["Justin", "Kate", "Amelia", "Gus", "Meg"]
284 f.input :author, :as => :radio, :collection => User.find(:all)
285 f.input :author, :as => :radio, :collection => [@justin, @kate]
286 f.input :author, :as => :radio, :collection => { @justin.name => @justin.id, @kate.name => @kate.id }
287 f.input :author, :as => :radio, :collection => ["Justin", "Kate", "Amelia", "Gus", "Meg"]
288 f.input :admin, :as => :radio, :collection => ["Yes!", "No"]
289 </pre>
290
6fd1bd2 @justinfrench improving the documentation in README
authored
291
5a39443 @justinfrench bulking up the documentation and readme with the different inputs ava…
authored
292 h2. The Available Inputs
293
d9a06fe @grimen README: Last set of polishing moves for now.
grimen authored
294 The Formtastic input types:
295
8577c18 @grimen More README-readability polishing.
grimen authored
296 * @:select@ - a select menu. Default for ActiveRecord associations: @belongs_to@, @has_many@, and @has_and_belongs_to_many@.
297 * @:check_boxes@ - a set of check_box inputs. Alternative to @:select@ for ActiveRecord-associations: @has_many@, and @has_and_belongs_to_many@.
298 * @:radio@ - a set of radio inputs. Alternative to @:select@ for ActiveRecord-associations: @belongs_to@.
299 * @:time_zone@ - a select input. Default for column types: @:string@ with name matching @"time_zone"@.
300 * @:password@ - a password input. Default for column types: @:string@ with name matching @"password"@.
301 * @:text@ - a textarea. Default for column types: @:text@.
302 * @:date@ - a date select. Default for column types: @:date@.
303 * @:datetime@ - a date and time select. Default for column types: @:datetime@ and @:timestamp@.
304 * @:time@ - a time select. Default for column types: @:time@.
305 * @:boolean@ - a checkbox. Default for column types: @:boolean@.
306 * @:string@ - a text field. Default for column types: @:string@.
307 * @:numeric@ - a text field (just like string). Default for column types: @:integer@, @:float@, and @:decimal@.
308 * @: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.
309 * @: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
310 * @:email@ - a text field (just like string). Default for columns with name matching @"email"@. New in HTML5. Works on some mobile browsers already.
311 * @:url@ - a text field (just like string). Default for columns with name matching @"url"@. New in HTML5. Works on some mobile browsers already.
312 * @:phone@ - a text field (just like string). Default for columns with name matching @"phone"@ or @"fax"@. New in HTML5.
313 * @: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
314 * @:hidden@ - a hidden field. Creates a hidden field (added for compatibility).
315
fd23ef4 @justinfrench tiny README tweak
authored
316 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.
317
5a39443 @justinfrench bulking up the documentation and readme with the different inputs ava…
authored
318
06ff25d @lardawge Added section clarifying label lookup order.
lardawge authored
319 h2. Delegation for label lookups
320
321 Formtastic decides which label to use in the following order:
322
323 <pre>
324 1. :label # :label => "Choose Title"
325 2. Formtastic i18n # if either :label => true || i18n_lookups_by_default = true (see Internationalization)
326 3. Activerecord i18n # if localization file found for the given attribute
327 4. label_str_method # if nothing provided this defaults to :humanize but can be set to a custom method
328 </pre>
329
94ce3ec @grimen Documentation for the new I18n features for labels/hints.
grimen authored
330 h2. Internationalization (I18n)
331
49a18a5 @grimen README-update: I18n instructions are better structured, and easier to…
grimen authored
332 h3. Basic Localization
71ef99f @justinfrench nuked the configuration copy/paste from the README, linked to the gen…
authored
333
49a18a5 @grimen README-update: I18n instructions are better structured, and easier to…
grimen authored
334 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
335
75782e1 @grimen Updated I18n-instructions in README; on the I18n-support for fieldset…
grimen authored
336 Basic localization (labels only, with ActiveRecord):
94ce3ec @grimen Documentation for the new I18n features for labels/hints.
grimen authored
337
338 <pre>
339 <% semantic_form_for @post do |form| %>
340 <%= form.input :title %> # => :label => I18n.t('activerecord.attributes.user.title') or 'Title'
341 <%= form.input :body %> # => :label => I18n.t('activerecord.attributes.user.body') or 'Body'
342 <%= form.input :section %> # => :label => I18n.t('activerecord.attributes.user.section') or 'Section'
343 <% end %>
344 </pre>
345
49a18a5 @grimen README-update: I18n instructions are better structured, and easier to…
grimen authored
346 *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?
347
348 h3. Enhanced Localization (Formtastic I18n API)
94ce3ec @grimen Documentation for the new I18n features for labels/hints.
grimen authored
349
d9a06fe @grimen README: Last set of polishing moves for now.
grimen authored
350 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
351
49a18a5 @grimen README-update: I18n instructions are better structured, and easier to…
grimen authored
352 *1. Enable I18n lookups by default (@config/initializers/formtastic.rb@):*
94ce3ec @grimen Documentation for the new I18n features for labels/hints.
grimen authored
353
354 <pre>
549ef7a @justinfrench Renamed all instances of Formtastic::SemanticFormBuilder to Formtasti…
authored
355 Formtastic::FormBuilder.i18n_lookups_by_default = true
94ce3ec @grimen Documentation for the new I18n features for labels/hints.
grimen authored
356 </pre>
357
49a18a5 @grimen README-update: I18n instructions are better structured, and easier to…
grimen authored
358 *2. Add some cool label-translations/variants (@config/locale/en.yml@):*
94ce3ec @grimen Documentation for the new I18n features for labels/hints.
grimen authored
359
360 <pre>
361 en:
362 formtastic:
75782e1 @grimen Updated I18n-instructions in README; on the I18n-support for fieldset…
grimen authored
363 titles:
364 post_details: "Post details"
94ce3ec @grimen Documentation for the new I18n features for labels/hints.
grimen authored
365 labels:
366 post:
367 title: "Choose a title..."
368 body: "Write something..."
75782e1 @grimen Updated I18n-instructions in README; on the I18n-support for fieldset…
grimen authored
369 edit:
370 title: "Edit title"
94ce3ec @grimen Documentation for the new I18n features for labels/hints.
grimen authored
371 hints:
372 post:
373 title: "Choose a good title for you post."
374 body: "Write something inspiring here."
4aca8cd @grimen New I18n-features:
grimen authored
375 actions:
743b26b @yabawock Revert "Reverting two i18n patches pulled in from the rails3 branch w…
yabawock authored
376 create: "Create my %{model}"
4aca8cd @grimen New I18n-features:
grimen authored
377 update: "Save changes"
378 dummie: "Launch!"
94ce3ec @grimen Documentation for the new I18n features for labels/hints.
grimen authored
379 </pre>
380
381 *Note:* We are using English here still, but you get the point.
382
49a18a5 @grimen README-update: I18n instructions are better structured, and easier to…
grimen authored
383 *3. ...and now you'll get:*
94ce3ec @grimen Documentation for the new I18n features for labels/hints.
grimen authored
384
385 <pre>
4aca8cd @grimen New I18n-features:
grimen authored
386 <% semantic_form_for Post.new do |form| %>
a8e2f2e @justinfrench fix README examples missing form.x prefix for buttons and inputs
authored
387 <% form.inputs do %>
75782e1 @grimen Updated I18n-instructions in README; on the I18n-support for fieldset…
grimen authored
388 <%= form.input :title %> # => :label => "Choose a title...", :hint => "Choose a good title for you post."
389 <%= form.input :body %> # => :label => "Write something...", :hint => "Write something inspiring here."
390 <%= form.input :section %> # => :label => I18n.t('activerecord.attributes.user.section') or 'Section'
391 <% end %>
a8e2f2e @justinfrench fix README examples missing form.x prefix for buttons and inputs
authored
392 <% form.buttons do %>
743b26b @yabawock Revert "Reverting two i18n patches pulled in from the rails3 branch w…
yabawock authored
393 <%= form.commit_button %> # => "Create my %{model}"
4aca8cd @grimen New I18n-features:
grimen authored
394 <% end %>
94ce3ec @grimen Documentation for the new I18n features for labels/hints.
grimen authored
395 <% end %>
396 </pre>
397
49a18a5 @grimen README-update: I18n instructions are better structured, and easier to…
grimen authored
398 *4. Localized titles (a.k.a. legends):*
75782e1 @grimen Updated I18n-instructions in README; on the I18n-support for fieldset…
grimen authored
399
17f6668 @justinfrench Revert "This reverts commit 440bd2d8da117acdbca57fa199c115caefcd87c0."
authored
400 _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
401
402 <pre>
403 <% semantic_form_for @post do |form| %>
17f6668 @justinfrench Revert "This reverts commit 440bd2d8da117acdbca57fa199c115caefcd87c0."
authored
404 <% form.inputs :post_details do %> # => :title => "Post details"
75782e1 @grimen Updated I18n-instructions in README; on the I18n-support for fieldset…
grimen authored
405 # ...
406 <% end %>
407 # ...
408 <% end %>
409 </pre>
410
49a18a5 @grimen README-update: I18n instructions are better structured, and easier to…
grimen authored
411 *5. Override I18n settings:*
94ce3ec @grimen Documentation for the new I18n features for labels/hints.
grimen authored
412
413 <pre>
414 <% semantic_form_for @post do |form| %>
a8e2f2e @justinfrench fix README examples missing form.x prefix for buttons and inputs
authored
415 <% form.inputs do %>
75782e1 @grimen Updated I18n-instructions in README; on the I18n-support for fieldset…
grimen authored
416 <%= form.input :title %> # => :label => "Choose a title...", :hint => "Choose a good title for you post."
417 <%= form.input :body, :hint => false %> # => :label => "Write something..."
418 <%= form.input :section, :label => 'Some section' %> # => :label => 'Some section'
419 <% end %>
a8e2f2e @justinfrench fix README examples missing form.x prefix for buttons and inputs
authored
420 <% form.buttons do %>
4aca8cd @grimen New I18n-features:
grimen authored
421 <%= form.commit_button :dummie %> # => "Launch!"
422 <% end %>
94ce3ec @grimen Documentation for the new I18n features for labels/hints.
grimen authored
423 <% end %>
424 </pre>
425
426 If I18n-lookups is disabled, i.e.:
427
428 <pre>
549ef7a @justinfrench Renamed all instances of Formtastic::SemanticFormBuilder to Formtasti…
authored
429 Formtastic::FormBuilder.i18n_lookups_by_default = false
94ce3ec @grimen Documentation for the new I18n features for labels/hints.
grimen authored
430 </pre>
431
432 ...then you can enable I18n within the forms instead:
433
434 <pre>
435 <% semantic_form_for @post do |form| %>
a8e2f2e @justinfrench fix README examples missing form.x prefix for buttons and inputs
authored
436 <% form.inputs do %>
75782e1 @grimen Updated I18n-instructions in README; on the I18n-support for fieldset…
grimen authored
437 <%= form.input :title, :label => true %> # => :label => "Choose a title..."
438 <%= form.input :body, :label => true %> # => :label => "Write something..."
439 <%= form.input :section, :label => true %> # => :label => I18n.t('activerecord.attributes.user.section') or 'Section'
440 <% end %>
a8e2f2e @justinfrench fix README examples missing form.x prefix for buttons and inputs
authored
441 <% form.buttons do %>
4b1ba5f @dbackeus Updated expected commit_button text in README.
dbackeus authored
442 <%= form.commit_button true %> # => "Update %{model}" (if we are in edit that is...)
4aca8cd @grimen New I18n-features:
grimen authored
443 <% end %>
94ce3ec @grimen Documentation for the new I18n features for labels/hints.
grimen authored
444 <% end %>
445 </pre>
446
49a18a5 @grimen README-update: I18n instructions are better structured, and easier to…
grimen authored
447 *6. Advanced I18n lookups*
94ce3ec @grimen Documentation for the new I18n features for labels/hints.
grimen authored
448
449 For more flexible forms; Formtastic find translations using a bottom-up approach taking the following variables in account:
450
75782e1 @grimen Updated I18n-instructions in README; on the I18n-support for fieldset…
grimen authored
451 * @MODEL@, e.g. "post"
452 * @ACTION@, e.g. "edit"
4aca8cd @grimen New I18n-features:
grimen authored
453 * @KEY/ATTRIBUTE@, e.g. "title", :my_custom_key, ...
94ce3ec @grimen Documentation for the new I18n features for labels/hints.
grimen authored
454
455 ...in the following order:
456
6688887 @grimen More README-polishing.
grimen authored
457 1. @formtastic.{titles,labels,hints,actions}.MODEL.ACTION.ATTRIBUTE@ - by model and action
458 2. @formtastic.{titles,labels,hints,actions}.MODEL.ATTRIBUTE@ - by model
459 3. @formtastic.{titles,labels,hints,actions}.ATTRIBUTE@ - global default
94ce3ec @grimen Documentation for the new I18n features for labels/hints.
grimen authored
460
461 ...which means that you can define translations like this:
462
463 <pre>
464 en:
465 formtastic:
466 labels:
467 title: "Title" # Default global value
468 article:
469 body: "Article content"
470 post:
471 new:
472 title: "Choose a title..."
473 body: "Write something..."
474 edit:
475 title: "Edit title"
476 body: "Edit body"
477 </pre>
478
4aca8cd @grimen New I18n-features:
grimen authored
479 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
480
71ef99f @justinfrench nuked the configuration copy/paste from the README, linked to the gen…
authored
481
c4ebcef * added semantic_errors method with specs
Wojciech Wnętrzak authored
482 h2. Semantic errors
483
484 You can show errors on base (by default) and any other attribute just passing it name to semantic_errors method:
485
486 <pre>
487 <% semantic_form_for @post do |form| %>
488 <%= form.semantic_errors :state %>
489 <% end %>
490 </pre>
491
492
94ce3ec @grimen Documentation for the new I18n features for labels/hints.
grimen authored
493 h2. ValidationReflection plugin
494
49a18a5 @grimen README-update: I18n instructions are better structured, and easier to…
grimen authored
495 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
496
497
71ef99f @justinfrench nuked the configuration copy/paste from the README, linked to the gen…
authored
498 h2. Configuration
5a39443 @justinfrench bulking up the documentation and readme with the different inputs ava…
authored
499
3340c53 @justinfrench Remove Rails 2 stuff from README
authored
500 Run @rails generate formtastic:install@ 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
501
5a39443 @justinfrench bulking up the documentation and readme with the different inputs ava…
authored
502
fef3288 @grimen Added documentation for the form generator in README, and showing som…
grimen authored
503 h2. Form Generator
504
5f3d7a6 @justinfrench updated the generator docs in README to reflect both Rails 3 and 2
authored
505 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
506
5f3d7a6 @justinfrench updated the generator docs in README to reflect both Rails 3 and 2
authored
507 h3. Basic usage
508
fef3288 @grimen Added documentation for the form generator in README, and showing som…
grimen authored
509 <pre>
5f3d7a6 @justinfrench updated the generator docs in README to reflect both Rails 3 and 2
authored
510 $ rails generate formtastic:form ModelName
44e944c @justinfrench Changed formtastic:form generator to generate a partial by default (i…
authored
511 exists app/views/posts
512 create app/views/posts/_form.html.erb
5f3d7a6 @justinfrench updated the generator docs in README to reflect both Rails 3 and 2
authored
513 </pre>
fef3288 @grimen Added documentation for the form generator in README, and showing som…
grimen authored
514
44e944c @justinfrench Changed formtastic:form generator to generate a partial by default (i…
authored
515 The ERB code is saved to a partial file, but it will not overwrite existing files without a prompt.
5f3d7a6 @justinfrench updated the generator docs in README to reflect both Rails 3 and 2
authored
516
44e944c @justinfrench Changed formtastic:form generator to generate a partial by default (i…
authored
517 h3. Copying the ERB code to the clipboard instead with @--copy@
fef3288 @grimen Added documentation for the form generator in README, and showing som…
grimen authored
518
519 <pre>
44e944c @justinfrench Changed formtastic:form generator to generate a partial by default (i…
authored
520 $ rails generate formtastic:form Post --copy
fef3288 @grimen Added documentation for the form generator in README, and showing som…
grimen authored
521 </pre>
522
5f3d7a6 @justinfrench updated the generator docs in README to reflect both Rails 3 and 2
authored
523 h3. Specifying HAML instead of ERB with @--haml@
3f58f3a @justinfrench README update for --controller option form generator
authored
524
525 <pre>
f7e2c87 @rahult Changed formastic to formtastic in README
rahult authored
526 $ rails generate formtastic:form Post --haml
3f58f3a @justinfrench README update for --controller option form generator
authored
527 exists app/views/admin/posts
528 create app/views/admin/posts/_form.html.haml
529 </pre>
530
5f3d7a6 @justinfrench updated the generator docs in README to reflect both Rails 3 and 2
authored
531 h3. Specifying controller namespace with @--controller@
3f58f3a @justinfrench README update for --controller option form generator
authored
532
533 <pre>
f7e2c87 @rahult Changed formastic to formtastic in README
rahult authored
534 $ rails generate formtastic:form Post --partial --controller admin/posts
3f58f3a @justinfrench README update for --controller option form generator
authored
535 exists app/views/admin/posts
536 create app/views/admin/posts/_form.html.erb
537 </pre>
538
fef3288 @grimen Added documentation for the form generator in README, and showing som…
grimen authored
539
ce7da5e @justinfrench added the builder config to the config template and quick documentati…
authored
540 h2. Custom Inputs
541
549ef7a @justinfrench Renamed all instances of Formtastic::SemanticFormBuilder to Formtasti…
authored
542 If you want to add your own input types to encapsulate your own logic or interface patterns, you can do so by subclassing Formtastic::FormBuilder and configuring Formtastic to use your custom builder class.
ce7da5e @justinfrench added the builder config to the config template and quick documentati…
authored
543
549ef7a @justinfrench Renamed all instances of Formtastic::SemanticFormBuilder to Formtasti…
authored
544 @Formtastic::Helpers::FormHelper.builder = MyCustomBuilder@
ce7da5e @justinfrench added the builder config to the config template and quick documentati…
authored
545
28bb57f @paneq Resolves http://github.com/justinfrench/formtastic/issues/#issue/409
paneq authored
546 Be aware that you should either set the options on custom builder or require it after setting options on formtastic default builder.
ce7da5e @justinfrench added the builder config to the config template and quick documentati…
authored
547
28bb57f @paneq Resolves http://github.com/justinfrench/formtastic/issues/#issue/409
paneq authored
548 <pre>
153f4e8 @justinfrench Merge branch 'master' of http://github.com/paneq/formtastic into pane…
authored
549 # OK
549ef7a @justinfrench Renamed all instances of Formtastic::SemanticFormBuilder to Formtasti…
authored
550 Formtastic::FormBuilder.i18n_lookups_by_default = true
153f4e8 @justinfrench Merge branch 'master' of http://github.com/paneq/formtastic into pane…
authored
551 require 'formtastic/my_custom_builder'
549ef7a @justinfrench Renamed all instances of Formtastic::SemanticFormBuilder to Formtasti…
authored
552 Formtastic::Helpers::FormHelper.builder = Formtastic::MyCustomBuilder
153f4e8 @justinfrench Merge branch 'master' of http://github.com/paneq/formtastic into pane…
authored
553
554 # OK
555 require 'formtastic/my_custom_builder'
549ef7a @justinfrench Renamed all instances of Formtastic::SemanticFormBuilder to Formtasti…
authored
556 Formtastic::Helpers::FormHelper.builder = Formtastic::MyCustomBuilder
153f4e8 @justinfrench Merge branch 'master' of http://github.com/paneq/formtastic into pane…
authored
557 Formtastic::MyCustomBuilder.i18n_lookups_by_default = true
558
559 # WRONG!
560 require 'formtastic/my_custom_builder'
549ef7a @justinfrench Renamed all instances of Formtastic::SemanticFormBuilder to Formtasti…
authored
561 Formtastic::FormBuilder.i18n_lookups_by_default = true
562 Formtastic::Helpers::FormHelper.builder = Formtastic::MyCustomBuilder
28bb57f @paneq Resolves http://github.com/justinfrench/formtastic/issues/#issue/409
paneq authored
563 </pre>
3f58f3a @justinfrench README update for --controller option form generator
authored
564
5f3d7a6 @justinfrench updated the generator docs in README to reflect both Rails 3 and 2
authored
565
2d2d813 @yabawock More intelligent way to html_escape labels and hints (GH-299)
yabawock authored
566 h2. Security
ce7da5e @justinfrench added the builder config to the config template and quick documentati…
authored
567
2d2d813 @yabawock More intelligent way to html_escape labels and hints (GH-299)
yabawock authored
568 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:
569
549ef7a @justinfrench Renamed all instances of Formtastic::SemanticFormBuilder to Formtasti…
authored
570 Formtastic::FormBuilder.escape_html_entities_in_hints_and_labels = false
3f58f3a @justinfrench README update for --controller option form generator
authored
571
572
9af5cc8 @justinfrench Big update and re-organization of the README:
authored
573 h2. Dependencies
dcf8beb Initial Commit
Justin French authored
574
9af5cc8 @justinfrench Big update and re-organization of the README:
authored
575 There are none, but...
dcf8beb Initial Commit
Justin French authored
576
e9f27cf @grimen The most tiny README-update ever. =)
grimen authored
577 * 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
578 * 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).
579 * "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
580
0b370ba @justinfrench Renamed input_field_set() to just inputs() and added a shorthand vers…
authored
581
2079c59 @justinfrench added a section about contributing to README
authored
582 h2. How to contribute
583
533c086 @justinfrench added a section to the README on getting a dev environment up and run…
authored
584 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 a pull request for your changes to be discussed and reviewed.
2079c59 @justinfrench added a section about contributing to README
authored
585
586 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.
587
588 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.
589
533c086 @justinfrench added a section to the README on getting a dev environment up and run…
authored
590 See below for installation of a development environment.
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
90282e3 @justinfrench added twitter account to the readme
authored
600 h2. Google Group, Twitter, etc
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
90282e3 @justinfrench added twitter account to the readme
authored
604 You can also "follow @formtastic on Twitter":http://twitter.com/formtastic for announcements, tutorials and awesome Formtastic links.
605
5af0311 @justinfrench updated the README to pimp the google group more
authored
606
ba3ce05 @justinfrench updated the README a little with contributors and some other busy work
authored
607 h2. Project Info
608
1fcc068 @grimen An effort to make the README somewhat more readable.
grimen authored
609 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
610
611
ebe4e51 @justinfrench updated the README to reflect the new gem versions and other compatib…
authored
612 Copyright (c) 2007-2010 Justin French, released under the MIT license.
Something went wrong with that request. Please try again.