You are here

Home » API reference » Theme Switcher Rules 8

README.txt in Theme Switcher Rules 8 

CONTENTS OF THIS FILE
---------------------

 * Introduction
 * Requirements
 * Installation
 * Configuration
 * FAQ
 * Maintainers


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

The Theme Switcher module allows you to create theme-switching rules which 
allow automatic selection of a theme based on Drupal 8 Conditions system. 
Because of this it can also be easily extended to support additional 
custom conditions exposed by other modules. In Drupal 8 conditions are no 
longer defined through a hook and they are plugins now.

This modules is currently only available for Drupal 8.

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

 * To submit bug reports and feature suggestions, or track changes:
   https://www.drupal.org/project/issues/theme_switcher
  
 * For Conditions further information:
   https://www.drupal.org/docs/8/modules/d8-rules-essentials/for-developers/conditions


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

The module require PHP >=7.1 and Drupal 8.5 or higher.


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

Install as you would normally install a contributed Drupal module. See
https://www.drupal.org/docs/8/extending-drupal-8/installing-drupal-8-modules
for further information.


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

* Configure the user permissions in Administration >> People >> Permissions:

    - Administer all Theme Switcher Rules
    
        Allows all permissions for the module.
       
    - View Theme Switcher Rules
    
        Users with this permission will be allow to view all Theme Switcher 
        Rules.
    
    - Create Theme Switcher Rules
    
        Users with this permission will be allow to create Theme Switcher 
        Rules.
    
    - Edit Theme Switcher Rules
    
        Users with this permission will be allow to edit Theme Switcher Rules.
    
    - Delete Theme Switcher Rules
    
        Users with this permission will be allow to delete Theme Switcher 
        Rules.

* Configuring theme switcher rules:

    - To create a theme switcher rule, you must provide the following 
    information:

        * A *name* to be used in lists of theme switcher rules.
        * A *machine_name* that must be unique. This value will be 
        autogenerated and cannot be edited once created.
        * A *status* indicating `active` or `inactive`.
        * A hidden field *weight* that can be changed using the list drag&drop 
        interface.
        * A *theme* to apply when each conditions are evaluated and pass.
        * A set of *Conditions* that indicate each one of the variables that 
        must be satisfied by the rule to apply the above selected theme.

    **IMPORTANT**: All the rules will be evaluated in the order of the list. 
    This means that once the rule pass all its conditions in a satisfying way 
    the rest of the rules will not be evaluated.


FAQ
---

 Q: What can I do with this module?

 A: You can apply a specific theme to a unique node, use different themes based
    on the page language, use contrib conditions like a domain to apply one
    theme or another. The best of all is that you can do al of the above at
    once!


Maintainers
-----------

Current maintainers:
 * Adrian Marin (amarincolas) - https://www.drupal.org/u/amarincolas

File

README.txt
View source 
  1. CONTENTS OF THIS FILE

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

  3. 

  4.  * Introduction

  5.  * Requirements

  6.  * Installation

  7.  * Configuration

  8.  * FAQ

  9.  * Maintainers

  10. 

  11. 

  12. INTRODUCTION

  13. ------------

  14. 

  15. The Theme Switcher module allows you to create theme-switching rules which 

  16. allow automatic selection of a theme based on Drupal 8 Conditions system. 

  17. Because of this it can also be easily extended to support additional 

  18. custom conditions exposed by other modules. In Drupal 8 conditions are no 

  19. longer defined through a hook and they are plugins now.

  20. 

  21. This modules is currently only available for Drupal 8.

  22. 

  23.  * For a full description of the module, visit the project page:

  24.    https://www.drupal.org/project/theme_switcher

  25. 

  26.  * To submit bug reports and feature suggestions, or track changes:

  27.    https://www.drupal.org/project/issues/theme_switcher

  28.   

  29.  * For Conditions further information:

  30.    https://www.drupal.org/docs/8/modules/d8-rules-essentials/for-developers/conditions

  31. 

  32. 

  33. REQUIREMENTS

  34. ------------

  35. 

  36. The module require PHP >=7.1 and Drupal 8.5 or higher.

  37. 

  38. 

  39. INSTALLATION

  40. ------------

  41. 

  42. Install as you would normally install a contributed Drupal module. See

  43. https://www.drupal.org/docs/8/extending-drupal-8/installing-drupal-8-modules

  44. for further information.

  45. 

  46. 

  47. CONFIGURATION

  48. -------------

  49. 

  50. * Configure the user permissions in Administration >> People >> Permissions:

  51. 

  52.     - Administer all Theme Switcher Rules

  53.     

  54.         Allows all permissions for the module.

  55.        

  56.     - View Theme Switcher Rules

  57.     

  58.         Users with this permission will be allow to view all Theme Switcher 

  59.         Rules.

  60.     

  61.     - Create Theme Switcher Rules

  62.     

  63.         Users with this permission will be allow to create Theme Switcher 

  64.         Rules.

  65.     

  66.     - Edit Theme Switcher Rules

  67.     

  68.         Users with this permission will be allow to edit Theme Switcher Rules.

  69.     

  70.     - Delete Theme Switcher Rules

  71.     

  72.         Users with this permission will be allow to delete Theme Switcher 

  73.         Rules.

  74. 

  75. * Configuring theme switcher rules:

  76. 

  77.     - To create a theme switcher rule, you must provide the following 

  78.     information:

  79. 

  80.         * A *name* to be used in lists of theme switcher rules.

  81.         * A *machine_name* that must be unique. This value will be 

  82.         autogenerated and cannot be edited once created.

  83.         * A *status* indicating `active` or `inactive`.

  84.         * A hidden field *weight* that can be changed using the list drag&drop 

  85.         interface.

  86.         * A *theme* to apply when each conditions are evaluated and pass.

  87.         * A set of *Conditions* that indicate each one of the variables that 

  88.         must be satisfied by the rule to apply the above selected theme.

  89. 

  90.     **IMPORTANT**: All the rules will be evaluated in the order of the list. 

  91.     This means that once the rule pass all its conditions in a satisfying way 

  92.     the rest of the rules will not be evaluated.

  93. 

  94. 

  95. FAQ

  96. ---

  97. 

  98.  Q: What can I do with this module?

  99. 

  100.  A: You can apply a specific theme to a unique node, use different themes based

  101.     on the page language, use contrib conditions like a domain to apply one

  102.     theme or another. The best of all is that you can do al of the above at

  103.     once!

  104. 

  105. 

  106. Maintainers

  107. -----------

  108. 

  109. Current maintainers:

  110.  * Adrian Marin (amarincolas) - https://www.drupal.org/u/amarincolas