diff --git a/README.md b/README.md index daf625f..cab8b6d 100644 --- a/README.md +++ b/README.md @@ -1,23 +1,49 @@ -# Context +CONTENTS OF THIS FILE +--------------------- -The context module lets you define conditions for when certain reactions -should take place. + * Introduction + * Requirements + * Conditions + * Reactions + * Installation + * Configuration + * Maintainers -An example of a condition could be when viewing a certain node type and blocks -should be placed as a reaction when viewing a page with this node type. -###Good resources +INTRODUCTION +------------ -- [Drupal 8 Plugin API](https://www.drupal.org/developing/api/8/plugins) +Context allows you to manage contextual conditions and reactions for different +portions of your site. You can think of each context as representing 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 react +to this active context. + + * For a full description of the module, visit the project page: + https://www.drupal.org/project/context + + * To submit bug reports and feature suggestions, or to track changes: + https://www.drupal.org/project/issues/context + + +REQUIREMENTS +------------ + +This module requires no modules outside of Drupal core. + + +CONDITIONS +---------- -Conditions ---- Context for Drupal 8 uses the built in condition plugins supplied by Drupal through the [Plugin API](https://www.drupal.org/developing/api/8/plugins). -So any conditional plug-ins supplied by other modules can also be used with context. +So any conditional plug-ins supplied by other modules can also be used with +context. + + +REACTIONS +--------- -Reactions ---- Reactions for the context module are defined trough the new Drupal 8 [Plugin API](https://www.drupal.org/developing/api/8/plugins). @@ -25,17 +51,44 @@ The context module defines a plugin type named Context Reaction that you can extend when creating your own plugins. A context reaction requires a configuration form and execute method. The -execution of the plugin is also something that will have to be handled by the author of the reaction. +execution of the plugin is also something that will have to be handled by the +author of the reaction. + + +INSTALLATION +------------ + + * Install the Context module as you would normally install a + contributed Drupal module. Visit + https://www.drupal.org/node/1897420 for further information. + + +CONFIGURATION +------------- + + 1. Navigate to Administration > Extend and enable the module and the + submodule Context UI. + 2. Navigate to Administration > Structure > Context to associate menus, + views, blocks, etc. with different contexts. + 3. Select "Add context" to add general details for a new context. Save. + 4. Add conditions. When there are no added conditions the context will be + considered sitewide. + 5. Add reactions. + 6. Save and continue. + + +MAINTAINERS +----------- -Installation ---- -Context can be installed like any other Drupal module -- place it in -the modules directory for your site and enable it (and its requirement, -CTools) on the `admin/modules` page. + * yhahn - https://www.drupal.org/user/264833 + * Jeff Miccolis (jmiccolis) - https://www.drupal.org/user/31731 + * Steven Jones - https://www.drupal.org/u/steven-jones + * Git Migration - https://www.drupal.org/u/git-migration + * Frank Febbraro (febbraro) - https://www.drupal.org/u/febbraro + * Chris Johnson (tekante) - https://www.drupal.org/u/tekante + * Igor Čurk (icurk) - https://www.drupal.org/u/icurk -You will probably also want to install Context UI which provides a way for -you to edit contexts through the Drupal admin interface. +Supporting organizations: -Configuration ---- -The path for configuration page is: admin/structure/context + * AGILEDROP - https://www.drupal.org/agiledrop + * Colan Schwartz Consulting - https://www.drupal.org/agiledrop