You are here

README.txt in Style Switcher 7.2

Same filename and directory in other branches
  1. 8.2 README.txt
  2. 6.2 README.txt
  3. 3.0.x README.txt
--------------------------------------------------------------------------------
                                Style Switcher 2
--------------------------------------------------------------------------------

The module allows website visitors to choose which stylesheet they would like to
view the site with.

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

This module takes the fuss out of creating themes or building sites with
alternate stylesheets. Themer can provide a theme with alternate stylesheets.
Site builder can add alternate stylesheets found in the internet right in the
admin section. And this module presents all those styles to site visitors as a
list of links in a block. So any site visitor is able to choose the style of
the site they prefer. The module uses cookies so that when people return to the
site or visit a different page they still get their chosen style.

There are many commonly known JavaScript techniques to switch CSS stylesheets
"live", without reloading the page. Some examples of them and relevant
JavaScript files can be found here:
 * https://alistapart.com/article/alternate/
 * http://2008.kelvinluck.com/2006/05/switch-stylesheets-with-jquery.html
 * https://www.immortalwolf.com/code-repository/javascript-components/

This module uses a slightly different and more powerful mechanism. But the logic
is the same: click a link » get the new look of the site.

Works in all major browsers.

For more information about the module, visit the documentation guide:
 * https://www.drupal.org/docs/7/modules/style-switcher
To submit bug reports and feature suggestions, or to track changes:
 * https://www.drupal.org/project/issues/styleswitcher

--------------------------------------------------------------------------------
INSTALLATION/UPDATE
--------------------------------------------------------------------------------

Install as you would normally install a contributed Drupal module. For more
information refer:
 * https://www.drupal.org/docs/7/extend/installing-modules

If you're updating from a previous version don't forget to run DB updates. For
more information refer:
 * https://www.drupal.org/node/1782798

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

There are 2 ways to configure the list of styles for switching. And they can be
combined.

 * One way is for site admins:

   1. Create CSS files in site's public directory, for example: in the
      sites/default/files, or anywhere in the internet. Just remember that these
      locations along with the CSS files must be publicly accessible.

   2. Go to Administration » Configuration » User interface » Styleswitcher.
      There you'll find a module's configuration form and a link to add
      stylesheets for switching. Add all your styles providing their labels and
      paths.

 * Another way is mostly for themers. For site builders it is appropriate only
   if you use a custom theme that you are able to edit:

   1. In your theme's directory or subdirectory create CSS files for each
      different style.

      Note that each stylesheet when switched is being added to the existing set
      of other site's stylesheets.

   2. In your theme's .info file add a section like the following, replacing
      labels and paths with yours:

        styleswitcher[css][Light Blue] = css/blue.css
        styleswitcher[css][All Black] = css/black.css
        styleswitcher[default] = All Black

      where "All Black" is the label of the style, and css/black.css is the
      location of the stylesheet file, relative to theme's root. A line with
      Default is optional - it is for new site visitors. If it is not set then
      none of alternatives will be visible until user explicitly clicks one.

      NOTE: Do not specify in this section any of other existing CSS loaded by
      Drupal core, modules or your theme. They are being loaded unconditionally.
      If you want to set some of your theme's stylesheets for switching then
      move them from "stylesheets" section of .info file to the "styleswitcher"
      section.

The next steps are for both of previous ways:

 3. In the Styleswitcher admin section you can see tabs for each of site's
    enabled themes. There you can reorganize how style links will be displayed
    to visitors: you can reorder them, enable/disable some of them and choose
    another default style for each theme. This means that each of your site's
    themes can have its own set of styles for switching.

    Note that styles added in admin form will be available for all themes, but
    those provided in theme's .info will only be available for that theme and
    its sub-themes, but not for other themes.

 4. Finally, go to Administration » Structure » Blocks, find "Style Switcher"
    block, place it wherever you want and press "Save". You can also configure
    the block as you like.

    If you want the style switching functionality in multiple themes then you
    need to place the block in them too.

That's it. The block will present links for each of the configured styles to the
site visitors.

