diff --git a/core/modules/settings_tray/settings_tray.api.php b/core/modules/settings_tray/settings_tray.api.php index b204d255b4..56f2cb71e6 100644 --- a/core/modules/settings_tray/settings_tray.api.php +++ b/core/modules/settings_tray/settings_tray.api.php @@ -12,13 +12,9 @@ * * @section sec_overview Overview and terminology * - * 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 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. + * The Settings Tray module allows blocks to configured in a sidebar form + * without leaving the page. For example: * - * 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 @@ -27,10 +23,12 @@ * display (block configuration), but also the site name and slogan (simple * configuration). * + * Block visibility conditions are not included the sidebar form. + * * @section sec_api The API: the form in the Settings Tray * - * By default, every block will show its built-in form in the Settings Tray - * which uses the off-canvas dialog. + * By default, the Settings Tray shows any block's built-in form in the + * off-canvas dialog. * * @see core/misc/dialog/off-canvas.es6.js * @@ -61,11 +59,11 @@ * }, * @endcode * - * Finally, blocks that do not specify an settings_tray form using the - * annotation above will automatically have it set to their plugin class. For - * example, the "Powered by Drupal" block plugin - * (\Drupal\system\Plugin\Block\SystemPoweredByBlock) automatically gets - * this added to its annotation: + * Finally, blocks that do not specify a settings_tray form using the annotation + * above will automatically have it set to their plugin class. For example, the + * "Powered by Drupal" block plugin + * (\Drupal\system\Plugin\Block\SystemPoweredByBlock) automatically gets this + * added to its annotation: * @code * forms = { * "settings_tray" = "\Drupal\system\Plugin\Block\SystemPoweredByBlock", diff --git a/core/modules/settings_tray/settings_tray.module b/core/modules/settings_tray/settings_tray.module index 20a2eac2d9..48b08caaab 100644 --- a/core/modules/settings_tray/settings_tray.module +++ b/core/modules/settings_tray/settings_tray.module @@ -24,7 +24,7 @@ function settings_tray_help($route_name, RouteMatchInterface $route_match) { $output .= '
'; $output .= '
' . t('Editing blocks in place') . '
'; $output .= '
'; - $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('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 .= '
';