Welcome | Register | Changes | Topics | Index | Search | Go

<<O>> Difference Topic HeadlinesPlugin (11 - 2018-07-14 - TWikiContributor)

Headlines Plugin

<--
   Contributions to this plugin are appreciated. Please update the plugin page at
   http://twiki.org/cgi-bin/view/Plugins/HeadlinesPlugin or provide feedback at
   http://twiki.org/cgi-bin/view/Plugins/HeadlinesPluginDev.
   If you are a TWiki contributor please update the plugin in the SVN repository.
-->

Page contents

Show headline news in TWiki pages based on RSS and ATOM news feeds from external sites

Description

This plugin displays RSS and ATOM feeds from news sites. Use it to build news portals that show headline news.

Notes:

RSS (Rich Site Summary) is an XML standard used to publish frequently updated works such as blog entries, news headlines and audio.
Atom is an XML syndication format used for web feeds.
Syndic8.com at http://www.syndic8.com/ lists many RSS and ATOM feeds.

Syntax Rules

%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
`filter="..."`	Filter out content from feed; for example to delete an encoded break tag specify `"<br>"`	`""`
`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
`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
`href="..."`	(Alternative to above)	N/A
`limit="12"`	Maximum number of items shown	Global `LIMIT` setting
`newline="$br"`	Convert newlines in feed; `"$br"` becomes `<br />` tag	`"$n"` (newline)
`refresh="60"`	Refresh rate in minutes for caching feed; `"0"` for no caching	Global `REFRESH` 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

The 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.

Rendering the `dc` namespace

The following variables are extracting the 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)

Rendering the `image` namespace

An 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)

Rendering the `content` namespace

The variable $content is referring to the <content:encoding> content </content:encoding>.

Examples

Slashdot News

Write

%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:

HeadlinesPlugin ERROR: 501 Protocol scheme 'https' is not supported (LWP::Protocol::https not installed)

Deleted:

<
<

Wired Enterprise Feed

Write

%HEADLINES{ "http://feeds.wired.com/wiredenterprise/" limit="3" }%

to get the latest postings on the Wired.com feed on enterprise:

HeadlinesPlugin ERROR: 501 Protocol scheme 'https' is not supported (LWP::Protocol::https not installed)

Plugin Settings

Plugin settings are stored as preferences settings. Do not change the settings here, they are here only for illustration purposes showing the default values. Define the settings in Main.TWikiPreferences. For example, to customize the HEADLINESPLUGIN_USERAGENTNAME setting, add a * Set HEADLINESPLUGIN_USERAGENTNAME = ... bullet in Main.TWikiPreferences.

Refresh rate in minutes for cached feeds. Set to 0 to disable caching:
- Set HEADLINESPLUGIN_REFRESH = 60

Maximum number of items shown:
- Set HEADLINESPLUGIN_LIMIT = 100

Use LWP::UserAgent if set to 1, or fallback to TWiki's internal getUrl() method if set to 0:
- Set HEADLINESPLUGIN_USELWPUSERAGENT = 1

Timeout fetching a feed using the LWP::UserAgent:
- Set HEADLINESPLUGIN_USERAGENTTIMEOUT = 20

Name of user agent:
- Set HEADLINESPLUGIN_USERAGENTNAME = TWikiHeadlinesPlugin/2011-07-08

Default header: (variables are explained in the syntax rules)

      * 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>

Default format of one item: (variables are explained in the syntax rules)

      * 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>

Added:

>
>

Allow HTML in header and format parameters of the HEADLINES variable. If set to 0, HTML is not allowed those in parameters. This is to guard against Cross-Site Scripting (XSS) attacks. The HEADLINESPLUGIN_HEADER and HEADLINESPLUGIN_FORMAT plugin settings allow HTML regardless of this setting.
- Set HEADLINESPLUGIN_ALLOWHTML = 0

Values taken from configure: (only supported if CPAN:LWP is installed)
- $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";

Style Sheets

The default HEADER and FORMAT settings use the following styles. See the style.css file defining the default CSS properties (indentation illustrates enclosure).

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)

Plugin Installation Instructions

This is a pre-installed plugin. TWiki administrators can upgrade the plugin as needed on the TWiki server.

Show details

Hide details

<--/twistyPlugin twikiMakeVisibleInline-->

Note: You do not need to install anything on the browser to use this plugin. The following instructions are for the administrator who installs the plugin on the TWiki server.

For an automated installation, run the configure script and follow "Find More Extensions" in the in the Extensions section.

Or, follow these manual installation steps:

Download the ZIP file from the Plugins home (see below).

Unzip 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

Set the ownership of the extracted directories and files to the webserver user.
Make sure the dependencies listed in the table below are resolved.
Name Version Description
Digest::MD5 >=2.33 Required. Download from CPAN:Digest::MD5
LWP::UserAgent >=5.803 Optional. Download from CPAN:LWP::UserAgent

Plugin configuration and testing:
- Run the configure script, enable the plugin in the Plugins section
- Configure the plugin: See plugin settings above.
- Test if the installation was successful: See example above.

<--/twistyPlugin-->

Plugin Info

One line description, shown in the TextFormattingRules topic:
- Set SHORTDESCRIPTION = Show headline news in TWiki pages based on RSS and ATOM news feeds from external sites

Plugin Author:

TWiki:Main.PeterThoeny

, TWiki:Main.MichaelDaum

Changed:

<
<

;
© 2002-2015 TWiki:TWiki.TWikiContributor

;
© 2005-2007 Michael Daum wikiring.de

>
>

;
© 2002-2018 TWiki:TWiki.TWikiContributor

;
© 2005-2007 Michael Daum wikiring.de

License:

GPL (GNU General Public License

)

Changed:

<
<

Plugin Version:

2015-11-06

>
>

Plugin Version:

2018-07-13

Show Change History

Hide Change History

<--/twistyPlugin twikiMakeVisibleInline-->

Added:

>
>

2018-07-13:	TWikibug:Item7846: Sanitize parameters; add HEADLINESPLUGIN_ALLOWHTML setting; sanitize malicious scripts in feed; remove non-functional Wired feed example
2018-07-05:	TWikibug:Item7841: Copyright update to 2018
2016-01-08:	TWikibug:Item7708: Copyright update to 2016

2015-11-06:	TWikibug:Item7697: New filter and newline parameters; fix Atom feed parser to support Google Alerts
2015-07-28:	TWikibug:Item7678: HeadlinesPlugin not working well on Fast CGI and mod_perl
2015-01-10:	TWikibug:Item7604: Switch from GPL v2 to v3
2013-11-18:	TWikibug:Item7385: Encode "[" and "]" to avoid problems with TWiki `[[...][...]]` links; code-refactor to use registerTagHandler and OO style.
2013-02-16:	TWikibug:Item7091: Use TWISTY in installation instructions section and change history
2013-01-29:	TWikibug:Item7131: HeadlinesPlugin doesn't match pattern in multiple lines.
2012-12-10:	TWikibug:Item7070: HeadlinesPlugin doesn't support multiple disks.
2012-11-13:	TWikibug:Item7016: Restore changes for earlier versions with LWP
2012-11-13:	TWikibug:Item7020: Categorize TWiki Variable
2012-10-31:	TWikibug:Item7016: Utilize <guid> value when it is available
2012-09-05:	TWikibug:Item6837: Doc fixes
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)

<--/twistyPlugin-->

Perl Version:	5.8
Plugin 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

<<O>> Difference Topic HeadlinesPlugin (10 - 2015-11-05 - TWikiContributor)

Headlines Plugin

<--
   Contributions to this plugin are appreciated. Please update the plugin page at
   http://twiki.org/cgi-bin/view/Plugins/HeadlinesPlugin or provide feedback at
   http://twiki.org/cgi-bin/view/Plugins/HeadlinesPluginDev.
   If you are a TWiki contributor please update the plugin in the SVN repository.
-->

Changed:

<
<

>
>

Added:

>
>

Page contents

Changed:

<
<

>
>

Added:

>
>

Show headline news in TWiki pages based on RSS and ATOM news feeds from external sites

Description

