You are here

README.txt in Mobile Switch 6

Same filename and directory in other branches
  1. 7.2 README.txt
  2. 7 README.txt
Mobile Switch module

Simple automatic theme switch for mobile devices, detected by browscap.

DEPENDENCIES
------------

  Drupal 6.
  The Browscap module from drupal.org/project/browscap

INSTALL
-------

  1) Copy the Mobile Switch folder to the modules folder in your installation.
     Usually this is sites/all/modules.

  2) In your Drupal site, enable the module under:
     Administer -> Site building -> Modules.
     /admin/build/modules

ADMINISTER
----------

  1) Important for first time usage

     of Mobile Switch and Browscap module.

     As first make sure that fetched the Browscap module browser data.

     Administer the Browscap module under Administer -> Site configuration
     admin/settings/browscap

     Check the line 'Current browscap data version'.

     If you see 'Never fetched' on this line it is necessary to fetch
     browser data.
     To fetch browser data use simply the 'Refresh browscap data' button.

  2) Administer themes under Administer -> Site building -> Themes.
     /admin/build/themes

     - Enable your preffered mobile theme (Not set as default).
     - Use as default theme a 'not mobile theme'.

  3) Administer the Mobile Switch module under Administer -> Site configuration
     /admin/settings/mobile-switch

     - Choose your mobile theme.

     If a theme used as mobile theme, their displayed informations on the
     Appearance administration page are altered for better visualisation.

     A Mobile Switch mobile theme is not available on administration pages and
     in the maintenance mode.

     Mobile theme on administration pages

       Configure the 'Administration usage' in the module 'Basic settings' to
       enable the use of the mobile theme on administration pages.

     Mobile device prevention

       It is possible to bypass the automatic switching to the mobile theme for
       mobile devices.
       This is useful, for example, to exclude large tablets for the theme
       switching.

       To use this,

       administer the 'Advanced' settings under:
       Administer -> Site configuration -> Mobile Switch
       /admin/settings/mobile-switch/advanced

       enable the 'Use preventing' option and configure the user agent strings
       for such devices.

       To test this feature, without a real mobile device, it is a good
       solution to use the desktop browser with a user agent switcher extension
       and custom defined user agents.

     For the development of a web site

       Administer the 'Development' settings under:
       Administer -> Site configuration -> Mobile Switch
       /admin/settings/mobile-switch/development

       a) Enable/disable the 'Developer modus'.

          If a desktop mobile emulator not detected from browscap it is possible
          to configure additional user agents.

       b) Enable/disable desktop browser usage of the mobile theme.

DEVELOPMENT
-----------

  Development with Mobile Switch.

  The module provides three system variables:

  1. mobile_switch_ismobiledevice
  2. mobile_switch_ismobiletheme
  3. theme_mobile

  The value of the variables 1. and 2. is a boolean value.
  The value of the variable 3. is FALSE or the machine name of the used theme.

EXTERNAL RECOURCES
------------------

  Mobile Emulators & Simulators: The Ultimate Guide
  http://www.mobilexweb.com/emulators

File

README.txt
View source
  1. Mobile Switch module
  2. Simple automatic theme switch for mobile devices, detected by browscap.
  3. DEPENDENCIES
  4. ------------
  5. Drupal 6.
  6. The Browscap module from drupal.org/project/browscap
  7. INSTALL
  8. -------
  9. 1) Copy the Mobile Switch folder to the modules folder in your installation.
  10. Usually this is sites/all/modules.
  11. 2) In your Drupal site, enable the module under:
  12. Administer -> Site building -> Modules.
  13. /admin/build/modules
  14. ADMINISTER
  15. ----------
  16. 1) Important for first time usage
  17. of Mobile Switch and Browscap module.
  18. As first make sure that fetched the Browscap module browser data.
  19. Administer the Browscap module under Administer -> Site configuration
  20. admin/settings/browscap
  21. Check the line 'Current browscap data version'.
  22. If you see 'Never fetched' on this line it is necessary to fetch
  23. browser data.
  24. To fetch browser data use simply the 'Refresh browscap data' button.
  25. 2) Administer themes under Administer -> Site building -> Themes.
  26. /admin/build/themes
  27. - Enable your preffered mobile theme (Not set as default).
  28. - Use as default theme a 'not mobile theme'.
  29. 3) Administer the Mobile Switch module under Administer -> Site configuration
  30. /admin/settings/mobile-switch
  31. - Choose your mobile theme.
  32. If a theme used as mobile theme, their displayed informations on the
  33. Appearance administration page are altered for better visualisation.
  34. A Mobile Switch mobile theme is not available on administration pages and
  35. in the maintenance mode.
  36. Mobile theme on administration pages
  37. Configure the 'Administration usage' in the module 'Basic settings' to
  38. enable the use of the mobile theme on administration pages.
  39. Mobile device prevention
  40. It is possible to bypass the automatic switching to the mobile theme for
  41. mobile devices.
  42. This is useful, for example, to exclude large tablets for the theme
  43. switching.
  44. To use this,
  45. administer the 'Advanced' settings under:
  46. Administer -> Site configuration -> Mobile Switch
  47. /admin/settings/mobile-switch/advanced
  48. enable the 'Use preventing' option and configure the user agent strings
  49. for such devices.
  50. To test this feature, without a real mobile device, it is a good
  51. solution to use the desktop browser with a user agent switcher extension
  52. and custom defined user agents.
  53. For the development of a web site
  54. Administer the 'Development' settings under:
  55. Administer -> Site configuration -> Mobile Switch
  56. /admin/settings/mobile-switch/development
  57. a) Enable/disable the 'Developer modus'.
  58. If a desktop mobile emulator not detected from browscap it is possible
  59. to configure additional user agents.
  60. b) Enable/disable desktop browser usage of the mobile theme.
  61. DEVELOPMENT
  62. -----------
  63. Development with Mobile Switch.
  64. The module provides three system variables:
  65. 1. mobile_switch_ismobiledevice
  66. 2. mobile_switch_ismobiletheme
  67. 3. theme_mobile
  68. The value of the variables 1. and 2. is a boolean value.
  69. The value of the variable 3. is FALSE or the machine name of the used theme.
  70. EXTERNAL RECOURCES
  71. ------------------
  72. Mobile Emulators & Simulators: The Ultimate Guide
  73. http://www.mobilexweb.com/emulators