function toolbar_help

Same name in other branches
  1. 7.x modules/toolbar/toolbar.module \toolbar_help()
  2. 9 core/modules/toolbar/toolbar.module \toolbar_help()
  3. 10 core/modules/toolbar/toolbar.module \toolbar_help()

Implements hook_help().

File

core/modules/toolbar/toolbar.module, line 19

Code

function toolbar_help($route_name, RouteMatchInterface $route_match) {
    switch ($route_name) {
        case 'help.page.toolbar':
            $output = '<h3>' . t('About') . '</h3>';
            $output .= '<p>' . t('The Toolbar module provides a toolbar for site administrators, which displays tabs and trays provided by the Toolbar module itself and other modules. For more information, see the <a href=":toolbar_docs">online documentation for the Toolbar module</a>.', [
                ':toolbar_docs' => 'https://www.drupal.org/documentation/modules/toolbar',
            ]) . '</p>';
            $output .= '<h4>' . t('Terminology') . '</h4>';
            $output .= '<dl>';
            $output .= '<dt>' . t('Tabs') . '</dt>';
            $output .= '<dd>' . t('Tabs are buttons, displayed in a bar across the top of the screen. Some tabs execute an action (such as starting Edit mode), while other tabs toggle which tray is open.') . '</dd>';
            $output .= '<dt>' . t('Trays') . '</dt>';
            $output .= '<dd>' . t('Trays are usually lists of links, which can be hierarchical like a menu. If a tray has been toggled open, it is displayed either vertically or horizontally below the tab bar, depending on the browser width. Only one tray may be open at a time. If you click another tab, that tray will replace the tray being displayed. In wide browser widths, the user has the ability to toggle from vertical to horizontal, using a link at the bottom or right of the tray. Hierarchical menus only have open/close behavior in vertical mode; if you display a tray containing a hierarchical menu horizontally, only the top-level links will be available.') . '</dd>';
            $output .= '</dl>';
            return $output;
    }
}

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.