Differences

This shows you the differences between two versions of the page.

--- plugin:filterrss [2014-03-22 06:39] – [Discussion] 71.14.73.66
+++ plugin:filterrss [2021-03-01 19:36] (current) – [Syntax] Aleksandr
@@ Line 2: / Line 2: @@
 ---- plugin ----
-description: Display RSS feed using simple filters.
+description: Display RSS feed using simple filters
 author     : Szymon Olewniczak
-email      : szymon.olewniczak@rid.pl
+email      : solewniczak@rid.pl
 type       : syntax
-lastupdate : 2013-06-20
+lastupdate : 2017-09-29
-compatible : "Weatherwax" "Angua" "Adora Belle"
+compatible : Weatherwax, Angua, Adora Belle
 depends    :
 conflicts  :
@@ Line 13: / Line 13: @@
 tags       : rss, feed
-downloadurl: https://github.com/hafron/dokuwiki-filterrss-plugin/zipball/master
+downloadurl: https://github.com/gkrid/dokuwiki-plugin-filterrss/zipball/master
-bugtracker : https://github.com/hafron/dokuwiki-filterrss-plugin/issues
+bugtracker : https://github.com/gkrid/dokuwiki-plugin-filterrss/issues
-sourcerepo : https://github.com/hafron/dokuwiki-filterrss-plugin/
+sourcerepo : https://github.com/gkrid/dokuwiki-plugin-filterrss/
-donationurl: https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=F2VQWA9PCK6LQ&lc=PL&item_name=filterrss%20%2d%20dokuwiki%20plugin&currency_code=EUR&bn=PP%2dDonationsBF%3abtn_donate_SM%2egif%3aNonHosted
 screenshot_img :
 ----
-**Attention!** I'm trying my best to make this plugin elastic and robust. So when you will find any bug or have an idea how to make the plugin better, do not hasitate and contact me using my e-mail address or create a new issue in the bugtracker.
+===== Description =====
-===== Goals of the project =====
+This plugin aims to create elastic and highly customisable rss feed reader plugin which will also be easy to use. The main advantage of this plugin is possibility of filtering rss results and changing the way how they are they displayed.
-This project aims to create elastic and highly customisable rss feed reader plugin which will also be easy to use. The main advantage of this plugin is possibility of filtering rss results and changing the way how they are they displayed.
-===== Donate =====
-I'm a young student working on this plugin in my free time. So if you like this plugin you can [[https://github.com/hafron/dokuwiki-filterrss-plugin/|Flattr it on its github page]] or send me money via [[https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=F2VQWA9PCK6LQ&lc=PL&item_name=filterrss%20%2d%20dokuwiki%20plugin&currency_code=EUR&bn=PP%2dDonationsBF%3abtn_donate_SM%2egif%3aNonHosted|PayPal]]. There is a lot to do in this plugin and a small donation would convince me that you need my work and motivate me to keep developing this plugin. Thank you in advance. ;-)
-===== Installation =====
-Install the plugin using the [[plugin:plugin|Plugin Manager]] and the download URL above, which points to latest version of the plugin. Refer to [[:Plugins]] on how to install plugins manually.
 ===== Examples/Usage =====
@@ Line 66: / Line 57: @@
 ===== Syntax =====
