function custom_pub_help in Custom Publishing Options 8

Same name and namespace in other branches

1. 6 custom_pub.module \custom_pub_help()
2. 7 custom_pub.module \custom_pub_help()

Implements hook_help().

Parameters

$route_name:

RouteMatchInterface $route_match:

Return value

string

File

./custom_pub.module, line 20

Code

function custom_pub_help($route_name, RouteMatchInterface $route_match) {
  switch ($route_name) {
    case 'help.page.custom_pub':
      $output = '<h3>' . t('About') . '</h3>';
      $output .= '<p>' . t('This module allows you to create custom publishing options for nodes.  For more information, see the <a href=":online">online documentation for Custom Publishing Options</a>.', [
        ':online' => 'https://www.drupal.org/project/custom_pub',
      ]) . '</p>';
      $output .= '<dl>';
      $output .= '<dt>' . t('Uses') . '</dt>';
      $output .= '<ol>';
      $output .= '<li>' . t('Install "Custom Publishing Options" from the module list page.') . '</li>';
      $output .= '<li>' . t('Configure the Custom Publishing Options.') . '</li>';
      $output .= '<li>' . t('On each new option created, set the Node types the option should be available from.') . '</li>';
      $output .= '<li>' . t('Go to the Permissions page. Grant permission to each role that should be able to use the new publishing option.') . '</li>';
      $output .= '</ol>';
      $output .= '<dt>' . t('Views') . '</dt>';
      $output .= '<dd>' . t('Using the Views module opens up a whole new avenue of displaying content with Custom Publishing Options. Create your View any way you like, and under Filter you will find all Custom Publishing Options available. Create archived content sections by creating an Archive option, and Filter by that option!') . '</dd>';
      $output .= '<dt>' . t('Additional Features') . '</dt>';
      $output .= '<dd>' . t('If you want greater permissions to allow a role to use custom publishing options or core states (status, sticky, promoted), it is suggested that you also pick up the Override Node Options module. This module adds access control to each publish state at the role level, so \'administer nodes\' is not a requirement.') . '</dd>';
      $output .= '</dl>';
      return $output;
    default:
  }
}