README.txt 2.9 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374
  1. Context UI
  2. ----------
  3. Context UI provides an administrative interface for managing and editing
  4. Contexts. It is not necessary for the proper functioning of contexts once they
  5. are built and can be turned off on most production sites.
  6. Requirements
  7. ------------
  8. - Context, Context UI modules enabled (`admin/modules`)
  9. - [jQuery UI 1.x][1] and [Admin 2.x][2] to use the inline context editor.
  10. Optional.
  11. Basic usage
  12. -----------
  13. As a site administrator you can manage your site's contexts at
  14. `admin/structure/context`. The main page will show you a list of the contexts
  15. on the site and give you some options for managing each context.
  16. When editing or adding a new context, you will be presented with a form to
  17. manage some basic information about the context and then alter its conditions
  18. and reactions.
  19. - `name`: The name of your context. This is the main identifier for your context
  20. and cannot be changed after you've created it.
  21. - `description`: A description or human-readable name for your context. This is
  22. displayed in the inline editor if available instead of the name.
  23. - `tag`: A category for organizing contexts in the administrative context
  24. listing. Optional.
  25. **Conditions**
  26. When certain conditions are true, your context will be made active. You can
  27. customize the conditions that trigger the activation of your context.
  28. - **Condition mode**: you can choose to have your context triggered if **ANY**
  29. conditions are met or only active when **ALL** conditions are met.
  30. - **Adding/removing conditions**: you can add or remove to the conditions on
  31. your context using the conditions dropdown.
  32. - **Individual settings**: most conditions provide a simple form for selecting
  33. individual settings for that condition. For example, the node type condition
  34. allows you to choose which node types activate the context.
  35. **Reactions**
  36. Whenever a particular context is active, all of its reactions will be run.
  37. Like conditions, reactions can be added or removed and have settings that can
  38. be configured.
  39. - **Reaction Block Groupings**: You can influence what "group" a block appears
  40. in when listing all blocks available to be added to a region. This is done
  41. by specifying $block->context_group via hook_block_info. If no group is
  42. specified it will default to the module name, but if a group is specified
  43. it will be grouped under that group name.
  44. Using the inline editor
  45. -----------------------
  46. If you have installed jQuery UI and Admin, you can enable the inline context
  47. editor:
  48. 1. As an administrative user go to `admin/settings/admin`.
  49. 2. Check the 'Context editor' block and save.
  50. 3. When viewing a page with one or more active contexts, you will see the
  51. `Context editor` in the admin toolbar.
  52. 4. You can use the context editor to adjust the conditions under which each
  53. context is active and alter its reactions.
  54. [1]: http://drupal.org/project/jquery_ui
  55. [2]: http://drupal.org/project/admin