1 # Blosxom Plugin: rss20
2 # Author(s): Gavin Carr <gavin@openfusion.com.au>
4 # Requires: lastmodified2
6 # Follows: lastmodified2
21 # --- Configuration variables -----
23 # What flavour string to you want to use for your feed?
27 # What email address should be used as the default author email?
28 $author_email = 'author@example.com';
30 # What email address should feed errors be reported to?
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';
37 # What link should be used for trackbacks on a story?
38 # This must be single-quoted, to defer evaluation; blosxom namespace applies
40 # $trackback_link = '$url$path/$fn.writeback';
41 # $trackback_link = '$url$path/$fn.$feedback::trackback_flavour';
43 # Copyright statement; leave blank to omit.
46 # Generator that produced this feed
47 $generator_url = "http://blosxom.sourceforge.net/?v=$blosxom::version";
52 # --------------------------------
54 $error_email ||= $author_email;
62 # --- Private subroutines
65 $blosxom::template{$flavour}{'content_type'} = 'text/xml';
67 $blosxom::template{$flavour}{'date'} = "\n";
69 $blosxom::template{$flavour}{'head'} = <<'HEAD';
70 <?xml version="1.0" encoding="iso-8859-1"?>
72 xmlns:dc="http://purl.org/dc/elements/1.1/"
73 xmlns:sy="http://purl.org/rss/1.0/modules/syndication/"
74 xmlns:admin="http://webns.net/mvcb/"
75 xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
76 xmlns:content="http://purl.org/rss/1.0/modules/content/">
79 <title>$blog_title</title>
81 <description>$blog_description</description>
82 <dc:date>$lastmodified2::latest_iso8601</dc:date>
83 <dc:language>$blosxom::blog_language</dc:language>
84 <dc:creator>mailto:$rss20::author_email</dc:creator>
85 <dc:rights>$rss20::copyright</dc:rights>
86 <admin:generatorAgent rdf:resource="$rss20::generator_url" />
87 <admin:errorReportsTo rdf:resource="mailto:$rss20::error_email" />
88 <sy:updatePeriod>hourly</sy:updatePeriod>
89 <sy:updateFrequency>1</sy:updateFrequency>
90 <sy:updateBase>2000-01-01T12:00+00:00</sy:updateBase>
94 $blosxom::template{$flavour}{'story'} = <<STORY;
96 <title>\$title</title>
97 <link>$rss20::permalink</link>
98 <description>\$body</description>
99 <comments>$rss20::trackback_link</comments>
100 <guid isPermaLink="true">$rss20::permalink</guid>
101 <dc:date>\$lastmodified2::story_iso8601</dc:date>
105 $blosxom::template{$flavour}{'foot'} = <<'FOOT';
118 rss20 - blosxom plugin to generate an RSS 2.0 feed of your blog
122 rss20 is a blosxom plugin to generate an RSS 2.0 feed of your blog. It
123 is self-contained, including the required flavours, and has a bunch of
124 configuration variables to allow for configuration.
128 The following package variables can be configured:
134 Flavour string to use for your feed (typically 'rss' or 'rss20').
138 Default author email address for posts.
142 Email address to use to report errors with the feed (defaults to
147 Story permalink. Default is '$url$path/$fn.$default_flavour'.
148 Note that this value should probably be single quoted to defer
149 variable evaluation until rendering time.
151 =item $trackback_link
153 Story trackback or comment link. Default is ''. Useful if you
154 are using a comments plugin like C<writeback> or C<feedback>,
155 and the format you want will be plugin-dependant.
157 Like $permalink, this value should be single quoted to defer
158 variable evaluation till rendering time.
162 Default copyright clause for posts, if any.
168 rss20 should be loaded relatively late, since you'll typically want
169 plugins that manipulate your story content to have run already. It
170 also should be run after the 'story' or 'prefs' plugins if you want
171 to use those to customise your configuration variables.
176 Blosxom: http://blosxom.sourceforge.net/
178 rss20 is based on the 'atomfeed' and 'rss10' plugins, by Rael
179 Dornfest and contributors.
184 Please report bugs either directly to the author or to the blosxom
185 development mailing list: <blosxom-devel@lists.sourceforge.net>.
190 Gavin Carr <gavin@openfusion.com.au>, http://www.openfusion.net/
195 Copyright 2007 Gavin Carr.
197 This plugin is licensed under the same terms as blosxom itself i.e.
199 Permission is hereby granted, free of charge, to any person obtaining a
200 copy of this software and associated documentation files (the "Software"),
201 to deal in the Software without restriction, including without limitation
202 the rights to use, copy, modify, merge, publish, distribute, sublicense,
203 and/or sell copies of the Software, and to permit persons to whom the
204 Software is furnished to do so, subject to the following conditions:
206 The above copyright notice and this permission notice shall be included
207 in all copies or substantial portions of the Software.
209 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
210 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
211 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
212 THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
213 OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
214 ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
215 OTHER DEALINGS IN THE SOFTWARE.