HeadlinesPlugin (r1.1 vs. r1.6)

AVO TWiki system

Edit page

View page

All Diffs

Printable

Logged in as TWikiGuest

TWiki
WelcomeGuest
TWikiTutorial
WikiSyntax
GoodStyle
TWikiDocumentation
TWikiShorthand

<<O>> Difference Topic HeadlinesPlugin (r1.6 - 01 Nov 2004 - PeterThoeny)

Headlines Plugin

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

Line: 75 to 75

Plugin Info

Plugin Author:

PeterThoeny

Changed:

<
<

Plugin Version:

29 Oct 2004 (V1.002)

>
>

Plugin Version:

31 Oct 2004 (V1.003)

Change History:

Added:

>
>

31 Oct 2004:

Fixed taint issue by TWiki:Main.AdrianWeiler; small performance improvement

29 Oct 2004:	Fixed issue of eternal 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)
CPAN Dependencies:	none
Other Dependencies:	none
Perl Version:	5.004

Added:

>
>

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

Related Topics: TWikiPreferences, TWikiPlugins

Changed:

<
<

-- PeterThoeny - 29 Oct 2004

>
>

-- TWiki:Main.PeterThoeny - 31 Oct 2004

<<O>> Difference Topic HeadlinesPlugin (r1.5 - 30 Oct 2004 - PeterThoeny)

Headlines Plugin

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

Line: 16 to 16

Set DEBUG to 1 to get debug messages in data/debug.txt. Default: 0
- Set DEBUG = 0

Changed:

<
<

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

>
>

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

Line: 34 to 34

Syntax Rules

Changed:

<
< The %HEADLINES{...}% variable gets expanded to the content pulled from an RSS feed.

>
> The %HEADLINES{...}% variable gets expanded to the content pulled from an RSS feed. Supported parameters:

Changed:

<
<

%HEADLINES% Parameter	Explanation	Default
`href`	URL of RSS feed	None; is required
`refresh`	Refresh rate in minutes for caching feed; `"0"` for no caching	Global `REFRESH` setting
`limit`	Maximum number of items shown	Global `LIMIT` setting
`header`	Header. Can include these variables: - $channeltitle: Title of channel - $channellink: Link of channel - $channeldescription: Description of channel - $imagetitle: Title text for site - $imagelink: Link for site - $imageurl: URL of image - $imagedescription: Description of image	Global `HEADER` setting
`format`	Format of one item. Can include these variables: - $title: News item title - $link: News item link - $description: News item description	Global `FORMAT` setting

<!-- NOT YET IMPLEMENTED:

refresh Refresh rate in minutes Global REFRESH setting

-->

>
>

Parameter	Explanation	Default
`"http://..."`	URL of RSS feed	None; is required
`href="http://..."`	(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 of channel - $channellink: Link of channel - $channeldescription: Description of channel - $imagetitle: Title text for site - $imagelink: Link for site - $imageurl: URL of image - $imagedescription: Description of image	Global `HEADER` setting
`format="..."`	Format of one item. Can include these variables: - $title: News item title - $link: News item link - $description: News item description	Global `FORMAT` setting

Examples

Changed:

<
< Write %HEADLINES{ href="http://slashdot.org/slashdot.rdf" }% to get the latest Slashdot news in table format:

>
> Write %HEADLINES{ "http://slashdot.org/slashdot.rdf" }% to get the latest Slashdot news in table format:

Changed:

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

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

Write %HEADLINES{ href="http://www.moreover.com/cgi-local/page?o=rss&c=Aerospace%20and%20defense%20industry%20news" header=" * [[$channellink][$channeltitle]]:" format=" * [[$link][$title]] ($description)" }% to get Aerospace and defense industry news rendered as a bullet list:

Line: 59 to 56

Known issues

Deleted:

<
<

Topic load time depends on timeit takes to load the RSS feed. A future version might include some caching to improve performance.

This plugin uses the undocumented TWiki::Net::getUrl() function. The plugin might break in a future TWiki release.

Changed:

<
<

URLs on virtual hosts cannot be read, for example, TWiki:Codev/TWikiSyndication does not work. This is a limitation of TWiki::Net::getUrl()

>
>

URLs on virtual hosts cannot be read. This is a limitation of TWiki::Net::getUrl()

Plugin Installation Instructions

Line: 79 to 75

Plugin Info

Plugin Author:

PeterThoeny

Changed:

<
<

Plugin Version:

02 Aug 2002 (V1.001)

>
>

Plugin Version:

29 Oct 2004 (V1.002)

Change History:

Added:

>
>

29 Oct 2004:

Fixed issue of eternal 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)
CPAN Dependencies:	none

Line: 91 to 88

