' . t('The Action module provides tasks that can be executed by the site such as unpublishing content, sending e-mail messages, or blocking a user. Other modules can trigger these actions when specific system events happen; for example, when new content is posted or when a user logs in. Modules can also provide additional actions. For more information, see the online documentation for the Action module.', array('!documentation' => 'https://drupal.org/documentation/modules/action')) . '
'; @@ -23,12 +25,11 @@ function action_help($path, $arg) { $output .= ''; return $output; - case 'admin/config/system/actions': - case 'admin/config/system/actions/manage': + case 'action.admin': $output = '' . t('There are two types of actions: simple and advanced. Simple actions do not require any additional configuration and are listed here automatically. Advanced actions need to be created and configured before they can be used because they have options that need to be specified; for example, sending an e-mail to a specified address or unpublishing content containing certain words. To create an advanced action, select the action from the drop-down list in the advanced action section below and click the Create button.') . '
'; return $output; - case 'admin/config/system/actions/configure': + case 'action.admin_configure': return t('An advanced action offers additional configuration options which may be filled out below. Changing the Description field is recommended in order to better identify the precise action taking place.'); } } diff --git a/core/modules/aggregator/aggregator.module b/core/modules/aggregator/aggregator.module index 0ce31c2..fd985a1 100644 --- a/core/modules/aggregator/aggregator.module +++ b/core/modules/aggregator/aggregator.module @@ -7,6 +7,7 @@ use Drupal\aggregator\Entity\Feed; use Drupal\Component\Plugin\Exception\PluginException; +use Symfony\Component\HttpFoundation\Request; /** * Denotes that a feed's items should never expire. @@ -16,9 +17,10 @@ /** * Implements hook_help(). */ -function aggregator_help($path, $arg) { - switch ($path) { - case 'admin/help#aggregator': +function aggregator_help($path, $arg, $route_name, Request $request) { + switch ($route_name) { + case 'help.page.aggregator': + case 'help.main': $output = ''; $output .= '' . t('The Aggregator module is an on-site syndicator and news reader that gathers and displays fresh content from RSS-, RDF-, and Atom-based feeds made available across the web. Thousands of sites (particularly news sites and blogs) publish their latest headlines in feeds, using a number of standardized XML-based formats. For more information, see the online documentation for the Aggregator module.', array('!aggregator-module' => 'https://drupal.org/documentation/modules/aggregator')) . '
'; @@ -34,15 +36,19 @@ function aggregator_help($path, $arg) { $output .= '' . t('Thousands of sites (particularly news sites and blogs) publish their latest headlines and posts in feeds, using a number of standardized XML-based formats. Formats supported by the aggregator include RSS, RDF, and Atom.') . '
'; $output .= '' . t('Current feeds are listed below, and new feeds may be added. At the blocks administration page you can enable for each feed the block Aggregator feed that contains the latest items .', array('!addfeed' => \Drupal::url('aggregator.feed_add'), '!block' => \Drupal::url('block.admin_display'))) . '
'; return $output; - case 'admin/config/services/aggregator/add/feed': + + case 'aggregator.feed_add': return '' . t('Add a feed in RSS, RDF or Atom format. A feed may only have one entry.') . '
'; - case 'admin/config/services/aggregator/add/opml': + + case 'aggregator.opml_add': return '' . t('OPML is an XML format used to exchange multiple feeds between aggregators. A single OPML document may contain a collection of many feeds. Drupal can parse such a file and import all feeds at once, saving you the effort of adding them manually. You may either upload a local file from your computer or enter a URL where Drupal can download it.') . '
'; + } } diff --git a/core/modules/ban/ban.module b/core/modules/ban/ban.module index 7d09e7c..fbae39e 100644 --- a/core/modules/ban/ban.module +++ b/core/modules/ban/ban.module @@ -1,4 +1,5 @@ ' . t('About') . ''; $output .= '' . t('The Ban module allows administrators to ban visits to their site from individual IP addresses. For more information, see the online documentation for the Ban module.', array('!url' => 'https://drupal.org/documentation/modules/ban')) . '
'; @@ -21,7 +23,7 @@ function ban_help($path, $arg) { $output .= ''; return $output; - case 'admin/config/people/ban': + case 'ban.admin_page': return '' . t('IP addresses listed here are banned from your site. Banned addresses are completely forbidden from accessing the site and instead see a brief message explaining the situation.') . '
'; } } diff --git a/core/modules/block/block.module b/core/modules/block/block.module index ba915a9..0c37ac9 100644 --- a/core/modules/block/block.module +++ b/core/modules/block/block.module @@ -9,6 +9,7 @@ use Drupal\Component\Plugin\Exception\PluginException; use Drupal\Component\Utility\NestedArray; use Symfony\Cmf\Component\Routing\RouteObjectInterface; +use Symfony\Component\HttpFoundation\Request; /** * Shows this block on every page except the listed pages. @@ -29,9 +30,10 @@ /** * Implements hook_help(). */ -function block_help($path, $arg) { - switch ($path) { - case 'admin/help#block': +function block_help($path, $arg, $route_name, Request $request) { + switch ($route_name) { + case 'help.main': + case 'help.page.block': $output = ''; $output .= '' . t('The Block module allows you to place blocks in regions and to configure their settings. For more information, see the online documentation for the Blocks module.', array('!blocks-documentation' => 'https://drupal.org/documentation/modules/block/')) . '
'; @@ -52,13 +54,8 @@ function block_help($path, $arg) { $output .= ''; return $output; } - if ($arg[0] == 'admin' && $arg[1] == 'structure' && $arg['2'] == 'block' && (empty($arg[3]) || $arg[3] == 'list') && empty($arg[5])) { - if (!empty($arg[4])) { - $demo_theme = $arg[4]; - } - else { - $demo_theme = \Drupal::config('system.theme')->get('default'); - } + if ($route_name == 'block.admin_display' || $route_name = 'block.admin_display_theme') { + $demo_theme = $request->attributes->get('theme', \Drupal::config('system.theme')->get('default')); $themes = list_themes(); $output = '' . t('This page provides a drag-and-drop interface for adding a block to a region, and for controlling the order of blocks within regions. To add a block to a region, or to configure its specific title and visibility settings, click the block title under Place blocks. Since not all themes implement the same regions, or display regions in the same way, blocks are positioned on a per-theme basis. Remember that your changes will not be saved until you click the Save blocks button at the bottom of the page.') . '
'; $output .= '' . l(t('Demonstrate block regions (@theme)', array('@theme' => $themes[$demo_theme]->info['name'])), 'admin/structure/block/demo/' . $demo_theme) . '
'; diff --git a/core/modules/book/book.module b/core/modules/book/book.module index 9bc7b72..5129288 100644 --- a/core/modules/book/book.module +++ b/core/modules/book/book.module @@ -11,13 +11,15 @@ use Drupal\Core\Language\Language; use Drupal\Core\Entity\Display\EntityViewDisplayInterface; use Drupal\Core\Template\Attribute; +use Symfony\Component\HttpFoundation\Request; /** * Implements hook_help(). */ -function book_help($path, $arg) { - switch ($path) { - case 'admin/help#book': +function book_help($path, $arg, $route_name, Request $request) { + switch ($route_name) { + case 'help.page.book': + case 'help.main': $output = '' . t('The Book module is used for creating structured, multi-page content, such as site resource guides, manuals, and wikis. It allows you to create content that has chapters, sections, subsections, or any similarly-tiered structure. For more information, see the online documentation for the Book module.', array('!book' => 'https://drupal.org/documentation/modules/book')) . '
'; $output .= '' . t('The book module offers a means to organize a collection of related content pages, collectively known as a book. When viewed, this content automatically displays links to adjacent book pages, providing a simple navigation system for creating and reviewing structured content.') . '
'; - case 'node/%/outline': + + case 'book.outline': return '' . t('The outline feature allows you to include pages in the Book hierarchy, as well as move them within the hierarchy or to reorder an entire book.', array('!book' => \Drupal::url('book.render'), '!book-admin' => \Drupal::url('book.admin'))) . '
'; } } diff --git a/core/modules/breakpoint/breakpoint.module b/core/modules/breakpoint/breakpoint.module index 9306fec..6964c3e 100644 --- a/core/modules/breakpoint/breakpoint.module +++ b/core/modules/breakpoint/breakpoint.module @@ -8,13 +8,15 @@ use Drupal\breakpoint\Entity\Breakpoint; use Drupal\breakpoint\Entity\BreakpointGroup; use Drupal\Core\Config\Entity\ConfigStorageController; +use Symfony\Component\HttpFoundation\Request; /** * Implements hook_help(). */ -function breakpoint_help($path, $arg) { - switch ($path) { - case 'admin/help#breakpoint': +function breakpoint_help($path, $arg, $route_name, Request $request) { + switch ($route_name) { + case 'help.page.breakpoint': + case 'help.main': $output = ''; $output .= '' . t('The Breakpoints module keeps track of the height, width, and resolution breakpoints where a responsive design needs to change in order to respond to different devices being used to view the site.') . '
'; diff --git a/core/modules/ckeditor/ckeditor.module b/core/modules/ckeditor/ckeditor.module index 50f13e4..f706b73 100644 --- a/core/modules/ckeditor/ckeditor.module +++ b/core/modules/ckeditor/ckeditor.module @@ -6,13 +6,15 @@ */ use Drupal\editor\Entity\Editor; +use Symfony\Component\HttpFoundation\Request; /** * Implements hook_help(). */ -function ckeditor_help($path, $arg) { - switch ($path) { - case 'admin/help#ckeditor': +function ckeditor_help($path, $arg, $route_name, Request $request) { + switch ($route_name) { + case 'help.main': + case 'help.page.ckeditor': $output = ''; $output .= '' . t('The CKEditor module provides a visual text editor and adds a toolbar to text fields. Users can use buttons to format content and to create semantically correct and valid HTML. The CKEditor module uses the framework provided by the Text Editor module. It requires JavaScript to be enabled in the browser. For more information, see the online documentation for the CKEditor module and the CKEditor website.', array( '!doc_url' => 'https://drupal.org/documentation/modules/ckeditor', '!cke_url' => 'http://ckeditor.com', '!text_editor' => \Drupal::url('help.page', array('name' => 'editor')))) . '
'; diff --git a/core/modules/color/color.module b/core/modules/color/color.module index aaf0ba6..0a6d558 100644 --- a/core/modules/color/color.module +++ b/core/modules/color/color.module @@ -5,13 +5,15 @@ */ use Drupal\Core\Asset\CssOptimizer; +use Symfony\Component\HttpFoundation\Request; /** * Implements hook_help(). */ -function color_help($path, $arg) { - switch ($path) { - case 'admin/help#color': +function color_help($path, $arg, $route_name, Request $request) { + switch ($route_name) { + case 'help.main': + case 'help.page.color': $output = '' . t('The Color module allows users with the Administer site configuration permission to change the color scheme (color of links, backgrounds, text, and other theme elements) of themes that are compatible with it. For more information, see the online documentation for the Color module.', array('!color_do' => 'https://drupal.org/documentation/modules/color')) . '
'; $output .= '' . t('The Comment module allows users to comment on site content, set commenting defaults and permissions, and moderate comments. For more information, see the online handbook entry for Comment module.', array('@comment' => 'http://drupal.org/documentation/modules/comment')) . '
'; $output .= '' . t('This page provides a list of all comment forms on the site and allows you to manage the fields, form and display settings for each.') . '
'; return $output; } diff --git a/core/modules/config/config.module b/core/modules/config/config.module index 3cb71e6..d50dd6e 100644 --- a/core/modules/config/config.module +++ b/core/modules/config/config.module @@ -1,4 +1,5 @@ ' . t('About') . ''; $output .= '' . t('The Configuration manager module provides a user interface for importing and exporting configuration changes; i.e., for staging configuration data between multiple instances of this web site. For more information, see the online handbook entry for Configuration manager module', array( @@ -18,7 +20,7 @@ function config_help($path, $arg) { )) . '
'; return $output; - case 'admin/config/development/configuration/sync': + case 'config.sync': $output = ''; $output .= '' . t('Import configuration that is placed in your staging directory. All changes, deletions, renames, and additions are listed below.') . '
'; return $output; diff --git a/core/modules/contact/contact.module b/core/modules/contact/contact.module index bb967db..1319c70 100644 --- a/core/modules/contact/contact.module +++ b/core/modules/contact/contact.module @@ -1,4 +1,5 @@ ' . t('About') . ''; $output .= '' . t('The Contact module allows visitors to contact site administrators and other users. Users specify a subject, write their message, and can have a copy of their message sent to their own e-mail address. For more information, see the online handbook entry for Contact module.', array('@contact' => 'http://drupal.org/documentation/modules/contact')) . '
'; @@ -26,7 +28,8 @@ function contact_help($path, $arg) { $output .= '' . t('Add one or more categories on this page to set up your site-wide contact form.', array('@form' => url('contact'))) . '
'; $output .= '' . t('A Contact menu item is added to the Footer menu, which you can modify on the Menus administration page.', array('@menu-settings' => url('admin/structure/menu'))) . '
'; $output .= '' . t('If you would like additional text to appear on the site-wide contact page, use a block. You can create and edit blocks on the Blocks administration page.', array('@blocks' => url('admin/structure/block'))) . '
'; diff --git a/core/modules/contextual/contextual.module b/core/modules/contextual/contextual.module index 3fd2cb9..eb020e9 100644 --- a/core/modules/contextual/contextual.module +++ b/core/modules/contextual/contextual.module @@ -7,6 +7,7 @@ use Drupal\Component\Utility\Url; use Drupal\Core\Template\Attribute; +use Symfony\Component\HttpFoundation\Request; /** * Implements hook_toolbar(). @@ -62,9 +63,10 @@ function contextual_page_build(&$page) { /** * Implements hook_help(). */ -function contextual_help($path, $arg) { - switch ($path) { - case 'admin/help#contextual': +function contextual_help($path, $arg, $route_name, Request $request) { + switch ($route_name) { + case 'help.page.contextual': + case 'help.main': $output = ''; $output .= '' . t('The Contextual Links module displays links related to regions of pages on your site to users with access contextual links permission. For more information, see the online handbook entry for Contextual Links module.', array('@contextual' => 'http://drupal.org/documentation/modules/contextual')) . '
'; diff --git a/core/modules/dblog/dblog.module b/core/modules/dblog/dblog.module index 4060d63..538fe7f 100644 --- a/core/modules/dblog/dblog.module +++ b/core/modules/dblog/dblog.module @@ -13,13 +13,15 @@ use Drupal\Component\Utility\MapArray; use Drupal\Core\Database\Database; +use Symfony\Component\HttpFoundation\Request; /** * Implements hook_help(). */ -function dblog_help($path, $arg) { - switch ($path) { - case 'admin/help#dblog': +function dblog_help($path, $arg, $route_name, Request $request) { + switch ($route_name) { + case 'help.main': + case 'help.page.dblog': $output = ''; $output .= '' . t('The Database Logging module logs system events in the Drupal database. For more information, see the online handbook entry for the Database Logging module.', array('!dblog' => 'http://drupal.org/documentation/modules/dblog')) . '
'; @@ -31,7 +33,8 @@ function dblog_help($path, $arg) { $output .= '' . t('The Database Logging module monitors your website, capturing system events in a log (shown here) to be reviewed by an authorized individual at a later time. This log is a list of recorded events containing usage data, performance data, errors, warnings and operational information. It is vital to check the Recent log messages report on a regular basis, as it is often the only way to tell what is going on.') . '
'; } } diff --git a/core/modules/editor/editor.module b/core/modules/editor/editor.module index 1358910..47b54bc 100644 --- a/core/modules/editor/editor.module +++ b/core/modules/editor/editor.module @@ -10,13 +10,15 @@ use Drupal\Component\Utility\NestedArray; use Drupal\Core\Entity\EntityInterface; use Drupal\field\Field; +use Symfony\Component\HttpFoundation\Request; /** * Implements hook_help(). */ -function editor_help($path, $arg) { - switch ($path) { - case 'admin/help#editor': +function editor_help($path, $arg, $route_name, Request $request) { + switch ($route_name) { + case 'help.main': + case 'help.page.editor': $output = ''; $output .= '' . t('The Text Editor module provides a framework that other modules (such as CKEditor module) can use to provide toolbars and other functionality that allow users to format text more easily than typing HTML tags directly. For more information, see the online documentation for the Text Editor module.', array('!documentation' => 'https://drupal.org/documentation/modules/editor', '!ckeditor' => \Drupal::url('help.page', array('name' => 'ckeditor')))) . '
'; diff --git a/core/modules/email/email.module b/core/modules/email/email.module index f74da6f..c58bb0e 100644 --- a/core/modules/email/email.module +++ b/core/modules/email/email.module @@ -1,4 +1,5 @@ ' . t('About') . ''; $output .= '' . t('The E-mail module allows you to create fields that contain e-mail addresses. See the Field module help and the Field UI help pages for general information on fields and how to create and manage them. For more information, see the online documentation for the E-mail module.', array('@field' => url('admin/help/field'), '@field_ui' => url('admin/help/field_ui'), '@email_documentation' => 'https://drupal.org/documentation/modules/email')) . '
'; diff --git a/core/modules/entity/entity.module b/core/modules/entity/entity.module index 5b3f414..96eb1da 100644 --- a/core/modules/entity/entity.module +++ b/core/modules/entity/entity.module @@ -9,13 +9,15 @@ */ use Drupal\Core\Config\Entity\ConfigStorageController; +use Symfony\Component\HttpFoundation\Request; /** * Implements hook_help(). */ -function entity_help($path, $arg) { - switch ($path) { - case 'admin/help#entity': +function entity_help($path, $arg, $route_name, Request $request) { + switch ($route_name) { + case 'help.main': + case 'help.page.entity': $output = ''; $output .= '' . t('The Entity module manages various types of content and configuration for the website. This information is collectively know as "entities", which are grouped into "entity types" (such as the main site content, comments, custom blocks, taxonomy terms, user accounts, and views configuration). Some entity types are further grouped into sub-types (for example, you could have article and page content types within the main site content entity type, and tag and category vocabularies within the taxonomy term entity type); other entity types, such as user accounts, do not have sub-types.') . '
'; diff --git a/core/modules/field/field.module b/core/modules/field/field.module index fc29d92..fc1d63b 100644 --- a/core/modules/field/field.module +++ b/core/modules/field/field.module @@ -7,6 +7,7 @@ use Drupal\Core\Entity\ContentEntityInterface; use Drupal\Core\Entity\EntityInterface; use Drupal\Core\Template\Attribute; +use Symfony\Component\HttpFoundation\Request; /* * Load all public Field API functions. Drupal currently has no @@ -76,9 +77,10 @@ /** * Implements hook_help(). */ -function field_help($path, $arg) { - switch ($path) { - case 'admin/help#field': +function field_help($path, $arg, $route_name, Request $request) { + switch ($route_name) { + case 'help.main': + case 'help.page.field': $output = ''; $output .= '' . t('The Field module allows custom data fields to be defined for entity types (entities include content items, comments, user accounts, and taxonomy terms). The Field module takes care of storing, loading, editing, and rendering field data. Most users will not interact with the Field module directly, but will instead use the Field UI module user interface. Module developers can use the Field API to make new entity types "fieldable" and thus allow fields to be attached to them. For more information, see the online handbook entry for Field module.', array('@field-ui-help' => url('admin/help/field_ui'), '@field' => 'http://drupal.org/documentation/modules/field')) . '
'; diff --git a/core/modules/file/file.module b/core/modules/file/file.module index 892b214..b925252 100644 --- a/core/modules/file/file.module +++ b/core/modules/file/file.module @@ -11,6 +11,7 @@ use Drupal\Core\Entity\EntityStorageControllerInterface; use Drupal\Core\Template\Attribute; use Drupal\file\FileUsage\FileUsageInterface; +use Symfony\Component\HttpFoundation\Request; // Load all Field module hooks for File. require_once __DIR__ . '/file.field.inc'; @@ -18,9 +19,10 @@ /** * Implements hook_help(). */ -function file_help($path, $arg) { - switch ($path) { - case 'admin/help#file': +function file_help($path, $arg, $route_name, Request $request) { + switch ($route_name) { + case 'help.page.file': + case 'help.main': $output = ''; $output .= '' . t('The File module allows you to create fields that contain files. See the Field module help and the Field UI help pages for general information on fields and how to create and manage them. For more information, see the online documentation for the File module.', array('!field' => \Drupal::url('help.page', array('name' => 'field')), '!field_ui' => \Drupal::url('help.page', array('name' => 'field_ui')), '!file_documentation' => 'https://drupal.org/documentation/modules/file')) . '
'; diff --git a/core/modules/filter/filter.module b/core/modules/filter/filter.module index 710c59f..4040fff 100644 --- a/core/modules/filter/filter.module +++ b/core/modules/filter/filter.module @@ -11,6 +11,7 @@ use Drupal\Core\Session\AccountInterface; use Drupal\Core\Template\Attribute; use Drupal\filter\FilterFormatInterface; +use Symfony\Component\HttpFoundation\Request; /** * Non-HTML markup language filters that generate HTML. @@ -43,9 +44,10 @@ /** * Implements hook_help(). */ -function filter_help($path, $arg) { - switch ($path) { - case 'admin/help#filter': +function filter_help($path, $arg, $route_name, Request $request) { + switch ($route_name) { + case 'help.page.filter': + case 'help.main': $output = ''; $output .= '' . t('The Filter module allows administrators to configure text formats. A text format defines the HTML tags, codes, and other input allowed in content and comments, and is a key feature in guarding against potentially damaging input from malicious users. For more information, see the online handbook entry for Filter module.', array('@filter' => 'http://drupal.org/documentation/modules/filter/')) . '
'; @@ -62,12 +64,12 @@ function filter_help($path, $arg) { $output .= ''; return $output; - case 'admin/config/content/formats': + case 'filter.admin_overview': $output = '' . t('Text formats define the HTML tags, code, and other formatting that can be used when entering text. Improper text format configuration is a security risk. Learn more on the Filter module help page.', array('@filterhelp' => url('admin/help/filter'))) . '
'; $output .= '' . t('Text formats are presented on content editing pages in the order defined on this page. The first format available to a user will be selected by default.') . '
'; return $output; - case 'admin/config/content/formats/manage/%': + case 'filter.format_edit': $output = '' . t('A text format contains filters that change the user input, for example stripping out malicious HTML or making URLs clickable. Filters are executed from top to bottom and the order is important, since one filter may prevent another filter from doing its job. For example, when URLs are converted into links before disallowed HTML tags are removed, all links may be removed. When this happens, the order of filters may need to be re-arranged.') . '
'; return $output; } diff --git a/core/modules/forum/forum.module b/core/modules/forum/forum.module index 7179120..09e0ac1 100644 --- a/core/modules/forum/forum.module +++ b/core/modules/forum/forum.module @@ -7,13 +7,15 @@ use Drupal\Core\Entity\EntityInterface; use Drupal\field\Field; +use Symfony\Component\HttpFoundation\Request; /** * Implements hook_help(). */ -function forum_help($path, $arg) { - switch ($path) { - case 'admin/help#forum': +function forum_help($path, $arg, $route_name, Request $request) { + switch ($route_name) { + case 'help.page.forum': + case 'help.main': $output = ''; $output .= '' . t('The Forum module lets you create threaded discussion forums with functionality similar to other message board systems. Forums are useful because they allow community members to discuss topics with one another while ensuring those conversations are archived for later reference. In a forum, users post topics and threads in nested hierarchies, allowing discussions to be categorized and grouped. The forum hierarchy consists of:') . '
'; @@ -41,7 +43,8 @@ function forum_help($path, $arg) { $output .= '' . t('Forums contain forum topics. Use containers to group related forums.') . '
'; $more_help_link = array( '#type' => 'link', @@ -57,11 +60,14 @@ function forum_help($path, $arg) { ); $output .= drupal_render($container); return $output; - case 'admin/structure/forum/add/container': + + case 'forum.add_container': return '' . t('Use containers to group related forums.') . '
'; - case 'admin/structure/forum/add/forum': + + case 'forum.add_forum': return '' . t('A forum holds related forum topics.') . '
'; - case 'admin/structure/forum/settings': + + case 'forum.settings': return '' . t('Adjust the display of your forum topics. Organize the forums on the forum structure page.', array('!forum-structure' => \Drupal::url('forum.overview'))) . '
'; } } diff --git a/core/modules/hal/hal.module b/core/modules/hal/hal.module index c124fb1..4ace443 100644 --- a/core/modules/hal/hal.module +++ b/core/modules/hal/hal.module @@ -1,4 +1,5 @@ ' . t('About') . ''; $output .= '' . t('Hypertext Application Language (HAL) is a format that supports the linking required for hypermedia APIs.', array('!hal_spec' => 'http://stateless.co/hal_specification.html')) . '
'; diff --git a/core/modules/help/help.api.php b/core/modules/help/help.api.php index 8b75a78..6090693 100644 --- a/core/modules/help/help.api.php +++ b/core/modules/help/help.api.php @@ -1,4 +1,5 @@ ' . t('Blocks are boxes of content rendered into an area, or region, of a web page. The default theme Bartik, for example, implements the regions "Sidebar first", "Sidebar second", "Featured", "Content", "Header", "Footer", etc., and a block may appear in any one of these areas. The blocks administration page provides a drag-and-drop interface for assigning a block to a region, and for controlling the order of blocks within regions.', array('@blocks' => url('admin/structure/block'))) . ''; // Help for another path in the block module. - case 'admin/structure/block': + case 'block.admin_display': return '' . t('This page provides a drag-and-drop interface for assigning a block to a region, and for controlling the order of blocks within regions. Since not all themes implement the same regions, or display regions in the same way, blocks are positioned on a per-theme basis. Remember that your changes will not be saved until you click the Save blocks button at the bottom of the page.') . '
'; } } diff --git a/core/modules/help/help.module b/core/modules/help/help.module index 6d07405..d92cb10 100644 --- a/core/modules/help/help.module +++ b/core/modules/help/help.module @@ -1,4 +1,5 @@ ' . t('Getting Started') . ''; $output .= '' . t('Follow these steps to set up and start using your website:') . '
'; $output .= '' . t('For more information, refer to the subjects listed in the Help Topics section or to the online documentation and support pages at drupal.org.', array('!docs' => 'https://drupal.org/documentation', '!support' => 'https://drupal.org/support', '!drupal' => 'https://drupal.org')) . '
'; return $output; - case 'admin/help#help': + case 'help.page.help': $output = ''; $output .= '' . t('The Help module provides Help reference pages and context-sensitive advice to guide you through the use and configuration of modules. It is a starting point for Drupal.org online documentation 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 online documentation for the Help module.', array('!help' => 'https://drupal.org/documentation/modules/help/', '!handbook' => 'https://drupal.org/documentation', '!help-page' => \Drupal::url('help.main'))) . '
'; diff --git a/core/modules/help/lib/Drupal/help/Controller/HelpController.php b/core/modules/help/lib/Drupal/help/Controller/HelpController.php index 7aac826..75985d9 100644 --- a/core/modules/help/lib/Drupal/help/Controller/HelpController.php +++ b/core/modules/help/lib/Drupal/help/Controller/HelpController.php @@ -9,6 +9,7 @@ use Drupal\Core\DependencyInjection\ContainerInjectionInterface; use Drupal\Core\Extension\ModuleHandlerInterface; use Symfony\Component\DependencyInjection\ContainerInterface; +use Symfony\Component\HttpFoundation\Request; use Symfony\Component\HttpKernel\Exception\NotFoundHttpException; use Drupal\Component\Utility\String; @@ -44,15 +45,18 @@ public static function create(ContainerInterface $container) { /** * Prints a page listing a glossary of Drupal terminology. * + * @param \Symfony\Component\HttpFoundation\Request $request + * The current request. + * * @return string * An HTML string representing the contents of help page. */ - public function helpMain() { + public function helpMain(Request $request) { $output = array( '#attached' => array( 'css' => array(drupal_get_path('module', 'help') . '/css/help.module.css'), ), - '#markup' => '' . t('Help is available on the following items:') . '
' . $this->helpLinksAsList(), + '#markup' => '' . t('Help is available on the following items:') . '
' . $this->helpLinksAsList($request), ); return $output; } @@ -60,16 +64,19 @@ public function helpMain() { /** * Provides a formatted list of available help topics. * + * @param \Symfony\Component\HttpFoundation\Request $request + * The current request + * * @return string * A string containing the formatted list. */ - protected function helpLinksAsList() { + protected function helpLinksAsList(Request $request) { $empty_arg = drupal_help_arg(); $module_info = system_rebuild_module_data(); $modules = array(); foreach ($this->moduleHandler->getImplementations('help') as $module) { - if ($this->moduleHandler->invoke($module, 'help', array("admin/help#$module", $empty_arg))) { + if ($this->moduleHandler->invoke($module, 'help', array("admin/help#$module", $empty_arg, 'help.main', $request))) { $modules[$module] = $module_info[$module]->info['name']; } } @@ -97,19 +104,21 @@ protected function helpLinksAsList() { * * @param string $name * A module name to display a help page for. + * @param \Symfony\Component\HttpFoundation\Request $request + * The current request * + * @throws \Symfony\Component\HttpKernel\Exception\NotFoundHttpException * @return array * A render array as expected by drupal_render(). * - * @throws \Symfony\Component\HttpKernel\Exception\NotFoundHttpException */ - public function helpPage($name) { + public function helpPage($name, Request $request) { $build = array(); if ($this->moduleHandler->implementsHook($name, 'help')) { $info = system_get_info('module'); $build['#title'] = String::checkPlain($info[$name]['name']); - $temp = $this->moduleHandler->invoke($name, 'help', array("admin/help#$name", drupal_help_arg())); + $temp = $this->moduleHandler->invoke($name, 'help', array("admin/help#$name", drupal_help_arg(), 'help.page.' . $name, $request)); if (empty($temp)) { $build['top']['#markup'] = t('No help is available for module %module.', array('%module' => $info[$name]['name'])); } diff --git a/core/modules/history/history.module b/core/modules/history/history.module index 88a60c7..a761da8 100644 --- a/core/modules/history/history.module +++ b/core/modules/history/history.module @@ -11,6 +11,7 @@ use Drupal\Core\Entity\EntityInterface; use Drupal\Core\Entity\Display\EntityViewDisplayInterface; +use Symfony\Component\HttpFoundation\Request; /** * Entities changed before this time are always shown as read. @@ -23,9 +24,10 @@ /** * Implements hook_help(). */ -function history_help($path, $arg) { - switch ($path) { - case 'admin/help#history': +function history_help($path, $arg, $route_name, Request $request) { + switch ($route_name) { + case 'help.main': + case 'help.page.history': $output = '' . t('The History module keeps track of which content a user has read. It marks content as new or updated depending on the last time the user viewed it. History records that are older than one month are removed during cron, which means that content older than one month is always considered read. The History module does not have a user interface but it provides a filter to Views to show new or updated content. For more information, see the online documentation for the History module.', array('!views-help' => \Drupal::url('help.page', array ('name' => 'views')), '!url' => 'https://drupal.org/documentation/modules/history')) . '
'; return $output; diff --git a/core/modules/image/image.module b/core/modules/image/image.module index 3751b8c..becf6ad 100644 --- a/core/modules/image/image.module +++ b/core/modules/image/image.module @@ -13,6 +13,7 @@ use Drupal\image\Entity\ImageStyle; use Drupal\field\FieldInterface; use Drupal\field\FieldInstanceInterface; +use Symfony\Component\HttpFoundation\Request; /** * Image style constant for user presets in the database. @@ -50,9 +51,10 @@ /** * Implements hook_help(). */ -function image_help($path, $arg) { - switch ($path) { - case 'admin/help#image': +function image_help($path, $arg, $route_name, Request $request) { + switch ($route_name) { + case 'help.page.image': + case 'help.main': $output = ''; $output .= '' . t('The Image module allows you to manipulate images on your website. It exposes a setting for using the Image toolkit, allows you to configure Image styles that can be used for resizing or adjusting images on display, and provides an Image field for attaching images to content. For more information, see the online handbook entry for Image module.', array('@image' => 'http://drupal.org/documentation/modules/image')) . '
'; @@ -67,14 +69,17 @@ function image_help($path, $arg) { $output .= '' . t('Image styles commonly provide thumbnail sizes by scaling and cropping images, but can also add various effects before an image is displayed. When an image is displayed with a style, a new file is created and the original image is left unchanged.') . '
'; - case 'admin/config/media/image-styles/manage/%/add/%': - $effect = \Drupal::service('plugin.manager.image.effect')->getDefinition($arg[7]); + + case 'image.effect_add_form': + $effect = \Drupal::service('plugin.manager.image.effect')->getDefinition($request->attributes->get('image_effect')); return isset($effect['description']) ? ('' . $effect['description'] . '
') : NULL; - case 'admin/config/media/image-styles/manage/%/effects/%': + + case 'image.effect_edit_form': try { - $effect = entity_load('image_style', $arg[5])->getEffect($arg[7]); + $effect = $request->attributes->get('image_style')->getEffect($request->attributes->get('image_effect')); } catch (UnknownPluginException $e) { return NULL; diff --git a/core/modules/language/language.module b/core/modules/language/language.module index 8d0faab..06d5016 100644 --- a/core/modules/language/language.module +++ b/core/modules/language/language.module @@ -13,13 +13,15 @@ use Drupal\language\Plugin\LanguageNegotiation\LanguageNegotiationUrl; use Drupal\language\Plugin\LanguageNegotiation\LanguageNegotiationUrlFallback; use Drupal\node\NodeTypeInterface; +use Symfony\Component\HttpFoundation\Request; /** * Implements hook_help(). */ -function language_help($path, $arg) { - switch ($path) { - case 'admin/help#language': +function language_help($path, $arg, $route_name, Request $request) { + switch ($route_name) { + case 'help.main': + case 'help.page.language': $output = ''; $output .= '' . t('The Language module allows you to maintain a list of languages used on your Drupal site for providing language information for content and for interface translation (using the Locale module). For more information, see the online handbook entry for Language module.', array('@language' => 'http://drupal.org/documentation/modules/language')) . '
'; @@ -32,33 +34,35 @@ function language_help($path, $arg) { $output .= ''; return $output; - case 'admin/config/regional/language': + case 'language.admin_overview': return '' . t('With multiple languages enabled, registered users may select their preferred language and authors can assign a specific language to content. The selection of what language is used to display page elements is made depending on the detection menthod settings in the Detection and Selection tab.', array('@detection' => url('admin/config/regional/language/detection'))) . '
'; - case 'admin/config/regional/language/add': + case 'language.add': return '' . t('Add a language to be supported by your site. If your desired language is not available, pick Custom language... at the end and provide a language code and other details manually.') . '
'; - case 'admin/config/regional/language/detection': + case 'language.negotiation': $output = '' . t('Define how to decide which language is used to display page elements (primarily text provided by Drupal and modules, such as field labels and help text). This decision is made by evaluating a series of detection methods for languages; the first detection method that gets a result will determine which language is used for that type of text. Be aware that some language negotiation methods are unreliable under certain conditions, such as browser detection when page-caching is enabled and a user is not currently logged in. Define the order of evaluation of language detection methods on this page. Default language can be changed at the Regional settings page.', array('@region-settings' => url('admin/config/regional/settings'))) . '
'; return $output; - case 'admin/config/regional/language/detection/session': + case 'language.negotiation_session': $output = '' . t('Determine the language from a request/session parameter. Example: "http://example.com?language=de" sets language to German based on the use of "de" within the "language" parameter.') . '
'; return $output; - case 'admin/config/regional/language/detection/browser': + case 'language.negotiation_browser': $output = '' . t('Browsers use different language codes to refer to the same languages. You can add and edit mappings from browser language codes to the languages used by Drupal.', array('@configure-languages' => url('admin/config/regional/language'))) . '
'; return $output; - case 'admin/config/regional/language/detection/selected': + case 'language.negotiation_selected': $output = '' . t('Changing the selected language here (and leaving this option as the last among the detection and selection options) is the easiest way to change the fallback language for the website, if you need to change how your site works by default (eg. when using an empty path prefix or using the default domain). Changing the site\'s default language itself might have other undesired side effects. ', array('@admin-change-language' => url('admin/config/regional/language'))) . '
'; return $output; - case 'admin/structure/block/manage/%': - case 'admin/structure/block/add/%/%': - if ($arg[4] == 'language' && $arg[5] == 'language_interface') { + case 'block.admin_edit': + case 'block.admin_add': + $plugin_id = $request->attributes->get('plugin_id'); + list($plugin, $derivative) = explode(':', $plugin_id); + if ($plugin == 'language' && $derivative == 'language_interface') { return '' . t('With multiple languages enabled, registered users can select their preferred language and authors can assign a specific language to content.') . '
'; } break; diff --git a/core/modules/link/link.module b/core/modules/link/link.module index 24c6286..99d3ea8 100644 --- a/core/modules/link/link.module +++ b/core/modules/link/link.module @@ -1,4 +1,5 @@ ' . t('About') . ''; $output .= '' . t('The Link module allows you to create fields that contain external URLs and optional link text. See the Field module help and the Field UI help pages for general information on fields and how to create and manage them. For more information, see the online documentation for the Link module.', array('!field' => \Drupal::url('help.page', array('name' => 'field')), '!field_ui' => \Drupal::url('help.page', array('name' => 'field_ui')), '!link_documentation' => 'https://drupal.org/documentation/modules/link')) . '
'; diff --git a/core/modules/locale/locale.module b/core/modules/locale/locale.module index 21748ae..8c33cd9 100644 --- a/core/modules/locale/locale.module +++ b/core/modules/locale/locale.module @@ -13,6 +13,7 @@ use Drupal\Core\Cache\Cache; use Drupal\Core\Language\Language; use Drupal\Component\Utility\Crypt; +use Symfony\Component\HttpFoundation\Request; /** * Regular expression pattern used to localize JavaScript strings. @@ -130,9 +131,10 @@ /** * Implements hook_help(). */ -function locale_help($path, $arg) { - switch ($path) { - case 'admin/help#locale': +function locale_help($path, $arg, $route_name, Request $request) { + switch ($route_name) { + case 'help.main': + case 'help.page.locale': $output = ''; $output .= '' . t('The Locale module allows your Drupal site to be presented in languages other than the default English, and to be multilingual. The Locale module works by maintaining a database of translations, and examining text as it is about to be displayed. When a translation of the text is available in the language to be displayed, the translation is displayed rather than the original text. When a translation is unavailable, the original text is displayed, and then stored for review by a translator. For more information, see the online handbook entry for Locale module.', array('@locale' => 'http://drupal.org/documentation/modules/locale/')) . '
'; @@ -148,20 +150,20 @@ function locale_help($path, $arg) { $output .= ''; return $output; - case 'admin/config/regional/language': + case 'language.admin_overview': return '' . t('Interface translations are automatically imported when a language is added, or when new modules or themes are enabled. The report, Available translation updates, shows the status. Interface text can be customized.', array('@update' => url('admin/reports/translations'), '@translate' => url('admin/config/regional/translate'))) . '
'; - case 'admin/config/regional/translate': + case 'locale.translate_page': $output = '' . t('This page allows a translator to search for specific translated and untranslated strings, and is used when creating or editing translations. (Note: Because translation tasks involves many strings, it may be more convenient to export strings for offline editing in a desktop Gettext translation editor). Searches may be limited to strings in a specific language.', array('@export' => url('admin/config/regional/translate/export'))) . '
'; return $output; - case 'admin/config/regional/translate/import': + case 'locale.translate_import': $output = '' . t('Translation files are automatically downloaded and imported when languages are added, or when modules or themes are enabled.', array('@language' => url('admin/config/regional/language'))). '
'; $output .= '' . t('This page allows translators to manually import translated strings contained in a Gettext Portable Object (.po) file. Manual import may be used for customized translations or for the translation of custom modules and themes. To customize translations you can download a translation file from the Drupal translation server or export translations from the site, customize the translations using a Gettext translation editor, and import the result using this page.', array('@url' => 'http://localize.drupal.org', '@export' => url('admin/config/regional/translate/export'))) . '
'; $output .= '' . t('Note that importing large .po files may take several minutes.') . '
'; return $output; - case 'admin/config/regional/translate/export': + case 'locale.translate_export': return '' . t('This page exports the translated strings used by your site. An export file may be in Gettext Portable Object (.po) form, which includes both the original string and the translation (used to share translations with others), or in Gettext Portable Object Template (.pot) form, which includes the original strings only (used to create new translations with a Gettext translation editor).') . '
'; } } diff --git a/core/modules/menu/menu.module b/core/modules/menu/menu.module index d4a8857..10e9757 100644 --- a/core/modules/menu/menu.module +++ b/core/modules/menu/menu.module @@ -19,6 +19,7 @@ use Drupal\menu_link\Entity\MenuLink; use Drupal\menu_link\MenuLinkStorageController; use Drupal\node\NodeInterface; +use Symfony\Component\HttpFoundation\Request; /** * Maximum length of menu name as entered by the user. Database length is 32 @@ -29,9 +30,10 @@ /** * Implements hook_help(). */ -function menu_help($path, $arg) { - switch ($path) { - case 'admin/help#menu': +function menu_help($path, $arg, $route_name, Request $request) { + switch ($route_name) { + case 'help.main': + case 'help.page.menu': $output = ''; $output .= '' . t('The Menu module provides an interface for managing menus. A menu is a hierarchical collection of links, which can be within or external to the site, generally used for navigation. Each menu is rendered in a block that can be enabled and positioned through the Blocks administration page. You can view and manage menus on the Menus administration page. For more information, see the online handbook entry for the Menu module.', array('@blocks' => url('admin/structure/block'), '@menus' => url('admin/structure/menu'), '@menu' => 'http://drupal.org/documentation/modules/menu/')) . '
'; @@ -43,10 +45,11 @@ function menu_help($path, $arg) { $output .= '' . t('You can enable the newly-created block for this menu on the Blocks administration page.', array('@blocks' => url('admin/structure/block'))) . '
'; } - if ($path == 'admin/structure/menu' && \Drupal::moduleHandler()->moduleExists('block')) { + if ($route_name == 'menu.overview_page' && \Drupal::moduleHandler()->moduleExists('block')) { return '' . t('Each menu has a corresponding block that is managed on the Blocks administration page.', array('@blocks' => url('admin/structure/block'))) . '
'; } } diff --git a/core/modules/node/node.module b/core/modules/node/node.module index 9cbb1f9..9e48f53 100644 --- a/core/modules/node/node.module +++ b/core/modules/node/node.module @@ -10,6 +10,7 @@ use Drupal\Component\Utility\String; use Drupal\Core\Language\Language; +use Symfony\Component\HttpFoundation\Request; use Symfony\Component\HttpFoundation\Response; use Drupal\Core\Cache\Cache; use Drupal\Core\Database\Query\AlterableInterface; @@ -78,13 +79,13 @@ /** * Implements hook_help(). */ -function node_help($path, $arg) { +function node_help($path, $arg, $route_name, Request $request) { // Remind site administrators about the {node_access} table being flagged // for rebuild. We don't need to issue the message on the confirm form, or // while the rebuild is being processed. - if ($path != 'admin/reports/status/rebuild' && $path != 'batch' && strpos($path, '#') === FALSE + if ($route_name != 'node.configure_rebuild_confirm' && $route_name != 'system.batch_page.normal' && $route_name != 'help.page.node' && $route_name != 'help.main' && user_access('access administration pages') && node_access_needs_rebuild()) { - if ($path == 'admin/reports/status') { + if ($route_name == 'system.status') { $message = t('The content access permissions need to be rebuilt.'); } else { @@ -93,8 +94,9 @@ function node_help($path, $arg) { drupal_set_message($message, 'error'); } - switch ($path) { - case 'admin/help#node': + switch ($route_name) { + case 'help.main': + case 'help.page.node': $output = ''; $output .= '' . t('The Node module manages the creation, editing, deletion, settings, and display of the main site content. Content items managed by the Node module are typically displayed as pages on your site, and include a title, some meta-data (author, creation time, content type, etc.), and optional fields containing text or other data (fields are managed by the Field module). For more information, see the online handbook entry for Node module.', array('@node' => 'http://drupal.org/documentation/modules/node', '@field' => url('admin/help/field'))) . '
'; @@ -113,29 +115,31 @@ function node_help($path, $arg) { $output .= ''; return $output; - case 'admin/structure/types/add': + case 'node.type_add': return '' . t('Individual content types can have different fields, behaviors, and permissions assigned to them.') . '
'; - case 'admin/structure/types/manage/%/form-display': + case 'field_ui.form_display_overview_node': + case 'field_ui.form_display_overview_form_mode_node': $type = entity_load('node_type', $arg[4]); return '' . t('Content items can be edited using different form modes. Here, you can define which fields are shown and hidden when %type content is edited in each form mode, and define how the field form widgets are displayed in each form mode.', array('%type' => $type->label())) . '
' ; - case 'admin/structure/types/manage/%/display': + case 'field_ui.display_overview_node': + case 'field_ui.display_overview_view_mode_node': $type = entity_load('node_type', $arg[4]); return '' . t('Content items can be displayed using different view modes: Teaser, Full content, Print, RSS, etc. Teaser is a short format that is typically used in lists of multiple content items. Full content is typically used when the content is displayed on its own page.') . '
' . '' . t('Here, you can define which fields are shown and hidden when %type content is displayed in each view mode, and define how the fields are displayed in each view mode.', array('%type' => $type->label())) . '
'; - case 'node/%/revisions': + case 'node.revision.overview': return '' . t('Revisions allow you to track differences between multiple versions of your content, and revert back to older versions.') . '
'; - case 'node/%/edit': - $node = node_load($arg[1]); - $type = node_type_load($node->bundle()); + case 'node.page_edit': + $node = $request->attributes->get('node'); + $type = $node->getType(); return (!empty($type->help) ? filter_xss_admin($type->help) : ''); } - if ($arg[0] == 'node' && $arg[1] == 'add' && $arg[2]) { - $type = node_type_load($arg[2]); + if ($route_name == 'node.add') { + $type = $request->attributes->get('node_type'); return (!empty($type->help) ? filter_xss_admin($type->help) : ''); } } diff --git a/core/modules/number/number.module b/core/modules/number/number.module index 9e52fbc..95dc067 100644 --- a/core/modules/number/number.module +++ b/core/modules/number/number.module @@ -1,4 +1,5 @@ ' . t('About') . ''; $output .= '' . t('The Number module defines various numeric field types for the Field module. Numbers can be in integer, decimal, or floating-point form, and they can be formatted when displayed. Number fields can be limited to a specific set of input values or to a range of values. See the Field module help page for more information about fields.', array('@field-help' => url('admin/help/field'))) . '
'; diff --git a/core/modules/options/options.module b/core/modules/options/options.module index 5953ab1..ea6e9d4 100644 --- a/core/modules/options/options.module +++ b/core/modules/options/options.module @@ -10,13 +10,15 @@ use Drupal\Core\Field\FieldDefinitionInterface; use Drupal\field\FieldInterface; use Drupal\field\FieldUpdateForbiddenException; +use Symfony\Component\HttpFoundation\Request; /** * Implements hook_help(). */ -function options_help($path, $arg) { - switch ($path) { - case 'admin/help#options': +function options_help($path, $arg, $route_name, Request $request) { + switch ($route_name) { + case 'help.main': + case 'help.page.options': $output = ''; $output .= '' . t('The Options module defines various fields for storing a list of items, for use with the Field module. Usually these items are entered through a select list, checkboxes, or radio buttons. See the Field module help page for more information about fields.', array('@field-help' => url('admin/help/field'))) . '
'; diff --git a/core/modules/path/path.module b/core/modules/path/path.module index 80eeace..937bd17 100644 --- a/core/modules/path/path.module +++ b/core/modules/path/path.module @@ -9,13 +9,15 @@ use Drupal\Core\Entity\EntityInterface; use Drupal\Core\Entity\ContentEntityInterface; use Drupal\Core\Field\FieldDefinition; +use Symfony\Component\HttpFoundation\Request; /** * Implements hook_help(). */ -function path_help($path, $arg) { - switch ($path) { - case 'admin/help#path': +function path_help($path, $arg, $route_name, Request $request) { + switch ($route_name) { + case 'help.main': + case 'help.page.path': $output = ''; $output .= '' . t('The Path module allows you to specify an alias, or custom URL, for any existing internal system path. Aliases should not be confused with URL redirects, which allow you to forward a changed or inactive URL to a new URL. In addition to making URLs more readable, aliases also help search engines index content more effectively. Multiple aliases may be used for a single internal system path. To automate the aliasing of paths, you can install the contributed module Pathauto. For more information, see the online handbook entry for the Path module.', array('@path' => 'http://drupal.org/documentation/modules/path', '@pathauto' => 'http://drupal.org/project/pathauto')) . '
'; @@ -31,10 +33,10 @@ function path_help($path, $arg) { $output .= ''; return $output; - case 'admin/config/search/path': + case 'path.admin_overview': return '' . t("An alias defines a different name for an existing URL path - for example, the alias 'about' for the URL path 'node/1'. A URL path can have multiple aliases.") . '
'; - case 'admin/config/search/path/add': + case 'path.admin_add': return '' . t('Enter the path you wish to create the alias for, followed by the name of the new alias.') . '
'; } } diff --git a/core/modules/picture/picture.module b/core/modules/picture/picture.module index 9e5e4a3..973a62a 100644 --- a/core/modules/picture/picture.module +++ b/core/modules/picture/picture.module @@ -7,14 +7,16 @@ use Drupal\picture\Entity\PictureMapping; use \Drupal\Core\Template\Attribute; +use Symfony\Component\HttpFoundation\Request; /** * Implements hook_help(). */ -function picture_help($path, $arg) { +function picture_help($path, $arg, $route_name, Request $request) { $output = ''; - switch ($path) { - case 'admin/help#picture': + switch ($route_name) { + case 'help.main': + case 'help.page.picture': $output .= '' . t('The Picture module provides an image formatter and breakpoint mappings to output responsive images using the HTML5 picture tag.') . '
'; $output .= '' . t('A picture mapping associates an image style with each breakpoint defined by your theme.') . '
'; break; diff --git a/core/modules/rdf/rdf.module b/core/modules/rdf/rdf.module index c48e683..1911434 100644 --- a/core/modules/rdf/rdf.module +++ b/core/modules/rdf/rdf.module @@ -7,13 +7,15 @@ use Drupal\Component\Utility\NestedArray; use Drupal\Core\Template\Attribute; +use Symfony\Component\HttpFoundation\Request; /** * Implements hook_help(). */ -function rdf_help($path, $arg) { - switch ($path) { - case 'admin/help#rdf': +function rdf_help($path, $arg, $route_name, Request $request) { + switch ($route_name) { + case 'help.main': + case 'help.page.rdf': $output = ''; $output .= '' . t('The RDF module enriches your content with metadata to let other applications (e.g., search engines, aggregators, and so on) better understand its relationships and attributes. This semantically enriched, machine-readable output for Drupal sites uses the RDFa specification, which allows RDF data to be embedded in HTML markup. Other modules can define mappings of their data to RDF terms, and the RDF module makes this RDF data available to the theme. The core Drupal modules define RDF mappings for their data model, and the core Drupal themes output this RDF metadata information along with the human-readable visual information. For more information, see the online documentation for the RDF module.', array('!rdfa' => 'http://www.w3.org/TR/xhtml-rdfa-primer/', '!rdf' => 'https://drupal.org/documentation/modules/rdf')) . '
'; diff --git a/core/modules/rest/rest.module b/core/modules/rest/rest.module index 086961a..f2cb2d3 100644 --- a/core/modules/rest/rest.module +++ b/core/modules/rest/rest.module @@ -1,4 +1,5 @@ ' . t('About') . ''; $output .= '' . t('The REST module provides a framework for exposing Drupal\'s data structures as RESTful web services. It can be used to read and write resources remotely, such as entity types like nodes or users. For more information, see the online handbook entry for the RESTful web services module.', array('@rest' => 'http://drupal.org/documentation/modules/rest')) . '
'; diff --git a/core/modules/search/search.module b/core/modules/search/search.module index 11a5e00..ea1b781 100644 --- a/core/modules/search/search.module +++ b/core/modules/search/search.module @@ -6,6 +6,7 @@ */ use Drupal\Component\Utility\Unicode; +use Symfony\Component\HttpFoundation\Request; /** * Matches all 'N' Unicode character classes (numbers) @@ -65,9 +66,10 @@ /** * Implements hook_help(). */ -function search_help($path, $arg) { - switch ($path) { - case 'admin/help#search': +function search_help($path, $arg, $route_name, Request $request) { + switch ($route_name) { + case 'help.main': + case 'help.page.search': $output = ''; $output .= '' . t('The Search module provides the ability to index and search for content by exact keywords, and for users by username or e-mail. For more information, see the online handbook entry for Search module.', array('@search-module' => 'http://drupal.org/documentation/modules/search', '@search' => url('search'))) . '
'; @@ -87,14 +89,18 @@ function search_help($path, $arg) { $output .= '' . t('The search engine maintains an index of words found in your site\'s content. To build and maintain this index, a correctly configured cron maintenance task is required. Indexing behavior can be adjusted using the settings below.', array('@cron' => url('admin/reports/status'))) . '
'; - case 'search#noresults': + + case 'search.empty': + // This is a psuedo route, @see template_preprocess_search_results(). return t('' . t('The Serialization module provides a service for serializing and deserializing data to and from formats such as JSON and XML.') . '
'; diff --git a/core/modules/shortcut/shortcut.module b/core/modules/shortcut/shortcut.module index a988cf4..09b8e69 100644 --- a/core/modules/shortcut/shortcut.module +++ b/core/modules/shortcut/shortcut.module @@ -12,11 +12,11 @@ /** * Implements hook_help(). */ -function shortcut_help($path, $arg) { +function shortcut_help($path, $arg, $route_name, Request $request) { $user = \Drupal::currentUser(); - - switch ($path) { - case 'admin/help#shortcut': + switch ($route_name) { + case 'help.main': + case 'help.page.shortcut': $output = '' . t('The Shortcut module allows users to create sets of shortcut links to commonly-visited pages of the site. Shortcuts are contained within sets. Each user with Select any shortcut set permission can select a shortcut set created by anyone at the site. For more information, see the online handbook entry for Shortcut module.', array('!shortcut' => 'http://drupal.org/documentation/modules/shortcut')) . '
'; $output .= '' . t('Define which shortcut set you are using on the Shortcuts tab of your account page.', array('@shortcut-link' => url("user/{$user->id()}/shortcuts"))) . '
'; return $output; diff --git a/core/modules/simpletest/simpletest.module b/core/modules/simpletest/simpletest.module index c6b53bf..7f89208 100644 --- a/core/modules/simpletest/simpletest.module +++ b/core/modules/simpletest/simpletest.module @@ -3,6 +3,7 @@ use Drupal\Core\Database\Database; use Drupal\Core\Page\HtmlPage; use Drupal\simpletest\TestBase; +use Symfony\Component\HttpFoundation\Request; use Symfony\Component\Process\PhpExecutableFinder; /** @@ -13,9 +14,10 @@ /** * Implements hook_help(). */ -function simpletest_help($path, $arg) { - switch ($path) { - case 'admin/help#simpletest': +function simpletest_help($path, $arg, $route_name, Request $request) { + switch ($route_name) { + case 'help.main': + case 'help.page.simpletest': $output = ''; $output .= '' . t('The Testing module provides a framework for running automated unit tests. It can be used to verify a working state of Drupal before and after any code changes, or as a means for developers to write and execute tests for their modules. For more information, see the online handbook entry for Testing module.', array('@simpletest' => 'http://drupal.org/documentation/modules/simpletest', '@blocks' => url('admin/structure/block'))) . '
'; diff --git a/core/modules/statistics/statistics.module b/core/modules/statistics/statistics.module index a8a0105..1604b7f 100644 --- a/core/modules/statistics/statistics.module +++ b/core/modules/statistics/statistics.module @@ -8,13 +8,15 @@ use Drupal\Core\Entity\EntityInterface; use Drupal\Core\Entity\Display\EntityViewDisplayInterface; use Drupal\node\NodeInterface; +use Symfony\Component\HttpFoundation\Request; /** * Implements hook_help(). */ -function statistics_help($path, $arg) { - switch ($path) { - case 'admin/help#statistics': +function statistics_help($path, $arg, $route_name, Request $request) { + switch ($route_name) { + case 'help.main': + case 'help.page.statistics': $output = ''; $output .= '' . t('The Statistics module shows you how often content is viewed. This is useful in determining which pages of your site are most popular. For more information, see the online handbook entry for the Statistics module.', array('@statistics' => url('http://drupal.org/documentation/modules/statistics/'))) . '
'; @@ -26,7 +28,8 @@ function statistics_help($path, $arg) { $output .= '' . t('Settings for the statistical information that Drupal will keep about the site. See site statistics for the actual information.', array('@statistics' => url('admin/reports/hits'))) . '
'; } } diff --git a/core/modules/syslog/syslog.module b/core/modules/syslog/syslog.module index 287cfaf..a97b835 100644 --- a/core/modules/syslog/syslog.module +++ b/core/modules/syslog/syslog.module @@ -1,4 +1,5 @@ ' . t('About') . ''; $output .= '' . t("The Syslog module logs events by sending messages to the logging facility of your web server's operating system. Syslog is an operating system administrative logging tool that provides valuable information for use in system management and security auditing. Most suited to medium and large sites, Syslog provides filtering tools that allow messages to be routed by type and severity. For more information, see the online documentation for the Syslog module, as well as PHP's documentation pages for the openlog and syslog functions.", array('!syslog' => 'https://drupal.org/documentation/modules/syslog', '!php_openlog' => 'http://www.php.net/manual/function.openlog.php', '!php_syslog' => 'http://www.php.net/manual/function.syslog.php')) . '
'; diff --git a/core/modules/system/lib/Drupal/system/Plugin/Block/SystemHelpBlock.php b/core/modules/system/lib/Drupal/system/Plugin/Block/SystemHelpBlock.php index f669e61..eafed56 100644 --- a/core/modules/system/lib/Drupal/system/Plugin/Block/SystemHelpBlock.php +++ b/core/modules/system/lib/Drupal/system/Plugin/Block/SystemHelpBlock.php @@ -11,6 +11,7 @@ use Drupal\Core\Extension\ModuleHandlerInterface; use Drupal\Core\Plugin\ContainerFactoryPluginInterface; use Drupal\Core\Session\AccountInterface; +use Symfony\Cmf\Component\Routing\RouteObjectInterface; use Symfony\Component\DependencyInjection\ContainerInterface; use Symfony\Component\HttpFoundation\Request; @@ -95,13 +96,14 @@ protected function getActiveHelp(Request $request) { if (!$router_path) { return ''; } + $route_name = $request->attributes->get(RouteObjectInterface::ROUTE_NAME); $arg = drupal_help_arg(explode('/', $router_path)); foreach ($this->moduleHandler->getImplementations('help') as $module) { $function = $module . '_help'; // Lookup help for this path. - if ($help = $function($router_path, $arg)) { + if ($help = $function($router_path, $arg, $route_name, $request)) { $output .= $help . "\n"; } } diff --git a/core/modules/system/system.module b/core/modules/system/system.module index cc647a2..5ccde71 100644 --- a/core/modules/system/system.module +++ b/core/modules/system/system.module @@ -13,6 +13,7 @@ use Drupal\user\UserInterface; use Symfony\Component\HttpFoundation\JsonResponse; use Symfony\Component\HttpFoundation\RedirectResponse; +use Symfony\Component\HttpFoundation\Request; use Symfony\Component\HttpFoundation\Response; use Symfony\Component\HttpFoundation\Request; use Guzzle\Http\Exception\BadResponseException; @@ -82,11 +83,12 @@ /** * Implements hook_help(). */ -function system_help($path, $arg) { +function system_help($path, $arg, $route_name, Request $request) { global $base_url; - switch ($path) { - case 'admin/help#system': + switch ($route_name) { + case 'help.main': + case 'help.page.serialization': $output = ''; $output .= '' . t('The System module is integral to the site, and provides basic but extensible functionality for use by other modules and themes. Some integral elements of Drupal are contained in and managed by the System module, including caching, enabling and disabling modules and themes, preparing and displaying the administrative page, and configuring fundamental site settings. A number of key system maintenance operations are also part of the System module. For more information, see the online handbook entry for System module.', array('@system' => 'http://drupal.org/documentation/modules/system')) . '
'; @@ -104,18 +106,23 @@ function system_help($path, $arg) { $output .= '' . t('This page shows you all available administration tasks for each module.') . '
'; - case 'admin/appearance': + + case 'system.themes_page': $output = '' . t('Set and configure the default theme for your website. Alternative themes are available.', array('@themes' => 'http://drupal.org/project/themes')) . '
'; return $output; - case 'admin/appearance/settings/' . $arg[3]: + + case 'system.theme_settings_theme': $theme_list = list_themes(); - $theme = $theme_list[$arg[3]]; + $theme = $theme_list[$request->attributes->get('theme')]; return '' . t('These options control the display settings for the %name theme. When your site is displayed using this theme, these settings will be used.', array('%name' => $theme->info['name'])) . '
'; - case 'admin/appearance/settings': + + case 'system.theme_settings': return '' . t('These options control the default display settings for your entire site, across all themes. Unless they have been overridden by a specific theme, these settings will be used.') . '
'; - case 'admin/modules': + + case 'system.modules': $output = '' . t('Download additional contributed modules to extend Drupal\'s functionality.', array('@modules' => 'http://drupal.org/project/modules')) . '
'; if (\Drupal::moduleHandler()->moduleExists('update')) { if (update_manager_access()) { @@ -129,19 +136,23 @@ function system_help($path, $arg) { $output .= '' . t('Regularly review available updates to maintain a secure and current site. Always run the update script each time a module is updated. Enable the Update Manager module to update and install modules and themes.', array('@update-php' => $base_url . '/core/update.php')) . '
'; } return $output; - case 'admin/modules/uninstall': + + case 'system.modules_uninstall': return '' . t('The uninstall process removes all data related to a module.') . '
'; - case 'admin/structure/block/manage': - if ($arg[4] == 'system' && $arg[5] == 'powered-by') { + + case 'block.admin_edit': + if (($block = $request->attributes->get('block')) && $block->plugin == 'system_powered_by_block') { return '' . t('The Powered by Drupal block is an optional link to the home page of the Drupal project. While there is absolutely no requirement that sites feature this link, it may be used to show support for Drupal.') . '
'; } break; - case 'admin/config/development/maintenance': + + case 'system.site_maintenance_mode': if (\Drupal::currentUser()->id() == 1) { return '' . t('Use maintenance mode when making major updates, particularly if the updates could disrupt visitors or the update process. Examples include upgrading, importing or exporting content, modifying a theme, modifying content types, and making backups.') . '
'; } break; - case 'admin/reports/status': + + case 'system.status': return '' . t("Here you can find a short overview of your site's parameters as well as any problems detected with your installation. It may be useful to copy and paste this information into support requests filed on drupal.org's support forums and project issue queues. Before filing a support request, ensure that your web server meets the system requirements.", array('@system-requirements' => 'http://drupal.org/requirements')) . '
'; } } diff --git a/core/modules/taxonomy/taxonomy.module b/core/modules/taxonomy/taxonomy.module index c1aa72e..c73a02e 100644 --- a/core/modules/taxonomy/taxonomy.module +++ b/core/modules/taxonomy/taxonomy.module @@ -12,6 +12,7 @@ use Drupal\taxonomy\Entity\Term; use Drupal\taxonomy\Entity\Vocabulary; use Drupal\taxonomy\VocabularyInterface; +use Symfony\Component\HttpFoundation\Request; /** * Denotes that no term in the vocabulary has a parent. @@ -39,9 +40,10 @@ /** * Implements hook_help(). */ -function taxonomy_help($path, $arg) { - switch ($path) { - case 'admin/help#taxonomy': +function taxonomy_help($path, $arg, $route_name, Request $request) { + switch ($route_name) { + case 'help.main': + case 'help.page.taxonomy': $output = ''; $output .= '' . t('The Taxonomy module allows you to classify the content of your website. To classify content, you define vocabularies that contain related terms, and then assign the vocabularies to content types. For more information, see the online handbook entry for the Taxonomy module.', array('@taxonomy' => 'http://drupal.org/documentation/modules/taxonomy')) . '
'; @@ -68,11 +70,13 @@ function taxonomy_help($path, $arg) { $output .= '' . t('Taxonomy is for categorizing content. Terms are grouped into vocabularies. For example, a vocabulary called "Fruit" would contain the terms "Apple" and "Banana".') . '
'; return $output; - case 'admin/structure/taxonomy/manage/%': - $vocabulary = entity_load('taxonomy_vocabulary', $arg[4]); + + case 'taxonomy.overview_terms': + $vocabulary = $request->attributes->get('taxonomy_vocabulary'); switch ($vocabulary->hierarchy) { case TAXONOMY_HIERARCHY_DISABLED: return '' . t('You can reorganize the terms in %capital_name using their drag-and-drop handles, and group terms under a parent term by sliding them under and to the right of the parent.', array('%capital_name' => drupal_ucfirst($vocabulary->name), '%name' => $vocabulary->name)) . '
'; diff --git a/core/modules/telephone/telephone.module b/core/modules/telephone/telephone.module index 23099a9..abf1d34 100644 --- a/core/modules/telephone/telephone.module +++ b/core/modules/telephone/telephone.module @@ -1,4 +1,5 @@ ' . t('About') . ''; $output .= '' . t('The Telephone module allows you to create fields that contain telephone numbers. See the Field module help and the Field UI help pages for general information on fields and how to create and manage them. For more information, see the online documentation for the Telephone module.', array('!field' => \Drupal::url('help.page', array('name' => 'field')), '!field_ui' => \Drupal::url('help.page', array('name' => 'field_ui')), '!telephone_documentation' => 'https://drupal.org/documentation/modules/telephone')) . '
'; diff --git a/core/modules/text/text.module b/core/modules/text/text.module index 675c63e..d6c4f0e 100644 --- a/core/modules/text/text.module +++ b/core/modules/text/text.module @@ -6,6 +6,7 @@ */ use Drupal\Core\Entity\EntityInterface; +use Symfony\Component\HttpFoundation\Request; /** * Implements hook_library_info(). @@ -30,9 +31,10 @@ function text_library_info() { /** * Implements hook_help(). */ -function text_help($path, $arg) { - switch ($path) { - case 'admin/help#text': +function text_help($path, $arg, $route_name, Request $request) { + switch ($route_name) { + case 'help.main': + case 'help.page.text': $output = ''; $output .= '' . t('The Text module allows you to create short and long text fields with optional summaries. See the Field module help and the Field UI help pages for general information on fields and how to create and manage them. For more information, see the online documentation for the Text module.', array('!field' => \Drupal::url('help.page', array('name' => 'field')), '!field_ui' => \Drupal::url('help.page', array('name' => 'field_ui')), '!text_documentation' => 'https://drupal.org/documentation/modules/text')) . '
'; diff --git a/core/modules/toolbar/toolbar.module b/core/modules/toolbar/toolbar.module index d91527b..7016844 100644 --- a/core/modules/toolbar/toolbar.module +++ b/core/modules/toolbar/toolbar.module @@ -9,6 +9,7 @@ use Drupal\Core\Language\Language; use Drupal\Core\Template\Attribute; use Drupal\Component\Utility\Crypt; +use Symfony\Component\HttpFoundation\Request; use Symfony\Component\HttpFoundation\Response; use Drupal\menu_link\MenuLinkInterface; use Drupal\user\RoleInterface; @@ -17,9 +18,10 @@ /** * Implements hook_help(). */ -function toolbar_help($path, $arg) { - switch ($path) { - case 'admin/help#toolbar': +function toolbar_help($path, $arg, $route_name, Request $request) { + switch ($route_name) { + case 'help.main': + case 'help.page.toolbar': $output = '' . t('The Toolbar module displays links to top-level administration menu items and links from other modules at the top of the screen. For more information, see the online handbook entry for Toolbar module.', array('@toolbar' => 'http://drupal.org/documentation/modules/toolbar')) . '
'; $output .= '' . t('The Tracker module displays the most recently added and updated content on your site, and allows you to follow new content created by each user. This module has no configuration options. For more information, see the online handbook entry for Tracker module.', array('@tracker' => 'http://drupal.org/documentation/modules/tracker')) . '
'; $output .= '' . t("The Update Manager module periodically checks for new versions of your site's software (including contributed modules and themes), and alerts administrators to available updates. In order to provide update information, anonymous usage statistics are sent to Drupal.org. If desired, you may disable the Update Manager module from the Module administration page. For more information, see the online handbook entry for Update Manager module.", array('@update' => 'http://drupal.org/documentation/modules/update', '@modules' => url('admin/modules'))) . '
'; diff --git a/core/modules/user/user.module b/core/modules/user/user.module index b6b9f53..688eb7b 100644 --- a/core/modules/user/user.module +++ b/core/modules/user/user.module @@ -11,6 +11,7 @@ use Drupal\Core\Template\Attribute; use Drupal\Core\TypedData\DataDefinition; use Symfony\Component\HttpFoundation\RedirectResponse; +use Symfony\Component\HttpFoundation\Request; use Symfony\Component\HttpKernel\Exception\NotFoundHttpException; use Drupal\menu_link\Entity\MenuLink; @@ -43,9 +44,10 @@ /** * Implement hook_help(). */ -function user_help($path, $arg) { - switch ($path) { - case 'admin/help#user': +function user_help($path, $arg, $route_name, Request $request) { + switch ($route_name) { + case 'help.main': + case 'help.page.user': $output = ''; $output .= '' . t('The User module allows users to register, log in, and log out. It also allows users with proper permissions to manage user roles (used to classify users) and permissions associated with those roles. For more information, see the online handbook entry for User module.', array('@user' => 'http://drupal.org/documentation/modules/user')) . '
'; @@ -59,11 +61,14 @@ function user_help($path, $arg) { $output .= '' . t("This web page allows administrators to register new users. Users' e-mail addresses and usernames must be unique.") . '
'; - case 'admin/people/permissions': + + case 'user.admin_permissions': return '' . t('Permissions let you control what users can do and see on your site. You can define a specific set of permissions for each role. (See the Roles page to create a role). Two important roles to consider are Authenticated Users and Administrators. Any permissions granted to the Authenticated Users role will be given to any user who can log into your site. You can make any role the Administrator role for the site, meaning this will be granted all new permissions automatically. You can do this on the User Settings page. You should be careful to ensure that only trusted users are given this access and level of control of your site.', array('@role' => url('admin/people/roles'), '@settings' => url('admin/config/people/accounts'))) . '
'; - case 'admin/people/roles': + + case 'user.role_list': $output = '' . t('Roles allow you to fine tune the security and administration of Drupal. A role defines a group of users that have certain privileges as defined on the permissions page. Examples of roles include: anonymous user, authenticated user, moderator, administrator and so on. In this area you will define the names and order of the roles on your site. It is recommended to order your roles from least permissive (anonymous user) to most permissive (administrator). To delete a role choose "edit role".', array('@permissions' => url('admin/people/permissions'))) . '
'; $output .= '' . t('Drupal has three special user roles:') . '
'; $output .= '' . t('This form lets administrators add and edit fields for storing user data.') . '
'; - case 'admin/config/people/accounts/form-display': + + case 'field_ui.form_display_overview_user': return '' . t('This form lets administrators configure how form fields should be displayed when editing a user profile.') . '
'; - case 'admin/config/people/accounts/display': + + case 'field_ui.display_overview_user': return '' . t('This form lets administrators configure how fields should be displayed when rendering a user profile page.') . '
'; - case 'admin/people/search': - return '' . t('Enter a simple pattern ("*" may be used as a wildcard match) to search for a username or e-mail address. For example, one may search for "br" and Drupal might return "brian", "brad", and "brenda@example.com".') . '
'; } } diff --git a/core/modules/views/views.module b/core/modules/views/views.module index 1959cd8..3592bed 100644 --- a/core/modules/views/views.module +++ b/core/modules/views/views.module @@ -19,13 +19,15 @@ use Drupal\views\Entity\View; use Drupal\views\Views; use Drupal\field\FieldInstanceInterface; +use Symfony\Component\HttpFoundation\Request; /** * Implements hook_help(). */ -function views_help($path, $arg) { - switch($path) { - case 'admin/help#views': +function views_help($path, $arg, $route_name, Request $request) { + switch ($route_name) { + case 'help.main': + case 'help.page.views': $output = ''; $output .= '' . t('The Views module provides a back end to fetch information from content, user accounts, taxonomy terms, and other entities from the database and present it to the user as a grid, HTML list, table, unformatted list, etc. The resulting displays are known generally as views.') . '
'; diff --git a/core/modules/xmlrpc/xmlrpc.module b/core/modules/xmlrpc/xmlrpc.module index 187da85..3c37c0a 100644 --- a/core/modules/xmlrpc/xmlrpc.module +++ b/core/modules/xmlrpc/xmlrpc.module @@ -1,4 +1,5 @@ ' . t('About') . ''; $output .= '' . t('The XML-RPC module gives external systems the opportunity to communicate with the site through the XML-RPC protocol. An XML-RPC client can communicate with the site by making a request to xmlrpc.php. For more information, see the online documentation for the XML-RPC module.', array('!xrphp' => \Drupal::url('xmlrpc.php'),'!xrdocs' => 'https://drupal.org/documentation/modules/xmlrpc')) . '
';