%HEADLINES{"..."}%
| Parameter | Explanation | Default |
|---|---|---|
"..." |
Source of RSS or ATOM feed; this can be an url (starting with http) or a web.topic location for internal feeds | None; is required |
href="..." |
(Alternative to above) | N/A |
refresh="60" |
Refresh rate in minutes for caching feed; "0" for no caching |
Global REFRESH setting |
limit="12" |
Maximum number of items shown | Global LIMIT setting |
header="..." |
Header. May include these variables: - $channeltitle, $title: title of channel (channel.title) - $channellink, $link: link of channel (channel.link) - $channeldescription, $description: description (channel.description) - $channeldate, $date: publication date of the channel (channel.pubDate) - $rights: copyrights of the channel (channel.copyright) - $imagetitle: title text for site (image.title) - $imagelink: link for site (image.link) - $imageurl: URL of image (image.url) - $imagedescription: description of image (image.description) |
Global HEADER setting |
format="..." |
Format of one item. May include these variables: - $title: news item title (item.title) - $link: news item link (item.link) - $description: news item description (item.description) - $date: the publication date (item.pubDate, item.date) - $category: the article category (item.category) |
Global FORMAT setting |
touch="..." |
Touch (edit/save) topics if the feed has updates. Specify a comma-space delimited list of TopicNames or Web.TopicNames, such as "%TOPIC%, NewsLetter". Useful to send out newsletter using MailerContrib, showing new feeds since last newsletter. To update feeds, visit topics with feeds in regular intervals (using cron with wget or the like). |
N/A |
header and format parameters might also use variables rendering the dc, image and content namespace information. Note, that only bits of interest have been implemented so far and those namespaces might not be implemented fully yet.
dc namespace dc namespace info, that could be used in header and format. Note that some of the variables are already used above. This is done by purpose to use different feeds with the same formatting parameters. If there's a conflict the non-dc tags have higher precedence, i.e. a <title> content </title> is preferred over <dc:title> content </dc:title>. $title: channel/article title (dc:title)
$creator: channel creator (dc:creator)
$subject: subject text; this will also add an image according to the subject hash list, see above (dc:subject)
$description: ... (dc:description)
$publisher: the channel/article publisher (dc:publisher)
$contributor: ... (dc:contributor)
$date: ... (dc:date)
$type: ... (dc:type)
$format: ... (dc:format)
$identifier: ... (dc:identifier)
$source: ... (dc:source)
$language: ... (dc:language)
$relation: ... (dc:relation)
$coverage: ... (dc: coverage)
$rights: ... (dc: rights)
image namespace image:item is converted into an <img> tag using the following mappings: src: image url (rdf:about attribute of the image.item tag)
alt: image title (title)
width: image width (image:width)
height: image height image:height)
content namespace $content is referring to the <content:encoding> content </content:encoding>.
%HEADLINES{ "http://slashdot.org/slashdot.rdf"
header="*[[$link][$title]]:* $description"
format="$t* [[$link][$title]]"
limit="4"
}%
to get the latest Slashdot news as a bullet list format:
%HEADLINES{ "http://www.business-opportunities.biz/feed" limit="2" }%
to get the latest postings on the "Business Opportunities" weblog:

With the start of camping season upon us, I’m reminded of this business idea that Loyd from Yosemite Blog sent to me a few years ago:
Here's a great part time business to start&hellip. camping spot savers! On major holidays they go in a few days in advance, set up a tent, and camp there until the payee gets there.
If they get a good spot the payee could ''tip'' them. We could get college students and high school kids above 18 to do it.
Maybe charge about $7.50 on top of the campsite fee not including tip. Pay in advance credit card deal.
Because a lot of campgrounds are first come, first serve and don't offer reservations or if they do they book quickly like the ones in Yosemite.
Photo by IDAK/ShutterStock.

