Skip to content
Snippets Groups Projects
Commit 6b63aa66 authored by Dries Buytaert's avatar Dries Buytaert
Browse files

- Updated the import module to the new documentation scheme.  Patch by
  Michael.
parent 0431f070
No related branches found
No related tags found
2 merge requests!7452Issue #1797438. HTML5 validation is preventing form submit and not fully...,!789Issue #3210310: Adjust Database API to remove deprecated Drupal 9 code in Drupal 10
......@@ -2,58 +2,86 @@
// $Id$
function import_help() {
$output .= "<p>Thousands of web sites, especially news sites and weblogs, syndicate their most recent site content for others to display. The syndicated content always includes titles, also known as headlines, for the newest published stories. Each headline acts as a direct link to the stories on the remote site. Along with the headline, most sites typically provide either the first few paragraphs of the story or a short summary. Many individuals use client-based news aggregators on their personal computer to aggregate content, such as <a href=\"http://www.disobey.com/amphetadesk/\">AmphetaDesk</a>.</p>";
$output .= "<p>Drupal also has a news aggregator built in as a standard feature. With it, you can subscribe to feeds from other sites and display their content for your site users. Simply enable the import module in site administration and enter the feeds that you choose.</p>";
$output .= "<h3>What do I need to subscribe to a feed?</h3>";
$output .= "<p>The standard method of syndication is using the XML-based <a href=\"http://groups.yahoo.com/group/rss-dev/files/specification.html\">Rich Site Summary</a> (RSS). To syndicate a site's content, obtain the full URL of the RSS page providing syndication. Common file tags for RSS pages are .rss, .xml and .rdf. Example: <a href=\"http://slashdot.org/slashdot.rdf\">http://slashdot.org/slashdot.rdf</a>.</p>";
$output .= "<p>Most weblog sites that offer syndication will have an obvious link on the main page. Often you need only look for an xml syndication button, such as the one Drupal uses for site syndication.</p>";
$output .= "<p>But some sites do not make their RSS feeds as easy to find. Or maybe you want to find a number of feeds on a given topic, without extensively searching the web. In that case, try an RSS syndication directory such as <a href=\"http://www.syndic8.com/\">Syndic8</a>.</p>";
$output .= "<p>To learn much more about RSS, read Mark Pilgrim's <a href=\"http://www.xml.com/pub/a/2002/12/18/dive-into-xml.html\">What is RSS</a> and WebReference.com's <a href=\"http://www.webreference.com/authoring/languages/xml/rss/1/\">The Evolution of RSS</a>.</p>";
$output .= "<p>NOTE: Enable your site's xml syndication button by turning on the Syndicate block in block management.</p>";
$output .= "<h3>Configuring news feeds</h3>";
$output .= "<p>To subscribe to an RSS feed on another site, use the <i>administer news feeds</i> shortcut at the top of the news aggregation page. The link leads directly to the news aggregation configuration section of Drupal site administration.</p>";
$output .= "<p>Once there, select <i>add new feed</i> from the left hand menu. Drupal will then ask for the following:</p>";
$output .= "<ul>";
$output .= " <li><b>Title</b> -- The text entered here will be used in your news aggregator, within the administration configuration section, and as title for the news feed block. As a general rule, use the web site name from which the feed originates.</li>";
$output .= " <li><b>URL</b> -- Here you'll enter the fully-qualified URL for the feed for the site you want to subscribe to.</li>";
$output .= " <li><b>Attributes</b> -- Attributes are keywords which can be used to collect feeds into <i>bundles</i> (see below). Think of these as the means of classifying your feeds. Separate multiple attributes with commas. If you do not plan on using the specific feed in a bundle, this input field can be left blank.</li>";
$output .= " <li><b>Update interval</b> -- The update interval is how often Drupal will automatically access the RSS URL for the site for fresh content. The 1 hour default is typically the minimum you will want to use. Accessing another site's RSS page more frequently can be considered impolite. After all, it does require the other site's server to handle your automatic requests. To take advantage of this feature, note that cron.php must be configured to have your feeds updated regularly. Otherwise, you'll have to manually update feeds one at a time within the news aggregation administration section by using <i>update items</i>.</li>";
$output .= "</ul>";
$output .= "<p>Once you submit your new feed, check to see if it is working properly. Select <i>update items </i> on the main news aggregation page. If you do not see any items listed for that feed, edit the feed and make sure that the URL was entered correctly.</p>";
$output .= "<h3>Adding bundles</h3>";
$output .= "<p>You may want to follow some feeds more closely than others. Or perhaps you'd like to display a select list of the titles for some feeds as a block for users. Bundles are a way of grouping your feeds into categories. Bundles look for feeds that contain at least one of the keywords, or attributes, associated with the bundle and display those feeds together.</p>";
$output .= "<p>When adding a bundle, Drupal will ask for:</p>";
$output .= "<ul>";
$output .= " <li><b>Title</b> -- The title will be used in the <i>news by topics</i> listing in your news aggregator and with the customized block created for the bundle.</li>";
$output .= " <li><b>Attributes</b> -- Enter one or more of the attributes used to categorize the news feeds already created. Separate multiple attributes with commas. Be careful to use the same spelling. Don't have any feeds with attributes for the bundle? After creating the bundle, edit existing feeds or create new ones and tag them with the attribute.</li>";
$output .= "</ul>";
$output .= "<h3>Using the news aggregator</h3>";
$output .= "<p>The news aggregator has a number of ways that it displays your subscribed content:</p>";
$output .= "<ul>";
$output .= " <li><b>Latest news</b> -- Displays all incoming content in the order received with:";
$output .= " <ul>";
$output .= " <li>The title of the original post.</li>";
$output .= " <li>The name of the source, which acts as a link to an individual feed page, listing information about that feed and incoming content for that feed only.</li>";
$output .= " <li>A description, the first few paragraphs or summary of the originating post (if any).</li>";
$output .= " <li>A <i>blog it</i> link. Users can select this link to have Drupal automatically prepare a blog post for the specific item.</li>";
$output .= " <li>A <i>feed</i> link, which acts as a link to an individual feed page, listing information about that feed and incoming content for that feed only.</li>";
$output .= " </ul>";
$output .= " </li>";
$output .= " <li><b>News by source -- </b>Organizes incoming content by feed, displaying titles which link to the originating post. Also has an icon which acts as blog it link.</li>";
$output .= " <li><b>News by topic</b> -- Organizes incoming content by bundles, displaying titles which link to the originating post. Also has an icon which acts as
blog it link.</li>";
$output .= " <li><b>News sources</b> -- Displays an alphabetical listing of all subscribed feeds and a description. The title acts as a link to an individual feed page, listing information about that feed and incoming content for that feed only.</li>";
$output .= "</ul>";
$output .= "<h3>RSS feed blocks</h3>";
$output .= "<p>In addition to providing subscribed content through the news aggregator, Drupal automatically creates a block for each subscribed feed and every bundle created. Beside each headline in each block, Drupal includes an icon which acts a blog it link. Enable any or all of the blocks using block management.</p>";
return $output;
function import_help($section = "admin/import/help") {
$output = "";
switch ($section) {
case 'admin/help':
case 'admin/import/help':
$output .= strtr("<p>Thousands of web sites, especially news sites and weblogs, syndicate their most recent site content for others to display. The syndicated content always includes titles, also known as headlines, for the newest published stories. Each headline acts as a direct link to the stories on the remote site. Along with the headline, most sites typically provide either the first few paragraphs of the story or a short summary. Many individuals use client-based news aggregators on their personal computer to aggregate content, such as %amphetadesk</p>", array("%amphetadesk" => "<a href=\"http://www.disobey.com/amphetadesk/\">". t("AmphetaDesk") ."</a>"));
$output .= "<p>Drupal also has a news aggregator built in as a standard feature. With it, you can subscribe to feeds from other sites and display their content for your site users. Simply enable the import module in site administration and enter the feeds that you choose.</p>";
$output .= "<h3>What do I need to subscribe to a feed?</h3>";
$output .= strtr("<p>The standard method of syndication is using the XML-based %rss (RSS). To syndicate a site's content, obtain the full URL of the RSS page providing syndication. Common file tags for RSS pages are .rss, .xml and .rdf. Example: %slashdot-rss.</p>", array("%rss" => "<a href=\"http://groups.yahoo.com/group/rss-dev/files/specification.html\">". t("Rich Site Summary") ."</a>", "%slashdot-rss" => "<a href=\"http://slashdot.org/slashdot.rdf\">". t("http://slashdot.org/slashdot.rfd") ."</a>"));
$output .= "<p>Most weblog sites that offer syndication will have an obvious link on the main page. Often you need only look for an xml syndication button, such as the one Drupal uses for site syndication.</p>";
$output .= strtr("<p>But some sites do not make their RSS feeds as easy to find. Or maybe you want to find a number of feeds on a given topic, without extensively searching the web. In that case, try an RSS syndication directory such as %syndic8.</p>", array("%syndic8" => "<a href=\"http://www.syndic8.com/\">". t("Syndic8") ."</a>"));
$output .= strtr("<p>To learn much more about RSS, read Mark Pilgrim's %rss-what and WebReference.com's %rss-evolution.</p>", array("%rss-what" => "<a href=\"http://www.xml.com/pub/a/2002/12/18/dive-into-xml.html\">". t("What is RSS") ."</a>", "%rss-evolution" => "<a href=\"http://www.webreference.com/authoring/languages/xml/rss/1/\">". t("The Evolution of RSS") ."</a>"));
$output .= "<p>NOTE: Enable your site's xml syndication button by turning on the Syndicate block in block management.</p>";
$output .= "<h3>Configuring news feeds</h3>";
$output .= strtr("<p>To subscribe to an RSS feed on another site, use the %admin-news shortcut at the top of the news aggregation page. The link leads directly to the news aggregation configuration section of Drupal site administration.</p>", array("%admin-news" => l(t("administer news feeds"), "admin/syndication/news")));
$output .= strtr("<p>Once there, select %new-feed from the left hand menu. Drupal will then ask for the following:</p>", array("%new-feed" => l(t("add new feed"), "admin/syndication/news/add/feed") ));
$output .= "<ul>";
$output .= "<li><b>Title</b> -- The text entered here will be used in your news aggregator, within the administration configuration section, and as title for the news feed block. As a general rule, use the web site name from which the feed originates.</li>";
$output .= " <li><b>URL</b> -- Here you'll enter the fully-qualified URL for the feed for the site you want to subscribe to.</li>";
$output .= "<li><b>Attributes</b> -- Attributes are keywords which can be used to collect feeds into <i>bundles</i> (see below). Think of these as the means of classifying your feeds. Separate multiple attributes with commas. If you do not plan on using the specific feed in a bundle, this input field can be left blank.</li>";
$output .= strtr("<li><b>Update interval</b> -- The update interval is how often Drupal will automatically access the RSS URL for the site for fresh content. The 1 hour default is typically the minimum you will want to use. Accessing another site's RSS page more frequently can be considered impolite. After all, it does require the other site's server handle your requests. To use this feature cron.php must be called regularly, otherwise, you'll have to manually update feeds one at a time within the news aggregation administration section by using %update-items.</li>", array("%update-items" => l(t("update items"), "admin/syndication/news") ));
$output .= "</ul>";
$output .= strtr("<p>Once you submit your new feed, check to see if it is working properly. Select %update-items on the %main-aggregation page. If you do not see any items listed for that feed, edit the feed and make sure that the URL was entered correctly.</p>", array("%update-items" => l(t("update items"), "admin/syndication/news"), "%main-aggregation" => l(t("main news aggregation"), "admin/syndication/news") ));
$output .= "<h3>Adding bundles</h3>";
$output .= "<p>You may want to follow some feeds more closely than others. Or perhaps you'd like to display a select list of the titles for some feeds as a block for users. Bundles are a way of grouping your feeds into categories. Bundles look for feeds that contain at least one of the keywords, or attributes, associated with the bundle and display those feeds together.</p>";
$output .= "<p>When adding a bundle, Drupal will ask for:</p>";
$output .= "<ul>";
$output .= " <li><b>Title</b> -- The title will be used in the <i>news by topics</i> listing in your news aggregator and with the customized block created for the bundle.</li>";
$output .= " <li><b>Attributes</b> -- Enter one or more of the attributes used to categorize the news feeds already created. Separate multiple attributes with commas. Be careful to use the same spelling. Don't have any feeds with attributes for the bundle? After creating the bundle, edit existing feeds or create new ones and tag them with the attribute.</li>";
$output .= "</ul>";
$output .= "<h3>Using the news aggregator</h3>";
$output .= "<p>The news aggregator has a number of ways that it displays your subscribed content:</p>";
$output .= "<ul>";
$output .= " <li><b>Latest news</b> -- Displays all incoming content in the order received with:";
$output .= " <ul>";
$output .= " <li>The title of the original post.</li>";
$output .= " <li>The name of the source, which acts as a link to an individual feed page, listing information about that feed and incoming content for that feed only.</li>";
$output .= " <li>A description, the first few paragraphs or summary of the originating post (if any).</li>";
$output .= " <li>A <i>blog it</i> link. Users can select this link to have Drupal automatically prepare a blog post for the specific item.</li>";
$output .= " <li>A <i>feed</i> link, which acts as a link to an individual feed page, listing information about that feed and incoming content for that feed only.</li>";
$output .= " </ul>";
$output .= " </li>";
$output .= " <li><b>News by source</b> -- Organizes incoming content by feed, displaying titles which link to the originating post. Also has an icon which acts as blog it link.</li>";
$output .= " <li><b>News by topic</b> -- Organizes incoming content by bundles, displaying titles which link to the originating post. Also has an icon which acts as blog it link.</li>";
$output .= " <li><b>News sources</b> -- Displays an alphabetical listing of all subscribed feeds and a description. The title acts as a link to an individual feed page, listing information about that feed and incoming content for that feed only.</li>";
$output .= "</ul>";
$output .= "<h3>RSS feed blocks</h3>";
$output .= "<p>In addition to providing subscribed content through the news aggregator, Drupal automatically creates a block for each subscribed feed and every bundle created. Beside each headline in each block, Drupal includes an icon which acts a blog it link. Enable any or all of the blocks using block management.</p>";
break;
case 'admin/system/modules':
$output = "Used to aggregate syndicated content (RSS and RDF).";
break;
case 'admin/system/modules/import':
$output = "Drupal's news aggregator controls how many RSS/RDF items from a single source are displayed in a \"Block\", and on the page that goes with that block.";
break;
case 'admin/syndication/news':
$output = strtr("Several web sites, especially news related sites, syndicate parts of their site's content for other web sites to display. Usually, the syndicated content includes the latest headlines with a direct link to that story on the remote site. Some syndicated content also includes a description of the headline. The standard method of syndication is using the XML based Rich Site Summary (RSS). To get a feed to work you <b>must</b> run \"cron.php\". To display the feed in a block you must turn on the %block. <br /><ul><li>To delete a feed choose \"edit feed\"</li><li>To clear all of the entries from a feed choose \"Remove items\"</li><li>To check whether a feed is working, and to get new items <b>now</b> click on \"update items\"</li></ul><ul><li>To delete a bundle choose \"edit bundle\".</li></ul>", array("%block" => l(t("feed's block"), "admin/block") ));
break;
case 'admin/syndication/news/add/feed':
$output = strtr("Add a site that has an RSS/RDF feed. The URL is the full path to the RSS feed file. For the feed to update automatically you must run \"cron.php\". The \"Attributes\" are used to bundle this feed with other feeds (See %bundle), and to tag articles from this feed.<br />Note: 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.", array("%bundle" => l(t("add new bundle"), "admin/syndication/news/add/bundle") ));
break;
case 'admin/syndication/news/add/bundle':
$output = strtr("Bundles provide a generalized way of creating composite feeds. They allow you, for example, to combine various sport-related feeds into one bundle called <i>Sport</i>. If an article from a feed has been \"tag\"-ged (See %tag too look at and change tags.) with a matching \"Attribute\" then it will be added to the bundle.", array("%tag" => l(t("tag news item"), "admin/syndication/news/tag") ));
break;
case 'admin/syndication/news/tag':
$output = "This allows you to see and change an news item's \"tag\". All articles are originally tagged with the \"Attributes\" of their feed.";
break;
}
return t($output);
}
function import_system($field){
$system["description"] = t("Used to aggregate syndicated content (RSS and RDF).");
$system["admin_help"] = t("Drupal's news aggregator controls how many RSS/RDF items from a single source are displayed in a \"Block\", and on the page that goes with that block.");
$output = "";
if ($field == "description") {$output = import_help("admin/system/modules"); }
else if ($field == "admin_help") {$output = import_help("admin/system/modules/import"); };
return $system[$field];
}
......@@ -78,16 +106,12 @@ function import_link($type) {
}
if ($type == "admin" && user_access("administer news feeds")) {
$help["general"] = t("Several web sites, especially news related sites, syndicate parts of their site's content for other web sites to display. Usually, the syndicated content includes the latest headlines with a direct link to that story on the remote site. Some syndicated content also includes a description of the headline. The standard method of syndication is using the XML based Rich Site Summary (RSS). To get a feed to work you <b>must</b> run \"cron.php\". To display the feed in a block you must turn on the <a href=\"%block\">feed's block</a>. <br /><ul><li>To delete a feed choose \"edit feed\"</li><li>To clear all of the entries from a feed choose \"Remove items\"</li><li>To check whether a feed is working, and to get new items <b>now</b> click on \"update items\"</li></ul><ul><li>To delete a bundle choose \"edit bundle\".</li></ul>", array("%block" => url("admin/block")));
$help["addfeed"] = t("Add a site to that has an RSS/RDF feed. The URL is the full path to the RSS feed file. For the feed to update you must run \"cron.php\". The \"Attributes\" are used to bundle this feed with other feeds (See <a href=\"%bundle\">add new bundle</a>, and to tag articles from this feed.<br />Note: If you already have another feed with the URL you are planning to use, the system will not accept your entry.", array("%bundle" => url("admin/syndication/news/add/bundle")));
$help["bundles"] = t("Bundles provide a generalized way of creating composite feeds. They allow you, for example, to combine various sport-related feeds into one bundle called <i>Sport</i>. If an article from a feed has been \"tag\"-ged (See <a href=\"%tag\">tag news item</a> too look at and change tags.) with a matching \"Attribute\" then it will be added to the bundle.", array("%tag" => url("admin/syndication/news/tag")));
$help["tag"] = t("This allows you to see and change an news item's \"tag\". All articles are originally tagged with the \"Attributes\" of their feed.");
menu("admin/syndication", "content syndication", NULL, NULL, 5);
menu("admin/syndication/news", "news aggregation", "import_admin", $help["general"]);
menu("admin/syndication/news/add/feed", "add new feed", "import_admin", $help["addfeed"], 2);
menu("admin/syndication/news/add/bundle", "add new bundle", "import_admin", $help["bundles"], 3);
menu("admin/syndication/news/tag", "tag news items", "import_admin", $help["tag"], 4);
menu("admin/syndication/news", "news aggregation", "import_admin", import_help("admin/syndication/news") );
menu("admin/syndication/news/add/feed", "add new feed", "import_admin", import_help("admin/syndication/news/add/feed"), 2);
menu("admin/syndication/news/add/bundle", "add new bundle", "import_admin", import_help("admin/syndication/news/add/bundle"), 3);
menu("admin/syndication/news/tag", "tag news items", "import_admin", import_help("admin/syndication/news/tag"), 4);
menu("admin/syndication/news/help", "help", "import_help", NULL, 9);
}
......
......@@ -2,58 +2,86 @@
// $Id$
function import_help() {
$output .= "<p>Thousands of web sites, especially news sites and weblogs, syndicate their most recent site content for others to display. The syndicated content always includes titles, also known as headlines, for the newest published stories. Each headline acts as a direct link to the stories on the remote site. Along with the headline, most sites typically provide either the first few paragraphs of the story or a short summary. Many individuals use client-based news aggregators on their personal computer to aggregate content, such as <a href=\"http://www.disobey.com/amphetadesk/\">AmphetaDesk</a>.</p>";
$output .= "<p>Drupal also has a news aggregator built in as a standard feature. With it, you can subscribe to feeds from other sites and display their content for your site users. Simply enable the import module in site administration and enter the feeds that you choose.</p>";
$output .= "<h3>What do I need to subscribe to a feed?</h3>";
$output .= "<p>The standard method of syndication is using the XML-based <a href=\"http://groups.yahoo.com/group/rss-dev/files/specification.html\">Rich Site Summary</a> (RSS). To syndicate a site's content, obtain the full URL of the RSS page providing syndication. Common file tags for RSS pages are .rss, .xml and .rdf. Example: <a href=\"http://slashdot.org/slashdot.rdf\">http://slashdot.org/slashdot.rdf</a>.</p>";
$output .= "<p>Most weblog sites that offer syndication will have an obvious link on the main page. Often you need only look for an xml syndication button, such as the one Drupal uses for site syndication.</p>";
$output .= "<p>But some sites do not make their RSS feeds as easy to find. Or maybe you want to find a number of feeds on a given topic, without extensively searching the web. In that case, try an RSS syndication directory such as <a href=\"http://www.syndic8.com/\">Syndic8</a>.</p>";
$output .= "<p>To learn much more about RSS, read Mark Pilgrim's <a href=\"http://www.xml.com/pub/a/2002/12/18/dive-into-xml.html\">What is RSS</a> and WebReference.com's <a href=\"http://www.webreference.com/authoring/languages/xml/rss/1/\">The Evolution of RSS</a>.</p>";
$output .= "<p>NOTE: Enable your site's xml syndication button by turning on the Syndicate block in block management.</p>";
$output .= "<h3>Configuring news feeds</h3>";
$output .= "<p>To subscribe to an RSS feed on another site, use the <i>administer news feeds</i> shortcut at the top of the news aggregation page. The link leads directly to the news aggregation configuration section of Drupal site administration.</p>";
$output .= "<p>Once there, select <i>add new feed</i> from the left hand menu. Drupal will then ask for the following:</p>";
$output .= "<ul>";
$output .= " <li><b>Title</b> -- The text entered here will be used in your news aggregator, within the administration configuration section, and as title for the news feed block. As a general rule, use the web site name from which the feed originates.</li>";
$output .= " <li><b>URL</b> -- Here you'll enter the fully-qualified URL for the feed for the site you want to subscribe to.</li>";
$output .= " <li><b>Attributes</b> -- Attributes are keywords which can be used to collect feeds into <i>bundles</i> (see below). Think of these as the means of classifying your feeds. Separate multiple attributes with commas. If you do not plan on using the specific feed in a bundle, this input field can be left blank.</li>";
$output .= " <li><b>Update interval</b> -- The update interval is how often Drupal will automatically access the RSS URL for the site for fresh content. The 1 hour default is typically the minimum you will want to use. Accessing another site's RSS page more frequently can be considered impolite. After all, it does require the other site's server to handle your automatic requests. To take advantage of this feature, note that cron.php must be configured to have your feeds updated regularly. Otherwise, you'll have to manually update feeds one at a time within the news aggregation administration section by using <i>update items</i>.</li>";
$output .= "</ul>";
$output .= "<p>Once you submit your new feed, check to see if it is working properly. Select <i>update items </i> on the main news aggregation page. If you do not see any items listed for that feed, edit the feed and make sure that the URL was entered correctly.</p>";
$output .= "<h3>Adding bundles</h3>";
$output .= "<p>You may want to follow some feeds more closely than others. Or perhaps you'd like to display a select list of the titles for some feeds as a block for users. Bundles are a way of grouping your feeds into categories. Bundles look for feeds that contain at least one of the keywords, or attributes, associated with the bundle and display those feeds together.</p>";
$output .= "<p>When adding a bundle, Drupal will ask for:</p>";
$output .= "<ul>";
$output .= " <li><b>Title</b> -- The title will be used in the <i>news by topics</i> listing in your news aggregator and with the customized block created for the bundle.</li>";
$output .= " <li><b>Attributes</b> -- Enter one or more of the attributes used to categorize the news feeds already created. Separate multiple attributes with commas. Be careful to use the same spelling. Don't have any feeds with attributes for the bundle? After creating the bundle, edit existing feeds or create new ones and tag them with the attribute.</li>";
$output .= "</ul>";
$output .= "<h3>Using the news aggregator</h3>";
$output .= "<p>The news aggregator has a number of ways that it displays your subscribed content:</p>";
$output .= "<ul>";
$output .= " <li><b>Latest news</b> -- Displays all incoming content in the order received with:";
$output .= " <ul>";
$output .= " <li>The title of the original post.</li>";
$output .= " <li>The name of the source, which acts as a link to an individual feed page, listing information about that feed and incoming content for that feed only.</li>";
$output .= " <li>A description, the first few paragraphs or summary of the originating post (if any).</li>";
$output .= " <li>A <i>blog it</i> link. Users can select this link to have Drupal automatically prepare a blog post for the specific item.</li>";
$output .= " <li>A <i>feed</i> link, which acts as a link to an individual feed page, listing information about that feed and incoming content for that feed only.</li>";
$output .= " </ul>";
$output .= " </li>";
$output .= " <li><b>News by source -- </b>Organizes incoming content by feed, displaying titles which link to the originating post. Also has an icon which acts as blog it link.</li>";
$output .= " <li><b>News by topic</b> -- Organizes incoming content by bundles, displaying titles which link to the originating post. Also has an icon which acts as
blog it link.</li>";
$output .= " <li><b>News sources</b> -- Displays an alphabetical listing of all subscribed feeds and a description. The title acts as a link to an individual feed page, listing information about that feed and incoming content for that feed only.</li>";
$output .= "</ul>";
$output .= "<h3>RSS feed blocks</h3>";
$output .= "<p>In addition to providing subscribed content through the news aggregator, Drupal automatically creates a block for each subscribed feed and every bundle created. Beside each headline in each block, Drupal includes an icon which acts a blog it link. Enable any or all of the blocks using block management.</p>";
return $output;
function import_help($section = "admin/import/help") {
$output = "";
switch ($section) {
case 'admin/help':
case 'admin/import/help':
$output .= strtr("<p>Thousands of web sites, especially news sites and weblogs, syndicate their most recent site content for others to display. The syndicated content always includes titles, also known as headlines, for the newest published stories. Each headline acts as a direct link to the stories on the remote site. Along with the headline, most sites typically provide either the first few paragraphs of the story or a short summary. Many individuals use client-based news aggregators on their personal computer to aggregate content, such as %amphetadesk</p>", array("%amphetadesk" => "<a href=\"http://www.disobey.com/amphetadesk/\">". t("AmphetaDesk") ."</a>"));
$output .= "<p>Drupal also has a news aggregator built in as a standard feature. With it, you can subscribe to feeds from other sites and display their content for your site users. Simply enable the import module in site administration and enter the feeds that you choose.</p>";
$output .= "<h3>What do I need to subscribe to a feed?</h3>";
$output .= strtr("<p>The standard method of syndication is using the XML-based %rss (RSS). To syndicate a site's content, obtain the full URL of the RSS page providing syndication. Common file tags for RSS pages are .rss, .xml and .rdf. Example: %slashdot-rss.</p>", array("%rss" => "<a href=\"http://groups.yahoo.com/group/rss-dev/files/specification.html\">". t("Rich Site Summary") ."</a>", "%slashdot-rss" => "<a href=\"http://slashdot.org/slashdot.rdf\">". t("http://slashdot.org/slashdot.rfd") ."</a>"));
$output .= "<p>Most weblog sites that offer syndication will have an obvious link on the main page. Often you need only look for an xml syndication button, such as the one Drupal uses for site syndication.</p>";
$output .= strtr("<p>But some sites do not make their RSS feeds as easy to find. Or maybe you want to find a number of feeds on a given topic, without extensively searching the web. In that case, try an RSS syndication directory such as %syndic8.</p>", array("%syndic8" => "<a href=\"http://www.syndic8.com/\">". t("Syndic8") ."</a>"));
$output .= strtr("<p>To learn much more about RSS, read Mark Pilgrim's %rss-what and WebReference.com's %rss-evolution.</p>", array("%rss-what" => "<a href=\"http://www.xml.com/pub/a/2002/12/18/dive-into-xml.html\">". t("What is RSS") ."</a>", "%rss-evolution" => "<a href=\"http://www.webreference.com/authoring/languages/xml/rss/1/\">". t("The Evolution of RSS") ."</a>"));
$output .= "<p>NOTE: Enable your site's xml syndication button by turning on the Syndicate block in block management.</p>";
$output .= "<h3>Configuring news feeds</h3>";
$output .= strtr("<p>To subscribe to an RSS feed on another site, use the %admin-news shortcut at the top of the news aggregation page. The link leads directly to the news aggregation configuration section of Drupal site administration.</p>", array("%admin-news" => l(t("administer news feeds"), "admin/syndication/news")));
$output .= strtr("<p>Once there, select %new-feed from the left hand menu. Drupal will then ask for the following:</p>", array("%new-feed" => l(t("add new feed"), "admin/syndication/news/add/feed") ));
$output .= "<ul>";
$output .= "<li><b>Title</b> -- The text entered here will be used in your news aggregator, within the administration configuration section, and as title for the news feed block. As a general rule, use the web site name from which the feed originates.</li>";
$output .= " <li><b>URL</b> -- Here you'll enter the fully-qualified URL for the feed for the site you want to subscribe to.</li>";
$output .= "<li><b>Attributes</b> -- Attributes are keywords which can be used to collect feeds into <i>bundles</i> (see below). Think of these as the means of classifying your feeds. Separate multiple attributes with commas. If you do not plan on using the specific feed in a bundle, this input field can be left blank.</li>";
$output .= strtr("<li><b>Update interval</b> -- The update interval is how often Drupal will automatically access the RSS URL for the site for fresh content. The 1 hour default is typically the minimum you will want to use. Accessing another site's RSS page more frequently can be considered impolite. After all, it does require the other site's server handle your requests. To use this feature cron.php must be called regularly, otherwise, you'll have to manually update feeds one at a time within the news aggregation administration section by using %update-items.</li>", array("%update-items" => l(t("update items"), "admin/syndication/news") ));
$output .= "</ul>";
$output .= strtr("<p>Once you submit your new feed, check to see if it is working properly. Select %update-items on the %main-aggregation page. If you do not see any items listed for that feed, edit the feed and make sure that the URL was entered correctly.</p>", array("%update-items" => l(t("update items"), "admin/syndication/news"), "%main-aggregation" => l(t("main news aggregation"), "admin/syndication/news") ));
$output .= "<h3>Adding bundles</h3>";
$output .= "<p>You may want to follow some feeds more closely than others. Or perhaps you'd like to display a select list of the titles for some feeds as a block for users. Bundles are a way of grouping your feeds into categories. Bundles look for feeds that contain at least one of the keywords, or attributes, associated with the bundle and display those feeds together.</p>";
$output .= "<p>When adding a bundle, Drupal will ask for:</p>";
$output .= "<ul>";
$output .= " <li><b>Title</b> -- The title will be used in the <i>news by topics</i> listing in your news aggregator and with the customized block created for the bundle.</li>";
$output .= " <li><b>Attributes</b> -- Enter one or more of the attributes used to categorize the news feeds already created. Separate multiple attributes with commas. Be careful to use the same spelling. Don't have any feeds with attributes for the bundle? After creating the bundle, edit existing feeds or create new ones and tag them with the attribute.</li>";
$output .= "</ul>";
$output .= "<h3>Using the news aggregator</h3>";
$output .= "<p>The news aggregator has a number of ways that it displays your subscribed content:</p>";
$output .= "<ul>";
$output .= " <li><b>Latest news</b> -- Displays all incoming content in the order received with:";
$output .= " <ul>";
$output .= " <li>The title of the original post.</li>";
$output .= " <li>The name of the source, which acts as a link to an individual feed page, listing information about that feed and incoming content for that feed only.</li>";
$output .= " <li>A description, the first few paragraphs or summary of the originating post (if any).</li>";
$output .= " <li>A <i>blog it</i> link. Users can select this link to have Drupal automatically prepare a blog post for the specific item.</li>";
$output .= " <li>A <i>feed</i> link, which acts as a link to an individual feed page, listing information about that feed and incoming content for that feed only.</li>";
$output .= " </ul>";
$output .= " </li>";
$output .= " <li><b>News by source</b> -- Organizes incoming content by feed, displaying titles which link to the originating post. Also has an icon which acts as blog it link.</li>";
$output .= " <li><b>News by topic</b> -- Organizes incoming content by bundles, displaying titles which link to the originating post. Also has an icon which acts as blog it link.</li>";
$output .= " <li><b>News sources</b> -- Displays an alphabetical listing of all subscribed feeds and a description. The title acts as a link to an individual feed page, listing information about that feed and incoming content for that feed only.</li>";
$output .= "</ul>";
$output .= "<h3>RSS feed blocks</h3>";
$output .= "<p>In addition to providing subscribed content through the news aggregator, Drupal automatically creates a block for each subscribed feed and every bundle created. Beside each headline in each block, Drupal includes an icon which acts a blog it link. Enable any or all of the blocks using block management.</p>";
break;
case 'admin/system/modules':
$output = "Used to aggregate syndicated content (RSS and RDF).";
break;
case 'admin/system/modules/import':
$output = "Drupal's news aggregator controls how many RSS/RDF items from a single source are displayed in a \"Block\", and on the page that goes with that block.";
break;
case 'admin/syndication/news':
$output = strtr("Several web sites, especially news related sites, syndicate parts of their site's content for other web sites to display. Usually, the syndicated content includes the latest headlines with a direct link to that story on the remote site. Some syndicated content also includes a description of the headline. The standard method of syndication is using the XML based Rich Site Summary (RSS). To get a feed to work you <b>must</b> run \"cron.php\". To display the feed in a block you must turn on the %block. <br /><ul><li>To delete a feed choose \"edit feed\"</li><li>To clear all of the entries from a feed choose \"Remove items\"</li><li>To check whether a feed is working, and to get new items <b>now</b> click on \"update items\"</li></ul><ul><li>To delete a bundle choose \"edit bundle\".</li></ul>", array("%block" => l(t("feed's block"), "admin/block") ));
break;
case 'admin/syndication/news/add/feed':
$output = strtr("Add a site that has an RSS/RDF feed. The URL is the full path to the RSS feed file. For the feed to update automatically you must run \"cron.php\". The \"Attributes\" are used to bundle this feed with other feeds (See %bundle), and to tag articles from this feed.<br />Note: 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.", array("%bundle" => l(t("add new bundle"), "admin/syndication/news/add/bundle") ));
break;
case 'admin/syndication/news/add/bundle':
$output = strtr("Bundles provide a generalized way of creating composite feeds. They allow you, for example, to combine various sport-related feeds into one bundle called <i>Sport</i>. If an article from a feed has been \"tag\"-ged (See %tag too look at and change tags.) with a matching \"Attribute\" then it will be added to the bundle.", array("%tag" => l(t("tag news item"), "admin/syndication/news/tag") ));
break;
case 'admin/syndication/news/tag':
$output = "This allows you to see and change an news item's \"tag\". All articles are originally tagged with the \"Attributes\" of their feed.";
break;
}
return t($output);
}
function import_system($field){
$system["description"] = t("Used to aggregate syndicated content (RSS and RDF).");
$system["admin_help"] = t("Drupal's news aggregator controls how many RSS/RDF items from a single source are displayed in a \"Block\", and on the page that goes with that block.");
$output = "";
if ($field == "description") {$output = import_help("admin/system/modules"); }
else if ($field == "admin_help") {$output = import_help("admin/system/modules/import"); };
return $system[$field];
}
......@@ -78,16 +106,12 @@ function import_link($type) {
}
if ($type == "admin" && user_access("administer news feeds")) {
$help["general"] = t("Several web sites, especially news related sites, syndicate parts of their site's content for other web sites to display. Usually, the syndicated content includes the latest headlines with a direct link to that story on the remote site. Some syndicated content also includes a description of the headline. The standard method of syndication is using the XML based Rich Site Summary (RSS). To get a feed to work you <b>must</b> run \"cron.php\". To display the feed in a block you must turn on the <a href=\"%block\">feed's block</a>. <br /><ul><li>To delete a feed choose \"edit feed\"</li><li>To clear all of the entries from a feed choose \"Remove items\"</li><li>To check whether a feed is working, and to get new items <b>now</b> click on \"update items\"</li></ul><ul><li>To delete a bundle choose \"edit bundle\".</li></ul>", array("%block" => url("admin/block")));
$help["addfeed"] = t("Add a site to that has an RSS/RDF feed. The URL is the full path to the RSS feed file. For the feed to update you must run \"cron.php\". The \"Attributes\" are used to bundle this feed with other feeds (See <a href=\"%bundle\">add new bundle</a>, and to tag articles from this feed.<br />Note: If you already have another feed with the URL you are planning to use, the system will not accept your entry.", array("%bundle" => url("admin/syndication/news/add/bundle")));
$help["bundles"] = t("Bundles provide a generalized way of creating composite feeds. They allow you, for example, to combine various sport-related feeds into one bundle called <i>Sport</i>. If an article from a feed has been \"tag\"-ged (See <a href=\"%tag\">tag news item</a> too look at and change tags.) with a matching \"Attribute\" then it will be added to the bundle.", array("%tag" => url("admin/syndication/news/tag")));
$help["tag"] = t("This allows you to see and change an news item's \"tag\". All articles are originally tagged with the \"Attributes\" of their feed.");
menu("admin/syndication", "content syndication", NULL, NULL, 5);
menu("admin/syndication/news", "news aggregation", "import_admin", $help["general"]);
menu("admin/syndication/news/add/feed", "add new feed", "import_admin", $help["addfeed"], 2);
menu("admin/syndication/news/add/bundle", "add new bundle", "import_admin", $help["bundles"], 3);
menu("admin/syndication/news/tag", "tag news items", "import_admin", $help["tag"], 4);
menu("admin/syndication/news", "news aggregation", "import_admin", import_help("admin/syndication/news") );
menu("admin/syndication/news/add/feed", "add new feed", "import_admin", import_help("admin/syndication/news/add/feed"), 2);
menu("admin/syndication/news/add/bundle", "add new bundle", "import_admin", import_help("admin/syndication/news/add/bundle"), 3);
menu("admin/syndication/news/tag", "tag news items", "import_admin", import_help("admin/syndication/news/tag"), 4);
menu("admin/syndication/news/help", "help", "import_help", NULL, 9);
}
......
......@@ -2,58 +2,86 @@
// $Id$
function import_help() {
$output .= "<p>Thousands of web sites, especially news sites and weblogs, syndicate their most recent site content for others to display. The syndicated content always includes titles, also known as headlines, for the newest published stories. Each headline acts as a direct link to the stories on the remote site. Along with the headline, most sites typically provide either the first few paragraphs of the story or a short summary. Many individuals use client-based news aggregators on their personal computer to aggregate content, such as <a href=\"http://www.disobey.com/amphetadesk/\">AmphetaDesk</a>.</p>";
$output .= "<p>Drupal also has a news aggregator built in as a standard feature. With it, you can subscribe to feeds from other sites and display their content for your site users. Simply enable the import module in site administration and enter the feeds that you choose.</p>";
$output .= "<h3>What do I need to subscribe to a feed?</h3>";
$output .= "<p>The standard method of syndication is using the XML-based <a href=\"http://groups.yahoo.com/group/rss-dev/files/specification.html\">Rich Site Summary</a> (RSS). To syndicate a site's content, obtain the full URL of the RSS page providing syndication. Common file tags for RSS pages are .rss, .xml and .rdf. Example: <a href=\"http://slashdot.org/slashdot.rdf\">http://slashdot.org/slashdot.rdf</a>.</p>";
$output .= "<p>Most weblog sites that offer syndication will have an obvious link on the main page. Often you need only look for an xml syndication button, such as the one Drupal uses for site syndication.</p>";
$output .= "<p>But some sites do not make their RSS feeds as easy to find. Or maybe you want to find a number of feeds on a given topic, without extensively searching the web. In that case, try an RSS syndication directory such as <a href=\"http://www.syndic8.com/\">Syndic8</a>.</p>";
$output .= "<p>To learn much more about RSS, read Mark Pilgrim's <a href=\"http://www.xml.com/pub/a/2002/12/18/dive-into-xml.html\">What is RSS</a> and WebReference.com's <a href=\"http://www.webreference.com/authoring/languages/xml/rss/1/\">The Evolution of RSS</a>.</p>";
$output .= "<p>NOTE: Enable your site's xml syndication button by turning on the Syndicate block in block management.</p>";
$output .= "<h3>Configuring news feeds</h3>";
$output .= "<p>To subscribe to an RSS feed on another site, use the <i>administer news feeds</i> shortcut at the top of the news aggregation page. The link leads directly to the news aggregation configuration section of Drupal site administration.</p>";
$output .= "<p>Once there, select <i>add new feed</i> from the left hand menu. Drupal will then ask for the following:</p>";
$output .= "<ul>";
$output .= " <li><b>Title</b> -- The text entered here will be used in your news aggregator, within the administration configuration section, and as title for the news feed block. As a general rule, use the web site name from which the feed originates.</li>";
$output .= " <li><b>URL</b> -- Here you'll enter the fully-qualified URL for the feed for the site you want to subscribe to.</li>";
$output .= " <li><b>Attributes</b> -- Attributes are keywords which can be used to collect feeds into <i>bundles</i> (see below). Think of these as the means of classifying your feeds. Separate multiple attributes with commas. If you do not plan on using the specific feed in a bundle, this input field can be left blank.</li>";
$output .= " <li><b>Update interval</b> -- The update interval is how often Drupal will automatically access the RSS URL for the site for fresh content. The 1 hour default is typically the minimum you will want to use. Accessing another site's RSS page more frequently can be considered impolite. After all, it does require the other site's server to handle your automatic requests. To take advantage of this feature, note that cron.php must be configured to have your feeds updated regularly. Otherwise, you'll have to manually update feeds one at a time within the news aggregation administration section by using <i>update items</i>.</li>";
$output .= "</ul>";
$output .= "<p>Once you submit your new feed, check to see if it is working properly. Select <i>update items </i> on the main news aggregation page. If you do not see any items listed for that feed, edit the feed and make sure that the URL was entered correctly.</p>";
$output .= "<h3>Adding bundles</h3>";
$output .= "<p>You may want to follow some feeds more closely than others. Or perhaps you'd like to display a select list of the titles for some feeds as a block for users. Bundles are a way of grouping your feeds into categories. Bundles look for feeds that contain at least one of the keywords, or attributes, associated with the bundle and display those feeds together.</p>";
$output .= "<p>When adding a bundle, Drupal will ask for:</p>";
$output .= "<ul>";
$output .= " <li><b>Title</b> -- The title will be used in the <i>news by topics</i> listing in your news aggregator and with the customized block created for the bundle.</li>";
$output .= " <li><b>Attributes</b> -- Enter one or more of the attributes used to categorize the news feeds already created. Separate multiple attributes with commas. Be careful to use the same spelling. Don't have any feeds with attributes for the bundle? After creating the bundle, edit existing feeds or create new ones and tag them with the attribute.</li>";
$output .= "</ul>";
$output .= "<h3>Using the news aggregator</h3>";
$output .= "<p>The news aggregator has a number of ways that it displays your subscribed content:</p>";
$output .= "<ul>";
$output .= " <li><b>Latest news</b> -- Displays all incoming content in the order received with:";
$output .= " <ul>";
$output .= " <li>The title of the original post.</li>";
$output .= " <li>The name of the source, which acts as a link to an individual feed page, listing information about that feed and incoming content for that feed only.</li>";
$output .= " <li>A description, the first few paragraphs or summary of the originating post (if any).</li>";
$output .= " <li>A <i>blog it</i> link. Users can select this link to have Drupal automatically prepare a blog post for the specific item.</li>";
$output .= " <li>A <i>feed</i> link, which acts as a link to an individual feed page, listing information about that feed and incoming content for that feed only.</li>";
$output .= " </ul>";
$output .= " </li>";
$output .= " <li><b>News by source -- </b>Organizes incoming content by feed, displaying titles which link to the originating post. Also has an icon which acts as blog it link.</li>";
$output .= " <li><b>News by topic</b> -- Organizes incoming content by bundles, displaying titles which link to the originating post. Also has an icon which acts as
blog it link.</li>";
$output .= " <li><b>News sources</b> -- Displays an alphabetical listing of all subscribed feeds and a description. The title acts as a link to an individual feed page, listing information about that feed and incoming content for that feed only.</li>";
$output .= "</ul>";
$output .= "<h3>RSS feed blocks</h3>";
$output .= "<p>In addition to providing subscribed content through the news aggregator, Drupal automatically creates a block for each subscribed feed and every bundle created. Beside each headline in each block, Drupal includes an icon which acts a blog it link. Enable any or all of the blocks using block management.</p>";
return $output;
function import_help($section = "admin/import/help") {
$output = "";
switch ($section) {
case 'admin/help':
case 'admin/import/help':
$output .= strtr("<p>Thousands of web sites, especially news sites and weblogs, syndicate their most recent site content for others to display. The syndicated content always includes titles, also known as headlines, for the newest published stories. Each headline acts as a direct link to the stories on the remote site. Along with the headline, most sites typically provide either the first few paragraphs of the story or a short summary. Many individuals use client-based news aggregators on their personal computer to aggregate content, such as %amphetadesk</p>", array("%amphetadesk" => "<a href=\"http://www.disobey.com/amphetadesk/\">". t("AmphetaDesk") ."</a>"));
$output .= "<p>Drupal also has a news aggregator built in as a standard feature. With it, you can subscribe to feeds from other sites and display their content for your site users. Simply enable the import module in site administration and enter the feeds that you choose.</p>";
$output .= "<h3>What do I need to subscribe to a feed?</h3>";
$output .= strtr("<p>The standard method of syndication is using the XML-based %rss (RSS). To syndicate a site's content, obtain the full URL of the RSS page providing syndication. Common file tags for RSS pages are .rss, .xml and .rdf. Example: %slashdot-rss.</p>", array("%rss" => "<a href=\"http://groups.yahoo.com/group/rss-dev/files/specification.html\">". t("Rich Site Summary") ."</a>", "%slashdot-rss" => "<a href=\"http://slashdot.org/slashdot.rdf\">". t("http://slashdot.org/slashdot.rfd") ."</a>"));
$output .= "<p>Most weblog sites that offer syndication will have an obvious link on the main page. Often you need only look for an xml syndication button, such as the one Drupal uses for site syndication.</p>";
$output .= strtr("<p>But some sites do not make their RSS feeds as easy to find. Or maybe you want to find a number of feeds on a given topic, without extensively searching the web. In that case, try an RSS syndication directory such as %syndic8.</p>", array("%syndic8" => "<a href=\"http://www.syndic8.com/\">". t("Syndic8") ."</a>"));
$output .= strtr("<p>To learn much more about RSS, read Mark Pilgrim's %rss-what and WebReference.com's %rss-evolution.</p>", array("%rss-what" => "<a href=\"http://www.xml.com/pub/a/2002/12/18/dive-into-xml.html\">". t("What is RSS") ."</a>", "%rss-evolution" => "<a href=\"http://www.webreference.com/authoring/languages/xml/rss/1/\">". t("The Evolution of RSS") ."</a>"));
$output .= "<p>NOTE: Enable your site's xml syndication button by turning on the Syndicate block in block management.</p>";
$output .= "<h3>Configuring news feeds</h3>";
$output .= strtr("<p>To subscribe to an RSS feed on another site, use the %admin-news shortcut at the top of the news aggregation page. The link leads directly to the news aggregation configuration section of Drupal site administration.</p>", array("%admin-news" => l(t("administer news feeds"), "admin/syndication/news")));
$output .= strtr("<p>Once there, select %new-feed from the left hand menu. Drupal will then ask for the following:</p>", array("%new-feed" => l(t("add new feed"), "admin/syndication/news/add/feed") ));
$output .= "<ul>";
$output .= "<li><b>Title</b> -- The text entered here will be used in your news aggregator, within the administration configuration section, and as title for the news feed block. As a general rule, use the web site name from which the feed originates.</li>";
$output .= " <li><b>URL</b> -- Here you'll enter the fully-qualified URL for the feed for the site you want to subscribe to.</li>";
$output .= "<li><b>Attributes</b> -- Attributes are keywords which can be used to collect feeds into <i>bundles</i> (see below). Think of these as the means of classifying your feeds. Separate multiple attributes with commas. If you do not plan on using the specific feed in a bundle, this input field can be left blank.</li>";
$output .= strtr("<li><b>Update interval</b> -- The update interval is how often Drupal will automatically access the RSS URL for the site for fresh content. The 1 hour default is typically the minimum you will want to use. Accessing another site's RSS page more frequently can be considered impolite. After all, it does require the other site's server handle your requests. To use this feature cron.php must be called regularly, otherwise, you'll have to manually update feeds one at a time within the news aggregation administration section by using %update-items.</li>", array("%update-items" => l(t("update items"), "admin/syndication/news") ));
$output .= "</ul>";
$output .= strtr("<p>Once you submit your new feed, check to see if it is working properly. Select %update-items on the %main-aggregation page. If you do not see any items listed for that feed, edit the feed and make sure that the URL was entered correctly.</p>", array("%update-items" => l(t("update items"), "admin/syndication/news"), "%main-aggregation" => l(t("main news aggregation"), "admin/syndication/news") ));
$output .= "<h3>Adding bundles</h3>";
$output .= "<p>You may want to follow some feeds more closely than others. Or perhaps you'd like to display a select list of the titles for some feeds as a block for users. Bundles are a way of grouping your feeds into categories. Bundles look for feeds that contain at least one of the keywords, or attributes, associated with the bundle and display those feeds together.</p>";
$output .= "<p>When adding a bundle, Drupal will ask for:</p>";
$output .= "<ul>";
$output .= " <li><b>Title</b> -- The title will be used in the <i>news by topics</i> listing in your news aggregator and with the customized block created for the bundle.</li>";
$output .= " <li><b>Attributes</b> -- Enter one or more of the attributes used to categorize the news feeds already created. Separate multiple attributes with commas. Be careful to use the same spelling. Don't have any feeds with attributes for the bundle? After creating the bundle, edit existing feeds or create new ones and tag them with the attribute.</li>";
$output .= "</ul>";
$output .= "<h3>Using the news aggregator</h3>";
$output .= "<p>The news aggregator has a number of ways that it displays your subscribed content:</p>";
$output .= "<ul>";
$output .= " <li><b>Latest news</b> -- Displays all incoming content in the order received with:";
$output .= " <ul>";
$output .= " <li>The title of the original post.</li>";
$output .= " <li>The name of the source, which acts as a link to an individual feed page, listing information about that feed and incoming content for that feed only.</li>";
$output .= " <li>A description, the first few paragraphs or summary of the originating post (if any).</li>";
$output .= " <li>A <i>blog it</i> link. Users can select this link to have Drupal automatically prepare a blog post for the specific item.</li>";
$output .= " <li>A <i>feed</i> link, which acts as a link to an individual feed page, listing information about that feed and incoming content for that feed only.</li>";
$output .= " </ul>";
$output .= " </li>";
$output .= " <li><b>News by source</b> -- Organizes incoming content by feed, displaying titles which link to the originating post. Also has an icon which acts as blog it link.</li>";
$output .= " <li><b>News by topic</b> -- Organizes incoming content by bundles, displaying titles which link to the originating post. Also has an icon which acts as blog it link.</li>";
$output .= " <li><b>News sources</b> -- Displays an alphabetical listing of all subscribed feeds and a description. The title acts as a link to an individual feed page, listing information about that feed and incoming content for that feed only.</li>";
$output .= "</ul>";
$output .= "<h3>RSS feed blocks</h3>";
$output .= "<p>In addition to providing subscribed content through the news aggregator, Drupal automatically creates a block for each subscribed feed and every bundle created. Beside each headline in each block, Drupal includes an icon which acts a blog it link. Enable any or all of the blocks using block management.</p>";
break;
case 'admin/system/modules':
$output = "Used to aggregate syndicated content (RSS and RDF).";
break;
case 'admin/system/modules/import':
$output = "Drupal's news aggregator controls how many RSS/RDF items from a single source are displayed in a \"Block\", and on the page that goes with that block.";
break;
case 'admin/syndication/news':
$output = strtr("Several web sites, especially news related sites, syndicate parts of their site's content for other web sites to display. Usually, the syndicated content includes the latest headlines with a direct link to that story on the remote site. Some syndicated content also includes a description of the headline. The standard method of syndication is using the XML based Rich Site Summary (RSS). To get a feed to work you <b>must</b> run \"cron.php\". To display the feed in a block you must turn on the %block. <br /><ul><li>To delete a feed choose \"edit feed\"</li><li>To clear all of the entries from a feed choose \"Remove items\"</li><li>To check whether a feed is working, and to get new items <b>now</b> click on \"update items\"</li></ul><ul><li>To delete a bundle choose \"edit bundle\".</li></ul>", array("%block" => l(t("feed's block"), "admin/block") ));
break;
case 'admin/syndication/news/add/feed':
$output = strtr("Add a site that has an RSS/RDF feed. The URL is the full path to the RSS feed file. For the feed to update automatically you must run \"cron.php\". The \"Attributes\" are used to bundle this feed with other feeds (See %bundle), and to tag articles from this feed.<br />Note: 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.", array("%bundle" => l(t("add new bundle"), "admin/syndication/news/add/bundle") ));
break;
case 'admin/syndication/news/add/bundle':
$output = strtr("Bundles provide a generalized way of creating composite feeds. They allow you, for example, to combine various sport-related feeds into one bundle called <i>Sport</i>. If an article from a feed has been \"tag\"-ged (See %tag too look at and change tags.) with a matching \"Attribute\" then it will be added to the bundle.", array("%tag" => l(t("tag news item"), "admin/syndication/news/tag") ));
break;
case 'admin/syndication/news/tag':
$output = "This allows you to see and change an news item's \"tag\". All articles are originally tagged with the \"Attributes\" of their feed.";
break;
}
return t($output);
}
function import_system($field){
$system["description"] = t("Used to aggregate syndicated content (RSS and RDF).");
$system["admin_help"] = t("Drupal's news aggregator controls how many RSS/RDF items from a single source are displayed in a \"Block\", and on the page that goes with that block.");
$output = "";
if ($field == "description") {$output = import_help("admin/system/modules"); }
else if ($field == "admin_help") {$output = import_help("admin/system/modules/import"); };
return $system[$field];
}
......@@ -78,16 +106,12 @@ function import_link($type) {
}
if ($type == "admin" && user_access("administer news feeds")) {
$help["general"] = t("Several web sites, especially news related sites, syndicate parts of their site's content for other web sites to display. Usually, the syndicated content includes the latest headlines with a direct link to that story on the remote site. Some syndicated content also includes a description of the headline. The standard method of syndication is using the XML based Rich Site Summary (RSS). To get a feed to work you <b>must</b> run \"cron.php\". To display the feed in a block you must turn on the <a href=\"%block\">feed's block</a>. <br /><ul><li>To delete a feed choose \"edit feed\"</li><li>To clear all of the entries from a feed choose \"Remove items\"</li><li>To check whether a feed is working, and to get new items <b>now</b> click on \"update items\"</li></ul><ul><li>To delete a bundle choose \"edit bundle\".</li></ul>", array("%block" => url("admin/block")));
$help["addfeed"] = t("Add a site to that has an RSS/RDF feed. The URL is the full path to the RSS feed file. For the feed to update you must run \"cron.php\". The \"Attributes\" are used to bundle this feed with other feeds (See <a href=\"%bundle\">add new bundle</a>, and to tag articles from this feed.<br />Note: If you already have another feed with the URL you are planning to use, the system will not accept your entry.", array("%bundle" => url("admin/syndication/news/add/bundle")));
$help["bundles"] = t("Bundles provide a generalized way of creating composite feeds. They allow you, for example, to combine various sport-related feeds into one bundle called <i>Sport</i>. If an article from a feed has been \"tag\"-ged (See <a href=\"%tag\">tag news item</a> too look at and change tags.) with a matching \"Attribute\" then it will be added to the bundle.", array("%tag" => url("admin/syndication/news/tag")));
$help["tag"] = t("This allows you to see and change an news item's \"tag\". All articles are originally tagged with the \"Attributes\" of their feed.");
menu("admin/syndication", "content syndication", NULL, NULL, 5);
menu("admin/syndication/news", "news aggregation", "import_admin", $help["general"]);
menu("admin/syndication/news/add/feed", "add new feed", "import_admin", $help["addfeed"], 2);
menu("admin/syndication/news/add/bundle", "add new bundle", "import_admin", $help["bundles"], 3);
menu("admin/syndication/news/tag", "tag news items", "import_admin", $help["tag"], 4);
menu("admin/syndication/news", "news aggregation", "import_admin", import_help("admin/syndication/news") );
menu("admin/syndication/news/add/feed", "add new feed", "import_admin", import_help("admin/syndication/news/add/feed"), 2);
menu("admin/syndication/news/add/bundle", "add new bundle", "import_admin", import_help("admin/syndication/news/add/bundle"), 3);
menu("admin/syndication/news/tag", "tag news items", "import_admin", import_help("admin/syndication/news/tag"), 4);
menu("admin/syndication/news/help", "help", "import_help", NULL, 9);
}
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment