Browse files

Clarified that there is no feed-level description element in Atom fee…

…ds and the

subtitle element (and model attribute) may be a substitute in many cases.

git-svn-id: bcc190cf-cafb-0310-a4f2-bffc1f526a37
  • Loading branch information...
1 parent db8ca44 commit 37201540276bc0cd25310d4bd3aec83c91effa91 @malcolmt malcolmt committed Apr 9, 2007
Showing with 14 additions and 0 deletions.
  1. +14 −0 docs/syndication_feeds.txt
@@ -114,6 +114,10 @@ Note:
`object-relational mapper`_, ``items()`` doesn't have to return model
instances. Although you get a few bits of functionality "for free" by
using Django models, ``items()`` can return any type of object you want.
+ * If you are creating an Atom feed, rather than the default RSS feed, you
+ will want to set the ``subtitle`` attribute instead of the
+ ``description`` attribute. See `Publishing Atom and RSS feeds in
+ tandem`_, later, for an example.
One thing's left to do. In an RSS feed, each ``<item>`` has a ``<title>``,
``<link>`` and ``<description>``. We need to tell the framework what data to
@@ -318,6 +322,16 @@ Here's a full example::
class AtomSiteNewsFeed(RssSiteNewsFeed):
feed_type = Atom1Feed
+ subtitle = description
+.. Note::
+ In Atom feeds, there is no feed-level description element. There *is* a
+ subtitle element, however. Your RSS feed description may be too verbose
+ for a subtitle, so Django does not automatically put the feed description
+ into the subtitle element. Instead, you should create a ``subtitle``
+ attribute in your model, containing an appropriate string. In the above
+ example, we have used the RSS feed's description, since it is quite short
+ already.
And the accompanying URLconf::

0 comments on commit 3720154

Please sign in to comment.