README.txt in Mobile Switch Block 6

Mobile Switch Block module

Extends the Mobile Switch module with an theme switch block.

The block content provides a link to manually switch the current theme to
the mobile or desktop theme.

HOW IT WORKS
------------

  The module uses a cookie to store the theme was changed to. This works with
  anonymous visitors and logged in users.

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

  - Drupal 6.
  - The Mobile Switch module from drupal.org/project/mobile_switch.
    NOTE: It is required to use the
          - 6.x-1.0-beta1+ version or
          - latest development version
          of the Mobile Switch module.

INSTALL
-------

  1) Copy the Mobile Switch Block folder to the modules folder in
     your installation. Usually this is sites/all/modules.
     Or use the UI and install it via admin/modules/install.

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

  Note:
  Install/enable the module only if you want to use the manual switch function!

ADMINISTER
----------

  Administer blocks under:
  Administer -> Site building
  /admin/build/block

    - Enable the 'Mobile Switch' block in the desktop theme.
    - Enable the 'Mobile Switch' block in the mobile theme.

    - Configure one of the "Mobile Switch" blocks.
      Choose the option to display the block content. The same configuration
      option exists in the Advanced module administration.

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

    - Configure the output of the switch content.

    - Configure the 'Cookie lifetime' when needed.

      Lifetime examples:

      31536000 - 1 year (default)
      2628000  - 30 days
      604800   - 1 week
      86400    - 24 hours

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

  Don't forget to take a look at the 'Development' funtions in the Mobile Switch
  module settings.
  As example, it is usefull to enable the 'Desktop browser' option.

  Development with Mobile Switch Block.

  1) The module provides the system variable:

     theme_cookie

     - The default value of this variable is FALSE. If the theme switch cookie
       exists the value can be 'standard' or 'mobile'.

  2) Use the block content. Example PHP code to do this:

     print mobile_switch_block_get_block_content();

     In this use case, you ensure that the switch link content appears only
     with mobile devices.

  3) Use the switch block only on large mobile devices:

     It is possible to use media queries to hide the block on small mobile
     devices. Example CSS code to do this:

     @media screen and (max-device-width: 600px) {
       #block-mobile-switch-block-switch {
         display: none;
       }
     }

     More media query examples:
     http://webdesignerwall.com/tutorials/css3-media-queries

     Note: Take a look at the Respond.js module.
           drupal.org/project/respondjs

           This module provides IE 6-8 support for responsive themes.
           It uses Respond.js, delivering lightweight, fast support for
           min-width and max-width CSS3 media queries.

THEMING
-------

  Module template
  ---------------

     The module comes with a template file, included in the module folder.

     mobile-switch-block-content.tpl.php

     Is used for the switch content - the switch link and the switch message.

  Use of the template
  -------------------

     This requires that there is a mobile-switch-block-content.tpl.php template
     in the desktop and/or mobile theme folder.

  Switch link without menu bullet
  -------------------------------

    Remove in the template/s the class 'leaf' from the list tag.

    

      <li class="even first last">
    


    This will work with most themes and is recommended rather than an additional
    CSS formatting.

  Usage with a 'Mobile jQuery' theme
  ----------------------------------

    Mobile jQuery Theme, drupal.org/project/mobile_jquery

    To obtain a 'Mobile jQuery' like output of the switch link, create a
    template file for the Mobile jQuery theme from the desktop template file
    'mobile-switch-block-switch-content.tpl.php' with the same name and put this
    new template file in the 'templates' folder. Example path for the new
    Mobile jQuery theme template file:

    /sites/all/themes/mobile_jquery/templates/

    In the new template file replace the code

    

     <?php if ($switch_message): ?>
       <?php print $switch_message ?>
     <?php endif;?>
       <ul class="menu clearfix">
         <li class="leaf even first last">
           <?php print $switch_link ?>
         </li>
       </ul>
    


    with the following code

    

    <?php print $content ?>
    


    It is therefore possible to use different templates in the desktop and
    mobile Theme.

    Note: Take a look at the Mobile Switch Block module folder
          templates/mobile_jquery/.