Ticket #7921: actionview_base_docs.diff

actionpack/lib/action_view/base.rb

@@ -4 +4 @@
-  class ActionViewError < StandardError #:nodoc:
-  end
-
-
-
-
+
+
+
+
+
+
+
-  # 
-
+
+
+
+
+
+
+
+
-  # 
-
-
-
-
-
-
+
+
-  #   <% end %>
-  #
-
-
+
+
+
-  #
-
+
+
+
-  #
-
+
+
-  #
-
+
+
-  #
-
+
+
+
+
-  #
-
-
+
+
+
-  #
-
-
-
+
-  #
-
-
+
+
+
-  #
-
-
-
-
-
-
-
-
-
-
-
+
-  # 
-
+
+
+
-  #
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
-  # Here are some basic examples:
-  #
-  #   xml.em("emphasized")                              # => <em>emphasized</em>
@@ -86 +70 @@
-  #   xml.a("A Link", "href"=>"http://onestepback.org") # => <a href="http://onestepback.org">A Link</a>
-  #   xml.target("name"=>"compile", "option"=>"fast")   # => <target option="fast" name="compile"\>
-  #                                                     # NOTE: order of attributes is not specified.
+  #   xml.tag!("dc:creator", "My Name")                 # => <dc:creator>My Name</dc:creator>
-  # 
-
+
+
+
+
-  #
-  #   xml.div {
-  #     xml.h1(@person.name)
@@ -101 +89 @@
-  #     <p>A product of Danish Design during the Winter of '79...</p>
-  #   </div>
-  #
-
+
+
-  #
-  #   xml.rss("version" => "2.0", "xmlns:dc" => "http://purl.org/dc/elements/1.1/") do
-  #     xml.channel do
@@ -125 +114 @@
-  #     end
-  #   end
-  #
-More builder documentation can be found at http://builder.rubyforge.org.
+This script generates something like the following:
-  #
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-  #
-
-
-
-
+
+
+
+
+
+
+
+
+
+
-  # 
-
+
+
+
-  #
-  # When an .rjs action is called with +link_to_remote+, the generated JavaScript is automatically evaluated.  Example:
-  #
-  #   link_to_remote :url => {:action => 'delete'}
-  #
-+delete.rjs+
+<tt>delete.rjs</tt>
-  #
-  #   page.replace_html  'sidebar', :partial => 'sidebar'
-  #   page.remove        "person-#{@person.id}"
-  #   page.visual_effect :highlight, 'user-list' 
-  #
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-  # 
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-  class Base
-    include ERB::Util
-
@@ -228 +382 @@
-    # takes the contents of the template to render as well as the Hash of
-    # local assigns available to the template. The #render method ought to
-    # return the rendered template as a string.
+    #
+    # ==== Example
+    #
+    # Adding the <tt>PDF::Writer</tt> library by Austin Ziegler as a template
+    # handler is as simple as requiring the library, calling <tt>register_template_handler</tt>,...
+    #
+    #   require 'pdf_render'
+    #   ActionView::Base.register_template_handler 'rpdf', ActionView::PDFRender 
+    #
+    # ...and then creating a handler as shown here[http://wiki.rubyonrails.org/rails/pages/HowtoGeneratePDFs].
-    def self.register_template_handler(extension, klass)
-      @@template_handlers[extension] = klass
-    end
@@ -241 +405 @@
-    end
-
-    # Renders the template present at <tt>template_path</tt>. If <tt>use_full_path</tt> is set to true, 
-view_paths
+<tt>view_paths</tt>
-    # is made available as local variables.
+    #
+    # ==== Examples
+    #   # Renders the view header.erb in the shared directory of app/views
+    #   render_file "shared/header"
+    #
+    #   # The false says the path to the template is absolute
+    #   render_file "/var/www/rails_app/app/views/shared/header", false
+    #
+    #   # Renders a template, passing in two local variables: user and date
+    #   render_file "application/top", true, { 'user' => 'dhh@rubyonrails.com', 'date' => 'March 28th, 2007'}
-    def render_file(template_path, use_full_path = true, local_assigns = {}) #:nodoc:
-      @first_render ||= template_path
-      template_path_without_extension, template_extension = path_and_extension(template_path)
@@ -272 +446 @@
-    end
-    
-    # Renders the template present at <tt>template_path</tt> (relative to the view_paths array). 
-
-
+
+
+
+
+
+
+
+
+
+
-      if options.is_a?(String)
-        render_file(options, true, old_local_assigns)
-      elsif options == :update
@@ -307 +489 @@
-    # Render the provided template with the given local assigns. If the template has not been rendered with the provided
-    # local assigns yet, or if the template has been updated on disk, then the template will be compiled to a method.
-    #
-
-    # Either, but not both, of template and file_path may be nil. If file_path is given, the template
-    # will only be read if it has to be compiled.
-    #