diff --git a/core/modules/forum/tests/src/Functional/migrate_drupal/d6/Upgrade6Test.php b/core/modules/forum/tests/src/Functional/migrate_drupal/d6/Upgrade6Test.php
index 247b9d722a23bf4bd6910e2565b980ca93e1fc75..11d0358a12b13b7b19d20424904c6da31ad673d9 100644
--- a/core/modules/forum/tests/src/Functional/migrate_drupal/d6/Upgrade6Test.php
+++ b/core/modules/forum/tests/src/Functional/migrate_drupal/d6/Upgrade6Test.php
@@ -48,7 +48,7 @@ protected function getSourceBasePath() {
*/
protected function getEntityCounts() {
return [
- 'block' => 32,
+ 'block' => 33,
'block_content' => 1,
'block_content_type' => 1,
'comment' => 4,
@@ -63,7 +63,7 @@ protected function getEntityCounts() {
'image_style' => 6,
'node' => 2,
'node_type' => 7,
- 'search_page' => 2,
+ 'search_page' => 3,
'shortcut' => 2,
'shortcut_set' => 1,
'action' => 27,
diff --git a/core/modules/forum/tests/src/Functional/migrate_drupal/d7/Upgrade7Test.php b/core/modules/forum/tests/src/Functional/migrate_drupal/d7/Upgrade7Test.php
index 6660c4bccdf3783b58621a7e540951d7f4715120..2d9ebd286b922ebffb4da68fb608e535e34e3cca 100644
--- a/core/modules/forum/tests/src/Functional/migrate_drupal/d7/Upgrade7Test.php
+++ b/core/modules/forum/tests/src/Functional/migrate_drupal/d7/Upgrade7Test.php
@@ -61,7 +61,7 @@ protected function getSourceBasePath() {
*/
protected function getEntityCounts() {
return [
- 'block' => 25,
+ 'block' => 26,
'block_content' => 1,
'block_content_type' => 1,
'comment' => 0,
@@ -76,7 +76,7 @@ protected function getEntityCounts() {
'image_style' => 7,
'node' => 2,
'node_type' => 4,
- 'search_page' => 2,
+ 'search_page' => 3,
'shortcut' => 2,
'shortcut_set' => 1,
'action' => 27,
diff --git a/core/modules/help_topics/config/optional/block.block.claro_help_search.yml b/core/modules/help/config/optional/block.block.claro_help_search.yml
similarity index 100%
rename from core/modules/help_topics/config/optional/block.block.claro_help_search.yml
rename to core/modules/help/config/optional/block.block.claro_help_search.yml
diff --git a/core/modules/help_topics/config/optional/search.page.help_search.yml b/core/modules/help/config/optional/search.page.help_search.yml
similarity index 88%
rename from core/modules/help_topics/config/optional/search.page.help_search.yml
rename to core/modules/help/config/optional/search.page.help_search.yml
index 5ae158e5ea5f24285b3332140f679d68ad22c1af..38d4344448aae3b9587d89bb1e12ae61ca3801ae 100644
--- a/core/modules/help_topics/config/optional/search.page.help_search.yml
+++ b/core/modules/help/config/optional/search.page.help_search.yml
@@ -2,7 +2,7 @@ langcode: en
status: true
dependencies:
module:
- - help_topics
+ - help
id: help_search
label: Help
path: help
diff --git a/core/modules/help_topics/config/schema/help_topics.schema.yml b/core/modules/help/config/schema/help.schema.yml
similarity index 100%
rename from core/modules/help_topics/config/schema/help_topics.schema.yml
rename to core/modules/help/config/schema/help.schema.yml
diff --git a/core/modules/help/help.api.php b/core/modules/help/help.api.php
index 6ce605880f469669f8dd39830c6996d7c9773b93..dd3590a7e5d40b029d243795a496f8fb8269c18d 100644
--- a/core/modules/help/help.api.php
+++ b/core/modules/help/help.api.php
@@ -7,6 +7,36 @@
use Drupal\Core\Url;
+/**
+ * @defgroup help_docs Help and documentation
+ * @{
+ * Documenting modules, themes, and install profiles
+ *
+ * @section sec_topics Help Topics
+ * Modules, themes, and install profiles can have a subdirectory help_topics
+ * that contains one or more Help Topics, to provide help to administrative
+ * users. These are shown on the main admin/help page. See
+ * @link https://www.drupal.org/docs/develop/documenting-your-project/help-topic-standards Help Topic Standards @endlink
+ * for more information.
+ *
+ * @section sec_hook hook_help
+ * Modules can implement hook_help() to provide a module overview (shown on the
+ * main admin/help page). This hook implementation can also provide help text
+ * that is shown in the Help block at the top of administrative pages. See the
+ * hook_help() documentation and
+ * @link https://www.drupal.org/docs/develop/documenting-your-project/help-text-standards Help text standards @endlink
+ * for more information.
+ *
+ * @section sec_tour Tours
+ * Modules can provide tours of administrative pages by creating tour config
+ * files and placing them in their config/optional subdirectory. See
+ * @link https://www.drupal.org/docs/8/api/tour-api/overview Tour API overview @endlink
+ * for more information. The contributed
+ * @link https://www.drupal.org/project/tour_ui Tour UI module @endlink
+ * can also be used to create tour config files.
+ * @}
+ */
+
/**
* @addtogroup hooks
* @{
@@ -79,6 +109,17 @@ function hook_help_section_info_alter(array &$info) {
$info['hook_help']['weight'] = 500;
}
+/**
+ * Perform alterations on help topic definitions.
+ *
+ * @param array $info
+ * Array of help topic plugin definitions keyed by their plugin ID.
+ */
+function hook_help_topics_info_alter(array &$info) {
+ // Alter the help topic to be displayed on admin/help.
+ $info['example.help_topic']['top_level'] = TRUE;
+}
+
/**
* @} End of "addtogroup hooks".
*/
diff --git a/core/modules/help/help.install b/core/modules/help/help.install
new file mode 100644
index 0000000000000000000000000000000000000000..2ae1a9030a575319434b80c75878354345f8444c
--- /dev/null
+++ b/core/modules/help/help.install
@@ -0,0 +1,98 @@
+<?php
+
+/**
+ * @file
+ * Install and uninstall functions for help module.
+ */
+
+/**
+ * Implements hook_schema().
+ */
+function help_schema() {
+ $schema['help_search_items'] = [
+ 'description' => 'Stores information about indexed help search items',
+ 'fields' => [
+ 'sid' => [
+ 'description' => 'Numeric index of this item in the search index',
+ 'type' => 'serial',
+ 'unsigned' => TRUE,
+ 'not null' => TRUE,
+ ],
+ 'section_plugin_id' => [
+ 'description' => 'The help section the item comes from',
+ 'type' => 'varchar_ascii',
+ 'length' => 255,
+ 'not null' => TRUE,
+ 'default' => '',
+ ],
+ 'permission' => [
+ 'description' => 'The permission needed to view this item',
+ 'type' => 'varchar_ascii',
+ 'length' => 255,
+ 'not null' => TRUE,
+ 'default' => '',
+ ],
+ 'topic_id' => [
+ 'description' => 'The topic ID of the item',
+ 'type' => 'varchar_ascii',
+ 'length' => 255,
+ 'not null' => TRUE,
+ 'default' => '',
+ ],
+ ],
+ 'primary key' => ['sid'],
+ 'indexes' => [
+ 'section_plugin_id' => ['section_plugin_id'],
+ 'topic_id' => ['topic_id'],
+ ],
+ ];
+
+ return $schema;
+}
+
+/**
+ * Install search index table for help topics.
+ */
+function help_update_10200(&$sandbox = NULL) {
+ $connection = \Drupal::database();
+ if (!$connection->schema()->tableExists('help_search_items')) {
+ $table = [
+ 'description' => 'Stores information about indexed help search items',
+ 'fields' => [
+ 'sid' => [
+ 'description' => 'Numeric index of this item in the search index',
+ 'type' => 'serial',
+ 'unsigned' => TRUE,
+ 'not null' => TRUE,
+ ],
+ 'section_plugin_id' => [
+ 'description' => 'The help section the item comes from',
+ 'type' => 'varchar_ascii',
+ 'length' => 255,
+ 'not null' => TRUE,
+ 'default' => '',
+ ],
+ 'permission' => [
+ 'description' => 'The permission needed to view this item',
+ 'type' => 'varchar_ascii',
+ 'length' => 255,
+ 'not null' => TRUE,
+ 'default' => '',
+ ],
+ 'topic_id' => [
+ 'description' => 'The topic ID of the item',
+ 'type' => 'varchar_ascii',
+ 'length' => 255,
+ 'not null' => TRUE,
+ 'default' => '',
+ ],
+ ],
+ 'primary key' => ['sid'],
+ 'indexes' => [
+ 'section_plugin_id' => ['section_plugin_id'],
+ 'topic_id' => ['topic_id'],
+ ],
+ ];
+ $connection->schema()->createTable('help_search_items', $table);
+ }
+}
diff --git a/core/modules/help/help.module b/core/modules/help/help.module
index 9ada44feb71cebf51c01e046f1c056d69bfb6c8e..e550e27fcca7303503634eafbe4683477a1ad22c 100644
--- a/core/modules/help/help.module
+++ b/core/modules/help/help.module
@@ -30,17 +30,35 @@ function help_help($route_name, RouteMatchInterface $route_match) {
return ['#markup' => $output];
case 'help.page.help':
- $output = '';
- $output .= '<h3>' . t('About') . '</h3>';
- $output .= '<p>' . t('The Help module generates <a href=":help-page">Help reference pages</a> to guide you through the use and configuration of modules, and provides a Help block with page-level help. The reference pages are a starting point for <a href=":handbook">Drupal.org online documentation</a> pages that contain more extensive and up-to-date information, are annotated with user-contributed comments, and serve as the definitive reference point for all Drupal documentation. For more information, see the <a href=":help">online documentation for the Help module</a>.', [':help' => 'https://www.drupal.org/documentation/modules/help/', ':handbook' => 'https://www.drupal.org/documentation', ':help-page' => Url::fromRoute('help.main')->toString()]) . '</p>';
+ $help_home = Url::fromRoute('help.main')->toString();
+ $module_handler = \Drupal::moduleHandler();
+ $locale_help = ($module_handler->moduleExists('locale')) ? Url::fromRoute('help.page', ['name' => 'locale'])->toString() : '#';
+ $search_help = ($module_handler->moduleExists('search')) ? Url::fromRoute('help.page', ['name' => 'search'])->toString() : '#';
+ $output = '<h3>' . t('About') . '</h3>';
+ $output .= '<p>' . t('The Help module generates <a href=":help-page">Help topics and reference pages</a> to guide you through the use and configuration of modules, and provides a Help block with page-level help. The reference pages are a starting point for <a href=":handbook">Drupal.org online documentation</a> pages that contain more extensive and up-to-date information, are annotated with user-contributed comments, and serve as the definitive reference point for all Drupal documentation. For more information, see the <a href=":help">online documentation for the Help module</a>.', [':help' => 'https://www.drupal.org/documentation/modules/help/', ':handbook' => 'https://www.drupal.org/documentation', ':help-page' => Url::fromRoute('help.main')->toString()]) . '</p>';
+ $output .= '<p>' . t('Help topics provided by modules and themes are also part of the Help module. If the core Search module is enabled, these topics are searchable. For more information, see the <a href=":online">online documentation for Help Topics</a>.', [':online' => 'https://www.drupal.org/documentation/modules/help_topics']) . '</p>';
$output .= '<h3>' . t('Uses') . '</h3>';
$output .= '<dl>';
$output .= '<dt>' . t('Providing a help reference') . '</dt>';
$output .= '<dd>' . t('The Help module displays explanations for using each module listed on the main <a href=":help">Help reference page</a>.', [':help' => Url::fromRoute('help.main')->toString()]) . '</dd>';
$output .= '<dt>' . t('Providing page-specific help') . '</dt>';
$output .= '<dd>' . t('Page-specific help text provided by modules is displayed in the Help block. This block can be placed and configured on the <a href=":blocks">Block layout page</a>.', [':blocks' => (\Drupal::moduleHandler()->moduleExists('block')) ? Url::fromRoute('block.admin_display')->toString() : '#']) . '</dd>';
+ $output .= '<dt>' . t('Viewing help topics') . '</dt>';
+ $output .= '<dd>' . t('The top-level help topics are listed on the main <a href=":help_page">Help page</a>. Links to other topics, including non-top-level help topics, can be found under the "Related" heading when viewing a topic page.', [':help_page' => $help_home]) . '</dd>';
+ $output .= '<dt>' . t('Providing help topics') . '</dt>';
+ $output .= '<dd>' . t("Modules and themes can provide help topics as Twig-file-based plugins in a project sub-directory called <em>help_topics</em>; plugin meta-data is provided in YAML front matter within each Twig file. Plugin-based help topics provided by modules and themes will automatically be updated when a module or theme is updated. Use the plugins in <em>core/modules/help_topics/help_topics</em> as a guide when writing and formatting a help topic plugin for your theme or module.") . '</dd>';
+ $output .= '<dt>' . t('Translating help topics') . '</dt>';
+ $output .= '<dd>' . t('The title and body text of help topics provided by contributed modules and themes are translatable using the <a href=":locale_help">Interface Translation module</a>. Topics provided by custom modules and themes are also translatable if they have been viewed at least once in a non-English language, which triggers putting their translatable text into the translation database.', [':locale_help' => $locale_help]) . '</dd>';
+ $output .= '<dt>' . t('Configuring help search') . '</dt>';
+ $output .= '<dd>' . t('To search help, you will need to install the core Search module, configure a search page, and add a search block to the Help page or another administrative page. (A search page is provided automatically, and if you use the core Claro administrative theme, a help search block is shown on the main Help page.) Then users with search permissions, and permission to view help, will be able to search help. See the <a href=":search_help">Search module help page</a> for more information.', [':search_help' => $search_help]) . '</dd>';
$output .= '</dl>';
return ['#markup' => $output];
+
+ case 'help.help_topic':
+ $help_home = Url::fromRoute('help.main')->toString();
+ return '<p>' . t('See the <a href=":help_page">Help page</a> for more topics.', [
+ ':help_page' => $help_home,
+ ]) . '</p>';
}
}
@@ -57,6 +75,12 @@ function help_theme($existing, $type, $theme, $path) {
'empty' => NULL,
],
],
+ 'help_topic' => [
+ 'variables' => [
+ 'body' => [],
+ 'related' => [],
+ ],
+ ],
];
}
@@ -77,3 +101,56 @@ function help_block_view_help_block_alter(array &$build, BlockPluginInterface $b
// the help block, so don't needlessly draw attention to it.
unset($build['#contextual_links']);
}
+
+/**
+ * Implements hook_modules_uninstalled().
+ */
+function help_modules_uninstalled(array $modules) {
+ _help_search_update($modules);
+}
+
+/**
+ * Implements hook_themes_uninstalled().
+ */
+function help_themes_uninstalled(array $themes) {
+ _help_search_update();
+}
+
+/**
+ * Implements hook_modules_installed().
+ */
+function help_modules_installed(array $modules, $is_syncing) {
+ _help_search_update();
+}
+
+/**
+ * Implements hook_themes_installed().
+ */
+function help_themes_installed(array $themes) {
+ _help_search_update();
+}
+
+/**
+ * Ensure that search is updated when extensions are installed or uninstalled.
+ *
+ * @param string[] $extensions
+ * (optional) If modules are being uninstalled, the names of the modules
+ * being uninstalled. For themes being installed/uninstalled, or modules
+ * being installed, omit this parameter.
+ */
+function _help_search_update(array $extensions = []): void {
+ // Early return if search is not installed or if we're uninstalling this
+ // module.
+ if (!\Drupal::hasService('plugin.manager.search') ||
+ in_array('help', $extensions)) {
+ return;
+ }
+
+ if (\Drupal::service('update.update_hook_registry')->getInstalledVersion('help') >= 10100) {
+ // Ensure that topics for extensions that have been uninstalled are removed
+ // and that the index state variable is updated.
+ $help_search = \Drupal::service('plugin.manager.search')->createInstance('help_search');
+ $help_search->updateTopicList();
+ $help_search->updateIndexState();
+ }
+}
diff --git a/core/modules/help/help.post_update.php b/core/modules/help/help.post_update.php
new file mode 100644
index 0000000000000000000000000000000000000000..00663afceb25bf32c7a49ed1bb69562b0448b0f6
--- /dev/null
+++ b/core/modules/help/help.post_update.php
@@ -0,0 +1,97 @@
+<?php
+
+/**
+ * @file
+ * Post update functions for the Help module.
+ */
+
+use Drupal\search\Entity\SearchPage;
+
+/**
+ * Install or update config for help topics if the search module installed.
+ */
+function help_post_update_help_topics_search() {
+ $module_handler = \Drupal::moduleHandler();
+ if (!$module_handler->moduleExists('search')) {
+ // No dependencies to update or install.
+ return;
+ }
+ if ($module_handler->moduleExists('help_topics')) {
+ if ($page = SearchPage::load('help_search')) {
+ // Resave to update module dependency.
+ $page->save();
+ }
+ }
+ else {
+ $factory = \Drupal::configFactory();
+ // Install optional config for the search page.
+ $config = $factory->getEditable('search.page.help_search');
+ $config->setData([
+ 'langcode' => 'en',
+ 'status' => TRUE,
+ 'dependencies' => [
+ 'module' => [
+ 'help',
+ ],
+ ],
+ 'id' => 'help_search',
+ 'label' => 'Help',
+ 'path' => 'help',
+ 'weight' => 0,
+ 'plugin' => 'help_search',
+ 'configuration' => [],
+ ])->save(TRUE);
+ if (\Drupal::service('theme_handler')->themeExists('claro') && $factory->get('block.block.claro_help_search')->isNew()) {
+ // Optional block only if it's not created manually earlier.
+ $config = $factory->getEditable('block.block.claro_help_search');
+ $config->setData([
+ 'langcode' => 'en',
+ 'status' => TRUE,
+ 'dependencies' => [
+ 'module' => [
+ 'search',
+ 'system',
+ ],
+ 'theme' => [
+ 'claro',
+ ],
+ 'enforced' => [
+ 'config' => [
+ 'search.page.help_search',
+ ],
+ ],
+ ],
+ 'id' => 'claro_help_search',
+ 'theme' => 'claro',
+ 'region' => 'help',
+ 'weight' => -4,
+ 'provider' => NULL,
+ 'plugin' => 'search_form_block',
+ 'settings' => [
+ 'id' => 'search_form_block',
+ 'label' => 'Search help',
+ 'label_display' => 'visible',
+ 'provider' => 'search',
+ 'page_id' => 'help_search',
+ ],
+ 'visibility' => [
+ 'request_path' => [
+ 'id' => 'request_path',
+ 'negate' => FALSE,
+ 'context_mapping' => [],
+ 'pages' => '/admin/help',
+ ],
+ ],
+ ])->save(TRUE);
+ }
+ }
+}
+
+/**
+ * Uninstall the help_topics module if installed.
+ */
+function help_post_update_help_topics_uninstall() {
+ if (\Drupal::moduleHandler()->moduleExists('help_topics')) {
+ \Drupal::service('module_installer')->uninstall(['help_topics'], FALSE);
+ }
+}
diff --git a/core/modules/help/help.routing.yml b/core/modules/help/help.routing.yml
index 505251df9dad40708b830188c49033a7495a88fb..aa15b5f8fd4444e247d8df8ae50eef4de7e75c48 100644
--- a/core/modules/help/help.routing.yml
+++ b/core/modules/help/help.routing.yml
@@ -13,3 +13,10 @@ help.page:
_title: 'Help'
requirements:
_permission: 'access administration pages'
+
+help.help_topic:
+ path: '/admin/help/topic/{id}'
+ defaults:
+ _controller: '\Drupal\help\Controller\HelpTopicPluginController::viewHelpTopic'
+ requirements:
+ _permission: 'access administration pages'
diff --git a/core/modules/help/help.services.yml b/core/modules/help/help.services.yml
index 26a2c3376d8e321fd593577049e449aad7143d4d..cb1a4b333c983f0570cd2427f3b47bc0fc9789d6 100644
--- a/core/modules/help/help.services.yml
+++ b/core/modules/help/help.services.yml
@@ -2,3 +2,28 @@ services:
plugin.manager.help_section:
class: Drupal\help\HelpSectionManager
parent: default_plugin_manager
+ calls:
+ - [setSearchManager, ['@?plugin.manager.search']]
+ tags:
+ - { name: plugin_manager_cache_clear }
+ help.breadcrumb:
+ class: Drupal\help\HelpBreadcrumbBuilder
+ tags:
+ - { name: breadcrumb_builder, priority: 900 }
+ public: false
+ plugin.manager.help_topic:
+ class: Drupal\help\HelpTopicPluginManager
+ arguments: ['@module_handler', '@theme_handler', '@cache.discovery', '%app.root%']
+ Drupal\help\HelpTopicPluginManagerInterface: '@plugin.manager.help_topic'
+ help.twig.loader:
+ class: Drupal\help\HelpTopicTwigLoader
+ arguments: ['%app.root%', '@module_handler', '@theme_handler']
+ # Lowest core priority because loading help topics is not the usual case.
+ tags:
+ - { name: twig.loader, priority: -200 }
+ public: false
+ help_twig.extension:
+ class: Drupal\help\HelpTwigExtension
+ arguments: ['@access_manager', '@plugin.manager.help_topic', '@string_translation']
+ tags:
+ - { name: twig.extension }
diff --git a/core/modules/help_topics/help_topics/announcements_feed.overview.html.twig b/core/modules/help/help_topics/announcements_feed.overview.html.twig
similarity index 100%
rename from core/modules/help_topics/help_topics/announcements_feed.overview.html.twig
rename to core/modules/help/help_topics/announcements_feed.overview.html.twig
diff --git a/core/modules/help_topics/help_topics/ban.banning_ips.html.twig b/core/modules/help/help_topics/ban.banning_ips.html.twig
similarity index 100%
rename from core/modules/help_topics/help_topics/ban.banning_ips.html.twig
rename to core/modules/help/help_topics/ban.banning_ips.html.twig
diff --git a/core/modules/help_topics/help_topics/block.configure.html.twig b/core/modules/help/help_topics/block.configure.html.twig
similarity index 100%
rename from core/modules/help_topics/help_topics/block.configure.html.twig
rename to core/modules/help/help_topics/block.configure.html.twig
diff --git a/core/modules/help_topics/help_topics/block.overview.html.twig b/core/modules/help/help_topics/block.overview.html.twig
similarity index 100%
rename from core/modules/help_topics/help_topics/block.overview.html.twig
rename to core/modules/help/help_topics/block.overview.html.twig
diff --git a/core/modules/help_topics/help_topics/block.place.html.twig b/core/modules/help/help_topics/block.place.html.twig
similarity index 100%
rename from core/modules/help_topics/help_topics/block.place.html.twig
rename to core/modules/help/help_topics/block.place.html.twig
diff --git a/core/modules/help_topics/help_topics/block_content.add.html.twig b/core/modules/help/help_topics/block_content.add.html.twig
similarity index 100%
rename from core/modules/help_topics/help_topics/block_content.add.html.twig
rename to core/modules/help/help_topics/block_content.add.html.twig
diff --git a/core/modules/help_topics/help_topics/block_content.type.html.twig b/core/modules/help/help_topics/block_content.type.html.twig
similarity index 100%
rename from core/modules/help_topics/help_topics/block_content.type.html.twig
rename to core/modules/help/help_topics/block_content.type.html.twig
diff --git a/core/modules/help_topics/help_topics/book.about.html.twig b/core/modules/help/help_topics/book.about.html.twig
similarity index 100%
rename from core/modules/help_topics/help_topics/book.about.html.twig
rename to core/modules/help/help_topics/book.about.html.twig
diff --git a/core/modules/help_topics/help_topics/book.adding.html.twig b/core/modules/help/help_topics/book.adding.html.twig
similarity index 100%
rename from core/modules/help_topics/help_topics/book.adding.html.twig
rename to core/modules/help/help_topics/book.adding.html.twig
diff --git a/core/modules/help_topics/help_topics/book.configuring.html.twig b/core/modules/help/help_topics/book.configuring.html.twig
similarity index 100%
rename from core/modules/help_topics/help_topics/book.configuring.html.twig
rename to core/modules/help/help_topics/book.configuring.html.twig
diff --git a/core/modules/help_topics/help_topics/book.creating.html.twig b/core/modules/help/help_topics/book.creating.html.twig
similarity index 100%
rename from core/modules/help_topics/help_topics/book.creating.html.twig
rename to core/modules/help/help_topics/book.creating.html.twig
diff --git a/core/modules/help_topics/help_topics/book.organizing.html.twig b/core/modules/help/help_topics/book.organizing.html.twig
similarity index 100%
rename from core/modules/help_topics/help_topics/book.organizing.html.twig
rename to core/modules/help/help_topics/book.organizing.html.twig
diff --git a/core/modules/help_topics/help_topics/breakpoint.overview.html.twig b/core/modules/help/help_topics/breakpoint.overview.html.twig
similarity index 100%
rename from core/modules/help_topics/help_topics/breakpoint.overview.html.twig
rename to core/modules/help/help_topics/breakpoint.overview.html.twig
diff --git a/core/modules/help_topics/help_topics/comment.configuring.html.twig b/core/modules/help/help_topics/comment.configuring.html.twig
similarity index 100%
rename from core/modules/help_topics/help_topics/comment.configuring.html.twig
rename to core/modules/help/help_topics/comment.configuring.html.twig
diff --git a/core/modules/help_topics/help_topics/comment.creating_type.html.twig b/core/modules/help/help_topics/comment.creating_type.html.twig
similarity index 100%
rename from core/modules/help_topics/help_topics/comment.creating_type.html.twig
rename to core/modules/help/help_topics/comment.creating_type.html.twig
diff --git a/core/modules/help_topics/help_topics/comment.disabling.html.twig b/core/modules/help/help_topics/comment.disabling.html.twig
similarity index 100%
rename from core/modules/help_topics/help_topics/comment.disabling.html.twig
rename to core/modules/help/help_topics/comment.disabling.html.twig
diff --git a/core/modules/help_topics/help_topics/comment.moderating.html.twig b/core/modules/help/help_topics/comment.moderating.html.twig
similarity index 100%
rename from core/modules/help_topics/help_topics/comment.moderating.html.twig
rename to core/modules/help/help_topics/comment.moderating.html.twig
diff --git a/core/modules/help_topics/help_topics/comment.overview.html.twig b/core/modules/help/help_topics/comment.overview.html.twig
similarity index 100%
rename from core/modules/help_topics/help_topics/comment.overview.html.twig
rename to core/modules/help/help_topics/comment.overview.html.twig
diff --git a/core/modules/help_topics/help_topics/config.export_full.html.twig b/core/modules/help/help_topics/config.export_full.html.twig
similarity index 100%
rename from core/modules/help_topics/help_topics/config.export_full.html.twig
rename to core/modules/help/help_topics/config.export_full.html.twig
diff --git a/core/modules/help_topics/help_topics/config.export_single.html.twig b/core/modules/help/help_topics/config.export_single.html.twig
similarity index 100%
rename from core/modules/help_topics/help_topics/config.export_single.html.twig
rename to core/modules/help/help_topics/config.export_single.html.twig
diff --git a/core/modules/help_topics/help_topics/config.import_full.html.twig b/core/modules/help/help_topics/config.import_full.html.twig
similarity index 100%
rename from core/modules/help_topics/help_topics/config.import_full.html.twig
rename to core/modules/help/help_topics/config.import_full.html.twig
diff --git a/core/modules/help_topics/help_topics/config.import_single.html.twig b/core/modules/help/help_topics/config.import_single.html.twig
similarity index 100%
rename from core/modules/help_topics/help_topics/config.import_single.html.twig
rename to core/modules/help/help_topics/config.import_single.html.twig
diff --git a/core/modules/help_topics/help_topics/config_translation.overview.html.twig b/core/modules/help/help_topics/config_translation.overview.html.twig
similarity index 100%
rename from core/modules/help_topics/help_topics/config_translation.overview.html.twig
rename to core/modules/help/help_topics/config_translation.overview.html.twig
diff --git a/core/modules/help_topics/help_topics/contact.adding_fields.html.twig b/core/modules/help/help_topics/contact.adding_fields.html.twig
similarity index 100%
rename from core/modules/help_topics/help_topics/contact.adding_fields.html.twig
rename to core/modules/help/help_topics/contact.adding_fields.html.twig
diff --git a/core/modules/help_topics/help_topics/contact.configuring_personal.html.twig b/core/modules/help/help_topics/contact.configuring_personal.html.twig
similarity index 100%
rename from core/modules/help_topics/help_topics/contact.configuring_personal.html.twig
rename to core/modules/help/help_topics/contact.configuring_personal.html.twig
diff --git a/core/modules/help_topics/help_topics/contact.creating.html.twig b/core/modules/help/help_topics/contact.creating.html.twig
similarity index 100%
rename from core/modules/help_topics/help_topics/contact.creating.html.twig
rename to core/modules/help/help_topics/contact.creating.html.twig
diff --git a/core/modules/help_topics/help_topics/contact.overview.html.twig b/core/modules/help/help_topics/contact.overview.html.twig
similarity index 100%
rename from core/modules/help_topics/help_topics/contact.overview.html.twig
rename to core/modules/help/help_topics/contact.overview.html.twig
diff --git a/core/modules/help_topics/help_topics/contact.setting_default.html.twig b/core/modules/help/help_topics/contact.setting_default.html.twig
similarity index 100%
rename from core/modules/help_topics/help_topics/contact.setting_default.html.twig
rename to core/modules/help/help_topics/contact.setting_default.html.twig
diff --git a/core/modules/help_topics/help_topics/content_moderation.changing_states.html.twig b/core/modules/help/help_topics/content_moderation.changing_states.html.twig
similarity index 100%
rename from core/modules/help_topics/help_topics/content_moderation.changing_states.html.twig
rename to core/modules/help/help_topics/content_moderation.changing_states.html.twig
diff --git a/core/modules/help_topics/help_topics/content_moderation.configuring_workflows.html.twig b/core/modules/help/help_topics/content_moderation.configuring_workflows.html.twig
similarity index 100%
rename from core/modules/help_topics/help_topics/content_moderation.configuring_workflows.html.twig
rename to core/modules/help/help_topics/content_moderation.configuring_workflows.html.twig
diff --git a/core/modules/help_topics/help_topics/content_translation.overview.html.twig b/core/modules/help/help_topics/content_translation.overview.html.twig
similarity index 100%
rename from core/modules/help_topics/help_topics/content_translation.overview.html.twig
rename to core/modules/help/help_topics/content_translation.overview.html.twig
diff --git a/core/modules/help_topics/help_topics/contextual.overview.html.twig b/core/modules/help/help_topics/contextual.overview.html.twig
similarity index 100%
rename from core/modules/help_topics/help_topics/contextual.overview.html.twig
rename to core/modules/help/help_topics/contextual.overview.html.twig
diff --git a/core/modules/help_topics/help_topics/core.appearance.html.twig b/core/modules/help/help_topics/core.appearance.html.twig
similarity index 100%
rename from core/modules/help_topics/help_topics/core.appearance.html.twig
rename to core/modules/help/help_topics/core.appearance.html.twig
diff --git a/core/modules/help_topics/help_topics/core.config_overview.html.twig b/core/modules/help/help_topics/core.config_overview.html.twig
similarity index 100%
rename from core/modules/help_topics/help_topics/core.config_overview.html.twig
rename to core/modules/help/help_topics/core.config_overview.html.twig
diff --git a/core/modules/help_topics/help_topics/core.content_structure.html.twig b/core/modules/help/help_topics/core.content_structure.html.twig
similarity index 100%
rename from core/modules/help_topics/help_topics/core.content_structure.html.twig
rename to core/modules/help/help_topics/core.content_structure.html.twig
diff --git a/core/modules/help_topics/help_topics/core.cron.html.twig b/core/modules/help/help_topics/core.cron.html.twig
similarity index 100%
rename from core/modules/help_topics/help_topics/core.cron.html.twig
rename to core/modules/help/help_topics/core.cron.html.twig
diff --git a/core/modules/help_topics/help_topics/core.extending.html.twig b/core/modules/help/help_topics/core.extending.html.twig
similarity index 100%
rename from core/modules/help_topics/help_topics/core.extending.html.twig
rename to core/modules/help/help_topics/core.extending.html.twig
diff --git a/core/modules/help_topics/help_topics/core.maintenance.html.twig b/core/modules/help/help_topics/core.maintenance.html.twig
similarity index 100%
rename from core/modules/help_topics/help_topics/core.maintenance.html.twig
rename to core/modules/help/help_topics/core.maintenance.html.twig
diff --git a/core/modules/help_topics/help_topics/core.media.html.twig b/core/modules/help/help_topics/core.media.html.twig
similarity index 100%
rename from core/modules/help_topics/help_topics/core.media.html.twig
rename to core/modules/help/help_topics/core.media.html.twig
diff --git a/core/modules/help_topics/help_topics/core.menus.html.twig b/core/modules/help/help_topics/core.menus.html.twig
similarity index 100%
rename from core/modules/help_topics/help_topics/core.menus.html.twig
rename to core/modules/help/help_topics/core.menus.html.twig
diff --git a/core/modules/help_topics/help_topics/core.performance.html.twig b/core/modules/help/help_topics/core.performance.html.twig
similarity index 100%
rename from core/modules/help_topics/help_topics/core.performance.html.twig
rename to core/modules/help/help_topics/core.performance.html.twig
diff --git a/core/modules/help_topics/help_topics/core.security.html.twig b/core/modules/help/help_topics/core.security.html.twig
similarity index 100%
rename from core/modules/help_topics/help_topics/core.security.html.twig
rename to core/modules/help/help_topics/core.security.html.twig
diff --git a/core/modules/help_topics/help_topics/core.settings_tray.html.twig b/core/modules/help/help_topics/core.settings_tray.html.twig
similarity index 100%
rename from core/modules/help_topics/help_topics/core.settings_tray.html.twig
rename to core/modules/help/help_topics/core.settings_tray.html.twig
diff --git a/core/modules/help_topics/help_topics/core.tracking_content.html.twig b/core/modules/help/help_topics/core.tracking_content.html.twig
similarity index 100%
rename from core/modules/help_topics/help_topics/core.tracking_content.html.twig
rename to core/modules/help/help_topics/core.tracking_content.html.twig
diff --git a/core/modules/help_topics/help_topics/core.translations.html.twig b/core/modules/help/help_topics/core.translations.html.twig
similarity index 100%
rename from core/modules/help_topics/help_topics/core.translations.html.twig
rename to core/modules/help/help_topics/core.translations.html.twig
diff --git a/core/modules/help_topics/help_topics/core.ui_accessibility.html.twig b/core/modules/help/help_topics/core.ui_accessibility.html.twig
similarity index 100%
rename from core/modules/help_topics/help_topics/core.ui_accessibility.html.twig
rename to core/modules/help/help_topics/core.ui_accessibility.html.twig
diff --git a/core/modules/help_topics/help_topics/core.ui_components.html.twig b/core/modules/help/help_topics/core.ui_components.html.twig
similarity index 100%
rename from core/modules/help_topics/help_topics/core.ui_components.html.twig
rename to core/modules/help/help_topics/core.ui_components.html.twig
diff --git a/core/modules/help_topics/help_topics/core.web_services.html.twig b/core/modules/help/help_topics/core.web_services.html.twig
similarity index 100%
rename from core/modules/help_topics/help_topics/core.web_services.html.twig
rename to core/modules/help/help_topics/core.web_services.html.twig
diff --git a/core/modules/help_topics/help_topics/editor.overview.html.twig b/core/modules/help/help_topics/editor.overview.html.twig
similarity index 100%
rename from core/modules/help_topics/help_topics/editor.overview.html.twig
rename to core/modules/help/help_topics/editor.overview.html.twig
diff --git a/core/modules/help_topics/help_topics/field_ui.add_field.html.twig b/core/modules/help/help_topics/field_ui.add_field.html.twig
similarity index 100%
rename from core/modules/help_topics/help_topics/field_ui.add_field.html.twig
rename to core/modules/help/help_topics/field_ui.add_field.html.twig
diff --git a/core/modules/help_topics/help_topics/field_ui.manage_display.html.twig b/core/modules/help/help_topics/field_ui.manage_display.html.twig
similarity index 100%
rename from core/modules/help_topics/help_topics/field_ui.manage_display.html.twig
rename to core/modules/help/help_topics/field_ui.manage_display.html.twig
diff --git a/core/modules/help_topics/help_topics/field_ui.manage_form.html.twig b/core/modules/help/help_topics/field_ui.manage_form.html.twig
similarity index 100%
rename from core/modules/help_topics/help_topics/field_ui.manage_form.html.twig
rename to core/modules/help/help_topics/field_ui.manage_form.html.twig
diff --git a/core/modules/help_topics/help_topics/field_ui.reference_field.html.twig b/core/modules/help/help_topics/field_ui.reference_field.html.twig
similarity index 100%
rename from core/modules/help_topics/help_topics/field_ui.reference_field.html.twig
rename to core/modules/help/help_topics/field_ui.reference_field.html.twig
diff --git a/core/modules/help_topics/help_topics/filter.overview.html.twig b/core/modules/help/help_topics/filter.overview.html.twig
similarity index 100%
rename from core/modules/help_topics/help_topics/filter.overview.html.twig
rename to core/modules/help/help_topics/filter.overview.html.twig
diff --git a/core/modules/help_topics/help_topics/help.help_topic_search.html.twig b/core/modules/help/help_topics/help.help_topic_search.html.twig
similarity index 100%
rename from core/modules/help_topics/help_topics/help.help_topic_search.html.twig
rename to core/modules/help/help_topics/help.help_topic_search.html.twig
diff --git a/core/modules/help/help_topics/help.overview.html.twig b/core/modules/help/help_topics/help.overview.html.twig
new file mode 100644
index 0000000000000000000000000000000000000000..37f2c10dde3a79b1c112680e74877d4c97631700
--- /dev/null
+++ b/core/modules/help/help_topics/help.overview.html.twig
@@ -0,0 +1,26 @@
+---
+label: 'Working with help topics'
+top_level: true
+related:
+- help.help_topic_search
+- locale.translate_strings
+---
+{% set help_link_text %}{% trans %}Help{% endtrans %}{% endset %}
+{% set help_link = render_var(help_route_link(help_link_text, 'help.main')) %}
+{% set translate_text %}{% trans %}User interface translation{% endtrans %}{% endset %}
+{% set translate_link = render_var(help_route_link(translate_text, 'locale.translate_page')) %}
+{% set help_search_topic = render_var(help_topic_link('help.help_topic_search')) %}
+<h2>{% trans %}What is a help topic?{% endtrans %}</h2>
+<p>{% trans %}A help topic describes a concept, or steps to accomplish a task, related to a feature provided by one or more modules or themes. If the core Search module is enabled, these topics are also searchable.{% endtrans %}</p>
+<h2>{% trans %}Where are help topics listed?{% endtrans %}</h2>
+<p>{% trans %}The top-level help topics are listed at {{ help_link }}. Links to other topics, including non-top-level help topics, can be found under the "Related" heading when viewing a topic page.{% endtrans %}</p>
+<h2>{% trans %}How are help topics provided?{% endtrans %}</h2>
+<p>{% trans %}Modules and themes can provide help topics as Twig-file-based plugins in a project sub-directory called <em>help_topics</em>; plugin metadata is provided in YAML front matter within each Twig file. Plugin-based help topics provided by modules and themes will automatically be updated when a module or theme is updated. Use the plugins in <em>core/modules/help/help_topics</em> as a guide when writing and formatting a help topic plugin for your theme or module.{% endtrans %}</p>
+<h2>{% trans %}How are help topics translated?{% endtrans %}</h2>
+<p>{% trans %}The title and body text of help topics provided by contributed modules and themes are translatable using {{ translate_link }} (provided by Interface Translation module). Topics provided by custom modules and themes are also translatable if they have been viewed at least once in a non-English language, which triggers putting their translatable text into the translation database.{% endtrans %}</p>
+<h2>{% trans %}How can users search for help topics?{% endtrans %}</h2>
+<p>{% trans %}To enable users to search help, including help topics, you will need to install the core Search module, configure a search page, and add a search block to the Help page or another administrative page. (A search page is provided automatically, and if you use the core Claro administrative theme, a help search block is shown on the main Help page.) Then users with search permissions, and permission to view help, will be able to search help. See the related topic, {{ help_search_topic }}, for step-by-step instructions.{% endtrans %}</p>
+<h2>{% trans %}Additional resources{% endtrans %}</h2>
+<ul>
+ <li><a href="https://www.drupal.org/node/3074421">{% trans %}Help Topics Standards{% endtrans %}</a></li>
+</ul>
diff --git a/core/modules/help_topics/help_topics/history.tracking_user_content.html.twig b/core/modules/help/help_topics/history.tracking_user_content.html.twig
similarity index 100%
rename from core/modules/help_topics/help_topics/history.tracking_user_content.html.twig
rename to core/modules/help/help_topics/history.tracking_user_content.html.twig
diff --git a/core/modules/help_topics/help_topics/image.style.html.twig b/core/modules/help/help_topics/image.style.html.twig
similarity index 100%
rename from core/modules/help_topics/help_topics/image.style.html.twig
rename to core/modules/help/help_topics/image.style.html.twig
diff --git a/core/modules/help_topics/help_topics/language.add.html.twig b/core/modules/help/help_topics/language.add.html.twig
similarity index 100%
rename from core/modules/help_topics/help_topics/language.add.html.twig
rename to core/modules/help/help_topics/language.add.html.twig
diff --git a/core/modules/help_topics/help_topics/language.detect.html.twig b/core/modules/help/help_topics/language.detect.html.twig
similarity index 100%
rename from core/modules/help_topics/help_topics/language.detect.html.twig
rename to core/modules/help/help_topics/language.detect.html.twig
diff --git a/core/modules/help_topics/help_topics/layout_builder.overview.html.twig b/core/modules/help/help_topics/layout_builder.overview.html.twig
similarity index 100%
rename from core/modules/help_topics/help_topics/layout_builder.overview.html.twig
rename to core/modules/help/help_topics/layout_builder.overview.html.twig
diff --git a/core/modules/help_topics/help_topics/locale.import.html.twig b/core/modules/help/help_topics/locale.import.html.twig
similarity index 100%
rename from core/modules/help_topics/help_topics/locale.import.html.twig
rename to core/modules/help/help_topics/locale.import.html.twig
diff --git a/core/modules/help_topics/help_topics/locale.translate_strings.html.twig b/core/modules/help/help_topics/locale.translate_strings.html.twig
similarity index 100%
rename from core/modules/help_topics/help_topics/locale.translate_strings.html.twig
rename to core/modules/help/help_topics/locale.translate_strings.html.twig
diff --git a/core/modules/help_topics/help_topics/locale.translation_status.html.twig b/core/modules/help/help_topics/locale.translation_status.html.twig
similarity index 100%
rename from core/modules/help_topics/help_topics/locale.translation_status.html.twig
rename to core/modules/help/help_topics/locale.translation_status.html.twig
diff --git a/core/modules/help_topics/help_topics/media.media_type.html.twig b/core/modules/help/help_topics/media.media_type.html.twig
similarity index 100%
rename from core/modules/help_topics/help_topics/media.media_type.html.twig
rename to core/modules/help/help_topics/media.media_type.html.twig
diff --git a/core/modules/help_topics/help_topics/menu_ui.content_type_configuration.html.twig b/core/modules/help/help_topics/menu_ui.content_type_configuration.html.twig
similarity index 100%
rename from core/modules/help_topics/help_topics/menu_ui.content_type_configuration.html.twig
rename to core/modules/help/help_topics/menu_ui.content_type_configuration.html.twig
diff --git a/core/modules/help_topics/help_topics/menu_ui.menu_item_add.html.twig b/core/modules/help/help_topics/menu_ui.menu_item_add.html.twig
similarity index 100%
rename from core/modules/help_topics/help_topics/menu_ui.menu_item_add.html.twig
rename to core/modules/help/help_topics/menu_ui.menu_item_add.html.twig
diff --git a/core/modules/help_topics/help_topics/menu_ui.menu_operations.html.twig b/core/modules/help/help_topics/menu_ui.menu_operations.html.twig
similarity index 100%
rename from core/modules/help_topics/help_topics/menu_ui.menu_operations.html.twig
rename to core/modules/help/help_topics/menu_ui.menu_operations.html.twig
diff --git a/core/modules/help_topics/help_topics/menu_ui.overriding.html.twig b/core/modules/help/help_topics/menu_ui.overriding.html.twig
similarity index 100%
rename from core/modules/help_topics/help_topics/menu_ui.overriding.html.twig
rename to core/modules/help/help_topics/menu_ui.overriding.html.twig
diff --git a/core/modules/help_topics/help_topics/migrate.overview.html.twig b/core/modules/help/help_topics/migrate.overview.html.twig
similarity index 100%
rename from core/modules/help_topics/help_topics/migrate.overview.html.twig
rename to core/modules/help/help_topics/migrate.overview.html.twig
diff --git a/core/modules/help_topics/help_topics/migrate_drupal_ui.upgrading.html.twig b/core/modules/help/help_topics/migrate_drupal_ui.upgrading.html.twig
similarity index 100%
rename from core/modules/help_topics/help_topics/migrate_drupal_ui.upgrading.html.twig
rename to core/modules/help/help_topics/migrate_drupal_ui.upgrading.html.twig
diff --git a/core/modules/help_topics/help_topics/node.creating_content.html.twig b/core/modules/help/help_topics/node.creating_content.html.twig
similarity index 100%
rename from core/modules/help_topics/help_topics/node.creating_content.html.twig
rename to core/modules/help/help_topics/node.creating_content.html.twig
diff --git a/core/modules/help_topics/help_topics/node.creating_type.html.twig b/core/modules/help/help_topics/node.creating_type.html.twig
similarity index 100%
rename from core/modules/help_topics/help_topics/node.creating_type.html.twig
rename to core/modules/help/help_topics/node.creating_type.html.twig
diff --git a/core/modules/help_topics/help_topics/node.editing.html.twig b/core/modules/help/help_topics/node.editing.html.twig
similarity index 100%
rename from core/modules/help_topics/help_topics/node.editing.html.twig
rename to core/modules/help/help_topics/node.editing.html.twig
diff --git a/core/modules/help_topics/help_topics/node.overview.html.twig b/core/modules/help/help_topics/node.overview.html.twig
similarity index 100%
rename from core/modules/help_topics/help_topics/node.overview.html.twig
rename to core/modules/help/help_topics/node.overview.html.twig
diff --git a/core/modules/help_topics/help_topics/path.creating_alias.html.twig b/core/modules/help/help_topics/path.creating_alias.html.twig
similarity index 100%
rename from core/modules/help_topics/help_topics/path.creating_alias.html.twig
rename to core/modules/help/help_topics/path.creating_alias.html.twig
diff --git a/core/modules/help_topics/help_topics/path.editing_alias.html.twig b/core/modules/help/help_topics/path.editing_alias.html.twig
similarity index 100%
rename from core/modules/help_topics/help_topics/path.editing_alias.html.twig
rename to core/modules/help/help_topics/path.editing_alias.html.twig
diff --git a/core/modules/help_topics/help_topics/path.overview.html.twig b/core/modules/help/help_topics/path.overview.html.twig
similarity index 100%
rename from core/modules/help_topics/help_topics/path.overview.html.twig
rename to core/modules/help/help_topics/path.overview.html.twig
diff --git a/core/modules/help_topics/help_topics/responsive_image.style.html.twig b/core/modules/help/help_topics/responsive_image.style.html.twig
similarity index 100%
rename from core/modules/help_topics/help_topics/responsive_image.style.html.twig
rename to core/modules/help/help_topics/responsive_image.style.html.twig
diff --git a/core/modules/help_topics/help_topics/search.configuring.html.twig b/core/modules/help/help_topics/search.configuring.html.twig
similarity index 100%
rename from core/modules/help_topics/help_topics/search.configuring.html.twig
rename to core/modules/help/help_topics/search.configuring.html.twig
diff --git a/core/modules/help_topics/help_topics/search.index.html.twig b/core/modules/help/help_topics/search.index.html.twig
similarity index 100%
rename from core/modules/help_topics/help_topics/search.index.html.twig
rename to core/modules/help/help_topics/search.index.html.twig
diff --git a/core/modules/help_topics/help_topics/search.overview.html.twig b/core/modules/help/help_topics/search.overview.html.twig
similarity index 100%
rename from core/modules/help_topics/help_topics/search.overview.html.twig
rename to core/modules/help/help_topics/search.overview.html.twig
diff --git a/core/modules/help_topics/help_topics/shortcut.overview.html.twig b/core/modules/help/help_topics/shortcut.overview.html.twig
similarity index 100%
rename from core/modules/help_topics/help_topics/shortcut.overview.html.twig
rename to core/modules/help/help_topics/shortcut.overview.html.twig
diff --git a/core/modules/help_topics/help_topics/system.cache.html.twig b/core/modules/help/help_topics/system.cache.html.twig
similarity index 100%
rename from core/modules/help_topics/help_topics/system.cache.html.twig
rename to core/modules/help/help_topics/system.cache.html.twig
diff --git a/core/modules/help_topics/help_topics/system.config_basic.html.twig b/core/modules/help/help_topics/system.config_basic.html.twig
similarity index 100%
rename from core/modules/help_topics/help_topics/system.config_basic.html.twig
rename to core/modules/help/help_topics/system.config_basic.html.twig
diff --git a/core/modules/help_topics/help_topics/system.config_error.html.twig b/core/modules/help/help_topics/system.config_error.html.twig
similarity index 100%
rename from core/modules/help_topics/help_topics/system.config_error.html.twig
rename to core/modules/help/help_topics/system.config_error.html.twig
diff --git a/core/modules/help_topics/help_topics/system.maintenance_mode.html.twig b/core/modules/help/help_topics/system.maintenance_mode.html.twig
similarity index 100%
rename from core/modules/help_topics/help_topics/system.maintenance_mode.html.twig
rename to core/modules/help/help_topics/system.maintenance_mode.html.twig
diff --git a/core/modules/help_topics/help_topics/system.module_install.html.twig b/core/modules/help/help_topics/system.module_install.html.twig
similarity index 100%
rename from core/modules/help_topics/help_topics/system.module_install.html.twig
rename to core/modules/help/help_topics/system.module_install.html.twig
diff --git a/core/modules/help_topics/help_topics/system.module_uninstall.html.twig b/core/modules/help/help_topics/system.module_uninstall.html.twig
similarity index 100%
rename from core/modules/help_topics/help_topics/system.module_uninstall.html.twig
rename to core/modules/help/help_topics/system.module_uninstall.html.twig
diff --git a/core/modules/help_topics/help_topics/system.reports.html.twig b/core/modules/help/help_topics/system.reports.html.twig
similarity index 100%
rename from core/modules/help_topics/help_topics/system.reports.html.twig
rename to core/modules/help/help_topics/system.reports.html.twig
diff --git a/core/modules/help_topics/help_topics/system.theme_install.html.twig b/core/modules/help/help_topics/system.theme_install.html.twig
similarity index 100%
rename from core/modules/help_topics/help_topics/system.theme_install.html.twig
rename to core/modules/help/help_topics/system.theme_install.html.twig
diff --git a/core/modules/help_topics/help_topics/system.theme_uninstall.html.twig b/core/modules/help/help_topics/system.theme_uninstall.html.twig
similarity index 100%
rename from core/modules/help_topics/help_topics/system.theme_uninstall.html.twig
rename to core/modules/help/help_topics/system.theme_uninstall.html.twig
diff --git a/core/modules/help_topics/help_topics/taxonomy.configuring.html.twig b/core/modules/help/help_topics/taxonomy.configuring.html.twig
similarity index 100%
rename from core/modules/help_topics/help_topics/taxonomy.configuring.html.twig
rename to core/modules/help/help_topics/taxonomy.configuring.html.twig
diff --git a/core/modules/help_topics/help_topics/taxonomy.overview.html.twig b/core/modules/help/help_topics/taxonomy.overview.html.twig
similarity index 100%
rename from core/modules/help_topics/help_topics/taxonomy.overview.html.twig
rename to core/modules/help/help_topics/taxonomy.overview.html.twig
diff --git a/core/modules/help_topics/help_topics/tour.overview.html.twig b/core/modules/help/help_topics/tour.overview.html.twig
similarity index 100%
rename from core/modules/help_topics/help_topics/tour.overview.html.twig
rename to core/modules/help/help_topics/tour.overview.html.twig
diff --git a/core/modules/help_topics/help_topics/user.create.html.twig b/core/modules/help/help_topics/user.create.html.twig
similarity index 100%
rename from core/modules/help_topics/help_topics/user.create.html.twig
rename to core/modules/help/help_topics/user.create.html.twig
diff --git a/core/modules/help_topics/help_topics/user.new_role.html.twig b/core/modules/help/help_topics/user.new_role.html.twig
similarity index 100%
rename from core/modules/help_topics/help_topics/user.new_role.html.twig
rename to core/modules/help/help_topics/user.new_role.html.twig
diff --git a/core/modules/help_topics/help_topics/user.overview.html.twig b/core/modules/help/help_topics/user.overview.html.twig
similarity index 100%
rename from core/modules/help_topics/help_topics/user.overview.html.twig
rename to core/modules/help/help_topics/user.overview.html.twig
diff --git a/core/modules/help_topics/help_topics/user.permissions.html.twig b/core/modules/help/help_topics/user.permissions.html.twig
similarity index 100%
rename from core/modules/help_topics/help_topics/user.permissions.html.twig
rename to core/modules/help/help_topics/user.permissions.html.twig
diff --git a/core/modules/help_topics/help_topics/user.security_account_settings.html.twig b/core/modules/help/help_topics/user.security_account_settings.html.twig
similarity index 100%
rename from core/modules/help_topics/help_topics/user.security_account_settings.html.twig
rename to core/modules/help/help_topics/user.security_account_settings.html.twig
diff --git a/core/modules/help_topics/help_topics/user.update.html.twig b/core/modules/help/help_topics/user.update.html.twig
similarity index 100%
rename from core/modules/help_topics/help_topics/user.update.html.twig
rename to core/modules/help/help_topics/user.update.html.twig
diff --git a/core/modules/help_topics/help_topics/views.overview.html.twig b/core/modules/help/help_topics/views.overview.html.twig
similarity index 100%
rename from core/modules/help_topics/help_topics/views.overview.html.twig
rename to core/modules/help/help_topics/views.overview.html.twig
diff --git a/core/modules/help_topics/help_topics/views_ui.add_display.html.twig b/core/modules/help/help_topics/views_ui.add_display.html.twig
similarity index 100%
rename from core/modules/help_topics/help_topics/views_ui.add_display.html.twig
rename to core/modules/help/help_topics/views_ui.add_display.html.twig
diff --git a/core/modules/help_topics/help_topics/views_ui.bulk_operations.html.twig b/core/modules/help/help_topics/views_ui.bulk_operations.html.twig
similarity index 100%
rename from core/modules/help_topics/help_topics/views_ui.bulk_operations.html.twig
rename to core/modules/help/help_topics/views_ui.bulk_operations.html.twig
diff --git a/core/modules/help_topics/help_topics/views_ui.create.html.twig b/core/modules/help/help_topics/views_ui.create.html.twig
similarity index 100%
rename from core/modules/help_topics/help_topics/views_ui.create.html.twig
rename to core/modules/help/help_topics/views_ui.create.html.twig
diff --git a/core/modules/help_topics/help_topics/views_ui.edit.html.twig b/core/modules/help/help_topics/views_ui.edit.html.twig
similarity index 100%
rename from core/modules/help_topics/help_topics/views_ui.edit.html.twig
rename to core/modules/help/help_topics/views_ui.edit.html.twig
diff --git a/core/modules/help_topics/help_topics/workflows.overview.html.twig b/core/modules/help/help_topics/workflows.overview.html.twig
similarity index 100%
rename from core/modules/help_topics/help_topics/workflows.overview.html.twig
rename to core/modules/help/help_topics/workflows.overview.html.twig
diff --git a/core/modules/help/src/Controller/HelpTopicPluginController.php b/core/modules/help/src/Controller/HelpTopicPluginController.php
new file mode 100644
index 0000000000000000000000000000000000000000..5c22659cecb2eecfab0bc6fd5b404c0c6b8f7d27
--- /dev/null
+++ b/core/modules/help/src/Controller/HelpTopicPluginController.php
@@ -0,0 +1,99 @@
+<?php
+
+namespace Drupal\help\Controller;
+
+use Drupal\Component\Utility\SortArray;
+use Drupal\Core\Controller\ControllerBase;
+use Drupal\Core\Url;
+use Drupal\help\HelpTopicPluginManagerInterface;
+use Drupal\Core\Render\RendererInterface;
+use Symfony\Component\DependencyInjection\ContainerInterface;
+use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
+
+/**
+ * Controller for help topic plugins.
+ *
+ * @internal
+ * Controller classes are internal.
+ */
+class HelpTopicPluginController extends ControllerBase {
+
+ /**
+ * Constructs a HelpTopicPluginController object.
+ *
+ * @param \Drupal\help\HelpTopicPluginManagerInterface $helpTopicPluginManager
+ * The help topic plugin manager service.
+ * @param \Drupal\Core\Render\RendererInterface $renderer
+ * The renderer service.
+ */
+ public function __construct(protected HelpTopicPluginManagerInterface $helpTopicPluginManager, protected RendererInterface $renderer) {
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public static function create(ContainerInterface $container) {
+ return new static(
+ $container->get('plugin.manager.help_topic'),
+ $container->get('renderer')
+ );
+ }
+
+ /**
+ * Displays a help topic page.
+ *
+ * @param string $id
+ * The plugin ID. Maps to the {id} placeholder in the
+ * help.help_topic route.
+ *
+ * @return array
+ * A render array with the contents of a help topic page.
+ */
+ public function viewHelpTopic($id) {
+ $build = [];
+
+ if (!$this->helpTopicPluginManager->hasDefinition($id)) {
+ throw new NotFoundHttpException();
+ }
+ /** @var \Drupal\help\HelpTopicPluginInterface $help_topic */
+ $help_topic = $this->helpTopicPluginManager->createInstance($id);
+
+ $build['#body'] = $help_topic->getBody();
+
+ $this->renderer->addCacheableDependency($build, $help_topic);
+
+ // Build the related topics section, starting with the list this topic
+ // says are related.
+ $links = [];
+
+ $related = $help_topic->getRelated();
+ foreach ($related as $other_id) {
+ if ($other_id !== $id) {
+ /** @var \Drupal\help\HelpTopicPluginInterface $topic */
+ $topic = $this->helpTopicPluginManager->createInstance($other_id);
+ $links[$other_id] = [
+ 'title' => $topic->getLabel(),
+ 'url' => Url::fromRoute('help.help_topic', ['id' => $other_id]),
+ ];
+ $this->renderer->addCacheableDependency($build, $topic);
+ }
+ }
+
+ if (count($links)) {
+ uasort($links, [SortArray::class, 'sortByTitleElement']);
+ $build['#related'] = [
+ '#theme' => 'links__related',
+ '#heading' => [
+ 'text' => $this->t('Related topics'),
+ 'level' => 'h2',
+ ],
+ '#links' => $links,
+ ];
+ }
+
+ $build['#theme'] = 'help_topic';
+ $build['#title'] = $help_topic->getLabel();
+ return $build;
+ }
+
+}
diff --git a/core/modules/help/src/HelpBreadcrumbBuilder.php b/core/modules/help/src/HelpBreadcrumbBuilder.php
new file mode 100644
index 0000000000000000000000000000000000000000..b5fb69925109abfdf64ef7f54595b2d3914c93d2
--- /dev/null
+++ b/core/modules/help/src/HelpBreadcrumbBuilder.php
@@ -0,0 +1,39 @@
+<?php
+
+namespace Drupal\help;
+
+use Drupal\Core\Breadcrumb\Breadcrumb;
+use Drupal\Core\Breadcrumb\BreadcrumbBuilderInterface;
+use Drupal\Core\Link;
+use Drupal\Core\Routing\RouteMatchInterface;
+use Drupal\Core\StringTranslation\TranslatableMarkup;
+
+/**
+ * Provides a breadcrumb builder for help topic pages.
+ *
+ * @internal
+ * Tagged services are internal.
+ */
+class HelpBreadcrumbBuilder implements BreadcrumbBuilderInterface {
+
+ /**
+ * {@inheritdoc}
+ */
+ public function applies(RouteMatchInterface $route_match) {
+ return $route_match->getRouteName() == 'help.help_topic';
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function build(RouteMatchInterface $route_match) {
+ $breadcrumb = new Breadcrumb();
+ $breadcrumb->addCacheContexts(['url.path.parent']);
+ $breadcrumb->addLink(Link::createFromRoute(new TranslatableMarkup('Home'), '<front>'));
+ $breadcrumb->addLink(Link::createFromRoute(new TranslatableMarkup('Administration'), 'system.admin'));
+ $breadcrumb->addLink(Link::createFromRoute(new TranslatableMarkup('Help'), 'help.main'));
+
+ return $breadcrumb;
+ }
+
+}
diff --git a/core/modules/help/src/HelpSectionManager.php b/core/modules/help/src/HelpSectionManager.php
index d69a73e590d614a1bda2c6af34cbd44db2115e40..d8037e5082b7ebc729eb765cf2651a3b5f2ad259 100644
--- a/core/modules/help/src/HelpSectionManager.php
+++ b/core/modules/help/src/HelpSectionManager.php
@@ -2,6 +2,7 @@
namespace Drupal\help;
+use Drupal\Component\Plugin\PluginManagerInterface;
use Drupal\Core\Cache\CacheBackendInterface;
use Drupal\Core\Extension\ModuleHandlerInterface;
use Drupal\Core\Plugin\DefaultPluginManager;
@@ -16,6 +17,13 @@
*/
class HelpSectionManager extends DefaultPluginManager {
+ /**
+ * The search manager.
+ *
+ * @var \Drupal\Component\Plugin\PluginManagerInterface
+ */
+ protected ?PluginManagerInterface $searchManager = NULL;
+
/**
* Constructs a new HelpSectionManager.
*
@@ -34,4 +42,29 @@ public function __construct(\Traversable $namespaces, CacheBackendInterface $cac
$this->setCacheBackend($cache_backend, 'help_section_plugins');
}
+ /**
+ * Sets the search manager.
+ *
+ * @param \Drupal\Component\Plugin\PluginManagerInterface|null $search_manager
+ * The search manager if the Search module is installed.
+ */
+ public function setSearchManager(?PluginManagerInterface $search_manager = NULL) {
+ $this->searchManager = $search_manager;
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function clearCachedDefinitions() {
+ parent::clearCachedDefinitions();
+ $version = \Drupal::service('update.update_hook_registry')->getInstalledVersion('help');
+ if ($this->searchManager && $version >= 10100) {
+ // Rebuild the index on cache clear so that new help topics are indexed
+ // and any changes due to help topics edits or translation changes are
+ // picked up.
+ $help_search = $this->searchManager->createInstance('help_search');
+ $help_search->markForReindex();
+ }
+ }
+
}
diff --git a/core/modules/help/src/HelpTopicDiscovery.php b/core/modules/help/src/HelpTopicDiscovery.php
new file mode 100644
index 0000000000000000000000000000000000000000..afac85fe6e7ee9b50e2ce02a1e1a0fd0b3833745
--- /dev/null
+++ b/core/modules/help/src/HelpTopicDiscovery.php
@@ -0,0 +1,183 @@
+<?php
+
+namespace Drupal\help;
+
+use Drupal\Component\Discovery\DiscoveryException;
+use Drupal\Component\FileCache\FileCacheFactory;
+use Drupal\Component\FileSystem\RegexDirectoryIterator;
+use Drupal\Component\FrontMatter\FrontMatter;
+use Drupal\Component\Plugin\Discovery\DiscoveryInterface;
+use Drupal\Component\Plugin\Discovery\DiscoveryTrait;
+use Drupal\Component\Serialization\Exception\InvalidDataTypeException;
+use Drupal\Core\Serialization\Yaml;
+use Drupal\Core\StringTranslation\TranslatableMarkup;
+
+/**
+ * Discovers help topic plugins from Twig files in help_topics directories.
+ *
+ * @see \Drupal\help\HelpTopicTwig
+ * @see \Drupal\help\HelpTopicTwigLoader
+ *
+ * @internal
+ * Tagged services are internal.
+ */
+class HelpTopicDiscovery implements DiscoveryInterface {
+
+ use DiscoveryTrait;
+
+ /**
+ * Defines the key in the discovered data where the file path is stored.
+ */
+ const FILE_KEY = '_discovered_file_path';
+
+ /**
+ * An array of directories to scan, keyed by the provider.
+ *
+ * The value can either be a string or an array of strings. The string values
+ * should be the path of a directory to scan.
+ *
+ * @var array
+ */
+ protected $directories = [];
+
+ /**
+ * Constructs a HelpTopicDiscovery object.
+ *
+ * @param array $directories
+ * An array of directories to scan, keyed by the provider. The value can
+ * either be a string or an array of strings. The string values should be
+ * the path of a directory to scan.
+ */
+ public function __construct(array $directories) {
+ $this->directories = $directories;
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function getDefinitions() {
+ $plugins = $this->findAll();
+
+ // Flatten definitions into what's expected from plugins.
+ $definitions = [];
+ foreach ($plugins as $list) {
+ foreach ($list as $id => $definition) {
+ $definitions[$id] = $definition;
+ }
+ }
+
+ return $definitions;
+ }
+
+ /**
+ * Returns an array of discoverable items.
+ *
+ * @return array
+ * An array of discovered data keyed by provider.
+ *
+ * @throws \Drupal\Component\Discovery\DiscoveryException
+ * Exception thrown if there is a problem during discovery.
+ */
+ public function findAll() {
+ $all = [];
+
+ $files = $this->findFiles();
+
+ $file_cache = FileCacheFactory::get('help_topic_discovery:help_topics');
+
+ // Try to load from the file cache first.
+ foreach ($file_cache->getMultiple(array_keys($files)) as $file => $data) {
+ $all[$files[$file]][$data['id']] = $data;
+ unset($files[$file]);
+ }
+
+ // If there are files left that were not returned from the cache, load and
+ // parse them now. This list was flipped above and is keyed by filename.
+ if ($files) {
+ foreach ($files as $file => $provider) {
+ $plugin_id = substr(basename($file), 0, -10);
+ // The plugin ID begins with provider.
+ [$file_name_provider] = explode('.', $plugin_id, 2);
+ // Only the Help module can provide topics for other extensions.
+ // @todo https://www.drupal.org/i/3025577 Remove help special case once
+ // all Help Topics are moved to their own modules.
+ if ($provider !== 'help' && $provider !== $file_name_provider) {
+ throw new DiscoveryException("$file file name should begin with '$provider'");
+ }
+ $data = [
+ // The plugin ID is derived from the filename. The extension
+ // '.html.twig' is removed.
+ 'id' => $plugin_id,
+ 'provider' => $file_name_provider,
+ 'class' => HelpTopicTwig::class,
+ static::FILE_KEY => $file,
+ ];
+
+ // Get the rest of the plugin definition from front matter contained in
+ // the help topic Twig file.
+ try {
+ $front_matter = FrontMatter::create(file_get_contents($file), Yaml::class)->getData();
+ }
+ catch (InvalidDataTypeException $e) {
+ throw new DiscoveryException(sprintf('Malformed YAML in help topic "%s": %s.', $file, $e->getMessage()));
+ }
+ foreach ($front_matter as $key => $value) {
+ switch ($key) {
+ case 'related':
+ if (!is_array($value)) {
+ throw new DiscoveryException("$file contains invalid value for 'related' key, the value must be an array of strings");
+ }
+ $data[$key] = $value;
+ break;
+
+ case 'top_level':
+ if (!is_bool($value)) {
+ throw new DiscoveryException("$file contains invalid value for 'top_level' key, the value must be a Boolean");
+ }
+ $data[$key] = $value;
+ break;
+
+ case 'label':
+ $data[$key] = new TranslatableMarkup($value);
+ break;
+
+ default:
+ throw new DiscoveryException("$file contains invalid key='$key'");
+ }
+ }
+ if (!isset($data['label'])) {
+ throw new DiscoveryException("$file does not contain the required key with name='label'");
+ }
+
+ $all[$provider][$data['id']] = $data;
+ $file_cache->set($file, $data);
+ }
+ }
+
+ return $all;
+ }
+
+ /**
+ * Returns an array of providers keyed by file path.
+ *
+ * @return array
+ * An array of providers keyed by file path.
+ */
+ protected function findFiles() {
+ $file_list = [];
+ foreach ($this->directories as $provider => $directories) {
+ $directories = (array) $directories;
+ foreach ($directories as $directory) {
+ if (is_dir($directory)) {
+ /** @var \SplFileInfo $fileInfo */
+ $iterator = new RegexDirectoryIterator($directory, '/\.html\.twig$/i');
+ foreach ($iterator as $fileInfo) {
+ $file_list[$fileInfo->getPathname()] = $provider;
+ }
+ }
+ }
+ }
+ return $file_list;
+ }
+
+}
diff --git a/core/modules/help/src/HelpTopicPluginBase.php b/core/modules/help/src/HelpTopicPluginBase.php
new file mode 100644
index 0000000000000000000000000000000000000000..55841c645641c01543452ba20bb70aaa809c89ef
--- /dev/null
+++ b/core/modules/help/src/HelpTopicPluginBase.php
@@ -0,0 +1,62 @@
+<?php
+
+namespace Drupal\help;
+
+use Drupal\Core\Link;
+use Drupal\Core\Plugin\PluginBase;
+use Drupal\Core\Url;
+
+/**
+ * Base class for help topic plugins.
+ *
+ * @internal
+ * Plugin classes are internal.
+ */
+abstract class HelpTopicPluginBase extends PluginBase implements HelpTopicPluginInterface {
+
+ /**
+ * The name of the module or theme providing the help topic.
+ */
+ public function getProvider() {
+ return $this->pluginDefinition['provider'];
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function getLabel() {
+ return $this->pluginDefinition['label'];
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function isTopLevel() {
+ return $this->pluginDefinition['top_level'];
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function getRelated() {
+ return $this->pluginDefinition['related'];
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function toUrl(array $options = []) {
+ return Url::fromRoute('help.help_topic', ['id' => $this->getPluginId()], $options);
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function toLink($text = NULL, array $options = []) {
+ if (!$text) {
+ $text = $this->getLabel();
+ }
+ return Link::createFromRoute($text, 'help.help_topic', ['id' => $this->getPluginId()], $options);
+ }
+
+}
diff --git a/core/modules/help/src/HelpTopicPluginInterface.php b/core/modules/help/src/HelpTopicPluginInterface.php
new file mode 100644
index 0000000000000000000000000000000000000000..e82ecac41d898963a7dcd0d9cc6e038a9df156c8
--- /dev/null
+++ b/core/modules/help/src/HelpTopicPluginInterface.php
@@ -0,0 +1,78 @@
+<?php
+
+namespace Drupal\help;
+
+use Drupal\Component\Plugin\PluginInspectionInterface;
+use Drupal\Component\Plugin\DerivativeInspectionInterface;
+use Drupal\Core\Cache\CacheableDependencyInterface;
+
+/**
+ * Defines an interface for help topic plugin classes.
+ *
+ * @see \Drupal\help\HelpTopicPluginManager
+ */
+interface HelpTopicPluginInterface extends PluginInspectionInterface, DerivativeInspectionInterface, CacheableDependencyInterface {
+
+ /**
+ * Returns the label of the topic.
+ *
+ * @return string
+ * The label of the topic.
+ */
+ public function getLabel();
+
+ /**
+ * Returns the body of the topic.
+ *
+ * @return array
+ * A render array representing the body.
+ */
+ public function getBody();
+
+ /**
+ * Returns whether this is a top-level topic or not.
+ *
+ * @return bool
+ * TRUE if this is a topic that should be displayed on the Help topics
+ * list; FALSE if not.
+ */
+ public function isTopLevel();
+
+ /**
+ * Returns the IDs of related topics.
+ *
+ * @return string[]
+ * Array of the IDs of related topics.
+ */
+ public function getRelated();
+
+ /**
+ * Returns the URL for viewing the help topic.
+ *
+ * @param array $options
+ * (optional) See
+ * \Drupal\Core\Routing\UrlGeneratorInterface::generateFromRoute() for the
+ * available options.
+ *
+ * @return \Drupal\Core\Url
+ * A URL object containing the URL for viewing the help topic.
+ */
+ public function toUrl(array $options = []);
+
+ /**
+ * Returns a link for viewing the help topic.
+ *
+ * @param string|null $text
+ * (optional) Link text to use for the link. If NULL, defaults to the
+ * topic title.
+ * @param array $options
+ * (optional) See
+ * \Drupal\Core\Routing\UrlGeneratorInterface::generateFromRoute() for the
+ * available options.
+ *
+ * @return \Drupal\Core\Link
+ * A link object for viewing the topic.
+ */
+ public function toLink($text = NULL, array $options = []);
+
+}
diff --git a/core/modules/help/src/HelpTopicPluginManager.php b/core/modules/help/src/HelpTopicPluginManager.php
new file mode 100644
index 0000000000000000000000000000000000000000..5c95d8ed3fb74cd3a4cfb6b90493b95c1ad2dbad
--- /dev/null
+++ b/core/modules/help/src/HelpTopicPluginManager.php
@@ -0,0 +1,173 @@
+<?php
+
+namespace Drupal\help;
+
+use Drupal\Core\Cache\CacheBackendInterface;
+use Drupal\Core\Extension\ModuleHandlerInterface;
+use Drupal\Core\Extension\ThemeHandlerInterface;
+use Drupal\Core\Plugin\DefaultPluginManager;
+use Drupal\Core\Plugin\Discovery\YamlDiscoveryDecorator;
+use Drupal\Core\Plugin\Discovery\ContainerDerivativeDiscoveryDecorator;
+
+/**
+ * Provides the default help_topic manager.
+ *
+ * Modules and themes can provide help topics in .html.twig files called
+ * provider.name_of_topic.html.twig inside the module or theme sub-directory
+ * help_topics. The provider is validated to be the extension that provides the
+ * help topic.
+ *
+ * The Twig file must contain YAML front matter with a key named 'label'. It can
+ * also contain keys named 'top_level' and 'related'. For example:
+ * @code
+ * ---
+ * label: 'Configuring error responses, including 403/404 pages'
+ *
+ * # Related help topics in an array.
+ * related:
+ * - core.config_basic
+ * - core.maintenance
+ *
+ * # If the value is true then the help topic will appear on admin/help.
+ * top_level: true
+ * ---
+ * @endcode
+ *
+ * In addition, modules wishing to add plugins can define them in a
+ * module_name.help_topics.yml file, with the plugin ID as the heading for
+ * each entry, and these properties:
+ * - id: The plugin ID.
+ * - class: The name of your plugin class, implementing
+ * \Drupal\help\HelpTopicPluginInterface.
+ * - top_level: TRUE if the topic is top-level.
+ * - related: Array of IDs of topics this one is related to.
+ * - Additional properties that your plugin class needs, such as 'label'.
+ *
+ * You can also provide an entry that designates a plugin deriver class in your
+ * help_topics.yml file, with a heading giving a prefix ID for your group of
+ * derived plugins, and a 'deriver' property giving the name of a class
+ * implementing \Drupal\Component\Plugin\Derivative\DeriverInterface. Example:
+ * @code
+ * mymodule_prefix:
+ * deriver: 'Drupal\mymodule\Plugin\Deriver\HelpTopicDeriver'
+ * @endcode
+ *
+ * @ingroup help_docs
+ *
+ * @see \Drupal\help\HelpTopicDiscovery
+ * @see \Drupal\help\HelpTopicTwig
+ * @see \Drupal\help\HelpTopicTwigLoader
+ * @see \Drupal\help\HelpTopicPluginInterface
+ * @see \Drupal\help\HelpTopicPluginBase
+ * @see hook_help_topics_info_alter()
+ * @see plugin_api
+ * @see \Drupal\Component\Plugin\Derivative\DeriverInterface
+ */
+class HelpTopicPluginManager extends DefaultPluginManager implements HelpTopicPluginManagerInterface {
+
+ /**
+ * Provides default values for all help topic plugins.
+ *
+ * @var array
+ */
+ protected $defaults = [
+ // The plugin ID.
+ 'id' => '',
+ // The title of the help topic plugin.
+ 'label' => '',
+ // Whether or not the topic should appear on the help topics list.
+ 'top_level' => '',
+ // List of related topic machine names.
+ 'related' => [],
+ // The class used to instantiate the plugin.
+ 'class' => '',
+ ];
+
+ /**
+ * Constructs a new HelpTopicManager object.
+ *
+ * @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
+ * The module handler.
+ * @param \Drupal\Core\Extension\ThemeHandlerInterface $themeHandler
+ * The theme handler.
+ * @param \Drupal\Core\Cache\CacheBackendInterface $cache_backend
+ * Cache backend instance to use.
+ * @param string $root
+ * The app root.
+ */
+ public function __construct(ModuleHandlerInterface $module_handler, protected ThemeHandlerInterface $themeHandler, CacheBackendInterface $cache_backend, protected string $root) {
+ // Note that the parent construct is not called because this class does not use
+ // annotated class discovery.
+ $this->moduleHandler = $module_handler;
+ $this->alterInfo('help_topics_info');
+ // Use the 'config:core.extension' cache tag so the plugin cache is
+ // invalidated on theme install and uninstall.
+ $this->setCacheBackend($cache_backend, 'help_topics', ['config:core.extension']);
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ protected function getDiscovery() {
+ if (!isset($this->discovery)) {
+ $module_directories = $this->moduleHandler->getModuleDirectories();
+ $all_directories = array_merge(
+ ['core' => $this->root . '/core'],
+ $module_directories,
+ $this->themeHandler->getThemeDirectories()
+ );
+
+ // Search for Twig help topics in subdirectory help_topics, under
+ // modules/profiles, themes, and the core directory.
+ $all_directories = array_map(function ($dir) {
+ return [$dir . '/help_topics'];
+ }, $all_directories);
+ $discovery = new HelpTopicDiscovery($all_directories);
+
+ // Also allow modules/profiles to extend help topic discovery to their
+ // own plugins and derivers, in mymodule.help_topics.yml files.
+ $discovery = new YamlDiscoveryDecorator($discovery, 'help_topics', $module_directories);
+ $discovery = new ContainerDerivativeDiscoveryDecorator($discovery);
+ $this->discovery = $discovery;
+ }
+ return $this->discovery;
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ protected function providerExists($provider) {
+ return $this->moduleHandler->moduleExists($provider) || $this->themeHandler->themeExists($provider);
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ protected function findDefinitions() {
+ $definitions = parent::findDefinitions();
+
+ // At this point the plugin list only contains valid plugins. Ensure all
+ // related plugins exist and the relationship is bi-directional. This
+ // ensures topics are listed on their related topics.
+ foreach ($definitions as $plugin_id => $plugin_definition) {
+ foreach ($plugin_definition['related'] as $key => $related_id) {
+ // If the related help topic does not exist it might be for a module
+ // that is not installed. Remove it.
+ // @todo Discuss this more as this could cause silent errors but it
+ // offers useful functionality to relate to a help topic provided by
+ // extensions that are yet to be installed.
+ // https://www.drupal.org/i/3360133
+ if (!isset($definitions[$related_id])) {
+ unset($definitions[$plugin_id]['related'][$key]);
+ continue;
+ }
+ // Make the related relationship bi-directional.
+ if (isset($definitions[$related_id]) && !in_array($plugin_id, $definitions[$related_id]['related'], TRUE)) {
+ $definitions[$related_id]['related'][] = $plugin_id;
+ }
+ }
+ }
+ return $definitions;
+ }
+
+}
diff --git a/core/modules/help/src/HelpTopicPluginManagerInterface.php b/core/modules/help/src/HelpTopicPluginManagerInterface.php
new file mode 100644
index 0000000000000000000000000000000000000000..347e222dbd544fdd02ff656b6c16a0b5fc4466fb
--- /dev/null
+++ b/core/modules/help/src/HelpTopicPluginManagerInterface.php
@@ -0,0 +1,11 @@
+<?php
+
+namespace Drupal\help;
+
+use Drupal\Component\Plugin\PluginManagerInterface;
+
+/**
+ * Defines an interface for managing help topics and storing their definitions.
+ */
+interface HelpTopicPluginManagerInterface extends PluginManagerInterface {
+}
diff --git a/core/modules/help/src/HelpTopicTwig.php b/core/modules/help/src/HelpTopicTwig.php
new file mode 100644
index 0000000000000000000000000000000000000000..67f6b1b2ab7772f6281d16d94a6aff879048696e
--- /dev/null
+++ b/core/modules/help/src/HelpTopicTwig.php
@@ -0,0 +1,80 @@
+<?php
+
+namespace Drupal\help;
+
+use Drupal\Core\Cache\Cache;
+use Drupal\Core\Plugin\ContainerFactoryPluginInterface;
+use Drupal\Core\Template\TwigEnvironment;
+use Symfony\Component\DependencyInjection\ContainerInterface;
+
+/**
+ * Represents a help topic plugin whose definition comes from a Twig file.
+ *
+ * @see \Drupal\help\HelpTopicDiscovery
+ * @see \Drupal\help\HelpTopicTwigLoader
+ * @see \Drupal\help\HelpTopicPluginManager
+ *
+ * @internal
+ * Plugin classes are internal.
+ */
+class HelpTopicTwig extends HelpTopicPluginBase implements ContainerFactoryPluginInterface {
+
+ /**
+ * HelpTopicPluginBase constructor.
+ *
+ * @param array $configuration
+ * A configuration array containing information about the plugin instance.
+ * @param string $plugin_id
+ * The plugin_id for the plugin instance.
+ * @param mixed $plugin_definition
+ * The plugin implementation definition.
+ * @param \Drupal\Core\Template\TwigEnvironment $twig
+ * The Twig environment.
+ */
+ public function __construct(array $configuration, $plugin_id, $plugin_definition, protected TwigEnvironment $twig) {
+ parent::__construct($configuration, $plugin_id, $plugin_definition);
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
+ return new static(
+ $configuration,
+ $plugin_id,
+ $plugin_definition,
+ $container->get('twig')
+ );
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function getBody() {
+ return [
+ '#markup' => $this->twig->load('@help_topics/' . $this->getPluginId() . '.html.twig')->render(),
+ ];
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function getCacheContexts() {
+ return [];
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function getCacheTags() {
+ return ['core.extension'];
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function getCacheMaxAge() {
+ return Cache::PERMANENT;
+ }
+
+}
diff --git a/core/modules/help/src/HelpTopicTwigLoader.php b/core/modules/help/src/HelpTopicTwigLoader.php
new file mode 100644
index 0000000000000000000000000000000000000000..743015f9e5384f3a5e8811db55106461ea023e65
--- /dev/null
+++ b/core/modules/help/src/HelpTopicTwigLoader.php
@@ -0,0 +1,110 @@
+<?php
+
+namespace Drupal\help;
+
+use Drupal\Component\FrontMatter\FrontMatter;
+use Drupal\Component\Serialization\Exception\InvalidDataTypeException;
+use Drupal\Core\Extension\ModuleHandlerInterface;
+use Drupal\Core\Extension\ThemeHandlerInterface;
+use Drupal\Core\Serialization\Yaml;
+use Twig\Error\LoaderError;
+use Twig\Loader\FilesystemLoader;
+use Twig\Source;
+
+/**
+ * Loads help topic Twig files from the filesystem.
+ *
+ * This loader adds module and theme help topic paths to a help_topics namespace
+ * to the Twig filesystem loader so that help_topics can be referenced, using
+ * '@help-topic/pluginId.html.twig'.
+ *
+ * @see \Drupal\help\HelpTopicDiscovery
+ * @see \Drupal\help\HelpTopicTwig
+ *
+ * @internal
+ * Tagged services are internal.
+ */
+class HelpTopicTwigLoader extends FilesystemLoader {
+
+ /**
+ * {@inheritdoc}
+ */
+ const MAIN_NAMESPACE = 'help_topics';
+
+ /**
+ * Constructs a new HelpTopicTwigLoader object.
+ *
+ * @param string $root_path
+ * The root path.
+ * @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
+ * The module handler service.
+ * @param \Drupal\Core\Extension\ThemeHandlerInterface $theme_handler
+ * The theme handler service.
+ */
+ public function __construct($root_path, ModuleHandlerInterface $module_handler, ThemeHandlerInterface $theme_handler) {
+ parent::__construct([], $root_path);
+ // Add help_topics directories for modules and themes in the 'help_topic'
+ // namespace, plus core.
+ $this->addExtension($root_path . '/core');
+ array_map([$this, 'addExtension'], $module_handler->getModuleDirectories());
+ array_map([$this, 'addExtension'], $theme_handler->getThemeDirectories());
+ }
+
+ /**
+ * Adds an extensions help_topics directory to the Twig loader.
+ *
+ * @param $path
+ * The path to the extension.
+ */
+ protected function addExtension($path) {
+ $path .= DIRECTORY_SEPARATOR . 'help_topics';
+ if (is_dir($path)) {
+ $this->cache = $this->errorCache = [];
+ $this->paths[self::MAIN_NAMESPACE][] = rtrim($path, '/\\');
+ }
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function getSourceContext(string $name): Source {
+ $path = $this->findTemplate($name);
+
+ $contents = file_get_contents($path);
+ try {
+ // Note: always use \Drupal\Core\Serialization\Yaml here instead of the
+ // "serializer.yaml" service. This allows the core serializer to utilize
+ // core related functionality which isn't available as the standalone
+ // component based serializer.
+ $front_matter = new FrontMatter($contents, Yaml::class);
+
+ // Reconstruct the content if there is front matter data detected. Prepend
+ // the source with {% line \d+ %} to inform Twig that the source code
+ // actually starts on a different line past the front matter data. This is
+ // particularly useful when used in error reporting.
+ if ($front_matter->getData() && ($line = $front_matter->getLine())) {
+ $contents = "{% line $line %}" . $front_matter->getContent();
+ }
+ }
+ catch (InvalidDataTypeException $e) {
+ throw new LoaderError(sprintf('Malformed YAML in help topic "%s": %s.', $path, $e->getMessage()));
+ }
+
+ return new Source($contents, $name, $path);
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ protected function findTemplate($name, $throw = TRUE) {
+ if (!str_ends_with($name, '.html.twig')) {
+ if (!$throw) {
+ return NULL;
+ }
+ $extension = pathinfo($name, PATHINFO_EXTENSION);
+ throw new LoaderError(sprintf("Help topic %s has an invalid file extension (%s). Only help topics ending .html.twig are allowed.", $name, $extension));
+ }
+ return parent::findTemplate($name, $throw);
+ }
+
+}
diff --git a/core/modules/help/src/HelpTwigExtension.php b/core/modules/help/src/HelpTwigExtension.php
new file mode 100644
index 0000000000000000000000000000000000000000..fdd0085ee1e279ca1dc38ff8687b6d8f706b9324
--- /dev/null
+++ b/core/modules/help/src/HelpTwigExtension.php
@@ -0,0 +1,153 @@
+<?php
+
+namespace Drupal\help;
+
+use Drupal\Component\Plugin\Exception\PluginNotFoundException;
+use Drupal\Core\Access\AccessManagerInterface;
+use Drupal\Core\Render\BubbleableMetadata;
+use Drupal\Core\StringTranslation\StringTranslationTrait;
+use Drupal\Core\StringTranslation\TranslationInterface;
+use Drupal\Core\Url;
+use Symfony\Component\Routing\Exception\InvalidParameterException;
+use Symfony\Component\Routing\Exception\MissingMandatoryParametersException;
+use Symfony\Component\Routing\Exception\RouteNotFoundException;
+use Twig\Extension\AbstractExtension;
+use Twig\TwigFunction;
+
+/**
+ * Defines and registers Drupal Twig extensions for rendering help topics.
+ *
+ * @internal
+ * Tagged services are internal.
+ */
+class HelpTwigExtension extends AbstractExtension {
+
+ use StringTranslationTrait;
+
+ /**
+ * Constructs a \Drupal\help\HelpTwigExtension.
+ *
+ * @param \Drupal\Core\Access\AccessManagerInterface $accessManager
+ * The access manager.
+ * @param \Drupal\help\HelpTopicPluginManagerInterface $pluginManager
+ * The help topic plugin manager service.
+ * @param \Drupal\Core\StringTranslation\TranslationInterface $string_translation
+ * The string translation service.
+ */
+ public function __construct(protected AccessManagerInterface $accessManager, protected HelpTopicPluginManagerInterface $pluginManager, TranslationInterface $string_translation) {
+ $this->stringTranslation = $string_translation;
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function getFunctions() {
+ return [
+ new TwigFunction('help_route_link', [$this, 'getRouteLink']),
+ new TwigFunction('help_topic_link', [$this, 'getTopicLink']),
+ ];
+ }
+
+ /**
+ * Returns a link or plain text, given text, route name, and parameters.
+ *
+ * @param string $text
+ * The link text.
+ * @param string $route
+ * The name of the route.
+ * @param array $parameters
+ * (optional) An associative array of route parameter names and values.
+ * @param array $options
+ * (optional) An associative array of additional options. The 'absolute'
+ * option is forced to be TRUE.
+ *
+ * @return array
+ * A render array with a generated absolute link to the given route. If
+ * the user does not have permission for the route, or an exception occurs,
+ * such as a missing route or missing parameters, the render array is for
+ * the link text as a plain string instead.
+ *
+ * @see \Drupal\Core\Template\TwigExtension::getUrl()
+ */
+ public function getRouteLink(string $text, string $route, array $parameters = [], array $options = []): array {
+ assert($this->accessManager instanceof AccessManagerInterface, "The access manager hasn't been set up. Any configuration YAML file with a service directive dealing with the Twig configuration can cause this, most likely found in a recently installed or changed module.");
+
+ $bubbles = new BubbleableMetadata();
+ $bubbles->addCacheTags(['route_match']);
+
+ try {
+ $access_object = $this->accessManager->checkNamedRoute($route, $parameters, NULL, TRUE);
+ $bubbles->addCacheableDependency($access_object);
+
+ if ($access_object->isAllowed()) {
+ $options['absolute'] = TRUE;
+ $url = Url::fromRoute($route, $parameters, $options);
+ // Generate the URL to check for parameter problems and collect
+ // cache metadata.
+ $generated = $url->toString(TRUE);
+ $bubbles->addCacheableDependency($generated);
+ $build = [
+ '#title' => $text,
+ '#type' => 'link',
+ '#url' => $url,
+ ];
+ }
+ else {
+ // If the user doesn't have access, return the link text.
+ $build = ['#markup' => $text];
+ }
+ }
+ catch (RouteNotFoundException | MissingMandatoryParametersException | InvalidParameterException $e) {
+ // If the route had one of these exceptions, return the link text.
+ $build = ['#markup' => $text];
+ }
+ $bubbles->applyTo($build);
+ return $build;
+ }
+
+ /**
+ * Returns a link to a help topic, or the title of the topic.
+ *
+ * @param string $topic_id
+ * The help topic ID.
+ *
+ * @return array
+ * A render array with a generated absolute link to the given topic. If
+ * the user does not have permission to view the topic, or an exception
+ * occurs, such as the topic not being defined due to a module not being
+ * installed, a default string is returned.
+ *
+ * @see \Drupal\Core\Template\TwigExtension::getUrl()
+ */
+ public function getTopicLink(string $topic_id): array {
+ assert($this->pluginManager instanceof HelpTopicPluginManagerInterface, "The plugin manager hasn't been set up. Any configuration YAML file with a service directive dealing with the Twig configuration can cause this, most likely found in a recently installed or changed module.");
+
+ $bubbles = new BubbleableMetadata();
+ $bubbles->addCacheableDependency($this->pluginManager);
+ try {
+ $plugin = $this->pluginManager->createInstance($topic_id);
+ }
+ catch (PluginNotFoundException $e) {
+ // Not a topic.
+ $plugin = FALSE;
+ }
+
+ if ($plugin) {
+ $parameters = ['id' => $topic_id];
+ $route = 'help.help_topic';
+ $build = $this->getRouteLink($plugin->getLabel(), $route, $parameters);
+ $bubbles->addCacheableDependency($plugin);
+ }
+ else {
+ $build = [
+ '#markup' => $this->t('Missing help topic %topic', [
+ '%topic' => $topic_id,
+ ]),
+ ];
+ }
+
+ $bubbles->applyTo($build);
+ return $build;
+ }
+
+}
diff --git a/core/modules/help/src/Plugin/HelpSection/HelpTopicSection.php b/core/modules/help/src/Plugin/HelpSection/HelpTopicSection.php
new file mode 100644
index 0000000000000000000000000000000000000000..4d482269cd528bb9a9953fc160aa3f6b2a0fe8a9
--- /dev/null
+++ b/core/modules/help/src/Plugin/HelpSection/HelpTopicSection.php
@@ -0,0 +1,241 @@
+<?php
+
+namespace Drupal\help\Plugin\HelpSection;
+
+use Drupal\Core\Cache\CacheableMetadata;
+use Drupal\help\SearchableHelpInterface;
+use Drupal\help\HelpTopicPluginInterface;
+use Drupal\help\HelpTopicPluginManagerInterface;
+use Drupal\Core\Language\LanguageDefault;
+use Drupal\Core\Language\LanguageInterface;
+use Drupal\Core\Language\LanguageManagerInterface;
+use Drupal\Core\Plugin\ContainerFactoryPluginInterface;
+use Drupal\Core\Render\RendererInterface;
+use Drupal\Core\Render\RenderContext;
+use Drupal\Core\StringTranslation\TranslationManager;
+use Symfony\Component\DependencyInjection\ContainerInterface;
+
+/**
+ * Provides the help topics list section for the help page.
+ *
+ * @HelpSection(
+ * id = "help_topics",
+ * title = @Translation("Topics"),
+ * weight = -10,
+ * description = @Translation("Topics can be provided by modules or themes. Top-level help topics on your site:"),
+ * permission = "access administration pages"
+ * )
+ *
+ * @internal
+ * Plugin classes are internal.
+ */
+class HelpTopicSection extends HelpSectionPluginBase implements ContainerFactoryPluginInterface, SearchableHelpInterface {
+
+ /**
+ * The top level help topic plugins.
+ *
+ * @var \Drupal\help\HelpTopicPluginInterface[]
+ */
+ protected $topLevelPlugins;
+
+ /**
+ * The merged top level help topic plugins cache metadata.
+ *
+ * @var \Drupal\Core\Cache\CacheableMetadata
+ */
+ protected $cacheableMetadata;
+
+ /**
+ * Constructs a HelpTopicSection object.
+ *
+ * @param array $configuration
+ * A configuration array containing information about the plugin instance.
+ * @param string $plugin_id
+ * The plugin_id for the plugin instance.
+ * @param mixed $plugin_definition
+ * The plugin implementation definition.
+ * @param \Drupal\help\HelpTopicPluginManagerInterface $pluginManager
+ * The help topic plugin manager service.
+ * @param \Drupal\Core\Render\RendererInterface $renderer
+ * The renderer.
+ * @param \Drupal\Core\Language\LanguageDefault $defaultLanguage
+ * The default language object.
+ * @param \Drupal\Core\Language\LanguageManagerInterface $languageManager
+ * The language manager.
+ * @param \Drupal\Core\StringTranslation\TranslationManager $translationManager
+ * The translation manager. We are using a method that doesn't exist on an
+ * interface, so require this class.
+ */
+ public function __construct(array $configuration, $plugin_id, $plugin_definition, protected HelpTopicPluginManagerInterface $pluginManager, protected RendererInterface $renderer, protected LanguageDefault $defaultLanguage, protected LanguageManagerInterface $languageManager, protected TranslationManager $translationManager) {
+ parent::__construct($configuration, $plugin_id, $plugin_definition);
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
+ return new static(
+ $configuration,
+ $plugin_id,
+ $plugin_definition,
+ $container->get('plugin.manager.help_topic'),
+ $container->get('renderer'),
+ $container->get('language.default'),
+ $container->get('language_manager'),
+ $container->get('string_translation')
+ );
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function getCacheTags() {
+ return $this->getCacheMetadata()->getCacheTags();
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function getCacheContexts() {
+ return $this->getCacheMetadata()->getCacheContexts();
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function getCacheMaxAge() {
+ return $this->getCacheMetadata()->getCacheMaxAge();
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function listTopics() {
+ // Map the top level help topic plugins to a list of topic links.
+ return array_map(function (HelpTopicPluginInterface $topic) {
+ return $topic->toLink();
+ }, $this->getPlugins());
+ }
+
+ /**
+ * Gets the top level help topic plugins.
+ *
+ * @return \Drupal\help\HelpTopicPluginInterface[]
+ * The top level help topic plugins.
+ */
+ protected function getPlugins() {
+ if (!isset($this->topLevelPlugins)) {
+ $definitions = $this->pluginManager->getDefinitions();
+
+ $this->topLevelPlugins = [];
+ // Get all the top level topics and merge their list cache tags.
+ foreach ($definitions as $definition) {
+ if ($definition['top_level']) {
+ $this->topLevelPlugins[$definition['id']] = $this->pluginManager->createInstance($definition['id']);
+ }
+ }
+
+ // Sort the top level topics by label and, if the labels match, then by
+ // plugin ID.
+ usort($this->topLevelPlugins, function (HelpTopicPluginInterface $a, HelpTopicPluginInterface $b) {
+ $a_label = (string) $a->getLabel();
+ $b_label = (string) $b->getLabel();
+ if ($a_label === $b_label) {
+ return $a->getPluginId() <=> $b->getPluginId();
+ }
+ return strnatcasecmp($a_label, $b_label);
+ });
+ }
+ return $this->topLevelPlugins;
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function listSearchableTopics() {
+ $definitions = $this->pluginManager->getDefinitions();
+ return array_column($definitions, 'id');
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function renderTopicForSearch($topic_id, LanguageInterface $language) {
+ $plugin = $this->pluginManager->createInstance($topic_id);
+ if (!$plugin) {
+ return [];
+ }
+
+ // We are rendering this topic for search indexing or search results,
+ // possibly in a different language than the current language. The topic
+ // title and body come from translatable things in the Twig template, so we
+ // need to set the default language to the desired language, render them,
+ // then restore the default language so we do not affect other cron
+ // processes. Also, just in case there is an exception, wrap the whole
+ // thing in a try/finally block, and reset the language in the finally part.
+ $old_language = $this->defaultLanguage->get();
+ try {
+ if ($old_language->getId() !== $language->getId()) {
+ $this->defaultLanguage->set($language);
+ $this->translationManager->setDefaultLangcode($language->getId());
+ $this->languageManager->reset();
+ }
+ $topic = [];
+
+ // Render the title in this language.
+ $title_build = [
+ 'title' => [
+ '#type' => '#markup',
+ '#markup' => $plugin->getLabel(),
+ ],
+ ];
+ $topic['title'] = $this->renderer->renderPlain($title_build);
+ $cacheable_metadata = CacheableMetadata::createFromRenderArray($title_build);
+
+ // Render the body in this language. For this, we need to set up a render
+ // context, because the Twig plugins that provide the body assumes one
+ // is present.
+ $context = new RenderContext();
+ $build = [
+ 'body' => $this->renderer->executeInRenderContext($context, [$plugin, 'getBody']),
+ ];
+ $topic['text'] = $this->renderer->renderPlain($build);
+ $cacheable_metadata->addCacheableDependency(CacheableMetadata::createFromRenderArray($build));
+ $cacheable_metadata->addCacheableDependency($plugin);
+ if (!$context->isEmpty()) {
+ $cacheable_metadata->addCacheableDependency($context->pop());
+ }
+
+ // Add the other information.
+ $topic['url'] = $plugin->toUrl();
+ $topic['cacheable_metadata'] = $cacheable_metadata;
+ }
+ finally {
+ // Restore the original language.
+ if ($old_language->getId() !== $language->getId()) {
+ $this->defaultLanguage->set($old_language);
+ $this->translationManager->setDefaultLangcode($old_language->getId());
+ $this->languageManager->reset();
+ }
+ }
+
+ return $topic;
+ }
+
+ /**
+ * Gets the merged CacheableMetadata for all the top level help topic plugins.
+ *
+ * @return \Drupal\Core\Cache\CacheableMetadata
+ * The merged CacheableMetadata for all the top level help topic plugins.
+ */
+ protected function getCacheMetadata() {
+ if (!isset($this->cacheableMetadata)) {
+ $this->cacheableMetadata = new CacheableMetadata();
+ foreach ($this->getPlugins() as $plugin) {
+ $this->cacheableMetadata->addCacheableDependency($plugin);
+ }
+ }
+ return $this->cacheableMetadata;
+ }
+
+}
diff --git a/core/modules/help/src/Plugin/Search/HelpSearch.php b/core/modules/help/src/Plugin/Search/HelpSearch.php
new file mode 100644
index 0000000000000000000000000000000000000000..db593327cad2f97cdd54b0e137fdc77d2b04e66b
--- /dev/null
+++ b/core/modules/help/src/Plugin/Search/HelpSearch.php
@@ -0,0 +1,525 @@
+<?php
+
+namespace Drupal\help\Plugin\Search;
+
+use Drupal\Core\Access\AccessibleInterface;
+use Drupal\Core\Access\AccessResult;
+use Drupal\Core\Config\Config;
+use Drupal\Core\Database\Connection;
+use Drupal\Core\Database\Query\PagerSelectExtender;
+use Drupal\Core\Database\StatementInterface;
+use Drupal\Core\Language\LanguageInterface;
+use Drupal\Core\Language\LanguageManagerInterface;
+use Drupal\Core\Messenger\MessengerInterface;
+use Drupal\Core\Session\AccountInterface;
+use Drupal\Core\State\StateInterface;
+use Drupal\help\HelpSectionManager;
+use Drupal\help\SearchableHelpInterface;
+use Drupal\search\Plugin\SearchIndexingInterface;
+use Drupal\search\Plugin\SearchPluginBase;
+use Drupal\search\SearchIndexInterface;
+use Drupal\search\SearchQuery;
+use Symfony\Component\DependencyInjection\ContainerInterface;
+
+/**
+ * Handles searching for help using the Search module index.
+ *
+ * Help items are indexed if their HelpSection plugin implements
+ * \Drupal\help\HelpSearchInterface.
+ *
+ * @see \Drupal\help\HelpSearchInterface
+ * @see \Drupal\help\HelpSectionPluginInterface
+ *
+ * @SearchPlugin(
+ * id = "help_search",
+ * title = @Translation("Help"),
+ * use_admin_theme = TRUE,
+ * )
+ *
+ * @internal
+ * Plugin classes are internal.
+ */
+class HelpSearch extends SearchPluginBase implements AccessibleInterface, SearchIndexingInterface {
+
+ /**
+ * The current database connection.
+ *
+ * @var \Drupal\Core\Database\Connection
+ */
+ protected $database;
+
+ /**
+ * A config object for 'search.settings'.
+ *
+ * @var \Drupal\Core\Config\Config
+ */
+ protected $searchSettings;
+
+ /**
+ * The language manager.
+ *
+ * @var \Drupal\Core\Language\LanguageManagerInterface
+ */
+ protected $languageManager;
+
+ /**
+ * The Drupal account to use for checking for access to search.
+ *
+ * @var \Drupal\Core\Session\AccountInterface
+ */
+ protected $account;
+
+ /**
+ * The messenger.
+ *
+ * @var \Drupal\Core\Messenger\MessengerInterface
+ */
+ protected $messenger;
+
+ /**
+ * The state object.
+ *
+ * @var \Drupal\Core\State\StateInterface
+ */
+ protected $state;
+
+ /**
+ * The help section plugin manager.
+ *
+ * @var \Drupal\help\HelpSectionManager
+ */
+ protected $helpSectionManager;
+
+ /**
+ * The search index.
+ *
+ * @var \Drupal\search\SearchIndexInterface
+ */
+ protected $searchIndex;
+
+ /**
+ * {@inheritdoc}
+ */
+ public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
+ return new static(
+ $configuration,
+ $plugin_id,
+ $plugin_definition,
+ $container->get('database'),
+ $container->get('config.factory')->get('search.settings'),
+ $container->get('language_manager'),
+ $container->get('messenger'),
+ $container->get('current_user'),
+ $container->get('state'),
+ $container->get('plugin.manager.help_section'),
+ $container->get('search.index')
+ );
+ }
+
+ /**
+ * Constructs a \Drupal\help_search\Plugin\Search\HelpSearch object.
+ *
+ * @param array $configuration
+ * Configuration for the plugin.
+ * @param string $plugin_id
+ * The plugin_id for the plugin instance.
+ * @param mixed $plugin_definition
+ * The plugin implementation definition.
+ * @param \Drupal\Core\Database\Connection $database
+ * The current database connection.
+ * @param \Drupal\Core\Config\Config $search_settings
+ * A config object for 'search.settings'.
+ * @param \Drupal\Core\Language\LanguageManagerInterface $language_manager
+ * The language manager.
+ * @param \Drupal\Core\Messenger\MessengerInterface $messenger
+ * The messenger.
+ * @param \Drupal\Core\Session\AccountInterface $account
+ * The $account object to use for checking for access to view help.
+ * @param \Drupal\Core\State\StateInterface $state
+ * The state object.
+ * @param \Drupal\help\HelpSectionManager $help_section_manager
+ * The help section manager.
+ * @param \Drupal\search\SearchIndexInterface $search_index
+ * The search index.
+ */
+ public function __construct(array $configuration, $plugin_id, $plugin_definition, Connection $database, Config $search_settings, LanguageManagerInterface $language_manager, MessengerInterface $messenger, AccountInterface $account, StateInterface $state, HelpSectionManager $help_section_manager, SearchIndexInterface $search_index) {
+ parent::__construct($configuration, $plugin_id, $plugin_definition);
+ $this->database = $database;
+ $this->searchSettings = $search_settings;
+ $this->languageManager = $language_manager;
+ $this->messenger = $messenger;
+ $this->account = $account;
+ $this->state = $state;
+ $this->helpSectionManager = $help_section_manager;
+ $this->searchIndex = $search_index;
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function access($operation = 'view', AccountInterface $account = NULL, $return_as_object = FALSE) {
+ $result = AccessResult::allowedIfHasPermission($account, 'access administration pages');
+ return $return_as_object ? $result : $result->isAllowed();
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function getType() {
+ return $this->getPluginId();
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function execute() {
+ if ($this->isSearchExecutable()) {
+ $results = $this->findResults();
+
+ if ($results) {
+ return $this->prepareResults($results);
+ }
+ }
+
+ return [];
+ }
+
+ /**
+ * Finds the search results.
+ *
+ * @return \Drupal\Core\Database\StatementInterface|null
+ * Results from search query execute() method, or NULL if the search
+ * failed.
+ */
+ protected function findResults() {
+ // We need to check access for the current user to see the topics that
+ // could be returned by search. Each entry in the help_search_items
+ // database has an optional permission that comes from the HelpSection
+ // plugin, in addition to the generic 'access administration pages'
+ // permission. In order to enforce these permissions so only topics that
+ // the current user has permission to view are selected by the query, make
+ // a list of the permission strings and pre-check those permissions.
+ $this->addCacheContexts(['user.permissions']);
+ if (!$this->account->hasPermission('access administration pages')) {
+ return NULL;
+ }
+ $permissions = $this->database
+ ->select('help_search_items', 'hsi')
+ ->distinct()
+ ->fields('hsi', ['permission'])
+ ->condition('permission', '', '<>')
+ ->execute()
+ ->fetchCol();
+ $denied_permissions = array_filter($permissions, function ($permission) {
+ return !$this->account->hasPermission($permission);
+ });
+
+ $query = $this->database
+ ->select('search_index', 'i')
+ // Restrict the search to the current interface language.
+ ->condition('i.langcode', $this->languageManager->getCurrentLanguage()->getId())
+ ->extend(SearchQuery::class)
+ ->extend(PagerSelectExtender::class);
+ $query->innerJoin('help_search_items', 'hsi', '[i].[sid] = [hsi].[sid] AND [i].[type] = :type', [':type' => $this->getType()]);
+ if ($denied_permissions) {
+ $query->condition('hsi.permission', $denied_permissions, 'NOT IN');
+ }
+ $query->searchExpression($this->getKeywords(), $this->getType());
+
+ $find = $query
+ ->fields('i', ['langcode'])
+ ->fields('hsi', ['section_plugin_id', 'topic_id'])
+ // Since SearchQuery makes these into GROUP BY queries, if we add
+ // a field, for PostgreSQL we also need to make it an aggregate or a
+ // GROUP BY. In this case, we want GROUP BY.
+ ->groupBy('i.langcode')
+ ->groupBy('hsi.section_plugin_id')
+ ->groupBy('hsi.topic_id')
+ ->limit(10)
+ ->execute();
+
+ // Check query status and set messages if needed.
+ $status = $query->getStatus();
+
+ if ($status & SearchQuery::EXPRESSIONS_IGNORED) {
+ $this->messenger->addWarning($this->t('Your search used too many AND/OR expressions. Only the first @count terms were included in this search.', ['@count' => $this->searchSettings->get('and_or_limit')]));
+ }
+
+ if ($status & SearchQuery::LOWER_CASE_OR) {
+ $this->messenger->addWarning($this->t('Search for either of the two terms with uppercase <strong>OR</strong>. For example, <strong>cats OR dogs</strong>.'));
+ }
+
+ if ($status & SearchQuery::NO_POSITIVE_KEYWORDS) {
+ $this->messenger->addWarning($this->formatPlural($this->searchSettings->get('index.minimum_word_size'), 'You must include at least one keyword to match in the content, and punctuation is ignored.', 'You must include at least one keyword to match in the content. Keywords must be at least @count characters, and punctuation is ignored.'));
+ }
+
+ $unindexed = $this->state->get('help_search_unindexed_count', 1);
+ if ($unindexed) {
+ $this->messenger()->addWarning($this->t('Help search is not fully indexed. Some results may be missing or incorrect.'));
+ }
+
+ return $find;
+ }
+
+ /**
+ * Prepares search results for display.
+ *
+ * @param \Drupal\Core\Database\StatementInterface $found
+ * Results found from a successful search query execute() method.
+ *
+ * @return array
+ * List of search result render arrays, with links, snippets, etc.
+ */
+ protected function prepareResults(StatementInterface $found) {
+ $results = [];
+ $plugins = [];
+ $languages = [];
+ $keys = $this->getKeywords();
+ foreach ($found as $item) {
+ $section_plugin_id = $item->section_plugin_id;
+ if (!isset($plugins[$section_plugin_id])) {
+ $plugins[$section_plugin_id] = $this->getSectionPlugin($section_plugin_id);
+ }
+ if ($plugins[$section_plugin_id]) {
+ $langcode = $item->langcode;
+ if (!isset($languages[$langcode])) {
+ $languages[$langcode] = $this->languageManager->getLanguage($item->langcode);
+ }
+ $topic = $plugins[$section_plugin_id]->renderTopicForSearch($item->topic_id, $languages[$langcode]);
+ if ($topic) {
+ if (isset($topic['cacheable_metadata'])) {
+ $this->addCacheableDependency($topic['cacheable_metadata']);
+ }
+ $results[] = [
+ 'title' => $topic['title'],
+ 'link' => $topic['url']->toString(),
+ 'snippet' => search_excerpt($keys, $topic['title'] . ' ' . $topic['text'], $item->langcode),
+ 'langcode' => $item->langcode,
+ ];
+ }
+ }
+ }
+
+ return $results;
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function updateIndex() {
+ // Update the list of items to be indexed.
+ $this->updateTopicList();
+
+ // Find some items that need to be updated. Start with ones that have
+ // never been indexed.
+ $limit = (int) $this->searchSettings->get('index.cron_limit');
+
+ $query = $this->database->select('help_search_items', 'hsi');
+ $query->fields('hsi', ['sid', 'section_plugin_id', 'topic_id']);
+ $query->leftJoin('search_dataset', 'sd', '[sd].[sid] = [hsi].[sid] AND [sd].[type] = :type', [':type' => $this->getType()]);
+ $query->where('[sd].[sid] IS NULL');
+ $query->groupBy('hsi.sid')
+ ->groupBy('hsi.section_plugin_id')
+ ->groupBy('hsi.topic_id')
+ ->range(0, $limit);
+ $items = $query->execute()->fetchAll();
+
+ // If there is still space in the indexing limit, index items that have
+ // been indexed before, but are currently marked as needing a re-index.
+ if (count($items) < $limit) {
+ $query = $this->database->select('help_search_items', 'hsi');
+ $query->fields('hsi', ['sid', 'section_plugin_id', 'topic_id']);
+ $query->leftJoin('search_dataset', 'sd', '[sd].[sid] = [hsi].[sid] AND [sd].[type] = :type', [':type' => $this->getType()]);
+ $query->condition('sd.reindex', 0, '<>');
+ $query->groupBy('hsi.sid')
+ ->groupBy('hsi.section_plugin_id')
+ ->groupBy('hsi.topic_id')
+ ->range(0, $limit - count($items));
+ $items = $items + $query->execute()->fetchAll();
+ }
+
+ // Index the items we have chosen, in all available languages.
+ $language_list = $this->languageManager->getLanguages(LanguageInterface::STATE_CONFIGURABLE);
+ $section_plugins = [];
+
+ $words = [];
+ try {
+ foreach ($items as $item) {
+ $section_plugin_id = $item->section_plugin_id;
+ if (!isset($section_plugins[$section_plugin_id])) {
+ $section_plugins[$section_plugin_id] = $this->getSectionPlugin($section_plugin_id);
+ }
+
+ if (!$section_plugins[$section_plugin_id]) {
+ $this->removeItemsFromIndex($item->sid);
+ continue;
+ }
+
+ $section_plugin = $section_plugins[$section_plugin_id];
+ $this->searchIndex->clear($this->getType(), $item->sid);
+ foreach ($language_list as $langcode => $language) {
+ $topic = $section_plugin->renderTopicForSearch($item->topic_id, $language);
+ if ($topic) {
+ // Index the title plus body text.
+ $text = '<h1>' . $topic['title'] . '</h1>' . "\n" . $topic['text'];
+ $words += $this->searchIndex->index($this->getType(), $item->sid, $langcode, $text, FALSE);
+ }
+ }
+ }
+ }
+ finally {
+ $this->searchIndex->updateWordWeights($words);
+ $this->updateIndexState();
+ }
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function indexClear() {
+ $this->searchIndex->clear($this->getType());
+ }
+
+ /**
+ * Rebuilds the database table containing topics to be indexed.
+ */
+ public function updateTopicList() {
+ // Start by fetching the existing list, so we can remove items not found
+ // at the end.
+ $old_list = $this->database->select('help_search_items', 'hsi')
+ ->fields('hsi', ['sid', 'topic_id', 'section_plugin_id', 'permission'])
+ ->execute();
+ $old_list_ordered = [];
+ $sids_to_remove = [];
+ foreach ($old_list as $item) {
+ $old_list_ordered[$item->section_plugin_id][$item->topic_id] = $item;
+ $sids_to_remove[$item->sid] = $item->sid;
+ }
+
+ $section_plugins = $this->helpSectionManager->getDefinitions();
+ foreach ($section_plugins as $section_plugin_id => $section_plugin_definition) {
+ $plugin = $this->getSectionPlugin($section_plugin_id);
+ if (!$plugin) {
+ continue;
+ }
+ $permission = $section_plugin_definition['permission'] ?? '';
+ foreach ($plugin->listSearchableTopics() as $topic_id) {
+ if (isset($old_list_ordered[$section_plugin_id][$topic_id])) {
+ $old_item = $old_list_ordered[$section_plugin_id][$topic_id];
+ if ($old_item->permission == $permission) {
+ // Record has not changed.
+ unset($sids_to_remove[$old_item->sid]);
+ continue;
+ }
+
+ // Permission has changed, update record.
+ $this->database->update('help_search_items')
+ ->condition('sid', $old_item->sid)
+ ->fields(['permission' => $permission])
+ ->execute();
+ unset($sids_to_remove[$old_item->sid]);
+ continue;
+ }
+
+ // New record, create it.
+ $this->database->insert('help_search_items')
+ ->fields([
+ 'section_plugin_id' => $section_plugin_id,
+ 'permission' => $permission,
+ 'topic_id' => $topic_id,
+ ])
+ ->execute();
+ }
+ }
+
+ // Remove remaining items from the index.
+ $this->removeItemsFromIndex($sids_to_remove);
+ }
+
+ /**
+ * Updates the 'help_search_unindexed_count' state variable.
+ *
+ * The state variable is a count of help topics that have never been indexed.
+ */
+ public function updateIndexState() {
+ $query = $this->database->select('help_search_items', 'hsi');
+ $query->addExpression('COUNT(DISTINCT(hsi.sid))');
+ $query->leftJoin('search_dataset', 'sd', 'hsi.sid = sd.sid AND sd.type = :type', [':type' => $this->getType()]);
+ $query->isNull('sd.sid');
+ $never_indexed = $query->execute()->fetchField();
+ $this->state->set('help_search_unindexed_count', $never_indexed);
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function markForReindex() {
+ $this->updateTopicList();
+ $this->searchIndex->markForReindex($this->getType());
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function indexStatus() {
+ $this->updateTopicList();
+ $total = $this->database->select('help_search_items', 'hsi')
+ ->countQuery()
+ ->execute()
+ ->fetchField();
+
+ $query = $this->database->select('help_search_items', 'hsi');
+ $query->addExpression('COUNT(DISTINCT([hsi].[sid]))');
+ $query->leftJoin('search_dataset', 'sd', '[hsi].[sid] = [sd].[sid] AND [sd].[type] = :type', [':type' => $this->getType()]);
+ $condition = $this->database->condition('OR');
+ $condition->condition('sd.reindex', 0, '<>')
+ ->isNull('sd.sid');
+ $query->condition($condition);
+ $remaining = $query->execute()->fetchField();
+
+ return [
+ 'remaining' => $remaining,
+ 'total' => $total,
+ ];
+ }
+
+ /**
+ * Removes an item or items from the search index.
+ *
+ * @param int|int[] $sids
+ * Search ID (sid) of item or items to remove.
+ */
+ protected function removeItemsFromIndex($sids) {
+ $sids = (array) $sids;
+
+ // Remove items from our table in batches of 100, to avoid problems
+ // with having too many placeholders in database queries.
+ foreach (array_chunk($sids, 100) as $this_list) {
+ $this->database->delete('help_search_items')
+ ->condition('sid', $this_list, 'IN')
+ ->execute();
+ }
+ // Remove items from the search tables individually, as there is no bulk
+ // function to delete items from the search index.
+ foreach ($sids as $sid) {
+ $this->searchIndex->clear($this->getType(), $sid);
+ }
+ }
+
+ /**
+ * Instantiates a help section plugin and verifies it is searchable.
+ *
+ * @param string $section_plugin_id
+ * Type of plugin to instantiate.
+ *
+ * @return \Drupal\help\SearchableHelpInterface|false
+ * Plugin object, or FALSE if it is not searchable.
+ */
+ protected function getSectionPlugin($section_plugin_id) {
+ /** @var \Drupal\help\HelpSectionPluginInterface $section_plugin */
+ $section_plugin = $this->helpSectionManager->createInstance($section_plugin_id);
+ // Intentionally return boolean to allow caching of results.
+ return $section_plugin instanceof SearchableHelpInterface ? $section_plugin : FALSE;
+ }
+
+}
diff --git a/core/modules/help/src/SearchableHelpInterface.php b/core/modules/help/src/SearchableHelpInterface.php
new file mode 100644
index 0000000000000000000000000000000000000000..53c6e44d07739f532cf49f8f281b69ace0904a31
--- /dev/null
+++ b/core/modules/help/src/SearchableHelpInterface.php
@@ -0,0 +1,41 @@
+<?php
+
+namespace Drupal\help;
+
+use Drupal\Core\Language\LanguageInterface;
+
+/**
+ * Provides an interface for a HelpSection plugin that also supports search.
+ *
+ * @see \Drupal\help\HelpSectionPluginInterface
+ */
+interface SearchableHelpInterface {
+
+ /**
+ * Returns the IDs of topics that should be indexed for searching.
+ *
+ * @return string[]
+ * An array of topic IDs that should be searchable. IDs need to be
+ * unique within this HelpSection plugin.
+ */
+ public function listSearchableTopics();
+
+ /**
+ * Renders one topic for search indexing or search results.
+ *
+ * @param string $topic_id
+ * The ID of the topic to be indexed.
+ * @param \Drupal\Core\Language\LanguageInterface $language
+ * The language to render the topic in.
+ *
+ * @return array
+ * An array of information about the topic, with elements:
+ * - title: The title of the topic in this language.
+ * - text: The text of the topic in this language.
+ * - url: The URL of the topic as a \Drupal\Core\Url object.
+ * - cacheable_metadata: (optional) An object to add as a cache dependency
+ * if this topic is shown in search results.
+ */
+ public function renderTopicForSearch($topic_id, LanguageInterface $language);
+
+}
diff --git a/core/modules/help/templates/help-topic.html.twig b/core/modules/help/templates/help-topic.html.twig
new file mode 100644
index 0000000000000000000000000000000000000000..cde833335532e8ea2c8cd3b9c83d9cd3b0b2bc5e
--- /dev/null
+++ b/core/modules/help/templates/help-topic.html.twig
@@ -0,0 +1,16 @@
+{#
+/**
+ * @file
+ * Default theme implementation to display a help topic.
+ *
+ * Available variables:
+ * - body: The body of the topic.
+ * - related: List of related topic links.
+ *
+ * @ingroup themeable
+ */
+#}
+<article>
+ {{ body }}
+ {{ related }}
+</article>
diff --git a/core/modules/help/tests/fixtures/update/help-topics-3087499.php b/core/modules/help/tests/fixtures/update/help-topics-3087499.php
new file mode 100644
index 0000000000000000000000000000000000000000..b989514fcd78866c897822b84739c6b46e079a4c
--- /dev/null
+++ b/core/modules/help/tests/fixtures/update/help-topics-3087499.php
@@ -0,0 +1,45 @@
+<?php
+
+/**
+ * @file
+ * Contains database additions for testing the upgrade path for help topics.
+ *
+ * @see https://www.drupal.org/node/3087499
+ */
+
+use Drupal\Core\Database\Database;
+use Drupal\Core\Serialization\Yaml;
+
+$connection = Database::getConnection();
+
+// Enable experimental help_topics module.
+$extensions = $connection->select('config')
+ ->fields('config', ['data'])
+ ->condition('collection', '')
+ ->condition('name', 'core.extension')
+ ->execute()
+ ->fetchField();
+$extensions = unserialize($extensions);
+$extensions['module']['help_topics'] = 0;
+$connection->update('config')
+ ->fields([
+ 'data' => serialize($extensions),
+ ])
+ ->condition('collection', '')
+ ->condition('name', 'core.extension')
+ ->execute();
+
+// Structure of configured block and search page.
+$search_page = Yaml::decode(file_get_contents(__DIR__ . '/search.page.help_search.yml'));
+$connection->insert('config')
+ ->fields([
+ 'collection',
+ 'name',
+ 'data',
+ ])
+ ->values([
+ 'collection' => '',
+ 'name' => 'search.page.help_search',
+ 'data' => serialize($search_page),
+ ])
+ ->execute();
diff --git a/core/modules/help/tests/fixtures/update/search.page.help_search.yml b/core/modules/help/tests/fixtures/update/search.page.help_search.yml
new file mode 100644
index 0000000000000000000000000000000000000000..1973edb57d7576acdf8f9b3f4f64a50ab84445c6
--- /dev/null
+++ b/core/modules/help/tests/fixtures/update/search.page.help_search.yml
@@ -0,0 +1,14 @@
+uuid: c0c6e5d5-c0b1-4874-8c94-ffed8929f5d7
+langcode: en
+status: true
+dependencies:
+ module:
+ - help_topics
+_core:
+ default_config_hash: RZ-bcSekNSsAbIPLW7Gmyd3uUjIOSrPvnb8RCCZYJm8
+id: help_search
+label: Help
+path: help
+weight: 0
+plugin: help_search
+configuration: { }
diff --git a/core/modules/help_topics/tests/modules/help_topics_test/bad_help_topics/syntax/bad_help_topics.bad_html.html.twig b/core/modules/help/tests/modules/help_topics_test/bad_help_topics/syntax/bad_help_topics.bad_html.html.twig
similarity index 100%
rename from core/modules/help_topics/tests/modules/help_topics_test/bad_help_topics/syntax/bad_help_topics.bad_html.html.twig
rename to core/modules/help/tests/modules/help_topics_test/bad_help_topics/syntax/bad_help_topics.bad_html.html.twig
diff --git a/core/modules/help_topics/tests/modules/help_topics_test/bad_help_topics/syntax/bad_help_topics.bad_html2.html.twig b/core/modules/help/tests/modules/help_topics_test/bad_help_topics/syntax/bad_help_topics.bad_html2.html.twig
similarity index 100%
rename from core/modules/help_topics/tests/modules/help_topics_test/bad_help_topics/syntax/bad_help_topics.bad_html2.html.twig
rename to core/modules/help/tests/modules/help_topics_test/bad_help_topics/syntax/bad_help_topics.bad_html2.html.twig
diff --git a/core/modules/help_topics/tests/modules/help_topics_test/bad_help_topics/syntax/bad_help_topics.bad_html3.html.twig b/core/modules/help/tests/modules/help_topics_test/bad_help_topics/syntax/bad_help_topics.bad_html3.html.twig
similarity index 100%
rename from core/modules/help_topics/tests/modules/help_topics_test/bad_help_topics/syntax/bad_help_topics.bad_html3.html.twig
rename to core/modules/help/tests/modules/help_topics_test/bad_help_topics/syntax/bad_help_topics.bad_html3.html.twig
diff --git a/core/modules/help_topics/tests/modules/help_topics_test/bad_help_topics/syntax/bad_help_topics.empty.html.twig b/core/modules/help/tests/modules/help_topics_test/bad_help_topics/syntax/bad_help_topics.empty.html.twig
similarity index 100%
rename from core/modules/help_topics/tests/modules/help_topics_test/bad_help_topics/syntax/bad_help_topics.empty.html.twig
rename to core/modules/help/tests/modules/help_topics_test/bad_help_topics/syntax/bad_help_topics.empty.html.twig
diff --git a/core/modules/help_topics/tests/modules/help_topics_test/bad_help_topics/syntax/bad_help_topics.h1.html.twig b/core/modules/help/tests/modules/help_topics_test/bad_help_topics/syntax/bad_help_topics.h1.html.twig
similarity index 100%
rename from core/modules/help_topics/tests/modules/help_topics_test/bad_help_topics/syntax/bad_help_topics.h1.html.twig
rename to core/modules/help/tests/modules/help_topics_test/bad_help_topics/syntax/bad_help_topics.h1.html.twig
diff --git a/core/modules/help_topics/tests/modules/help_topics_test/bad_help_topics/syntax/bad_help_topics.hierarchy.html.twig b/core/modules/help/tests/modules/help_topics_test/bad_help_topics/syntax/bad_help_topics.hierarchy.html.twig
similarity index 100%
rename from core/modules/help_topics/tests/modules/help_topics_test/bad_help_topics/syntax/bad_help_topics.hierarchy.html.twig
rename to core/modules/help/tests/modules/help_topics_test/bad_help_topics/syntax/bad_help_topics.hierarchy.html.twig
diff --git a/core/modules/help_topics/tests/modules/help_topics_test/bad_help_topics/syntax/bad_help_topics.locale.html.twig b/core/modules/help/tests/modules/help_topics_test/bad_help_topics/syntax/bad_help_topics.locale.html.twig
similarity index 100%
rename from core/modules/help_topics/tests/modules/help_topics_test/bad_help_topics/syntax/bad_help_topics.locale.html.twig
rename to core/modules/help/tests/modules/help_topics_test/bad_help_topics/syntax/bad_help_topics.locale.html.twig
diff --git a/core/modules/help_topics/tests/modules/help_topics_test/bad_help_topics/syntax/bad_help_topics.related.html.twig b/core/modules/help/tests/modules/help_topics_test/bad_help_topics/syntax/bad_help_topics.related.html.twig
similarity index 100%
rename from core/modules/help_topics/tests/modules/help_topics_test/bad_help_topics/syntax/bad_help_topics.related.html.twig
rename to core/modules/help/tests/modules/help_topics_test/bad_help_topics/syntax/bad_help_topics.related.html.twig
diff --git a/core/modules/help_topics/tests/modules/help_topics_test/bad_help_topics/syntax/bad_help_topics.top_level.html.twig b/core/modules/help/tests/modules/help_topics_test/bad_help_topics/syntax/bad_help_topics.top_level.html.twig
similarity index 100%
rename from core/modules/help_topics/tests/modules/help_topics_test/bad_help_topics/syntax/bad_help_topics.top_level.html.twig
rename to core/modules/help/tests/modules/help_topics_test/bad_help_topics/syntax/bad_help_topics.top_level.html.twig
diff --git a/core/modules/help_topics/tests/modules/help_topics_test/bad_help_topics/syntax/bad_help_topics.translated.html.twig b/core/modules/help/tests/modules/help_topics_test/bad_help_topics/syntax/bad_help_topics.translated.html.twig
similarity index 100%
rename from core/modules/help_topics/tests/modules/help_topics_test/bad_help_topics/syntax/bad_help_topics.translated.html.twig
rename to core/modules/help/tests/modules/help_topics_test/bad_help_topics/syntax/bad_help_topics.translated.html.twig
diff --git a/core/modules/help_topics/tests/modules/help_topics_test/bad_help_topics/syntax/bad_help_topics.url_func_used.html.twig b/core/modules/help/tests/modules/help_topics_test/bad_help_topics/syntax/bad_help_topics.url_func_used.html.twig
similarity index 100%
rename from core/modules/help_topics/tests/modules/help_topics_test/bad_help_topics/syntax/bad_help_topics.url_func_used.html.twig
rename to core/modules/help/tests/modules/help_topics_test/bad_help_topics/syntax/bad_help_topics.url_func_used.html.twig
diff --git a/core/modules/help_topics/tests/modules/help_topics_test/help_topics/help_topics_test.additional.html.twig b/core/modules/help/tests/modules/help_topics_test/help_topics/help_topics_test.additional.html.twig
similarity index 100%
rename from core/modules/help_topics/tests/modules/help_topics_test/help_topics/help_topics_test.additional.html.twig
rename to core/modules/help/tests/modules/help_topics_test/help_topics/help_topics_test.additional.html.twig
diff --git a/core/modules/help_topics/tests/modules/help_topics_test/help_topics/help_topics_test.linked.html.twig b/core/modules/help/tests/modules/help_topics_test/help_topics/help_topics_test.linked.html.twig
similarity index 100%
rename from core/modules/help_topics/tests/modules/help_topics_test/help_topics/help_topics_test.linked.html.twig
rename to core/modules/help/tests/modules/help_topics_test/help_topics/help_topics_test.linked.html.twig
diff --git a/core/modules/help_topics/tests/modules/help_topics_test/help_topics/help_topics_test.test.html.twig b/core/modules/help/tests/modules/help_topics_test/help_topics/help_topics_test.test.html.twig
similarity index 100%
rename from core/modules/help_topics/tests/modules/help_topics_test/help_topics/help_topics_test.test.html.twig
rename to core/modules/help/tests/modules/help_topics_test/help_topics/help_topics_test.test.html.twig
diff --git a/core/modules/help_topics/tests/modules/help_topics_test/help_topics/help_topics_test.test_urls.html.twig b/core/modules/help/tests/modules/help_topics_test/help_topics/help_topics_test.test_urls.html.twig
similarity index 100%
rename from core/modules/help_topics/tests/modules/help_topics_test/help_topics/help_topics_test.test_urls.html.twig
rename to core/modules/help/tests/modules/help_topics_test/help_topics/help_topics_test.test_urls.html.twig
diff --git a/core/modules/help_topics/tests/modules/help_topics_test/help_topics_test.help_topics.yml b/core/modules/help/tests/modules/help_topics_test/help_topics_test.help_topics.yml
similarity index 100%
rename from core/modules/help_topics/tests/modules/help_topics_test/help_topics_test.help_topics.yml
rename to core/modules/help/tests/modules/help_topics_test/help_topics_test.help_topics.yml
diff --git a/core/modules/help_topics/tests/modules/help_topics_test/help_topics_test.info.yml b/core/modules/help/tests/modules/help_topics_test/help_topics_test.info.yml
similarity index 91%
rename from core/modules/help_topics/tests/modules/help_topics_test/help_topics_test.info.yml
rename to core/modules/help/tests/modules/help_topics_test/help_topics_test.info.yml
index d81219bd5c67b9073a7535caeda5f81c4dabf7cf..87ea5d1cb919986b2894f495fb962c7535f536c1 100644
--- a/core/modules/help_topics/tests/modules/help_topics_test/help_topics_test.info.yml
+++ b/core/modules/help/tests/modules/help_topics_test/help_topics_test.info.yml
@@ -5,4 +5,4 @@ type: module
description: 'Support module for help testing.'
package: Testing
dependencies:
- - drupal:help_topics
+ - drupal:help
diff --git a/core/modules/help_topics/tests/modules/help_topics_test/help_topics_test.module b/core/modules/help/tests/modules/help_topics_test/help_topics_test.module
similarity index 63%
rename from core/modules/help_topics/tests/modules/help_topics_test/help_topics_test.module
rename to core/modules/help/tests/modules/help_topics_test/help_topics_test.module
index 6bbecbac3f29a10e4791d7eb20a3bea4ea8e358d..9e9ad985caee6911593b49289d8b41226504b1a4 100644
--- a/core/modules/help_topics/tests/modules/help_topics_test/help_topics_test.module
+++ b/core/modules/help/tests/modules/help_topics_test/help_topics_test.module
@@ -21,5 +21,11 @@ function help_topics_test_help($route_name, RouteMatchInterface $route_match) {
* Implements hook_help_topics_info_alter().
*/
function help_topics_test_help_topics_info_alter(array &$info) {
+ // To prevent false positive search results limit list to testing topis only.
+ $filter = fn(string $key) => str_starts_with($key, 'help_topics_test') || in_array($key, [
+ 'help_topics_test_direct_yml',
+ 'help_topics_derivatives:test_derived_topic',
+ ], TRUE);
+ $info = array_filter($info, $filter, ARRAY_FILTER_USE_KEY);
$info['help_topics_test.test']['top_level'] = \Drupal::state()->get('help_topics_test.test:top_level', TRUE);
}
diff --git a/core/modules/help_topics/tests/modules/help_topics_test/help_topics_test.permissions.yml b/core/modules/help/tests/modules/help_topics_test/help_topics_test.permissions.yml
similarity index 100%
rename from core/modules/help_topics/tests/modules/help_topics_test/help_topics_test.permissions.yml
rename to core/modules/help/tests/modules/help_topics_test/help_topics_test.permissions.yml
diff --git a/core/modules/help_topics/tests/modules/help_topics_test/help_topics_test.routing.yml b/core/modules/help/tests/modules/help_topics_test/help_topics_test.routing.yml
similarity index 100%
rename from core/modules/help_topics/tests/modules/help_topics_test/help_topics_test.routing.yml
rename to core/modules/help/tests/modules/help_topics_test/help_topics_test.routing.yml
diff --git a/core/modules/help_topics/tests/modules/help_topics_test/src/Controller/HelpTopicsTestController.php b/core/modules/help/tests/modules/help_topics_test/src/Controller/HelpTopicsTestController.php
similarity index 100%
rename from core/modules/help_topics/tests/modules/help_topics_test/src/Controller/HelpTopicsTestController.php
rename to core/modules/help/tests/modules/help_topics_test/src/Controller/HelpTopicsTestController.php
diff --git a/core/modules/help_topics/tests/modules/help_topics_test/src/Plugin/Deriver/TestHelpTopicDeriver.php b/core/modules/help/tests/modules/help_topics_test/src/Plugin/Deriver/TestHelpTopicDeriver.php
similarity index 100%
rename from core/modules/help_topics/tests/modules/help_topics_test/src/Plugin/Deriver/TestHelpTopicDeriver.php
rename to core/modules/help/tests/modules/help_topics_test/src/Plugin/Deriver/TestHelpTopicDeriver.php
diff --git a/core/modules/help_topics/tests/modules/help_topics_test/src/Plugin/HelpSection/TestHelpSection.php b/core/modules/help/tests/modules/help_topics_test/src/Plugin/HelpSection/TestHelpSection.php
similarity index 97%
rename from core/modules/help_topics/tests/modules/help_topics_test/src/Plugin/HelpSection/TestHelpSection.php
rename to core/modules/help/tests/modules/help_topics_test/src/Plugin/HelpSection/TestHelpSection.php
index 2dc366bc9e98078ed26b93cce756629fa0e57620..9860221800cd5372aa375e295667ab967e76d615 100644
--- a/core/modules/help_topics/tests/modules/help_topics_test/src/Plugin/HelpSection/TestHelpSection.php
+++ b/core/modules/help/tests/modules/help_topics_test/src/Plugin/HelpSection/TestHelpSection.php
@@ -2,7 +2,7 @@
namespace Drupal\help_topics_test\Plugin\HelpSection;
-use Drupal\help_topics\SearchableHelpInterface;
+use Drupal\help\SearchableHelpInterface;
use Drupal\Core\Language\LanguageInterface;
use Drupal\Core\Url;
use Drupal\Core\Link;
diff --git a/core/modules/help_topics/tests/modules/help_topics_test/src/Plugin/HelpTopic/TestHelpTopicPlugin.php b/core/modules/help/tests/modules/help_topics_test/src/Plugin/HelpTopic/TestHelpTopicPlugin.php
similarity index 93%
rename from core/modules/help_topics/tests/modules/help_topics_test/src/Plugin/HelpTopic/TestHelpTopicPlugin.php
rename to core/modules/help/tests/modules/help_topics_test/src/Plugin/HelpTopic/TestHelpTopicPlugin.php
index 421c26321f20f50d6fc3f837be8d924457ec57fb..bec5b480708f8107f4648bcd7174bf6f72a3215a 100644
--- a/core/modules/help_topics/tests/modules/help_topics_test/src/Plugin/HelpTopic/TestHelpTopicPlugin.php
+++ b/core/modules/help/tests/modules/help_topics_test/src/Plugin/HelpTopic/TestHelpTopicPlugin.php
@@ -3,7 +3,7 @@
namespace Drupal\help_topics_test\Plugin\HelpTopic;
use Drupal\Core\Cache\Cache;
-use Drupal\help_topics\HelpTopicPluginBase;
+use Drupal\help\HelpTopicPluginBase;
/**
* A fake help topic plugin for testing.
diff --git a/core/modules/help_topics/tests/modules/help_topics_twig_tester/help_topics_twig_tester.info.yml b/core/modules/help/tests/modules/help_topics_twig_tester/help_topics_twig_tester.info.yml
similarity index 84%
rename from core/modules/help_topics/tests/modules/help_topics_twig_tester/help_topics_twig_tester.info.yml
rename to core/modules/help/tests/modules/help_topics_twig_tester/help_topics_twig_tester.info.yml
index ae66bbc0a8cf0222c09b4e38016b9b469919dd41..c04b642bd81229dc481b14b3fe433c0d0bf774ce 100644
--- a/core/modules/help_topics/tests/modules/help_topics_twig_tester/help_topics_twig_tester.info.yml
+++ b/core/modules/help/tests/modules/help_topics_twig_tester/help_topics_twig_tester.info.yml
@@ -3,4 +3,4 @@ type: module
description: 'Support module for help testing.'
package: Testing
dependencies:
- - drupal:help_topics
+ - drupal:help
diff --git a/core/modules/help_topics/tests/modules/help_topics_twig_tester/help_topics_twig_tester.services.yml b/core/modules/help/tests/modules/help_topics_twig_tester/help_topics_twig_tester.services.yml
similarity index 100%
rename from core/modules/help_topics/tests/modules/help_topics_twig_tester/help_topics_twig_tester.services.yml
rename to core/modules/help/tests/modules/help_topics_twig_tester/help_topics_twig_tester.services.yml
diff --git a/core/modules/help_topics/tests/modules/help_topics_twig_tester/src/HelpTestTwigExtension.php b/core/modules/help/tests/modules/help_topics_twig_tester/src/HelpTestTwigExtension.php
similarity index 100%
rename from core/modules/help_topics/tests/modules/help_topics_twig_tester/src/HelpTestTwigExtension.php
rename to core/modules/help/tests/modules/help_topics_twig_tester/src/HelpTestTwigExtension.php
diff --git a/core/modules/help_topics/tests/modules/help_topics_twig_tester/src/HelpTestTwigNodeVisitor.php b/core/modules/help/tests/modules/help_topics_twig_tester/src/HelpTestTwigNodeVisitor.php
similarity index 100%
rename from core/modules/help_topics/tests/modules/help_topics_twig_tester/src/HelpTestTwigNodeVisitor.php
rename to core/modules/help/tests/modules/help_topics_twig_tester/src/HelpTestTwigNodeVisitor.php
diff --git a/core/modules/help_topics/tests/src/Functional/HelpTopicSearchTest.php b/core/modules/help/tests/src/Functional/HelpTopicSearchTest.php
similarity index 97%
rename from core/modules/help_topics/tests/src/Functional/HelpTopicSearchTest.php
rename to core/modules/help/tests/src/Functional/HelpTopicSearchTest.php
index 013841aa10d2f16d0a4f53191b79d4ae6f04b1ff..dd5472f11accc182610c8e093e8e6965e7739597 100644
--- a/core/modules/help_topics/tests/src/Functional/HelpTopicSearchTest.php
+++ b/core/modules/help/tests/src/Functional/HelpTopicSearchTest.php
@@ -1,9 +1,9 @@
<?php
-namespace Drupal\Tests\help_topics\Functional;
+namespace Drupal\Tests\help\Functional;
use Drupal\Tests\Traits\Core\CronRunTrait;
-use Drupal\help_topics\Plugin\Search\HelpSearch;
+use Drupal\help\Plugin\Search\HelpSearch;
// cspell:ignore asdrsad barmm foomm hilfetestmodul sdeeeee sqruct
// cspell:ignore wcsrefsdf übersetzung
@@ -11,7 +11,7 @@
/**
* Verifies help topic search.
*
- * @group help_topics
+ * @group help
*/
class HelpTopicSearchTest extends HelpTopicTranslatedTestBase {
@@ -257,13 +257,13 @@ public function testUninstall() {
// breaking.
$this->drupalLogin($this->rootUser);
$edit = [];
- $edit['uninstall[help_topics]'] = TRUE;
+ $edit['uninstall[help]'] = TRUE;
$this->drupalGet('admin/modules/uninstall');
$this->submitForm($edit, 'Uninstall');
$this->submitForm([], 'Uninstall');
$this->assertSession()->statusMessageContains('The selected modules have been uninstalled.', 'status');
$this->drupalGet('admin/help');
- $this->assertSession()->statusCodeEquals(200);
+ $this->assertSession()->statusCodeEquals(404);
}
/**
@@ -284,7 +284,7 @@ public function testUninstallSearch() {
// Rebuild the container to reflect the latest changes.
$this->rebuildContainer();
- $this->assertTrue(\Drupal::moduleHandler()->moduleExists('help_topics'), 'The help_topics module is still installed.');
+ $this->assertTrue(\Drupal::moduleHandler()->moduleExists('help'), 'The help module is still installed.');
$this->assertFalse(\Drupal::moduleHandler()->moduleExists('search'), 'The search module is uninstalled.');
}
diff --git a/core/modules/help_topics/tests/src/Functional/HelpTopicTest.php b/core/modules/help/tests/src/Functional/HelpTopicTest.php
similarity index 99%
rename from core/modules/help_topics/tests/src/Functional/HelpTopicTest.php
rename to core/modules/help/tests/src/Functional/HelpTopicTest.php
index b22bc4f5214c61a8c590f3f1d4dff86799fa0051..922a469b49ca7ac63de19234c64e1b9e1cb55080 100644
--- a/core/modules/help_topics/tests/src/Functional/HelpTopicTest.php
+++ b/core/modules/help/tests/src/Functional/HelpTopicTest.php
@@ -1,6 +1,6 @@
<?php
-namespace Drupal\Tests\help_topics\Functional;
+namespace Drupal\Tests\help\Functional;
use Drupal\Tests\BrowserTestBase;
use Drupal\Tests\system\Functional\Menu\AssertBreadcrumbTrait;
@@ -8,7 +8,7 @@
/**
* Verifies help topic display and user access to help based on permissions.
*
- * @group help_topics
+ * @group help
*/
class HelpTopicTest extends BrowserTestBase {
use AssertBreadcrumbTrait;
@@ -21,7 +21,6 @@ class HelpTopicTest extends BrowserTestBase {
protected static $modules = [
'help_topics_test',
'help',
- 'help_topics',
'block',
];
diff --git a/core/modules/help_topics/tests/src/Functional/HelpTopicTranslatedTestBase.php b/core/modules/help/tests/src/Functional/HelpTopicTranslatedTestBase.php
similarity index 97%
rename from core/modules/help_topics/tests/src/Functional/HelpTopicTranslatedTestBase.php
rename to core/modules/help/tests/src/Functional/HelpTopicTranslatedTestBase.php
index ceefee43fe7aaceaf3d6c19d648aefa6fe2296f6..d3db4dc7db5a7b0212ea0f5b2ce755a9d352371a 100644
--- a/core/modules/help_topics/tests/src/Functional/HelpTopicTranslatedTestBase.php
+++ b/core/modules/help/tests/src/Functional/HelpTopicTranslatedTestBase.php
@@ -1,6 +1,6 @@
<?php
-namespace Drupal\Tests\help_topics\Functional;
+namespace Drupal\Tests\help\Functional;
use Drupal\Tests\BrowserTestBase;
@@ -20,7 +20,6 @@ abstract class HelpTopicTranslatedTestBase extends BrowserTestBase {
protected static $modules = [
'help_topics_test',
'help',
- 'help_topics',
'block',
];
diff --git a/core/modules/help_topics/tests/src/Functional/HelpTopicTranslationTest.php b/core/modules/help/tests/src/Functional/HelpTopicTranslationTest.php
similarity index 95%
rename from core/modules/help_topics/tests/src/Functional/HelpTopicTranslationTest.php
rename to core/modules/help/tests/src/Functional/HelpTopicTranslationTest.php
index 261fcb0ba2411083c291466ac094c14c611ed1fd..221254f456e04574279adaf3c1440e0a7e8507f1 100644
--- a/core/modules/help_topics/tests/src/Functional/HelpTopicTranslationTest.php
+++ b/core/modules/help/tests/src/Functional/HelpTopicTranslationTest.php
@@ -1,13 +1,13 @@
<?php
-namespace Drupal\Tests\help_topics\Functional;
+namespace Drupal\Tests\help\Functional;
// cspell:ignore hilfetestmodul übersetzung
/**
* Verifies help topic translations.
*
- * @group help_topics
+ * @group help
*/
class HelpTopicTranslationTest extends HelpTopicTranslatedTestBase {
diff --git a/core/modules/help_topics/tests/src/Functional/HelpTopicsSyntaxTest.php b/core/modules/help/tests/src/Functional/HelpTopicsSyntaxTest.php
similarity index 99%
rename from core/modules/help_topics/tests/src/Functional/HelpTopicsSyntaxTest.php
rename to core/modules/help/tests/src/Functional/HelpTopicsSyntaxTest.php
index 810b0a4700b7bf85b86dea19ba9081da4f2fe08a..b4c3d7f09137dde1184be27df87d6a38b044a516 100644
--- a/core/modules/help_topics/tests/src/Functional/HelpTopicsSyntaxTest.php
+++ b/core/modules/help/tests/src/Functional/HelpTopicsSyntaxTest.php
@@ -1,11 +1,11 @@
<?php
-namespace Drupal\Tests\help_topics\Functional;
+namespace Drupal\Tests\help\Functional;
use Drupal\Core\Extension\ExtensionLifecycle;
use Drupal\Component\FrontMatter\FrontMatter;
use Drupal\Tests\BrowserTestBase;
-use Drupal\help_topics\HelpTopicDiscovery;
+use Drupal\help\HelpTopicDiscovery;
use Drupal\help_topics_twig_tester\HelpTestTwigNodeVisitor;
use PHPUnit\Framework\ExpectationFailedException;
use PHPUnit\Framework\AssertionFailedError;
@@ -19,7 +19,7 @@
* at a time installed and not duplicate the effort of installing. See issue
* https://www.drupal.org/project/drupal/issues/3074040
*
- * @group help_topics
+ * @group help
*/
class HelpTopicsSyntaxTest extends BrowserTestBase {
@@ -28,7 +28,6 @@ class HelpTopicsSyntaxTest extends BrowserTestBase {
*/
protected static $modules = [
'help',
- 'help_topics',
'help_topics_twig_tester',
'locale',
];
diff --git a/core/modules/help/tests/src/Functional/Update/HelpTopicsMerge.php b/core/modules/help/tests/src/Functional/Update/HelpTopicsMerge.php
new file mode 100644
index 0000000000000000000000000000000000000000..f6a9cfa7c957011311b3108c4796c6f70c8aba3e
--- /dev/null
+++ b/core/modules/help/tests/src/Functional/Update/HelpTopicsMerge.php
@@ -0,0 +1,61 @@
+<?php
+
+namespace Drupal\Tests\help\Functional\Update;
+
+use Drupal\FunctionalTests\Update\UpdatePathTestBase;
+use Drupal\block\Entity\Block;
+use Drupal\search\Entity\SearchPage;
+
+/**
+ * Tests merging help topics module when the module is not installed.
+ *
+ * @group Update
+ */
+class HelpTopicsMerge extends UpdatePathTestBase {
+
+ /**
+ * {@inheritdoc}
+ */
+ protected $defaultTheme = 'stark';
+
+ /**
+ * {@inheritdoc}
+ */
+ protected function setDatabaseDumpFiles() {
+ $this->databaseDumpFiles = [
+ __DIR__ . '/../../../../../system/tests/fixtures/update/drupal-9.4.0.bare.standard.php.gz',
+ ];
+ }
+
+ /**
+ * Tests upgrading help module for help topics.
+ *
+ * @see \help_update_10200()
+ * @see \help_post_update_help_topics_search()
+ * @see \help_post_update_help_topics_disable()
+ */
+ public function testHelpTopicsMerge() {
+ $moduleHandler = \Drupal::moduleHandler();
+ $this->assertTrue($moduleHandler->moduleExists('help'));
+ $this->assertFalse($moduleHandler->moduleExists('help_topics'));
+ $this->assertTrue($moduleHandler->moduleExists('search'));
+
+ $this->assertFalse(\Drupal::database()->schema()->tableExists('help_search_items'));
+
+ // No configuration present.
+ $this->assertNull(SearchPage::load('help_search'));
+ $this->assertNull(Block::load('claro_help_search'));
+
+ // Run updates.
+ $this->runUpdates();
+
+ $this->assertFalse(\Drupal::moduleHandler()->moduleExists('help_topics'));
+
+ $this->assertTrue(\Drupal::database()->schema()->tableExists('help_search_items'));
+
+ // Search module's configuration is installed.
+ $this->assertNotNull(Block::load('claro_help_search'));
+ $this->assertNotNull(SearchPage::load('help_search'));
+ }
+
+}
diff --git a/core/modules/help/tests/src/Functional/Update/HelpTopicsUninstall.php b/core/modules/help/tests/src/Functional/Update/HelpTopicsUninstall.php
new file mode 100644
index 0000000000000000000000000000000000000000..69ea80b670c21770a53913f3179254059cb70b4c
--- /dev/null
+++ b/core/modules/help/tests/src/Functional/Update/HelpTopicsUninstall.php
@@ -0,0 +1,64 @@
+<?php
+
+namespace Drupal\Tests\help\Functional\Update;
+
+use Drupal\FunctionalTests\Update\UpdatePathTestBase;
+
+/**
+ * Tests merging help topics module when the module is enabled.
+ *
+ * @group Update
+ */
+class HelpTopicsUninstall extends UpdatePathTestBase {
+
+ /**
+ * {@inheritdoc}
+ */
+ protected $defaultTheme = 'stark';
+
+ /**
+ * {@inheritdoc}
+ */
+ protected function setDatabaseDumpFiles() {
+ $this->databaseDumpFiles = [
+ __DIR__ . '/../../../../../system/tests/fixtures/update/drupal-9.4.0.bare.standard.php.gz',
+ __DIR__ . '/../../../../tests/fixtures/update/help-topics-3087499.php',
+ ];
+ }
+
+ /**
+ * Tests upgrading help module for help topics.
+ *
+ * @see \help_update_10200()
+ * @see \help_post_update_help_topics_search()
+ * @see \help_post_update_help_topics_uninstall()
+ */
+ public function testHelpTopicsMerge() {
+ $module_handler = \Drupal::moduleHandler();
+ $this->assertTrue($module_handler->moduleExists('help'));
+ $this->assertTrue($module_handler->moduleExists('help_topics'));
+ $this->assertTrue($module_handler->moduleExists('search'));
+
+ $this->assertFalse(\Drupal::database()->schema()->tableExists('help_search_items'));
+
+ $dependencies = $this
+ ->config('search.page.help_search')
+ ->get('dependencies.module');
+ $this->assertTrue(in_array('help_topics', $dependencies, TRUE));
+ $this->assertFalse(in_array('help', $dependencies, TRUE));
+
+ // Run updates.
+ $this->runUpdates();
+
+ $this->assertFalse(\Drupal::moduleHandler()->moduleExists('help_topics'));
+
+ $this->assertTrue(\Drupal::database()->schema()->tableExists('help_search_items'));
+
+ $dependencies = $this
+ ->config('search.page.help_search')
+ ->get('dependencies.module');
+ $this->assertFalse(in_array('help_topics', $dependencies, TRUE));
+ $this->assertTrue(in_array('help', $dependencies, TRUE));
+ }
+
+}
diff --git a/core/modules/help_topics/tests/src/Kernel/HelpSearchPluginTest.php b/core/modules/help/tests/src/Kernel/HelpSearchPluginTest.php
similarity index 87%
rename from core/modules/help_topics/tests/src/Kernel/HelpSearchPluginTest.php
rename to core/modules/help/tests/src/Kernel/HelpSearchPluginTest.php
index eaea9fe2fc495bde132ef2f7e729185cc29ee8f2..becce2bf22028a577ce980a3066101bdc1380ab4 100644
--- a/core/modules/help_topics/tests/src/Kernel/HelpSearchPluginTest.php
+++ b/core/modules/help/tests/src/Kernel/HelpSearchPluginTest.php
@@ -1,6 +1,6 @@
<?php
-namespace Drupal\Tests\help_topics\Kernel;
+namespace Drupal\Tests\help\Kernel;
use Drupal\Core\Access\AccessibleInterface;
use Drupal\KernelTests\KernelTestBase;
@@ -9,7 +9,7 @@
/**
* Tests search plugin behaviors.
*
- * @group help_topics
+ * @group help
*
* @see \Drupal\help_topics\Plugin\Search\HelpSearch
*/
@@ -18,7 +18,7 @@ class HelpSearchPluginTest extends KernelTestBase {
/**
* {@inheritdoc}
*/
- protected static $modules = ['help', 'help_topics', 'search'];
+ protected static $modules = ['help', 'search'];
/**
* Tests search plugin annotation and interfaces.
diff --git a/core/modules/help_topics/tests/src/Unit/HelpTopicDiscoveryTest.php b/core/modules/help/tests/src/Unit/HelpTopicDiscoveryTest.php
similarity index 92%
rename from core/modules/help_topics/tests/src/Unit/HelpTopicDiscoveryTest.php
rename to core/modules/help/tests/src/Unit/HelpTopicDiscoveryTest.php
index 066c24b41193d219da2463f1e163d95755c22dce..244235749ff8377fe43cebca7d0df8ea0dcb7a6d 100644
--- a/core/modules/help_topics/tests/src/Unit/HelpTopicDiscoveryTest.php
+++ b/core/modules/help/tests/src/Unit/HelpTopicDiscoveryTest.php
@@ -1,18 +1,18 @@
<?php
-namespace Drupal\Tests\help_topics\Unit;
+namespace Drupal\Tests\help\Unit;
use Drupal\Component\Discovery\DiscoveryException;
use Drupal\Core\DependencyInjection\ContainerBuilder;
use Drupal\Core\StringTranslation\TranslatableMarkup;
-use Drupal\help_topics\HelpTopicDiscovery;
-use Drupal\help_topics\HelpTopicTwig;
+use Drupal\help\HelpTopicDiscovery;
+use Drupal\help\HelpTopicTwig;
use Drupal\Tests\UnitTestCase;
use org\bovigo\vfs\vfsStream;
/**
- * @coversDefaultClass \Drupal\help_topics\HelpTopicDiscovery
- * @group help_topics
+ * @coversDefaultClass \Drupal\help\HelpTopicDiscovery
+ * @group help
*/
class HelpTopicDiscoveryTest extends UnitTestCase {
@@ -159,14 +159,14 @@ public function testHelpTopicsExtensionProviderSpecialCase() {
vfsStream::create([
'modules' => [
- 'help_topics' => [
+ 'help' => [
'help_topics' => [
'core.topic.html.twig' => $topic_content,
],
],
],
]);
- $discovery = new HelpTopicDiscovery(['help_topics' => vfsStream::url('root/modules/help_topics/help_topics')]);
+ $discovery = new HelpTopicDiscovery(['help' => vfsStream::url('root/modules/help/help_topics')]);
$this->assertArrayHasKey('core.topic', $discovery->getDefinitions());
}
@@ -207,16 +207,16 @@ public function testHelpTopicsBrokenYaml() {
vfsStream::create([
'modules' => [
- 'help_topics' => [
+ 'help' => [
'help_topics' => [
'core.topic.html.twig' => $topic_content,
],
],
],
]);
- $discovery = new HelpTopicDiscovery(['help_topics' => vfsStream::url('root/modules/help_topics/help_topics')]);
+ $discovery = new HelpTopicDiscovery(['help' => vfsStream::url('root/modules/help/help_topics')]);
$this->expectException(DiscoveryException::class);
- $this->expectExceptionMessage("Malformed YAML in help topic \"vfs://root/modules/help_topics/help_topics/core.topic.html.twig\":");
+ $this->expectExceptionMessage("Malformed YAML in help topic \"vfs://root/modules/help/help_topics/core.topic.html.twig\":");
$discovery->getDefinitions();
}
diff --git a/core/modules/help_topics/tests/src/Unit/HelpTopicTwigLoaderTest.php b/core/modules/help/tests/src/Unit/HelpTopicTwigLoaderTest.php
similarity index 93%
rename from core/modules/help_topics/tests/src/Unit/HelpTopicTwigLoaderTest.php
rename to core/modules/help/tests/src/Unit/HelpTopicTwigLoaderTest.php
index 9e9081ce3fd08c914b7ed1e0275b4ef0c7d7f6ff..c4cbfff7436c070cb1b24628b30a720eefdb039a 100644
--- a/core/modules/help_topics/tests/src/Unit/HelpTopicTwigLoaderTest.php
+++ b/core/modules/help/tests/src/Unit/HelpTopicTwigLoaderTest.php
@@ -1,10 +1,10 @@
<?php
-namespace Drupal\Tests\help_topics\Unit;
+namespace Drupal\Tests\help\Unit;
use Drupal\Core\Extension\ModuleHandlerInterface;
use Drupal\Core\Extension\ThemeHandlerInterface;
-use Drupal\help_topics\HelpTopicTwigLoader;
+use Drupal\help\HelpTopicTwigLoader;
use Drupal\Tests\UnitTestCase;
use org\bovigo\vfs\vfsStream;
use Twig\Error\LoaderError;
@@ -12,15 +12,15 @@
/**
* Unit test for the HelpTopicTwigLoader class.
*
- * @coversDefaultClass \Drupal\help_topics\HelpTopicTwigLoader
- * @group help_topics
+ * @coversDefaultClass \Drupal\help\HelpTopicTwigLoader
+ * @group help
*/
class HelpTopicTwigLoaderTest extends UnitTestCase {
/**
* The help topic loader instance to test.
*
- * @var \Drupal\help_topics\HelpTopicTwigLoader
+ * @var \Drupal\help\HelpTopicTwigLoader
*/
protected $helpLoader;
diff --git a/core/modules/help_topics/tests/src/Unit/HelpTopicTwigTest.php b/core/modules/help/tests/src/Unit/HelpTopicTwigTest.php
similarity index 93%
rename from core/modules/help_topics/tests/src/Unit/HelpTopicTwigTest.php
rename to core/modules/help/tests/src/Unit/HelpTopicTwigTest.php
index 89478dbe1a68ebc49390ac36dca9c945b38f302a..acc48c144657b69127353db4b3e0347c1d6c510d 100644
--- a/core/modules/help_topics/tests/src/Unit/HelpTopicTwigTest.php
+++ b/core/modules/help/tests/src/Unit/HelpTopicTwigTest.php
@@ -1,9 +1,9 @@
<?php
-namespace Drupal\Tests\help_topics\Unit;
+namespace Drupal\Tests\help\Unit;
use Drupal\Core\Cache\Cache;
-use Drupal\help_topics\HelpTopicTwig;
+use Drupal\help\HelpTopicTwig;
use Drupal\Tests\UnitTestCase;
use Twig\Template;
use Twig\TemplateWrapper;
@@ -15,15 +15,15 @@
* have calls to new Url() and new Link() in them, so they cannot be unit
* tested.
*
- * @coversDefaultClass \Drupal\help_topics\HelpTopicTwig
- * @group help_topics
+ * @coversDefaultClass \Drupal\help\HelpTopicTwig
+ * @group help
*/
class HelpTopicTwigTest extends UnitTestCase {
/**
* The help topic instance to test.
*
- * @var \Drupal\help_topics\HelpTopicTwig
+ * @var \Drupal\help\HelpTopicTwig
*/
protected $helpTopic;
diff --git a/core/modules/help_topics/tests/themes/help_topics_test_theme/help_topics/help_topics_test_theme.test.html.twig b/core/modules/help/tests/themes/help_topics_test_theme/help_topics/help_topics_test_theme.test.html.twig
similarity index 100%
rename from core/modules/help_topics/tests/themes/help_topics_test_theme/help_topics/help_topics_test_theme.test.html.twig
rename to core/modules/help/tests/themes/help_topics_test_theme/help_topics/help_topics_test_theme.test.html.twig
diff --git a/core/modules/help_topics/tests/themes/help_topics_test_theme/help_topics_test_theme.info.yml b/core/modules/help/tests/themes/help_topics_test_theme/help_topics_test_theme.info.yml
similarity index 100%
rename from core/modules/help_topics/tests/themes/help_topics_test_theme/help_topics_test_theme.info.yml
rename to core/modules/help/tests/themes/help_topics_test_theme/help_topics_test_theme.info.yml
diff --git a/core/modules/help_topics/help_topics.api.php b/core/modules/help_topics/help_topics.api.php
deleted file mode 100644
index efd601a26735105140c58ee05ff8a6228c7982fa..0000000000000000000000000000000000000000
--- a/core/modules/help_topics/help_topics.api.php
+++ /dev/null
@@ -1,61 +0,0 @@
-<?php
-
-/**
- * @file
- * Hooks provided by the Help Topics module.
- */
-
-/**
- * @defgroup help_docs Help and documentation
- * @{
- * Documenting modules, themes, and install profiles
- *
- * @section sec_topics Help Topics
- * Modules, themes, and install profiles can have a subdirectory help_topics
- * that contains one or more Help Topics, to provide help to administrative
- * users. These are shown on the main admin/help page. See
- * @link https://www.drupal.org/docs/develop/documenting-your-project/help-topic-standards Help Topic Standards @endlink
- * for more information.
- *
- * @section sec_hook hook_help
- * Modules can implement hook_help() to provide a module overview (shown on the
- * main admin/help page). This hook implementation can also provide help text
- * that is shown in the Help block at the top of administrative pages. See the
- * hook_help() documentation and
- * @link https://www.drupal.org/docs/develop/documenting-your-project/help-text-standards Help text standards @endlink
- * for more information.
- *
- * @section sec_tour Tours
- * Modules can provide tours of administrative pages by creating tour config
- * files and placing them in their config/optional subdirectory. See
- * @link https://www.drupal.org/docs/8/api/tour-api/overview Tour API overview @endlink
- * for more information. The contributed
- * @link https://www.drupal.org/project/tour_ui Tour UI module @endlink
- * can also be used to create tour config files.
- * @}
- */
-
-/**
- * @addtogroup hooks
- * @{
- */
-
-/**
- * Perform alterations on help topic definitions.
- *
- * @param array $info
- * Array of help topic plugin definitions keyed by their plugin ID.
- *
- * @internal
- * Help Topics is currently experimental and should only be leveraged by
- * experimental modules and development releases of contributed modules.
- * See https://www.drupal.org/core/experimental for more information.
- */
-function hook_help_topics_info_alter(array &$info) {
- // Alter the help topic to be displayed on admin/help.
- $info['example.help_topic']['top_level'] = TRUE;
-}
-
-/**
- * @} End of "addtogroup hooks".
- */
diff --git a/core/modules/help_topics/help_topics.info.yml b/core/modules/help_topics/help_topics.info.yml
index 0c8f9eb5675d6c5a7e8ceb2557fffc64e99f9520..5957dd3fab5a2f02ad005f9aea0c4ee0d014ca41 100644
--- a/core/modules/help_topics/help_topics.info.yml
+++ b/core/modules/help_topics/help_topics.info.yml
@@ -2,7 +2,8 @@ name: Help Topics
type: module
description: 'Displays help topics provided by themes and modules.'
package: Core (Experimental)
-lifecycle: experimental
+lifecycle: deprecated
+lifecycle_link: https://www.drupal.org/node/3223395#s-help_topics
version: VERSION
dependencies:
- drupal:help
diff --git a/core/modules/help_topics/help_topics.install b/core/modules/help_topics/help_topics.install
deleted file mode 100644
index ef3e343da25aa986cb046d9f94c4ac3f392cec1c..0000000000000000000000000000000000000000
--- a/core/modules/help_topics/help_topics.install
+++ /dev/null
@@ -1,51 +0,0 @@
-<?php
-
-/**
- * @file
- * Install and uninstall functions for help_topics module.
- */
-
-/**
- * Implements hook_schema().
- */
-function help_topics_schema() {
- $schema['help_search_items'] = [
- 'description' => 'Stores information about indexed help search items',
- 'fields' => [
- 'sid' => [
- 'description' => 'Numeric index of this item in the search index',
- 'type' => 'serial',
- 'unsigned' => TRUE,
- 'not null' => TRUE,
- ],
- 'section_plugin_id' => [
- 'description' => 'The help section the item comes from',
- 'type' => 'varchar_ascii',
- 'length' => 255,
- 'not null' => TRUE,
- 'default' => '',
- ],
- 'permission' => [
- 'description' => 'The permission needed to view this item',
- 'type' => 'varchar_ascii',
- 'length' => 255,
- 'not null' => TRUE,
- 'default' => '',
- ],
- 'topic_id' => [
- 'description' => 'The topic ID of the item',
- 'type' => 'varchar_ascii',
- 'length' => 255,
- 'not null' => TRUE,
- 'default' => '',
- ],
- ],
- 'primary key' => ['sid'],
- 'indexes' => [
- 'section_plugin_id' => ['section_plugin_id'],
- 'topic_id' => ['topic_id'],
- ],
- ];
-
- return $schema;
-}
diff --git a/core/modules/help_topics/help_topics.module b/core/modules/help_topics/help_topics.module
index 5a33176a73a3682e3024470fdb149ad5bcf89db4..567f08743f06deaee3ea11b4057ed312b9712ae7 100644
--- a/core/modules/help_topics/help_topics.module
+++ b/core/modules/help_topics/help_topics.module
@@ -12,100 +12,13 @@
* Implements hook_help().
*/
function help_topics_help($route_name, RouteMatchInterface $route_match) {
- switch ($route_name) {
- case 'help.page.help_topics':
- $help_home = Url::fromRoute('help.main')->toString();
- $module_handler = \Drupal::moduleHandler();
- $locale_help = ($module_handler->moduleExists('locale')) ? Url::fromRoute('help.page', ['name' => 'locale'])->toString() : '#';
- $search_help = ($module_handler->moduleExists('search')) ? Url::fromRoute('help.page', ['name' => 'search'])->toString() : '#';
- $output = '';
- $output .= '<h3>' . t('About') . '</h3>';
- $output .= '<p>' . t('The Help Topics module adds module- and theme-provided help topics to the module overviews from the core Help module. If the core Search module is enabled, these topics are also searchable. For more information, see the <a href=":online">online documentation for the Help Topics module</a>.', [':online' => 'https://www.drupal.org/documentation/modules/help_topics']) . '</p>';
- $output .= '<h3>' . t('Uses') . '</h3>';
- $output .= '<dl>';
- $output .= '<dt>' . t('Viewing help topics') . '</dt>';
- $output .= '<dd>' . t('The top-level help topics are listed on the main <a href=":help_page">Help page</a>. Links to other topics, including non-top-level help topics, can be found under the "Related" heading when viewing a topic page.', [':help_page' => $help_home]) . '</dd>';
- $output .= '<dt>' . t('Providing help topics') . '</dt>';
- $output .= '<dd>' . t("Modules and themes can provide help topics as Twig-file-based plugins in a project sub-directory called <em>help_topics</em>; plugin meta-data is provided in YAML front matter within each Twig file. Plugin-based help topics provided by modules and themes will automatically be updated when a module or theme is updated. Use the plugins in <em>core/modules/help_topics/help_topics</em> as a guide when writing and formatting a help topic plugin for your theme or module.") . '</dd>';
- $output .= '<dt>' . t('Translating help topics') . '</dt>';
- $output .= '<dd>' . t('The title and body text of help topics provided by contributed modules and themes are translatable using the <a href=":locale_help">Interface Translation module</a>. Topics provided by custom modules and themes are also translatable if they have been viewed at least once in a non-English language, which triggers putting their translatable text into the translation database.', [':locale_help' => $locale_help]) . '</dd>';
- $output .= '<dt>' . t('Configuring help search') . '</dt>';
- $output .= '<dd>' . t('To search help, you will need to install the core Search module, configure a search page, and add a search block to the Help page or another administrative page. (A search page is provided automatically, and if you use the core Claro administrative theme, a help search block is shown on the main Help page.) Then users with search permissions, and permission to view help, will be able to search help. See the <a href=":search_help">Search module help page</a> for more information.', [':search_help' => $search_help]) . '</dd>';
- $output .= '</dl>';
- return ['#markup' => $output];
-
- case 'help.help_topic':
- $help_home = Url::fromRoute('help.main')->toString();
- return '<p>' . t('See the <a href=":help_page">Help page</a> for more topics.', [
- ':help_page' => $help_home,
- ]) . '</p>';
- }
-}
-
-/**
- * Implements hook_theme().
- */
-function help_topics_theme() {
- return [
- 'help_topic' => [
- 'variables' => [
- 'body' => [],
- 'related' => [],
- ],
- ],
- ];
-}
-
-/**
- * Implements hook_modules_uninstalled().
- */
-function help_topics_modules_uninstalled(array $modules) {
- _help_topics_search_update($modules);
-}
-
-/**
- * Implements hook_themes_uninstalled().
- */
-function help_topics_themes_uninstalled(array $themes) {
- _help_topics_search_update();
-}
-
-/**
- * Implements hook_modules_installed().
- */
-function help_topics_modules_installed(array $modules, $is_syncing) {
- _help_topics_search_update();
-}
-
-/**
- * Implements hook_themes_installed().
- */
-function help_topics_themes_installed(array $themes) {
- _help_topics_search_update();
-}
-
-/**
- * Ensure that search is updated when extensions are installed or uninstalled.
- *
- * @param string[] $extensions
- * (optional) If modules are being uninstalled, the names of the modules
- * being uninstalled. For themes being installed/uninstalled, or modules
- * being installed, omit this parameter.
- */
-function _help_topics_search_update(array $extensions = []): void {
- // Early return if search is not installed or if we're uninstalling this
- // module.
- if (!\Drupal::hasService('plugin.manager.search') ||
- in_array('help_topics', $extensions)) {
- return;
- }
-
- $search_plugin_manager = \Drupal::service('plugin.manager.search');
- if ($search_plugin_manager->hasDefinition('help_search')) {
- // Ensure that topics for extensions that have been uninstalled are removed
- // and that the index state variable is updated.
- $help_search = $search_plugin_manager->createInstance('help_search');
- $help_search->updateTopicList();
- $help_search->updateIndexState();
+ if ($route_name == 'help.page.help_topics') {
+ $help_home = Url::fromRoute('help.main')->toString();
+ $output = '<h3>' . t('About') . '</h3>';
+ $output .= '<p>' . t('The Help Topics module has been moved to the Help module.') . '</p>';
+ $output .= '<p>' . t('See the <a href=":help_page">Help page</a> to view topics.', [
+ ':help_page' => $help_home,
+ ]) . '</p>';
+ return ['#markup' => $output];
}
}
diff --git a/core/modules/help_topics/help_topics.routing.yml b/core/modules/help_topics/help_topics.routing.yml
deleted file mode 100644
index 4bf760ef78e682b31624de365cf67c42397bdf94..0000000000000000000000000000000000000000
--- a/core/modules/help_topics/help_topics.routing.yml
+++ /dev/null
@@ -1,6 +0,0 @@
-help.help_topic:
- path: '/admin/help/topic/{id}'
- defaults:
- _controller: '\Drupal\help_topics\Controller\HelpTopicPluginController::viewHelpTopic'
- requirements:
- _permission: 'access administration pages'
diff --git a/core/modules/help_topics/help_topics.services.yml b/core/modules/help_topics/help_topics.services.yml
deleted file mode 100644
index aae5415c3e3f32fc69b0a111ce150d1e5434f552..0000000000000000000000000000000000000000
--- a/core/modules/help_topics/help_topics.services.yml
+++ /dev/null
@@ -1,31 +0,0 @@
-services:
- help.breadcrumb:
- class: Drupal\help_topics\HelpBreadcrumbBuilder
- arguments: ['@string_translation']
- tags:
- - { name: breadcrumb_builder, priority: 900 }
- public: false
- plugin.manager.help_topic:
- class: Drupal\help_topics\HelpTopicPluginManager
- arguments: ['@module_handler', '@theme_handler', '@cache.discovery', '%app.root%']
- Drupal\help_topics\HelpTopicPluginManagerInterface: '@plugin.manager.help_topic'
- help.twig.loader:
- class: Drupal\help_topics\HelpTopicTwigLoader
- arguments: ['%app.root%', '@module_handler', '@theme_handler']
- # Lowest core priority because loading help topics is not the usual case.
- tags:
- - { name: twig.loader, priority: -200 }
- public: false
- plugin.manager.help_section_topics:
- class: Drupal\help_topics\HelpSectionManager
- decorates: plugin.manager.help_section
- parent: plugin.manager.help_section
- calls:
- - [setSearchManager, ['@?plugin.manager.search']]
- tags:
- - { name: plugin_manager_cache_clear }
- help_twig.extension:
- class: Drupal\help_topics\HelpTwigExtension
- arguments: ['@access_manager', '@plugin.manager.help_topic', '@string_translation']
- tags:
- - { name: twig.extension }
diff --git a/core/modules/help_topics/src/Controller/HelpTopicPluginController.php b/core/modules/help_topics/src/Controller/HelpTopicPluginController.php
index 336ee05bf7a574e1e693f40e87f592d785c1fc1e..4c14477a387a9157caae9d5307fbe19c3061ec7c 100644
--- a/core/modules/help_topics/src/Controller/HelpTopicPluginController.php
+++ b/core/modules/help_topics/src/Controller/HelpTopicPluginController.php
@@ -2,13 +2,7 @@
namespace Drupal\help_topics\Controller;
-use Drupal\Component\Utility\SortArray;
-use Drupal\Core\Controller\ControllerBase;
-use Drupal\Core\Url;
-use Drupal\help_topics\HelpTopicPluginManagerInterface;
-use Drupal\Core\Render\RendererInterface;
-use Symfony\Component\DependencyInjection\ContainerInterface;
-use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
+use Drupal\help\Controller\HelpTopicPluginController as CoreHelpTopicPluginController;
/**
* Controller for help topic plugins.
@@ -18,100 +12,6 @@
* experimental modules and development releases of contributed modules.
* See https://www.drupal.org/core/experimental for more information.
*/
-class HelpTopicPluginController extends ControllerBase {
-
- /**
- * The renderer service.
- *
- * @var \Drupal\Core\Render\RendererInterface
- */
- protected $renderer;
-
- /**
- * The Help Topic plugin manager.
- *
- * @var \Drupal\help_topics\HelpTopicPluginManagerInterface
- */
- protected $helpTopicPluginManager;
-
- /**
- * Constructs a HelpTopicPluginController object.
- *
- * @param \Drupal\help_topics\HelpTopicPluginManagerInterface $help_topic_plugin_manager
- * The help topic plugin manager service.
- * @param \Drupal\Core\Render\RendererInterface $renderer
- * The renderer service.
- */
- public function __construct(HelpTopicPluginManagerInterface $help_topic_plugin_manager, RendererInterface $renderer) {
- $this->helpTopicPluginManager = $help_topic_plugin_manager;
- $this->renderer = $renderer;
- }
-
- /**
- * {@inheritdoc}
- */
- public static function create(ContainerInterface $container) {
- return new static(
- $container->get('plugin.manager.help_topic'),
- $container->get('renderer')
- );
- }
-
- /**
- * Displays a help topic page.
- *
- * @param string $id
- * The plugin ID. Maps to the {id} placeholder in the
- * help.help_topic route.
- *
- * @return array
- * A render array with the contents of a help topic page.
- */
- public function viewHelpTopic($id) {
- $build = [];
-
- if (!$this->helpTopicPluginManager->hasDefinition($id)) {
- throw new NotFoundHttpException();
- }
- /** @var \Drupal\help_topics\HelpTopicPluginInterface $help_topic */
- $help_topic = $this->helpTopicPluginManager->createInstance($id);
-
- $build['#body'] = $help_topic->getBody();
-
- $this->renderer->addCacheableDependency($build, $help_topic);
-
- // Build the related topics section, starting with the list this topic
- // says are related.
- $links = [];
-
- $related = $help_topic->getRelated();
- foreach ($related as $other_id) {
- if ($other_id !== $id) {
- /** @var \Drupal\help_topics\HelpTopicPluginInterface $topic */
- $topic = $this->helpTopicPluginManager->createInstance($other_id);
- $links[$other_id] = [
- 'title' => $topic->getLabel(),
- 'url' => Url::fromRoute('help.help_topic', ['id' => $other_id]),
- ];
- $this->renderer->addCacheableDependency($build, $topic);
- }
- }
-
- if (count($links)) {
- uasort($links, [SortArray::class, 'sortByTitleElement']);
- $build['#related'] = [
- '#theme' => 'links__related',
- '#heading' => [
- 'text' => $this->t('Related topics'),
- 'level' => 'h2',
- ],
- '#links' => $links,
- ];
- }
-
- $build['#theme'] = 'help_topic';
- $build['#title'] = $help_topic->getLabel();
- return $build;
- }
+class HelpTopicPluginController extends CoreHelpTopicPluginController {
}
diff --git a/core/modules/help_topics/src/HelpBreadcrumbBuilder.php b/core/modules/help_topics/src/HelpBreadcrumbBuilder.php
index 1387b4fa2ecdb1fe9b813b132ce710d02673249d..d8bcad01b92aef5bac5582a68c1eeb0cf4d9dbfd 100644
--- a/core/modules/help_topics/src/HelpBreadcrumbBuilder.php
+++ b/core/modules/help_topics/src/HelpBreadcrumbBuilder.php
@@ -2,12 +2,7 @@
namespace Drupal\help_topics;
-use Drupal\Core\Breadcrumb\Breadcrumb;
-use Drupal\Core\Breadcrumb\BreadcrumbBuilderInterface;
-use Drupal\Core\Link;
-use Drupal\Core\Routing\RouteMatchInterface;
-use Drupal\Core\StringTranslation\StringTranslationTrait;
-use Drupal\Core\StringTranslation\TranslationInterface;
+use Drupal\help\HelpBreadcrumbBuilder as CoreHelpBreadcrumbBuilder;
/**
* Provides a breadcrumb builder for help topic pages.
@@ -17,38 +12,6 @@
* experimental modules and development releases of contributed modules.
* See https://www.drupal.org/core/experimental for more information.
*/
-class HelpBreadcrumbBuilder implements BreadcrumbBuilderInterface {
-
- use StringTranslationTrait;
-
- /**
- * Constructs the HelpBreadcrumbBuilder.
- *
- * @param \Drupal\Core\StringTranslation\TranslationInterface $string_translation
- * The translation service.
- */
- public function __construct(TranslationInterface $string_translation) {
- $this->stringTranslation = $string_translation;
- }
-
- /**
- * {@inheritdoc}
- */
- public function applies(RouteMatchInterface $route_match) {
- return $route_match->getRouteName() == 'help.help_topic';
- }
-
- /**
- * {@inheritdoc}
- */
- public function build(RouteMatchInterface $route_match) {
- $breadcrumb = new Breadcrumb();
- $breadcrumb->addCacheContexts(['url.path.parent']);
- $breadcrumb->addLink(Link::createFromRoute($this->t('Home'), '<front>'));
- $breadcrumb->addLink(Link::createFromRoute($this->t('Administration'), 'system.admin'));
- $breadcrumb->addLink(Link::createFromRoute($this->t('Help'), 'help.main'));
-
- return $breadcrumb;
- }
+class HelpBreadcrumbBuilder extends CoreHelpBreadcrumbBuilder {
}
diff --git a/core/modules/help_topics/src/HelpSectionManager.php b/core/modules/help_topics/src/HelpSectionManager.php
index 92e9b83e40481e975abcd17e3778be525966106f..906e411d1324d5136afbb9beb520b2638451ee3e 100644
--- a/core/modules/help_topics/src/HelpSectionManager.php
+++ b/core/modules/help_topics/src/HelpSectionManager.php
@@ -2,7 +2,6 @@
namespace Drupal\help_topics;
-use Drupal\Component\Plugin\PluginManagerInterface;
use Drupal\help\HelpSectionManager as CoreHelpSectionManager;
/**
@@ -15,35 +14,4 @@
*/
class HelpSectionManager extends CoreHelpSectionManager {
- /**
- * The search manager.
- *
- * @var \Drupal\Component\Plugin\PluginManagerInterface
- */
- protected $searchManager;
-
- /**
- * Sets the search manager.
- *
- * @param \Drupal\Component\Plugin\PluginManagerInterface|null $search_manager
- * The search manager if the Search module is installed.
- */
- public function setSearchManager(PluginManagerInterface $search_manager = NULL) {
- $this->searchManager = $search_manager;
- }
-
- /**
- * {@inheritdoc}
- */
- public function clearCachedDefinitions() {
- parent::clearCachedDefinitions();
- if ($this->searchManager && $this->searchManager->hasDefinition('help_search') && $this->moduleHandler->moduleExists('help_topics')) {
- // Rebuild the index on cache clear so that new help topics are indexed
- // and any changes due to help topics edits or translation changes are
- // picked up.
- $help_search = $this->searchManager->createInstance('help_search');
- $help_search->markForReindex();
- }
- }
-
}
diff --git a/core/modules/help_topics/src/HelpTopicDiscovery.php b/core/modules/help_topics/src/HelpTopicDiscovery.php
index 684453faa0af45287b41a9724437657e440f726f..0a7d2d147667c0ac20fc72c50acd942089dd8118 100644
--- a/core/modules/help_topics/src/HelpTopicDiscovery.php
+++ b/core/modules/help_topics/src/HelpTopicDiscovery.php
@@ -2,15 +2,7 @@
namespace Drupal\help_topics;
-use Drupal\Component\Discovery\DiscoveryException;
-use Drupal\Component\FileCache\FileCacheFactory;
-use Drupal\Component\FileSystem\RegexDirectoryIterator;
-use Drupal\Component\FrontMatter\FrontMatter;
-use Drupal\Component\Plugin\Discovery\DiscoveryInterface;
-use Drupal\Component\Plugin\Discovery\DiscoveryTrait;
-use Drupal\Component\Serialization\Exception\InvalidDataTypeException;
-use Drupal\Core\Serialization\Yaml;
-use Drupal\Core\StringTranslation\TranslatableMarkup;
+use Drupal\help\HelpTopicDiscovery as CoreHelpTopicDiscovery;
/**
* Discovers help topic plugins from Twig files in help_topics directories.
@@ -23,164 +15,6 @@
* experimental modules and development releases of contributed modules.
* See https://www.drupal.org/core/experimental for more information.
*/
-class HelpTopicDiscovery implements DiscoveryInterface {
-
- use DiscoveryTrait;
-
- /**
- * Defines the key in the discovered data where the file path is stored.
- */
- const FILE_KEY = '_discovered_file_path';
-
- /**
- * An array of directories to scan, keyed by the provider.
- *
- * The value can either be a string or an array of strings. The string values
- * should be the path of a directory to scan.
- *
- * @var array
- */
- protected $directories = [];
-
- /**
- * Constructs a HelpTopicDiscovery object.
- *
- * @param array $directories
- * An array of directories to scan, keyed by the provider. The value can
- * either be a string or an array of strings. The string values should be
- * the path of a directory to scan.
- */
- public function __construct(array $directories) {
- $this->directories = $directories;
- }
-
- /**
- * {@inheritdoc}
- */
- public function getDefinitions() {
- $plugins = $this->findAll();
-
- // Flatten definitions into what's expected from plugins.
- $definitions = [];
- foreach ($plugins as $list) {
- foreach ($list as $id => $definition) {
- $definitions[$id] = $definition;
- }
- }
-
- return $definitions;
- }
-
- /**
- * Returns an array of discoverable items.
- *
- * @return array
- * An array of discovered data keyed by provider.
- *
- * @throws \Drupal\Component\Discovery\DiscoveryException
- * Exception thrown if there is a problem during discovery.
- */
- public function findAll() {
- $all = [];
-
- $files = $this->findFiles();
-
- $file_cache = FileCacheFactory::get('help_topic_discovery:help_topics');
-
- // Try to load from the file cache first.
- foreach ($file_cache->getMultiple(array_keys($files)) as $file => $data) {
- $all[$files[$file]][$data['id']] = $data;
- unset($files[$file]);
- }
-
- // If there are files left that were not returned from the cache, load and
- // parse them now. This list was flipped above and is keyed by filename.
- if ($files) {
- foreach ($files as $file => $provider) {
- $plugin_id = substr(basename($file), 0, -10);
- // The plugin ID begins with provider.
- [$file_name_provider] = explode('.', $plugin_id, 2);
- // Only the Help Topics module can provide help for other extensions.
- // @todo https://www.drupal.org/project/drupal/issues/3072312 Remove
- // help_topics special case once Help Topics is stable and core
- // modules can provide their own help topics.
- if ($provider !== 'help_topics' && $provider !== $file_name_provider) {
- throw new DiscoveryException("$file file name should begin with '$provider'");
- }
- $data = [
- // The plugin ID is derived from the filename. The extension
- // '.html.twig' is removed.
- 'id' => $plugin_id,
- 'provider' => $file_name_provider,
- 'class' => HelpTopicTwig::class,
- static::FILE_KEY => $file,
- ];
-
- // Get the rest of the plugin definition from front matter contained in
- // the help topic Twig file.
- try {
- $front_matter = FrontMatter::create(file_get_contents($file), Yaml::class)->getData();
- }
- catch (InvalidDataTypeException $e) {
- throw new DiscoveryException(sprintf('Malformed YAML in help topic "%s": %s.', $file, $e->getMessage()));
- }
- foreach ($front_matter as $key => $value) {
- switch ($key) {
- case 'related':
- if (!is_array($value)) {
- throw new DiscoveryException("$file contains invalid value for 'related' key, the value must be an array of strings");
- }
- $data[$key] = $value;
- break;
-
- case 'top_level':
- if (!is_bool($value)) {
- throw new DiscoveryException("$file contains invalid value for 'top_level' key, the value must be a Boolean");
- }
- $data[$key] = $value;
- break;
-
- case 'label':
- $data[$key] = new TranslatableMarkup($value);
- break;
-
- default:
- throw new DiscoveryException("$file contains invalid key='$key'");
- }
- }
- if (!isset($data['label'])) {
- throw new DiscoveryException("$file does not contain the required key with name='label'");
- }
-
- $all[$provider][$data['id']] = $data;
- $file_cache->set($file, $data);
- }
- }
-
- return $all;
- }
-
- /**
- * Returns an array of providers keyed by file path.
- *
- * @return array
- * An array of providers keyed by file path.
- */
- protected function findFiles() {
- $file_list = [];
- foreach ($this->directories as $provider => $directories) {
- $directories = (array) $directories;
- foreach ($directories as $directory) {
- if (is_dir($directory)) {
- /** @var \SplFileInfo $fileInfo */
- $iterator = new RegexDirectoryIterator($directory, '/\.html\.twig$/i');
- foreach ($iterator as $fileInfo) {
- $file_list[$fileInfo->getPathname()] = $provider;
- }
- }
- }
- }
- return $file_list;
- }
+class HelpTopicDiscovery extends CoreHelpTopicDiscovery {
}
diff --git a/core/modules/help_topics/src/HelpTopicPluginBase.php b/core/modules/help_topics/src/HelpTopicPluginBase.php
index 5a0e90505f109c9ba05fdf21ee655c051c8b066f..f40e7a6a6a804a50a7bcde060689d8d9b25b0af7 100644
--- a/core/modules/help_topics/src/HelpTopicPluginBase.php
+++ b/core/modules/help_topics/src/HelpTopicPluginBase.php
@@ -2,9 +2,7 @@
namespace Drupal\help_topics;
-use Drupal\Core\Link;
-use Drupal\Core\Plugin\PluginBase;
-use Drupal\Core\Url;
+use Drupal\help\HelpTopicPluginBase as CoreHelpTopicPluginBase;
/**
* Base class for help topic plugins.
@@ -14,51 +12,6 @@
* experimental modules and development releases of contributed modules.
* See https://www.drupal.org/core/experimental for more information.
*/
-abstract class HelpTopicPluginBase extends PluginBase implements HelpTopicPluginInterface {
-
- /**
- * The name of the module or theme providing the help topic.
- */
- public function getProvider() {
- return $this->pluginDefinition['provider'];
- }
-
- /**
- * {@inheritdoc}
- */
- public function getLabel() {
- return $this->pluginDefinition['label'];
- }
-
- /**
- * {@inheritdoc}
- */
- public function isTopLevel() {
- return $this->pluginDefinition['top_level'];
- }
-
- /**
- * {@inheritdoc}
- */
- public function getRelated() {
- return $this->pluginDefinition['related'];
- }
-
- /**
- * {@inheritdoc}
- */
- public function toUrl(array $options = []) {
- return Url::fromRoute('help.help_topic', ['id' => $this->getPluginId()], $options);
- }
-
- /**
- * {@inheritdoc}
- */
- public function toLink($text = NULL, array $options = []) {
- if (!$text) {
- $text = $this->getLabel();
- }
- return Link::createFromRoute($text, 'help.help_topic', ['id' => $this->getPluginId()], $options);
- }
+abstract class HelpTopicPluginBase extends CoreHelpTopicPluginBase {
}
diff --git a/core/modules/help_topics/src/HelpTopicPluginInterface.php b/core/modules/help_topics/src/HelpTopicPluginInterface.php
index 50eb42c7a05164f2ab861a3f906d7c33b233c0dd..00c94dbf0098c9a631e333d432a27e58c6663e76 100644
--- a/core/modules/help_topics/src/HelpTopicPluginInterface.php
+++ b/core/modules/help_topics/src/HelpTopicPluginInterface.php
@@ -2,9 +2,7 @@
namespace Drupal\help_topics;
-use Drupal\Component\Plugin\PluginInspectionInterface;
-use Drupal\Component\Plugin\DerivativeInspectionInterface;
-use Drupal\Core\Cache\CacheableDependencyInterface;
+use Drupal\help\HelpTopicPluginInterface as CoreHelpTopicPluginInterface;
/**
* Defines an interface for help topic plugin classes.
@@ -16,68 +14,6 @@
* experimental modules and development releases of contributed modules.
* See https://www.drupal.org/core/experimental for more information.
*/
-interface HelpTopicPluginInterface extends PluginInspectionInterface, DerivativeInspectionInterface, CacheableDependencyInterface {
-
- /**
- * Returns the label of the topic.
- *
- * @return string
- * The label of the topic.
- */
- public function getLabel();
-
- /**
- * Returns the body of the topic.
- *
- * @return array
- * A render array representing the body.
- */
- public function getBody();
-
- /**
- * Returns whether this is a top-level topic or not.
- *
- * @return bool
- * TRUE if this is a topic that should be displayed on the Help topics
- * list; FALSE if not.
- */
- public function isTopLevel();
-
- /**
- * Returns the IDs of related topics.
- *
- * @return string[]
- * Array of the IDs of related topics.
- */
- public function getRelated();
-
- /**
- * Returns the URL for viewing the help topic.
- *
- * @param array $options
- * (optional) See
- * \Drupal\Core\Routing\UrlGeneratorInterface::generateFromRoute() for the
- * available options.
- *
- * @return \Drupal\Core\Url
- * A URL object containing the URL for viewing the help topic.
- */
- public function toUrl(array $options = []);
-
- /**
- * Returns a link for viewing the help topic.
- *
- * @param string|null $text
- * (optional) Link text to use for the link. If NULL, defaults to the
- * topic title.
- * @param array $options
- * (optional) See
- * \Drupal\Core\Routing\UrlGeneratorInterface::generateFromRoute() for the
- * available options.
- *
- * @return \Drupal\Core\Link
- * A link object for viewing the topic.
- */
- public function toLink($text = NULL, array $options = []);
+interface HelpTopicPluginInterface extends CoreHelpTopicPluginInterface {
}
diff --git a/core/modules/help_topics/src/HelpTopicPluginManager.php b/core/modules/help_topics/src/HelpTopicPluginManager.php
index ff73d8c151f97c87a106fe478bd99071dfc4928c..fccb4bbb16c9e336a9c92dbd2e5e872caa723e38 100644
--- a/core/modules/help_topics/src/HelpTopicPluginManager.php
+++ b/core/modules/help_topics/src/HelpTopicPluginManager.php
@@ -2,12 +2,7 @@
namespace Drupal\help_topics;
-use Drupal\Core\Cache\CacheBackendInterface;
-use Drupal\Core\Extension\ModuleHandlerInterface;
-use Drupal\Core\Extension\ThemeHandlerInterface;
-use Drupal\Core\Plugin\DefaultPluginManager;
-use Drupal\Core\Plugin\Discovery\YamlDiscoveryDecorator;
-use Drupal\Core\Plugin\Discovery\ContainerDerivativeDiscoveryDecorator;
+use Drupal\help\HelpTopicPluginManager as CoreHelpTopicPluginManager;
/**
* Provides the default help_topic manager.
@@ -68,126 +63,6 @@
* experimental modules and development releases of contributed modules.
* See https://www.drupal.org/core/experimental for more information.
*/
-class HelpTopicPluginManager extends DefaultPluginManager implements HelpTopicPluginManagerInterface {
-
- /**
- * Provides default values for all help topic plugins.
- *
- * @var array
- */
- protected $defaults = [
- // The plugin ID.
- 'id' => '',
- // The title of the help topic plugin.
- 'label' => '',
- // Whether or not the topic should appear on the help topics list.
- 'top_level' => '',
- // List of related topic machine names.
- 'related' => [],
- // The class used to instantiate the plugin.
- 'class' => '',
- ];
-
- /**
- * The theme handler.
- *
- * @var \Drupal\Core\Extension\ThemeHandlerInterface
- */
- protected $themeHandler;
-
- /**
- * The app root.
- *
- * @var string
- */
- protected $root;
-
- /**
- * Constructs a new HelpTopicManager object.
- *
- * @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
- * The module handler.
- * @param \Drupal\Core\Extension\ThemeHandlerInterface $theme_handler
- * The theme handler.
- * @param \Drupal\Core\Cache\CacheBackendInterface $cache_backend
- * Cache backend instance to use.
- * @param string $root
- * The app root.
- */
- public function __construct(ModuleHandlerInterface $module_handler, ThemeHandlerInterface $theme_handler, CacheBackendInterface $cache_backend, $root) {
- // Note that the parent construct is not called because this not use
- // annotated class discovery.
- $this->moduleHandler = $module_handler;
- $this->themeHandler = $theme_handler;
- $this->alterInfo('help_topics_info');
- // Use the 'config:core.extension' cache tag so the plugin cache is
- // invalidated on theme install and uninstall.
- $this->setCacheBackend($cache_backend, 'help_topics', ['config:core.extension']);
- $this->root = (string) $root;
- }
-
- /**
- * {@inheritdoc}
- */
- protected function getDiscovery() {
- if (!isset($this->discovery)) {
- $module_directories = $this->moduleHandler->getModuleDirectories();
- $all_directories = array_merge(
- ['core' => $this->root . '/core'],
- $module_directories,
- $this->themeHandler->getThemeDirectories()
- );
-
- // Search for Twig help topics in subdirectory help_topics, under
- // modules/profiles, themes, and the core directory.
- $all_directories = array_map(function ($dir) {
- return [$dir . '/help_topics'];
- }, $all_directories);
- $discovery = new HelpTopicDiscovery($all_directories);
-
- // Also allow modules/profiles to extend help topic discovery to their
- // own plugins and derivers, in mymodule.help_topics.yml files.
- $discovery = new YamlDiscoveryDecorator($discovery, 'help_topics', $module_directories);
- $discovery = new ContainerDerivativeDiscoveryDecorator($discovery);
- $this->discovery = $discovery;
- }
- return $this->discovery;
- }
-
- /**
- * {@inheritdoc}
- */
- protected function providerExists($provider) {
- return $this->moduleHandler->moduleExists($provider) || $this->themeHandler->themeExists($provider);
- }
-
- /**
- * {@inheritdoc}
- */
- protected function findDefinitions() {
- $definitions = parent::findDefinitions();
-
- // At this point the plugin list only contains valid plugins. Ensure all
- // related plugins exist and the relationship is bi-directional. This
- // ensures topics are listed on their related topics.
- foreach ($definitions as $plugin_id => $plugin_definition) {
- foreach ($plugin_definition['related'] as $key => $related_id) {
- // If the related help topic does not exist it might be for a module
- // that is not installed. Remove it.
- // @todo Discuss this more as this could cause silent errors but it
- // offers useful functionality to relate to help topic provided by
- // extensions that are yet to be installed.
- if (!isset($definitions[$related_id])) {
- unset($definitions[$plugin_id]['related'][$key]);
- continue;
- }
- // Make the related relationship bi-directional.
- if (isset($definitions[$related_id]) && !in_array($plugin_id, $definitions[$related_id]['related'], TRUE)) {
- $definitions[$related_id]['related'][] = $plugin_id;
- }
- }
- }
- return $definitions;
- }
+class HelpTopicPluginManager extends CoreHelpTopicPluginManager {
}
diff --git a/core/modules/help_topics/src/HelpTopicPluginManagerInterface.php b/core/modules/help_topics/src/HelpTopicPluginManagerInterface.php
index 95e7ad6657be431a7178666b266b0efaaa381bb4..d07cc097d8bbaab2d1bfceecc0c48d92ed3db447 100644
--- a/core/modules/help_topics/src/HelpTopicPluginManagerInterface.php
+++ b/core/modules/help_topics/src/HelpTopicPluginManagerInterface.php
@@ -2,7 +2,7 @@
namespace Drupal\help_topics;
-use Drupal\Component\Plugin\PluginManagerInterface;
+use Drupal\help\HelpTopicPluginManagerInterface as CoreHelpTopicPluginManagerInterface;
/**
* Defines an interface for managing help topics and storing their definitions.
@@ -12,5 +12,6 @@
* experimental modules and development releases of contributed modules.
* See https://www.drupal.org/core/experimental for more information.
*/
-interface HelpTopicPluginManagerInterface extends PluginManagerInterface {
+interface HelpTopicPluginManagerInterface extends CoreHelpTopicPluginManagerInterface {
+
}
diff --git a/core/modules/help_topics/src/HelpTopicTwig.php b/core/modules/help_topics/src/HelpTopicTwig.php
index 3da9427f28ec987012711006cec0fbc3472e1f0e..8e88eade1409e1be0ddc6dd88d4fcf0fc3c51e29 100644
--- a/core/modules/help_topics/src/HelpTopicTwig.php
+++ b/core/modules/help_topics/src/HelpTopicTwig.php
@@ -2,10 +2,7 @@
namespace Drupal\help_topics;
-use Drupal\Core\Cache\Cache;
-use Drupal\Core\Plugin\ContainerFactoryPluginInterface;
-use Drupal\Core\Template\TwigEnvironment;
-use Symfony\Component\DependencyInjection\ContainerInterface;
+use Drupal\help\HelpTopicTwig as CoreHelpTopicTwig;
/**
* Represents a help topic plugin whose definition comes from a Twig file.
@@ -19,72 +16,6 @@
* experimental modules and development releases of contributed modules.
* See https://www.drupal.org/core/experimental for more information.
*/
-class HelpTopicTwig extends HelpTopicPluginBase implements ContainerFactoryPluginInterface {
-
- /**
- * The Twig environment.
- *
- * @var \Drupal\Core\Template\TwigEnvironment
- */
- protected $twig;
-
- /**
- * HelpTopicPluginBase constructor.
- *
- * @param array $configuration
- * A configuration array containing information about the plugin instance.
- * @param string $plugin_id
- * The plugin_id for the plugin instance.
- * @param mixed $plugin_definition
- * The plugin implementation definition.
- * @param \Drupal\Core\Template\TwigEnvironment $twig
- * The Twig environment.
- */
- public function __construct(array $configuration, $plugin_id, $plugin_definition, TwigEnvironment $twig) {
- parent::__construct($configuration, $plugin_id, $plugin_definition);
- $this->twig = $twig;
- }
-
- /**
- * {@inheritdoc}
- */
- public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
- return new static(
- $configuration,
- $plugin_id,
- $plugin_definition,
- $container->get('twig')
- );
- }
-
- /**
- * {@inheritdoc}
- */
- public function getBody() {
- return [
- '#markup' => $this->twig->load('@help_topics/' . $this->getPluginId() . '.html.twig')->render(),
- ];
- }
-
- /**
- * {@inheritdoc}
- */
- public function getCacheContexts() {
- return [];
- }
-
- /**
- * {@inheritdoc}
- */
- public function getCacheTags() {
- return ['core.extension'];
- }
-
- /**
- * {@inheritdoc}
- */
- public function getCacheMaxAge() {
- return Cache::PERMANENT;
- }
+class HelpTopicTwig extends CoreHelpTopicTwig {
}
diff --git a/core/modules/help_topics/src/HelpTopicTwigLoader.php b/core/modules/help_topics/src/HelpTopicTwigLoader.php
index 7f04f8f29f3a4b10d93813c2b3a1fab7f5d96f53..db12a36d24570013a32ded7cf846c2ab5e5ec837 100644
--- a/core/modules/help_topics/src/HelpTopicTwigLoader.php
+++ b/core/modules/help_topics/src/HelpTopicTwigLoader.php
@@ -2,14 +2,7 @@
namespace Drupal\help_topics;
-use Drupal\Component\FrontMatter\FrontMatter;
-use Drupal\Component\Serialization\Exception\InvalidDataTypeException;
-use Drupal\Core\Extension\ModuleHandlerInterface;
-use Drupal\Core\Extension\ThemeHandlerInterface;
-use Drupal\Core\Serialization\Yaml;
-use Twig\Error\LoaderError;
-use Twig\Loader\FilesystemLoader;
-use Twig\Source;
+use Drupal\help\HelpTopicTwigLoader as CoreHelpTopicTwigLoader;
/**
* Loads help topic Twig files from the filesystem.
@@ -26,87 +19,6 @@
* experimental modules and development releases of contributed modules.
* See https://www.drupal.org/core/experimental for more information.
*/
-class HelpTopicTwigLoader extends FilesystemLoader {
-
- /**
- * {@inheritdoc}
- */
- const MAIN_NAMESPACE = 'help_topics';
-
- /**
- * Constructs a new HelpTopicTwigLoader object.
- *
- * @param string $root_path
- * The root path.
- * @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
- * The module handler service.
- * @param \Drupal\Core\Extension\ThemeHandlerInterface $theme_handler
- * The theme handler service.
- */
- public function __construct($root_path, ModuleHandlerInterface $module_handler, ThemeHandlerInterface $theme_handler) {
- parent::__construct([], $root_path);
- // Add help_topics directories for modules and themes in the 'help_topic'
- // namespace, plus core.
- $this->addExtension($root_path . '/core');
- array_map([$this, 'addExtension'], $module_handler->getModuleDirectories());
- array_map([$this, 'addExtension'], $theme_handler->getThemeDirectories());
- }
-
- /**
- * Adds an extensions help_topics directory to the Twig loader.
- *
- * @param $path
- * The path to the extension.
- */
- protected function addExtension($path) {
- $path .= DIRECTORY_SEPARATOR . 'help_topics';
- if (is_dir($path)) {
- $this->cache = $this->errorCache = [];
- $this->paths[self::MAIN_NAMESPACE][] = rtrim($path, '/\\');
- }
- }
-
- /**
- * {@inheritdoc}
- */
- public function getSourceContext(string $name): Source {
- $path = $this->findTemplate($name);
-
- $contents = file_get_contents($path);
- try {
- // Note: always use \Drupal\Core\Serialization\Yaml here instead of the
- // "serializer.yaml" service. This allows the core serializer to utilize
- // core related functionality which isn't available as the standalone
- // component based serializer.
- $front_matter = new FrontMatter($contents, Yaml::class);
-
- // Reconstruct the content if there is front matter data detected. Prepend
- // the source with {% line \d+ %} to inform Twig that the source code
- // actually starts on a different line past the front matter data. This is
- // particularly useful when used in error reporting.
- if ($front_matter->getData() && ($line = $front_matter->getLine())) {
- $contents = "{% line $line %}" . $front_matter->getContent();
- }
- }
- catch (InvalidDataTypeException $e) {
- throw new LoaderError(sprintf('Malformed YAML in help topic "%s": %s.', $path, $e->getMessage()));
- }
-
- return new Source($contents, $name, $path);
- }
-
- /**
- * {@inheritdoc}
- */
- protected function findTemplate($name, $throw = TRUE) {
- if (!str_ends_with($name, '.html.twig')) {
- if (!$throw) {
- return NULL;
- }
- $extension = pathinfo($name, PATHINFO_EXTENSION);
- throw new LoaderError(sprintf("Help topic %s has an invalid file extension (%s). Only help topics ending .html.twig are allowed.", $name, $extension));
- }
- return parent::findTemplate($name, $throw);
- }
+class HelpTopicTwigLoader extends CoreHelpTopicTwigLoader {
}
diff --git a/core/modules/help_topics/src/HelpTwigExtension.php b/core/modules/help_topics/src/HelpTwigExtension.php
index 53a09aee116f4d68c3dd976321ce1a2e8db6c675..31d27cf38b235815d09082e3171fc3c5183a1d26 100644
--- a/core/modules/help_topics/src/HelpTwigExtension.php
+++ b/core/modules/help_topics/src/HelpTwigExtension.php
@@ -2,165 +2,16 @@
namespace Drupal\help_topics;
-use Drupal\Component\Plugin\Exception\PluginNotFoundException;
-use Drupal\Core\Access\AccessManagerInterface;
-use Drupal\Core\Render\BubbleableMetadata;
-use Drupal\Core\StringTranslation\StringTranslationTrait;
-use Drupal\Core\StringTranslation\TranslationInterface;
-use Drupal\Core\Url;
-use Symfony\Component\Routing\Exception\InvalidParameterException;
-use Symfony\Component\Routing\Exception\MissingMandatoryParametersException;
-use Symfony\Component\Routing\Exception\RouteNotFoundException;
-use Twig\Extension\AbstractExtension;
-use Twig\TwigFunction;
+use Drupal\help\HelpTwigExtension as CoreHelpTwigExtension;
/**
* Defines and registers Drupal Twig extensions for rendering help topics.
+ *
+ * @internal
+ * Help Topics is currently experimental and should only be leveraged by
+ * experimental modules and development releases of contributed modules.
+ * See https://www.drupal.org/core/experimental for more information.
*/
-class HelpTwigExtension extends AbstractExtension {
-
- use StringTranslationTrait;
-
- /**
- * The access manager.
- *
- * @var \Drupal\Core\Access\AccessManagerInterface
- */
- protected $accessManager;
-
- /**
- * The help topic plugin manager.
- *
- * @var \Drupal\help_topics\HelpTopicPluginManagerInterface
- */
- protected $pluginManager;
-
- /**
- * Constructs a \Drupal\help_topics\HelpTwigExtension.
- *
- * @param \Drupal\Core\Access\AccessManagerInterface $access_manager
- * The access manager.
- * @param \Drupal\help_topics\HelpTopicPluginManagerInterface $plugin_manager
- * The help topic plugin manager service.
- * @param \Drupal\Core\StringTranslation\TranslationInterface $string_translation
- * The string translation service.
- */
- public function __construct(AccessManagerInterface $access_manager, HelpTopicPluginManagerInterface $plugin_manager, TranslationInterface $string_translation) {
- $this->accessManager = $access_manager;
- $this->pluginManager = $plugin_manager;
- $this->stringTranslation = $string_translation;
- }
-
- /**
- * {@inheritdoc}
- */
- public function getFunctions() {
- return [
- new TwigFunction('help_route_link', [$this, 'getRouteLink']),
- new TwigFunction('help_topic_link', [$this, 'getTopicLink']),
- ];
- }
-
- /**
- * Returns a link or plain text, given text, route name, and parameters.
- *
- * @param string $text
- * The link text.
- * @param string $route
- * The name of the route.
- * @param array $parameters
- * (optional) An associative array of route parameter names and values.
- * @param array $options
- * (optional) An associative array of additional options. The 'absolute'
- * option is forced to be TRUE.
- *
- * @return array
- * A render array with a generated absolute link to the given route. If
- * the user does not have permission for the route, or an exception occurs,
- * such as a missing route or missing parameters, the render array is for
- * the link text as a plain string instead.
- *
- * @see \Drupal\Core\Template\TwigExtension::getUrl()
- */
- public function getRouteLink(string $text, string $route, array $parameters = [], array $options = []): array {
- assert($this->accessManager instanceof AccessManagerInterface, "The access manager hasn't been set up. Any configuration YAML file with a service directive dealing with the Twig configuration can cause this, most likely found in a recently installed or changed module.");
-
- $bubbles = new BubbleableMetadata();
- $bubbles->addCacheTags(['route_match']);
-
- try {
- $access_object = $this->accessManager->checkNamedRoute($route, $parameters, NULL, TRUE);
- $bubbles->addCacheableDependency($access_object);
-
- if ($access_object->isAllowed()) {
- $options['absolute'] = TRUE;
- $url = Url::fromRoute($route, $parameters, $options);
- // Generate the URL to check for parameter problems and collect
- // cache metadata.
- $generated = $url->toString(TRUE);
- $bubbles->addCacheableDependency($generated);
- $build = [
- '#title' => $text,
- '#type' => 'link',
- '#url' => $url,
- ];
- }
- else {
- // If the user doesn't have access, return the link text.
- $build = ['#markup' => $text];
- }
- }
- catch (RouteNotFoundException | MissingMandatoryParametersException | InvalidParameterException $e) {
- // If the route had one of these exceptions, return the link text.
- $build = ['#markup' => $text];
- }
- $bubbles->applyTo($build);
- return $build;
- }
-
- /**
- * Returns a link to a help topic, or the title of the topic.
- *
- * @param string $topic_id
- * The help topic ID.
- *
- * @return array
- * A render array with a generated absolute link to the given topic. If
- * the user does not have permission to view the topic, or an exception
- * occurs, such as the topic not being defined due to a module not being
- * installed, a default string is returned.
- *
- * @see \Drupal\Core\Template\TwigExtension::getUrl()
- */
- public function getTopicLink(string $topic_id): array {
- assert($this->pluginManager instanceof HelpTopicPluginManagerInterface, "The plugin manager hasn't been set up. Any configuration YAML file with a service directive dealing with the Twig configuration can cause this, most likely found in a recently installed or changed module.");
-
- $bubbles = new BubbleableMetadata();
- $bubbles->addCacheableDependency($this->pluginManager);
- try {
- $plugin = $this->pluginManager->createInstance($topic_id);
- }
- catch (PluginNotFoundException $e) {
- // Not a topic.
- $plugin = FALSE;
- }
-
- if ($plugin) {
- $parameters = ['id' => $topic_id];
- $route = 'help.help_topic';
- $build = $this->getRouteLink($plugin->getLabel(), $route, $parameters);
- $bubbles->addCacheableDependency($plugin);
- }
- else {
- $build = [
- '#markup' => $this->t('Missing help topic %topic', [
- '%topic' => $topic_id,
- ]),
- ];
- }
-
- $bubbles->applyTo($build);
- return $build;
- }
+class HelpTwigExtension extends CoreHelpTwigExtension {
}
diff --git a/core/modules/help_topics/src/Plugin/HelpSection/HelpTopicSection.php b/core/modules/help_topics/src/Plugin/HelpSection/HelpTopicSection.php
index b69782b7edbc41f8160f4af0d7f44758ac761b5a..04040fde2e0e27eb3ffdb822b4f91b8d3f575287 100644
--- a/core/modules/help_topics/src/Plugin/HelpSection/HelpTopicSection.php
+++ b/core/modules/help_topics/src/Plugin/HelpSection/HelpTopicSection.php
@@ -2,280 +2,15 @@
namespace Drupal\help_topics\Plugin\HelpSection;
-use Drupal\Core\Cache\CacheableMetadata;
-use Drupal\help_topics\SearchableHelpInterface;
-use Drupal\help_topics\HelpTopicPluginInterface;
-use Drupal\help_topics\HelpTopicPluginManagerInterface;
-use Drupal\Core\Language\LanguageDefault;
-use Drupal\Core\Language\LanguageInterface;
-use Drupal\Core\Language\LanguageManagerInterface;
-use Drupal\Core\Plugin\ContainerFactoryPluginInterface;
-use Drupal\help\Plugin\HelpSection\HelpSectionPluginBase;
-use Drupal\Core\Render\RendererInterface;
-use Drupal\Core\Render\RenderContext;
-use Drupal\Core\StringTranslation\TranslationManager;
-use Symfony\Component\DependencyInjection\ContainerInterface;
+use Drupal\help\Plugin\HelpSection\HelpTopicSection as CoreHelpTopicSection;
/**
* Provides the help topics list section for the help page.
*
- * @HelpSection(
- * id = "help_topics",
- * title = @Translation("Topics"),
- * weight = -10,
- * description = @Translation("Topics can be provided by modules or themes. Top-level help topics on your site:"),
- * permission = "access administration pages"
- * )
- *
* @internal
* Help Topic is currently experimental and should only be leveraged by
* experimental modules and development releases of contributed modules.
* See https://www.drupal.org/core/experimental for more information.
*/
-class HelpTopicSection extends HelpSectionPluginBase implements ContainerFactoryPluginInterface, SearchableHelpInterface {
-
- /**
- * The plugin manager.
- *
- * @var \Drupal\help_topics\HelpTopicPluginManagerInterface
- */
- protected $pluginManager;
-
- /**
- * The top level help topic plugins.
- *
- * @var \Drupal\help_topics\HelpTopicPluginInterface[]
- */
- protected $topLevelPlugins;
-
- /**
- * The merged top level help topic plugins cache metadata.
- *
- * @var \Drupal\Core\Cache\CacheableMetadata
- */
- protected $cacheableMetadata;
-
- /**
- * The Renderer service to format the username and node.
- *
- * @var \Drupal\Core\Render\RendererInterface
- */
- protected $renderer;
-
- /**
- * The default language object.
- *
- * @var \Drupal\Core\Language\LanguageDefault
- */
- protected $defaultLanguage;
-
- /**
- * The language manager.
- *
- * @var \Drupal\Core\Language\LanguageManagerInterface
- */
- protected $languageManager;
-
- /**
- * The string translation service.
- */
- protected TranslationManager $translationManager;
-
- /**
- * Constructs a HelpTopicSection object.
- *
- * @param array $configuration
- * A configuration array containing information about the plugin instance.
- * @param string $plugin_id
- * The plugin_id for the plugin instance.
- * @param mixed $plugin_definition
- * The plugin implementation definition.
- * @param \Drupal\help_topics\HelpTopicPluginManagerInterface $plugin_manager
- * The help topic plugin manager service.
- * @param \Drupal\Core\Render\RendererInterface $renderer
- * The renderer.
- * @param \Drupal\Core\Language\LanguageDefault $default_language
- * The default language object.
- * @param \Drupal\Core\Language\LanguageManagerInterface $language_manager
- * The language manager.
- * @param \Drupal\Core\StringTranslation\TranslationManager $translation_manager
- * The translation manager. We are using a method that doesn't exist on an
- * interface, so require this class.
- */
- public function __construct(array $configuration, $plugin_id, $plugin_definition, HelpTopicPluginManagerInterface $plugin_manager, RendererInterface $renderer, LanguageDefault $default_language, LanguageManagerInterface $language_manager, TranslationManager $translation_manager) {
- parent::__construct($configuration, $plugin_id, $plugin_definition);
- $this->pluginManager = $plugin_manager;
- $this->renderer = $renderer;
- $this->defaultLanguage = $default_language;
- $this->languageManager = $language_manager;
- $this->translationManager = $translation_manager;
- }
-
- /**
- * {@inheritdoc}
- */
- public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
- return new static(
- $configuration,
- $plugin_id,
- $plugin_definition,
- $container->get('plugin.manager.help_topic'),
- $container->get('renderer'),
- $container->get('language.default'),
- $container->get('language_manager'),
- $container->get('string_translation')
- );
- }
-
- /**
- * {@inheritdoc}
- */
- public function getCacheTags() {
- return $this->getCacheMetadata()->getCacheTags();
- }
-
- /**
- * {@inheritdoc}
- */
- public function getCacheContexts() {
- return $this->getCacheMetadata()->getCacheContexts();
- }
-
- /**
- * {@inheritdoc}
- */
- public function getCacheMaxAge() {
- return $this->getCacheMetadata()->getCacheMaxAge();
- }
-
- /**
- * {@inheritdoc}
- */
- public function listTopics() {
- // Map the top level help topic plugins to a list of topic links.
- return array_map(function (HelpTopicPluginInterface $topic) {
- return $topic->toLink();
- }, $this->getPlugins());
- }
-
- /**
- * Gets the top level help topic plugins.
- *
- * @return \Drupal\help_topics\HelpTopicPluginInterface[]
- * The top level help topic plugins.
- */
- protected function getPlugins() {
- if (!isset($this->topLevelPlugins)) {
- $definitions = $this->pluginManager->getDefinitions();
-
- // Get all the top level topics and merge their list cache tags.
- foreach ($definitions as $definition) {
- if ($definition['top_level']) {
- $this->topLevelPlugins[$definition['id']] = $this->pluginManager->createInstance($definition['id']);
- }
- }
-
- // Sort the top level topics by label and, if the labels match, then by
- // plugin ID.
- usort($this->topLevelPlugins, function (HelpTopicPluginInterface $a, HelpTopicPluginInterface $b) {
- $a_label = (string) $a->getLabel();
- $b_label = (string) $b->getLabel();
- if ($a_label === $b_label) {
- return $a->getPluginId() <=> $b->getPluginId();
- }
- return strnatcasecmp($a_label, $b_label);
- });
- }
- return $this->topLevelPlugins;
- }
-
- /**
- * {@inheritdoc}
- */
- public function listSearchableTopics() {
- $definitions = $this->pluginManager->getDefinitions();
- return array_column($definitions, 'id');
- }
-
- /**
- * {@inheritdoc}
- */
- public function renderTopicForSearch($topic_id, LanguageInterface $language) {
- $plugin = $this->pluginManager->createInstance($topic_id);
- if (!$plugin) {
- return [];
- }
-
- // We are rendering this topic for search indexing or search results,
- // possibly in a different language than the current language. The topic
- // title and body come from translatable things in the Twig template, so we
- // need to set the default language to the desired language, render them,
- // then restore the default language so we do not affect other cron
- // processes. Also, just in case there is an exception, wrap the whole
- // thing in a try/finally block, and reset the language in the finally part.
- $old_language = $this->defaultLanguage->get();
- try {
- if ($old_language->getId() !== $language->getId()) {
- $this->defaultLanguage->set($language);
- $this->translationManager->setDefaultLangcode($language->getId());
- $this->languageManager->reset();
- }
- $topic = [];
-
- // Render the title in this language.
- $title_build = [
- 'title' => [
- '#type' => '#markup',
- '#markup' => $plugin->getLabel(),
- ],
- ];
- $topic['title'] = $this->renderer->renderPlain($title_build);
- $cacheable_metadata = CacheableMetadata::createFromRenderArray($title_build);
-
- // Render the body in this language. For this, we need to set up a render
- // context, because the Twig plugins that provide the body assumes one
- // is present.
- $context = new RenderContext();
- $build = [
- 'body' => $this->renderer->executeInRenderContext($context, [$plugin, 'getBody']),
- ];
- $topic['text'] = $this->renderer->renderPlain($build);
- $cacheable_metadata->addCacheableDependency(CacheableMetadata::createFromRenderArray($build));
- $cacheable_metadata->addCacheableDependency($plugin);
- if (!$context->isEmpty()) {
- $cacheable_metadata->addCacheableDependency($context->pop());
- }
-
- // Add the other information.
- $topic['url'] = $plugin->toUrl();
- $topic['cacheable_metadata'] = $cacheable_metadata;
- }
- finally {
- // Restore the original language.
- if ($old_language->getId() !== $language->getId()) {
- $this->defaultLanguage->set($old_language);
- $this->translationManager->setDefaultLangcode($old_language->getId());
- $this->languageManager->reset();
- }
- }
-
- return $topic;
- }
-
- /**
- * Gets the merged CacheableMetadata for all the top level help topic plugins.
- *
- * @return \Drupal\Core\Cache\CacheableMetadata
- * The merged CacheableMetadata for all the top level help topic plugins.
- */
- protected function getCacheMetadata() {
- if (!isset($this->cacheableMetadata)) {
- $this->cacheableMetadata = new CacheableMetadata();
- foreach ($this->getPlugins() as $plugin) {
- $this->cacheableMetadata->addCacheableDependency($plugin);
- }
- }
- return $this->cacheableMetadata;
- }
-
+class HelpTopicSection extends CoreHelpTopicSection {
}
diff --git a/core/modules/help_topics/src/Plugin/Search/HelpSearch.php b/core/modules/help_topics/src/Plugin/Search/HelpSearch.php
index 49b0038d0d1e42d0268a2734815a8d59ba4c43f0..7d1cade82cd484dedfe3b0475277d0079b59a711 100644
--- a/core/modules/help_topics/src/Plugin/Search/HelpSearch.php
+++ b/core/modules/help_topics/src/Plugin/Search/HelpSearch.php
@@ -2,24 +2,7 @@
namespace Drupal\help_topics\Plugin\Search;
-use Drupal\Core\Access\AccessibleInterface;
-use Drupal\Core\Access\AccessResult;
-use Drupal\Core\Config\Config;
-use Drupal\Core\Database\Connection;
-use Drupal\Core\Database\Query\PagerSelectExtender;
-use Drupal\Core\Database\StatementInterface;
-use Drupal\Core\Language\LanguageInterface;
-use Drupal\Core\Language\LanguageManagerInterface;
-use Drupal\Core\Messenger\MessengerInterface;
-use Drupal\Core\Session\AccountInterface;
-use Drupal\Core\State\StateInterface;
-use Drupal\help\HelpSectionManager;
-use Drupal\help_topics\SearchableHelpInterface;
-use Drupal\search\Plugin\SearchIndexingInterface;
-use Drupal\search\Plugin\SearchPluginBase;
-use Drupal\search\SearchIndexInterface;
-use Drupal\search\SearchQuery;
-use Symfony\Component\DependencyInjection\ContainerInterface;
+use Drupal\help\Plugin\Search\HelpSearch as CoreHelpSearch;
/**
* Handles searching for help using the Search module index.
@@ -30,498 +13,11 @@
* @see \Drupal\help\HelpSearchInterface
* @see \Drupal\help\HelpSectionPluginInterface
*
- * @SearchPlugin(
- * id = "help_search",
- * title = @Translation("Help"),
- * use_admin_theme = TRUE,
- * )
- *
* @internal
* Help Topics is currently experimental and should only be leveraged by
* experimental modules and development releases of contributed modules.
* See https://www.drupal.org/core/experimental for more information.
*/
-class HelpSearch extends SearchPluginBase implements AccessibleInterface, SearchIndexingInterface {
-
- /**
- * The current database connection.
- *
- * @var \Drupal\Core\Database\Connection
- */
- protected $database;
-
- /**
- * A config object for 'search.settings'.
- *
- * @var \Drupal\Core\Config\Config
- */
- protected $searchSettings;
-
- /**
- * The language manager.
- *
- * @var \Drupal\Core\Language\LanguageManagerInterface
- */
- protected $languageManager;
-
- /**
- * The Drupal account to use for checking for access to search.
- *
- * @var \Drupal\Core\Session\AccountInterface
- */
- protected $account;
-
- /**
- * The messenger.
- *
- * @var \Drupal\Core\Messenger\MessengerInterface
- */
- protected $messenger;
-
- /**
- * The state object.
- *
- * @var \Drupal\Core\State\StateInterface
- */
- protected $state;
-
- /**
- * The help section plugin manager.
- *
- * @var \Drupal\help\HelpSectionManager
- */
- protected $helpSectionManager;
-
- /**
- * The search index.
- *
- * @var \Drupal\search\SearchIndexInterface
- */
- protected $searchIndex;
-
- /**
- * {@inheritdoc}
- */
- public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
- return new static(
- $configuration,
- $plugin_id,
- $plugin_definition,
- $container->get('database'),
- $container->get('config.factory')->get('search.settings'),
- $container->get('language_manager'),
- $container->get('messenger'),
- $container->get('current_user'),
- $container->get('state'),
- $container->get('plugin.manager.help_section'),
- $container->get('search.index')
- );
- }
-
- /**
- * Constructs a \Drupal\help_search\Plugin\Search\HelpSearch object.
- *
- * @param array $configuration
- * Configuration for the plugin.
- * @param string $plugin_id
- * The plugin_id for the plugin instance.
- * @param mixed $plugin_definition
- * The plugin implementation definition.
- * @param \Drupal\Core\Database\Connection $database
- * The current database connection.
- * @param \Drupal\Core\Config\Config $search_settings
- * A config object for 'search.settings'.
- * @param \Drupal\Core\Language\LanguageManagerInterface $language_manager
- * The language manager.
- * @param \Drupal\Core\Messenger\MessengerInterface $messenger
- * The messenger.
- * @param \Drupal\Core\Session\AccountInterface $account
- * The $account object to use for checking for access to view help.
- * @param \Drupal\Core\State\StateInterface $state
- * The state object.
- * @param \Drupal\help\HelpSectionManager $help_section_manager
- * The help section manager.
- * @param \Drupal\search\SearchIndexInterface $search_index
- * The search index.
- */
- public function __construct(array $configuration, $plugin_id, $plugin_definition, Connection $database, Config $search_settings, LanguageManagerInterface $language_manager, MessengerInterface $messenger, AccountInterface $account, StateInterface $state, HelpSectionManager $help_section_manager, SearchIndexInterface $search_index) {
- parent::__construct($configuration, $plugin_id, $plugin_definition);
- $this->database = $database;
- $this->searchSettings = $search_settings;
- $this->languageManager = $language_manager;
- $this->messenger = $messenger;
- $this->account = $account;
- $this->state = $state;
- $this->helpSectionManager = $help_section_manager;
- $this->searchIndex = $search_index;
- }
-
- /**
- * {@inheritdoc}
- */
- public function access($operation = 'view', AccountInterface $account = NULL, $return_as_object = FALSE) {
- $result = AccessResult::allowedIfHasPermission($account, 'access administration pages');
- return $return_as_object ? $result : $result->isAllowed();
- }
-
- /**
- * {@inheritdoc}
- */
- public function getType() {
- return $this->getPluginId();
- }
-
- /**
- * {@inheritdoc}
- */
- public function execute() {
- if ($this->isSearchExecutable()) {
- $results = $this->findResults();
-
- if ($results) {
- return $this->prepareResults($results);
- }
- }
-
- return [];
- }
-
- /**
- * Finds the search results.
- *
- * @return \Drupal\Core\Database\StatementInterface|null
- * Results from search query execute() method, or NULL if the search
- * failed.
- */
- protected function findResults() {
- // We need to check access for the current user to see the topics that
- // could be returned by search. Each entry in the help_search_items
- // database has an optional permission that comes from the HelpSection
- // plugin, in addition to the generic 'access administration pages'
- // permission. In order to enforce these permissions so only topics that
- // the current user has permission to view are selected by the query, make
- // a list of the permission strings and pre-check those permissions.
- $this->addCacheContexts(['user.permissions']);
- if (!$this->account->hasPermission('access administration pages')) {
- return NULL;
- }
- $permissions = $this->database
- ->select('help_search_items', 'hsi')
- ->distinct()
- ->fields('hsi', ['permission'])
- ->condition('permission', '', '<>')
- ->execute()
- ->fetchCol();
- $denied_permissions = array_filter($permissions, function ($permission) {
- return !$this->account->hasPermission($permission);
- });
-
- $query = $this->database
- ->select('search_index', 'i')
- // Restrict the search to the current interface language.
- ->condition('i.langcode', $this->languageManager->getCurrentLanguage()->getId())
- ->extend(SearchQuery::class)
- ->extend(PagerSelectExtender::class);
- $query->innerJoin('help_search_items', 'hsi', '[i].[sid] = [hsi].[sid] AND [i].[type] = :type', [':type' => $this->getType()]);
- if ($denied_permissions) {
- $query->condition('hsi.permission', $denied_permissions, 'NOT IN');
- }
- $query->searchExpression($this->getKeywords(), $this->getType());
-
- $find = $query
- ->fields('i', ['langcode'])
- ->fields('hsi', ['section_plugin_id', 'topic_id'])
- // Since SearchQuery makes these into GROUP BY queries, if we add
- // a field, for PostgreSQL we also need to make it an aggregate or a
- // GROUP BY. In this case, we want GROUP BY.
- ->groupBy('i.langcode')
- ->groupBy('hsi.section_plugin_id')
- ->groupBy('hsi.topic_id')
- ->limit(10)
- ->execute();
-
- // Check query status and set messages if needed.
- $status = $query->getStatus();
-
- if ($status & SearchQuery::EXPRESSIONS_IGNORED) {
- $this->messenger->addWarning($this->t('Your search used too many AND/OR expressions. Only the first @count terms were included in this search.', ['@count' => $this->searchSettings->get('and_or_limit')]));
- }
-
- if ($status & SearchQuery::LOWER_CASE_OR) {
- $this->messenger->addWarning($this->t('Search for either of the two terms with uppercase <strong>OR</strong>. For example, <strong>cats OR dogs</strong>.'));
- }
-
- if ($status & SearchQuery::NO_POSITIVE_KEYWORDS) {
- $this->messenger->addWarning($this->formatPlural($this->searchSettings->get('index.minimum_word_size'), 'You must include at least one keyword to match in the content, and punctuation is ignored.', 'You must include at least one keyword to match in the content. Keywords must be at least @count characters, and punctuation is ignored.'));
- }
-
- $unindexed = $this->state->get('help_search_unindexed_count', 1);
- if ($unindexed) {
- $this->messenger()->addWarning($this->t('Help search is not fully indexed. Some results may be missing or incorrect.'));
- }
-
- return $find;
- }
-
- /**
- * Prepares search results for display.
- *
- * @param \Drupal\Core\Database\StatementInterface $found
- * Results found from a successful search query execute() method.
- *
- * @return array
- * List of search result render arrays, with links, snippets, etc.
- */
- protected function prepareResults(StatementInterface $found) {
- $results = [];
- $plugins = [];
- $languages = [];
- $keys = $this->getKeywords();
- foreach ($found as $item) {
- $section_plugin_id = $item->section_plugin_id;
- if (!isset($plugins[$section_plugin_id])) {
- $plugins[$section_plugin_id] = $this->getSectionPlugin($section_plugin_id);
- }
- if ($plugins[$section_plugin_id]) {
- $langcode = $item->langcode;
- if (!isset($languages[$langcode])) {
- $languages[$langcode] = $this->languageManager->getLanguage($item->langcode);
- }
- $topic = $plugins[$section_plugin_id]->renderTopicForSearch($item->topic_id, $languages[$langcode]);
- if ($topic) {
- if (isset($topic['cacheable_metadata'])) {
- $this->addCacheableDependency($topic['cacheable_metadata']);
- }
- $results[] = [
- 'title' => $topic['title'],
- 'link' => $topic['url']->toString(),
- 'snippet' => search_excerpt($keys, $topic['title'] . ' ' . $topic['text'], $item->langcode),
- 'langcode' => $item->langcode,
- ];
- }
- }
- }
-
- return $results;
- }
-
- /**
- * {@inheritdoc}
- */
- public function updateIndex() {
- // Update the list of items to be indexed.
- $this->updateTopicList();
-
- // Find some items that need to be updated. Start with ones that have
- // never been indexed.
- $limit = (int) $this->searchSettings->get('index.cron_limit');
-
- $query = $this->database->select('help_search_items', 'hsi');
- $query->fields('hsi', ['sid', 'section_plugin_id', 'topic_id']);
- $query->leftJoin('search_dataset', 'sd', '[sd].[sid] = [hsi].[sid] AND [sd].[type] = :type', [':type' => $this->getType()]);
- $query->where('[sd].[sid] IS NULL');
- $query->groupBy('hsi.sid')
- ->groupBy('hsi.section_plugin_id')
- ->groupBy('hsi.topic_id')
- ->range(0, $limit);
- $items = $query->execute()->fetchAll();
-
- // If there is still space in the indexing limit, index items that have
- // been indexed before, but are currently marked as needing a re-index.
- if (count($items) < $limit) {
- $query = $this->database->select('help_search_items', 'hsi');
- $query->fields('hsi', ['sid', 'section_plugin_id', 'topic_id']);
- $query->leftJoin('search_dataset', 'sd', '[sd].[sid] = [hsi].[sid] AND [sd].[type] = :type', [':type' => $this->getType()]);
- $query->condition('sd.reindex', 0, '<>');
- $query->groupBy('hsi.sid')
- ->groupBy('hsi.section_plugin_id')
- ->groupBy('hsi.topic_id')
- ->range(0, $limit - count($items));
- $items = $items + $query->execute()->fetchAll();
- }
-
- // Index the items we have chosen, in all available languages.
- $language_list = $this->languageManager->getLanguages(LanguageInterface::STATE_CONFIGURABLE);
- $section_plugins = [];
-
- $words = [];
- try {
- foreach ($items as $item) {
- $section_plugin_id = $item->section_plugin_id;
- if (!isset($section_plugins[$section_plugin_id])) {
- $section_plugins[$section_plugin_id] = $this->getSectionPlugin($section_plugin_id);
- }
-
- if (!$section_plugins[$section_plugin_id]) {
- $this->removeItemsFromIndex($item->sid);
- continue;
- }
-
- $section_plugin = $section_plugins[$section_plugin_id];
- $this->searchIndex->clear($this->getType(), $item->sid);
- foreach ($language_list as $langcode => $language) {
- $topic = $section_plugin->renderTopicForSearch($item->topic_id, $language);
- if ($topic) {
- // Index the title plus body text.
- $text = '<h1>' . $topic['title'] . '</h1>' . "\n" . $topic['text'];
- $words += $this->searchIndex->index($this->getType(), $item->sid, $langcode, $text, FALSE);
- }
- }
- }
- }
- finally {
- $this->searchIndex->updateWordWeights($words);
- $this->updateIndexState();
- }
- }
-
- /**
- * {@inheritdoc}
- */
- public function indexClear() {
- $this->searchIndex->clear($this->getType());
- }
-
- /**
- * Rebuilds the database table containing topics to be indexed.
- */
- public function updateTopicList() {
- // Start by fetching the existing list, so we can remove items not found
- // at the end.
- $old_list = $this->database->select('help_search_items', 'hsi')
- ->fields('hsi', ['sid', 'topic_id', 'section_plugin_id', 'permission'])
- ->execute();
- $old_list_ordered = [];
- $sids_to_remove = [];
- foreach ($old_list as $item) {
- $old_list_ordered[$item->section_plugin_id][$item->topic_id] = $item;
- $sids_to_remove[$item->sid] = $item->sid;
- }
-
- $section_plugins = $this->helpSectionManager->getDefinitions();
- foreach ($section_plugins as $section_plugin_id => $section_plugin_definition) {
- $plugin = $this->getSectionPlugin($section_plugin_id);
- if (!$plugin) {
- continue;
- }
- $permission = $section_plugin_definition['permission'] ?? '';
- foreach ($plugin->listSearchableTopics() as $topic_id) {
- if (isset($old_list_ordered[$section_plugin_id][$topic_id])) {
- $old_item = $old_list_ordered[$section_plugin_id][$topic_id];
- if ($old_item->permission == $permission) {
- // Record has not changed.
- unset($sids_to_remove[$old_item->sid]);
- continue;
- }
-
- // Permission has changed, update record.
- $this->database->update('help_search_items')
- ->condition('sid', $old_item->sid)
- ->fields(['permission' => $permission])
- ->execute();
- unset($sids_to_remove[$old_item->sid]);
- continue;
- }
-
- // New record, create it.
- $this->database->insert('help_search_items')
- ->fields([
- 'section_plugin_id' => $section_plugin_id,
- 'permission' => $permission,
- 'topic_id' => $topic_id,
- ])
- ->execute();
- }
- }
-
- // Remove remaining items from the index.
- $this->removeItemsFromIndex($sids_to_remove);
- }
-
- /**
- * Updates the 'help_search_unindexed_count' state variable.
- *
- * The state variable is a count of help topics that have never been indexed.
- */
- public function updateIndexState() {
- $query = $this->database->select('help_search_items', 'hsi');
- $query->addExpression('COUNT(DISTINCT(hsi.sid))');
- $query->leftJoin('search_dataset', 'sd', 'hsi.sid = sd.sid AND sd.type = :type', [':type' => $this->getType()]);
- $query->isNull('sd.sid');
- $never_indexed = $query->execute()->fetchField();
- $this->state->set('help_search_unindexed_count', $never_indexed);
- }
-
- /**
- * {@inheritdoc}
- */
- public function markForReindex() {
- $this->updateTopicList();
- $this->searchIndex->markForReindex($this->getType());
- }
-
- /**
- * {@inheritdoc}
- */
- public function indexStatus() {
- $this->updateTopicList();
- $total = $this->database->select('help_search_items', 'hsi')
- ->countQuery()
- ->execute()
- ->fetchField();
-
- $query = $this->database->select('help_search_items', 'hsi');
- $query->addExpression('COUNT(DISTINCT([hsi].[sid]))');
- $query->leftJoin('search_dataset', 'sd', '[hsi].[sid] = [sd].[sid] AND [sd].[type] = :type', [':type' => $this->getType()]);
- $condition = $this->database->condition('OR');
- $condition->condition('sd.reindex', 0, '<>')
- ->isNull('sd.sid');
- $query->condition($condition);
- $remaining = $query->execute()->fetchField();
-
- return [
- 'remaining' => $remaining,
- 'total' => $total,
- ];
- }
-
- /**
- * Removes an item or items from the search index.
- *
- * @param int|int[] $sids
- * Search ID (sid) of item or items to remove.
- */
- protected function removeItemsFromIndex($sids) {
- $sids = (array) $sids;
-
- // Remove items from our table in batches of 100, to avoid problems
- // with having too many placeholders in database queries.
- foreach (array_chunk($sids, 100) as $this_list) {
- $this->database->delete('help_search_items')
- ->condition('sid', $this_list, 'IN')
- ->execute();
- }
- // Remove items from the search tables individually, as there is no bulk
- // function to delete items from the search index.
- foreach ($sids as $sid) {
- $this->searchIndex->clear($this->getType(), $sid);
- }
- }
-
- /**
- * Instantiates a help section plugin and verifies it is searchable.
- *
- * @param string $section_plugin_id
- * Type of plugin to instantiate.
- *
- * @return \Drupal\help_topics\SearchableHelpInterface|false
- * Plugin object, or FALSE if it is not searchable.
- */
- protected function getSectionPlugin($section_plugin_id) {
- /** @var \Drupal\help\HelpSectionPluginInterface $section_plugin */
- $section_plugin = $this->helpSectionManager->createInstance($section_plugin_id);
- // Intentionally return boolean to allow caching of results.
- return $section_plugin instanceof SearchableHelpInterface ? $section_plugin : FALSE;
- }
+class HelpSearch extends CoreHelpSearch {
}
diff --git a/core/modules/help_topics/src/SearchableHelpInterface.php b/core/modules/help_topics/src/SearchableHelpInterface.php
index 8b6b8ebc33b712abe7507ad20f568a930ea41d53..ff3892058286d50ced8a83a928fec0577d479d09 100644
--- a/core/modules/help_topics/src/SearchableHelpInterface.php
+++ b/core/modules/help_topics/src/SearchableHelpInterface.php
@@ -2,7 +2,7 @@
namespace Drupal\help_topics;
-use Drupal\Core\Language\LanguageInterface;
+use Drupal\help\SearchableHelpInterface as CoreSearchableHelpInterface;
/**
* Provides an interface for a HelpSection plugin that also supports search.
@@ -14,33 +14,6 @@
* experimental modules and development releases of contributed modules.
* See https://www.drupal.org/core/experimental for more information.
*/
-interface SearchableHelpInterface {
-
- /**
- * Returns the IDs of topics that should be indexed for searching.
- *
- * @return string[]
- * An array of topic IDs that should be searchable. IDs need to be
- * unique within this HelpSection plugin.
- */
- public function listSearchableTopics();
-
- /**
- * Renders one topic for search indexing or search results.
- *
- * @param string $topic_id
- * The ID of the topic to be indexed.
- * @param \Drupal\Core\Language\LanguageInterface $language
- * The language to render the topic in.
- *
- * @return array
- * An array of information about the topic, with elements:
- * - title: The title of the topic in this language.
- * - text: The text of the topic in this language.
- * - url: The URL of the topic as a \Drupal\Core\Url object.
- * - cacheable_metadata: (optional) An object to add as a cache dependency
- * if this topic is shown in search results.
- */
- public function renderTopicForSearch($topic_id, LanguageInterface $language);
+interface SearchableHelpInterface extends CoreSearchableHelpInterface {
}
diff --git a/core/modules/migrate_drupal_ui/tests/src/Functional/d6/Upgrade6Test.php b/core/modules/migrate_drupal_ui/tests/src/Functional/d6/Upgrade6Test.php
index c7eed2b2d9012c60dc627fc953b9113c6dd224bd..5ab10a17e362e22e4f333c0399ce4052986aead8 100644
--- a/core/modules/migrate_drupal_ui/tests/src/Functional/d6/Upgrade6Test.php
+++ b/core/modules/migrate_drupal_ui/tests/src/Functional/d6/Upgrade6Test.php
@@ -66,7 +66,7 @@ protected function getSourceBasePath() {
*/
protected function getEntityCounts() {
return [
- 'block' => 36,
+ 'block' => 37,
'block_content' => 2,
'block_content_type' => 1,
'comment' => 8,
@@ -87,7 +87,7 @@ protected function getEntityCounts() {
// The 'book' module provides the 'book' node type, and the migration
// creates 12 node types.
'node_type' => 14,
- 'search_page' => 2,
+ 'search_page' => 3,
'shortcut' => 2,
'shortcut_set' => 1,
'action' => 33,
diff --git a/core/modules/migrate_drupal_ui/tests/src/Functional/d7/Upgrade7Test.php b/core/modules/migrate_drupal_ui/tests/src/Functional/d7/Upgrade7Test.php
index 960fffae0a494da44d823fd05ade0963d5461ccd..48b4d377188c79e3fc7ec165893f09064871234a 100644
--- a/core/modules/migrate_drupal_ui/tests/src/Functional/d7/Upgrade7Test.php
+++ b/core/modules/migrate_drupal_ui/tests/src/Functional/d7/Upgrade7Test.php
@@ -69,7 +69,7 @@ protected function getSourceBasePath() {
*/
protected function getEntityCounts() {
return [
- 'block' => 27,
+ 'block' => 28,
'block_content' => 1,
'block_content_type' => 1,
'comment' => 4,
@@ -90,7 +90,7 @@ protected function getEntityCounts() {
'language_content_settings' => 24,
'node' => 7,
'node_type' => 8,
- 'search_page' => 2,
+ 'search_page' => 3,
'shortcut' => 6,
'shortcut_set' => 2,
'action' => 27,
diff --git a/core/themes/stable9/templates/admin/help-topic.html.twig b/core/themes/stable9/templates/admin/help-topic.html.twig
new file mode 100644
index 0000000000000000000000000000000000000000..f2d8b65347a4fd9ff46ad999c7f0896a703077e7
--- /dev/null
+++ b/core/themes/stable9/templates/admin/help-topic.html.twig
@@ -0,0 +1,14 @@
+{#
+/**
+ * @file
+ * Theme override for a help topic.
+ *
+ * Available variables:
+ * - body: The body of the topic.
+ * - related: List of related topic links.
+ */
+#}
+<article>
+ {{ body }}
+ {{ related }}
+</article>