function xmlsitemap_help in XML sitemap 6

Same name and namespace in other branches

1. 8 xmlsitemap.module \xmlsitemap_help()
2. 5.2 xmlsitemap/xmlsitemap.module \xmlsitemap_help()
3. 5 xmlsitemap.module \xmlsitemap_help()
4. 6.2 xmlsitemap.module \xmlsitemap_help()
5. 7.2 xmlsitemap.module \xmlsitemap_help()
6. 2.x xmlsitemap.module \xmlsitemap_help()

Implementation of hook_help().

File

./xmlsitemap.module, line 83

Creates a sitemap compatible with the sitemaps.org schema.

Code

function xmlsitemap_help($path, $arg) {
  switch ($path) {
    case 'admin/settings/xmlsitemap':
    case 'admin/settings/xmlsitemap/engines':
      $output = t('The sitemap is located at <a href="@sitemap">@sitemap</a>.', array(
        '@sitemap' => url('sitemap.xml', array(
          'absolute' => TRUE,
        )),
      ));
      break;
    case 'admin/help#xmlsitemap':
      $output = '<p>' . t('XML sitemap automatically creates a sitemap that conforms to the <a href="@sitemaps.org">sitemaps.org specification</a>. This helps search engines keep their search results up to date.', array(
        '@sitemaps.org' => 'http://www.sitemaps.org',
      )) . '</p>';
      $output .= '<h3>' . t('Supporting modules') . '</h3>';
      $output .= '<p>' . t('By itself, the XML sitemap module adds only the front page of your site to the sitemap. Other types of links are handled by supporting modules.') . '</p>';
      $optional = '';
      foreach (module_implements('xmlsitemap_description', TRUE) as $module) {
        $function = $module . '_xmlsitemap_description';
        $optional .= $function();
      }
      if (!empty($optional)) {
        $output .= "<dl>{$optional}</dl>";
      }
      $output .= '<p>' . t('Links may be assigned a priority between 0.0 and 1.0. The default priority is 0.5. A priority of <em>Not in sitemap</em> excludes a link from the sitemap.') . '</p>';
      $output .= '<p>' . t('For more information, see the online handbook entry for <a href="@xmlsitemap">XML sitemap module</a>.', array(
        '@xmlsitemap' => 'http://drupal.org/handbook/modules/gsitemap',
      )) . '</p>';
      break;
    default:
      $output = '';
      break;
  }
  return $output;
}