Related Topics: TWikiPreferences, TWikiPlugins

Changed:

<
< -- PeterThoeny - 02 Aug 2002

>
> -- PeterThoeny - 29 Oct 2004

<<O>> Difference Topic HeadlinesPlugin (r1.4 - 02 Aug 2002 - PeterThoeny)

Headlines Plugin

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

Line: 16 to 16

Set DEBUG to 1 to get debug messages in data/debug.txt. Default: 0
- Set DEBUG = 0

Changed:

<
<

<!-- NOT YET IMPLEMENTED:

Refresh rate in minutes. Default: 15
- Set REFRESH = 15

-->

>
>

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

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

Line: 40 to 38

%HEADLINES% Parameter	Explanation	Default
`href`	URL of RSS feed	None; is required

Added:

>
>

refresh Refresh rate in minutes for caching feed; "0" for no caching Global REFRESH setting

`limit`	Maximum number of items shown	Global `LIMIT` setting
`header`	Header. Can include these variables: - $channeltitle: Title of channel - $channellink: Link of channel - $channeldescription: Description of channel - $imagetitle: Title text for site - $imagelink: Link for site - $imageurl: URL of image - $imagedescription: Description of image	Global `HEADER` setting
`format`	Format of one item. Can include these variables: - $title: News item title - $link: News item link - $description: News item description	Global `FORMAT` setting

Line: 80 to 79

Plugin Info

Plugin Author:

PeterThoeny

Changed:

<
<

Plugin Version:

11 June 2002 (V1.000)

>
>

Plugin Version:

02 Aug 2002 (V1.001)

Change History:

Changed:

<
<

11 June 2002:

Initial version (V1.0)

>
>

02 Aug 2002:	Implemented caching of feeds, thanks to TWiki:Main/RobDuarte
11 Jun 2002:	Initial version (V1.000)

CPAN Dependencies:	none
Other Dependencies:	none
Perl Version:	5.004

Line: 91 to 91

Related Topics: TWikiPreferences, TWikiPlugins

Changed:

<
< -- PeterThoeny - 12 Jun 2002

>
> -- PeterThoeny - 02 Aug 2002

<<O>> Difference Topic HeadlinesPlugin (r1.3 - 13 Jun 2002 - PeterThoeny)

Headlines Plugin

Changed:

<
< This plugin displays RSS feeds from news sites.

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

Changed:

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

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

HeadlinesPlugin Global Settings

Line: 11 to 11

a plugin setting write %<plugin>_<setting>%, for example, %HEADLINES_SHORTDESCRIPTION%

One line description, shown in the TextFormattingRules topic:

Changed:

<
<

- Set SHORTDESCRIPTION = This plugin displays RSS feeds from news sites.

>
>

- Set SHORTDESCRIPTION = Build news portals that show headline news based on RSS news feeds from news sites.

Set DEBUG to 1 to get debug messages in data/debug.txt. Default: 0
- Set DEBUG = 0

Line: 48 to 48

refresh Refresh rate in minutes Global REFRESH setting

-->

Changed:

<
<

Example

>
>

Examples

Changed:

<
< Write %HEADLINES{ href="http://slashdot.org/slashdot.rdf" }% to get:

>
> Write %HEADLINES{ href="http://slashdot.org/slashdot.rdf" }% to get the latest Slashdot news in table format:

%HEADLINES{ href="http://slashdot.org/slashdot.rdf" }%

Added:

>
>

Write

%HEADLINES{ href="http://www.moreover.com/cgi-local/page?o=rss&c=Aerospace%20and%20defense%20industry%20news" header="   * [[$channellink][$channeltitle]]:" format="      * [[$link][$title]] ($description)" }%

to get Aerospace and defense industry news rendered as a bullet list:

%HEADLINES{ href="http://www.moreover.com/cgi-local/page?o=rss&c=Aerospace%20and%20defense%20industry%20news" header=" * $channeltitle^?:" format=" * $title^? ($description)" }%

Known issues

Topic load time depends on timeit takes to load the RSS feed. A future version might include some caching to improve performance.

Line: 87 to 91

Related Topics: TWikiPreferences, TWikiPlugins

Changed:

<
< -- PeterThoeny - 11 Jun 2002

>
> -- PeterThoeny - 12 Jun 2002

<<O>> Difference Topic HeadlinesPlugin (r1.2 - 12 Jun 2002 - PeterThoeny)

Headlines Plugin

This plugin displays RSS feeds from news sites.

Added:

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

HeadlinesPlugin Global Settings

Plugin settings are stored as preferences variables. To reference

Line: 12 to 14

- Set SHORTDESCRIPTION = This plugin displays RSS feeds from news sites.

Set DEBUG to 1 to get debug messages in data/debug.txt. Default: 0

