function search_api_field_map_help in Search API Field Map 8.2

Same name and namespace in other branches

1. 8.3 search_api_field_map.module \search_api_field_map_help()
2. 8 search_api_field_map.module \search_api_field_map_help()
3. 4.x search_api_field_map.module \search_api_field_map_help()

Implements hook_help().

File

./search_api_field_map.module, line 13

search_api_field_map.module Contains hook implementations for the Field Map Search API Module.

Code

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

    // Main module help for the search_api_field_map module.
    case 'help.page.search_api_field_map':
      $output = '';
      $output .= '<h3>' . t('About') . '</h3>';
      $output .= '<p>' . t('This module facilitates indexing data from multiple Drupal sites into a single Solr search index.') . '</p>';
      $output .= '<h3>' . t('Usage') . '</h3>';
      $output .= '<p>' . t('On each site included in the mapped field search, you will need to') . ':</p>';
      $output .= '<ol>';
      $output .= '<li>' . t('Install this module') . '</li>';
      $output .= '<li>' . t('Configure a Search API server to connect to the shared Solr index') . '</li>';
      $output .= '</ol>';
      $output .= '<h3>' . t('More information') . '</h3>';
      $output .= '<ul>';
      $output .= '<li><a href="docs/usage.md">' . t('How to use this module') . '</a></li>';
      $output .= '</ul>';
      return $output;
    default:
  }
}