Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse code

Added a 'Directory listings' section to docs/static_files.txt

git-svn-id: http://code.djangoproject.com/svn/django/trunk@1457 bcc190cf-cafb-0310-a4f2-bffc1f526a37
  • Loading branch information...
commit ed97929b91c899fd880460e228d7c2622213980b 1 parent c8e98f4
Adrian Holovaty authored November 27, 2005

Showing 1 changed file with 39 additions and 0 deletions. Show diff stats Hide diff stats

  1. 39  docs/static_files.txt
39  docs/static_files.txt
@@ -36,6 +36,8 @@ Just put this in your URLconf_::
36 36
 ...where ``site_media`` is the URL where your media will be rooted, and
37 37
 ``/path/to/media`` is the filesystem root for your media.
38 38
 
  39
+You must pass a ``document_root`` parameter to indicate the filesystem root.
  40
+
39 41
 Examples:
40 42
 
41 43
     * The file ``/path/to/media/foo.jpg`` will be made available at the URL
@@ -49,6 +51,43 @@ Examples:
49 51
 
50 52
 .. _URLconf: http://www.djangoproject.com/documentation/url_dispatch/
51 53
 
  54
+Directory listings
  55
+==================
  56
+
  57
+Optionally, you can pass a ``show_indexes`` parameter to the ``static.serve``
  58
+view. This is ``False`` by default. If it's ``True``, Django will display file
  59
+listings for directories.
  60
+
  61
+Example::
  62
+
  63
+    (r'^site_media/(?P<path>.*)$', 'django.views.static.serve', {'document_root': '/path/to/media', 'show_indexes': True}),
  64
+
  65
+You can customize the index view by creating a template called
  66
+``static/directory_index``. That template gets two objects in its context:
  67
+
  68
+    * ``directory`` -- the directory name (a string)
  69
+    * ``file_list`` -- a list of file names (as strings) in the directory
  70
+
  71
+Here's the default ``static/directory_index`` template::
  72
+
  73
+    <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  74
+    <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
  75
+    <head>
  76
+        <meta http-equiv="Content-type" content="text/html; charset=utf-8" />
  77
+        <meta http-equiv="Content-Language" content="en-us" />
  78
+        <meta name="robots" content="NONE,NOARCHIVE" />
  79
+        <title>Index of {{ directory }}</title>
  80
+    </head>
  81
+    <body>
  82
+        <h1>Index of {{ directory }}</h1>
  83
+        <ul>
  84
+        {% for f in file_list %}
  85
+        <li><a href="{{ f }}">{{ f }}</a></li>
  86
+        {% endfor %}
  87
+        </ul>
  88
+    </body>
  89
+    </html>
  90
+
52 91
 Limiting use to DEBUG=True
53 92
 ==========================
54 93
 

0 notes on commit ed97929

Please sign in to comment.
Something went wrong with that request. Please try again.