| 1 |
# Super RSS Reader - Add attractive RSS Feed Widget |
| 2 |
Contributors: vaakash |
| 3 |
Author URI: https://www.aakashweb.com/ |
| 4 |
Plugin URI: https://www.aakashweb.com/wordpress-plugins/super-rss-reader/ |
| 5 |
Tags: rss, widget, ticker, feed, news, twitter, admin, plugin, posts, page, thumbnail, atom, shortcode |
| 6 |
License: GPLv2 or later |
| 7 |
Donate Link: https://www.paypal.me/vaakash |
| 8 |
Requires at least: 5.3 |
| 9 |
Requires PHP: 5.3 |
| 10 |
Tested up to: 6.0.1 |
| 11 |
Stable tag: 4.7 |
| 12 |
|
| 13 |
Display any RSS feed(s) in widget with news ticker effect in multiple tabs, thumbnails, customizable color themes and more. |
| 14 |
|
| 15 |
## Description |
| 16 |
|
| 17 |
Super RSS Reader plugin allows you to display RSS feed(s) in an attractive way to your widget. It has options to display multiple RSS feeds separated by tabs in a single widget and has feature to add a news ticker like effect to it. See the features list below for complete list. |
| 18 |
|
| 19 |
The widget is fully customizable with external styles and also has color themes out of the box. It is a perfect replacement for the default RSS widget in WordPress. |
| 20 |
|
| 21 |
[Check out the **LIVE DEMO** of the plugin](https://www.aakashweb.com/demos/super-rss-reader/) |
| 22 |
|
| 23 |
### ✨ Features |
| 24 |
|
| 25 |
* **News ticker** - Add news ticker like effect to the RSS feeds (can turn on of off) |
| 26 |
* **Multiple tabs** - Display multiple feeds in one widget separated by tabs. |
| 27 |
* **Thumbnail** - Display the thumbnail of the feed item. |
| 28 |
* **Color themes** - Options of multiple color themes out of the box. Customizable via CSS. |
| 29 |
* Different **thumbnail positions** (align left, right and cover) |
| 30 |
* Customizable ticker speed. |
| 31 |
* Different **date formats** for feed item (absolute and relative) |
| 32 |
* Supports RSS and atom feed. |
| 33 |
* Trim title and description text of the feed item. |
| 34 |
* **Order** feed items by date or random. |
| 35 |
|
| 36 |
### 🌄 Display RSS feeds like |
| 37 |
|
| 38 |
* Your own website content like recent posts, comments, forum topics etc. |
| 39 |
* Articles, posts from related websites and share with your users. |
| 40 |
* Events, job listings etc. from other websites. |
| 41 |
* Deals, Craigslist etc. You got it, any RSS feed on your site ! |
| 42 |
|
| 43 |
[youtube=https://www.youtube.com/watch?v=02aOG_-98Tg] |
| 44 |
|
| 45 |
### 💎 PRO version |
| 46 |
|
| 47 |
Super RSS reader has a PRO version which has more features to further enhance and to get more control of the RSS feed you display. With the PRO version you can enjoy below additional features included and also support the development of this plugin. |
| 48 |
|
| 49 |
* **Shortcode** - Display RSS feed anywhere in your website using `[srr_feed]` |
| 50 |
* **Grid display** - Display feed item in rows and columns |
| 51 |
* **Filter by keyword** - Show/hide feed items based on keyword |
| 52 |
* **Custom feed item template** - Change order of feed item content, add HTML |
| 53 |
* **Fetch thumbnail** - Forcefully fetches the thumbnail from feed URL |
| 54 |
* **4 new** color themes |
| 55 |
|
| 56 |
[**More information**](https://www.aakashweb.com/wordpress-plugins/super-rss-reader/?utm_source=readme&utm_medium=description&utm_campaign=srr-pro) - [Live demo](https://wpdemos.aakashweb.com/super-rss-reader/?utm_source=readme&utm_medium=description&utm_campaign=srr-pro) |
| 57 |
|
| 58 |
### Resources |
| 59 |
|
| 60 |
* [FAQs](https://www.aakashweb.com/docs/super-rss-reader/faq/) |
| 61 |
* [Documentation](https://www.aakashweb.com/docs/super-rss-reader/) |
| 62 |
* [Support forum](https://www.aakashweb.com/forum/discuss/wordpress-plugins/super-rss-reader/) |
| 63 |
|
| 64 |
## Installation |
| 65 |
|
| 66 |
Download and upload the latest version of Super RSS Reader, |
| 67 |
|
| 68 |
1. Unzip & upload it to your WordPress site. |
| 69 |
1. Activate the plugin. |
| 70 |
1. Drag and drop the "Super RSS Reader" widget in the "Widgets" page. |
| 71 |
1. Input a RSS feed URL to the widget, tweak some settings and you are, |
| 72 |
1. Done ! |
| 73 |
|
| 74 |
## Frequently Asked Questions |
| 75 |
|
| 76 |
### My RSS feed is not refreshing ! |
| 77 |
|
| 78 |
By default WordPress caches the RSS feed for 12 hours. You can change this default value by adding the below code to your theme's function.php file. |
| 79 |
|
| 80 |
`add_filter( 'wp_feed_cache_transient_lifetime', function($a) { return 600; } );` |
| 81 |
|
| 82 |
Here 600 indicates 10 minutes in seconds. Please note that setting lower value will increase the load on the server to refresh the RSS cache. |
| 83 |
|
| 84 |
You can also refer this post https://wordpress.org/support/topic/rss-not-updating-no-matter-which-plugin-i-try/#post-10123881 to change the refresh time for particular feed URL. |
| 85 |
|
| 86 |
Also, please ensure WordPress cache plugins (like W3 total cache, Super cache etc.) are configured to not cache the page where this widget is active or increase the expiry of the cache so that old cached page is not served to the users. |
| 87 |
|
| 88 |
### How can I customize the RSS widget via CSS styles ? |
| 89 |
|
| 90 |
There is a list of CSS classes which are available to take control and customize the RSS feed to the design as intended. The complete list of CSS classes can be found in [this page](https://www.aakashweb.com/docs/super-rss-reader/faq/) |
| 91 |
|
| 92 |
### RSS feed is not displayed or error is shown |
| 93 |
|
| 94 |
This can happen when, |
| 95 |
|
| 96 |
* The RSS feed URL is invalid. |
| 97 |
* The feed URL is not accessible by the server. |
| 98 |
* The feed content is not in the expected format or corrupt. Please use a [feed validation service](https://validator.w3.org/feed/) to validate the feed. |
| 99 |
|
| 100 |
### Does this plugin support horizontal ticker ? |
| 101 |
|
| 102 |
No, Super RSS Reader only supports vertical support feature for now. |
| 103 |
|
| 104 |
### How to display the feeds in multiple tabs ? |
| 105 |
|
| 106 |
Enter the RSS feed URLs separated by comma or in new line in the widget, the plugin automatically renders the tab. |
| 107 |
|
| 108 |
### What are the contents shown in the feed ? |
| 109 |
|
| 110 |
By default content like title, date, author, description, thumbnail can toggled to show in the feed. |
| 111 |
|
| 112 |
### Can I change the order of the content shown in the feed ? |
| 113 |
|
| 114 |
Yes, it is possible with the [PRO version](https://www.aakashweb.com/wordpress-plugins/super-rss-reader/?utm_source=readme&utm_medium=faq&utm_campaign=srr-pro) of the plugin. In the free version we can toggle the content. |
| 115 |
|
| 116 |
### Will the additional ticker effect slow down the site ? |
| 117 |
|
| 118 |
The additional effect needs only 2.5 KB of additional JavaScript file which is very small since it is minified and optimized already. |
| 119 |
|
| 120 |
[More FAQs in this page](https://www.aakashweb.com/docs/super-rss-reader/faq/) |
| 121 |
|
| 122 |
## Screenshots |
| 123 |
|
| 124 |
1. Super RSS Reader widgets shown in the sidebar, having a ticker effect and in tabbed mode. |
| 125 |
1. RSS feed widget in different themes and for different feed URLs. |
| 126 |
1. Some more examples of the RSS feed. |
| 127 |
1. Widget options. |
| 128 |
|
| 129 |
[Live working demo](https://www.aakashweb.com/demos/super-rss-reader/) |
| 130 |
|
| 131 |
## Changelog |
| 132 |
|
| 133 |
### 4.7 |
| 134 |
* New: Support for lazy loading is enabled for thumbnails. |
| 135 |
* New: WordPress requirement is updated. |
| 136 |
* Fix: Enhancements to widget form and feed output sanitization. |
| 137 |
|
| 138 |
### 4.6 |
| 139 |
* New: Option to choose timezone for the date of feed items. |
| 140 |
* Fix: Set default link URL when feed item has no link. |
| 141 |
* Fix: Break tags are retained in the feed description. |
| 142 |
|
| 143 |
### 4.5 |
| 144 |
* New: Display feed item date in relative format. |
| 145 |
* Fix: Minor enhancements to widget admin UI. |
| 146 |
|
| 147 |
### 4.4.1 |
| 148 |
* Fix: All feed items were displayed when "Order by" is selected as "default" |
| 149 |
|
| 150 |
### 4.4 |
| 151 |
* New: Option to prefer full content or summary to display as feed description. |
| 152 |
* New: Default ordering option. |
| 153 |
* New: Option to change no feed item text. |
| 154 |
* Fix: Bug with select field in widget form. |
| 155 |
* Fix: Read more link being displayed when description is empty. |
| 156 |
|
| 157 |
### 4.3 |
| 158 |
* New: Option to order/sort feed items by date, random. |
| 159 |
* New: Filter hook to customize thumbnail URL. |
| 160 |
|
| 161 |
### 4.2 |
| 162 |
* Fix: Ticker sometimes gets stuck when browser tab is switched or not viewed. |
| 163 |
* New: Featured image is automatically inserted into local RSS feed to show as thumbnail if the post has no image in it. |
| 164 |
|
| 165 |
### 4.1 |
| 166 |
* New: Option to change date format |
| 167 |
* New: Date will now be in the same language as the site. |
| 168 |
* New: Option to set default thumbnail image if not present. |
| 169 |
* New: Filter hook to customize the feed item's HTML. |
| 170 |
|
| 171 |
### 4.0.1 |
| 172 |
* Fix: Added hover style for the tabs and on active style when no theme is selected. |
| 173 |
* New: Tested with WordPress 5.6 |
| 174 |
|
| 175 |
### 4.0 |
| 176 |
* New: Reliable thumbnails. Thumbnails will now be taken from multiple places like feed content. |
| 177 |
* New: Thumbnail positions (align left, right and cover mode) and size can be changed. |
| 178 |
* New: Widget options are now more refined, easy to find and use. |
| 179 |
* New: Plugin is now translation ready. |
| 180 |
* New: `noreferrer` added to the feed links. |
| 181 |
* New: Stripe of feed items is now done using CSS class `srr-stripe` instead of `even`. |
| 182 |
* New: Introducing [PRO version](https://www.aakashweb.com/wordpress-plugins/super-rss-reader/?utm_source=readme&utm_medium=changelog&utm_campaign=srr-pro). |
| 183 |
|
| 184 |
### 3.2 |
| 185 |
* Fix: Read more link not present |
| 186 |
* New: Widgets settings is now clean and easy to use. |
| 187 |
* New: Thumbnail and description can now be displayed separately. |
| 188 |
* New: Description and title text are now trimmed by "words" instead of "characters". |
| 189 |
* New: `Enable ticker` option is now replaced with `Display type`. |
| 190 |
* Fix: Refactor code. |
| 191 |
* Fix: Undefined index notice upon saving the widget. |
| 192 |
|
| 193 |
### 3.1 |
| 194 |
* Fix: Settings not being saved. |
| 195 |
* New: Updated the ticker library to the latest. |
| 196 |
* Fix: Added cache buster to JS and CSS files. |
| 197 |
* Fix: Upon tab change, sometimes ticker height gets to 0; |
| 198 |
|
| 199 |
### 3.0 |
| 200 |
* New: Plugin code is refactored. |
| 201 |
* New: Options are reorganized for easy configuration. |
| 202 |
* Fix: Minor UI changes. |
| 203 |
* Fix: Certain PHP notices on saving widget settings. |
| 204 |
|
| 205 |
### 2.8 |
| 206 |
* New: jQuery ticker script is now loaded locally. |
| 207 |
* Fix: Minor style adjustments to the admin widget. |
| 208 |
|
| 209 |
### 2.7 |
| 210 |
* New: Support for "no follow" attribute in links. |
| 211 |
* Fix: Readme with updated FAQ. |
| 212 |
|
| 213 |
### 2.6 |
| 214 |
* New: Ability to set fixed height for the RSS widget. |
| 215 |
* New: Using minified JavaScript on frontend. |
| 216 |
* Fix: Cleaned widget UI, reordered options. |
| 217 |
* Fix: Code refactoring. |
| 218 |
|
| 219 |
### 2.5 |
| 220 |
* Added feature to change individual tab titles/names. |
| 221 |
* Added feature to enable rich or full description. |
| 222 |
* Fixed feed ordering issues. |
| 223 |
* Updated jQuery easy ticker plugin to v2.0. |
| 224 |
* Minor code revisions. |
| 225 |
|
| 226 |
### 2.4 |
| 227 |
* Added feature to cut down/strip feed titles. |
| 228 |
* Added a new 'Simple modern' color style. |
| 229 |
|
| 230 |
### 2.3 |
| 231 |
* Fixed incompatibility of other jQuery plugins due to the usage of the latest version of jQuery. |
| 232 |
|
| 233 |
### 2.2 |
| 234 |
* Displays "thumbnail" of the feed item if available. |
| 235 |
* Added setting to change ticker speed. |
| 236 |
* Added setting to edit the "Read more" text. |
| 237 |
* Default styles are revised. |
| 238 |
* Switched to full size ticker code. |
| 239 |
* Core code revised. |
| 240 |
|
| 241 |
### 2.1 |
| 242 |
* Added option to open links in new window. |
| 243 |
* Changed the method to include the scripts and styles. |
| 244 |
* Added a new 'Orange' color style. |
| 245 |
|
| 246 |
### 2.0 |
| 247 |
* Core code is completely rewritten. |
| 248 |
* Flash RSS Reader is removed and instead jQuery is used. |
| 249 |
* Administration panel used in the previous version is removed and settings are configured in the widget itself. |
| 250 |
|
| 251 |
### 0.8 |
| 252 |
* Second version with included CSS and Proxy file (loadXML.php). |
| 253 |
|
| 254 |
### 0.5 |
| 255 |
* Initial version with a flash RSS Reader |
| 256 |
|
| 257 |
## Upgrade Notice |
| 258 |
|
| 259 |
Version 2.0 is a major and recommended upgrade for previous version users. |
