|
|
Headlines Plugin
This plugin displays RSS 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.
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 = 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
- Refresh rate in minutes for cached feeds. Disable caching:
0, default: 60
- Maximum number of items shown. Default:
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. Supported parameters:
| 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
Write %HEADLINES{ "http://slashdot.org/slashdot.rdf" }% to get the latest Slashdot news in table format:
%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:
%HEADLINES{ href="http://www.moreover.com/cgi-local/page?o=rss&c=Aerospace%20and%20defense%20industry%20news" header=" * $channeltitle?:" format=" * $title? ($description)" }%
Known issues
- 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. 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.
- 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
Related Topics: TWikiPreferences, TWikiPlugins
-- TWiki:Main.PeterThoeny - 31 Oct 2004
|
|
Edit menu
