Skip to content


Subversion checkout URL

You can clone with
Download ZIP
Browse files

Fixed #472 - added notes about File/ImageFields from the FAQ to the m…

…odel API doc

git-svn-id: bcc190cf-cafb-0310-a4f2-bffc1f526a37
  • Loading branch information...
1 parent 998fc72 commit 1838c763070b5e060787d71a8b4d3819fd4871e6 @jacobian jacobian committed
Showing with 23 additions and 2 deletions.
  1. +23 −2 docs/model-api.txt
25 docs/model-api.txt
@@ -248,7 +248,28 @@ Here are all available field types:
uploaded files don't fill up the given directory).
The admin represents this as an ``<input type="file">`` (a file-upload widget).
+ Using a `FieldField` or an ``ImageField`` (see below) in a model takes a few
+ steps:
+ 1. In your settings file, you'll need to define ``MEDIA_ROOT``as the
+ full path to a directory where you'd like Django to store uploaded
+ files. (For performance, these files are not stored in the database.)
+ Define ``MEDIA_URL`` as the base public URL of that directory. Make
+ sure that this directory is writable by the Web server's user
+ account.
+ 2. Add the ``FileField`` or ``ImageField`` to your model, making sure
+ to define the ``upload_to`` option to tell Django to which
+ subdirectory of ``MEDIA_ROOT`` it should upload files.
+ 3. All that will be stored in your database is a path to the file
+ (relative to ``MEDIA_ROOT``). You'll must likely want to use the
+ convenience ``get_<fieldname>_url`` function provided by Django. For
+ example, if your ``ImageField`` is called ``mug_shot``, you can get
+ the absolute URL to your image in a template with ``{{
+ object.get_mug_shot_url }}``.
.. _`strftime formatting`:
@@ -281,7 +302,7 @@ Here are all available field types:
width of the image each time a model instance is saved.
Requires the `Python Imaging Library`_.
.. _Python Imaging Library:

0 comments on commit 1838c76

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