Tags:
create new tag
, view all tags

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 and ATOM feeds.

Syntax Rules

%HEADLINES{"..."}%

Parameter Explanation Default
"..." Source of RSS or ATOM 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
header="..." Header. May 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. May 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
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

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. Note that some of the variables are already used above. This is done by purpose to use different feeds with the same formatting parameters. If there's a conflict the non-dc tags have higher precedence, i.e. a <title> content </title> is preferred 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 referring 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, 24 Oct 2014 04:11:06 +0000
The original blog about business opportunities and business ideas for small business entrepreneurs
Fri, 24 Oct 2014 04:09:21 +0000 Dane Carlson

Why work from home in Raleigh, North Carolina ($5,139 per month) when you can work from home in Chiang Mai, Thailand ($641 per month) with the same internet speed?

NomadList has combined data on internet speed, the cost of rental housing and food, local weather conditions including air quality and other factors to come up with a useful list of the best cities in which to live and work remotely.

The only city in the United States in the top 10? San Juan, Puerto Rico.

Fri, 24 Oct 2014 00:22:51 +0000 Dane Carlson

Seva is a fast-casual beauty spa franchise with an unique strategy of locating their spas in places that maximize one-stop-shopping. I recently spoke with the founder and COO Vas Maniatis.

My questions are below in bold, and there’s a video of a Seva grand opening at the bottom of the this interview, so be sure to read to the end.


Where did the idea for Seva come from?

A trip to the Little India neighborhood on Chicago’s northside in 1999 to watch my girlfriend (now wife of 14 years) get her eyebrows threaded. I had never heard of threading nor for that matter noticed peoples’ eyebrows but she dragged me along anyway. Our original concept took the threading technique to the masses via Walmart under the name Simply Eyebrows but eventually expanded into Seva, which is the pioneer of the fast-casual spa.

How did you bring it to life?

Strategically and methodically coupled with some electrical diodes hooked up to my temples and a perfectly-timed bolt of lightning. Initially we opened corporate-owned locations and expanded successfully into multiple states. After proving the concept we began franchising across the USA in mid-2010.

Where do you see Seva in five years?

Bringing Beauty to the People (R) across the USA and internationally. I expect we will have at least 1001 studios in five years in all 51 States (Puerto Rico will be granted Statehood by then). Put it into your calendar to touch base with me 5yrs from today to check back in.

If you were to start again, what would you do differently?

Not a thing. Ok, I’d have more money to start with…

What does your typical day look like?

Up early. Read Wall St Journal & Tech Crunch. Work till noon. Exercise mid-day (alternate Run, Swim, Jiu-Jitsu). Go in to office and work some more. Go home and work some more. Sleep. Repeat.

What's your role?

My role at my company is Strategic Development as the COO and keeping the teams aligned on the initiatives and daily operations.

seva-location

What is one trend that really excites you?

Backyard chickens.

What is the worst job you’ve ever had and what have you learned from it?

Washing dishes at my father’s restaurant after I got into an argument with the Dishwasher who then proceeded to walk out in the midst of a packed Sunday brunch. Ruined the only nice pair of clothes I’ve ever owned. 

As an entrepreneur, what is the one thing you do over and over and recommend everyone else do, too?

Protocol everything. Commoditize the commoditizable.

What is one failure you had as an entrepreneur, and how did you overcome it?

My 1st venture after college in the 900# business: 1-900-FOR-RENT AND 1-900-FOR-JOBS. Ameritech pulled the plug on the whole concept mid-stream and left me hanging. Just kept on keeping on.

What is one business idea that you are willing to give away to our readers?

Zambot ™- Picture a large Roomba to resurface the ice at an ice rink instead of the outdated Zamboni.

If you could change one thing in the world, what would it be and how would you go about it?

Put women in charge of everything. I’d start by voting for Hillary.

What are your three favorite online tools or resources and what do you love about them?

Dropbox, Skype, Spotify. The 1st two are transformational for business. The latter for my personal enjoyment of music.