When you see the doctors standing in front of the whiteboard with all of the patients and surgeries mapped out on Grey’s Anatomy, that’s real life. Would you try to run your company from a whiteboard?
Xylemed thinks you shouldn’t either. They’ve created a program that will replace the whiteboards hospital use to track their patients and surgeries.
Nursing supervisors use a hand-written markerboard to keep track of the current roster of patient names, doctors treating them, procedures they're undergoing, and even critical contact information. Xylemed hopes to bring this into the 21st century with a software application that can replace all that scribbling and erasing. It's already being used at several locations, including Harborview Medical Center and the Seattle Cancer Care Alliance.
HEADLINESPLUGIN_USERAGENTNAME setting, add a * Set HEADLINESPLUGIN_USERAGENTNAME = ... bullet in Main.TWikiPreferences.
0 to disable caching: 1, or fallback to TWiki's internal getUrl() method if set to 0:
* Set HEADLINESPLUGIN_HEADER = <div class="headlinesChannel"><div class="headlinesLogo"><img src="$imageurl" alt="$imagetitle" border="0" />%BR%</div><div class="headlinesTitle">$n---+!! <a href="$link">$title</a></div><div class="headlinesDate">$date</div><div class="headlinesDescription">$description</div><div class="headlinesRight">$rights</div></div>
* Set HEADLINESPLUGIN_FORMAT = <div class="headlinesArticle"><div class="headlinesTitle"><a href="$link">$title</a></div>$n<span class="headlinesDate">$date</span> <span class="headlinesCreator"> $creator</span> <span class="headlinesSubject"> $subject </span>$n<div class="headlinesText"> $description</div></div>
$TWiki::cfg{PROXY}{HOST} - proxy host, such as "proxy.example.com";
$TWiki::cfg{PROXY}{PORT} - proxy port, such as "8080";
$TWiki::cfg{PROXY}{SkipProxyForDomains} - domains excluded from proxy, such as "intra.example.com, bugs.example.com";
headlinesRss: output of the HeadlinesPlugin (div) headlinesChannel: channel header (div) headlinesLogo: channel logo (div)
headlinesTitle: channel title (div)
headlinesDate: channel date (div)
headlinesDescription: channel description (div)
headlinesRight: channel copyright (div)
headlinesArticle: one news item (div) headlinesTitle: article title (div)
headlinesDate: article date (span)
headlinesCreator: author of article (span)
headlinesSubject: subect category of the article (span)
headlinesText: article text (div)
HeadlinesPlugin.zip in your twiki installation directory. Content: | File: | Description: |
|---|---|
data/TWiki/HeadlinesPlugin.txt | Plugin topic |
pub/TWiki/HeadlinesPlugin/style.css | Default CSS |
lib/TWiki/Plugins/HeadlinesPlugin.pm | Plugin Perl module |
lib/TWiki/HeadlinesPlugin/Core.pm | Plugin core |
| Name | Version | Description |
|---|---|---|
| Digest::MD5 | >=2.33 | Required. Download from CPAN:Digest::MD5 |
| LWP::UserAgent | >=5.803 | Optional. Download from CPAN:LWP::UserAgent |
| Plugin Author: | TWiki:Main.PeterThoeny, TWiki:Main.MichaelDaum |
| Copyright: | © 2002-2011 Peter Thoeny, Twiki, Inc. © 2005-2007 Michael Daum http://wikiring.de |
| License: | GPL (GNU General Public License) |
| Plugin Version: | 2011-07-17 |
| Change History: | |
| 2011-07-17: | TWikibug:Item6764: Add VarHEADLINES variable documentation; doc improvements; setting NO_PREFS_IN_TOPIC |
| 2011-07-08: | TWikibug:Item6725: Change global package variables from "use vars" to "our" |
| 2010-05-16: | TWikibug:Item6433: More doc improvements |
| 2010-04-25: | TWikibug:Item6433: Doc fix: Changing TWIKIWEB to SYSTEMWEB |
| 2010-02-27: | TWikibug:Item6313: Fixed bug in ATOM feed with <link ...></link> instead of <link ... /> -- Peter Thoeny |
| 2009-09-30: | fixed bug in lastBuildDate of feeds affecting touch parameter functionality -- Peter Thoeny |
| 2009-08-29: | added touch parameter -- Peter Thoeny |
| 12 Feb 2009: | {PROXY}{HOST} supports domain with and without protocol -- Peter Thoeny |
| 06 Feb 2009: | added {PROXY}{SkipProxyForDomains} configure setting, added USERAGENTNAME plugin setting -- Peter Thoeny |
| 11 Dec 2008: | added {PROXY}{HOST} and {PROXY}{PORT} configure settings -- Peter Thoeny |
| 13 Sep 2007: | fixed parsing of content:encoded |
| 23 Jul 2006: | improved atom parser; if a posting has no title default to 'Untitled' |
| 26 Apr 2006: | added lazy compilation |
| 10 Feb 2006: | packaged using the TWiki:Plugins/BuildContrib; minor fixes |
| 03 Feb 2006: | off-by-one: limit="n" returned n+1 articles; make FORMAT and HEADER format strings more robust |
| 23 Jan 2006: | released v2.00 |
| 05 Dec 2005: | internal feed urls must be absolute |
| 02 Dec 2005: | added web.topic shorthand for internal feeds |
| 29 Nov 2005: | fixed CDATA handling |
| 21 Nov 2005: | added ATOM support; extended RSS support; added dublin core support; added content support; optionally using LWP to fetch feeds to follow redirections; corrected CPAN dependencies ; recoding special chars from html integer to entity encoding to increase browser compatibility; added css support; use getWorkArea() if available |
| 11 May 2005: | TWiki:Main.WillNorris: added DevelopBranch compatability |
| 31 Oct 2004: | Fixed taint issue by TWiki:Main.AdrianWeiler; small performance improvement |
| 29 Oct 2004: | Fixed issue of external caching if mod_perl or SpeedyCGI is used |
| 02 Aug 2002: | Implemented caching of feeds, thanks to TWiki:Main/RobDuarte |
| 11 Jun 2002: | Initial version (V1.000) |
| Perl Version: | 5.8 |
| TWiki:Plugins/Benchmark: | GoodStyle 100%, FormattedSearch 99.5%, HeadlinesPlugin 94% |
| Plugin Home: | http://TWiki.org/cgi-bin/view/Plugins/HeadlinesPlugin |
| Feedback: | http://TWiki.org/cgi-bin/view/Plugins/HeadlinesPluginDev |
| Appraisal: | http://TWiki.org/cgi-bin/view/Plugins/HeadlinesPluginAppraisal |
| I | Attachment | Action | Size | Date | Who | Comment |
|---|---|---|---|---|---|---|
| |
HeadlinesPlugin.md5 | manage | 0.2 K | 2011-07-17 - 22:44 | PeterThoeny | |
| |
HeadlinesPlugin.tgz | manage | 14.3 K | 2011-07-17 - 22:44 | PeterThoeny | |
| |
HeadlinesPlugin.zip | manage | 18.5 K | 2011-07-17 - 22:44 | PeterThoeny | |
| |
HeadlinesPlugin_installer | manage | 3.6 K | 2011-07-17 - 22:44 | PeterThoeny |