1
0
Fork 0
mirror of https://github.com/rails/rails.git synced 2022-11-09 12:12:34 -05:00

Add :formats to options list of render documentation.

This commit is contained in:
Diogo Benicá 2015-01-21 23:52:44 -02:00
parent e8460f8bbe
commit 8b18449c27

View file

@ -316,12 +316,13 @@ NOTE: Unless overridden, your response returned from this render option will be
#### Options for `render` #### Options for `render`
Calls to the `render` method generally accept four options: Calls to the `render` method generally accept five options:
* `:content_type` * `:content_type`
* `:layout` * `:layout`
* `:location` * `:location`
* `:status` * `:status`
* `:formats`
##### The `:content_type` Option ##### The `:content_type` Option
@ -430,6 +431,15 @@ Rails understands both numeric status codes and the corresponding symbols shown
NOTE: If you try to render content along with a non-content status code NOTE: If you try to render content along with a non-content status code
(100-199, 204, 205 or 304), it will be dropped from the response. (100-199, 204, 205 or 304), it will be dropped from the response.
##### The `:formats` Option
Rails uses the format specified in request (or `:html` by default). You can change this adding the `:formats` option with a symbol or an array:
```ruby
render formats: :xml
render formats: [:json, :xml]
```
#### Finding Layouts #### Finding Layouts
To find the current layout, Rails first looks for a file in `app/views/layouts` with the same base name as the controller. For example, rendering actions from the `PhotosController` class will use `app/views/layouts/photos.html.erb` (or `app/views/layouts/photos.builder`). If there is no such controller-specific layout, Rails will use `app/views/layouts/application.html.erb` or `app/views/layouts/application.builder`. If there is no `.erb` layout, Rails will use a `.builder` layout if one exists. Rails also provides several ways to more precisely assign specific layouts to individual controllers and actions. To find the current layout, Rails first looks for a file in `app/views/layouts` with the same base name as the controller. For example, rendering actions from the `PhotosController` class will use `app/views/layouts/photos.html.erb` (or `app/views/layouts/photos.builder`). If there is no such controller-specific layout, Rails will use `app/views/layouts/application.html.erb` or `app/views/layouts/application.builder`. If there is no `.erb` layout, Rails will use a `.builder` layout if one exists. Rails also provides several ways to more precisely assign specific layouts to individual controllers and actions.