Commit 85ac7dd5 authored by volkswagenchick's avatar volkswagenchick Committed by boshtian
Browse files

Issue #3007934 by volkswagenchick, alonaoneill, boshtian: README - formatting,...

Issue #3007934 by volkswagenchick, alonaoneill, boshtian: README - formatting, configs and useful links
parent 31440f31
# Context CONTENTS OF THIS FILE
---------------------
The context module lets you define conditions for when certain reactions * Introduction
should take place. * 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 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). 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 Reactions for the context module are defined trough the new Drupal 8
[Plugin API](https://www.drupal.org/developing/api/8/plugins). [Plugin API](https://www.drupal.org/developing/api/8/plugins).
...@@ -25,17 +51,42 @@ The context module defines a plugin type named Context Reaction that you can ...@@ -25,17 +51,42 @@ The context module defines a plugin type named Context Reaction that you can
extend when creating your own plugins. extend when creating your own plugins.
A context reaction requires a configuration form and execute method. The 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.
Installation MAINTAINERS
--- -----------
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.
You will probably also want to install Context UI which provides a way for Current maintainers:
you to edit contexts through the Drupal admin interface. * Bostjan Kovac (boshtian) - https://www.drupal.org/u/boshtian
* Christoffer Palm (NormySan) - https://www.drupal.org/u/normysan
* Alexander Hass (hass) - https://www.drupal.org/u/hass
* Chris Johnson (tekante) - https://www.drupal.org/u/tekante
* Colan Schwartz (colan) - https://www.drupal.org/u/colan
Configuration Supporting organizations:
--- * AGILEDROP - https://www.drupal.org/agiledrop
The path for configuration page is: admin/structure/context * Colan Schwartz Consulting - https://www.drupal.org/agiledrop
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment