core/modules/outside_in/outside_in.api.php | 13 +++++++++++++ core/modules/outside_in/outside_in.info.yml | 2 +- 2 files changed, 14 insertions(+), 1 deletion(-) diff --git a/core/modules/outside_in/outside_in.api.php b/core/modules/outside_in/outside_in.api.php index 913036f..b34147f 100644 --- a/core/modules/outside_in/outside_in.api.php +++ b/core/modules/outside_in/outside_in.api.php @@ -10,6 +10,19 @@ * @{ * Settings Tray API * + * @section sec_overview Overview and terminology + * + * The goal of the Settings Tray module is to make administering blocks easier, + * and therefore to make the site building experience faster and more pleasant. + * + * It achieves this by building on the infrastructure that the Contextual + * Links module provides: Settings Tray provides a "Quick Edit" contextual link + * for blocks. Clicking this contextual link opens the Settings Tray, which + * allows to change the contents of the block (not the visibility conditions). + * This means blocks can be modified without leaving the page. + * + * The Settings Tray uses a variant of a standard dialog: an off-canvas dialog. + * * @section sec_api The API: the form in the Settings Tray * * By default, every block will show their built-in form in the Settings Tray. diff --git a/core/modules/outside_in/outside_in.info.yml b/core/modules/outside_in/outside_in.info.yml index f25420f..fd2db01 100644 --- a/core/modules/outside_in/outside_in.info.yml +++ b/core/modules/outside_in/outside_in.info.yml @@ -1,6 +1,6 @@ name: 'Settings Tray' type: module -description: 'Provides the ability to change the most common configuration from the Drupal front-end.' +description: 'In-place editing of block configuration.' package: Core (Experimental) version: VERSION core: 8.x