function aggregator_help in Drupal 6

Same name and namespace in other branches

1. 8 core/modules/aggregator/aggregator.module \aggregator_help()
2. 4 modules/aggregator.module \aggregator_help()
3. 5 modules/aggregator/aggregator.module \aggregator_help()
4. 7 modules/aggregator/aggregator.module \aggregator_help()
5. 9 core/modules/aggregator/aggregator.module \aggregator_help()

Implementation of hook_help().

File

modules/aggregator/aggregator.module, line 11

Used to aggregate syndicated content (RSS, RDF, and Atom).

Code

function aggregator_help($path, $arg) {
  switch ($path) {
    case 'admin/help#aggregator':
      $output = '<p>' . t('The aggregator is a powerful on-site syndicator and news reader that gathers fresh content from RSS-, RDF-, and Atom-based feeds made available across the web. Thousands of sites (particularly news sites and blogs) publish their latest headlines and posts in feeds, using a number of standardized XML-based formats. Formats supported by the aggregator include <a href="@rss">RSS</a>, <a href="@rdf">RDF</a>, and <a href="@atom">Atom</a>.', array(
        '@rss' => 'http://cyber.law.harvard.edu/rss/',
        '@rdf' => 'http://www.w3.org/RDF/',
        '@atom' => 'http://www.atomenabled.org',
      )) . '</p>';
      $output .= '<p>' . t('Feeds contain feed items, or individual posts published by the site providing the feed. Feeds may be grouped in categories, generally by topic. Users view feed items in the <a href="@aggregator">main aggregator display</a> or by <a href="@aggregator-sources">their source</a>. Administrators can <a href="@feededit">add, edit and delete feeds</a> and choose how often to check each feed for newly updated items. The most recent items in either a feed or category can be displayed as a block through the <a href="@admin-block">blocks administration page</a>. A <a href="@aggregator-opml">machine-readable OPML file</a> of all feeds is available. A correctly configured <a href="@cron">cron maintenance task</a> is required to update feeds automatically.', array(
        '@aggregator' => url('aggregator'),
        '@aggregator-sources' => url('aggregator/sources'),
        '@feededit' => url('admin/content/aggregator'),
        '@admin-block' => url('admin/build/block'),
        '@aggregator-opml' => url('aggregator/opml'),
        '@cron' => url('admin/reports/status'),
      )) . '</p>';
      $output .= '<p>' . t('For more information, see the online handbook entry for <a href="@aggregator">Aggregator module</a>.', array(
        '@aggregator' => 'http://drupal.org/handbook/modules/aggregator/',
      )) . '</p>';
      return $output;
    case 'admin/content/aggregator':
      $output = '<p>' . t('Thousands of sites (particularly news sites and blogs) publish their latest headlines and posts in feeds, using a number of standardized XML-based formats. Formats supported by the aggregator include <a href="@rss">RSS</a>, <a href="@rdf">RDF</a>, and <a href="@atom">Atom</a>.', array(
        '@rss' => 'http://cyber.law.harvard.edu/rss/',
        '@rdf' => 'http://www.w3.org/RDF/',
        '@atom' => 'http://www.atomenabled.org',
      )) . '</p>';
      $output .= '<p>' . t('Current feeds are listed below, and <a href="@addfeed">new feeds may be added</a>. For each feed or feed category, the <em>latest items</em> block may be enabled at the <a href="@block">blocks administration page</a>.', array(
        '@addfeed' => url('admin/content/aggregator/add/feed'),
        '@block' => url('admin/build/block'),
      )) . '</p>';
      return $output;
    case 'admin/content/aggregator/add/feed':
      return '<p>' . t('Add a feed in RSS, RDF or Atom format. A feed may only have one entry.') . '</p>';
    case 'admin/content/aggregator/add/category':
      return '<p>' . t('Categories allow feed items from different feeds to be grouped together. For example, several sport-related feeds may belong to a category named <em>Sports</em>. Feed items may be grouped automatically (by selecting a category when creating or editing a feed) or manually (via the <em>Categorize</em> page available from feed item listings). Each category provides its own feed page and block.') . '</p>';
  }
}