diff --git a/core/modules/settings_tray/settings_tray.api.php b/core/modules/settings_tray/settings_tray.api.php index eb9342cd21..9a7209ebe8 100644 --- a/core/modules/settings_tray/settings_tray.api.php +++ b/core/modules/settings_tray/settings_tray.api.php @@ -12,24 +12,21 @@ * * @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 rendered contents of the block by showing all relevant - * configuration (minus block visibility conditions). This means blocks can be - * modified without leaving the page. + * The Settings Tray module makes administering blocks easier. It provides a + * "Quick Edit" link for blocks using the Contextual Links module. Clicking this + * link opens the off-canvas Settings Tray which allows changing the rendered + * contents of the block by showing all relevant configuration (minus block + * visibility conditions). This means blocks can be modified without leaving the + * page. * * For example: - * - for every block, one can configure whether to display the block title or - * not, and optionally override it (block configuration) - * - for menu blocks, one can configure which menu levels to display (block - * configuration) but also the menu itself (menu configuration) - * - for the site branding block, one can change which branding elements to + * - For every block, one can configure whether to display the block title or + * not, and optionally override it (block configuration). + * - For menu blocks, one can configure which menu levels to display (block + * configuration) but also the menu itself (menu configuration). + * - For the site branding block, one can change which branding elements to * display (block configuration), but also the site name and slogan (simple - * configuration) + * configuration). * * The Settings Tray uses a variant of a standard dialog: an off-canvas dialog. * diff --git a/core/modules/settings_tray/settings_tray.info.yml b/core/modules/settings_tray/settings_tray.info.yml index fd2db01775..bb2e36c4d9 100644 --- a/core/modules/settings_tray/settings_tray.info.yml +++ b/core/modules/settings_tray/settings_tray.info.yml @@ -1,6 +1,6 @@ name: 'Settings Tray' type: module -description: 'In-place editing of block configuration.' +description: 'Provides a sidebar to configure blocks on the page.' package: Core (Experimental) version: VERSION core: 8.x diff --git a/core/modules/settings_tray/settings_tray.module b/core/modules/settings_tray/settings_tray.module index d97ff6e242..20a2eac2d9 100644 --- a/core/modules/settings_tray/settings_tray.module +++ b/core/modules/settings_tray/settings_tray.module @@ -24,8 +24,9 @@ function settings_tray_help($route_name, RouteMatchInterface $route_match) { $output .= '
'; $output .= '
' . t('Editing blocks in place') . '
'; $output .= '
'; - $output .= '

' . t('To edit blocks in place, you can either enable \'edit mode\' in the toolbar and click the block, or choosing Quick edit from the contextual links of a block (see the Contextual Links module help for more information about how to use contextual links).', [':contextual' => \Drupal::url('help.page', ['name' => 'contextual'])]) . '

'; - $output .= '

' . t('This will open the Settings Tray for this block, where a compact form will be displayed, with configuration that controls what the block shows. After saving, the page reloads, and the effects are visible.') . '

'; + $output .= '

' . t('To edit blocks in place, either click the Edit button in the toolbar and then click on the block, or choose "Quick edit" from the block\'s contextual link. (see the Contextual Links module help for more information about how to use contextual links).', [':contextual' => \Drupal::url('help.page', ['name' => 'contextual'])]) . '

'; + $output .= '

' . t('The Settings Tray for the block will open in a sidebar, with a compact form for configuring what the block shows.') . '

'; + $output .= '

' . t('Save the form and the changes will be immediately visible on the page.') . '

'; $output .= '
'; $output .= '
'; return ['#markup' => $output];