-[filterrss url condition1 && condition2 && condition3 ORDER BY filed DESC/ASC]
+  [filterrss url condition1 && condition2 && condition3 ORDER BY filed DESC/ASC]
-  * url - the url to rss feed. Ex. http://slashdot.org/index.rss
+  * ''url'' -- the url to rss feed. Ex. %%http://slashdot.org/index.rss%%
-  * contition - filter to be used over the feed. Currently there are 4 rss feed attributes suported in the contitions:
+  * ''contition'' -- filter to be used over the feed. Currently there are 4 rss feed attributes suported in the contitions:
-    * pubDate - the publication date of the entry. Date to compare should be given in an format recognized by PHP's strtotime function.  Ex. pubDate>=2012-05-02 (when I was writing this doc I've realized that it should be also possible to use relative date in here such as 1 month, 1 year etc. I will add it soon.)
+    * ''pubDate'' -- the publication date of the entry. Date to compare should be given in an format recognized by PHP's strtotime function.  Ex. ''%%pubDate>=2012-05-02%%'' (when I was writing this doc I've realized that it should be also possible to use relative date in here such as 1 month, 1 year etc. I will add it soon.)
-    * title - the title of the entry. Of course you can use only equal operation here(ex. title="My project"). The comparsion string can be quoded by " or ' or nothing if it doesn't contain any spaces. You can use percent sign here(%) which represents 0 or more chars. You can use it in order to find rss entries that contains something it the title. For ex. this condition is finding all rss etries that contains Linux in their titles: title="%Linux%"
+    * ''title'' -- the title of the entry. Of course you can use only equal operation here(ex. %%title="My project"%%). The comparsion string can be quoded by ''%%"%%'' or ''<nowiki>'</nowiki>'' or nothing if it doesn't contain any spaces. You can use percent sign here (''%'') which represents 0 or more chars. You can use it in order to find rss entries that contains something it the title. For ex. this condition is finding all rss etries that contains Linux in their titles: ''%%title="%Linux%"%%''
-    * description - description of the entry. The rules are the same as for the title.
+    * ''description'' -- description of the entry. The rules are the same as for the title.
-    * link - link of rss entry.  The rules are the same as for the title.
+    * ''link'' - link of rss entry.  The rules are the same as for the title.
-  * ORDER BY filed_name - it's optional and allows you to sort feeds in the diffirent order that they appear in XML. filed must be one of condition fileds. After the filed you can put DESC to show the entries in reverse order.(If you want you can also use ASC in place of desc but it does nothing)
+  * ''ORDER BY filed_name'' -- it's optional and allows you to sort feeds in the diffirent order that they appear in XML. filed must be one of condition fileds. After the filed you can put ''DESC'' to show the entries in reverse order.(If you want you can also use ''ASC'' in place of desc but it does nothing)
-  * LIMIT entries_nubmer - this allows you to determine how many entries should be displayed.
+  * ''LIMIT entries_nubmer'' -- this allows you to determine how many entries should be displayed.
 ===== Configuration and Settings =====
@@ Line 85: / Line 76: @@
 === Change Log ===
-{{rss>https://github.com/hafron/dokuwiki-filterrss-plugin/commits/master.atom}}
+{{rss>https://github.com/gkrid/dokuwiki-plugin-filterrss/commits/develop.atom date}}
-=== Known Bugs and Issues ===
+**Releases:**
+{{rss>https://github.com/gkrid/dokuwiki-plugin-filterrss/releases.atom description author}}
-Please report bug and issus on the project's [[https://github.com/hafron/dokuwiki-filterrss-plugin/issues|github page]].
-=== ToDo/Wish List ===
-  * Give a possibility to use use own html elements positioning. Add feed's classes.
-  * Better cache managment
-  * Use advanced reg exp in feed's conditions.
-  * Create more description syntax parsers(there is only bbcode parser avalible now)
-  * Allow joinig several feeds.
-  * <del>Add sorting</del> achieved(23-04-2013)
-If you have any other wishes write it down here.
-===== FAQ =====
 ===== Discussion =====
-Bad. Doesn't work on Weatherwax. I got the error: "Cannot load rss feed." Code: ''[filterrss http://slashdot.org/index.rss]''
+[[https://github.com/gkrid/dokuwiki-plugin-filterrss/issues]]
-Are you sure that server you are using are able to load remote data. Does normal dokuwiki rss syntax works for you? Can you check if PHP's simplexml_load_file can load any other xml file?
-Question: How hard would it be to add the ability to provide authentication information to an RSS server (presumably via an encrypted, otherwise inaccessible file from the filesystem)?
-It shouldn't be so hard. If you still interested in it, contact with me by email.  --- [[user>freesz|Szymon Olewniczak]] //2013/12/21 16:28//
-Bug. This plugin is not compatible in Release 2013-12-08 "Binky". Don't work rss filter pubDate and bbcode parser.
-> I'm running 'Binky' and it's working just fine for me. BC 22-Mar-2014