You are here

README.txt in Browser Class 7

Same filename and directory in other branches
  1. 6 README.txt
CONTENTS OF THIS FILE
---------------------

 * Introduction
 * Features
 * Requirements
 * Installation
 * Configuration
 * API
 * Maintainers

INTRODUCTION
------------

This small module helps theme-developers to deal with cross-browser
compatibility. It makes easier to handle different types of non-widespread
browsers just as much as it helps with using different versions of Internet
Explorer.

 * For a full description of the module, visit the project page:
   https://www.drupal.org/project/browserclass

 * To submit bug reports and feature suggestions, or to track changes:
   https://www.drupal.org/project/issues/browserclass

FEATURES
--------

The module extends the $body_classes variable in page.tpl.php based on the
enduser's browser, with the following:
 * ie
 * ie[version]
 * opera
 * safari
 * chrome
 * netscape
 * ff
 * konqueror
 * dillo
 * chimera
 * beonex
 * aweb
 * amaya
 * icab
 * lynx
 * galeon
 * operamini

and with the following platforms:
 * win
 * ipad
 * ipod
 * iphone
 * mac
 * android
 * linux
 * nokia
 * blackberry
 * freebsd
 * openbsd
 * netbsd

The module checks if the device is mobile and adds "mobile" or "desktop" class.

The module also makes a $browser_classes variable available in page.tpl.php,
which stores the data in an array, this way the developer can make use of it as
needed, if he does not wish to use the $body_classes variable.

REQUIREMENTS
------------

None.

INSTALLATION
------------

 * Install as you would normally install a contributed Drupal module. Visit:
   https://www.drupal.org/documentation/install/modules-themes/modules-7
   for further information.

CONFIGURATION
-------------

The module has a settings page (admin/config/user-interface/browserclass), where
the administrator can choose between these options:
 * always add the class with JavaScript
 * only use JavaScript if page cache is enabled
This page is available only users with "administer browser class" permission.

API
---

Developers can add their own classes with hook_browserclass_classes(). More
information in browserclass_hook.php file.


MAINTAINERS
-----------

Current maintainers:
 * Norman Kämper-Leymann - https://www.drupal.org/u/leymannx

Former maintainers:
 * Kálmán Hosszu – https://www.drupal.org/u/kalman.hosszu
 * Dániel Kalmár - https://www.drupal.org/u/kdani

This project has originally been developed by:
 * Kálmán Hosszu – https://www.drupal.org/u/kalman.hosszu

File

README.txt
View source
  1. CONTENTS OF THIS FILE
  2. ---------------------
  3. * Introduction
  4. * Features
  5. * Requirements
  6. * Installation
  7. * Configuration
  8. * API
  9. * Maintainers
  10. INTRODUCTION
  11. ------------
  12. This small module helps theme-developers to deal with cross-browser
  13. compatibility. It makes easier to handle different types of non-widespread
  14. browsers just as much as it helps with using different versions of Internet
  15. Explorer.
  16. * For a full description of the module, visit the project page:
  17. https://www.drupal.org/project/browserclass
  18. * To submit bug reports and feature suggestions, or to track changes:
  19. https://www.drupal.org/project/issues/browserclass
  20. FEATURES
  21. --------
  22. The module extends the $body_classes variable in page.tpl.php based on the
  23. enduser's browser, with the following:
  24. * ie
  25. * ie[version]
  26. * opera
  27. * safari
  28. * chrome
  29. * netscape
  30. * ff
  31. * konqueror
  32. * dillo
  33. * chimera
  34. * beonex
  35. * aweb
  36. * amaya
  37. * icab
  38. * lynx
  39. * galeon
  40. * operamini
  41. and with the following platforms:
  42. * win
  43. * ipad
  44. * ipod
  45. * iphone
  46. * mac
  47. * android
  48. * linux
  49. * nokia
  50. * blackberry
  51. * freebsd
  52. * openbsd
  53. * netbsd
  54. The module checks if the device is mobile and adds "mobile" or "desktop" class.
  55. The module also makes a $browser_classes variable available in page.tpl.php,
  56. which stores the data in an array, this way the developer can make use of it as
  57. needed, if he does not wish to use the $body_classes variable.
  58. REQUIREMENTS
  59. ------------
  60. None.
  61. INSTALLATION
  62. ------------
  63. * Install as you would normally install a contributed Drupal module. Visit:
  64. https://www.drupal.org/documentation/install/modules-themes/modules-7
  65. for further information.
  66. CONFIGURATION
  67. -------------
  68. The module has a settings page (admin/config/user-interface/browserclass), where
  69. the administrator can choose between these options:
  70. * always add the class with JavaScript
  71. * only use JavaScript if page cache is enabled
  72. This page is available only users with "administer browser class" permission.
  73. API
  74. ---
  75. Developers can add their own classes with hook_browserclass_classes(). More
  76. information in browserclass_hook.php file.
  77. MAINTAINERS
  78. -----------
  79. Current maintainers:
  80. * Norman Kämper-Leymann - https://www.drupal.org/u/leymannx
  81. Former maintainers:
  82. * Kálmán Hosszu – https://www.drupal.org/u/kalman.hosszu
  83. * Dániel Kalmár - https://www.drupal.org/u/kdani
  84. This project has originally been developed by:
  85. * Kálmán Hosszu – https://www.drupal.org/u/kalman.hosszu