From 3e7bd63ec5bd60d39145b480339c17b8a5c45273 Mon Sep 17 00:00:00 2001 From: Xavier Noria Date: Sun, 4 May 2008 23:29:35 +0200 Subject: revised some conventions in url_helper.rb --- actionpack/lib/action_view/helpers/url_helper.rb | 28 ++++++++++++------------ 1 file changed, 14 insertions(+), 14 deletions(-) diff --git a/actionpack/lib/action_view/helpers/url_helper.rb b/actionpack/lib/action_view/helpers/url_helper.rb index 6d27494213..375ebfcdc5 100644 --- a/actionpack/lib/action_view/helpers/url_helper.rb +++ b/actionpack/lib/action_view/helpers/url_helper.rb @@ -19,15 +19,15 @@ module ActionView # need an unescaped url, pass :escape => false in the +options+. # # ==== Options - # * :anchor -- specifies the anchor name to be appended to the path. - # * :only_path -- if true, returns the relative URL (omitting the protocol, host name, and port) (true by default unless :host is specified) - # * :trailing_slash -- if true, adds a trailing slash, as in "/archive/2005/". Note that this + # * :anchor - Specifies the anchor name to be appended to the path. + # * :only_path - If true, returns the relative URL (omitting the protocol, host name, and port) (true by default unless :host is specified). + # * :trailing_slash - If true, adds a trailing slash, as in "/archive/2005/". Note that this # is currently not recommended since it breaks caching. - # * :host -- overrides the default (current) host if provided - # * :protocol -- overrides the default (current) protocol if provided - # * :user -- Inline HTTP authentication (only plucked out if :password is also present) - # * :password -- Inline HTTP authentication (only plucked out if :user is also present) - # * :escape -- Determines whether the returned URL will be HTML escaped or not (true by default) + # * :host - Overrides the default (current) host if provided. + # * :protocol - Overrides the default (current) protocol if provided. + # * :user - Inline HTTP authentication (only plucked out if :password is also present). + # * :password - Inline HTTP authentication (only plucked out if :user is also present). + # * :escape - Determines whether the returned URL will be HTML escaped or not (true by default). # # ==== Relying on named routes # @@ -91,14 +91,14 @@ module ActionView # a name, the link itself will become the name. # # ==== Options - # * :confirm => 'question?' -- This will add a JavaScript confirm + # * :confirm => 'question?' - This will add a JavaScript confirm # prompt with the question specified. If the user accepts, the link is # processed normally, otherwise no action is taken. - # * :popup => true || array of window options -- This will force the + # * :popup => true || array of window options - This will force the # link to open in a popup window. By passing true, a default browser window # will be opened with the URL. You can also specify an array of options # that are passed-thru to JavaScripts window.open method. - # * :method => symbol of HTTP verb -- This modifier will dynamically + # * :method => symbol of HTTP verb - This modifier will dynamically # create an HTML form and immediately submit the form for processing using # the HTTP verb specified. Useful for having links perform a POST operation # in dangerous actions like deleting a record (which search bots can follow @@ -178,9 +178,9 @@ module ActionView # The +options+ hash accepts the same options at url_for. # # There are a few special +html_options+: - # * :method -- specifies the anchor name to be appended to the path. - # * :disabled -- specifies the anchor name to be appended to the path. - # * :confirm -- This will add a JavaScript confirm + # * :method - Specifies the anchor name to be appended to the path. + # * :disabled - Specifies the anchor name to be appended to the path. + # * :confirm - This will add a JavaScript confirm # prompt with the question specified. If the user accepts, the link is # processed normally, otherwise no action is taken. # -- cgit v1.2.3