Headlines Plugin

Show headline news in TWiki pages based on RSS and ATOM news feeds from external sites

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:

Fri, 29 May 2015 21:57:41 +0000
The original blog about business opportunities and business ideas for small business entrepreneurs
Fri, 29 May 2015 21:57:41 +0000 Erin Eagan

There may be no more successful franchise opportunity in the world than a Subway franchise. Starting from humble beginnings in one of the smallest states in the country - Connecticut - Subway has grown into an international brand, one that appeals to customers across pretty much every demographic there is.

RELATED: TOP 10 FRANCHISES OF 2015

Its high profile is one of the reasons that many aspiring franchisees look into owning their own Subway franchises. But, what does that look like? That's what we're going to be exploring below.

The Subway Concept

Unless you've been living underneath a rock for the past several decades, you know what a Subway restaurant is all about. Subway bills itself as a healthy alternative to the numerous fast-food franchises that are out there. While whether or not Subway is actually healthier or not is open to debate, no one can deny the success of its marketing campaigns along these lines. Just consult any of the numerous Subway advertisements that you'll see on television, which feature well-known sports figures.

How Does Subway Look to the Aspiring Franchisee?

Subway's success-which you've probably heard plenty about-is backed up by great numbers. Currently, there are Subway franchises in nearly 100 countries around the world, and Subway is poised to expand that even further.

Within the United States itself, there are currently just shy of 27,000 Subway franchises alone, from stand-alone locations to those located in malls, train stations and airports.

While the number of locations in the United States has grown by approximately 2,000 in the past five years, internationally the growth is even more staggering. Just over 4,000 more locations have opened outside of the U.S. within the past five years.

In order to open your own Subway franchise, you'll have to be prepared to make a significant investment, and Subway demands that its franchisees have a net worth of $80,000 at a minimum. How large the upfront investment is will depend upon the location that you select, with stand-alone locations requiring more capital. At a minimum, approximate $116,000 will be required to open a location, with a $15,000 franchise fee in addition.

RELATED: SUBWAY COMMITTED TO PROPER TREATMENT OF ANIMALS

One thing that's worth noting is that Subway offers incentives for franchisees that will be opening locations at government and military sites. In this case, Subway will completely waive the franchise fee for the franchisee. If the franchisee receives government funding to open his or her location, but it is not located on a government or military site, there is a 50 percent discount on the franchise fee available, as well.

Is It Time to Become a Sandwich Artist?

As you can see, there are many reasons that you may want to consider becoming a Subway franchisee. With Subway attempting to expand aggressively, especially in government, military and international markets, there's plenty of opportunity to be had! Of course, Subway isn't the only game in town when it comes to healthy alternatives to fast food. So, as you research Subway, be sure to keep other franchise opportunities in mind, like those afforded by Panera Bread, and others, for example.

For more information about owning a franchise, visit the Subway website.

Fri, 29 May 2015 17:13:15 +0000 Erin Eagan

Your earliest days as an entrepreneur can be a bit lonely. It's not like you have an office full of people to talk to. Furthermore, being an entrepreneur almost always means you're acting as a kind of pioneer. There's no one who's been down this path already, so there's no one to turn to for advice. This is where some good books on entrepreneurship can make a big difference. Not only will they have plenty of advice available, they'll also remind you that others have faced these challenges before and succeeded.

RELATED: TOP 6 PODCASTS FOR ENTREPRENEURS

The 4-Hour Workweek

When Tim Ferris' The 4-Hour Workweek debuted nearly 10 years ago, it was met with a lot of skepticism. The very title can pretty much tell you why. However, since then, it's gone on to be a bestseller and inspired millions.

Your entrepreneurial idea may not lend itself to an actual workweek of just four hours. Fortunately, Ferris' book will still have plenty to offer you with lessons on things like innovation, marketing, hiring and more.

The $100 Startup

Has your entrepreneurial spirit been hampered by the fact that your budget isn't very impressive? Chris Guillebeau wrote a book just for you. The $100 Startup isn't about how to get started with just $100 though. Instead, it presents case study after case study about people who were in your shoes and still succeeded. The best part is that even though it isn't strictly a ''how-to'' book, you'll still finish it with plenty of ideas for how to move forward.

The E-Myth Revisited

Here's essential reading for every entrepreneur. You could have the world's best idea and all the money you need to get it off the ground yet still fail. In his book, Michael E. Gerber details what it takes for an entrepreneur to succeed. It's not just about what to do right; it has just as much to do with the mistakes you need to avoid. A lot of times, people fail before they ever get started because bad assumptions stand in their way. Don't let this happen to you!

Crush It!

This book only weighs in at about 125 pages, but it packs a serious punch. Big names like Tim Ferris, Tony Robbins, Kevin Rose and Pat Flynn have all endorsed it as well. The author, Gary Vaynerchuck, is the son of immigrants who came to America from the former U.S.S.R. His father began small, working as a stock boy at a liquor store before starting on his own. Then Vaynerchuck helped take the family business to another level, multiplying their sales by 1,000%. Best of all, he did it his way and had fun the entire time. If you've been sitting on an idea you've always wanted to pursue, but just haven't been able to take that first step, let Gary Vaynerchuck tell you why there has never been a better time to get going and absolutely crush it.

RELATED: INDISPENSABLE TOOLS FOR TODAY’S ENTREPRENEUR

Don't think that being an entrepreneur means you have to go it alone, even if you're a one-person operation. Instead, add the above books to your library and read them over and over.

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-2010, Peter Thoeny, Twiki, Inc.; 2005-2007, Michael Daum http://wikiring.de
License: GPL (GNU General Public License)
Plugin Version: v2.6 - 2010-05-16
Change History:  
2010-05-16: TWikibug:Item6433 - more doc improvements
2010-04-25: TWikibug:Item6433 - doc fix: Changing TWIKIWEB to SYSTEMWEB
2010-02-27: TWikibug:Item6313 - fixed bug in ATOM feed with <link ...></link> instead of <link ... /> -- Peter Thoeny
2009-09-30: fixed bug in lastBuildDate of feeds affecting touch parameter functionality -- Peter Thoeny
2009-08-29: 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: http://TWiki.org/cgi-bin/view/Plugins/HeadlinesPlugin
Feedback: http://TWiki.org/cgi-bin/view/Plugins/HeadlinesPluginDev
Appraisal: http://TWiki.org/cgi-bin/view/Plugins/HeadlinesPluginAppraisal

Related Topics: TWikiPlugins, AdminDocumentationCategory, TWikiPreferences

Topic revision: r1 - 2010-05-17 - TWikiContributor
 
This site is powered by the TWiki collaboration platformCopyright © 1999-2015 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.