[1.0.X] Fixed #8688 -- Added a note about using a settings variable for the

static media viewer with the development server. Based on a suggestion from
trodrigues.

Backport of r9165 from trunk.


git-svn-id: http://code.djangoproject.com/svn/django/branches/releases/1.0.X@9171 bcc190cf-cafb-0310-a4f2-bffc1f526a37
This commit is contained in:
Malcolm Tredinnick 2008-10-06 08:44:40 +00:00
parent 167a131e53
commit 51fb4bb0d3
1 changed files with 16 additions and 2 deletions

View File

@ -38,7 +38,8 @@ Here's the formal definition of the :func:`~django.views.static.serve` view:
To use it, just put this in your :ref:`URLconf <topics-http-urls>`::
(r'^site_media/(?P<path>.*)$', 'django.views.static.serve', {'document_root': '/path/to/media'}),
(r'^site_media/(?P<path>.*)$', 'django.views.static.serve',
{'document_root': '/path/to/media'}),
...where ``site_media`` is the URL where your media will be rooted, and
``/path/to/media`` is the filesystem root for your media. This will call the
@ -56,6 +57,18 @@ Given the above URLconf:
* The file ``/path/bar.jpg`` will not be accessible, because it doesn't
fall under the document root.
Of course, it's not compulsory to use a fixed string for the
``'document_root'`` value. You might wish to make that an entry in your
settings file and use the setting value there. That will allow you and
other developers working on the code to easily change the value as
required. For example, if we have a line in ``settings.py`` that says::
STATIC_DOC_ROOT = '/path/to/media'
...we could write the above :ref:`URLconf <topics-http-urls>` entry as::
(r'^site_media/(?P<path>.*)$', 'django.views.static.serve',
{'document_root': settings.STATIC_DOC_ROOT}),
Directory listings
==================
@ -66,7 +79,8 @@ Optionally, you can pass the ``show_indexes`` parameter to the
For example::
(r'^site_media/(?P<path>.*)$', 'django.views.static.serve', {'document_root': '/path/to/media', 'show_indexes': True}),
(r'^site_media/(?P<path>.*)$', 'django.views.static.serve',
{'document_root': '/path/to/media', 'show_indexes': True}),
You can customize the index view by creating a template called
``static/directory_index.html``. That template gets two objects in its context: