function aggregator_help in Drupal 4

Same name and namespace in other branches

1. 8 core/modules/aggregator/aggregator.module \aggregator_help()
2. 5 modules/aggregator/aggregator.module \aggregator_help()
3. 6 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.module, line 11

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

Code

function aggregator_help($section) {
  switch ($section) {
    case 'admin/help#aggregator':
      $output = '<p>' . t('The news aggregator is a powerful on-site RSS syndicator/news reader that can gather fresh content from news sites and weblogs around the web.') . '</p>';
      $output .= '<p>' . t('Users can view the latest news chronologically in the <a href="%aggregator">main news aggregator display</a> or by <a href="%aggregator-sources">source</a>. Administrators can add, edit and delete feeds and choose how often to check for newly updated news for each individual feed. Administrators can also tag individual feeds with categories, offering selective grouping of some feeds into separate displays. Listings of the latest news for individual sources or categorized sources can be enabled as blocks for display in the sidebar through the <a href="%admin-block">block administration page</a>. The news aggregator requires cron to check for the latest news from the sites to which you have subscribed. Drupal also provides a <a href="%aggregator-opml">machine-readable OPML file</a> of all of your subscribed feeds.', array(
        '%aggregator' => url('aggregator'),
        '%aggregator-sources' => url('aggregator/sources'),
        '%admin-block' => url('admin/block'),
        '%aggregator-opml' => url('aggregator/opml'),
      )) . '</p>';
      $output .= t('<p>You can</p>
<ul>
<li>administer your list of news feeds <a href="%admin-aggregator">administer &gt;&gt;  aggregator</a>.</li>
<li>add a new feed <a href="%admin-aggregator-add-feed">administer &gt;&gt; aggregator &gt;&gt; add feed</a>.</li>
<li>add a new category <a href="%admin-aggregator-add-category">administer &gt;&gt; aggregator &gt;&gt; add category</a>.</li>
<li>configure global settings for the news aggregator <a href="%admin-settings-aggregator">administer &gt;&gt; settings &gt;&gt; aggregator</a>.</li>
<li>control access to the aggregator module through access permissions <a href="%admin-access">administer &gt;&gt; access control &gt;&gt; permissions</a>.</li>
<li>set permissions to access new feeds for user roles such as anonymous users at <a href="%admin-access">administer &gt;&gt; access control</a>.</li>
<li>view the <a href="%aggregator">aggregator page</a>.</li>
</ul>
', array(
        '%admin-aggregator' => url('admin/aggregator'),
        '%admin-aggregator-add-feed' => url('admin/aggregator/add/feed'),
        '%admin-aggregator-add-category' => url('admin/aggregator/add/category'),
        '%admin-settings-aggregator' => url('admin/settings/aggregator'),
        '%admin-access' => url('admin/access'),
        '%aggregator' => url('aggregator'),
      ));
      $output .= '<p>' . t('For more information please read the configuration and customization handbook <a href="%aggregator">Aggregator page</a>.', array(
        '%aggregator' => 'http://drupal.org/handbook/modules/aggregator/',
      )) . '</p>';
      return $output;
    case 'admin/modules#description':
      return t('Aggregates syndicated content (RSS, RDF, and Atom feeds).');
    case 'admin/aggregator':
      return t('<p>Thousands of sites (particularly news sites and weblogs) publish their latest headlines and/or stories in a machine-readable format so that other sites can easily link to them. This content is usually in the form of an <a href="http://blogs.law.harvard.edu/tech/rss">RSS</a> feed (which is an XML-based syndication standard). To display the feed or category in a block you must decide how many items to show by editing the feed or block and turning on the <a href="%block">feed\'s block</a>.</p>', array(
        '%block' => url('admin/block'),
      ));
    case 'admin/aggregator/add/feed':
      return t('<p>Add a site that has an RSS/RDF/Atom feed. The URL is the full path to the feed file. For the feed to update automatically you must run "cron.php" on a regular basis. If you already have a feed with the URL you are planning to use, the system will not accept another feed with the same URL.</p>');
    case 'admin/aggregator/add/category':
      return t('<p>Categories provide a way to group items from different news feeds together. Each news category has its own feed page and block. For example, you could tag various sport-related feeds as belonging to a category called <em>Sports</em>. News items can be added to a category automatically by setting a feed to automatically place its item into that category, or by using the categorize items link in any listing of news items.</p>');
  }
}