Your world of Magento extensions and themes!

Features

RSS Reader offers numerous features, including:

• Ability to work with numerous feeds
  Create as many RSS Reader occurrences as you need!
• Full control over every option available on a “per instance” basis
  You can override the default options set in the administration panel (see list of configurable options below)
• Enabled caching options
  RSS Reader obtains content from a remote host and stores it in its own cache
• Ability to put RSS Reader occurrences on your pages using Magento CMS pages and blocks
  For store owners, developers and designers, you won’t ever have to edit any files, as this feature can be handled through the administration panel. Need more flexibility? Not a problem! RSS Reader occurrences can be easily culled from Magento layout XML files
• Option to customize CSS and Template files*
  RSS Reader uses its own CSS files and custom template. You can create as many output patterns as needed, using them on a “per instance” basis
  * requires CSS and Magento templating knowledge

Configurable options

RSS Reader options can be easily set up from the administration panel, but if you need more flexibility, you can easily override each option on a “per instance” basis:

• Feed URL
  Specifies the URL of the RSS feed to be read
• Feed title
  Allows you to set up a RSS feed title that will appear above the RSS Reader content
• Articles number
  Sets the number of RSS feed entries to be displayed
• Show summary
  Controls the RSS feed entry content display (if your RSS feed is from a Wordpress blog, it will enable/disable article content display)
• Summary max characters
  Carefully cuts off the summary text so it’s not longer than a specified number of characters without breaking up words
• Summary max words
  Limits the word count in the summary text
• Show date
  Enables/Disables RSS feed entry date display
• Date format
  Sets a date format string (default setting is “d-m-Y H:i:s”, e.g. 04-03-2009 13:51:32)
• Enable links
  Makes links from RSS feed entry titles. The links are then opened in a new window
• Enable cache
  Enables or disables caching as needed
• Cache lifetime (in seconds)
  Allows the user to set up a cache update period (default setting is 86,400 seconds, a.k.a. 24 hours)

With the RSS Reader extension you gain:

• Easy 2-minute installation
• 100% open source
• 30 day money back – satisfaction guaranteed
• Lifetime bug free guarantee
• Meets Magento programming practices for most versions and customizations compatibility
• Free upgrades at least in current version branch
• Our excellent support team is waiting to hear from you each business day from 9:00 am to 5:00 pm GMT

Installation

Clear the store cache under var/cache and all cookies for your store domain. This step eliminates almost all potential problems. It's necessary since Magento uses cache heavily.

1. Backup your store database and web directory
2. Extract the contents of the archive on your computer and navigate inside the extracted AW_Rssreader-X.X folder.
3. Using your FTP client upload 'app' and 'skin' directories to your store root. Agree with any overwrite prompt.
   If you use a different from 'default' theme - be sure to rename folders app/design/frontend/default/default and skin/frontend/default/default to your store's values.

That's all, the installation is complete now. You can proceed to the Configuration section.

Configuration

General configuration options are available in administartion panel: System > Configuration > RSS Reader

There are 2 ways to create RSS Reader instance.

From CMS Manage Pages/Static Blocks

Place the following code in the place(s) where you want RSS Reader instance to be: {{block type="rssreader/list" template="rssreader/list.phtml" feed_url="FEED URL HERE"}} Use CMS of your store for this task. Do NOT insert the line in .phtml files directly.

Below is the list of available options:

feed_url	Required	URL	Specifies the URL of the feed to read.
feed_title	Optional	Text	Allows to setup feed title. It will appear above the RSS Reader content.
articles_number	Optional	Number	Allows to setup feed title. It will appear above the RSS Reader content.
show_summary	Optional	Yes, No	Controls the feed entry content display. If your feed from Wordpress blog it will enable/disable articles content display.
summary_max_chars	Optional	Number	Carefully cuts summary text off not to be longer than specified number of chars (does not break the words).
summary_max_words	Optional	Number	Same way limits the words count in the summary text.
show_date	Optional	Yes, No	Enables/disables feed entry date display.
date_format	Optional	PHP date format string	Sets format for the date. Examples: "F j, Y, g:i a" // March 10, 2001, 5:16 pm "m.d.y" // 03.10.01 "j, n, Y" // 10, 3, 2001 "Ymd" // 20010310 "D M j G:i:s T Y" // Sat Mar 10 15:16:08 MST 2001 "H:i:s" // 17:16:17 Learn more at php.net/date
enable_links	Optional	Yes, No	Makes links from feed entries titles. Links are open in a new window.
enable_caching	Optional	Yes, No	Enables/disables caching.
cache_lifetime	Optional	Number	Allows to setup cache update period. By default it is 86400 seconds or 1440 minutes or 24 hours or 1 day.

Updating XML layout files

We recommend you to work with RSS Reader layout file located here: app\design\frontend\default\default\layout\rssreader.xml This will keep safe your changes during Magento upgrades.

This sample code adds RSS feed from our blog to right column: <?xml version="1.0"?>
<layout version="0.1.0">
  <default>
    <reference name="head">
      <action method="addCss"><stylesheet>css/rssreader.css</stylesheet></action>
    </reference>
    
    <!-- PLEASE ADD YOUR CODE BELOW -->
    
    <reference name="right">
      <block name="aw.feed" type="rssreader/list" template="rssreader/list.phtml">
        <action method="setOption">
          <name>feed_url</name>
          <value>http://ecommerce.aheadworks.com/blog/feed/</value>
        </action>
        <action method="setOption"><name>feed_title</name><value>My First RSS Feed</value></action>
        <action method="setOption"><name>articles_number</name><value>7</value></action>
        <action method="setOption"><name>show_summary</name><value>NO</value></action>
        <action method="setOption"><name>summary_max_chars</name><value>40</value></action>
        <action method="setOption"><name>summary_max_words</name><value>0</value></action>
        <action method="setOption"><name>show_date</name><value>No</value></action>
        <action method="setOption"><name>enable_links</name><value>Yes</value></action>
        <action method="setOption"><name>enable_caching</name><value>Yes</value></action>
        <action method="setOption"><name>cache_lifetime</name><value>86400</value></action>
      </block>
    </reference>

  </default>
</layout>
We set the number of articles equal 7, disabled summary and date display, enabled links and caching.

Troubleshooting

1. After installing the extension the store gives an error, or blank page, or suggests to start Magento installaton procedure.
   Change the owner of the extracted extension files to the web server user and set 775 permissions on them. Clear the store cache and try again.
2. My configuration changes do not appear on the store.
   Clear the store cache, clear you browser cache and domain cookies and refresh the page.

Legend:
+ New feature
* Bug fix

1.2.0
* Several bugs with Magento caching enabled are fixed

1.1.1
+ AW All 2.0 extension integrated

1.1.0
+ "Summary max chars" and "summary max words" configuration parameters added