This plugin displays RSS and ATOM feeds from news sites. Use it to build news portals that show headline news.

Notes:

RSS (Rich Site Summary) is an XML standard used to publish frequently updated works such as blog entries, news headlines and audio.
Atom is an XML syndication format used for web feeds.
Syndic8.com at http://www.syndic8.com/ lists many RSS and ATOM feeds.

Syntax Rules

%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

Added:

>
>

`newline="$br"`	Convert newlines in feed; `"$br"` becomes `<br />` tag	`"$n"` (newline)
`filter="..."`	Filter out content from feed; for example to delete an encoded break tag specify `"<br>"`	`""`

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

Rendering the `dc` namespace

$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)

Rendering the `image` namespace

An 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)

Rendering the `content` namespace

The variable $content is referring to the <content:encoding> content </content:encoding>.

Examples

Slashdot News

Write

%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:

HeadlinesPlugin ERROR: 501 Protocol scheme 'https' is not supported (LWP::Protocol::https not installed)

Wired Enterprise Feed

Write

%HEADLINES{ "http://feeds.wired.com/wiredenterprise/" limit="3" }%

to get the latest postings on the Wired.com feed on enterprise:

HeadlinesPlugin ERROR: 501 Protocol scheme 'https' is not supported (LWP::Protocol::https not installed)

Plugin Settings

Refresh rate in minutes for cached feeds. Set to 0 to disable caching:
- Set HEADLINESPLUGIN_REFRESH = 60

Maximum number of items shown:
- Set HEADLINESPLUGIN_LIMIT = 100

Use LWP::UserAgent if set to 1, or fallback to TWiki's internal getUrl() method if set to 0:
- Set HEADLINESPLUGIN_USELWPUSERAGENT = 1

Timeout fetching a feed using the LWP::UserAgent:
- Set HEADLINESPLUGIN_USERAGENTTIMEOUT = 20

Name of user agent:
- Set HEADLINESPLUGIN_USERAGENTNAME = TWikiHeadlinesPlugin/2011-07-08

Default header: (variables are explained in the syntax rules)

      * 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>

Default format of one item: (variables are explained in the syntax rules)

      * 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>

Values taken from configure: (only supported if CPAN:LWP is installed)
- $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";

Style Sheets

The default HEADER and FORMAT settings use the following styles. See the style.css file defining the default CSS properties (indentation illustrates enclosure).

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)

Plugin Installation Instructions

This is a pre-installed plugin. TWiki administrators can upgrade the plugin as needed on the TWiki server.

Show details

Hide details

<--/twistyPlugin twikiMakeVisibleInline-->

Note: You do not need to install anything on the browser to use this plugin. The following instructions are for the administrator who installs the plugin on the TWiki server.

For an automated installation, run the configure script and follow "Find More Extensions" in the in the Extensions section.

Or, follow these manual installation steps:

Download the ZIP file from the Plugins home (see below).

Unzip 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

Set the ownership of the extracted directories and files to the webserver user.
Make sure the dependencies listed in the table below are resolved.
Name Version Description
Digest::MD5 >=2.33 Required. Download from CPAN:Digest::MD5
LWP::UserAgent >=5.803 Optional. Download from CPAN:LWP::UserAgent

Plugin configuration and testing:
- Run the configure script, enable the plugin in the Plugins section
- Configure the plugin: See plugin settings above.
- Test if the installation was successful: See example above.

<--/twistyPlugin-->

Plugin Info

One line description, shown in the TextFormattingRules topic:
- Set SHORTDESCRIPTION = Show headline news in TWiki pages based on RSS and ATOM news feeds from external sites

Plugin Author:

TWiki:Main.PeterThoeny

, TWiki:Main.MichaelDaum

Changed:

<
<

>
>

;
© 2002-2015 TWiki:TWiki.TWikiContributor

;
© 2005-2007 Michael Daum wikiring.de

License:

GPL (GNU General Public License

)

Changed:

<
<

Plugin Version:

2013-11-18

>
>

Plugin Version:

2015-11-06

Show Change History

Hide Change History

<--/twistyPlugin twikiMakeVisibleInline-->

Added:

>
>

2015-11-06:	TWikibug:Item7697: New filter and newline parameters; fix Atom feed parser to support Google Alerts
2015-07-28:	TWikibug:Item7678: HeadlinesPlugin not working well on Fast CGI and mod_perl
2015-01-10:	TWikibug:Item7604: Switch from GPL v2 to v3

2013-11-18:	TWikibug:Item7385: Encode "[" and "]" to avoid problems with TWiki `[[...][...]]` links; code-refactor to use registerTagHandler and OO style.
2013-02-16:	TWikibug:Item7091: Use TWISTY in installation instructions section and change history
2013-01-29:	TWikibug:Item7131: HeadlinesPlugin doesn't match pattern in multiple lines.
2012-12-10:	TWikibug:Item7070: HeadlinesPlugin doesn't support multiple disks.
2012-11-13:	TWikibug:Item7016: Restore changes for earlier versions with LWP
2012-11-13:	TWikibug:Item7020: Categorize TWiki Variable
2012-10-31:	TWikibug:Item7016: Utilize <guid> value when it is available
2012-09-05:	TWikibug:Item6837: Doc fixes
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)

<--/twistyPlugin-->

Perl Version:	5.8
Plugin 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

<<O>> Difference Topic HeadlinesPlugin (9 - 2013-11-19 - TWikiContributor)

Headlines Plugin

<--
   Contributions to this plugin are appreciated. Please update the plugin page at
   http://twiki.org/cgi-bin/view/Plugins/HeadlinesPlugin or provide feedback at
   http://twiki.org/cgi-bin/view/Plugins/HeadlinesPluginDev.
   If you are a TWiki contributor please update the plugin in the SVN repository.
-->

Page contents

Show headline news in TWiki pages based on RSS and ATOM news feeds from external sites

Description

This plugin displays RSS and ATOM feeds from news sites. Use it to build news portals that show headline news.

Notes:

RSS (Rich Site Summary) is an XML standard used to publish frequently updated works such as blog entries, news headlines and audio.
Atom is an XML syndication format used for web feeds.
Syndic8.com at http://www.syndic8.com/ lists many RSS and ATOM feeds.

Syntax Rules

%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

Rendering the `dc` namespace

$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)

Rendering the `image` namespace

An 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)

Rendering the `content` namespace

The variable $content is referring to the <content:encoding> content </content:encoding>.

Examples

Slashdot News

Write

%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:

HeadlinesPlugin ERROR: 501 Protocol scheme 'https' is not supported (LWP::Protocol::https not installed)

Changed:

<
<

Business Opportunities Weblog

>
>

Wired Enterprise Feed

Write

Changed:

<
< HeadlinesPlugin ERROR: 501 Protocol scheme 'https' is not supported (LWP::Protocol::https not installed)

>
> HeadlinesPlugin ERROR: 501 Protocol scheme 'https' is not supported (LWP::Protocol::https not installed)

Changed:

<
< to get the latest postings on the "Business Opportunities" weblog:

>
> to get the latest postings on the Wired.com feed on enterprise:

Changed:

<
< HeadlinesPlugin ERROR: 501 Protocol scheme 'https' is not supported (LWP::Protocol::https not installed)

>
> HeadlinesPlugin ERROR: 501 Protocol scheme 'https' is not supported (LWP::Protocol::https not installed)

Plugin Settings

Refresh rate in minutes for cached feeds. Set to 0 to disable caching:
- Set HEADLINESPLUGIN_REFRESH = 60

Maximum number of items shown:
- Set HEADLINESPLUGIN_LIMIT = 100

Use LWP::UserAgent if set to 1, or fallback to TWiki's internal getUrl() method if set to 0:
- Set HEADLINESPLUGIN_USELWPUSERAGENT = 1

Timeout fetching a feed using the LWP::UserAgent:
- Set HEADLINESPLUGIN_USERAGENTTIMEOUT = 20

Name of user agent:
- Set HEADLINESPLUGIN_USERAGENTNAME = TWikiHeadlinesPlugin/2011-07-08

Default header: (variables are explained in the syntax rules)

      * 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>

Default format of one item: (variables are explained in the syntax rules)

      * 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>

