Django comes with a high-level syndication-feed-generating framework\nthat makes creating RSS and Atom feeds easy.
\nTo create any syndication feed, all you have to do is write a short\nPython class. You can create as many feeds as you want.
\nDjango also comes with a lower-level feed-generating API. Use this if\nyou want to generate feeds outside of a Web context, or in some other\nlower-level way.
\nThe high-level feed-generating framework is supplied by the\nFeed class. To create a\nfeed, write a Feed class\nand point to an instance of it in your URLconf.
A Feed class is a Python\nclass that represents a syndication feed. A feed can be simple (e.g.,\na “site news” feed, or a basic feed displaying the latest entries of a\nblog) or more complex (e.g., a feed displaying all the blog entries in\na particular category, where the category is variable).
Feed classes subclass django.contrib.syndication.views.Feed.\nThey can live anywhere in your codebase.
Instances of Feed classes\nare views which can be used in your URLconf.
This simple example, taken from a hypothetical police beat news site describes\na feed of the latest five news items:
\nfrom django.contrib.syndication.views import Feed\nfrom django.core.urlresolvers import reverse\nfrom policebeat.models import NewsItem\n\nclass LatestEntriesFeed(Feed):\n title = "Police beat site news"\n link = "/sitenews/"\n description = "Updates on changes and additions to police beat central."\n\n def items(self):\n return NewsItem.objects.order_by('-pub_date')[:5]\n\n def item_title(self, item):\n return item.title\n\n def item_description(self, item):\n return item.description\n\n # item_link is only needed if NewsItem has no get_absolute_url method.\n def item_link(self, item):\n return reverse('news-item', args=[item.pk])\nTo connect a URL to this feed, put an instance of the Feed object in\nyour URLconf. For example:
\nfrom django.conf.urls import url\nfrom myproject.feeds import LatestEntriesFeed\n\nurlpatterns = [\n # ...\n url(r'^latest/feed/$', LatestEntriesFeed()),\n # ...\n]\nNote:
\nThe Feed class subclasses django.contrib.syndication.views.Feed.
title, link and description correspond to the\nstandard RSS <title>, <link> and <description> elements,\nrespectively.
items() is, simply, a method that returns a list of objects that\nshould be included in the feed as <item> elements. Although this\nexample returns NewsItem objects using Django’s\nobject-relational mapper, items()\ndoesn’t have to return model instances. Although you get a few bits of\nfunctionality “for free” by using Django models, items() can\nreturn any type of object you want.
If you’re creating an Atom feed, rather than an RSS feed, set the\nsubtitle attribute instead of the description attribute.\nSee Publishing Atom and RSS feeds in tandem, later, for an example.
One thing is left to do. In an RSS feed, each <item> has a <title>,\n<link> and <description>. We need to tell the framework what data to put\ninto those elements.
For the contents of <title> and <description>, Django tries\ncalling the methods item_title() and item_description() on\nthe Feed class. They are passed\na single parameter, item, which is the object itself. These are\noptional; by default, the unicode representation of the object is used for\nboth.
If you want to do any special formatting for either the title or\ndescription, Django templates can be used\ninstead. Their paths can be specified with the title_template and\ndescription_template attributes on the\nFeed class. The templates are\nrendered for each item and are passed two template context variables:
{{ obj }} – The current object (one of whichever objects you\nreturned in items()).
{{ site }} – A django.contrib.sites.models.Site object\nrepresenting the current site. This is useful for {{ site.domain\n}} or {{ site.name }}. If you do not have the Django sites\nframework installed, this will be set to a\nRequestSite object. See the\nRequestSite section of the sites framework documentation for more.
See a complex example below that uses a description template.
\nThere is also a way to pass additional information to title and description\ntemplates, if you need to supply more than the two variables mentioned\nbefore. You can provide your implementation of get_context_data method\nin your Feed subclass. For example:
from mysite.models import Article\nfrom django.contrib.syndication.views import Feed\n\nclass ArticlesFeed(Feed):\n title = "My articles"\n description_template = "feeds/articles.html"\n\n def items(self):\n return Article.objects.order_by('-pub_date')[:5]\n\n def get_context_data(self, **kwargs):\n context = super(ArticlesFeed, self).get_context_data(**kwargs)\n context['foo'] = 'bar'\n return context\nAnd the template:
\nSomething about {{ foo }}: {{ obj.description }}\nThis method will be called once per each item in the list returned by\nitems() with the following keyword arguments:
item: the current item. For backward compatibility reasons, the name\nof this context variable is {{ obj }}.
obj: the object returned by get_object(). By default this is not\nexposed to the templates to avoid confusion with {{ obj }} (see above),\nbut you can use it in your implementation of get_context_data().
site: current site as described above.
request: current request.
The behavior of get_context_data() mimics that of\ngeneric views - you’re supposed to call\nsuper() to retrieve context data from parent class, add your data\nand return the modified dictionary.
To specify the contents of <link>, you have two options. For each item\nin items(), Django first tries calling the\nitem_link() method on the\nFeed class. In a similar way to\nthe title and description, it is passed it a single parameter,\nitem. If that method doesn’t exist, Django tries executing a\nget_absolute_url() method on that object. Both\nget_absolute_url() and item_link() should return the\nitem’s URL as a normal Python string. As with get_absolute_url(), the\nresult of item_link() will be included directly in the URL, so you\nare responsible for doing all necessary URL quoting and conversion to\nASCII inside the method itself.
The framework also supports more complex feeds, via arguments.
\nFor example, a website could offer an RSS feed of recent crimes for every\npolice beat in a city. It’d be silly to create a separate\nFeed class for each police beat; that\nwould violate the DRY principle and would couple data to\nprogramming logic. Instead, the syndication framework lets you access the\narguments passed from your URLconf so feeds can output\nitems based on information in the feed’s URL.
The police beat feeds could be accessible via URLs like this:
\n/beats/613/rss/ – Returns recent crimes for beat 613.
/beats/1424/rss/ – Returns recent crimes for beat 1424.
These can be matched with a URLconf line such as:
\nurl(r'^beats/(?P<beat_id>[0-9]+)/rss/$', BeatFeed()),\nLike a view, the arguments in the URL are passed to the get_object()\nmethod along with the request object.
Here’s the code for these beat-specific feeds:
\nfrom django.contrib.syndication.views import Feed\n\nclass BeatFeed(Feed):\n description_template = 'feeds/beat_description.html'\n\n def get_object(self, request, beat_id):\n return Beat.objects.get(pk=beat_id)\n\n def title(self, obj):\n return "Police beat central: Crimes for beat %s" % obj.beat\n\n def link(self, obj):\n return obj.get_absolute_url()\n\n def description(self, obj):\n return "Crimes recently reported in police beat %s" % obj.beat\n\n def items(self, obj):\n return Crime.objects.filter(beat=obj).order_by('-crime_date')[:30]\nTo generate the feed’s <title>, <link> and <description>, Django\nuses the title(), link() and description() methods. In\nthe previous example, they were simple string class attributes, but this example\nillustrates that they can be either strings or methods. For each of\ntitle, link and description, Django follows this\nalgorithm:
First, it tries to call a method, passing the obj argument, where\nobj is the object returned by get_object().
Failing that, it tries to call a method with no arguments.
Failing that, it uses the class attribute.
Also note that items() also follows the same algorithm – first, it\ntries items(obj), then items(), then finally an items\nclass attribute (which should be a list).
We are using a template for the item descriptions. It can be very simple:
\n{{ obj.description }}\nHowever, you are free to add formatting as desired.
\nThe ExampleFeed class below gives full documentation on methods and\nattributes of Feed classes.
By default, feeds produced in this framework use RSS 2.0.
\nTo change that, add a feed_type attribute to your\nFeed class, like so:
from django.utils.feedgenerator import Atom1Feed\n\nclass MyFeed(Feed):\n feed_type = Atom1Feed\nNote that you set feed_type to a class object, not an instance.
Currently available feed types are:
\ndjango.utils.feedgenerator.Rss201rev2Feed (RSS 2.01. Default.)
django.utils.feedgenerator.RssUserland091Feed (RSS 0.91.)
django.utils.feedgenerator.Atom1Feed (Atom 1.0.)
To specify enclosures, such as those used in creating podcast feeds, use the\nitem_enclosure_url, item_enclosure_length and\nitem_enclosure_mime_type hooks. See the ExampleFeed class below for\nusage examples.
Feeds created by the syndication framework automatically include the\nappropriate <language> tag (RSS 2.0) or xml:lang attribute (Atom). This\ncomes directly from your LANGUAGE_CODE setting.
The link method/attribute can return either an absolute path (e.g.\n"/blog/") or a URL with the fully-qualified domain and protocol (e.g.\n"http://www.example.com/blog/"). If link doesn’t return the domain,\nthe syndication framework will insert the domain of the current site, according\nto your SITE_ID setting.
Atom feeds require a <link rel="self"> that defines the feed’s current\nlocation. The syndication framework populates this automatically, using the\ndomain of the current site according to the SITE_ID setting.
Some developers like to make available both Atom and RSS versions of their\nfeeds. That’s easy to do with Django: Just create a subclass of your\nFeed\nclass and set the feed_type to something different. Then update your\nURLconf to add the extra versions.
Here’s a full example:
\nfrom django.contrib.syndication.views import Feed\nfrom policebeat.models import NewsItem\nfrom django.utils.feedgenerator import Atom1Feed\n\nclass RssSiteNewsFeed(Feed):\n title = "Police beat site news"\n link = "/sitenews/"\n description = "Updates on changes and additions to police beat central."\n\n def items(self):\n return NewsItem.objects.order_by('-pub_date')[:5]\n\nclass AtomSiteNewsFeed(RssSiteNewsFeed):\n feed_type = Atom1Feed\n subtitle = RssSiteNewsFeed.description\nAnd the accompanying URLconf:
\nfrom django.conf.urls import url\nfrom myproject.feeds import RssSiteNewsFeed, AtomSiteNewsFeed\n\nurlpatterns = [\n # ...\n url(r'^sitenews/rss/$', RssSiteNewsFeed()),\n url(r'^sitenews/atom/$', AtomSiteNewsFeed()),\n # ...\n]\nThis example illustrates all possible attributes and methods for a\nFeed class:
from django.contrib.syndication.views import Feed\nfrom django.utils import feedgenerator\n\nclass ExampleFeed(Feed):\n\n # FEED TYPE -- Optional. This should be a class that subclasses\n # django.utils.feedgenerator.SyndicationFeed. This designates\n # which type of feed this should be: RSS 2.0, Atom 1.0, etc. If\n # you don't specify feed_type, your feed will be RSS 2.0. This\n # should be a class, not an instance of the class.\n\n feed_type = feedgenerator.Rss201rev2Feed\n\n # TEMPLATE NAMES -- Optional. These should be strings\n # representing names of Django templates that the system should\n # use in rendering the title and description of your feed items.\n # Both are optional. If a template is not specified, the\n # item_title() or item_description() methods are used instead.\n\n title_template = None\n description_template = None\n\n # TITLE -- One of the following three is required. The framework\n # looks for them in this order.\n\n def title(self, obj):\n """\n Takes the object returned by get_object() and returns the\n feed's title as a normal Python string.\n """\n\n def title(self):\n """\n Returns the feed's title as a normal Python string.\n """\n\n title = 'foo' # Hard-coded title.\n\n # LINK -- One of the following three is required. The framework\n # looks for them in this order.\n\n def link(self, obj):\n """\n # Takes the object returned by get_object() and returns the URL\n # of the HTML version of the feed as a normal Python string.\n """\n\n def link(self):\n """\n Returns the URL of the HTML version of the feed as a normal Python\n string.\n """\n\n link = '/blog/' # Hard-coded URL.\n\n # FEED_URL -- One of the following three is optional. The framework\n # looks for them in this order.\n\n def feed_url(self, obj):\n """\n # Takes the object returned by get_object() and returns the feed's\n # own URL as a normal Python string.\n """\n\n def feed_url(self):\n """\n Returns the feed's own URL as a normal Python string.\n """\n\n feed_url = '/blog/rss/' # Hard-coded URL.\n\n # GUID -- One of the following three is optional. The framework looks\n # for them in this order. This property is only used for Atom feeds\n # (where it is the feed-level ID element). If not provided, the feed\n # link is used as the ID.\n\n def feed_guid(self, obj):\n """\n Takes the object returned by get_object() and returns the globally\n unique ID for the feed as a normal Python string.\n """\n\n def feed_guid(self):\n """\n Returns the feed's globally unique ID as a normal Python string.\n """\n\n feed_guid = '/foo/bar/1234' # Hard-coded guid.\n\n # DESCRIPTION -- One of the following three is required. The framework\n # looks for them in this order.\n\n def description(self, obj):\n """\n Takes the object returned by get_object() and returns the feed's\n description as a normal Python string.\n """\n\n def description(self):\n """\n Returns the feed's description as a normal Python string.\n """\n\n description = 'Foo bar baz.' # Hard-coded description.\n\n # AUTHOR NAME --One of the following three is optional. The framework\n # looks for them in this order.\n\n def author_name(self, obj):\n """\n Takes the object returned by get_object() and returns the feed's\n author's name as a normal Python string.\n """\n\n def author_name(self):\n """\n Returns the feed's author's name as a normal Python string.\n """\n\n author_name = 'Sally Smith' # Hard-coded author name.\n\n # AUTHOR EMAIL --One of the following three is optional. The framework\n # looks for them in this order.\n\n def author_email(self, obj):\n """\n Takes the object returned by get_object() and returns the feed's\n author's email as a normal Python string.\n """\n\n def author_email(self):\n """\n Returns the feed's author's email as a normal Python string.\n """\n\n author_email = 'test@example.com' # Hard-coded author email.\n\n # AUTHOR LINK --One of the following three is optional. The framework\n # looks for them in this order. In each case, the URL should include\n # the "http://" and domain name.\n\n def author_link(self, obj):\n """\n Takes the object returned by get_object() and returns the feed's\n author's URL as a normal Python string.\n """\n\n def author_link(self):\n """\n Returns the feed's author's URL as a normal Python string.\n """\n\n author_link = 'http://www.example.com/' # Hard-coded author URL.\n\n # CATEGORIES -- One of the following three is optional. The framework\n # looks for them in this order. In each case, the method/attribute\n # should return an iterable object that returns strings.\n\n def categories(self, obj):\n """\n Takes the object returned by get_object() and returns the feed's\n categories as iterable over strings.\n """\n\n def categories(self):\n """\n Returns the feed's categories as iterable over strings.\n """\n\n categories = ("python", "django") # Hard-coded list of categories.\n\n # COPYRIGHT NOTICE -- One of the following three is optional. The\n # framework looks for them in this order.\n\n def feed_copyright(self, obj):\n """\n Takes the object returned by get_object() and returns the feed's\n copyright notice as a normal Python string.\n """\n\n def feed_copyright(self):\n """\n Returns the feed's copyright notice as a normal Python string.\n """\n\n feed_copyright = 'Copyright (c) 2007, Sally Smith' # Hard-coded copyright notice.\n\n # TTL -- One of the following three is optional. The framework looks\n # for them in this order. Ignored for Atom feeds.\n\n def ttl(self, obj):\n """\n Takes the object returned by get_object() and returns the feed's\n TTL (Time To Live) as a normal Python string.\n """\n\n def ttl(self):\n """\n Returns the feed's TTL as a normal Python string.\n """\n\n ttl = 600 # Hard-coded Time To Live.\n\n # ITEMS -- One of the following three is required. The framework looks\n # for them in this order.\n\n def items(self, obj):\n """\n Takes the object returned by get_object() and returns a list of\n items to publish in this feed.\n """\n\n def items(self):\n """\n Returns a list of items to publish in this feed.\n """\n\n items = ('Item 1', 'Item 2') # Hard-coded items.\n\n # GET_OBJECT -- This is required for feeds that publish different data\n # for different URL parameters. (See "A complex example" above.)\n\n def get_object(self, request, *args, **kwargs):\n """\n Takes the current request and the arguments from the URL, and\n returns an object represented by this feed. Raises\n django.core.exceptions.ObjectDoesNotExist on error.\n """\n\n # ITEM TITLE AND DESCRIPTION -- If title_template or\n # description_template are not defined, these are used instead. Both are\n # optional, by default they will use the unicode representation of the\n # item.\n\n def item_title(self, item):\n """\n Takes an item, as returned by items(), and returns the item's\n title as a normal Python string.\n """\n\n def item_title(self):\n """\n Returns the title for every item in the feed.\n """\n\n item_title = 'Breaking News: Nothing Happening' # Hard-coded title.\n\n def item_description(self, item):\n """\n Takes an item, as returned by items(), and returns the item's\n description as a normal Python string.\n """\n\n def item_description(self):\n """\n Returns the description for every item in the feed.\n """\n\n item_description = 'A description of the item.' # Hard-coded description.\n\n def get_context_data(self, **kwargs):\n """\n Returns a dictionary to use as extra context if either\n description_template or item_template are used.\n\n Default implementation preserves the old behavior\n of using {'obj': item, 'site': current_site} as the context.\n """\n\n # ITEM LINK -- One of these three is required. The framework looks for\n # them in this order.\n\n # First, the framework tries the two methods below, in\n # order. Failing that, it falls back to the get_absolute_url()\n # method on each item returned by items().\n\n def item_link(self, item):\n """\n Takes an item, as returned by items(), and returns the item's URL.\n """\n\n def item_link(self):\n """\n Returns the URL for every item in the feed.\n """\n\n # ITEM_GUID -- The following method is optional. If not provided, the\n # item's link is used by default.\n\n def item_guid(self, obj):\n """\n Takes an item, as return by items(), and returns the item's ID.\n """\n\n # ITEM_GUID_IS_PERMALINK -- The following method is optional. If\n # provided, it sets the 'isPermaLink' attribute of an item's\n # GUID element. This method is used only when 'item_guid' is\n # specified.\n\n def item_guid_is_permalink(self, obj):\n """\n Takes an item, as returned by items(), and returns a boolean.\n """\n\n item_guid_is_permalink = False # Hard coded value\n\n # ITEM AUTHOR NAME -- One of the following three is optional. The\n # framework looks for them in this order.\n\n def item_author_name(self, item):\n """\n Takes an item, as returned by items(), and returns the item's\n author's name as a normal Python string.\n """\n\n def item_author_name(self):\n """\n Returns the author name for every item in the feed.\n """\n\n item_author_name = 'Sally Smith' # Hard-coded author name.\n\n # ITEM AUTHOR EMAIL --One of the following three is optional. The\n # framework looks for them in this order.\n #\n # If you specify this, you must specify item_author_name.\n\n def item_author_email(self, obj):\n """\n Takes an item, as returned by items(), and returns the item's\n author's email as a normal Python string.\n """\n\n def item_author_email(self):\n """\n Returns the author email for every item in the feed.\n """\n\n item_author_email = 'test@example.com' # Hard-coded author email.\n\n # ITEM AUTHOR LINK -- One of the following three is optional. The\n # framework looks for them in this order. In each case, the URL should\n # include the "http://" and domain name.\n #\n # If you specify this, you must specify item_author_name.\n\n def item_author_link(self, obj):\n """\n Takes an item, as returned by items(), and returns the item's\n author's URL as a normal Python string.\n """\n\n def item_author_link(self):\n """\n Returns the author URL for every item in the feed.\n """\n\n item_author_link = 'http://www.example.com/' # Hard-coded author URL.\n\n # ITEM ENCLOSURE URL -- One of these three is required if you're\n # publishing enclosures. The framework looks for them in this order.\n\n def item_enclosure_url(self, item):\n """\n Takes an item, as returned by items(), and returns the item's\n enclosure URL.\n """\n\n def item_enclosure_url(self):\n """\n Returns the enclosure URL for every item in the feed.\n """\n\n item_enclosure_url = "/foo/bar.mp3" # Hard-coded enclosure link.\n\n # ITEM ENCLOSURE LENGTH -- One of these three is required if you're\n # publishing enclosures. The framework looks for them in this order.\n # In each case, the returned value should be either an integer, or a\n # string representation of the integer, in bytes.\n\n def item_enclosure_length(self, item):\n """\n Takes an item, as returned by items(), and returns the item's\n enclosure length.\n """\n\n def item_enclosure_length(self):\n """\n Returns the enclosure length for every item in the feed.\n """\n\n item_enclosure_length = 32000 # Hard-coded enclosure length.\n\n # ITEM ENCLOSURE MIME TYPE -- One of these three is required if you're\n # publishing enclosures. The framework looks for them in this order.\n\n def item_enclosure_mime_type(self, item):\n """\n Takes an item, as returned by items(), and returns the item's\n enclosure MIME type.\n """\n\n def item_enclosure_mime_type(self):\n """\n Returns the enclosure MIME type for every item in the feed.\n """\n\n item_enclosure_mime_type = "audio/mpeg" # Hard-coded enclosure MIME type.\n\n # ITEM PUBDATE -- It's optional to use one of these three. This is a\n # hook that specifies how to get the pubdate for a given item.\n # In each case, the method/attribute should return a Python\n # datetime.datetime object.\n\n def item_pubdate(self, item):\n """\n Takes an item, as returned by items(), and returns the item's\n pubdate.\n """\n\n def item_pubdate(self):\n """\n Returns the pubdate for every item in the feed.\n """\n\n item_pubdate = datetime.datetime(2005, 5, 3) # Hard-coded pubdate.\n\n # ITEM UPDATED -- It's optional to use one of these three. This is a\n # hook that specifies how to get the updateddate for a given item.\n # In each case, the method/attribute should return a Python\n # datetime.datetime object.\n\n def item_updateddate(self, item):\n """\n Takes an item, as returned by items(), and returns the item's\n updateddate.\n """\n\n def item_updateddate(self):\n """\n Returns the updateddate for every item in the feed.\n """\n\n item_updateddate = datetime.datetime(2005, 5, 3) # Hard-coded updateddate.\n\n # ITEM CATEGORIES -- It's optional to use one of these three. This is\n # a hook that specifies how to get the list of categories for a given\n # item. In each case, the method/attribute should return an iterable\n # object that returns strings.\n\n def item_categories(self, item):\n """\n Takes an item, as returned by items(), and returns the item's\n categories.\n """\n\n def item_categories(self):\n """\n Returns the categories for every item in the feed.\n """\n\n item_categories = ("python", "django") # Hard-coded categories.\n\n # ITEM COPYRIGHT NOTICE (only applicable to Atom feeds) -- One of the\n # following three is optional. The framework looks for them in this\n # order.\n\n def item_copyright(self, obj):\n """\n Takes an item, as returned by items(), and returns the item's\n copyright notice as a normal Python string.\n """\n\n def item_copyright(self):\n """\n Returns the copyright notice for every item in the feed.\n """\n\n item_copyright = 'Copyright (c) 2007, Sally Smith' # Hard-coded copyright notice.\nBehind the scenes, the high-level RSS framework uses a lower-level framework\nfor generating feeds’ XML. This framework lives in a single module:\ndjango/utils/feedgenerator.py.
\nYou use this framework on your own, for lower-level feed generation. You can\nalso create custom feed generator subclasses for use with the feed_type\nFeed option.
If you need to produce a custom feed format, you’ve got a couple of options.
\nIf the feed format is totally custom, you’ll want to subclass\nSyndicationFeed and completely replace the write() and\nwriteString() methods.
However, if the feed format is a spin-off of RSS or Atom (i.e. GeoRSS, Apple’s\niTunes podcast format, etc.), you’ve got a better choice. These types of\nfeeds typically add extra elements and/or attributes to the underlying format,\nand there are a set of methods that SyndicationFeed calls to get these extra\nattributes. Thus, you can subclass the appropriate feed generator class\n(Atom1Feed or Rss201rev2Feed) and extend these callbacks. They are:
SyndicationFeed.root_attributes(self, )Return a dict of attributes to add to the root feed element\n(feed/channel).
SyndicationFeed.add_root_elements(self, handler)Callback to add elements inside the root feed element\n(feed/channel). handler is an\nXMLGenerator from Python’s built-in SAX library;\nyou’ll call methods on it to add to the XML document in process.
SyndicationFeed.item_attributes(self, item)Return a dict of attributes to add to each item (item/entry)\nelement. The argument, item, is a dictionary of all the data passed to\nSyndicationFeed.add_item().
SyndicationFeed.add_item_elements(self, handler, item)Callback to add elements to each item (item/entry) element.\nhandler and item are as above.
For example, you might start implementing an iTunes RSS feed generator like so:
\nclass iTunesFeed(Rss201rev2Feed):\n def root_attributes(self):\n attrs = super(iTunesFeed, self).root_attributes()\n attrs['xmlns:itunes'] = 'http://www.itunes.com/dtds/podcast-1.0.dtd'\n return attrs\n\n def add_root_elements(self, handler):\n super(iTunesFeed, self).add_root_elements(handler)\n handler.addQuickElement('itunes:explicit', 'clean')\nObviously there’s a lot more work to be done for a complete custom feed class,\nbut the above example should demonstrate the basic idea.
\n