You are here

Home » API reference » Context 6

README.txt in Context 6

Same filename in this branch
  1. 6 README.txt
  2. 6 context_ui/README.txt
  3. 6 context_layouts/README.txt
Same filename and directory in other branches
  1. 6.3 context_ui/README.txt
  2. 7.3 context_ui/README.txt
context_ui for Drupal 6.x

Installation
------------
context_ui can be installed like any other Drupal module -- place it in
the modules directory for your site and enable it (and its requirement,
context) on the admin/build/modules page.

You will probably want to install context_ui_contrib as well, which
adds context_ui integration for several contrib modules including
Views.

Basic usage
-----------
context_ui allows you to manage contexts for different portions of your
site. You can think of each context as represeting a "section" of your
site. For each context, you can choose the conditions that trigger this
context to be active and choose different aspects of Drupal that should
respond to this active context.

Example
-------
You want to create a "pressroom" section of your site. You have a press
room view that displays press release nodes, but you also want to tie
a book with media resources tightly to this section. You would also
like a contact block you've made to appear whenever a user is in the
pressroom section.

1. Add a new context on admin/build/context
2. Set the value to "pressroom"
3. Under the "set context" dialogue, associate the pressroom nodetype,
   the pressroom view, and the media kit book with the context.
4. Choose the pressroom menu item to be set active under the "respond
   to context" items.
5. Add the contact block to a region under the block visibility
   settings.
6. Save the context.

Hooks
-----
hook_context_ui_setters()
  Provides an array of FormAPI definitions. Allows you to provide
  additional conditions as context setters in the context UI form.
  See context_ui_context_ui_setters() as an example.

hook_context_ui_getters()
  Provides an array of FormAPI definitions. Allows you to provide
  additional context getters that respond to a set context in the
  context UI form. See context_ui_context_ui_getters() as an
  example.

hook_context_ui_define()
  Provides an array of exported context definitions. Allows you
  to provide default contexts in your modules.

hook_context_ui_default_contexts_alter()
  A drupal_alter() that acts on the collected array of default
  contexts before they are cached.

hook_context_ui_active_contexts_alter()
  A drupal_alter() that acts on the collected array of active
  contexts on a given page load.

hook_context_ui_node_links_alter()
  A drupal_alter() that acts on the a links array of node
  creation and other contextual links for a given page load.

Maintainers
-----------
yhahn (Young Hahn)
jmiccolis (Jeff Miccolis)

Contributors
------------
dmitrig01 (Dmitri Gaskin)
Pasqualle (Csuthy Bálint)

File

context_ui/README.txt
View source 
  1. 

  2. context_ui for Drupal 6.x

  3. 

  4. Installation

  5. ------------

  6. context_ui can be installed like any other Drupal module -- place it in

  7. the modules directory for your site and enable it (and its requirement,

  8. context) on the admin/build/modules page.

  9. 

  10. You will probably want to install context_ui_contrib as well, which

  11. adds context_ui integration for several contrib modules including

  12. Views.

  13. 

  14. Basic usage

  15. -----------

  16. context_ui allows you to manage contexts for different portions of your

  17. site. You can think of each context as represeting a "section" of your

  18. site. For each context, you can choose the conditions that trigger this

  19. context to be active and choose different aspects of Drupal that should

  20. respond to this active context.

  21. 

  22. Example

  23. -------

  24. You want to create a "pressroom" section of your site. You have a press

  25. room view that displays press release nodes, but you also want to tie

  26. a book with media resources tightly to this section. You would also

  27. like a contact block you've made to appear whenever a user is in the

  28. pressroom section.

  29. 

  30. 1. Add a new context on admin/build/context

  31. 2. Set the value to "pressroom"

  32. 3. Under the "set context" dialogue, associate the pressroom nodetype,

  33.    the pressroom view, and the media kit book with the context.

  34. 4. Choose the pressroom menu item to be set active under the "respond

  35.    to context" items.

  36. 5. Add the contact block to a region under the block visibility

  37.    settings.

  38. 6. Save the context.

  39. 

  40. Hooks

  41. -----

  42. hook_context_ui_setters()

  43.   Provides an array of FormAPI definitions. Allows you to provide

  44.   additional conditions as context setters in the context UI form.

  45.   See context_ui_context_ui_setters() as an example.

  46. 

  47. hook_context_ui_getters()

  48.   Provides an array of FormAPI definitions. Allows you to provide

  49.   additional context getters that respond to a set context in the

  50.   context UI form. See context_ui_context_ui_getters() as an

  51.   example.

  52. 

  53. hook_context_ui_define()

  54.   Provides an array of exported context definitions. Allows you

  55.   to provide default contexts in your modules.

  56. 

  57. hook_context_ui_default_contexts_alter()

  58.   A drupal_alter() that acts on the collected array of default

  59.   contexts before they are cached.

  60. 

  61. hook_context_ui_active_contexts_alter()

  62.   A drupal_alter() that acts on the collected array of active

  63.   contexts on a given page load.

  64. 

  65. hook_context_ui_node_links_alter()

  66.   A drupal_alter() that acts on the a links array of node

  67.   creation and other contextual links for a given page load.

  68. 

  69. Maintainers

  70. -----------

  71. yhahn (Young Hahn)

  72. jmiccolis (Jeff Miccolis)

  73. 

  74. Contributors

  75. ------------

  76. dmitrig01 (Dmitri Gaskin)

  77. Pasqualle (Csuthy Bálint)

  78.