GitHub Sale: sign up for any paid plan this week and pay nothing until January 1, 2009!  [ hide ]

public
Fork of lifo/doc-rails
Description: Repository for improving Rails documentation
Homepage: http://www.rubyonrails.org
Clone URL: git://github.com/zmalltalker/doc-rails.git
revised markup in AC::UrlWriter docs
Xavier Noria (author)
Thu Apr 10 14:18:01 -0700 2008
commit  a5c3f7e8b7a22d34d614cd241d40818519983944
tree    e971a20b9ce7153a51e13b62cd198f420be14297
parent  d9e2861e47d60ee50fcba1587f202898ab83dab2
...
15
16
17
18
19
 
 
20
21
22
...
29
30
31
32
 
33
34
35
 
 
 
36
37
38
 
 
39
40
41
 
 
42
43
44
...
15
16
17
 
 
18
19
20
21
22
...
29
30
31
 
32
33
 
 
34
35
36
37
38
 
39
40
41
42
 
43
44
45
46
47
0
@@ -15,8 +15,8 @@ module ActionController
0
   # In addition to providing +url_for+, named routes are also accessible after
0
   # including UrlWriter.
0
   module UrlWriter
0
- # The default options for urls written by this writer. Typically a :host pair
0
- # is provided.
0
+ # The default options for urls written by this writer. Typically a <tt>:host</tt>
0
+ # pair is provided.
0
     mattr_accessor :default_url_options
0
     self.default_url_options = {}
0
 
0
@@ -29,16 +29,19 @@ module ActionController
0
     # Generate a url based on the options provided, default_url_options and the
0
     # routes defined in routes.rb. The following options are supported:
0
     #
0
- # * <tt>:only_path</tt> If true, the relative url is returned. Defaults to false.
0
+ # * <tt>:only_path</tt> If true, the relative url is returned. Defaults to +false+.
0
     # * <tt>:protocol</tt> The protocol to connect to. Defaults to 'http'.
0
- # * <tt>:host</tt> Specifies the host the link should be targetted at. If <tt>:only_path</tt> is false, this option must be
0
- # provided either explicitly, or via default_url_options.
0
+ # * <tt>:host</tt> Specifies the host the link should be targetted at.
0
+ # If <tt>:only_path</tt> is false, this option must be
0
+ # provided either explicitly, or via +default_url_options+.
0
     # * <tt>:port</tt> Optionally specify the port to connect to.
0
     # * <tt>:anchor</tt> An anchor name to be appended to the path.
0
- # * <tt>:skip_relative_url_root</tt> If true, the url is not constructed using the relative_url_root set in <tt>ActionController::AbstractRequest.relative_url_root</tt>.
0
+ # * <tt>:skip_relative_url_root</tt> If true, the url is not constructed using the
0
+ # +relative_url_root+ set in ActionController::AbstractRequest.relative_url_root.
0
     # * <tt>:trailing_slash</tt> If true, adds a trailing slash, as in "/archive/2009/"
0
     #
0
- # Any other key(:controller, :action, etc...) given to <tt>url_for</tt> is forwarded to the Routes module.
0
+ # Any other key (<tt>:controller</tt>, <tt>:action</tt>, etc.) given to
0
+ # +url_for+ is forwarded to the Routes module.
0
     #
0
     # Examples:
0
     #

Comments

    No one has commented yet.