gavinc/rss20

   1 # Blosxom Plugin: rss20
   2 # Author(s): Gavin Carr <gavin@openfusion.com.au>
   3 # Version: 0.001001
   4 # Requires: storydate, lastmodified2
   5 # Suggests: absolute
   6 # Follows:  storydate, lastmodified2
   7
   8 package rss20;
   9
  10 use strict;
  11 use vars qw(
  12   $flavour
  13   $author_email
  14   $error_email
  15   $permalink
  16   $trackback_link
  17   $copyright
  18   $generator_url
  19 );
  20
  21 # --- Configuration variables -----
  22
  23 # What flavour string to you want to use for your feed?
  24 $flavour = 'rss';
  25 #$flavour = 'rss20';
  26
  27 # What email address should be used as the default author email?
  28 $author_email = 'author@example.com';
  29
  30 # What email address should feed errors be reported to?
  31 $error_email = '';
  32
  33 # What do your story permalinks look like?
  34 # This must be single-quoted, to defer evaluation; blosxom namespace applies
  35 $permalink = '$url$path/$fn.$default_flavour';
  36
  37 # What link should be used for trackbacks on a story?
  38 # This must be single-quoted, to defer evaluation; blosxom namespace applies
  39 $trackback_link = '';
  40 # $trackback_link = '$url$path/$fn.writeback';
  41 # $trackback_link = '$url$path/$fn.$feedback::trackback_flavour';
  42
  43 # Copyright statement; leave blank to omit.
  44 $copyright = '';
  45
  46 # Generator that produced this feed
  47 $generator_url = "http://blosxom.sourceforge.net/?v=$blosxom::version";
  48
  49 # --------------------------------
  50
  51 $error_email ||= $author_email;
  52
  53 sub start {
  54   _load_templates();
  55
  56   1;
  57 }
  58
  59 # --- Private subroutines
  60
  61 sub _load_templates {
  62   $blosxom::template{$flavour}{'content_type'} = 'text/xml';
  63
  64   $blosxom::template{$flavour}{'date'} = "\n";
  65
  66   $blosxom::template{$flavour}{'head'} = <<'HEAD';
  67 <?xml version="1.0" encoding="iso-8859-1"?>
  68 <rss version="2.0"
  69     xmlns:dc="http://purl.org/dc/elements/1.1/"
  70     xmlns:sy="http://purl.org/rss/1.0/modules/syndication/"
  71     xmlns:admin="http://webns.net/mvcb/"
  72     xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
  73     xmlns:content="http://purl.org/rss/1.0/modules/content/">
  74
  75     <channel>
  76         <title>$blog_title</title>
  77         <link>$url</link>
  78         <description>$blog_description</description>
  79         <dc:date>$lastmodified2::latest_iso8601</dc:date>
  80         <dc:language>$blosxom::blog_language</dc:language>
  81         <dc:creator>mailto:$rss20::author_email</dc:creator>
  82         <dc:rights>$rss20::copyright</dc:rights>
  83         <admin:generatorAgent rdf:resource="$rss20::generator_url" />
  84         <admin:errorReportsTo rdf:resource="mailto:$rss20::error_email" />
  85         <sy:updatePeriod>hourly</sy:updatePeriod>
  86         <sy:updateFrequency>1</sy:updateFrequency>
  87         <sy:updateBase>2000-01-01T12:00+00:00</sy:updateBase>
  88
  89 HEAD
  90
  91   $blosxom::template{$flavour}{'story'} = <<STORY;
  92         <item>
  93             <title>\$title</title>
  94             <link>$rss20::permalink</link>
  95             <description>\$body</description>
  96             <comments>$rss20::trackback_link</comments>
  97             <guid isPermaLink="true">$rss20::permalink</guid>
  98             <dc:date>\$storydate::story_iso8601</dc:date>
  99         </item>
 100 STORY
 101
 102   $blosxom::template{$flavour}{'foot'} = <<'FOOT';
 103     </channel>
 104 </rss>
 105 FOOT
 106 }
 107
 108
 109 1;
 110
 111 __END__
 112
 113 =head1 NAME
 114
 115 rss20 - blosxom plugin to generate an RSS 2.0 feed of your blog
 116
 117 =head1 DESCRIPTION
 118
 119 rss20 is a blosxom plugin to generate an RSS 2.0 feed of your blog. It
 120 is self-contained, including the required flavours, and has a bunch of
 121 configuration variables to allow for configuration.
 122
 123 =head2 CONFIGURATION
 124
 125 The following package variables can be configured:
 126
 127 =over 4
 128
 129 =item $flavour
 130
 131 Flavour string to use for your feed (typically 'rss' or 'rss20').
 132
 133 =item $author_email
 134
 135 Default author email address for posts.
 136
 137 =item $error_email
 138
 139 Email address to use to report errors with the feed (defaults to
 140 $author_email).
 141
 142 =item $permalink
 143
 144 Story permalink. Default is '$url$path/$fn.$default_flavour'.
 145 Note that this value should probably be single quoted to defer
 146 variable evaluation until rendering time.
 147
 148 =item $trackback_link
 149
 150 Story trackback or comment link. Default is ''. Useful if you
 151 are using a comments plugin like C<writeback> or C<feedback>,
 152 and the format you want will be plugin-dependant.
 153
 154 Like $permalink, this value should be single quoted to defer
 155 variable evaluation till rendering time.
 156
 157 =item $copyright
 158
 159 Default copyright clause for posts, if any.
 160
 161 =back
 162
 163 =head1 USAGE
 164
 165 rss20 should be loaded relatively late, since you'll typically want
 166 plugins that manipulate your story content to have run already. It
 167 also should be run after the 'story' or 'prefs' plugins if you want
 168 to use those to customise your configuration variables.
 169
 170
 171 =head1 SEE ALSO
 172
 173 Blosxom: http://blosxom.sourceforge.net/
 174
 175 rss20 is based on the 'atomfeed' and 'rss10' plugins, by Rael
 176 Dornfest and contributors.
 177
 178
 179 =head1 BUGS
 180
 181 Please report bugs either directly to the author or to the blosxom
 182 development mailing list: <blosxom-devel@lists.sourceforge.net>.
 183
 184
 185 =head1 AUTHOR
 186
 187 Gavin Carr <gavin@openfusion.com.au>, http://www.openfusion.net/
 188
 189
 190 =head1 LICENSE
 191
 192 Copyright 2007 Gavin Carr.
 193
 194 This plugin is licensed under the same terms as blosxom itself i.e.
 195
 196 Permission is hereby granted, free of charge, to any person obtaining a
 197 copy of this software and associated documentation files (the "Software"),
 198 to deal in the Software without restriction, including without limitation
 199 the rights to use, copy, modify, merge, publish, distribute, sublicense,
 200 and/or sell copies of the Software, and to permit persons to whom the
 201 Software is furnished to do so, subject to the following conditions:
 202
 203 The above copyright notice and this permission notice shall be included
 204 in all copies or substantial portions of the Software.
 205
 206 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 207 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 208 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
 209 THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
 210 OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
 211 ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 212 OTHER DEALINGS IN THE SOFTWARE.
 213
 214 =cut
 215
 216 # vim:ft=perl