Values taken from configure: (only supported if CPAN:LWP is installed)
- $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";

Style Sheets

The default HEADER and FORMAT settings use the following styles. See the style.css file defining the default CSS properties (indentation illustrates enclosure).

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)

Plugin Installation Instructions

This is a pre-installed plugin. TWiki administrators can upgrade the plugin as needed on the TWiki server.

Show details

Hide details

<--/twistyPlugin twikiMakeVisibleInline-->

Note: You do not need to install anything on the browser to use this plugin. The following instructions are for the administrator who installs the plugin on the TWiki server.

For an automated installation, run the configure script and follow "Find More Extensions" in the in the Extensions section.

Or, follow these manual installation steps:

Download the ZIP file from the Plugins home (see below).

Unzip 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

Set the ownership of the extracted directories and files to the webserver user.
Make sure the dependencies listed in the table below are resolved.
Name Version Description
Digest::MD5 >=2.33 Required. Download from CPAN:Digest::MD5
LWP::UserAgent >=5.803 Optional. Download from CPAN:LWP::UserAgent

Plugin configuration and testing:
- Run the configure script, enable the plugin in the Plugins section
- Configure the plugin: See plugin settings above.
- Test if the installation was successful: See example above.

<--/twistyPlugin-->

Plugin Info

One line description, shown in the TextFormattingRules topic:
- Set SHORTDESCRIPTION = Show headline news in TWiki pages based on RSS and ATOM news feeds from external sites

Plugin Author:	TWiki:Main.PeterThoeny, TWiki:Main.MichaelDaum
Copyright:	© 2002-2013 Peter Thoeny, TWiki.org © 2005-2007 Michael Daum wikiring.de
License:	GPL (GNU General Public License)

Changed:

<
<

Plugin Version:

2013-02-16

>
>

Plugin Version:

2013-11-18

Show Change History

Hide Change History

<--/twistyPlugin twikiMakeVisibleInline-->

Added:

>
>

2013-11-18: TWikibug:Item7385: Encode "[" and "]" to avoid problems with TWiki [[...][...]] links; code-refactor to use registerTagHandler and OO style.

2013-02-16:	TWikibug:Item7091: Use TWISTY in installation instructions section and change history
2013-01-29:	TWikibug:Item7131: HeadlinesPlugin doesn't match pattern in multiple lines.
2012-12-10:	TWikibug:Item7070: HeadlinesPlugin doesn't support multiple disks.
2012-11-13:	TWikibug:Item7016: Restore changes for earlier versions with LWP
2012-11-13:	TWikibug:Item7020: Categorize TWiki Variable
2012-10-31:	TWikibug:Item7016: Utilize <guid> value when it is available
2012-09-05:	TWikibug:Item6837: Doc fixes
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)

<--/twistyPlugin-->

Perl Version:	5.8
Plugin 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

<<O>> Difference Topic HeadlinesPlugin (8 - 2013-02-16 - TWikiContributor)

Headlines Plugin

<--
   Contributions to this plugin are appreciated. Please update the plugin page at
   http://twiki.org/cgi-bin/view/Plugins/HeadlinesPlugin or provide feedback at
   http://twiki.org/cgi-bin/view/Plugins/HeadlinesPluginDev.
   If you are a TWiki contributor please update the plugin in the SVN repository.
-->

Page contents

Show headline news in TWiki pages based on RSS and ATOM news feeds from external sites

Description

This plugin displays RSS and ATOM feeds from news sites. Use it to build news portals that show headline news.

Notes:

RSS (Rich Site Summary) is an XML standard used to publish frequently updated works such as blog entries, news headlines and audio.
Atom is an XML syndication format used for web feeds.
Syndic8.com at http://www.syndic8.com/ lists many RSS and ATOM feeds.

Syntax Rules

%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

Rendering the `dc` namespace

$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)

Rendering the `image` namespace

An 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)

Rendering the `content` namespace

The variable $content is referring to the <content:encoding> content </content:encoding>.

Examples

Slashdot News

Write

%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:

HeadlinesPlugin ERROR: 501 Protocol scheme 'https' is not supported (LWP::Protocol::https not installed)

Business Opportunities Weblog

Write

%HEADLINES{ "http://www.business-opportunities.biz/feed" limit="2" }%

to get the latest postings on the "Business Opportunities" weblog:

HeadlinesPlugin ERROR: 501 Protocol scheme 'https' is not supported (LWP::Protocol::https not installed)

Plugin Settings

Refresh rate in minutes for cached feeds. Set to 0 to disable caching:
- Set HEADLINESPLUGIN_REFRESH = 60

Maximum number of items shown:
- Set HEADLINESPLUGIN_LIMIT = 100

Use LWP::UserAgent if set to 1, or fallback to TWiki's internal getUrl() method if set to 0:
- Set HEADLINESPLUGIN_USELWPUSERAGENT = 1

Timeout fetching a feed using the LWP::UserAgent:
- Set HEADLINESPLUGIN_USERAGENTTIMEOUT = 20

Name of user agent:
- Set HEADLINESPLUGIN_USERAGENTNAME = TWikiHeadlinesPlugin/2011-07-08

Default header: (variables are explained in the syntax rules)

      * 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>

Default format of one item: (variables are explained in the syntax rules)

      * 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>

Values taken from configure: (only supported if CPAN:LWP is installed)
- $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";

Style Sheets

The default HEADER and FORMAT settings use the following styles. See the style.css file defining the default CSS properties (indentation illustrates enclosure).

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)

Plugin Installation Instructions

Added:

>
>

This is a pre-installed plugin. TWiki administrators can upgrade the plugin as needed on the TWiki server.

Show details

Hide details

<--/twistyPlugin twikiMakeVisibleInline-->

Note: You do not need to install anything on the browser to use this plugin. The following instructions are for the administrator who installs the plugin on the TWiki server.

For an automated installation, run the configure script and follow "Find More Extensions" in the in the Extensions section.

Or, follow these manual installation steps:

Download the ZIP file from the Plugins home (see below).

Unzip 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

Set the ownership of the extracted directories and files to the webserver user.
Make sure the dependencies listed in the table below are resolved.
Name Version Description
Digest::MD5 >=2.33 Required. Download from CPAN:Digest::MD5
LWP::UserAgent >=5.803 Optional. Download from CPAN:LWP::UserAgent

Plugin configuration and testing:
- Run the configure script, enable the plugin in the Plugins section
- Configure the plugin: See plugin settings above.
- Test if the installation was successful: See example above.

Added:

>
>

<--/twistyPlugin-->

Plugin Info

One line description, shown in the TextFormattingRules topic:
- Set SHORTDESCRIPTION = Show headline news in TWiki pages based on RSS and ATOM news feeds from external sites

Added:

>
>

Plugin Author:

TWiki:Main.PeterThoeny

, TWiki:Main.MichaelDaum

Changed:

<
<

>
>

License:

GPL (GNU General Public License

)

Changed:

<
<

Plugin Version:	2012-11-13
Change History:	<-- specify latest version first -->

>
>

Plugin Version:

2013-02-16

%TWISTY{

Added:

>
>

mode="div" showlink="Show Change History http://tait.tcyrus.com/pub/TWiki/TWikiDocGraphics/toggleopen.gif" hidelink="Hide Change History

" }%

2013-02-16:	TWikibug:Item7091: Use TWISTY in installation instructions section and change history
2013-01-29:	TWikibug:Item7131: HeadlinesPlugin doesn't match pattern in multiple lines.
2012-12-10:	TWikibug:Item7070: HeadlinesPlugin doesn't support multiple disks.

2012-11-13:	TWikibug:Item7016: Restore changes for earlier versions with LWP
2012-11-13:	TWikibug:Item7020: Categorize TWiki Variable
2012-10-31:	TWikibug:Item7016: Utilize <guid> value when it is available
2012-09-05:	TWikibug:Item6837: Doc fixes
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)

Added:

>
>

</>

<--/twistyPlugin-->

Perl Version:

5.8

Changed:

<
<

TWiki:Plugins/Benchmark

GoodStyle 100%, FormattedSearch 99.5%, HeadlinesPlugin 94%