--------------------------------------------------------------------------------
AUTHORS & MAINTAINERS
--------------------------------------------------------------------------------

 * Mike Shiyan [https://www.drupal.org/u/pingwin4eg]
 * Alan Burke [https://www.drupal.org/u/alanburke]
 * Roger López [https://www.drupal.org/u/zroger]
 * Kristjan Jansen [https://www.drupal.org/u/kika]

File

README.txt
View source
  1. --------------------------------------------------------------------------------
  2. Style Switcher 2
  3. --------------------------------------------------------------------------------
  4. The module allows website visitors to choose which stylesheet they would like to
  5. view the site with.
  6. --------------------------------------------------------------------------------
  7. INTRODUCTION
  8. --------------------------------------------------------------------------------
  9. This module takes the fuss out of creating themes or building sites with
  10. alternate stylesheets. Themer can provide a theme with alternate stylesheets.
  11. Site builder can add alternate stylesheets found in the internet right in the
  12. admin section. And this module presents all those styles to site visitors as a
  13. list of links in a block. So any site visitor is able to choose the style of
  14. the site they prefer. The module uses cookies so that when people return to the
  15. site or visit a different page they still get their chosen style.
  16. There are many commonly known JavaScript techniques to switch CSS stylesheets
  17. "live", without reloading the page. Some examples of them and relevant
  18. JavaScript files can be found here:
  19. * https://alistapart.com/article/alternate/
  20. * http://2008.kelvinluck.com/2006/05/switch-stylesheets-with-jquery.html
  21. * https://www.immortalwolf.com/code-repository/javascript-components/
  22. This module uses a slightly different and more powerful mechanism. But the logic
  23. is the same: click a link » get the new look of the site.
  24. Works in all major browsers.
  25. For more information about the module, visit the documentation guide:
  26. * https://www.drupal.org/docs/7/modules/style-switcher
  27. To submit bug reports and feature suggestions, or to track changes:
  28. * https://www.drupal.org/project/issues/styleswitcher
  29. --------------------------------------------------------------------------------
  30. INSTALLATION/UPDATE
  31. --------------------------------------------------------------------------------
  32. Install as you would normally install a contributed Drupal module. For more
  33. information refer:
  34. * https://www.drupal.org/docs/7/extend/installing-modules
  35. If you're updating from a previous version don't forget to run DB updates. For
  36. more information refer:
  37. * https://www.drupal.org/node/1782798
  38. --------------------------------------------------------------------------------
  39. CONFIGURATION
  40. --------------------------------------------------------------------------------
  41. There are 2 ways to configure the list of styles for switching. And they can be
  42. combined.
  43. * One way is for site admins:
  44. 1. Create CSS files in site's public directory, for example: in the
  45. sites/default/files, or anywhere in the internet. Just remember that these
  46. locations along with the CSS files must be publicly accessible.
  47. 2. Go to Administration » Configuration » User interface » Styleswitcher.
  48. There you'll find a module's configuration form and a link to add
  49. stylesheets for switching. Add all your styles providing their labels and
  50. paths.
  51. * Another way is mostly for themers. For site builders it is appropriate only
  52. if you use a custom theme that you are able to edit:
  53. 1. In your theme's directory or subdirectory create CSS files for each
  54. different style.
  55. Note that each stylesheet when switched is being added to the existing set
  56. of other site's stylesheets.
  57. 2. In your theme's .info file add a section like the following, replacing
  58. labels and paths with yours:
  59. styleswitcher[css][Light Blue] = css/blue.css
  60. styleswitcher[css][All Black] = css/black.css
  61. styleswitcher[default] = All Black
  62. where "All Black" is the label of the style, and css/black.css is the
  63. location of the stylesheet file, relative to theme's root. A line with
  64. Default is optional - it is for new site visitors. If it is not set then
  65. none of alternatives will be visible until user explicitly clicks one.
  66. NOTE: Do not specify in this section any of other existing CSS loaded by
  67. Drupal core, modules or your theme. They are being loaded unconditionally.
  68. If you want to set some of your theme's stylesheets for switching then
  69. move them from "stylesheets" section of .info file to the "styleswitcher"
  70. section.
  71. The next steps are for both of previous ways:
  72. 3. In the Styleswitcher admin section you can see tabs for each of site's
  73. enabled themes. There you can reorganize how style links will be displayed
  74. to visitors: you can reorder them, enable/disable some of them and choose
  75. another default style for each theme. This means that each of your site's
  76. themes can have its own set of styles for switching.
  77. Note that styles added in admin form will be available for all themes, but
  78. those provided in theme's .info will only be available for that theme and
  79. its sub-themes, but not for other themes.
  80. 4. Finally, go to Administration » Structure » Blocks, find "Style Switcher"
  81. block, place it wherever you want and press "Save". You can also configure
  82. the block as you like.
  83. If you want the style switching functionality in multiple themes then you
  84. need to place the block in them too.
  85. That's it. The block will present links for each of the configured styles to the
  86. site visitors.
  87. --------------------------------------------------------------------------------
  88. AUTHORS & MAINTAINERS
  89. --------------------------------------------------------------------------------
  90. * Mike Shiyan [https://www.drupal.org/u/pingwin4eg]
  91. * Alan Burke [https://www.drupal.org/u/alanburke]
  92. * Roger López [https://www.drupal.org/u/zroger]
  93. * Kristjan Jansen [https://www.drupal.org/u/kika]