Difference: HeadlinesPlugin (4 vs. 5)

Revision 52011-07-17 - TWikiContributor

Line: 1 to 1
 

Headlines Plugin

Changed:
<
<
>
>
  Show headline news in TWiki pages based on RSS and ATOM news feeds from external sites
Line: 15 to 15
  This plugin displays RSS and ATOM feeds from news sites. Use it to build news portals that show headline news.
Changed:
<
<
Note: Syndic8.com ( http://www.syndic8.com/ ) lists many RSS feeds.
>
>
Note: Syndic8.com ( http://www.syndic8.com/ ) lists many RSS and ATOM feeds.
 
Added:
>
>
 

Syntax Rules

%HEADLINES{"..."}%

Parameter Explanation Default
Changed:
<
<
"..." source of RSS feed; this can be an url (starting with http) or a web.topic location for internal feeds None; is required
>
>
"..." 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
Changed:
<
<
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)
>
>
| 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
Changed:
<
<
| 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)
>
>
| 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
Added:
>
>
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

Changed:
<
<
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
>
>
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)
Changed:
<
<
  • $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)
>
>
  • $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

Line: 80 to 79
 

Rendering the content namespace

Changed:
<
<
The variable $content is refering to the <content:encoding> content </content:encoding>.
>
>
The variable $content is referring to the <content:encoding> content </content:encoding>.
 

Examples

Line: 111 to 110
 

Plugin Settings

Changed:
<
<
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.
>
>
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.
 
Changed:
<
<
  • 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. Set to 0 to disable caching:
    • Set HEADLINESPLUGIN_REFRESH = 60
 
Changed:
<
<
  • Refresh rate in minutes for cached feeds. Disable caching: 0, default: 60
    • Set REFRESH = 60
>
>
  • Maximum number of items shown:
    • Set HEADLINESPLUGIN_LIMIT = 100
 
Changed:
<
<
  • Maximum number of items shown. Default: 100
    • Set 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
 
Changed:
<
<
  • Use LWP::UserAgent, or fallback to TWiki's internal getUrl() method. Default: yes
    • Set USELWPUSERAGENT = yes
>
>
  • Timeout fetching a feed using the LWP::UserAgent:
    • Set HEADLINESPLUGIN_USERAGENTTIMEOUT = 20
 
Changed:
<
<
  • 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
>
>
  • Name of user agent:
    • Set HEADLINESPLUGIN_USERAGENTNAME = TWikiHeadlinesPlugin/2011-07-08
 
  • Default header: (variables are explained in the syntax rules)
Changed:
<
<
    • Set HEADER =
      $n---+!! $title
      $date
      $description
      $rights
>
>
    • Set HEADLINESPLUGIN_HEADER =
      $n---+!! $title
      $date
      $description
      $rights
 

  • Default format of one item: (variables are explained in the syntax rules)
Changed:
<
<
    • Set FORMAT =
      $n$date $creator $subject $n
      $description
>
>
    • Set HEADLINESPLUGIN_FORMAT =
      $n$date $creator $subject $n
      $description
 

  • Values taken from configure: (only supported if CPAN:LWP is installed)
Line: 152 to 148
  The default HEADER and FORMAT settings use the following styles. See the style.css file defining the default CSS properties (indentation illustrates enclosure).
Changed:
<
<
  • 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)
>
>
  • 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

Changed:
<
<
  • Download the ZIP file.
  • Unzip it in your twiki installation directory. Content:
>
>
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:
Changed:
<
<
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.
>
>
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
Added:
>
>
  • 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

Added:
>
>
  • 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
Changed:
<
<
Copyright: © 2002-2010, Peter Thoeny, Twiki, Inc.; 2005-2007, Michael Daum http://wikiring.de
>
>
Copyright: © 2002-2011 Peter Thoeny, Twiki, Inc.
© 2005-2007 Michael Daum http://wikiring.de
 
License: GPL (GNU General Public License)
Changed:
<
<
Plugin Version: v2.6 - 2010-05-16
>
>
Plugin Version: 2011-07-17
 
Change History:
<-- specify latest version first -->
 
Changed:
<
<
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
>
>
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
Line: 216 to 226
 
Feedback: http://TWiki.org/cgi-bin/view/Plugins/HeadlinesPluginDev
Appraisal: http://TWiki.org/cgi-bin/view/Plugins/HeadlinesPluginAppraisal
Changed:
<
<
Related Topics: TWikiPlugins, AdminDocumentationCategory, TWikiPreferences
>
>
Related Topics: VarHEADLINES, TWikiPlugins, AdminDocumentationCategory, TWikiPreferences
 
This site is powered by the TWiki collaboration platform Powered by PerlCopyright © 1999-2019 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding URCS? Send feedback
Note: Please contribute updates to this topic on TWiki.org at TWiki:TWiki.HeadlinesPlugin.