>
>

Plugin 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

<<O>> Difference Topic HeadlinesPlugin (7 - 2012-11-13 - TWikiContributor)

Headlines Plugin

<--
   Contributions to this plugin are appreciated. Please update the plugin page at
   http://twiki.org/cgi-bin/view/Plugins/HeadlinesPlugin or provide feedback at
   http://twiki.org/cgi-bin/view/Plugins/HeadlinesPluginDev.
   If you are a TWiki contributor please update the plugin in the SVN repository.
-->

Page contents

Show headline news in TWiki pages based on RSS and ATOM news feeds from external sites

Description

This plugin displays RSS and ATOM feeds from news sites. Use it to build news portals that show headline news.

Notes:

RSS (Rich Site Summary) is an XML standard used to publish frequently updated works such as blog entries, news headlines and audio.
Atom is an XML syndication format used for web feeds.
Syndic8.com at http://www.syndic8.com/ lists many RSS and ATOM feeds.

Syntax Rules

%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

Rendering the `dc` namespace

$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)

Rendering the `image` namespace

An 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)

Rendering the `content` namespace

The variable $content is referring to the <content:encoding> content </content:encoding>.

Examples

Slashdot News

Write

%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:

HeadlinesPlugin ERROR: 501 Protocol scheme 'https' is not supported (LWP::Protocol::https not installed)

Business Opportunities Weblog

Write

%HEADLINES{ "http://www.business-opportunities.biz/feed" limit="2" }%

to get the latest postings on the "Business Opportunities" weblog:

HeadlinesPlugin ERROR: 501 Protocol scheme 'https' is not supported (LWP::Protocol::https not installed)

Plugin Settings

Refresh rate in minutes for cached feeds. Set to 0 to disable caching:
- Set HEADLINESPLUGIN_REFRESH = 60

Maximum number of items shown:
- Set HEADLINESPLUGIN_LIMIT = 100

Use LWP::UserAgent if set to 1, or fallback to TWiki's internal getUrl() method if set to 0:
- Set HEADLINESPLUGIN_USELWPUSERAGENT = 1

Timeout fetching a feed using the LWP::UserAgent:
- Set HEADLINESPLUGIN_USERAGENTTIMEOUT = 20

Name of user agent:
- Set HEADLINESPLUGIN_USERAGENTNAME = TWikiHeadlinesPlugin/2011-07-08

Default header: (variables are explained in the syntax rules)

      * 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>

Default format of one item: (variables are explained in the syntax rules)

      * 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>

Values taken from configure: (only supported if CPAN:LWP is installed)
- $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";

Style Sheets

The default HEADER and FORMAT settings use the following styles. See the style.css file defining the default CSS properties (indentation illustrates enclosure).

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)

Plugin Installation Instructions

Note: You do not need to install anything on the browser to use this plugin. The following instructions are for the administrator who installs the plugin on the TWiki server.

For an automated installation, run the configure script and follow "Find More Extensions" in the in the Extensions section.

Or, follow these manual installation steps:

Download the ZIP file from the Plugins home (see below).

Unzip 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

Set the ownership of the extracted directories and files to the webserver user.
Make sure the dependencies listed in the table below are resolved.
Name Version Description
Digest::MD5 >=2.33 Required. Download from CPAN:Digest::MD5
LWP::UserAgent >=5.803 Optional. Download from CPAN:LWP::UserAgent

Plugin configuration and testing:
- Run the configure script, enable the plugin in the Plugins section
- Configure the plugin: See plugin settings above.
- Test if the installation was successful: See example above.

Plugin Info

One line description, shown in the TextFormattingRules topic:
- Set SHORTDESCRIPTION = Show headline news in TWiki pages based on RSS and ATOM news feeds from external sites

Plugin Author:	TWiki:Main.PeterThoeny, TWiki:Main.MichaelDaum
Copyright:	© 2002-2012 Peter Thoeny, TWiki.org © 2005-2007 Michael Daum http://wikiring.de
License:	GPL (GNU General Public License)

Changed:

<
<

Plugin Version:

2012-09-05

>
>

Plugin Version:

2012-11-13

Change History:

<-- specify latest version first -->

Added:

>
>

2012-11-13:	TWikibug:Item7016: Restore changes for earlier versions with LWP
2012-11-13:	TWikibug:Item7020: Categorize TWiki Variable
2012-10-31:	TWikibug:Item7016: Utilize <guid> value when it is available

2012-09-05:	TWikibug:Item6837: Doc fixes
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

<<O>> Difference Topic HeadlinesPlugin (6 - 2012-09-05 - TWikiContributor)

Headlines Plugin

<--
   Contributions to this plugin are appreciated. Please update the plugin page at
   http://twiki.org/cgi-bin/view/Plugins/HeadlinesPlugin or provide feedback at
   http://twiki.org/cgi-bin/view/Plugins/HeadlinesPluginDev.
   If you are a TWiki contributor please update the plugin in the SVN repository.
-->

Page contents

Show headline news in TWiki pages based on RSS and ATOM news feeds from external sites

Description

This plugin displays RSS and ATOM feeds from news sites. Use it to build news portals that show headline news.

Changed:

<
< Note: Syndic8.com ( http://www.syndic8.com/ ) lists many RSS and ATOM feeds.

>
> Notes:

Added:

>
>

RSS (Rich Site Summary) is an XML standard used to publish frequently updated works such as blog entries, news headlines and audio.
Atom is an XML syndication format used for web feeds.
Syndic8.com at http://www.syndic8.com/ lists many RSS and ATOM feeds.

Syntax Rules

%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

Rendering the `dc` namespace

$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)

Rendering the `image` namespace

An 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)

Rendering the `content` namespace

The variable $content is referring to the <content:encoding> content </content:encoding>.

Examples

Slashdot News

Write

%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:

HeadlinesPlugin ERROR: 501 Protocol scheme 'https' is not supported (LWP::Protocol::https not installed)

Business Opportunities Weblog

Write

%HEADLINES{ "http://www.business-opportunities.biz/feed" limit="2" }%

to get the latest postings on the "Business Opportunities" weblog:

HeadlinesPlugin ERROR: 501 Protocol scheme 'https' is not supported (LWP::Protocol::https not installed)

Plugin Settings

Refresh rate in minutes for cached feeds. Set to 0 to disable caching:
- Set HEADLINESPLUGIN_REFRESH = 60

Maximum number of items shown:
- Set HEADLINESPLUGIN_LIMIT = 100

Use LWP::UserAgent if set to 1, or fallback to TWiki's internal getUrl() method if set to 0:
- Set HEADLINESPLUGIN_USELWPUSERAGENT = 1

Timeout fetching a feed using the LWP::UserAgent:
- Set HEADLINESPLUGIN_USERAGENTTIMEOUT = 20

Name of user agent:
- Set HEADLINESPLUGIN_USERAGENTNAME = TWikiHeadlinesPlugin/2011-07-08

Default header: (variables are explained in the syntax rules)

      * 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>

Default format of one item: (variables are explained in the syntax rules)

      * 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>

Values taken from configure: (only supported if CPAN:LWP is installed)
- $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";

Style Sheets

The default HEADER and FORMAT settings use the following styles. See the style.css file defining the default CSS properties (indentation illustrates enclosure).

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)

Plugin Installation Instructions

Note: You do not need to install anything on the browser to use this plugin. The following instructions are for the administrator who installs the plugin on the TWiki server.

For an automated installation, run the configure script and follow "Find More Extensions" in the in the Extensions section.

Or, follow these manual installation steps:

Download the ZIP file from the Plugins home (see below).

Unzip 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

Set the ownership of the extracted directories and files to the webserver user.
Make sure the dependencies listed in the table below are resolved.
Name Version Description
Digest::MD5 >=2.33 Required. Download from CPAN:Digest::MD5
LWP::UserAgent >=5.803 Optional. Download from CPAN:LWP::UserAgent

Plugin configuration and testing:
- Run the configure script, enable the plugin in the Plugins section
- Configure the plugin: See plugin settings above.
- Test if the installation was successful: See example above.

Plugin Info