Changed:

<
<

- Set DEBUG = 1

>
>

- Set DEBUG = 0

<!-- NOT YET IMPLEMENTED:

Refresh rate in minutes. Default: 15

Line: 36 to 38

The %HEADLINES{...}% variable gets expanded to the content pulled from an RSS feed.

Changed:

<
<

%HEADLINES% Parameter	Comment	Default

>
>

%HEADLINES% Parameter	Explanation	Default

`href`	URL of RSS feed	None; is required
`limit`	Maximum number of items shown	Global `LIMIT` setting
`header`	Header. Can include these variables: - $channeltitle: Title of channel - $channellink: Link of channel - $channeldescription: Description of channel - $imagetitle: Title text for site - $imagelink: Link for site - $imageurl: URL of image - $imagedescription: Description of image	Global `HEADER` setting

Line: 52 to 54

%HEADLINES{ href="http://slashdot.org/slashdot.rdf" }%

Added:

>
>

Known issues

Topic load time depends on timeit takes to load the RSS feed. A future version might include some caching to improve performance.
This plugin uses the undocumented TWiki::Net::getUrl() function. The plugin might break in a future TWiki release.
URLs on virtual hosts cannot be read, for example, TWiki:Codev/TWikiSyndication does not work. This is a limitation of TWiki::Net::getUrl()

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 server where TWiki is running.

<<O>> Difference Topic HeadlinesPlugin (r1.1 - 12 Jun 2002 - PeterThoeny)

Line: 1 to 1

Added:

>
>

Headlines Plugin

This plugin displays RSS feeds from news sites.

HeadlinesPlugin Global Settings

Plugin settings are stored as preferences variables. To reference a plugin setting write %<plugin>_<setting>%, for example, %HEADLINES_SHORTDESCRIPTION%

One line description, shown in the TextFormattingRules topic:
- Set SHORTDESCRIPTION = This plugin displays RSS feeds from news sites.

Set DEBUG to 1 to get debug messages in data/debug.txt. Default: 0
- Set DEBUG = 1

<!-- NOT YET IMPLEMENTED:

Refresh rate in minutes. Default: 15
- Set REFRESH = 15

-->

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

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

      * Set HEADER = | *[[$channellink][$channeltitle]] [[$imagelink][<img src="$imageurl" alt="$imagetitle" border="0" />]]* |

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

      * Set FORMAT = | [[$link][$title]] |

Syntax Rules

The %HEADLINES{...}% variable gets expanded to the content pulled from an RSS feed.

%HEADLINES% Parameter	Comment	Default
`href`	URL of RSS feed	None; is required
`limit`	Maximum number of items shown	Global `LIMIT` setting
`header`	Header. Can include these variables: - $channeltitle: Title of channel - $channellink: Link of channel - $channeldescription: Description of channel - $imagetitle: Title text for site - $imagelink: Link for site - $imageurl: URL of image - $imagedescription: Description of image	Global `HEADER` setting
`format`	Format of one item. Can include these variables: - $title: News item title - $link: News item link - $description: News item description	Global `FORMAT` setting

<!-- NOT YET IMPLEMENTED:

refresh Refresh rate in minutes Global REFRESH setting

-->

Example

Write %HEADLINES{ href="http://slashdot.org/slashdot.rdf" }% to get:

%HEADLINES{ href="http://slashdot.org/slashdot.rdf" }%

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 server where TWiki is running.

Download the ZIP file from the Plugin web (see below)

Unzip HeadlinesPlugin.zip in your twiki installation directory. Content:

File:	Description:
`data/TWiki/HeadlinesPlugin.txt`	Plugin topic
`data/TWiki/HeadlinesPlugin.txt,v`	Plugin topic repository
`lib/TWiki/Plugins/HeadlinesPlugin.pm`	Plugin Perl module

Test if the plugin is correctly installed:
- Check if above example shows a news feed instead of variable.

Plugin Info

Plugin Author:	PeterThoeny
Plugin Version:	11 June 2002 (V1.000)
Change History:	<!-- specify latest version first -->
11 June 2002:	Initial version (V1.0)
CPAN Dependencies:	none
Other Dependencies:	none
Perl Version:	5.004
Plugin Home:	http://TWiki.org/cgi-bin/view/Plugins/HeadlinesPlugin
Feedback:	http://TWiki.org/cgi-bin/view/Plugins/HeadlinesPluginDev

Related Topics: TWikiPreferences, TWikiPlugins

-- PeterThoeny - 11 Jun 2002

Revision r1.1 - 12 Jun 2002 - 01:54 - PeterThoeny
Revision r1.6 - 01 Nov 2004 - 07:13 - PeterThoeny