Issue #2113611 by mstef: [Fatal error] hook_requirements() not returning anything
[project/context.git] / README.txt
1
2 Context 3.x for Drupal 6.x
3 --------------------------
4 Context allows you to manage contextual conditions and reactions for
5 different portions of your site. You can think of each context as
6 representing a "section" of your site. For each context, you can choose
7 the conditions that trigger this context to be active and choose different
8 aspects of Drupal that should react to this active context.
9
10 Think of conditions as a set of rules that are checked during page load
11 to see what context is active. Any reactions that are associated with
12 active contexts are then fired.
13
14
15 Installation
16 ------------
17 Context can be installed like any other Drupal module -- place it in
18 the modules directory for your site and enable it (and its requirement,
19 CTools) on the `admin/build/modules` page.
20
21 You will probably also want to install Context UI which provides a way for
22 you to edit contexts through the Drupal admin interface.
23
24
25 Example
26 -------
27 You want to create a "pressroom" section of your site. You have a press
28 room view that displays press release nodes, but you also want to tie
29 a book with media resources tightly to this section. You would also
30 like a contact block you've made to appear whenever a user is in the
31 pressroom section.
32
33 1. Add a new context on admin/build/context
34 2. Under "Conditions", associate the pressroom nodetype, the pressroom view,
35    and the media kit book with the context.
36 3. Under "Reactions > Menu", choose the pressroom menu item to be set active.
37 4. Under "Reactions > Blocks", add the contact block to a region.
38 5. Save the context.
39
40 For a more in-depth overview of the UI components, see the Context UI
41 `README.txt`.
42
43
44 Upgrading from Context 2.x for Drupal 6.x
45 -----------------------------------------
46 - Download latest Context 3.x and latest CTools release and place in modules
47   directory. Make sure to *remove* the existing Context 2.x directory before
48   unpacking Context 3.x. There are stale files in the 2.x branch that need to
49   be removed.
50 - Run `update.php` or `drush updatedb`.
51 - If your site contains contexts defined in code they will be overridden.
52   Re-export them to code again. If you are using any custom conditions or
53   reactions, you may need to upgrade or reconfigure them by hand. See `API.txt`
54   for instructions on adding and extending plugins in Context.
55
56
57 Hooks
58 -----
59 See `context.api.php` for the hooks made available by context and `API.txt` for
60 usage examples.
61
62
63 Maintainers
64 -----------
65
66 - yhahn (Young Hahn)
67 - jmiccolis (Jeff Miccolis)
68 - Steven Jones
69
70
71 Contributors
72 ------------
73
74 - alex_b (Alex Barth)
75 - dmitrig01 (Dmitri Gaskin)
76 - Pasqualle (Csuthy Bálint)