Welcome, Registration, and other StartingPoints; Foswiki history & Wiki style; All the docs...
Edit | Attach | New | Raw | Delete | History | Print | Tools
You are here: System » 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/ ) is a good site listing many RSS feeds.

Syntax Rules

%HEADLINES{"..."}%

Parameter Explanation DefaultSorted ascending
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
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
limit="12" Maximum number of items shown Global LIMIT setting
refresh="60" Refresh rate in minutes for caching feed; "0" for no caching Global REFRESH setting
href="..." (Alternative to above) N/A
"..." source of RSS feed; this can be an url (starting with http) or a web.topic location for internal feeds None; is required

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]]$n $description" format="$t* [[$link][$title]]"}%
to get the latest Slashdot news as a bullet list format:

Business Opportunities Weblog

Write

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

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

Thu, 05 Mar 2015 22:44:01 +0000
The original blog about business opportunities and business ideas for small business entrepreneurs
Thu, 05 Mar 2015 19:02:20 +0000 Dane Carlson

Papa John's franchisee ordered to pay New York City workers more than $2 million

Better ingredients, better pizza, bad pay. A Papa John’s franchisee must pay hundreds of pizza delivery workers over $2 million, Manhattan Supreme Court Justice Joan Kenney ruled this week.

Arizona Burger King franchisee wins award, gives staff $120K in bonuses

The Burger King Franchisee of the Year for 2014 turned his Corvette and Rolex prizes into cash for employee bonuses, to honor those who made the award possible.

Why These Two Boxing Club Franchisees Picked Franchising as a Path to Entrepreneurial Success

For some businesses, two heads are better than one. That’s the case in TITLE Boxing Club’s location in Chicago’s Lincoln Park neighborhood. Business partners John Jarvis and Mike Confalone both had experience in the franchise industry when they opened up the boxing club together. Here’s what the duo has learned.

Sarpino's continues to expand with 24-year-old entrepreneur, franchising veteran team

Most would be hard-pressed to find anyone at the age of 24 that could be called a veteran in business. But for David Gantcher, who has been involved with Sarpino's Pizzeria since his father opened a location when Gantcher was 15, that distinction fits him to a ''T.''

Blaze Pizza opens near Northwestern University

The company's assembly-line format lets customers choose which toppings to put on their 11-inch pizza, which is baked in an open-flame oven within 3 minutes. Blaze Pizza also has gluten-free dough and vegan cheese. The Evanston restaurant will have wine and craft beer too.

Thu, 05 Mar 2015 17:07:44 +0000 Dane Carlson

''I don’t have one. They’re kind of expensive to use,'' John Sylvan told me frankly, of Keurig K-Cups, the single-serve brewing pods that have fundamentally changed the coffee experience in recent years. ''Plus it's not like drip coffee is tough to make.'' Which would seem like a pretty banal sentiment, were Sylvan not the inventor of the K-Cup.

Almost one in three American homes now has a pod-based coffee machine, even though Sylvan never imagined they would be used outside of offices. Last year K-Cups accounted for most of Keurig Green Mountain's $4.7 billion in revenue-more than five times what the company made five years prior. So even though he gets treated like a minor celebrity when he tells people he founded Keurig, Sylvan has some regrets about selling his share of the company in 1997 for $50,000. But that's not what really upsets him.

In 2010, journalist and caffeine aficionado Murray Carpenter visited the Keurig facilities in Waterbury, Vermont, reporting for The New York Times that the K-Cup idea posed environmental concerns, as the pods were not recyclable or biodegradable. It was that same year that the Keurig model seemed to take off, doubling in sales. In a 2011 local-boys-make-it-big story in Boston magazine, Eric Anderson, a professor of marketing at Northwestern University, likewise noted that the coffee machines could invite significant backlash because they ''generate a ton of plastic waste.''

Wed, 04 Mar 2015 22:27:01 +0000 Dane Carlson

How upcoming legal cases may change the future of franchises

