From 8cbf5d102c43dc27d8728e019a607ca866b73dec Mon Sep 17 00:00:00 2001 From: Malcolm Tredinnick Date: Mon, 6 Oct 2008 08:29:05 +0000 Subject: [PATCH] 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. git-svn-id: http://code.djangoproject.com/svn/django/trunk@9165 bcc190cf-cafb-0310-a4f2-bffc1f526a37 --- docs/howto/static-files.txt | 18 ++++++++++++++++-- 1 file changed, 16 insertions(+), 2 deletions(-) diff --git a/docs/howto/static-files.txt b/docs/howto/static-files.txt index 2f4e8fc8f3..2cb6315545 100644 --- a/docs/howto/static-files.txt +++ b/docs/howto/static-files.txt @@ -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 `:: - (r'^site_media/(?P.*)$', 'django.views.static.serve', {'document_root': '/path/to/media'}), + (r'^site_media/(?P.*)$', '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 ` entry as:: + + (r'^site_media/(?P.*)$', '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.*)$', 'django.views.static.serve', {'document_root': '/path/to/media', 'show_indexes': True}), + (r'^site_media/(?P.*)$', '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: