You are here

README.txt in Domain Access 7.3

README file for Domain Theme

File

domain_theme/README.txt
View source
  1. /**
  2. * @file
  3. * README file for Domain Theme
  4. */
  5. Domain Access: Theme
  6. Assign themes to domains created by the Domain Access modules.
  7. CONTENTS
  8. --------
  9. 1. Introduction
  10. 1.1 Upgrading
  11. 1.2 Contributors
  12. 2. Installation
  13. 2.1 Dependencies
  14. 2.2 Upgrading to Drupal 7
  15. 3. Configuration Options
  16. 3.1 Theme Settings
  17. 3.2 Domain-Specific Themes
  18. 3.3 Domain-Specific Theme Settings
  19. 3.4 Color Module Notes
  20. 3.5 Conflicts With Other Modules
  21. 4. Batch Updates
  22. 5. Developer Notes
  23. 5.1 Database Schema
  24. ----
  25. 1. Introduction
  26. The Domain Theme module is a small module that allows you to assign
  27. different themes for each active domain created with the Domain Access
  28. module.
  29. You may also set domain-specific settings for each theme.
  30. ----
  31. 1.1 Upgrading
  32. If you used Domain Theme prior to 6.x.2.0rc7, you will need to run the
  33. Drupal upgrade script.
  34. ----
  35. 1.2 Contributors
  36. Drupal user 'canen' http://drupal.org/user/16188 wrote the first implementation
  37. of this module. The current release version is based on that work.
  38. ----
  39. 2. Installation
  40. The Domain Theme module is included in the Domain Access download.
  41. To install, untar the domain package and place the entire folder in your modules
  42. directory.
  43. When you enable the module, it will create a {domain_theme} table in your Drupal
  44. database.
  45. ----
  46. 2.1 Dependencies
  47. Domain Theme requires the Domain Access module be installed and active.
  48. ----
  49. 2.2 Upgrading to Drupal 7
  50. When you upgrade the module to Drupal 7, you may need to reset your theme
  51. settings for each domain. There are internal changes to the theme system that
  52. cannot be automated during the update process.
  53. You should check your logo and favicon files after performing an upgrade.
  54. ----
  55. 3. Configuration Options
  56. The Domain Theme modules adds configuration options to the main module and
  57. to each of your domains.
  58. ----
  59. 3.1 Theme Settings
  60. This module edits the global $custom_theme variable for your site. Other
  61. modules -- especially the Organic Groups module -- may also attempt to modify
  62. this variable.
  63. If you use other modules that allow custom user or group themes, you may
  64. experience conflicts with the Domain Theme module. Use this setting to vary the
  65. execution order of the Domain Theme module. Lower (negative) values will
  66. execute earlier in the Drupal page building process.
  67. You may need to experiment with this setting to get the desired result.
  68. ----
  69. 3.2 Domain-Specific Themes
  70. When active, the Domain Theme module will add a 'theme' link to the Domain List
  71. screen.
  72. When you click the 'theme' link for a domain record, you can set the default
  73. theme for use by that domain. This form works just like the default system
  74. theme selection form, with the following notes:
  75. -- You cannot enable themes from this screen. Themes must be enabled globally.
  76. You may configure domain-specific theme settings by clicking on the 'configure'
  77. link.
  78. NOTE: When viewing this configuration page, the theme's domain-specific
  79. settings will be displayed and the page's theme will change.
  80. ----
  81. 3.3 Domain-Specific Theme Settings
  82. New in versions 6.x.2.0rc7 and higher, you may configure custom theme settings
  83. per domain. This can be very useful in swapping out logo files per domain, or
  84. changed the color of Garland for each domain.
  85. To enable theme-specific setting, click the configure link on the Domain Theme
  86. configure page. You will be presented with the standard Drupal theme
  87. configuration form.
  88. On page load, your domain-specific theme settings will be loaded automatically.
  89. If you configure a theme's settings without having selected a default theme for
  90. the domain, that theme will be made the default.
  91. NOTE: When viewing this configuration page, the theme's domain-specific
  92. settings will be displayed.
  93. NOTE: In Drupal 7, the logo and favicon files you upload per theme are no
  94. longer renamed to match the theme name. In order to have custom logos
  95. and favicons, you may need to name the files appropriately before they are
  96. uploaded.
  97. ----
  98. 3.4 Color Module Notes
  99. The core Color module allows theme elements to have their colors reset, using
  100. CSS files and image transformations to copy necessary files to create subthemes.
  101. The primary use of Color module is by the default Garland theme.
  102. Color module is a difficult case, and this module works as expected in Garland
  103. and Minelli (both core Drupal themes). You may experience issues with custom
  104. themes, or with modules that dynamically add additional CSS files to the Color
  105. module.
  106. ----
  107. 3.5 Conflicts With Other Modules
  108. Due to how Drupal handles theme switching, you may experience a conflict if
  109. more than one module tries to alter the site theme. To work around this issue,
  110. Domain Theme provides a settings that allows you to adjust the module's
  111. execution order.
  112. The form is found at the bottom of the settings page for Domain Access,
  113. under the 'Theme settings' header.
  114. You may need to experiment with various weights before finding the correct
  115. setting for your site. Lower weights execute first. Zero is the default weight.
  116. By design, Domain Theme should not reset the theme for a page if another
  117. module has already done so.
  118. ----
  119. 4. Batch Updates
  120. Domain Theme allows you to make batch changes to settings for all domains.
  121. You may also choose to remove domain-specific theme selections. Note that
  122. the batch editing form only allows you to change the active theme for a domain.
  123. You cannot use the batch edit screen to modify theme settings per-domain.
  124. Using the batch screen sets the active theme for all domains to the selected
  125. value(s).
  126. This feature is useful if you wish to roll back custom changes.
  127. ----
  128. 5. Developer Notes
  129. This module may not work as expected with custom or contributed themes.
  130. Use at your own risk.
  131. ----
  132. 5.1 Database Schema
  133. Installing the module creates a {domain_theme} table that contains:
  134. - domain_id
  135. Integer, unique
  136. The lookup key for this record, foreign key to the {domain} table.
  137. - theme
  138. String, unique
  139. The theme name assigned as the default for this domain.
  140. - settings
  141. Blob (bytea)
  142. A serialized array of theme settings for this domain. Currently not used.
  143. - status
  144. Integer (tiny)
  145. A boolean flag indicating that this is the active theme for the given domain.
  146. - filepath
  147. Varchar (255)
  148. A string containing the file location for Color module files for this theme.