One line description, shown in the TextFormattingRules topic:
- Set SHORTDESCRIPTION = Show headline news in TWiki pages based on RSS and ATOM news feeds from external sites

Plugin Author:

TWiki:Main.PeterThoeny

, TWiki:Main.MichaelDaum

Changed:

<
<

>
>

License:

GPL (GNU General Public License

)

Changed:

<
<

Plugin Version:

2011-07-17

>
>

Plugin Version:

2012-09-05

Change History:

<-- specify latest version first -->

Added:

>
>

2012-09-05:

TWikibug:Item6837

: Doc fixes

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

<<O>> Difference Topic HeadlinesPlugin (5 - 2011-07-17 - TWikiContributor)

Headlines Plugin

<--
   Contributions to this plugin are appreciated. Please update the plugin page at
   http://twiki.org/cgi-bin/view/Plugins/HeadlinesPlugin or provide feedback at
   http://twiki.org/cgi-bin/view/Plugins/HeadlinesPluginDev.
   If you are a TWiki contributor please update the plugin in the SVN repository.
-->

Changed:

<
<

Page contents

>
>

Page contents

Show headline news in TWiki pages based on RSS and ATOM news feeds from external sites

Description

This plugin displays RSS and ATOM feeds from news sites. Use it to build news portals that show headline news.

Changed:

<
< Note: Syndic8.com ( http://www.syndic8.com/ ) lists many RSS feeds.

>
> Note: Syndic8.com ( http://www.syndic8.com/ ) lists many RSS and ATOM feeds.

Added:

>
>

Syntax Rules

%HEADLINES{"..."}%

Parameter	Explanation	Default

Changed:

<
< | "..." | source of RSS feed; this can be an url (starting with http)

>
>

"..." 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

Deleted:

<
< 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

Changed:

<
<

| header | Header. Can 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)

>
> | 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)

Deleted:

<
< - $imagedescription: description of image (image.description)

Global HEADER setting

Changed:

<
< | format | Format of one item. Can 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)

>
> | 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

Added:

>
>

Rendering the `dc` namespace

Changed:

<
<

The following variables are extracting the dc namespace info, that could be used in header and format. Nnote, that some of the variables are already used above. This is done by purpose to use different feeds with the same formating parameters. If there's a conflict the non-dc tags have higher precedence, i.e. a <title> content </title> is prefered 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

>
>

$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)

Changed:

<
<

$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)

>
>

$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)

Rendering the `image` namespace

An 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)

Rendering the `content` namespace

Changed:

<
< The variable $content is refering to the <content:encoding> content </content:encoding>.

>
> The variable $content is referring to the <content:encoding> content </content:encoding>.

Examples

Slashdot News

Write

%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:

HeadlinesPlugin ERROR: 501 Protocol scheme 'https' is not supported (LWP::Protocol::https not installed)

Business Opportunities Weblog

Write

%HEADLINES{ "http://www.business-opportunities.biz/feed" limit="2" }%

to get the latest postings on the "Business Opportunities" weblog:

HeadlinesPlugin ERROR: 501 Protocol scheme 'https' is not supported (LWP::Protocol::https not installed)

Plugin Settings

Changed:

<
< Plugin settings are stored as preferences variables. To reference a plugin setting write %<plugin>_<setting>%, for example, %HEADLINESPLUGIN_SHORTDESCRIPTION%. Note: Don't modify the settings here; copy and customize the settings in Main.TWikiPreferences. For example, to customize the USERAGENTNAME setting, create a HEADLINESPLUGIN_USERAGENTNAME setting in Main.TWikiPreferences.

>
> Plugin settings are stored as preferences settings. Do not change the settings here, they are here only for illustration purposes showing the default values. Define the settings in Main.TWikiPreferences. For example, to customize the HEADLINESPLUGIN_USERAGENTNAME setting, add a * Set HEADLINESPLUGIN_USERAGENTNAME = ... bullet in Main.TWikiPreferences.

Changed:

<
<

One line description, shown in the TextFormattingRules topic:
- Set SHORTDESCRIPTION = Show headline news in TWiki pages based on RSS and ATOM news feeds from external sites

>
>

Refresh rate in minutes for cached feeds. Set to 0 to disable caching:
- Set HEADLINESPLUGIN_REFRESH = 60

Changed:

<
<

Refresh rate in minutes for cached feeds. Disable caching: 0, default: 60
- Set REFRESH = 60

>
>

Maximum number of items shown:
- Set HEADLINESPLUGIN_LIMIT = 100

Changed:

<
<

Maximum number of items shown. Default: 100
- Set LIMIT = 100

>
>

Use LWP::UserAgent if set to 1, or fallback to TWiki's internal getUrl() method if set to 0:
- Set HEADLINESPLUGIN_USELWPUSERAGENT = 1

Changed:

<
<

Use LWP::UserAgent, or fallback to TWiki's internal getUrl() method. Default: yes
- Set USELWPUSERAGENT = yes

>
>

Timeout fetching a feed using the LWP::UserAgent:
- Set HEADLINESPLUGIN_USERAGENTTIMEOUT = 20

Changed:

<
<

Timeout fetching a feed using the LWP::UserAgent. Default: 20
- Set USERAGENTTIMEOUT = 20

>
>

Name of user agent:

Added:

>
>

- Set HEADLINESPLUGIN_USERAGENTNAME = TWikiHeadlinesPlugin/2011-07-08

Deleted:

<
<

Name of user agent. Default: TWikiHeadlinesPlugin/2.21

      * Set USERAGENTNAME = TWikiHeadlinesPlugin/2.21

Default header: (variables are explained in the syntax rules)

Changed:

<
<

- Set HEADER =
  
  $n---+!! $title
  $date
  $description
  $rights

>
>

- Set HEADLINESPLUGIN_HEADER =
  
  $n---+!! $title
  $date
  $description
  $rights

Default format of one item: (variables are explained in the syntax rules)

Changed:

<
<

- Set FORMAT =
  $title
  $n$date $creator $subject $n
  $description

>
>

- Set HEADLINESPLUGIN_FORMAT =
  $title
  $n$date $creator $subject $n
  $description

Values taken from configure: (only supported if CPAN:LWP is installed)
- $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";

Style Sheets

The default HEADER and FORMAT settings use the following styles. See the style.css file defining the default CSS properties (indentation illustrates enclosure).

Changed:

<
<

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)

>
>

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)

Plugin Installation Instructions

Changed:

<
<

Download the ZIP file.

>
> Note: You do not need to install anything on the browser to use this plugin. The following instructions are for the administrator who installs the plugin on the TWiki server.

Deleted:

<
<

Unzip it in your twiki installation directory. Content:

File:	Description:
`data/TWiki/HeadlinesPlugin.txt`	plugin topic
`pub/TWiki/HeadlinesPlugin/style.css`	default css
`lib/TWiki/HeadlinesPlugin.pm`	plugin perl module
`lib/TWiki/HeadlinesPlugin/Core.pm`	plugin core

Check if above examples show a news feed instead of variable.

Optionally, run HeadlinesPlugin_installer.pl to automatically check and install other TWiki modules that this module depends on. You can also do this step manually.
Alternatively, manually make sure the dependencies listed in the table below are resolved.
Name Version Description
Digest::MD5 >=2.33 Required. Download from CPAN:Digest::MD5
LWP::UserAgent >=5.803 Optional. Download from CPAN:LWP::UserAgent

Added:

>
>

For an automated installation, run the configure script and follow "Find More Extensions" in the in the Extensions section.

Or, follow these manual installation steps:

Download the ZIP file from the Plugins home (see below).

Unzip 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

Set the ownership of the extracted directories and files to the webserver user.
Make sure the dependencies listed in the table below are resolved.
Name Version Description
Digest::MD5 >=2.33 Required. Download from CPAN:Digest::MD5
LWP::UserAgent >=5.803 Optional. Download from CPAN:LWP::UserAgent

Plugin configuration and testing:
- Run the configure script, enable the plugin in the Plugins section
- Configure the plugin: See plugin settings above.
- Test if the installation was successful: See example above.

Plugin Info

Added:

>
>

