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:

Mon, 30 Mar 2015 18:06:26 +0000
The original blog about business opportunities and business ideas for small business entrepreneurs
Mon, 30 Mar 2015 18:01:03 +0000 Guest Poster

It is popular today for people to want to be their own boss. Ads relating to entrepreneurship are all over the Internet and some people are probably talking about it at work. There definitely is a push for people to start their own business. Before launching out on your own new business, however, there are five things you need to know.

1. Do Your Research

Every idea sounds good on the surface. It is necessary to take a serious look at every aspect of it - both the pros and the cons. Know where your weak points are and either hire someone else for those tasks, or dig in and learn how to do them yourself.

Take time to develop a realistic and thorough business plan. It will prepare you for possible problems later on, and it will help you stay on track, if you refer to it often.

2. Know How to Sell

You also need to carefully study the market. You need to know who your target market is, what will trigger them to buy from you, and who your competitors are. A new business will only succeed if you can sell your product or services to those in need of them.

Learn what marketing methods work and stick to it. Then, add new methods as needed. If you plan to sell online, realize that what worked five years ago may not be as effective today. This demands that you need to be constantly learning new methods, as well as learning how to perfect and test methods you will use to get started.

3. Calculate the Cost

There will certainly be considerable cost involved with starting your own business. As a general rule, it will likely cost more than you think it will to get the business off the ground. Find out how much income or savings you need to live on for the next six months, and if you can’t get it, be sure to keep on working. Many people start a business as a side job and then quit their full-time job after the new business becomes successful.

Understanding the cost also means that you need to have calculated a point where you need to exit the business before it destroys you financially. You need to know the breakeven point and get out while your own finances are still intact - if need be.

4. Be Determined

Determination and good old-fashioned bull-doggedness will help you succeed when other things won’t. You will have to have a good amount of self-discipline to be your own boss, even when you don’t feel like getting out of bed. Long hours will most likely be necessary at the start, and you will have to push yourself to do some tasks that are not as enjoyable to you, such as marketing, accounting, design, selling, talking with clients, etc.

5. Get Started

Instead of continuing to want to start your business “someday,” you need to set a start date, and stick to it. Get everything ready for that day and make sure you have everything you need at that time. Let everyone around you know in advance, then launch your new business and enjoy it.

Sun, 29 Mar 2015 15:27:52 +0000 Dane Carlson

If you're currently in the process of trying to get a business opportunity off the ground, it might be best to read advice from some entrepreneurial heavyweights that have blazed the trail before you that you intend to walk. Below you'll find a collection of inspirational bits of wisdom from some names that you might be familiar with and some that you might not be. As they say, good artists borrow, and great artists steal. The same is true in business. So take the time to think over and internalize what these entrepreneurs have had to say:

Dale Carnegie
''Most of the important things in the world have been accomplished by people who have kept on trying when there seemed to be no hope at all.'' - Dale Carnegie

As the prototypical entrepreneur, Dale Carnegie needs no introduction. Here, he lays it out plain: If you're going to be successful in any of your business endeavors, you need to expect failure and be prepared to forge on regardless.

Bill Gates
Some might say that Bill Gates is the Dale Carnegie of his generation. Known originally for founding Microsoft, Bill has become increasingly better known for his philanthropy work across the globe. ''We always overestimate the change that will occur in the next two years and underestimate the change that will occur in the next ten. Don’t let yourself be lulled into inaction.'' - Bill Gates

While it could be argued that Microsoft failed to heed Bill's advice, that doesn't make it any less true. As an entrepreneur you have to be adaptable, and you've got to keep your eye toward the future, even while you're focusing on what's right in front of you.

Jeff Bezos
Jeff is the founder of Amazon, which is so ubiquitous that it almost needs no introduction.

''In the old world, you devoted 30% of your time to building a great service and 70% of your time to shouting about it. In the new world, that inverts.'' - Jeff Bezos

Amazon succeeded because it offered consumers a service that once seemed impossible, not because it had glitzy advertisements. Do what you do as well as it can be done, and the rest will follow.

Oprah Winfrey
If there's one person that knows how to build and cultivate a brand, it's Oprah Winfrey. She's been a ubiquitous cultural force for the past several decades, and she doesn't show any signs of slowing down.

''I had no idea that being your authentic self could make me as rich as I've become. If I had, I'd have done it a lot earlier.'' - Oprah Winfrey

What Oprah says is true: If you want to be successful at anything, you have to be yourself. People can smell authenticity, and people are drawn to it. Try to leave that mark of authenticity upon your own business.

Arianna Huffington
Always in the national spotlight, Arianna Huffington quietly moved from cable news networks to found the Huffington Post which embodies - and some might say heralded - the new age of journalism.

''A lot of my ideas come in moments of peace, relaxation, hiking and reading. Something completely unrelated. Not in moments of dealing with my email or cleaning out my inbox.'' - Arianna Huffington

In spite of all the stress related to running a media empire, Arianna still finds time to relax, and you should too. While we sometimes think we need to eat and sleep our businesses, taking a step back can make the ground fertile for further innovation!

Daymond John
You've likely seen Daymond on ABC's ''Shark Tank'', and if you have, then you know that he's a brand specialist who built the popular apparel brand FUBU from the ground up.

''When looking at trends I always ask myself basic and timeless questions about business, and the one I seem to always come back to is, ‘How is this different than anything else in the marketplace?''' - Daymond John

In this day and age, where everything is pitched as the latest and greatest thing, this simple advice is sage advice. Like Daymond says, always remember to take a step back and really think about whether that new thing is all that it's cracked up to be.

Steve Jobs
Unless you've been living underneath a rock for the past decade, you likely already know who Steve Jobs is. He's the magnetic late founder of Apple, whose various products seem to never be very far from reach.

''Remembering that you are going to die is the best way I know to avoid the trap of thinking you have something to lose. You are already naked. There is no reason not to follow your heart.'' - Steve Jobs

As with anything in life, it's important to remember that death is the great equalizer. So, while you're in this world, take risks and do something. With nothing to lose, you can find the spark to be the truly successful entrepreneur you want to be.

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.