From cc9ae5deb80502d69c6bce3ea64498c5c1c0560a Mon Sep 17 00:00:00 2001 From: Holger Schurig Date: Wed, 23 Jun 2010 11:33:53 +0200 Subject: [PATCH] doc rss_feed: added documentation --- in/plugins/rss_feed.md | 86 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 86 insertions(+) create mode 100644 in/plugins/rss_feed.md diff --git a/in/plugins/rss_feed.md b/in/plugins/rss_feed.md new file mode 100644 index 0000000..046db84 --- /dev/null +++ b/in/plugins/rss_feed.md @@ -0,0 +1,86 @@ +title: RSS feed generator +linktitle: rss_feed.py +parent: Plugins +keywords: RSS +ctime: 2010-06-23 + +This plugins write an XML file "`feed.rss`" (can be changed) into the +out-directory. The format is according to the RSS feed documentation +at [[http://www.rssboard.org/rss-specification]]. + + += Configuration = + +Please make sure to enable this plugin: + + plugins: [ + ... + "rss_feed", + ] + + +After this, the following three [[Configurations|configuration]] are +available: + +== rss_file == + +The rss feed can use the configuration entry `rss_file` to specify the +path of the generated file. + + rss_file: "rss.xml" + +The default is "`feed.rss`". + + +== rss_max_items == + +Here you can specify how many items (articles) are written into the +RSS feed. + + rss_max_items: 10 + +If you don't configure this, then the number of published articles +won't be limited. + + +== rss_max_age_days == + +Here you specify (in days) how young an article must be in order to be +published via RSS. + + rss_max_age_days: 28 + +If you don't configure this, then any article will be limited, +regardless of it's age. + + += Support in the template = + +You [[templates]] should mention your rss feed. One possible solution +is this: + + + ... + + + + += Example of output = + + + + + + Holger Schurig's Computer Calisthenics & Orthodontia + http://www.holgerschurig.de + Holger Schurig's Computer Calisthenics & Orthodontia + Wed, 23 Jun 2010 08:59:24 GMT + PyRSS2Gen-1.0.0 + http://blogs.law.harvard.edu/tech/rss + + QtIAX + http://www.holgerschurig.de/out/qtiax.html + + http://www.holgerschurig.de/out/qtiax.html 1260652641 + Sat, 12 Dec 2009 21:17:21 GMT + -- 2.39.2