One line description, shown in the TextFormattingRules topic:
- Set SHORTDESCRIPTION = Show headline news in TWiki pages based on RSS and ATOM news feeds from external sites

Plugin Author:

TWiki:Main.PeterThoeny

, TWiki:Main.MichaelDaum

Changed:

<
<

; 2005-2007, Michael Daum http://wikiring.de

>
>

License:

GPL (GNU General Public License

)

Changed:

<
<

Plugin Version:

v2.6 - 2010-05-16

>
>

Plugin Version:

2011-07-17

Change History:

<-- specify latest version first -->

Changed:

<
<

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

>
>

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

Added:

>
>

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

Changed:

<
< Related Topics: TWikiPlugins, AdminDocumentationCategory, TWikiPreferences

>
> Related Topics: VarHEADLINES, TWikiPlugins, AdminDocumentationCategory, TWikiPreferences

<<O>> Difference Topic HeadlinesPlugin (4 - 2010-12-31 - TWikiContributor)

Headlines Plugin

<--
   Contributions to this plugin are appreciated. Please update the plugin page at
   http://twiki.org/cgi-bin/view/Plugins/HeadlinesPlugin or provide feedback at
   http://twiki.org/cgi-bin/view/Plugins/HeadlinesPluginDev.
   If you are a TWiki contributor please update the plugin in the SVN repository.
-->

Changed:

<
<

On this page:

>
>

Page contents

Show headline news in TWiki pages based on RSS and ATOM news feeds from external sites

Description

This plugin displays RSS and ATOM feeds from news sites. Use it to build news portals that show headline news.

Note: Syndic8.com ( http://www.syndic8.com/ ) lists many RSS feeds.

Syntax Rules

%HEADLINES{"..."}%

Parameter	Explanation	Default
`"..."`	source of RSS 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
`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`	Header. Can 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. Can 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

Rendering the `dc` namespace

$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)

Rendering the `image` namespace

An 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)

Rendering the `content` namespace

The variable $content is refering to the <content:encoding> content </content:encoding>.

Examples

Slashdot News

Write

%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:

HeadlinesPlugin ERROR: 501 Protocol scheme 'https' is not supported (LWP::Protocol::https not installed)

Business Opportunities Weblog

Write

%HEADLINES{ "http://www.business-opportunities.biz/feed" limit="2" }%

to get the latest postings on the "Business Opportunities" weblog:

HeadlinesPlugin ERROR: 501 Protocol scheme 'https' is not supported (LWP::Protocol::https not installed)

Plugin Settings

Plugin settings are stored as preferences variables. To reference a plugin setting write %<plugin>_<setting>%, for example, %HEADLINESPLUGIN_SHORTDESCRIPTION%. Note: Don't modify the settings here; copy and customize the settings in Main.TWikiPreferences. For example, to customize the USERAGENTNAME setting, create a HEADLINESPLUGIN_USERAGENTNAME setting in Main.TWikiPreferences.

One line description, shown in the TextFormattingRules topic:
- Set SHORTDESCRIPTION = Show headline news in TWiki pages based on RSS and ATOM news feeds from external sites

Refresh rate in minutes for cached feeds. Disable caching: 0, default: 60
- Set REFRESH = 60

Maximum number of items shown. Default: 100
- Set LIMIT = 100

Use LWP::UserAgent, or fallback to TWiki's internal getUrl() method. Default: yes
- Set USELWPUSERAGENT = yes

Timeout fetching a feed using the LWP::UserAgent. Default: 20
- Set USERAGENTTIMEOUT = 20

Name of user agent. Default: TWikiHeadlinesPlugin/2.21

      * Set USERAGENTNAME = TWikiHeadlinesPlugin/2.21

Default header: (variables are explained in the syntax rules)

      * Set 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>

Default format of one item: (variables are explained in the syntax rules)

      * Set 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>

Values taken from configure: (only supported if CPAN:LWP is installed)
- $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";

Style Sheets

The default HEADER and FORMAT settings use the following styles. See the style.css file defining the default CSS properties (indentation illustrates enclosure).

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)

Plugin Installation Instructions

Download the ZIP file.

Unzip it in your twiki installation directory. Content:

File:	Description:
`data/TWiki/HeadlinesPlugin.txt`	plugin topic
`pub/TWiki/HeadlinesPlugin/style.css`	default css
`lib/TWiki/HeadlinesPlugin.pm`	plugin perl module
`lib/TWiki/HeadlinesPlugin/Core.pm`	plugin core

Check if above examples show a news feed instead of variable.

Optionally, run HeadlinesPlugin_installer.pl to automatically check and install other TWiki modules that this module depends on. You can also do this step manually.
Alternatively, manually make sure the dependencies listed in the table below are resolved.
Name Version Description
Digest::MD5 >=2.33 Required. Download from CPAN:Digest::MD5
LWP::UserAgent >=5.803 Optional. Download from CPAN:LWP::UserAgent

Plugin Info

Plugin Author:	TWiki:Main.PeterThoeny, TWiki:Main.MichaelDaum
Copyright:	© 2002-2010, Peter Thoeny, Twiki, Inc.; 2005-2007, Michael Daum http://wikiring.de
License:	GPL (GNU General Public License)
Plugin Version:	v2.6 - 2010-05-16
Change History:	<-- specify latest version first -->
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

Related Topics: TWikiPlugins, AdminDocumentationCategory, TWikiPreferences

<<O>> Difference Topic HeadlinesPlugin (3 - 2010-05-17 - TWikiContributor)

Headlines Plugin

Added:

>
>

On this page:

Added:

>
> Show headline news in TWiki pages based on RSS and ATOM news feeds from external sites

Description

This plugin displays RSS and ATOM feeds from news sites. Use it to build news portals that show headline news.

Note: Syndic8.com ( http://www.syndic8.com/ ) lists many RSS feeds.

Syntax Rules

%HEADLINES{"..."}%

Parameter	Explanation	Default
`"..."`	source of RSS 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
`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`	Header. Can 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. Can 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

Rendering the `dc` namespace

$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)

Rendering the `image` namespace

An 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)

Rendering the `content` namespace

The variable $content is refering to the <content:encoding> content </content:encoding>.

Examples

Slashdot News

Write

%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:

HeadlinesPlugin ERROR: 501 Protocol scheme 'https' is not supported (LWP::Protocol::https not installed)

Business Opportunities Weblog

Write

%HEADLINES{ "http://www.business-opportunities.biz/feed" limit="2" }%

to get the latest postings on the "Business Opportunities" weblog:

HeadlinesPlugin ERROR: 501 Protocol scheme 'https' is not supported (LWP::Protocol::https not installed)

Plugin Settings

One line description, shown in the TextFormattingRules topic:
- Set SHORTDESCRIPTION = Show headline news in TWiki pages based on RSS and ATOM news feeds from external sites

Refresh rate in minutes for cached feeds. Disable caching: 0, default: 60
- Set REFRESH = 60

Maximum number of items shown. Default: 100
- Set LIMIT = 100

Use LWP::UserAgent, or fallback to TWiki's internal getUrl() method. Default: yes
- Set USELWPUSERAGENT = yes

Timeout fetching a feed using the LWP::UserAgent. Default: 20
- Set USERAGENTTIMEOUT = 20

Name of user agent. Default: TWikiHeadlinesPlugin/2.21

      * Set USERAGENTNAME = TWikiHeadlinesPlugin/2.21

Default header: (variables are explained in the syntax rules)

      * Set 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>

Default format of one item: (variables are explained in the syntax rules)

      * Set 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>

Values taken from configure: (only supported if CPAN:LWP is installed)
- $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";

Style Sheets

The default HEADER and FORMAT settings use the following styles. See the style.css file defining the default CSS properties (indentation illustrates enclosure).

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)

Plugin Installation Instructions

Download the ZIP file.

Unzip it in your twiki installation directory. Content:

File:	Description:
`data/TWiki/HeadlinesPlugin.txt`	plugin topic
`pub/TWiki/HeadlinesPlugin/style.css`	default css
`lib/TWiki/HeadlinesPlugin.pm`	plugin perl module
`lib/TWiki/HeadlinesPlugin/Core.pm`	plugin core

