From a02e13c7da653c83b44ab021d06a1d3bd139ef53 Mon Sep 17 00:00:00 2001 From: Adrian Holovaty Date: Mon, 9 Apr 2007 15:48:08 +0000 Subject: [PATCH] Edited docs/syndication_feeds.txt changes from [4982] git-svn-id: http://code.djangoproject.com/svn/django/trunk@4988 bcc190cf-cafb-0310-a4f2-bffc1f526a37 --- docs/syndication_feeds.txt | 29 ++++++++++++++++------------- 1 file changed, 16 insertions(+), 13 deletions(-) diff --git a/docs/syndication_feeds.txt b/docs/syndication_feeds.txt index 0b402d01954..2a09307e098 100644 --- a/docs/syndication_feeds.txt +++ b/docs/syndication_feeds.txt @@ -114,10 +114,9 @@ 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. + * If you're creating an Atom feed, rather than an RSS feed, 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 ```` has a ````, ``<link>`` and ``<description>``. We need to tell the framework what data to @@ -302,7 +301,7 @@ Publishing Atom and RSS feeds in tandem --------------------------------------- Some developers like to make available both Atom *and* RSS versions of their -feeds. That's easy to do with Django: Just create a subclass of your ``feed`` +feeds. That's easy to do with Django: Just create a subclass of your ``Feed`` class and set the ``feed_type`` to something different. Then update your URLconf to add the extra versions. @@ -322,16 +321,20 @@ Here's a full example:: class AtomSiteNewsFeed(RssSiteNewsFeed): feed_type = Atom1Feed - subtitle = description + subtitle = RssSiteNewsFeed.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. + In this example, the RSS feed uses a ``description`` while the Atom feed + uses a ``subtitle``. That's because Atom feeds don't provide for a + feed-level "description," but they *do* provide for a "subtitle." + + If you provide a ``description`` in your ``Feed`` class, Django will *not* + automatically put that into the ``subtitle`` element, because a subtitle + and description are not necessarily the same thing. Instead, you should + define a ``subtitle`` attribute. + + In the above example, we simply set the Atom feed's ``subtitle`` to the + RSS feed's ``description``, because it's quite short already. And the accompanying URLconf::