function nofollowlist_help in Nofollow List 8

Same name and namespace in other branches

1. 5 nofollowlist.module \nofollowlist_help()
2. 6 nofollowlist.module \nofollowlist_help()
3. 7 nofollowlist.module \nofollowlist_help()

Implements hook_help().

File

./nofollowlist.module, line 13

Default file for nofollowlist.

Code

function nofollowlist_help($route_name, RouteMatchInterface $route_match) {
  switch ($route_name) {

    // Main module help for the forms_to_email module.
    case 'help.page.nofollowlist':
      $output = '';
      $output .= '<h3>' . t('About') . '</h3>';
      $output .= '<p>' . t('Allows a blacklist of sites that will have a rel="nofollow" attribute added to their link tags whenever used on your site. Originally the only page in the blacklist was Wikipedia, though it now allows an admin controlled blacklist and whitelist.') . '</p>';
      $output .= '<h3>' . t('Installation note') . '</h3>';
      $output .= '<p>' . t('You must configure the <a href=":filter_link">input formats</a> and add this to a format for this module to work.', [
        ':filter_link' => 'http://drupal.org/handbook/modules/filter',
      ]) . '</p>';
      $output .= '<p>' . t("Since this is a filter module, it only works on text that is passed through Drupal's filter system. The biggest example of content passed through the filters are the body of content, blocks, and cck text fields where the user specifies an input format. It will not work on several areas including menus, site footers, mission statements, and profile fields.") . '</p>';
      $output .= '<h3>' . t('Uses') . '</h3>';
      $output .= '<dl>';
      $output .= '<dt>' . t('Enable nofollow filter') . '</dt>';
      $output .= '<dd>' . t('Inside the Configuration menu > Content Authoring > Text Formats and Editor, select the desired text option and click on Configure menu.') . '</dd>';
      $output .= '<dd>' . t('Search for <strong>enabled filters</strong> and check the nofollow list option.') . '</dd>';
      $output .= '<dt>' . t('Using the nofollow filter') . '</dt>';
      $output .= '<dd>' . t('On <strong>Filter settings</strong> you will be able to see the nofollow options to set the black list or white list.') . '</dd>';
      $output .= '<dt>' . t('External Links') . '</dt>';
      $output .= '<dd>' . t('If you wish to add nofollow to all external links you simply add your site to the "whitelist".') . '</dd>';
      $output .= '</dl>';
      return $output;
  }
}