aboutsummaryrefslogtreecommitdiffstats
path: root/actionpack
diff options
context:
space:
mode:
authorDavid Heinemeier Hansson <david@loudthinking.com>2004-12-29 13:36:27 +0000
committerDavid Heinemeier Hansson <david@loudthinking.com>2004-12-29 13:36:27 +0000
commit1b0da48fe98abc67b56bc76f2af59a90198b21cc (patch)
tree29c13bf9561a871cd213fc6be7d2b7835767dcb9 /actionpack
parent60de8c110829cb7f2df1d312ad2898633e896c24 (diff)
downloadrails-1b0da48fe98abc67b56bc76f2af59a90198b21cc.tar.gz
rails-1b0da48fe98abc67b56bc76f2af59a90198b21cc.tar.bz2
rails-1b0da48fe98abc67b56bc76f2af59a90198b21cc.zip
Added documentation for using render_with_layout
git-svn-id: http://svn-commit.rubyonrails.org/rails/trunk@272 5ecf4fe2-1ee6-0310-87b1-e25e094e27de
Diffstat (limited to 'actionpack')
-rw-r--r--actionpack/lib/action_controller/layout.rb16
1 files changed, 16 insertions, 0 deletions
diff --git a/actionpack/lib/action_controller/layout.rb b/actionpack/lib/action_controller/layout.rb
index 6785967208..95b50a2eec 100644
--- a/actionpack/lib/action_controller/layout.rb
+++ b/actionpack/lib/action_controller/layout.rb
@@ -115,6 +115,22 @@ module ActionController #:nodoc:
# a given action without a layout. Just use the method <tt>render_without_layout</tt>, which works just like Base.render --
# it just doesn't apply any layouts.
#
+ # == Using a different layout in the action render call
+ #
+ # If most of your actions use the same layout, it makes perfect sense to define a controller-wide layout as described above.
+ # Some times you'll have exceptions, though, where one action wants to use a different layout than the rest of the controller.
+ # This is possible using <tt>render_with_layout</tt> method. It's just a bit more manual work as you'll have to supply fully
+ # qualified template and layout names as this example shows:
+ #
+ # class WeblogController < ActionController::Base
+ # def help
+ # render_with_layout "help/index", "200", "layouts/help"
+ # end
+ # end
+ #
+ # As you can see, you pass the template as the first parameter, the status code as the second ("200" is OK), and the layout
+ # as the third.
+ #
# == Automatic layout assignment
#
# If there is a template in <tt>app/views/layouts/</tt> with the same name as the current controller then it will be automatically