From d8c471b840f310aaab87b5b83abfab9ab73d9f2a Mon Sep 17 00:00:00 2001 From: Gabriel Hurley Date: Mon, 22 Nov 2010 06:08:38 +0000 Subject: [PATCH] Various nominal corrections for grammatical consistency, typos, and crossref targets. git-svn-id: http://code.djangoproject.com/svn/django/trunk@14675 bcc190cf-cafb-0310-a4f2-bffc1f526a37 --- docs/releases/1.3-alpha-2.txt | 65 +++++++++++++++++------------------ 1 file changed, 32 insertions(+), 33 deletions(-) diff --git a/docs/releases/1.3-alpha-2.txt b/docs/releases/1.3-alpha-2.txt index 4f71564630..3403c6e8d9 100644 --- a/docs/releases/1.3-alpha-2.txt +++ b/docs/releases/1.3-alpha-2.txt @@ -19,24 +19,24 @@ What's new in Django 1.3 alpha 2 Further tweaks to the staticfiles app ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Django 1.3 ships with a new contrib app ``'django.contrib.staticfiles'`` -to help developers handle the static media files (images, CSS, Javascript, +Django 1.3 ships with a new contrib app :mod:`django.contrib.staticfiles` +to help developers handle the static media files (images, CSS, JavaScript, etc.) that are needed to render a complete web page. -``staticfiles`` ships with the ability to automatically serve static files -during development (if the :setting:`DEBUG` is ``True``) when using the -:djadmin:`runserver` management command. Based on feedback from the -community this release adds two new options to the ``runserver`` command -to modify this behaviour: +The :mod:`~django.contrib.staticfiles` app ships with the ability to +automatically serve static files during development (if the :setting:`DEBUG` +setting is ``True``) when using the :djadmin:`runserver` management command. +Based on feedback from the community this release adds two new options to the +:djadmin:`runserver` command to modify this behaviour: - * ``--nostatic``: prevents the ``runserver`` command from serving files - completely + * ``--nostatic``: prevents the :djadmin:`runserver` command from serving + files completely. - * ``--insecure``: enables serving of static files even if stupidly - running in with :setting:`DEBUG` set to False + * ``--insecure``: enables serving of static files even if running with + :setting:`DEBUG` set to False. (This is **not** recommended!) -See the :doc:`reference documentation of the app ` -for more details or learn how to :doc:`manage static files +See the :doc:`staticfiles reference documentation ` +for more details, or learn :doc:`how to manage static files `. Translation comments @@ -61,40 +61,39 @@ Backwards-incompatible changes in 1.3 alpha 2 Introduction of STATIC_URL and STATIC_ROOT settings ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -The newly introduced :doc:`/ref/contrib/staticfiles` app extends Django's -abilities to handle static app and project files, required the additon of -settings to refer to those files in templates and code, especially in -contrast to the :setting:`MEDIA_URL` and :setting:`MEDIA_ROOT` settings that -refer to user-uploaded files. +The newly introduced :mod:`~django.contrib.staticfiles` app -- which extends +Django's abilities to handle static files for apps and projects -- required the +additon of two new settings to refer to those files in templates and code, +especially in contrast to the :setting:`MEDIA_URL` and :setting:`MEDIA_ROOT` +settings that refer to user-uploaded files. Prior to 1.3 alpha 2 these settings were called ``STATICFILES_URL`` and -``STATICFILES_ROOT`` to follow the naming scheme for app centric settings. +``STATICFILES_ROOT`` to follow the naming scheme for app-centric settings. Based on feedback from the community it became apparent that those settings -created confusion, especially given the fact handling static files is also -desired outside the use of the optional ``staticfiles`` app. +created confusion, especially given the fact that handling static files is also +desired outside the use of the optional :mod:`~django.contrib.staticfiles` app. -As a result, we take the followig steps to rectify the issue: +As a result, we took the following steps to rectify the issue: - * Two new global settings that will be used by -- **but are not limited - to** -- the :doc:`staticfiles` app: + * Two new global settings were added that will be used by, **but are not + limited to**, the :doc:`staticfiles` app: * :setting:`STATIC_ROOT` (formally ``STATICFILES_ROOT``) * :setting:`STATIC_URL` (formally ``STATICFILES_URL``) - * Moving the - ``django.contrib.staticfiles.templatetags.staticfiles.get_staticfiles_prefix`` - template tag to the core (``django.templatetags.static``) and renaming - it to :ttag:`get_static_prefix`. + * The ``django.contrib.staticfiles.templatetags.staticfiles.get_staticfiles_prefix`` + template tag was moved to Django's core (``django.templatetags.static``) and + renamed to :ttag:`get_static_prefix`. - * Moving the context processor - ``django.contrib.staticfiles.context_processors.staticfiles`` to the - core (``django.core.context_processors.static``) and renaming it to + * The ``django.contrib.staticfiles.context_processors.staticfiles`` + context processor was moved to Django's core + (``django.core.context_processors.static``) and renamed to :func:`~django.core.context_processors.static`. - * :ref:`form-media-paths` will use :setting:`STATIC_URL` as the prefix + * :ref:`form-media-paths` now uses :setting:`STATIC_URL` as the prefix **if the value is not None**, and falls back to the previously used - :setting:`MEDIA_URL`. + :setting:`MEDIA_URL` setting otherwise. The Django 1.3 roadmap ======================