(r1)HeadlinesPlugin < TWiki

Webs
Main
Sandbox
TWiki
You are here: FS > TWiki Web > HeadlinesPlugin	r1 - 18 Nov 2005 - 15:07 - TWikiContributor
View topic \| ~~EditAttach~~Printable
Start of topic | Skip to actions
---+!! Headlines Plugin

%TOC%

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

=%<nop>HEADLINES{"..."}%=

| *Parameter* | *Explanation* | *Default* |
| ="..."= | source of RSS feed; this can be an url (starting with http) \
            or a <nop>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) %BR% \
             - $channellink, $link: link of channel (channel.link) %BR% \
             - $channeldescription, $description: description (channel.description) %BR% \
             - $channeldate, $date: publication date of the channel (channel.pubDate) %BR% \
             - $rights: copyrights of the channel (channel.copyright) %BR% \
             - $imagetitle: title text for site (image.title) %BR% \
             - $imagelink: link for site (image.link) %BR% \
             - $imageurl: URL of image (image.url) %BR% \
             - $imagedescription: description of image (image.description) \
             | Global =HEADER= setting |
| =format= | Format of one item. Can include these variables: %BR% \
             - $title: news item title (item.title) %BR% \
             - $link: news item link (item.link)  %BR% \
             - $description: news item description (item.description) %BR% \
             - $date: the publication date (item.pubDate, item.date) %BR% \
             - $category: the article category (item.category) \
             | Global =FORMAT= setting |

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=. 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 &lt;title&gt; content &lt;/title&gt; is prefered over 
&lt;dc:title&gt; content &lt;/dc:title&gt; .
   * $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 [[#Subject_Images][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 &lt;img&gt; 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 &lt;content:encoding&gt; content &lt;/content:encoding&gt;.

---++ Examples

Write 
<verbatim>
%HEADLINES{"http://slashdot.org/slashdot.rdf" 
  header="*[[$link][$title]]:* $description" 
  format="$t* [[$link][$title]]"
}%
</verbatim>  
to get the latest Slashdot news as a bullet list format:

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

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

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

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

---++ Plugin Settings

Plugin settings are stored as preferences variables. To reference
a plugin setting write ==%<nop>&lt;plugin&gt;_&lt;setting&gt;%==, for example, ==%<nop>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.

   * 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

   * Default header: (variables are explained in the syntax rules)
<verbatim>
      * Set HEADER = <div class="headlinesChannel"><div class="headlinesLogo"><img src="$imageurl" alt="$imagetitle" border="0"/>%BR%</div><div class="headlinesTitle">$n---+!! [[$link][$title]]</div><div class="headlinesDate">$date</div><div class="headlinesDescription">$description</div><div class="headlinesRight">$rights</div></div>
</verbatim>
   * Default format of one item: (variables are explained in the syntax rules)
<verbatim>
      * Set FORMAT = <div class="headlinesArticle"><div class="headlinesTitle">[[$link][$title]]</div>$n<hr/><span class="headlinesDate">$date</span> <span class="headlinesCreator"> $creator</span> <span class="headlinesSubject"> $subject </span>$n<div class="headlinesText"> $description</div></div>
</verbatim>

---++ Style sheets
The default HEADER and FORMAT settings use the following styles. See the [[%ATTACHURL%/style.css][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)
         * headlineText: article text (div)

---++ Plugin Installation Instructions

   * Download the ZIP file from the Plugin web (see below)
   * Unzip ==%TOPIC%.zip== in your twiki installation directory. Content:
     | *File:* | *Description:* |
     | ==data/TWiki/%TOPIC%.txt== | Plugin topic |
     | ==pub/TWiki/%TOPIC%/style.css== | default css |
     | ==lib/TWiki//%TOPIC%.pm== | Plugin Perl module |
   * Test if the plugin is correctly installed:
     Check if above examples show a news feed instead of variable.


---++ Plugin Info

|  Plugin Author: | TWiki:Main.PeterThoeny, TWiki:Main.MichaelDaum |
|  Plugin Version: | 05 Dec 2005 (v1.95) |
|  Change History: | <!-- specify latest version first -->&nbsp; |
|  05 Dec 2005: | internal feed urls must be absolute |
|  02 Dec 2005: | added <nop>web.topic shorthand for internal feeds |
|  29 Nov 2005: | fixed CDATA handling |
|  21 Nov 2005: | added ATOM support; \
             extended RSS support; \
        added dublion 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 <nop>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 <nop>SpeedyCGI is used |
|  02 Aug 2002: | Implemented caching of feeds, thanks to TWiki:Main/RobDuarte |
|  11 Jun 2002: | Initial version (V1.000) |
|  CPAN Dependencies: | CPAN:LWP::UserAgent, CPAN:Digest::MD5 |
|  Other Dependencies: | none |
|  Perl Version: | 5.004 |
|  TWiki:Plugins/Benchmark: | %TWIKIWEB%.GoodStyle 100%, %TWIKIWEB%.FormattedSearch 99.5%, %TOPIC% 94% |
|  Plugin Home: | http://TWiki.org/cgi-bin/view/Plugins/%TOPIC% |
|  Feedback: | http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Dev |
|  Appraisal: | http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Appraisal |

-- TWiki:Main.PeterThoeny - 11 May 2005 %BR%
-- TWiki:Main.MichaelDaum - 05 Dec 2005
End of topic
Skip to actions | Back to top
Show attachments
Hide attachments
Topic attachments
I	Attachment	Action	Size	Date	Who	Comment
css	style.css	manage	1.3 K	21 Nov 2005 - 17:20	TWikiContributor
Copyright © by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding FS? Send feedback