p15693087
/
django
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Fixed #20860 -- Removed references to defunct chicagocrime.org

This commit is contained in:
Tim Graham 2013-08-04 14:45:29 -04:00
parent e8183a8193
commit 1593a86494
1 changed files with 12 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
docs/ref/contrib/syndication.txt
View File

@ -49,17 +49,17 @@ are views which can be used in your :doc:`URLconf </topics/http/urls>`.
A simple example A simple example
---------------- ----------------
This simple example, taken from `chicagocrime.org`_, describes a feed of the This simple example, taken from a hypothetical police beat news site describes
latest five news items:: a feed of the latest five news items::
from django.contrib.syndication.views import Feed from django.contrib.syndication.views import Feed
from django.core.urlresolvers import reverse from django.core.urlresolvers import reverse
from chicagocrime.models import NewsItem from policebeat.models import NewsItem
class LatestEntriesFeed(Feed): class LatestEntriesFeed(Feed):
title = "Chicagocrime.org site news" title = "Police beat site news"
link = "/sitenews/" link = "/sitenews/"
description = "Updates on changes and additions to chicagocrime.org." description = "Updates on changes and additions to police beat central."
def items(self): def items(self):
return NewsItem.objects.order_by('-pub_date')[:5] return NewsItem.objects.order_by('-pub_date')[:5]
@ -199,22 +199,20 @@ into those elements.
are responsible for doing all necessary URL quoting and conversion to are responsible for doing all necessary URL quoting and conversion to
ASCII inside the method itself. ASCII inside the method itself.
.. _chicagocrime.org: http://www.chicagocrime.org/
A complex example A complex example
----------------- -----------------
The framework also supports more complex feeds, via arguments. The framework also supports more complex feeds, via arguments.
For example, `chicagocrime.org`_ offers an RSS feed of recent crimes for every For example, a website could offer an RSS feed of recent crimes for every
police beat in Chicago. It'd be silly to create a separate police beat in a city. It'd be silly to create a separate
:class:`~django.contrib.syndication.views.Feed` class for each police beat; that :class:`~django.contrib.syndication.views.Feed` class for each police beat; that
would violate the :ref:`DRY principle <dry>` and would couple data to would violate the :ref:`DRY principle <dry>` and would couple data to
programming logic. Instead, the syndication framework lets you access the programming logic. Instead, the syndication framework lets you access the
arguments passed from your :doc:`URLconf </topics/http/urls>` so feeds can output arguments passed from your :doc:`URLconf </topics/http/urls>` so feeds can output
items based on information in the feed's URL. items based on information in the feed's URL.
On chicagocrime.org, the police-beat feeds are accessible via URLs like this: The police beat feeds could be accessible via URLs like this:
* :file:`/beats/613/rss/` -- Returns recent crimes for beat 613. * :file:`/beats/613/rss/` -- Returns recent crimes for beat 613.
* :file:`/beats/1424/rss/` -- Returns recent crimes for beat 1424. * :file:`/beats/1424/rss/` -- Returns recent crimes for beat 1424.
@ -238,7 +236,7 @@ Here's the code for these beat-specific feeds::
return get_object_or_404(Beat, pk=beat_id) return get_object_or_404(Beat, pk=beat_id)
def title(self, obj): def title(self, obj):
return "Chicagocrime.org: Crimes for beat %s" % obj.beat return "Police beat central: Crimes for beat %s" % obj.beat
def link(self, obj): def link(self, obj):
return obj.get_absolute_url() return obj.get_absolute_url()
@ -339,13 +337,13 @@ URLconf to add the extra versions.
Here's a full example:: Here's a full example::
from django.contrib.syndication.views import Feed from django.contrib.syndication.views import Feed
from chicagocrime.models import NewsItem from policebeat.models import NewsItem
from django.utils.feedgenerator import Atom1Feed from django.utils.feedgenerator import Atom1Feed
class RssSiteNewsFeed(Feed): class RssSiteNewsFeed(Feed):
title = "Chicagocrime.org site news" title = "Police beat site news"
link = "/sitenews/" link = "/sitenews/"
description = "Updates on changes and additions to chicagocrime.org." description = "Updates on changes and additions to police beat central."
def items(self): def items(self):
return NewsItem.objects.order_by('-pub_date')[:5] return NewsItem.objects.order_by('-pub_date')[:5]