DokuWiki

It's better when it's simple

User Tools

Site Tools


plugin:feedaggregator

Differences

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

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
Both sides next revision
plugin:feedaggregator [2015-12-17 05:51]
samwilson
plugin:feedaggregator [2018-05-29 23:13] (current)
Klap-in [Installation]
Line 2: Line 2:
  
 ---- plugin ---- ---- plugin ----
-description: A plugin for aggregating multiple news feeds onto a single wiki page.+description: A plugin for aggregating multiple news feeds onto a single wiki page
 author     : Sam Wilson  author     : Sam Wilson 
 email      : sam@samwilson.id.au  email      : sam@samwilson.id.au 
 type       : syntax,action type       : syntax,action
 lastupdate : 2015-12-17 lastupdate : 2015-12-17
-compatible : 2015-08-10a,2014-09-29+compatible : 2015-08-10a, 2014-09-29
 depends    :  depends    : 
 conflicts  conflicts 
 similar    :  similar    : 
-tags       : rss, feeds, news, simplepie+tags       : rss, feed, news, simplepie, embed
  
-downloadurl: http://github.com/samwilson/dokuwiki-plugin-feedaggregator/zipball/master +downloadurl: https://github.com/samwilson/dokuwiki-plugin-feedaggregator/zipball/master 
-bugtracker : http://github.com/samwilson/dokuwiki-plugin-feedaggregator/issues +bugtracker : https://github.com/samwilson/dokuwiki-plugin-feedaggregator/issues 
-sourcerepo : http://github.com/samwilson/dokuwiki-plugin-feedaggregator/+sourcerepo : https://github.com/samwilson/dokuwiki-plugin-feedaggregator/
 donationurl:  donationurl: 
  
Line 23: Line 23:
 ===== Installation ===== ===== Installation =====
  
-Install 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.+Search and install the plugin using the [[plugin:extension|Extension Manager]]. Refer to [[:Plugins]] on how to install plugins manually.
  
-The actual retrieval of the feeds is done by browsing to ''http://example.org/dokuwiki?do=feedaggregator''. This URL should be pinged regularly by cron or some quasi-cron web service.+The actual retrieval of the feeds is done by browsing to ''%%http://example.org/dokuwiki/?do=feedaggregator%%''. This URL should be pinged regularly by cron or some quasi-cron web service; see the //[[#Automating]]// section below for more information.
  
 ===== Usage ===== ===== Usage =====
- 
-See the plugin in action [[http://www.example.com|here]]. 
  
 Define the feeds to be included with one URL on each line: Define the feeds to be included with one URL on each line:
Line 42: Line 40:
  
 For other configuration options, please see the plugin's section in your site's Configuration Manager. For other configuration options, please see the plugin's section in your site's Configuration Manager.
 +
 +===== Automating =====
 +
 +The feed-update URL should be called regularly by a cron (or other task-scheduling) service. If you set up a system to do this, then you should set a ''token'' in the plugin configuration; this will prevent the possibility of other requests wasting system resources by also requesting this URL.
 +
 +An example cron entry looks like the following:
 +
 +  34 * * * * curl --silent http://example.org/dokuwiki/?do=feedaggregator&token=tok123
 +
 +If you use an automated update system, then you can do away with ''%%~~NOCACHE~~%%'' in the page text and instead force-purge the cache after the update operation. To do this, add a second cron entry similar to the following:
 +
 +  44 * * * * curl --silent http://example.org/dokuwiki/news?purge=true 
  
 ===== Change Log ===== ===== Change Log =====
-{{rss>https://github.com/samwilson/dokuwiki-plugin-feedaggregator/commits/master.atom}}+ 
 +{{rss>https://github.com/samwilson/dokuwiki-plugin-feedaggregator/commits/master.atom date}}
  
plugin/feedaggregator.1450327916.txt.gz · Last modified: 2015-12-17 05:51 by samwilson