You are here

README.txt in Context 7.3

Context UI
----------
Context UI provides an administrative interface for managing and editing
Contexts. It is not necessary for the proper functioning of contexts once they
are built and can be turned off on most production sites.


Requirements
------------
- Context, Context UI modules enabled (`admin/modules`)


Basic usage
-----------
As a site administrator you can manage your site's contexts at
`admin/structure/context`. The main page will show you a list of the contexts
on the site and give you some options for managing each context.

When editing or adding a new context, you will be presented with a form to
manage some basic information about the context and then alter its conditions
and reactions.

- `name`: The name of your context. This is the main identifier for your context
  and cannot be changed after you've created it.
- `description`: A description or human-readable name for your context. This is
  displayed in the inline editor if available instead of the name.
- `tag`: A category for organizing contexts in the administrative context
  listing. Optional.

**Conditions**

When certain conditions are true, your context will be made active. You can
customize the conditions that trigger the activation of your context.

- **Condition mode**: you can choose to have your context triggered if **ANY**
  conditions are met or only active when **ALL** conditions are met.
- **Adding/removing conditions**: you can add or remove to the conditions on
  your context using the conditions dropdown.
- **Individual settings**: most conditions provide a simple form for selecting
  individual settings for that condition. For example, the node type condition
  allows you to choose which node types activate the context.

**Reactions**

Whenever a particular context is active, all of its reactions will be run.
Like conditions, reactions can be added or removed and have settings that can
be configured.

- **Reaction Block Groupings**: You can influence what "group" a block appears
  in when listing all blocks available to be added to a region.  This is done
  by specifying $block->context_group via hook_block_info.  If no group is
  specified it will default to the module name, but if a group is specified
  it will be grouped under that group name.



Using the inline editor
-----------------------
The inline editor allows you to manage the block reaction for active
contexts within the context of a page rather than through the admin
interface. This can also be helpful when managing block ordering among
multiple contexts.

1. As an administrative user go to `admin/structure/context/settings`.
2. Check the 'Use Context Editor Dialog' block and save. You should also
   check the show all regions box.
3. When viewing a page with one or more active contexts, you will see
   the option to configure layout in the contextual links on all blocks
   on the page. This will allow you to manage the blocks placed by the
   block reaction for contexts.
4. You can use the context editor to adjust the conditions under which each
   context is active and alter its reactions.

File

context_ui/README.txt
View source
  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. Basic usage
  10. -----------
  11. As a site administrator you can manage your site's contexts at
  12. `admin/structure/context`. The main page will show you a list of the contexts
  13. on the site and give you some options for managing each context.
  14. When editing or adding a new context, you will be presented with a form to
  15. manage some basic information about the context and then alter its conditions
  16. and reactions.
  17. - `name`: The name of your context. This is the main identifier for your context
  18. and cannot be changed after you've created it.
  19. - `description`: A description or human-readable name for your context. This is
  20. displayed in the inline editor if available instead of the name.
  21. - `tag`: A category for organizing contexts in the administrative context
  22. listing. Optional.
  23. **Conditions**
  24. When certain conditions are true, your context will be made active. You can
  25. customize the conditions that trigger the activation of your context.
  26. - **Condition mode**: you can choose to have your context triggered if **ANY**
  27. conditions are met or only active when **ALL** conditions are met.
  28. - **Adding/removing conditions**: you can add or remove to the conditions on
  29. your context using the conditions dropdown.
  30. - **Individual settings**: most conditions provide a simple form for selecting
  31. individual settings for that condition. For example, the node type condition
  32. allows you to choose which node types activate the context.
  33. **Reactions**
  34. Whenever a particular context is active, all of its reactions will be run.
  35. Like conditions, reactions can be added or removed and have settings that can
  36. be configured.
  37. - **Reaction Block Groupings**: You can influence what "group" a block appears
  38. in when listing all blocks available to be added to a region. This is done
  39. by specifying $block->context_group via hook_block_info. If no group is
  40. specified it will default to the module name, but if a group is specified
  41. it will be grouped under that group name.
  42. Using the inline editor
  43. -----------------------
  44. The inline editor allows you to manage the block reaction for active
  45. contexts within the context of a page rather than through the admin
  46. interface. This can also be helpful when managing block ordering among
  47. multiple contexts.
  48. 1. As an administrative user go to `admin/structure/context/settings`.
  49. 2. Check the 'Use Context Editor Dialog' block and save. You should also
  50. check the show all regions box.
  51. 3. When viewing a page with one or more active contexts, you will see
  52. the option to configure layout in the contextual links on all blocks
  53. on the page. This will allow you to manage the blocks placed by the
  54. block reaction for contexts.
  55. 4. You can use the context editor to adjust the conditions under which each
  56. context is active and alter its reactions.