Are franchises small, independent businesses or should they be considered part of a much larger company? The question is at the heart of two upcoming legal cases. The outcomes could affect profits and change how franchisees hire, fire, manage and pay workers.

U.S. added 29,000 franchise jobs in february, according to ADP National Franchise report

U.S. private-sector franchise jobs increased by 29,000 during the month of February, according to the ADP National Franchise Report.

Delaware company seeks vehicle franchise change to allow snowball sales

The summertime tradition of snowballs could fill the vacant position as Ocean City's ice cream truck franchise as officials were open this week to amending the code.

Revention partners with franchise software solution FranConnect

Revention is the leading developer of complete, customizable restaurant and entertainment management solutions designed to streamline the way hospitality concepts do business. FranConnect is a provider of Franchise Management Systems

Cincinnati franchise owner expands hearing aid business

The owner of Zounds Hearing in Centerville has expanded his franchise business south, and acquired a second location in Montgomery, in suburban Cincinnati. Zounds provides hearing tests and sells hearing aids.

Why the NLRB is assaulting the franchise industry

In the U.S. there are two primary ways to capitalize rapid business expansion beyond internal financial resources: 1) outside investors, including going public; 2) franchising. This article is about the latter being in jeopardy.

Guidant builds partnerships to go beyond financing franchises

Guidant Financial's CEO David Nilssen felt he and his team had great relationships with franchisors. The lender, which focuses on providing SBA loans, 401(k) rollover financing and unsecured credit to start-up franchisees, wanted to further strengthen those relationships. ''Building those relationships has been challenging because we would only finance the first store,'' he said. ''But the franchisors need help with financing franchisees with second or third stores, and store upgrades. We just weren't able to build relationships with the entire system.'' In 2014, he decided to change that.

Everything you didn’t know about International Franchise Association president Steve Caldeira

He started on Capitol Hill as a legislative correspondent for a GOP freshman House member, then morphed to working on political campaigns, including former NY Sen. Al D'Amato's re-election in '86. Intro to associations came from working as senior manager of political affairs in the Northeast region during the '88 election cycle for the US Chamber of Commerce. Second stint in DC was mid- to late ’90s for the National Restaurant Association as communications, marketing and regulatory affairs SVP and then president/COO of its educational foundation in Chicago.

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 SitePreferences. For example, to customize the USERAGENTNAME setting, create a HEADLINESPLUGIN_USERAGENTNAME setting in Main.SitePreferences.

  • One line description, shown in the TextFormattingRules topic:
    • Set SHORTDESCRIPTION = Show headline news in Foswiki 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 Foswiki'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: FoswikiHeadlinesPlugin/2.21.1
      * Set USERAGENTNAME = FoswikiHeadlinesPlugin/2.21.1

  • 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)
    • $Foswiki::cfg{PROXY}{HOST} - proxy host, such as "proxy.example.com";
    • $Foswiki::cfg{PROXY}{PORT} - proxy port, such as "8080";
    • $Foswiki::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 foswiki installation directory. Content:
    File: Description:
    data/System/HeadlinesPlugin.txt plugin topic
    pub/System/HeadlinesPlugin/style.css default css
    lib/Foswiki/HeadlinesPlugin.pm plugin perl module
    lib/Foswiki/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 Foswiki 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, Foswiki:Main.MichaelDaum (2005-2007)
Copyright: © 2002-2009, Peter Thoeny, TWIKI.NET; 2005-2007, Michael Daum http://wikiring.de
License: GPL (GNU General Public License)
Plugin Version: 2.21.1 (08 Mar 2009)
Change History:  
08 Mar 2009: Ported without changes to Foswiki namespace by Kenneth Lavrsen and put under "Feel Free To Modify" in Foswiki context.
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.008
Plugin Home: http://foswiki.org/Extensions/HeadlinesPlugin
Feedback: http://foswiki.org/Extensions/HeadlinesPluginDev
spacer
Copyright © 2015 Atomikos BVBA. Transaction Management for Extreme Transaction Processing and SOA Environments serving ISV, Commercial, OEM and Open Source Markets
Site map RSS ATOM