diff options
| author | Alvaro Pereyra <alvaro@xendacentral.com> | 2012-12-01 12:49:27 -0500 |
|---|---|---|
| committer | Alvaro Pereyra <alvaro@xendacentral.com> | 2012-12-01 12:53:38 -0500 |
| commit | e1c0aa4d4ca29ca72d61e7d3f5e11af7c8250c03 (patch) | |
| tree | ef52eb5141350fdb973a30418ca2ffc6034c9a9b /actionpack | |
| parent | a1ffc4a31b38830ce72e9e2502db3c4b6b83d3f0 (diff) | |
| download | rails-e1c0aa4d4ca29ca72d61e7d3f5e11af7c8250c03.tar.gz rails-e1c0aa4d4ca29ca72d61e7d3f5e11af7c8250c03.tar.bz2 rails-e1c0aa4d4ca29ca72d61e7d3f5e11af7c8250c03.zip | |
Improves documentation on favicon_link_tag
Diffstat (limited to 'actionpack')
| -rw-r--r-- | actionpack/lib/action_view/helpers/asset_tag_helper.rb | 30 |
1 files changed, 16 insertions, 14 deletions
diff --git a/actionpack/lib/action_view/helpers/asset_tag_helper.rb b/actionpack/lib/action_view/helpers/asset_tag_helper.rb index 84422ea471..47a4b6cb61 100644 --- a/actionpack/lib/action_view/helpers/asset_tag_helper.rb +++ b/actionpack/lib/action_view/helpers/asset_tag_helper.rb @@ -68,6 +68,9 @@ module ActionView # to "screen", so you must explicitely set it to "all" for the stylesheet(s) to # apply to all media types. # + # When the Asset Pipeline is enabled, the helper is usually employed to load the manifest + # file to be processed by it. + # # stylesheet_link_tag "style" # # => <link href="/assets/style.css" media="screen" rel="stylesheet" /> # @@ -140,27 +143,26 @@ module ActionView ) end - # <%= favicon_link_tag %> - # - # generates - # - # <link href="/assets/favicon.ico" rel="shortcut icon" type="image/vnd.microsoft.icon" /> - # - # You may specify a different file in the first argument: + # Returns a link loading a favicon file. You may specify a different file + # in the first argument. The helper accepts an additional options hash where + # you can override "rel" and "type". # - # <%= favicon_link_tag '/myicon.ico' %> - # - # That's passed to +path_to_image+ as is, so it gives + # ==== Options + # * <tt>:rel</tt> - Specify the relation of this link, defaults to 'shortcut icon' + # * <tt>:type</tt> - Override the auto-generated mime type, defaults to 'image/vnd.microsoft.icon' # - # <link href="/myicon.ico" rel="shortcut icon" type="image/vnd.microsoft.icon" /> + # ==== Examples # - # The helper accepts an additional options hash where you can override "rel" and "type". + # favicon_link_tag '/myicon.ico' + # # => <link href="/assets/favicon.ico" rel="shortcut icon" type="image/vnd.microsoft.icon" /> # - # For example, Mobile Safari looks for a different LINK tag, pointing to an image that + # Mobile Safari looks for a different <link> tag, pointing to an image that # will be used if you add the page to the home screen of an iPod Touch, iPhone, or iPad. # The following call would generate such a tag: # - # <%= favicon_link_tag 'mb-icon.png', rel: 'apple-touch-icon', type: 'image/png' %> + # favicon_link_tag '/mb-icon.png', rel: 'apple-touch-icon', type: 'image/png' + # # => <link href="/assets/mb-icon.png" rel="apple-touch-icon" type="image/png" /> + # def favicon_link_tag(source='favicon.ico', options={}) tag('link', { :rel => 'shortcut icon', |