diff options
Diffstat (limited to 'docs/ref')
| -rw-r--r-- | docs/ref/contrib/sitemaps.txt | 9 | ||||
| -rw-r--r-- | docs/ref/templates/builtins.txt | 19 | ||||
| -rw-r--r-- | docs/ref/urlresolvers.txt | 11 |
3 files changed, 26 insertions, 13 deletions
diff --git a/docs/ref/contrib/sitemaps.txt b/docs/ref/contrib/sitemaps.txt index 12ed61b97a..8c48651054 100644 --- a/docs/ref/contrib/sitemaps.txt +++ b/docs/ref/contrib/sitemaps.txt @@ -54,7 +54,8 @@ Initialization To activate sitemap generation on your Django site, add this line to your :doc:`URLconf </topics/http/urls>`:: - (r'^sitemap\.xml$', 'django.contrib.sitemaps.views.sitemap', {'sitemaps': sitemaps}) + url(r'^sitemap\.xml$', 'django.contrib.sitemaps.views.sitemap', + {'sitemaps': sitemaps}, name='django.contrib.sitemaps.views.sitemap') This tells Django to build a sitemap when a client accesses :file:`/sitemap.xml`. @@ -284,7 +285,8 @@ Here's an example of a :doc:`URLconf </topics/http/urls>` using both:: # ... # the sitemap - url(r'^sitemap\.xml$', 'django.contrib.sitemaps.views.sitemap', {'sitemaps': sitemaps}), + url(r'^sitemap\.xml$', 'django.contrib.sitemaps.views.sitemap', + {'sitemaps': sitemaps}, name='django.contrib.sitemaps.views.sitemap'), ] .. _URLconf: ../url_dispatch/ @@ -325,7 +327,8 @@ the sitemap. For example:: url(r'^about/$', 'views.about', name='about'), url(r'^license/$', 'views.license', name='license'), # ... - url(r'^sitemap\.xml$', 'django.contrib.sitemaps.views.sitemap', {'sitemaps': sitemaps}) + url(r'^sitemap\.xml$', 'django.contrib.sitemaps.views.sitemap', + {'sitemaps': sitemaps}, name='django.contrib.sitemaps.views.sitemap') ] diff --git a/docs/ref/templates/builtins.txt b/docs/ref/templates/builtins.txt index 0e1266e0fb..9d4093e4da 100644 --- a/docs/ref/templates/builtins.txt +++ b/docs/ref/templates/builtins.txt @@ -982,7 +982,7 @@ resulting path will be encoded using :func:`~django.utils.encoding.iri_to_uri`. This is a way to output links without violating the DRY principle by having to hard-code URLs in your templates:: - {% url 'path.to.some_view' v1 v2 %} + {% url 'some-url-name' v1 v2 %} The first argument is a path to a view function in the format ``package.package.module.function``. It can be a quoted literal or any other @@ -991,7 +991,7 @@ should be space-separated values that will be used as arguments in the URL. The example above shows passing positional arguments. Alternatively you may use keyword syntax:: - {% url 'path.to.some_view' arg1=v1 arg2=v2 %} + {% url 'some-url-name' arg1=v1 arg2=v2 %} Do not mix both positional and keyword syntax in a single call. All arguments required by the URLconf should be present. @@ -1002,7 +1002,7 @@ takes a client ID (here, ``client()`` is a method inside the views file .. code-block:: python - ('^client/([0-9]+)/$', 'app_views.client') + ('^client/([0-9]+)/$', 'app_views.client', name='app-views-client') If this app's URLconf is included into the project's URLconf under a path such as this: @@ -1013,7 +1013,7 @@ such as this: ...then, in a template, you can create a link to this view like this:: - {% url 'app_views.client' client.id %} + {% url 'app-views-client' client.id %} The template tag will output the string ``/clients/client/123/``. @@ -1028,7 +1028,7 @@ cause your site to display an error page. If you'd like to retrieve a URL without displaying it, you can use a slightly different call:: - {% url 'path.to.view' arg arg2 as the_url %} + {% url 'some-url-name' arg arg2 as the_url %} <a href="{{ the_url }}">I'm linking to {{ the_url }}</a> @@ -1038,7 +1038,7 @@ The scope of the variable created by the ``as var`` syntax is the This ``{% url ... as var %}`` syntax will *not* cause an error if the view is missing. In practice you'll use this to link to views that are optional:: - {% url 'path.to.view' as the_url %} + {% url 'some-url-name' as the_url %} {% if the_url %} <a href="{{ the_url }}">Link to optional stuff</a> {% endif %} @@ -1051,6 +1051,13 @@ This will follow the normal :ref:`namespaced URL resolution strategy <topics-http-reversing-url-namespaces>`, including using any hints provided by the context as to the current application. +.. deprecated:: 1.8 + + The dotted Python path syntax is deprecated and will be removed in + Django 2.0:: + + {% url 'path.to.some_view' v1 v2 %} + .. warning:: Don't forget to put quotes around the function path or pattern name, diff --git a/docs/ref/urlresolvers.txt b/docs/ref/urlresolvers.txt index 491c4cd14e..79c219a8d8 100644 --- a/docs/ref/urlresolvers.txt +++ b/docs/ref/urlresolvers.txt @@ -16,12 +16,11 @@ your code, Django provides the following function: :ref:`URL pattern name <naming-url-patterns>`, or the callable view object. For example, given the following ``url``:: - url(r'^archive/$', 'news.views.archive', name='news_archive') + from news import views -you can use any of the following to reverse the URL:: + url(r'^archive/$', views.archive, name='news_archive') - # using the Python path - reverse('news.views.archive') +you can use any of the following to reverse the URL:: # using the named URL reverse('news_archive') @@ -63,6 +62,10 @@ namespaces into URLs on specific application instances, according to the The ``urlconf`` argument is the URLconf module containing the url patterns to use for reversing. By default, the root URLconf for the current thread is used. +.. deprecated:: 1.8 + + The ability to reverse using the Python path, e.g. + ``reverse('news.views.archive')``, has been deprecated. .. admonition:: Make sure your views are all correct. |