Changeset 4982

Timestamp:

04/09/07 07:35:05 (2 years ago)

Author:

mtredinnick

Message:

Clarified that there is no feed-level description element in Atom feeds and the
subtitle element (and model attribute) may be a substitute in many cases.

Files:

• django/trunk/docs/syndication_feeds.txt (modified) (2 diffs)

django/trunk/docs/syndication_feeds.txt

@@ -115 +115 @@
-      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>``,
@@ -319 +323 @@
-    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::