PluginProbe
Super RSS Reader – Add attractive RSS Feed Widget / 4.2
Super RSS Reader – Add attractive RSS Feed Widget v4.2
trunk 0.8 2.0 2.1 2.2 2.3 2.4 2.5 2.6 2.7 2.8 3.0 3.1 3.2 4.0 4.0.1 4.1 4.2 4.3 4.4 4.4.1 4.5 4.6 4.7 4.8 All 33 releases
super-rss-reader / readme.txt

readme.txt in Super RSS Reader – Add attractive RSS Feed Widget 4.2, at readme.txt

227 lines 9.6 KB
No matching file
Up and down to move Enter to open Esc to close
Raw Download Zip
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: 2.8
9 Requires PHP: 5.3
10 Tested up to: 5.7.1
11 Stable tag: 4.2
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 * Supports RSS and atom feed.
32 * Trim title and description text of the feed item.
33
34 ### 🌄 Display RSS feeds like
35
36 * Your own website content like recent posts, comments, forum topics etc.
37 * Articles, posts from related websites and share with your users.
38 * Events, job listings etc. from other websites.
39 * Deals, Craigslist etc. You got it, any RSS feed on your site !
40
41 [youtube=https://www.youtube.com/watch?v=02aOG_-98Tg]
42
43 ### 💎 PRO version
44
45 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.
46
47 * **Shortcode** - Display RSS feed anywhere in your website using `[srr_feed]`
48 * **Grid display** - Display feed item in rows and columns
49 * **Custom feed item template** - Change order of feed item content, add HTML
50 * **4 new** color themes
51
52 [**More information**](https://www.aakashweb.com/wordpress-plugins/super-rss-reader-pro/?utm_source=readme&utm_medium=description&utm_campaign=srr-pro) - [Live demo](https://wpdemos.aakashweb.com/super-rss-reader-pro/?utm_source=readme&utm_medium=description&utm_campaign=srr-pro)
53
54 ### Resources
55
56 * [FAQs](https://www.aakashweb.com/docs/super-rss-reader/faq/)
57 * [Documentation](https://www.aakashweb.com/docs/super-rss-reader/)
58 * [Support forum](https://www.aakashweb.com/forum/discuss/wordpress-plugins/super-rss-reader/)
59
60 ## Installation
61
62 Download and upload the latest version of Super RSS Reader,
63
64 1. Unzip & upload it to your WordPress site.
65 1. Activate the plugin.
66 1. Drag and drop the "Super RSS Reader" widget in the "Widgets" page.
67 1. Input a RSS feed URL to the widget, tweak some settings and you are,
68 1. Done !
69
70 ## Frequently Asked Questions
71
72 ### My RSS feed is not refreshing !
73
74 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.
75
76 `add_filter( 'wp_feed_cache_transient_lifetime', function($a) { return 600; } );`
77
78 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.
79
80 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.
81
82 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.
83
84 ### How can I customize the RSS widget via CSS styles ?
85
86 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/)
87
88 ### RSS feed is not displayed or error is shown
89
90 This can happen when,
91
92 * The RSS feed URL is invalid.
93 * The feed URL is not accessible by the server.
94 * 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.
95
96 ### Does this plugin support horizontal ticker ?
97
98 No, Super RSS Reader only supports vertical support feature for now.
99
100 ### How to display the feeds in multiple tabs ?
101
102 Enter the RSS feed URLs separated by comma or in new line in the widget, the plugin automatically renders the tab.
103
104 ### What are the contents shown in the feed ?
105
106 By default content like title, date, author, description, thumbnail can toggled to show in the feed.
107
108 ### Can I change the order of the content shown in the feed ?
109
110 Yes, it is possible with the [PRO version](https://www.aakashweb.com/wordpress-plugins/super-rss-reader-pro/?utm_source=readme&utm_medium=faq&utm_campaign=srr-pro) of the plugin. In the free version we can toggle the content.
111
112 ### Will the additional ticker effect slow down the site ?
113
114 The additional effect needs only 2.5 KB of additional JavaScript file which is very small since it is minified and optimized already.
115
116 [More FAQs in this page](https://www.aakashweb.com/docs/super-rss-reader/faq/)
117
118 ## Screenshots
119
120 1. Super RSS Reader widgets shown in the sidebar, having a ticker effect and in tabbed mode.
121 1. RSS feed widget in different themes and for different feed URLs.
122 1. Some more examples of the RSS feed.
123 1. Widget options.
124
125 [Live working demo](https://www.aakashweb.com/demos/super-rss-reader/)
126
127 ## Changelog
128
129 ### 4.2
130 * Fix: Ticker sometimes gets stuck when browser tab is switched or not viewed.
131 * New: Featured image is automatically inserted into local RSS feed to show as thumbnail if the post has no image in it.
132
133 ### 4.1
134 * New: Option to change date format
135 * New: Date will now be in the same language as the site.
136 * New: Option to set default thumbnail image if not present.
137 * New: Filter hook to customize the feed item's HTML.
138
139 ### 4.0.1
140 * Fix: Added hover style for the tabs and on active style when no theme is selected.
141 * New: Tested with WordPress 5.6
142
143 ### 4.0
144 * New: Reliable thumbnails. Thumbnails will now be taken from multiple places like feed content.
145 * New: Thumbnail positions (align left, right and cover mode) and size can be changed.
146 * New: Widget options are now more refined, easy to find and use.
147 * New: Plugin is now translation ready.
148 * New: `noreferrer` added to the feed links.
149 * New: Stripe of feed items is now done using CSS class `srr-stripe` instead of `even`.
150 * New: Introducing [PRO version](https://www.aakashweb.com/wordpress-plugins/super-rss-reader-pro/?utm_source=readme&utm_medium=changelog&utm_campaign=srr-pro).
151
152 ### 3.2
153 * Fix: Read more link not present
154 * New: Widgets settings is now clean and easy to use.
155 * New: Thumbnail and description can now be displayed separately.
156 * New: Description and title text are now trimmed by "words" instead of "characters".
157 * New: `Enable ticker` option is now replaced with `Display type`.
158 * Fix: Refactor code.
159 * Fix: Undefined index notice upon saving the widget.
160
161 ### 3.1
162 * Fix: Settings not being saved.
163 * New: Updated the ticker library to the latest.
164 * Fix: Added cache buster to JS and CSS files.
165 * Fix: Upon tab change, sometimes ticker height gets to 0;
166
167 ### 3.0
168 * New: Plugin code is refactored.
169 * New: Options are reorganized for easy configuration.
170 * Fix: Minor UI changes.
171 * Fix: Certain PHP notices on saving widget settings.
172
173 ### 2.8
174 * New: jQuery ticker script is now loaded locally.
175 * Fix: Minor style adjustments to the admin widget.
176
177 ### 2.7
178 * New: Support for "no follow" attribute in links.
179 * Fix: Readme with updated FAQ.
180
181 ### 2.6
182 * New: Ability to set fixed height for the RSS widget.
183 * New: Using minified JavaScript on frontend.
184 * Fix: Cleaned widget UI, reordered options.
185 * Fix: Code refactoring.
186
187 ### 2.5
188 * Added feature to change individual tab titles/names.
189 * Added feature to enable rich or full description.
190 * Fixed feed ordering issues.
191 * Updated jQuery easy ticker plugin to v2.0.
192 * Minor code revisions.
193
194 ### 2.4
195 * Added feature to cut down/strip feed titles.
196 * Added a new 'Simple modern' color style.
197
198 ### 2.3
199 * Fixed incompatibility of other jQuery plugins due to the usage of the latest version of jQuery.
200
201 ### 2.2
202 * Displays "thumbnail" of the feed item if available.
203 * Added setting to change ticker speed.
204 * Added setting to edit the "Read more" text.
205 * Default styles are revised.
206 * Switched to full size ticker code.
207 * Core code revised.
208
209 ### 2.1
210 * Added option to open links in new window.
211 * Changed the method to include the scripts and styles.
212 * Added a new 'Orange' color style.
213
214 ### 2.0
215 * Core code is completely rewritten.
216 * Flash RSS Reader is removed and instead jQuery is used.
217 * Administration panel used in the previous version is removed and settings are configured in the widget itself.
218
219 ### 0.8
220 * Second version with included CSS and Proxy file (loadXML.php).
221
222 ### 0.5
223 * Initial version with a flash RSS Reader
224
225 ## Upgrade Notice
226
227 Version 2.0 is a major and recommended upgrade for previous version users.