You are here

Home » API reference » Responsive Favicons 7

README.txt in Responsive Favicons 7

Same filename and directory in other branches
  1. 8 README.txt
Responsive Favicons
-------------------

This module adds the favicons generated by http://realfavicongenerator.net/ to
your site. The responsive name comes from the fact that many devices are
catered for including iPhone, Android, iPad, other tablets and dektops.


Requirements
------------

* Drupal 7
* Favicon files generated by http://realfavicongenerator.net/
* HTML code generated by http://realfavicongenerator.net/


Installation and configuration
------------------------------

1. Generate the favicons and the HTML code on http://realfavicongenerator.net/

   You will need a 260x260px PNG file with appropriate transparency already
   created. Smaller files can be uploaded but these will produce inferior
   results.

   When asked for the "path" in realfavicongenerator.net select "I will place
   favicon files (favicon.ico, apple-touch-icon.png, etc.) at the root of my web
   site. Recommended." - this is because Drupal will rewrite the URLs based on
   your configuration of the module for you.

2. Install Responsive Favicons module as you install a contributed Drupal module.
   See https://drupal.org/documentation/install/modules/themes/modules-7

3. Go to /admin/config/user-interface/responsive_favicons to configure the
   module.

   Here you will need to paste in the HTML provided by realfavicongenerator.net
   and upload the zip file they provided you with.

4. [optional] You can also allow this module to take over common paths like:

   * favicon.ico
   * apple-touch-icon.png
   * apple-touch-icon-precomposed.png
   * browserconfig.xml

   In order to do this you need to:

   1) Comment out the line

   #RewriteCond %{REQUEST_URI} !=/favicon.ico

   in the Drupal root .htaccess file.

   2) Alter the variable 404_fast_paths_exclude in your settings.php file:

   $conf['404_fast_paths_exclude'] = '/\/(?:styles)\/|favicon\.ico|apple-touch-icon(?:-precomposed)?\.png|browserconfig\.xml/';

You site will now output the required metadata for the favicons to work. You can
always check the status report page to find out if your site has been correctly
configured.

Note. The 'favicon' module duplicates some of the functionality of responsive
favicons, so it is preferred that you only install one of the two modules.


Further reading
---------------

This entire module was spawned from a blog post on the topic located at
http://www.pixelite.co.nz/article/adding-apple-android-favicons-drupal

File

README.txt
View source 
  1. Responsive Favicons

  2. -------------------

  3. 

  4. This module adds the favicons generated by http://realfavicongenerator.net/ to

  5. your site. The responsive name comes from the fact that many devices are

  6. catered for including iPhone, Android, iPad, other tablets and dektops.

  7. 

  8. 

  9. Requirements

  10. ------------

  11. 

  12. * Drupal 7

  13. * Favicon files generated by http://realfavicongenerator.net/

  14. * HTML code generated by http://realfavicongenerator.net/

  15. 

  16. 

  17. Installation and configuration

  18. ------------------------------

  19. 

  20. 1. Generate the favicons and the HTML code on http://realfavicongenerator.net/

  21. 

  22.    You will need a 260x260px PNG file with appropriate transparency already

  23.    created. Smaller files can be uploaded but these will produce inferior

  24.    results.

  25. 

  26.    When asked for the "path" in realfavicongenerator.net select "I will place

  27.    favicon files (favicon.ico, apple-touch-icon.png, etc.) at the root of my web

  28.    site. Recommended." - this is because Drupal will rewrite the URLs based on

  29.    your configuration of the module for you.

  30. 

  31. 2. Install Responsive Favicons module as you install a contributed Drupal module.

  32.    See https://drupal.org/documentation/install/modules/themes/modules-7

  33. 

  34. 3. Go to /admin/config/user-interface/responsive_favicons to configure the

  35.    module.

  36. 

  37.    Here you will need to paste in the HTML provided by realfavicongenerator.net

  38.    and upload the zip file they provided you with.

  39. 

  40. 4. [optional] You can also allow this module to take over common paths like:

  41. 

  42.    * favicon.ico

  43.    * apple-touch-icon.png

  44.    * apple-touch-icon-precomposed.png

  45.    * browserconfig.xml

  46. 

  47.    In order to do this you need to:

  48. 

  49.    1) Comment out the line

  50. 

  51.    #RewriteCond %{REQUEST_URI} !=/favicon.ico

  52. 

  53.    in the Drupal root .htaccess file.

  54. 

  55.    2) Alter the variable 404_fast_paths_exclude in your settings.php file:

  56. 

  57.    $conf['404_fast_paths_exclude'] = '/\/(?:styles)\/|favicon\.ico|apple-touch-icon(?:-precomposed)?\.png|browserconfig\.xml/';

  58. 

  59. You site will now output the required metadata for the favicons to work. You can

  60. always check the status report page to find out if your site has been correctly

  61. configured.

  62. 

  63. Note. The 'favicon' module duplicates some of the functionality of responsive

  64. favicons, so it is preferred that you only install one of the two modules.

  65. 

  66. 

  67. Further reading

  68. ---------------

  69. 

  70. This entire module was spawned from a blog post on the topic located at

  71. http://www.pixelite.co.nz/article/adding-apple-android-favicons-drupal