Add initial georss support to rss20 plugin.

[matthijs/upstream/blosxom-plugins.git] / gavinc / rss20

diff --git a/gavinc/rss20 b/gavinc/rss20
index 402a59a11217a5a0d4b5b6ac7f847ae19d5e0d7f..38a2687f559b148ac2bd3ee44b9dd94b4ec4e335 100644 (file)
--- a/gavinc/rss20
+++ b/gavinc/rss20
@@ -1,8 +1,8 @@
 # Blosxom Plugin: rss20
 # Author(s): Gavin Carr <gavin@openfusion.com.au>
-# Version: 0.002000
+# Version: 0.003000
 # Requires: storydate
-# Suggests: absolute, storytags
+# Suggests: absolute, storytags, geo
 # Follows:  storydate
 
 package rss20;
@@ -19,6 +19,7 @@ use vars qw(
   $copyright
   $generator
   $category_list
+  $georss
 );
 
 # --- Configuration variables -----
@@ -112,6 +113,14 @@ sub story {
       $category_list .= qq(<category>$_</category>\n) . ' ' x $item_indent;
     }
   }
+
+  $georss = '';
+  if ($blosxom::plugins{geo} && $geo::latitude && $geo::longitude) {
+    $georss = qq(<georss:point>$geo::latitude $geo::longitude</georss:point>\n) .
+      ' ' x $item_indent;
+  }
+
+  return 1;
 }
 
 # --- Private subroutines
@@ -138,6 +147,14 @@ sub _load_templates {
 <rss version="2.0"
     xmlns:dc="http://purl.org/dc/elements/1.1/"
     xmlns:sy="http://purl.org/rss/1.0/modules/syndication/"
+HEAD
+
+  if ($blosxom::plugins{geo}) {
+    $blosxom::template{$flavour}{'head'} .= 
+      qq(    xmlns:georss="http://www.georss.org/georss"\n);
+  }
+
+  $blosxom::template{$flavour}{'head'} .= <<HEAD;
     xmlns:atom="http://www.w3.org/2005/Atom">
 
     <channel>
@@ -175,12 +192,12 @@ HEAD
      ' ' x $channel_indent .
       qq(<copyright>$rss20::copyright</copyright>\n);
   }
-  my $path_info = $blosxom::path_info_orig || "/$blosxom::path_info";
+  my $path_info_full = $blosxom::path_info_full || "$blosxom::path_info/index.rss";
   $blosxom::template{$flavour}{'head'} .= <<HEAD;
         <pubDate>\$storydate::latest_rfc822</pubDate>
         <language>$blosxom::blog_language</language>
         <generator>$rss20::generator</generator>
-        <atom:link href="$blosxom::url$path_info" rel="self" type="application/rss+xml" />
+        <atom:link href="$blosxom::url$path_info_full" rel="self" type="application/rss+xml" />
         <sy:updatePeriod>hourly</sy:updatePeriod>
         <sy:updateFrequency>1</sy:updateFrequency>
         <sy:updateBase>2000-01-01T12:00+00:00</sy:updateBase>
@@ -200,8 +217,17 @@ STORY
       ' ' x $item_indent .
       qq(<comments>$rss20::trackback_link</comments>\n);
   }
-  $blosxom::template{$flavour}{'story'} .= <<STORY;
-            \$rss20::category_list<description>\$body
+  $blosxom::template{$flavour}{'story'} .= 
+      ' ' x $item_indent .
+      '$rss20::category_list';
+
+  # GeoRSS support
+  if ($blosxom::plugins{geo}) {
+    $blosxom::template{$flavour}{'story'} .= '$rss20::georss';
+  }
+
+  $blosxom::template{$flavour}{'story'} .= <<'STORY';
+<description>$body
             </description>
         </item>
 STORY
@@ -230,6 +256,10 @@ rss20 is a blosxom plugin to generate an RSS 2.0 feed of your blog. It
 is self-contained, including the required flavours, and has a bunch of
 configuration variables to allow for configuration.
 
+If you're using the L<geo> plugin, rss20 will also add georss:point
+entries for any items with latitude and longitude metadata set (see 
+L<geo>).
+
 =head2 CONFIGURATION
 
 The following package variables can be configured:
@@ -277,9 +307,15 @@ plugins that manipulate your story content to have run already. It
 also should be run after the 'story' or 'prefs' plugins if you want
 to use those to customise your configuration variables.
 
+Requires the L<storydate> plugin for setting up story dates in the 
+right formats, and recommends the L<absolute> plugin for absolutising
+URLs.
+
 
 =head1 SEE ALSO
 
+L<storydate>, L<absolute>, L<geo>
+
 Blosxom: http://blosxom.sourceforge.net/
 
 rss20 is based on the 'atomfeed' and 'rss10' plugins, by Rael