context_ui/README.txt

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