Browse files

Fixed #3664 -- Documented that get_absolute_url() and item_link() (in

syndication) links are expected to be strings that can be used in URLs without
further quoting or encoding.

git-svn-id: bcc190cf-cafb-0310-a4f2-bffc1f526a37
  • Loading branch information...
malcolmt committed May 15, 2007
1 parent a10e73a commit 7969c1bb655d24f98e8653d9008c90c6b0280673
Showing with 13 additions and 1 deletion.
  1. +9 −0 docs/model-api.txt
  2. +4 −1 docs/syndication_feeds.txt
@@ -1759,6 +1759,15 @@ But this template code is good::
<a href="{{ object.get_absolute_url }}">{{ }}</a>
+.. note::
+ The string you return from ``get_absolute_url()`` must be use only ASCII
+ characters (required by the URI spec, `RFC 2396`_) that has been
+ URL-encoded, if necessary. Code and templates using ``get_absolute_url()``
+ should be able to use the result directly without needing to do any
+ further processing.
+.. _RFC 2396:
The ``permalink`` decorator
@@ -146,7 +146,10 @@ put into those elements.
exist, it tries calling a method ``item_link()`` in the ``Feed`` class,
passing it a single parameter, ``item``, which is the object itself.
Both ``get_absolute_url()`` and ``item_link()`` should return the item's
- URL as a normal Python string.
+ URL as a normal Python string. As with ``get_absolute_url()``, the
+ result of ``item_link()`` will be included directly in the URL, so you
+ are responsible for doing all necessary URL quoting and conversion to
+ ASCII inside the method itself.
* For the LatestEntries example above, we could have very simple feed templates:

0 comments on commit 7969c1b

Please sign in to comment.