What is one book that you recommend our community should read and why?

The 4-Hour Workweek by Timothy Ferris. Tells you how to take advantage of a flattened world and maximize your time, which at the end of the day is the only valuable commodity.

Three people we should follow on Twitter and why?

I don’t use Twitter. I’d suggest taking three selfies instead.

When was the last time you laughed out loud? What cause it?

After I answered the above question.

Who is your hero?

My dad. He was the greatest!

Do you (or did you ever) have a mentor?

Again I’d say my dad was.

Tell us a secret.

That is a trick question.

What are Seva’s website?

Consumer: http://sevabeauty.com

Franchise: http://www.sevabeautyfranchise.com

Where can people find Seva on social media?

Twitter: https://twitter.com/sevabeauty

Facebook: https://www.facebook.com/SevaBeauty

Thank you for taking the time to talk with us today! Here’s that video:

Plugin Settings

Plugin settings are stored as preferences settings. Do not change the settings here, they are here only for illustration purposes showing the default values. Define the settings in Main.TWikiPreferences. For example, to customize the HEADLINESPLUGIN_USERAGENTNAME setting, add a * Set HEADLINESPLUGIN_USERAGENTNAME = ... bullet in Main.TWikiPreferences.

  • Refresh rate in minutes for cached feeds. Set to 0 to disable caching:
    • Set HEADLINESPLUGIN_REFRESH = 60

  • Maximum number of items shown:
    • Set HEADLINESPLUGIN_LIMIT = 100

  • Use LWP::UserAgent if set to 1, or fallback to TWiki's internal getUrl() method if set to 0:
    • Set HEADLINESPLUGIN_USELWPUSERAGENT = 1

  • Timeout fetching a feed using the LWP::UserAgent:
    • Set HEADLINESPLUGIN_USERAGENTTIMEOUT = 20

  • Name of user agent:
    • Set HEADLINESPLUGIN_USERAGENTNAME = TWikiHeadlinesPlugin/2011-07-08

  • Default header: (variables are explained in the syntax rules)
      * Set HEADLINESPLUGIN_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 HEADLINESPLUGIN_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

Note: You do not need to install anything on the browser to use this plugin. The following instructions are for the administrator who installs the plugin on the TWiki server.

  • For an automated installation, run the configure script and follow "Find More Extensions" in the in the Extensions section.

  • Or, follow these manual installation steps:
    • Download the ZIP file from the Plugins home (see below).
    • Unzip HeadlinesPlugin.zip in your twiki installation directory. Content:
      File: Description:
      data/TWiki/HeadlinesPlugin.txt Plugin topic
      pub/TWiki/HeadlinesPlugin/style.css Default CSS
      lib/TWiki/Plugins/HeadlinesPlugin.pm Plugin Perl module
      lib/TWiki/HeadlinesPlugin/Core.pm Plugin core
    • Set the ownership of the extracted directories and files to the webserver user.
    • 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 configuration and testing:
    • Run the configure script, enable the plugin in the Plugins section
    • Configure the plugin: See plugin settings above.
    • Test if the installation was successful: See example above.

Plugin Info

  • 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

Plugin Author: TWiki:Main.PeterThoeny, TWiki:Main.MichaelDaum
Copyright: © 2002-2011 Peter Thoeny, Twiki, Inc.
© 2005-2007 Michael Daum http://wikiring.de
License: GPL (GNU General Public License)
Plugin Version: 2011-07-17
Change History:  
2011-07-17: TWikibug:Item6764: Add VarHEADLINES variable documentation; doc improvements; setting NO_PREFS_IN_TOPIC
2011-07-08: TWikibug:Item6725: Change global package variables from "use vars" to "our"
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: VarHEADLINES, TWikiPlugins, AdminDocumentationCategory, TWikiPreferences

Topic revision: r5 - 17 Jul 2011 - TWikiContributor
 
This site is powered by the TWiki collaboration platformCopyright © 1999-2014 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.