mirror of
https://github.com/github/rails.git
synced 2026-01-09 14:48:08 -05:00
doc fixes
This commit is contained in:
@@ -8,12 +8,12 @@ into three layers, each with a specific responsibility.
|
||||
|
||||
The View layer is composed of "templates" that are responsible for providing
|
||||
appropriate representations of your application's resources. Templates
|
||||
can come in a variety of formats, but most view templates are HTML with embedded Ruby
|
||||
can come in a variety of formats, but most view templates are \HTML with embedded Ruby
|
||||
code (.erb files).
|
||||
|
||||
The Model layer represents your domain model (such as Account, Product, Person, Post)
|
||||
and encapsulates the business logic that is specific to your application. In Rails,
|
||||
database-backed model classes are derived from ActiveRecord::Base. ActiveRecord allows
|
||||
database-backed model classes are derived from ActiveRecord::Base. Active Record allows
|
||||
you to present the data from database rows as objects and embellish these data objects
|
||||
with business logic methods. Although most Rails models are backed by a database, models
|
||||
can also be ordinary Ruby classes, or Ruby classes that implement a set of interfaces as
|
||||
@@ -21,7 +21,7 @@ provided by the ActiveModel module. You can read more about Active Record in its
|
||||
{README}[link:/rails/rails/blob/master/activerecord/README.rdoc].
|
||||
|
||||
The Controller layer is responsible for handling incoming HTTP requests and providing a
|
||||
suitable response. Usually this means returning HTML, but Rails controllers can also
|
||||
suitable response. Usually this means returning \HTML, but Rails controllers can also
|
||||
generate XML, JSON, PDFs, mobile-specific views, and more. Controllers manipulate models
|
||||
and render view templates in order to generate the appropriate HTTP response.
|
||||
|
||||
|
||||
@@ -6,30 +6,30 @@ require 'active_support/core_ext/module/anonymous'
|
||||
require 'action_dispatch/http/mime_types'
|
||||
|
||||
module ActionController
|
||||
# Wraps parameters hash into nested hash. This will allow client to submit
|
||||
# POST request without having to specify a root element in it.
|
||||
# Wraps the parameters hash into a nested hash. This will allow clients to submit
|
||||
# POST requests without having to specify any root elements.
|
||||
#
|
||||
# This functionality is enabled in +config/initializers/wrap_parameters.rb+
|
||||
# and can be customized. If you are upgrading to Rails 3.1, this file will
|
||||
# and can be customized. If you are upgrading to \Rails 3.1, this file will
|
||||
# need to be created for the functionality to be enabled.
|
||||
#
|
||||
# You could also turn it on per controller by setting the format array to
|
||||
# non-empty array:
|
||||
# a non-empty array:
|
||||
#
|
||||
# class UsersController < ApplicationController
|
||||
# wrap_parameters :format => [:json, :xml]
|
||||
# end
|
||||
#
|
||||
# If you enable +ParamsWrapper+ for +:json+ format. Instead of having to
|
||||
# If you enable +ParamsWrapper+ for +:json+ format, instead of having to
|
||||
# send JSON parameters like this:
|
||||
#
|
||||
# {"user": {"name": "Konata"}}
|
||||
#
|
||||
# You can now just send a parameters like this:
|
||||
# You can send parameters like this:
|
||||
#
|
||||
# {"name": "Konata"}
|
||||
#
|
||||
# And it will be wrapped into a nested hash with the key name matching
|
||||
# And it will be wrapped into a nested hash with the key name matching the
|
||||
# controller's name. For example, if you're posting to +UsersController+,
|
||||
# your new +params+ hash will look like this:
|
||||
#
|
||||
@@ -81,7 +81,7 @@ module ActionController
|
||||
#
|
||||
# ==== Examples
|
||||
# wrap_parameters :format => :xml
|
||||
# # enables the parmeter wrapper for XML format
|
||||
# # enables the parameter wrapper for XML format
|
||||
#
|
||||
# wrap_parameters :person
|
||||
# # wraps parameters into +params[:person]+ hash
|
||||
|
||||
@@ -131,10 +131,14 @@ module ActionDispatch
|
||||
#
|
||||
# Examples:
|
||||
#
|
||||
# url_for :controller => 'tasks', :action => 'testing', :host => 'somehost.org', :port => '8080' # => 'http://somehost.org:8080/tasks/testing'
|
||||
# url_for :controller => 'tasks', :action => 'testing', :host => 'somehost.org', :anchor => 'ok', :only_path => true # => '/tasks/testing#ok'
|
||||
# url_for :controller => 'tasks', :action => 'testing', :trailing_slash => true # => 'http://somehost.org/tasks/testing/'
|
||||
# url_for :controller => 'tasks', :action => 'testing', :host => 'somehost.org', :number => '33' # => 'http://somehost.org/tasks/testing?number=33'
|
||||
# url_for :controller => 'tasks', :action => 'testing', :host => 'somehost.org', :port => '8080'
|
||||
# # => 'http://somehost.org:8080/tasks/testing'
|
||||
# url_for :controller => 'tasks', :action => 'testing', :host => 'somehost.org', :anchor => 'ok', :only_path => true
|
||||
# # => '/tasks/testing#ok'
|
||||
# url_for :controller => 'tasks', :action => 'testing', :trailing_slash => true
|
||||
# # => 'http://somehost.org/tasks/testing/'
|
||||
# url_for :controller => 'tasks', :action => 'testing', :host => 'somehost.org', :number => '33'
|
||||
# # => 'http://somehost.org/tasks/testing?number=33'
|
||||
def url_for(options = nil)
|
||||
case options
|
||||
when String
|
||||
|
||||
Reference in New Issue
Block a user