r2 - 2009-08-29 - 21:55:14 - TWikiContributorYou are here: TWiki >  TWiki Web  > HeadlinesPlugin

Headlines Plugin

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

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

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

Business Opportunities Weblog

Write

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

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

Thu, 23 Oct 2014 05:22:04 +0000
The original blog about business opportunities and business ideas for small business entrepreneurs
Thu, 23 Oct 2014 05:22:04 +0000 Dane Carlson

2 On this day in 1958, the Smurfs, a fictional race of blue dwarves, later popularized in a Hanna-Barbera animated cartoon series), appear for the first time in the story “The Flute with Six Holes.”

Wed, 22 Oct 2014 22:06:55 +0000 Dane Carlson

In court filings this week, the International Franchise Association provided new details in support of its legal challenge to the provisions of Seattle's new minimum wage law that discriminate against small franchise businesses.
This past June, the IFA and several local franchise business owners in Seattle filed a lawsuit to challenge the discriminatory provisions of Seattle's new minimum wage law. In August, the IFA requested a preliminary injunction to halt, pending the completion of the litigation, the part of the new law that unfairly classifies small franchise businesses as large employers.

If the minimum wage law were to go into effect in April 2015 as written, small franchise businesses would be forced to pay a much higher wage than other small businesses. That would put those local franchise business owners at a significant competitive disadvantage and could result in closed businesses and lost jobs.

In the past few weeks,more briefs have been filed and depositions have been taken as part of IFA's lawsuit.

On Friday, Oct. 10, the IFA filed a response to the city's brief regarding the preliminary injunction request. That IFA brief can be found in two parts here (Reply Brief) and here (Supporting Declaration).

IFA's Reply Brief includes legal arguments in favor of the preliminary injunction, and IFA's Supporting Declaration includes new evidence in the form of emails from city officials and business leaders and excerpts of depositions of the city's expert witness, Scott Shane, and three of the Seattle franchise business owners who filed the lawsuit along with IFA: Kathy Lyons, Ronald Oh and Chuck Stempler.

Some of the highlights from IFA's latest filing:

  • The IFA notes that the city did not counter the documents and emails filed by IFA in August that showed the city's move to add the discriminatory provisions against local franchise business owners was at the behest of the Service Employees International Union (SEIU), which in turn wanted to ''break the franchise model'' and enable unions to organize employees at franchise businesses. Nick Hanauer, a member of Mayor Ed Murray's advisory committee, is quoted in the August brief telling City Council President Tim Burgess that the local franchise business owner provisions were added because Hanauer and his allies on the Mayor's advisory committee didn't like franchise businesses and wanted them out of the city.

  • In its brief Friday, IFA said the city has not offered declarations from Mayor Murray, Mr. Hanauer, Council member Kshama Sawant or local SEIU head David Rolf - to counter the IFA's documents showing the city's discriminatory motive for treating small franchise businesses less favorably than small non-franchise businesses. (Reply Brief, Pgs. 13 and 19)

  • In a deposition of Scott Shane, a professor at Case Western Reserve University and the city's expert witness on franchises, Shane agrees that franchisors and local franchise business owner are separate and independent companies and that a local franchise business owner is just as legally independent as a non-franchise business. He agrees that a local franchise business owner's employees are not the franchisor's employees. (Supporting Declaration, Pgs. 15-33)

  • In depositions of three Seattle franchise business owners who filed the lawsuit with IFA - Kathy Lyons, the owner of a BrightStar Care home health care business; Ronald Oh, the general manager and an owner of a Holiday Inn Express; and Chuck Stempler, the owner of two AlphaGraphics print shops in Seattle - the business owners say they will be at a disadvantage compared to their non-franchise competitors if the law goes into effect. They will suffer a large increase in their labor costs and be subject to a $15 per hour minimum wage in just three years, while their non-franchise competitors will have seven years to phase in the higher minimum wage. (Supporting Declaration, Pgs. 34-69)

Seattle's new minimum wage law treats local franchise business owners not as the small businesses they are, but as large employers. Local franchise business owners with fewer than 500 employees must adopt the $15 minimum wage on the same expedited three-year timetable as big businesses with more than 500 employees, beginning in April 2015. The new law gives non-franchised businesses with fewer than 500 employees seven years to phase in the $15 minimum wage.

''With such a blatant discriminatory attack on the business community, Seattle may find it difficult to attract future business conventions like the American Bar Association (ABA) franchise conference, which has drawn 1,200 franchise attorneys to Seattle this week and brought at least $1.5 million to Seattle hotels, restaurants and other businesses,'' said IFA President & CEO Steve Caldeira.

''Franchise businesses are one of the largest drivers to Seattle's economy, with 600 local franchise business owners employing 19,000 people, and this economic strength is on display with the ABA conference this week,'' Caldeira said. ''In the U.S., franchise businesses are responsible for one out of every eight private-sector jobs and 3.4 percent of the gross domestic product. Local franchise business owners create new local jobs and new businesses at twice the rate of other business segments.''

Go to SeattleFranchiseFairness.com to learn more about the lawsuit and the coalition of Seattle small business owners working together to oppose the local franchise business owner provisions in the city's minimum wage law.

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.
    NameVersionDescription
    Digest::MD5>=2.33Required. Download from CPAN:Digest::MD5
    LWP::UserAgent>=5.803Optional. 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.3 - 29 Aug 2009
Change History:  
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
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 - 29 Aug 2009

Edit | WYSIWYG | Attach | Printable | Raw View | Backlinks: Web, All Webs | History: r2 < r1 | More topic actions
 
This site is powered by the TWiki collaboration platformCopyright © 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