first commit

core/modules/help_topics/src/Controller/HelpTopicPluginController.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace Drupal\help_topics\Controller;
+
+use Drupal\help\Controller\HelpTopicPluginController as CoreHelpTopicPluginController;
+
+/**
+ * Controller for help topic plugins.
+ *
+ * @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 HelpTopicPluginController extends CoreHelpTopicPluginController {
+
+}

core/modules/help_topics/src/HelpBreadcrumbBuilder.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace Drupal\help_topics;
+
+use Drupal\help\HelpBreadcrumbBuilder as CoreHelpBreadcrumbBuilder;
+
+/**
+ * Provides a breadcrumb builder for help topic pages.
+ *
+ * @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 HelpBreadcrumbBuilder extends CoreHelpBreadcrumbBuilder {
+
+}

core/modules/help_topics/src/HelpSectionManager.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace Drupal\help_topics;
+
+use Drupal\help\HelpSectionManager as CoreHelpSectionManager;
+
+/**
+ * Decorates the Help Section plugin manager to provide help topic search.
+ *
+ * @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 HelpSectionManager extends CoreHelpSectionManager {
+
+}

core/modules/help_topics/src/HelpTopicDiscovery.php

@@ -0,0 +1,20 @@
+<?php
+
+namespace Drupal\help_topics;
+
+use Drupal\help\HelpTopicDiscovery as CoreHelpTopicDiscovery;
+
+/**
+ * Discovers help topic plugins from Twig files in help_topics directories.
+ *
+ * @see \Drupal\help_topics\HelpTopicTwig
+ * @see \Drupal\help_topics\HelpTopicTwigLoader
+ *
+ * @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 HelpTopicDiscovery extends CoreHelpTopicDiscovery {
+
+}

core/modules/help_topics/src/HelpTopicPluginBase.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace Drupal\help_topics;
+
+use Drupal\help\HelpTopicPluginBase as CoreHelpTopicPluginBase;
+
+/**
+ * Base class for help topic plugins.
+ *
+ * @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.
+ */
+abstract class HelpTopicPluginBase extends CoreHelpTopicPluginBase {
+
+}

core/modules/help_topics/src/HelpTopicPluginInterface.php

@@ -0,0 +1,19 @@
+<?php
+
+namespace Drupal\help_topics;
+
+use Drupal\help\HelpTopicPluginInterface as CoreHelpTopicPluginInterface;
+
+/**
+ * Defines an interface for help topic plugin classes.
+ *
+ * @see \Drupal\help_topics\HelpTopicPluginManager
+ *
+ * @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.
+ */
+interface HelpTopicPluginInterface extends CoreHelpTopicPluginInterface {
+
+}

core/modules/help_topics/src/HelpTopicPluginManager.php

@@ -0,0 +1,68 @@
+<?php
+
+namespace Drupal\help_topics;
+
+use Drupal\help\HelpTopicPluginManager as CoreHelpTopicPluginManager;
+
+/**
+ * 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_topics\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
+ * my_module_prefix:
+ *   deriver: 'Drupal\my_module\Plugin\Deriver\HelpTopicDeriver'
+ * @endcode
+ *
+ * @ingroup help_docs
+ *
+ * @see \Drupal\help_topics\HelpTopicDiscovery
+ * @see \Drupal\help_topics\HelpTopicTwig
+ * @see \Drupal\help_topics\HelpTopicTwigLoader
+ * @see \Drupal\help_topics\HelpTopicPluginInterface
+ * @see \Drupal\help_topics\HelpTopicPluginBase
+ * @see hook_help_topics_info_alter()
+ * @see plugin_api
+ * @see \Drupal\Component\Plugin\Derivative\DeriverInterface
+ *
+ * @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 HelpTopicPluginManager extends CoreHelpTopicPluginManager {
+
+}

core/modules/help_topics/src/HelpTopicPluginManagerInterface.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace Drupal\help_topics;
+
+use Drupal\help\HelpTopicPluginManagerInterface as CoreHelpTopicPluginManagerInterface;
+
+/**
+ * Defines an interface for managing help topics and storing their definitions.
+ *
+ * @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.
+ */
+interface HelpTopicPluginManagerInterface extends CoreHelpTopicPluginManagerInterface {
+
+}

core/modules/help_topics/src/HelpTopicTwig.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace Drupal\help_topics;
+
+use Drupal\help\HelpTopicTwig as CoreHelpTopicTwig;
+
+/**
+ * Represents a help topic plugin whose definition comes from a Twig file.
+ *
+ * @see \Drupal\help_topics\HelpTopicDiscovery
+ * @see \Drupal\help_topics\HelpTopicTwigLoader
+ * @see \Drupal\help_topics\HelpTopicPluginManager
+ *
+ * @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 HelpTopicTwig extends CoreHelpTopicTwig {
+
+}

core/modules/help_topics/src/HelpTopicTwigLoader.php

@@ -0,0 +1,24 @@
+<?php
+
+namespace Drupal\help_topics;
+
+use Drupal\help\HelpTopicTwigLoader as CoreHelpTopicTwigLoader;
+
+/**
+ * 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_topics\HelpTopicDiscovery
+ * @see \Drupal\help_topics\HelpTopicTwig
+ *
+ * @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 HelpTopicTwigLoader extends CoreHelpTopicTwigLoader {
+
+}

core/modules/help_topics/src/HelpTwigExtension.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace Drupal\help_topics;
+
+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 CoreHelpTwigExtension {
+
+}

core/modules/help_topics/src/Plugin/HelpSection/HelpTopicSection.php

@@ -0,0 +1,16 @@
+<?php
+
+namespace Drupal\help_topics\Plugin\HelpSection;
+
+use Drupal\help\Plugin\HelpSection\HelpTopicSection as CoreHelpTopicSection;
+
+/**
+ * Provides the help topics list section for the help page.
+ *
+ * @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 CoreHelpTopicSection {
+}

core/modules/help_topics/src/Plugin/Search/HelpSearch.php

@@ -0,0 +1,23 @@
+<?php
+
+namespace Drupal\help_topics\Plugin\Search;
+
+use Drupal\help\Plugin\Search\HelpSearch as CoreHelpSearch;
+
+/**
+ * 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
+ *
+ * @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 CoreHelpSearch {
+
+}

core/modules/help_topics/src/SearchableHelpInterface.php

@@ -0,0 +1,19 @@
+<?php
+
+namespace Drupal\help_topics;
+
+use Drupal\help\SearchableHelpInterface as CoreSearchableHelpInterface;
+
+/**
+ * Provides an interface for a HelpSection plugin that also supports search.
+ *
+ * @see \Drupal\help\HelpSectionPluginInterface
+ *
+ * @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.
+ */
+interface SearchableHelpInterface extends CoreSearchableHelpInterface {
+
+}