diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/install.txt | 12 | ||||
| -rw-r--r-- | docs/model-api.txt | 35 | ||||
| -rw-r--r-- | docs/modpython.txt | 3 |
3 files changed, 42 insertions, 8 deletions
diff --git a/docs/install.txt b/docs/install.txt index b347006cbb..b18d26d5c8 100644 --- a/docs/install.txt +++ b/docs/install.txt @@ -21,14 +21,15 @@ See `How to use Django with mod_python`_ for information on how to configure mod_python once you have it installed. If you can't use mod_python for some reason, fear not: Django follows the WSGI_ -spec, which allows it to run on a variety of server platforms. As people -experiment with different server platforms, we'll update this document to -give specific installation instructions for each platform. +spec, which allows it to run on a variety of server platforms. See the +`server-arrangements wiki page`_ for specific installation instructions for +each platform. .. _Apache: http://httpd.apache.org/ .. _mod_python: http://www.modpython.org/ .. _WSGI: http://www.python.org/peps/pep-0333.html .. _How to use Django with mod_python: http://www.djangoproject.com/documentation/modpython/ +.. _server-arrangements wiki page: http://code.djangoproject.com/wiki/ServerArrangements Get your database running ========================= @@ -37,11 +38,6 @@ If you plan to use Django's database API functionality, you'll need to make sure a database server is running. Django works with PostgreSQL_ (recommended), MySQL_ and SQLite_. -Note that support for MySQL and SQLite is a recent development, and Django -hasn't been comprehensively tested in those environments. If you find any bugs -in Django's MySQL or SQLite bindings, please file them in -`Django's ticket system`_ so we can fix them immediately. - Additionally, you'll need to make sure your Python database bindings are installed. diff --git a/docs/model-api.txt b/docs/model-api.txt index 2ad2b3594d..140518e80e 100644 --- a/docs/model-api.txt +++ b/docs/model-api.txt @@ -272,6 +272,41 @@ Here are all available field types: .. _`strftime formatting`: http://docs.python.org/lib/module-time.html#l2h-1941 +``FilePathField`` + A field whose choices are limited to the filenames in a certain directory + on the filesystem. Has three special arguments, of which the first is + required: + + ====================== =================================================== + Argument Description + ====================== =================================================== + ``path`` Required. The absolute filesystem path to a + directory from which this ``FilePathField`` should + get its choices. Example: ``"/home/images"``. + + ``match`` Optional. A regular expression, as a string, that + ``FilePathField`` will use to filter filenames. + Note that the regex will be applied to the + base filename, not the full path. Example: + ``"foo.*\.txt^"``, which will match a file called + ``foo23.txt`` but not ``bar.txt`` or ``foo23.gif``. + + ``recursive`` Optional. Either ``True`` or ``False``. Default is + ``False``. Specifies whether all subdirectories of + ``path`` should be included. + ====================== =================================================== + + Of course, these arguments can be used together. + + The one potential gotcha is that ``match`` applies to the base filename, + not the full path. So, this example:: + + FilePathField(path="/home/images", match="foo.*", recursive=True) + + ...will match ``/home/images/foo.gif`` but not ``/home/images/foo/bar.gif`` + because the ``match`` applies to the base filename (``foo.gif`` and + ``bar.gif``). + ``FloatField`` A floating-point number. Has two **required** arguments: diff --git a/docs/modpython.txt b/docs/modpython.txt index acac50a6d5..d24ea29018 100644 --- a/docs/modpython.txt +++ b/docs/modpython.txt @@ -143,6 +143,9 @@ particular part of the site:: Just change ``Location`` to the root URL of your media files. +Note that the Django development server automagically serves admin media files, +but this is not the case when you use any other server arrangement. + .. _lighttpd: http://www.lighttpd.net/ .. _TUX: http://en.wikipedia.org/wiki/TUX_web_server .. _Apache: http://httpd.apache.org/ |