Check if above examples show a news feed instead of variable.

Optionally, run HeadlinesPlugin_installer.pl to automatically check and install other TWiki modules that this module depends on. You can also do this step manually.
Alternatively, manually make sure the dependencies listed in the table below are resolved.
Name Version Description
Digest::MD5 >=2.33 Required. Download from CPAN:Digest::MD5
LWP::UserAgent >=5.803 Optional. Download from CPAN:LWP::UserAgent

Plugin Info

Plugin Author:

TWiki:Main.PeterThoeny

, TWiki:Main.MichaelDaum

Changed:

<
<

; 2005-2007, Michael Daum http://wikiring.de

>
>

; 2005-2007, Michael Daum http://wikiring.de

License:

GPL (GNU General Public License

)

Changed:

<
<

Plugin Version:

v2.3 - 29 Aug 2009

>
>

Plugin Version:

v2.6 - 2010-05-16

Change History:

<-- specify latest version first -->

Changed:

<
<

29 Aug 2009:

added touch parameter -- Peter Thoeny

>
>

2010-05-16:

TWikibug:Item6433

- more doc improvements

Added:

>
>

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

Changed:

<
<

TWiki:Plugins/Benchmark:	GoodStyle 100%, FormattedSearch 99.5%, HeadlinesPlugin 94%
Plugin Home:	TWiki:Plugins/HeadlinesPlugin
Feedback:	TWiki:Plugins/HeadlinesPluginDev
Appraisal:	TWiki:Plugins/HeadlinesPluginAppraisal

>
>

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

Changed:

<
< -- TWiki:Main.PeterThoeny - 29 Aug 2009

>
> Related Topics: TWikiPlugins, AdminDocumentationCategory, TWikiPreferences

<<O>> Difference Topic HeadlinesPlugin (2 - 2009-08-29 - TWikiContributor)

Added:

>
>

Headlines Plugin

<--
   Contributions to this plugin are appreciated. Please update the plugin page
   at http://twiki.org/cgi-bin/view/Plugins/HeadlinesPlugin or provide feedback
   at http://twiki.org/cgi-bin/view/Plugins/HeadlinesPluginDev.
   If you are a TWiki contributor please update the plugin in the SVN repository.
-->

Deleted:

<
<

Headlines Plugin

On this page:

Description

This plugin displays RSS and ATOM feeds from news sites. Use it to build news portals that show headline news.

Changed:

<
< Note: Syndic8.com ( http://www.syndic8.com/ ) is a good site listing many RSS feeds.

>
> Note: Syndic8.com ( http://www.syndic8.com/ ) lists many RSS feeds.

Syntax Rules

%HEADLINES{"..."}%

Parameter	Explanation	Default
`"..."`	source of RSS 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

Added:

>
>

`header`	Header. Can 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. Can 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

Changed:

<
< The header and format parameters might also use variables rendering the dc, image and

>
> The 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.

Deleted:

<
< content namespace information. Note, that only bits of interest have been implemented so far and those namespaces might not be implemented fully yet.

Rendering the `dc` namespace

Changed:

<
< The following variables are extracting the dc namespace info,

>
> The following variables are extracting the dc namespace info, that could be used in header and format. Nnote, that some of the variables are already used above. This is done by purpose to use different feeds with the same formating parameters. If there's a conflict the non-dc tags have higher precedence, i.e. a <title> content </title> is prefered over <dc:title> content </dc:title> .

Deleted:

<
< that could be used in header and format. Nnote, that some of the variables are already used above. This is done by purpose to use different feeds with the same formating parameters. If there's a conflict the non-dc tags have higher precedence, i.e. a <title> content </title> is prefered 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)

Rendering the `image` namespace

An 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)

Rendering the `content` namespace

The variable $content is refering to the <content:encoding> content </content:encoding>.

Examples

Slashdot News

Write

Changed:

<
< %HEADLINES{"http://slashdot.org/slashdot.rdf"

>
> %HEADLINES{ "http://slashdot.org/slashdot.rdf"

header="*$title:* $description" format="$t* $title"

Added:

>
> limit="4"

}% to get the latest Slashdot news as a bullet list format:

Changed:

<
< HeadlinesPlugin ERROR: 501 Protocol scheme 'https' is not supported (LWP::Protocol::https not installed)

>
> HeadlinesPlugin ERROR: 501 Protocol scheme 'https' is not supported (LWP::Protocol::https not installed)

Business Opportunities Weblog

Write

Changed:

<
< HeadlinesPlugin ERROR: 501 Protocol scheme 'https' is not supported (LWP::Protocol::https not installed)

>
> HeadlinesPlugin ERROR: 501 Protocol scheme 'https' is not supported (LWP::Protocol::https not installed)

to get the latest postings on the "Business Opportunities" weblog:

Changed:

<
< HeadlinesPlugin ERROR: 501 Protocol scheme 'https' is not supported (LWP::Protocol::https not installed)

>
> HeadlinesPlugin ERROR: 501 Protocol scheme 'https' is not supported (LWP::Protocol::https not installed)

Plugin Settings

One line description, shown in the TextFormattingRules topic:
- Set SHORTDESCRIPTION = Show headline news in TWiki pages based on RSS and ATOM news feeds from external sites

Refresh rate in minutes for cached feeds. Disable caching: 0, default: 60
- Set REFRESH = 60

Maximum number of items shown. Default: 100
- Set LIMIT = 100

Use LWP::UserAgent, or fallback to TWiki's internal getUrl() method. Default: yes
- Set USELWPUSERAGENT = yes

Timeout fetching a feed using the LWP::UserAgent. Default: 20
- Set USERAGENTTIMEOUT = 20

Name of user agent. Default: TWikiHeadlinesPlugin/2.21

      * Set USERAGENTNAME = TWikiHeadlinesPlugin/2.21

Default header: (variables are explained in the syntax rules)

      * Set 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>

Default format of one item: (variables are explained in the syntax rules)

      * Set 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>

Values taken from configure: (only supported if CPAN:LWP is installed)
- $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";

Added:

>
>

Style Sheets

Changed:

<
<

Style sheets

>
> The default HEADER and FORMAT settings use the following styles. See the style.css file defining the default CSS properties (indentation illustrates enclosure).

Deleted:

<
< The default HEADER and FORMAT settings use the following styles. See the style.css file defining the default CSS properties (indentation illustrates enclosure).

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)

Plugin Installation Instructions

Changed:

<
<

Download the ZIP file

>
>

Download the ZIP file.

Unzip it in your twiki installation directory. Content:

File:	Description:
`data/TWiki/HeadlinesPlugin.txt`	plugin topic
`pub/TWiki/HeadlinesPlugin/style.css`	default css
`lib/TWiki/HeadlinesPlugin.pm`	plugin perl module
`lib/TWiki/HeadlinesPlugin/Core.pm`	plugin core

Check if above examples show a news feed instead of variable.

Changed:

<
<

Optionally, run HeadlinesPlugin_installer.pl to automatically check and install other TWiki modules that this module depends on. You can also do

>
>

Optionally, run HeadlinesPlugin_installer.pl to automatically check and install other TWiki modules that this module depends on. You can also do this step manually.
Alternatively, manually make sure the dependencies listed in the table below are resolved.

Deleted:

<
<

this step manually.

Alternatively, manually make sure the dependencies listed in the table below are resolved.

Name	Version	Description
Digest::MD5	>=2.33	Required. Download from CPAN:Digest::MD5
LWP::UserAgent	>=5.803	Optional. Download from CPAN:LWP::UserAgent

Deleted:

<
<

Plugin Info

Plugin Author:	TWiki:Main.PeterThoeny, TWiki:Main.MichaelDaum
Copyright:	© 2002-2009, Peter Thoeny, TWIKI.NET; 2005-2007, Michael Daum http://wikiring.de
License:	GPL (GNU General Public License)

Changed:

<
<

Plugin Version:

v2.21 - 12 Feb 2009

>
>

Plugin Version:

v2.3 - 29 Aug 2009

Change History:

<-- specify latest version first -->

Added:

>
>

29 Aug 2009:

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

Changed:

<
<

10 Feb 2006:

packaged using the TWiki:Plugins/BuildContrib

; minor fixes

| 03 Feb 2006: | off-by-one: limit="n" returned n+1 articles;

>
>

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

Deleted:

<
<

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

Changed:

<
< | 21 Nov 2005: | added ATOM support;

>
>

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

Deleted:

<
< 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:	TWiki:Plugins/HeadlinesPlugin
Feedback:	TWiki:Plugins/HeadlinesPluginDev
Appraisal:	TWiki:Plugins/HeadlinesPluginAppraisal

Changed:

<
< -- TWiki:Main.PeterThoeny - 12 Jan 2009

>
> -- TWiki:Main.PeterThoeny - 29 Aug 2009

Deleted:

<
< -- TWiki:Main.MichaelDaum - 13 Sep 2007

<<O>> Difference Topic HeadlinesPlugin (1 - 2009-02-13 - TWikiContributor)

<--
   Contributions to this plugin are appreciated. Please update the plugin page
   at http://twiki.org/cgi-bin/view/Plugins/HeadlinesPlugin or provide feedback
   at http://twiki.org/cgi-bin/view/Plugins/HeadlinesPluginDev.
   If you are a TWiki contributor please update the plugin in the SVN repository.
-->

Headlines Plugin

On this page:

Description

This plugin displays RSS and ATOM feeds from news sites. Use it to build news portals that show headline news.

Note: Syndic8.com ( http://www.syndic8.com/ ) is a good site listing many RSS feeds.

Syntax Rules

%HEADLINES{"..."}%

Parameter	Explanation	Default
`"..."`	source of RSS 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. Can 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. Can 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

Rendering the `dc` namespace

$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)

Rendering the `image` namespace

An 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)

