Skip to content.

Trova Pagina


Cerca testo

Sezioni

Utenti

Funzioni Sezioni

Aiuto

Link Veloci
TWiki > HeadlinesPlugin

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
    • Set DEBUG = 0

  • 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

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

Examples

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

HEADLINES Plugin Error
HeadlinesPlugin: Can't read http://slashdot.org/slashdot.rdf (301 Moved Permanently)

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:

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.

  • 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
    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 May 2005 (V1.004)
Change History:  
11 May 2005: added DevelopBranch? compatability (TWiki:Main.WillNorris)
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
Plugin Home: http://TWiki.org/cgi-bin/view/Plugins/HeadlinesPlugin
Feedback: http://TWiki.org/cgi-bin/view/Plugins/HeadlinesPluginDev

Related Topics: TWikiPreferences, TWikiPlugins

-- PeterThoeny - 02 Aug 2002


Ultima versione: r1.1 - 11 May 2005 - 00:58 - Main.guest
 
Riferimenti a questa pagina | Testo in formato Wiki |  Storia delle revisioni | r1.4 | > | r1.3 | > | r1.2
Se riconosciuto dal sistema come utente: Main.guest