function search_api_federated_solr_help in Search API Federated Solr 7.2

Same name and namespace in other branches

1. 8.3 search_api_federated_solr.module \search_api_federated_solr_help()
2. 8 search_api_federated_solr.module \search_api_federated_solr_help()
3. 8.2 search_api_federated_solr.module \search_api_federated_solr_help()
4. 7.3 search_api_federated_solr.module \search_api_federated_solr_help()
5. 7 search_api_federated_solr.module \search_api_federated_solr_help()
6. 4.x search_api_federated_solr.module \search_api_federated_solr_help()

Implements hook_help().

File

./search_api_federated_solr.module, line 13

search_api_federated_solr.module Contains hook implementations for the Federated Solr Search API Module.

Code

function search_api_federated_solr_help($path, $arg) {
  switch ($path) {

    // Main module help for the search_api_federated_solr module.
    case 'admin/help#search_api_federated_solr':
      $output = '';
      $output .= '<h3>' . t('About') . '</h3>';
      $output .= '<p>' . t('Allows indexing into a single Solr search index.') . '</p>';
      $output .= '<p>' . t('This help text uses Markdown. Install the <a href="@markdown">Markdown module</a> or <a href="@readme">view it online</a> for easier reading', [
        '@markdown' => 'https://www.drupal.org/project/markdown',
        '@readme' => 'https://git.drupalcode.org/project/search_api_federated_solr/tree/7.x-2.x',
      ]) . '</p>';
      $text = file_get_contents(dirname(__FILE__) . '/README.md');
      $output .= search_api_federated_solr_parse_help($text);
      return $output;
  }
}