Rendering the `content` namespace

The variable $content is refering to the <content:encoding> content </content:encoding>.

Examples

Slashdot News

Write

%HEADLINES{"http://slashdot.org/slashdot.rdf" 
  header="*[[$link][$title]]:* $description" 
  format="$t* [[$link][$title]]"
}%

to get the latest Slashdot news as a bullet list format:

HeadlinesPlugin ERROR: 501 Protocol scheme 'https' is not supported (LWP::Protocol::https not installed)

Business Opportunities Weblog

Write

%HEADLINES{"http://www.business-opportunities.biz/feed" limit="3"}%

to get the latest postings on the "Business Opportunities" weblog:

HeadlinesPlugin ERROR: 501 Protocol scheme 'https' is not supported (LWP::Protocol::https not installed)

Plugin Settings

One line description, shown in the TextFormattingRules topic:
- Set SHORTDESCRIPTION = Show headline news in TWiki pages based on RSS and ATOM news feeds from external sites

Refresh rate in minutes for cached feeds. Disable caching: 0, default: 60
- Set REFRESH = 60

Maximum number of items shown. Default: 100
- Set LIMIT = 100

Use LWP::UserAgent, or fallback to TWiki's internal getUrl() method. Default: yes
- Set USELWPUSERAGENT = yes

Timeout fetching a feed using the LWP::UserAgent. Default: 20
- Set USERAGENTTIMEOUT = 20

Name of user agent. Default: TWikiHeadlinesPlugin/2.21

      * Set USERAGENTNAME = TWikiHeadlinesPlugin/2.21

Default header: (variables are explained in the syntax rules)

      * Set 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>

Default format of one item: (variables are explained in the syntax rules)

      * Set 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>

Values taken from configure: (only supported if CPAN:LWP is installed)
- $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";

Style sheets

The default HEADER and FORMAT settings use the following styles. See the style.css file defining the default CSS properties (indentation illustrates enclosure).

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)

Plugin Installation Instructions

Download the ZIP file

Unzip it in your twiki installation directory. Content:

File:	Description:
`data/TWiki/HeadlinesPlugin.txt`	plugin topic
`pub/TWiki/HeadlinesPlugin/style.css`	default css
`lib/TWiki/HeadlinesPlugin.pm`	plugin perl module
`lib/TWiki/HeadlinesPlugin/Core.pm`	plugin core

Check if above examples show a news feed instead of variable.

Optionally, run HeadlinesPlugin_installer.pl to automatically check and install other TWiki modules that this module depends on. You can also do this step manually.
Alternatively, manually make sure the dependencies listed in the table below are resolved.
Name Version Description
Digest::MD5 >=2.33 Required. Download from CPAN:Digest::MD5
LWP::UserAgent >=5.803 Optional. Download from CPAN:LWP::UserAgent

Plugin Info

Plugin Author:	TWiki:Main.PeterThoeny, TWiki:Main.MichaelDaum
Copyright:	© 2002-2009, Peter Thoeny, TWIKI.NET; 2005-2007, Michael Daum http://wikiring.de
License:	GPL (GNU General Public License)
Plugin Version:	v2.21 - 12 Feb 2009
Change History:	<-- specify latest version first -->
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:	TWiki:Plugins/HeadlinesPlugin
Feedback:	TWiki:Plugins/HeadlinesPluginDev
Appraisal:	TWiki:Plugins/HeadlinesPluginAppraisal

-- TWiki:Main.PeterThoeny - 12 Jan 2009
-- TWiki:Main.MichaelDaum - 13 Sep 2007

View | History: r11 < r10 < r9 < r8 | More

Copyright © 1999-2025 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback
Note: Please contribute updates to this topic on TWiki.org at TWiki:TWiki.HeadlinesPlugin.

Welcome | Register | Changes | Topics | Index | Search | Go

Headlines Plugin

Description

Syntax Rules

Rendering the dc namespace

Rendering the image namespace

Rendering the content namespace

Examples

Slashdot News

Wired Enterprise Feed

Plugin Settings

Style Sheets

Plugin Installation Instructions

Plugin Info

Headlines Plugin

Description

Syntax Rules

Rendering the dc namespace

Rendering the image namespace

Rendering the content namespace

Examples

Slashdot News

Wired Enterprise Feed

Plugin Settings

Style Sheets

Plugin Installation Instructions

Plugin Info

Headlines Plugin

Description

Syntax Rules

Rendering the dc namespace

Rendering the image namespace

Rendering the content namespace

Examples

Slashdot News

Business Opportunities Weblog

Wired Enterprise Feed

Plugin Settings

Style Sheets

Plugin Installation Instructions

Plugin Info

Headlines Plugin

Description

Syntax Rules

Rendering the dc namespace

Rendering the image namespace

Rendering the content namespace

Examples

Slashdot News

Business Opportunities Weblog

Plugin Settings

Style Sheets

Plugin Installation Instructions

Plugin Info

Headlines Plugin

Description

Syntax Rules

Rendering the dc namespace

Rendering the image namespace

Rendering the content namespace

Examples

Slashdot News

Business Opportunities Weblog

Plugin Settings

Style Sheets

Plugin Installation Instructions

Plugin Info

Headlines Plugin

Description

Syntax Rules

Rendering the dc namespace

Rendering the image namespace

Rendering the content namespace

Examples

Slashdot News

Business Opportunities Weblog

Plugin Settings

Style Sheets

Plugin Installation Instructions

Plugin Info

Rendering the `dc` namespace

Rendering the `image` namespace

Rendering the `content` namespace

Rendering the `dc` namespace

Rendering the `image` namespace

Rendering the `content` namespace

Rendering the `dc` namespace

Rendering the `image` namespace

Rendering the `content` namespace

Rendering the `dc` namespace

Rendering the `image` namespace

Rendering the `content` namespace

Rendering the `dc` namespace

Rendering the `image` namespace

Rendering the `content` namespace

Rendering the `dc` namespace

Rendering the `image` namespace

Rendering the `content` namespace

Rendering the `dc` namespace

Rendering the `image` namespace

Rendering the `content` namespace

Rendering the `dc` namespace

Rendering the `image` namespace

Rendering the `content` namespace

Rendering the `dc` namespace

Rendering the `image` namespace

Rendering the `content` namespace

Rendering the `dc` namespace

Rendering the `image` namespace

Rendering the `content` namespace

Rendering the `dc` namespace

Rendering the `image` namespace

Rendering the `content` namespace