You are here

README.txt in ThemeKey 6

*****************************************************************************
                              T H E M E K E Y
*****************************************************************************
Name: themekey module
Author: Thilo Wawrzik <drupal at profix898 dot de>
Drupal: 6.x
*****************************************************************************
DESCRIPTION:

ThemeKey is meant to be a generic theme switching module. It
allows you to switch the theme for different paths and based
on object properties (e.g. node field values). It can also be
easily extended to support additional paths or properties as
exposed by other modules.

Documentation for users and developers is very sparse at the
moment. I hope to complete the docs in the next few weeks.
Thanks for your patience :)

*****************************************************************************
INSTALLATION:

1. Place whole themekey folder into your Drupal modules/ or better
   sites/x/modules/ directory.

2. Enable the themekey module by navigating to
     administer > modules

3. Bring up themekey configuration screens by navigating to
     administer > settings > themekey

*****************************************************************************
THEMEKEY UI:

How to use ThemeKey UI on node forms ...

- Go to admin/settings/themekey/settings/ui to make theme options available
  on node forms, and check off the content types you want to enable the
  options for
- Go to admin/settings/themekey/settings and enable the 'node:nid' property

*****************************************************************************
FOR DEVELOPERS:

HOOK_themekey_properties()
  Attributes
    Key:    namespace:property
    Value:  array()
            - description => Readable name of property (required)
            - multiple    => TRUE/FALSE (optional)
              (does an object, e.g. a node, can have more than one of this property values)
            - weight      => weighting callback (optional)
              (if multiple values are possible, the weighting callback is required for priority)
            - path        => Path to property value on an object (optional)

  Maps
    Key:    none (indexed)
    Value:  array()
            - src       => Source property path (required)
            - dst       => Destination property path (required)
            - callback  => Mapping callback (required)

HOOK_themekey_global()
  Global properties
    Key:    namespace:property
    Value:  property value

HOOK_themekey_paths()
  Paths
    Key:    none (indexed)
    Value:  array()
            - path      => Router path to register (required)
            - callbacks => Load (and/or match) callback (required)
              (the callback function can set the 'theme' element in $item directly)
              Callback arguments:
              - $item:    array of elements associated with the path/callback
              - $params:  array of parameters available for load callback
              
*****************************************************************************

File

README.txt
View source
  1. *****************************************************************************
  2. T H E M E K E Y
  3. *****************************************************************************
  4. Name: themekey module
  5. Author: Thilo Wawrzik
  6. Drupal: 6.x
  7. *****************************************************************************
  8. DESCRIPTION:
  9. ThemeKey is meant to be a generic theme switching module. It
  10. allows you to switch the theme for different paths and based
  11. on object properties (e.g. node field values). It can also be
  12. easily extended to support additional paths or properties as
  13. exposed by other modules.
  14. Documentation for users and developers is very sparse at the
  15. moment. I hope to complete the docs in the next few weeks.
  16. Thanks for your patience :)
  17. *****************************************************************************
  18. INSTALLATION:
  19. 1. Place whole themekey folder into your Drupal modules/ or better
  20. sites/x/modules/ directory.
  21. 2. Enable the themekey module by navigating to
  22. administer > modules
  23. 3. Bring up themekey configuration screens by navigating to
  24. administer > settings > themekey
  25. *****************************************************************************
  26. THEMEKEY UI:
  27. How to use ThemeKey UI on node forms ...
  28. - Go to admin/settings/themekey/settings/ui to make theme options available
  29. on node forms, and check off the content types you want to enable the
  30. options for
  31. - Go to admin/settings/themekey/settings and enable the 'node:nid' property
  32. *****************************************************************************
  33. FOR DEVELOPERS:
  34. HOOK_themekey_properties()
  35. Attributes
  36. Key: namespace:property
  37. Value: array()
  38. - description => Readable name of property (required)
  39. - multiple => TRUE/FALSE (optional)
  40. (does an object, e.g. a node, can have more than one of this property values)
  41. - weight => weighting callback (optional)
  42. (if multiple values are possible, the weighting callback is required for priority)
  43. - path => Path to property value on an object (optional)
  44. Maps
  45. Key: none (indexed)
  46. Value: array()
  47. - src => Source property path (required)
  48. - dst => Destination property path (required)
  49. - callback => Mapping callback (required)
  50. HOOK_themekey_global()
  51. Global properties
  52. Key: namespace:property
  53. Value: property value
  54. HOOK_themekey_paths()
  55. Paths
  56. Key: none (indexed)
  57. Value: array()
  58. - path => Router path to register (required)
  59. - callbacks => Load (and/or match) callback (required)
  60. (the callback function can set the 'theme' element in $item directly)
  61. Callback arguments:
  62. - $item: array of elements associated with the path/callback
  63. - $params: array of parameters available for load callback
  64. *****************************************************************************