1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
|
===========
Syndication
===========
:Author: PyBlosxom Development Team
:Version: $Id: syndication.txt 1029 2007-06-07 02:33:12Z willhelm $
:Copyright: This document is distributed under the MIT license.
.. contents::
Summary
=======
Syndicating your blog is very important as it provides a mechanism
for readers of your blog to keep up to date. Typically this is done
with newsreader software. Additionally, there are web-sites that post
blog entries from a variety of blogs that have similar content. Both
newsreaders and planet-type web-sites need a semantically marked up
version of your blog.
Most newsreaders read most of the syndication formats. So you shouldn't
feel that you have to implement each one of them in your blog--you can most
assuredly get away with implementing RSS 2.0 or Atom 1.0 and be just fine.
The syndication flavours that come with PyBlosxom should be fine for most
blogs. When pointing people to your syndication feed, just use one
of the syndication flavours:
* ``http://your-server/path-to-blog/index.rss``
* ``http://your-server/path-to-blog/index.rss20``
* ``http://your-server/path-to-blog/index.atom``
Feed formats that come with PyBlosxom
=====================================
PyBlosxom comes with a few default flavours, three of which are feed
formats.
RSS 0.9.1
---------
PyBlosxom comes with an rss flavour that produces RSS 0.9.1 output. Here's
a sample of what it produces::
<?xml version="1.0" encoding="utf-8"?>
<!-- name="generator" content="pyblosxom/1.2 3/25/2005" -->
<!DOCTYPE rss PUBLIC "-//Netscape Communications//DTD RSS 0.91//EN"
"http://my.netscape.com/publish/formats/rss-0.91.dtd">
<rss version="0.91">
<channel>
<title>My Blog</title>
<link>http://www.joe.com/blog/index.rss</link>
<description>This is my blog about trivial things</description>
<language>en</language>
<item>
<title>Example of an entry post</title>
<link>http://www.joe.com/blog/entries/example1.html</link>
<description><p>
Here's an example of an entry in my blog. This is the body of the entry.
</p>
</description>
</item>
</channel>
</rss>
This example only has one entry in it. The number of entries the rss flavour
will display is determined by the ``num_entries` property in your
``config.py`` file.
.. Note::
Probably better not to use RSS 0.9.1:
RSS 0.9.1 format lacks dates in the data for the items. Unless you
include the date for the entry somewhere in the description block, people
looking at your RSS 0.9.1 feed won't know what the date the entry was
created on was.
Unless you have some reason to use RSS 0.9.1 as your syndication format,
you should look at using RSS 2.0 or Atom 1.0 both of which also come
with PyBlosxom.
For more information, look at the `RSS 0.9.1 spec`_.
.. _RSS 0.9.1 spec: http://my.netscape.com/publish/formats/rss-spec-0.91.html
RSS 2.0
-------
PyBlosxom 1.3 comes with an RSS 2.0 flavour called "rss20". If it's missing
features that you want (for example, some folks are doing podcasting with
their blog), then override the individual templates you need to adjust.
For more information on RSS 2.0, see the `RSS 2.0 spec`_.
.. _RSS 2.0 spec: http://blogs.law.harvard.edu/tech/rss
Atom 1.0
--------
PyBlosxom 1.3 comes with an Atom 1.0 flavour called "atom". If it's
missing features that you want, then override the individual templates
you need to adjust.
For more information on Atom 1.0, see the `Atom 1.0 spec`_.
.. _Atom 1.0 spec: http://atomenabled.org/
Debugging your feeds
====================
`FeedValidator`_ is a hugely useful tool for figuring out whether your
feed is valid and fixing bugs in your feed content.
.. _FeedValidator: http://feedvalidator.org/
Additionally, feel free to ask on the pyblosxom-users mailing list.
|
