p31829507
/
django
mirror of https://github.com/django/django.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Made a bunch of doc improvements 

git-svn-id: http://code.djangoproject.com/svn/django/trunk@41 bcc190cf-cafb-0310-a4f2-bffc1f526a37
This commit is contained in:
Jacob Kaplan-Moss 2005-07-15 00:42:28 +00:00
parent 5fc13947fc
commit f19dbab514
4 changed files with 859 additions and 1041 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
docs/db-api.txt
View File

@ -2,7 +2,11 @@
Database API reference Database API reference
====================== ======================
XXX INTRO HERE XXX Once you've created your `data models`_, you'll need to lookup data from the
database. This document explains the database abstraction API derived from the
models, and how to create, retrieve, and update objects.
.. _`data models`: http://www.djangoproject.com/documentation/model_api/
Throughout this reference, we'll refer to the following Poll application:: Throughout this reference, we'll refer to the following Poll application::
@ -287,6 +291,18 @@ For example::
SELECT * FROM polls_polls WHERE question LIKE 'Who%' AND id IN (3, 4, 5, 20); SELECT * FROM polls_polls WHERE question LIKE 'Who%' AND id IN (3, 4, 5, 20);
Changing objects
================
Once you've retrieved an object from the database using any of the above
options, changing it is extremely easy. Make changes directly to the
objects fields, then call the object's ``save()`` method::
>>> p = polls.get_object(id__exact=15)
>>> p.slug = "new_slug"
>>> p.pub_date = datetime.datetime.now()
>>> p.save()
Creating new objects Creating new objects
==================== ====================

75
docs/faq.txt
View File

@ -2,16 +2,20 @@
Django FAQ Django FAQ
========== ==========
The admin site is ugly! How can I change it? General questions
--------------------------------------------- =================
We think it's very purty, but if you don't agree you can modify the admin site's Why does this project exist?
presentation by editing the CSS stylesheet and/or associated image files. The ----------------------------
site is built using semantic HTML, so any changes you'd like to make should be
possible by editing the CSS stylesheet. We've got a `guide to the CSS used
in the admin`_ to get you started.
.. _`guide to the CSS used in the admin`: http://www.djangoproject.com/FIXME/ Django grew from a very practical need: in our fast-paced newsroom, we often
have only a matter of hours to take a complicated web application from
concept to public launch. Django was designed to not only allow us to
build web applications quickly, but to allow us to build them right.
Django would not be possible without a whole host of open-source projects --
Apache, Python, and PostgresSQL to name a few -- and we're thrilled to be
able to give something back to the open source community.
How do you pronounce "Django"? How do you pronounce "Django"?
------------------------------ ------------------------------
@ -27,23 +31,66 @@ We've been using Django for almost two years. Sites built on Django have
weathered traffic spikes of over one million hits an hour, and at least weathered traffic spikes of over one million hits an hour, and at least
one slashdotting. Yes; it's quite stable. one slashdotting. Yes; it's quite stable.
Does Django scale?
------------------
Yes. Compared to development time, hardware is cheap, and so Django is
designed to take advantage of as much hardware as you can throw at it.
Django ships with clean separation of the database layer from the
application layer and a simple yet powerful `cache framework`_.
.. _`cache framework`: http://www.djangoproject.com/documentation/cache/
Who's behind this? Who's behind this?
------------------ ------------------
`Adrian Holovaty`_ `Adrian Holovaty`_
XXX Adrian is a gypsy-jazz virtuoso, an amateur Beatles historian and a proud
Chicagoan. He's also a pretty decent programmer, with a knack for whipping
data into shape and putting it to work for the good of his fellow man.
Adrian is the lead developer at World Online and the man behind the code at
chicagocrime.org.
`Simon Willison`_ `Simon Willison`_
XXX XXX
`Jacob Kaplan-Moss`_ `Jacob Kaplan-Moss`_
XXX Jacob is a whipper-snapper from California who spends equal time coding and
cooking. He does Web development for World Online and actively hacks on
various cool side projects. He's contributed to the Python-ObjC bindings and
was the first guy to figure out how to write Tivo apps in Python. Lately
he's been messing with Python on the PSP.
`Wilson Miner`_. `Wilson Miner`_
XXX Wilson's design-fu makes us all look like rock stars. When not sneaking
into apartment complex swimming pools he is the Commercial Development
Director for World Online, which means he makes the money that pays all our
paychecks.
.. _`Adrian Holovaty`: http://www.holovaty.com/ .. _`Adrian Holovaty`: http://www.holovaty.com/
.. _`Simon Willison`: http://simon.incutio.com/ .. _`Simon Willison`: http://simon.incutio.com/
.. _`Jacob Kaplan-Moss`: http://www.jacobian.org/ .. _`Jacob Kaplan-Moss`: http://www.jacobian.org/
.. _`Wilson Miner`: http://www.wilsonminer.com/live/ .. _`Wilson Miner`: http://www.wilsonminer.com/live/
Using Django
============
How do I get started?
---------------------
...
The admin interface
===================
The admin site is ugly! How can I change it?
---------------------------------------------
We think it's very purty, but if you don't agree you can modify the admin site's
presentation by editing the CSS stylesheet and/or associated image files. The
site is built using semantic HTML, so any changes you'd like to make should be
possible by editing the CSS stylesheet. We've got a `guide to the CSS used
in the admin`_ to get you started.
.. _`guide to the CSS used in the admin`: http://www.djangoproject.com/documentation/admin_css/

811
docs/model-api.txt
View File

@ -2,141 +2,117 @@
Model reference Model reference
=============== ===============
XXX INTRO XXX Django's models are the bread and butter of the framework. There's a huge
array of options available to you when defining your data models; this
document explains all of them.
Options for models Options for models
================== ==================
A list of all possible options for a model object follows. Although there's a wide A list of all possible options for a model object follows. Although there's a
array of possible options, only ``fields`` is required. wide array of possible options, only ``fields`` is required.
``admin`` ``admin``
--------- A ``meta.Admin`` object; see `Admin options`_. If this field isn't given,
the object will not have an admin interface.
A ``meta.Admin`` object; see `Admin options`_. If this field isn't given,
the object will not have an admin interface.
``db_table`` ``db_table``
------------ The name of the database table to use for the module::
The name of the database table to use for the module:: db_table = "pizza_orders"
db_table = "pizza_orders" If not given, this will use ``app_label + '_' + module_name``.
If not given, this will use ``app_label + '_' + module_name``.
``exceptions`` ``exceptions``
-------------- Names of extra exception subclasses to include in the generated module.
These exceptions are available from instance methods and from module-level
Names of extra exception subclasses to include in the generated module. methods::
These exceptions are available from instance methods and from module-level
methods:: exceptions = ("DisgustingToppingsException", "BurntCrust")
exceptions = ("DisgustingToppingsException", "BurntCrust")
``fields`` ``fields``
---------- A list of field objects; see `Field objects`_. For example::
A list of field objects; see `Field objects`_. For example::
fields = (
meta.CharField('customer_name', 'customer name', maxlength=15),
meta.BooleanField('use_extra_cheese', 'use extra cheese'),
meta.IntegerField('customer_type', 'customer type', choices=CUSTOMER_TYPE_CHOICES),
...
)
fields = (
meta.CharField('customer_name', 'customer name', maxlength=15),
meta.BooleanField('use_extra_cheese', 'use extra cheese'),
meta.IntegerField('customer_type', 'customer type', choices=CUSTOMER_TYPE_CHOICES),
...
)
``get_latest_by`` ``get_latest_by``
----------------- The name of a date or datetime field; if given, the module will have a
``get_latest()`` function which fetches the "latest" object in terms of
The name of a date or datetime field; if given, the module will have a that field::
``get_latest()`` function which fetches the "latest" object in terms of
that field:: get_latest_by = "order_date"
get_latest_by = "order_date"
``module_constants`` ``module_constants``
-------------------- A dict of name/values to use as extra module-level constants::
A dict of name/values to use as extra module-level constants:: module_constants = {
'MEAT_TYPE_PEPPERONI' : 1,
module_constants = { 'MEAT_TYPE_SAUSAGE' : 2,
'MEAT_TYPE_PEPPERONI' : 1, }
'MEAT_TYPE_SAUSAGE' : 2,
}
``module_name`` ``module_name``
--------------- The name of the module::
The name of the module:: module_name = "pizza_orders"
module_name = "pizza_orders" If not given this will use a lowercased version of the class name.
If not given this will use a lowercased version of the class name.
``order_with_respect_to`` ``order_with_respect_to``
------------------------- Marks this object as "orderable" with respect to the given field. This is
almost always used with related objects to allow them to be ordered with
Marks this object as "orderable" with respect to the given field. This is respect to a parent object. For example, if a ``PizzaToppping`` relates to
almost always used with related objects to allow them to be ordered with a ``Pizza`` object, you might use::
respect to a parent object. For example, if a ``PizzaToppping`` relates to
a ``Pizza`` object, you might use:: order_with_respect_to = 'pizza_id'
order_with_respect_to = 'pizza_id' to allow the toppings to be ordered with respect to the associated pizza.
to allow the toppings to be ordered with respect to the associated pizza.
``ordering`` ``ordering``
------------ The default ordering for tho object::
The default ordering for tho object:: ordering = (('order_date', 'DESC'),)
ordering = (('order_date', 'DESC'),) This is a tuple of 2-tuples; each 2-tuple is ``(field_name, ordering_type)``
where ordering_type is either ``"ASC"`` or ``"DESC"``. You may also use the
magic ``(None, "RANDOM")`` ordering tuple for random ordering.
This is a tuple of 2-tuples; each 2-tuple is ``(field_name, ordering_type)``
where ordering_type is either ``"ASC"`` or ``"DESC"``. You may also use the
magic ``(None, "RANDOM")`` ordering tuple for random ordering.
``permissions`` ``permissions``
--------------- Extra permissions to enter into the permissions table when creating this
object. A add, delete, and change permission is automatically created for
Extra permissions to enter into the permissions table when creating this each object; this option specifies extra permissions::
object. A add, delete, and change permission is automatically created for
each object; this option specifies extra permissions:: permissions = (("may_delivier_pizzas", "Can deliver pizzas"),)
permissions = (("may_delivier_pizzas", "Can deliver pizzas"),) This is a list of 2-tuples of
``(permission_code, human_readable_permission_name)``.
This is a list of 2-tuples of
``(permission_code, human_readable_permission_name)``.
``unique_together`` ``unique_together``
------------------- Sets of field names that, taken together, must be unique::
Sets of field names that, taken together, must be unique:: unique_together = (("driver_id", "restaurant_id"),)
unique_together = (("driver_id", "restaurant_id"),) This is a list of lists of fields that must be unique when considered
together.
This is a list of lists of fields that must be unique when considered
together.
``verbose_name`` ``verbose_name``
---------------- A human-readable name for the object, singular::
A human-readable name for the object, singular:: verbose_name = "pizza"
verbose_name = "pizza" If not given, this will use a munged version of the class name:
``CamelCase`` becomes ``camel case``.
If not given, this will use a munged version of the class name:
``CamelCase`` becomes ``camel case``.
``verbose_name_plural`` ``verbose_name_plural``
----------------------- The plural name for the object::
The plural name for the object:: verbose_name_plural = "stories"
verbose_name_plural = "stories" If not given, ``verbose_name + "s"`` will automatically be used.
If not given, ``verbose_name + "s"`` will automatically be used.
Field objects Field objects
============= =============
@ -249,256 +225,91 @@ options that are common to all field types. These options are:
Field Types Field Types
----------- -----------
``AutoField`` ``AutoField``
````````````` An ``IntegerField`` that automatically increments. You usually won't need to
use this directly; a primary key field will automatically be added to your
An ``IntegerField`` that automatically increments. You usually won't need to model if you don't specify otherwise. That automatically added field is::
use this directly; a primary key field will automatically be added to your
model if you don't specify otherwise. That automatically added field is:: meta.AutoField('id', 'ID', primary_key=True)
meta.AutoField('id', 'ID', primary_key=True)
``BooleanField`` ``BooleanField``
```````````````` A true/false field.
A true/false field.
``CharField`` ``CharField``
````````````` A text field. These are displayed in the admin as single-line text inputs, so
for large amounts of text use a ``TextField``.
A text field. These are displayed in the admin as single-line text inputs, so
for large amounts of text use a ``TextField``. ``CharField``s have an extra required argument: ``maxlength``; the maximum
length (in characters) of the field.
``CharField``s have an extra required argument: ``maxlength``; the maximum
length (in characters) of the field.
``CommaSeparatedIntegerField`` ``CommaSeparatedIntegerField``
`````````````````````````````` A field of integers separated by commas.
A field of integers separated by commas.
``DateField`` ``DateField``
````````````` A, um, date field. Has a few extra optional options:
A, um, date field. Has a few extra optional options: ====================== ===================================================
Option Description
====================== =================================================== ====================== ===================================================
Option Description ``auto_now`` Automatically set the field to now every time the
====================== =================================================== object is saved. Useful for "last-modified"
``auto_now`` Automatically set the field to now every time the timestamps.
object is saved. Useful for "last-modified"
timestamps. ``auto_now_add`` Automatically set the field to now when the object
is first created. Useful for creation timestamps.
``auto_now_add`` Automatically set the field to now when the object ====================== ===================================================
is first created. Useful for creation timestamps.
====================== ===================================================
``DateTimeField`` ``DateTimeField``
````````````````` A date and time field. Takes the same extra options as ``DateField``.
A date and time field. Takes the same extra options as ``DateField``.
``EmailField`` ``EmailField``
`````````````` A ``CharField`` that checks that the value is a valid email address. Because
validating email addresses can be tricky, this is a pretty loose test.
A ``CharField`` that checks that the value is a valid email address. Because
validating email addresses can be tricky, this is a pretty loose test.
``FileField`` ``FileField``
````````````` A file-upload field. Takes on additional option, ``upload_to`` which is
a path to upload the file to. This path may contain `strftime formatting`_
A file-upload field. Takes on additional option, ``upload_to`` which is which will be replaced by the date/time of the file upload (so that uploaded
a path to upload the file to. This path may contain `strftime formatting`_ files don't fill up the given directory).
which will be replaced by the date/time of the file upload (so that uploaded
files don't fill up the given directory). .. _`strftime formatting`: http://docs.python.org/lib/module-time.html#l2h-1941
.. _`strftime formatting`: http://docs.python.org/lib/module-time.html#l2h-1941
``FloatField`` ``FloatField``
`````````````` A floating-point number. Has two additional required options:
A floating-point number. Has two additional required options: ====================== ===================================================
Option Description
====================== =================================================== ====================== ===================================================
Option Description ``max_digits`` The maximum number of digits allowed in the number.
====================== ===================================================
``max_digits`` The maximum number of digits allowed in the number. ``decimal_places`` The number of decimal places to store with the
number
====================== ===================================================
For example, to store numbers up to 999 with a resolution of 2 decimal places,
you'd use::
meta.FloatField(..., max_digits=5, decimal_places=2)
And to store numbers up to one million with a resolution of 10 decimal places::
meta.FloatField(..., max_digits=19, decimal_places=10)
``decimal_places`` The number of decimal places to store with the
number
====================== ===================================================
For example, to store numbers up to 999 with a resolution of 2 decimal places,
you'd use::
meta.FloatField(..., max_digits=5, decimal_places=2)
And to store numbers up to one million with a resolution of 10 decimal places::
meta.FloatField(..., max_digits=19, decimal_places=10)
``ForeignKey`` ``ForeignKey``
`````````````` A many-to-one relationship to the primary key in another object. So, to give a
``Topping`` object a many-to-one relationship to ``Pizza`` (i.e. there are
A many-to-one relationship to the primary key in another object. So, to give a many toppings on a pizza)::
``Topping`` object a many-to-one relationship to ``Pizza`` (i.e. there are
many toppings on a pizza)::
meta.ForeignKey(Pizza)
This is equivalent to (but much clearer than):: meta.ForeignKey(Pizza)
meta.IntegerField('pizza_id', 'pizza', rel=meta.ManyToOne(Pizza, 'pizza', 'id')) ``ForeignKey`` fields take a large number of options for defining how the
relationship should work:
``ForeignKey`` fields take all the arguments of ``ManyToOne`` relations (see ====================== ===================================================
Relationships_, below for what those arguments are), plus the following extra
options:
====================== ===================================================
Option Description
====================== ===================================================
``to_field`` The field on the related object that the relation
is to. This is almost always ``id``, but if the
PK on the other object is named something
different, this is how to indicate that.
``rel_name`` The name of the relation. In the above exmaple,
this would default to 'pizza' (so that the
``Toppings`` object would have a ``get_pizza()``
function; if you set ``rel_name`` to "pie", then
the function would be called ``get_pie()`` and the
field name would be ``pie_id``.
====================== ===================================================
``ImageField``
``````````````
Like a ``FieldField``, but validates that the uploaded object is a valid
image. Has two extra optional arguments, ``height_field`` and ``width_field``
which, if set, will be auto-populated with the height and width of the image.
``IntegerField``
````````````````
An integer, surprisingly.
``IPAddressField``
``````````````````
An IP address, in string format (i.e. "24.124.1.30").
``ManyToManyField``
```````````````````
XXX document once Adrian reworks this XXX
``NullBooleanField``
````````````````````
Like a ``BooleanField``, but allows ``NULL`` as one of the options. Use this
instead of a ``BooleanField`` with ``null=True`` .
``PhoneNumberField``
````````````````````
Validates that the value is a valid phone number.
``PositiveIntegerField``
````````````````````````
Like an ``IntegerField``, but must be positive.
``PositiveSmallIntegerField``
`````````````````````````````
Like a ``PositiveIntegerField``, but only allows values below 32767.
``SlugField``
`````````````
A "slug" suitable for parts of a URL; only allows alpha-numeric characters and
underscores.
Implies ``maxlength=50`` and ``db_index=True``.
Accepts an extra option, ``prepopulate_from`` which is a list of fields from
which to auto-populate the slug.
``SmallIntegerField``
`````````````````````
Like an ``IntegerField``, but must be between -32768 and 32767.
``TextField``
`````````````
A large text field (``<textarea>`` in HTML).
``TimeField``
`````````````
A time. Accepts the same auto-population options as ``DateField`` and
``DateTimeField``.
``URLField``
````````````
A field for a URL. If the ``verify_exists`` option is ``True``, the URL given
will be checked for existence (i.e. actually loads and doesn't give a 404
response).
``USStateField``
````````````````
A US state.
``XMLField``
````````````
A field containing XML. Takes one required argument, ``schema_path`` which
is the path to a RelaxNG_ scheme against which to validate the field.
.. _RelaxNG: http://www.relaxng.org/
Relationships
=============
The ``rel`` option for a field marks that field as being a relationship to
another object. For the most common cases, using ``ForeignKey`` or
``ManyToManyField`` is best; these "shortcuts" encapsulate best practices
in database design (i.e. using integer foreign keys into another table's
primary key). If you do need to explicitly create a relation, these relation
objects should be used as the value of the ``rel`` attribute. Also, all
the options for ``ManyToOne`` are allowed as options for ``ForeignKey``,
and the same goes for ``ManyToMany`` and ``ManyToManyField``.
``ManyToOne``
-------------
Signifies a many-to-one relation: if a ``Pizza`` can have many ``Topping``s,
then the ``Topping`` object should have a ``ManyToOne`` relation to ``Pizza``.
The three positional arguments to ``ManyToMany`` are:
* The class to relate to (i.e. ``Pizza`` or ``core.Site``).
* The name of the relation (i.e. ``pizza``, or ``site``); this is used in
the generated functions for managing that relationship (i.e.
``get_pizza`` and ``get_site``).
* The name of the field the relationship "points" to. In most cases this
will be "id", but if the other object's PK isn't named "id", this
must match the PK field name.
The keyword arguments accepted by ``ManyToOne`` are:
======================= ==================================================
Option Description Option Description
======================= ================================================== ====================== ===================================================
``edit_inline`` If ``True``, this related object is edited ``edit_inline`` If ``True``, this related object is edited
"inline" on the related object's page. This means "inline" on the related object's page. This means
that the object will not have its own admin that the object will not have its own admin
@ -511,7 +322,7 @@ The keyword arguments accepted by ``ManyToOne`` are:
``meta.STACKED``. ``meta.STACKED``.
``limit_choices_to`` A dictionary of lookup arguments and values (see ``limit_choices_to`` A dictionary of lookup arguments and values (see
the `Dictionary API reference`_) to limit choices the `Database API reference`_) to limit choices
of this object to. Use this along with of this object to. Use this along with
``meta.LazyDate`` to limit choices of objects ``meta.LazyDate`` to limit choices of objects
by date, for example:: by date, for example::
@ -524,8 +335,6 @@ The keyword arguments accepted by ``ManyToOne`` are:
Not compatible with ``edit_inline``. Not compatible with ``edit_inline``.
``lookup_overrides`` XXX FIXME XXX
``max_num_in_admin`` For inline-edited objects, this is the maximum ``max_num_in_admin`` For inline-edited objects, this is the maximum
number of related objects to display in the admin. number of related objects to display in the admin.
Thus, if a pizza could only have up to 10 Thus, if a pizza could only have up to 10
@ -556,6 +365,13 @@ The keyword arguments accepted by ``ManyToOne`` are:
rows to make a menu practical. rows to make a menu practical.
Not used with ``edit_inline``. Not used with ``edit_inline``.
``rel_name`` The name of the relation. In the above exmaple,
this would default to 'pizza' (so that the
``Toppings`` object would have a ``get_pizza()``
function; if you set ``rel_name`` to "pie", then
the function would be called ``get_pie()`` and the
field name would be ``pie_id``.
``related_name`` The name to use for the relation from the related ``related_name`` The name to use for the relation from the related
object back to this one. For example, when if object back to this one. For example, when if
@ -596,37 +412,74 @@ The keyword arguments accepted by ``ManyToOne`` are:
which would give the category objects methods which would give the category objects methods
named ``get_primary_story_list()`` and named ``get_primary_story_list()`` and
``get_secondary_story_list()``. ``get_secondary_story_list()``.
``to_field`` The field on the related object that the relation
is to. This is almost always ``id``, but if the
PK on the other object is named something
different, this is how to indicate that.
======================= ================================================== ======================= ==================================================
.. _`Dictionary API reference`: http://www.djangoproject.com/FIXME/ .. _`Database API reference`: http://www.djangoproject.com/documentation/db_api/
``ManyToMany`` ``ImageField``
-------------- Like a ``FieldField``, but validates that the uploaded object is a valid
image. Has two extra optional arguments, ``height_field`` and ``width_field``
XXX will this still exist given the changes to ManyToManyField? XXX which, if set, will be auto-populated with the height and width of the image.
``OneToOne`` ``IntegerField``
------------ An integer, surprisingly.
Signifies a one-to-one relationship. This is most useful on the primary key ``IPAddressField``
of an object when that object "extends" another object in some way. An IP address, in string format (i.e. "24.124.1.30").
For example, if you are building a database of "places", you would build pretty ``ManyToManyField``
standard stuff like address, phone number, etc. in the database. If you then XXX document once Adrian reworks this XXX
wanted to build a database of restaurants on top of the places, instead of
repeating yourself and replicating those fields in the restaurants object, you ``NullBooleanField``
could make ``Restaurant`` have a ``OneToOne`` relation to ``Place`` (since Like a ``BooleanField``, but allows ``NULL`` as one of the options. Use this
a restaurant "is-a" place). instead of a ``BooleanField`` with ``null=True`` .
This has a few repercussions in the admin interface: ``PhoneNumberField``
Validates that the value is a valid phone number.
* No selection interface is displayed on ``Restaurant`` pages; there will
be one (and only one) ``Restaurant`` for each place. ``PositiveIntegerField``
Like an ``IntegerField``, but must be positive.
* On the ``Restaurant`` change list, every single ``Place`` -- weather it
has an associated ``Restaurant`` or not -- will be displayed. Adding ``PositiveSmallIntegerField``
a ``Restaurant`` to a ``Place`` just means filling out the required Like a ``PositiveIntegerField``, but only allows values below 32767.
``Restaurant`` fields.
``SlugField``
A "slug" suitable for parts of a URL; only allows alpha-numeric characters and
underscores.
Implies ``maxlength=50`` and ``db_index=True``.
Accepts an extra option, ``prepopulate_from`` which is a list of fields from
which to auto-populate the slug.
``SmallIntegerField``
Like an ``IntegerField``, but must be between -32768 and 32767.
``TextField``
A large text field (``<textarea>`` in HTML).
``TimeField``
A time. Accepts the same auto-population options as ``DateField`` and
``DateTimeField``.
``URLField``
A field for a URL. If the ``verify_exists`` option is ``True``, the URL given
will be checked for existence (i.e. actually loads and doesn't give a 404
response).
``USStateField``
A US state.
``XMLField``
A field containing XML. Takes one required argument, ``schema_path`` which
is the path to a RelaxNG_ scheme against which to validate the field.
.. _RelaxNG: http://www.relaxng.org/
Admin options Admin options
============= =============
@ -635,126 +488,108 @@ The ``admin`` field in the model tells Django how to construct the admin
interface for the object. The field is an instance of the ``meta.Admin`` interface for the object. The field is an instance of the ``meta.Admin``
object, which has the following options (of which only ``fields`` is required): object, which has the following options (of which only ``fields`` is required):
``date_hierarchy`` ``date_hierarchy``
------------------ To allow filtering of objects in the admin by date, set ``date_hierarchy``
to the name of the field to filter by::
To allow filtering of objects in the admin by date, set ``date_hierarchy``
to the name of the field to filter by:: date_hierarchy = 'order_date'
date_hierarchy = 'order_date'
``fields`` ``fields``
---------- A list of fieldsets to display on the admin page. Each fieldset is a 2-tuple:
``(name, field_options)``. The ``name`` is a string to name the field set,
A list of fieldsets to display on the admin page. Each fieldset is a 2-tuple: and ``field_options`` is a dictionary of information about the fields to be
``(name, field_options)``. The ``name`` is a string to name the field set, displayed in that fieldset. This dictionary has the following keys:
and ``field_options`` is a dictionary of information about the fields to be
displayed in that fieldset. This dictionary has the following keys: ``fields``
A tuple of field names to display in this fieldset. To display
``fields`` multiple fields on the same line, wrap those fields in their
A tuple of field names to display in this fieldset. To display own tuple.
multiple fields on the same line, wrap those fields in their
own tuple.
This key is required in the dict.
``classes``
Extra CSS classes to apply to the fieldset. This is a simple
string; you can apply multiple classes by separating them with
spaces.
Two useful classes defined by the default stylesheet are ``collapse``
and ``wide``. Fieldsets with the ``collapse`` style will be
initially collapsed in the admin and replaced with a small "click
to expand" link. Fieldsets with the ``wide`` style will be given
extra horizontal space.
For example (taken from the ``core.flatfiles`` model):: This key is required in the dict.
fields = ( ``classes``
(None, { Extra CSS classes to apply to the fieldset. This is a simple
'fields': ('url', 'title', 'content', 'sites') string; you can apply multiple classes by separating them with
}), spaces.
('Advanced options', {
'classes': 'collapse', Two useful classes defined by the default stylesheet are ``collapse``
'fields' : ('enable_comments', 'registration_required', 'template_name') and ``wide``. Fieldsets with the ``collapse`` style will be
}), initially collapsed in the admin and replaced with a small "click
), to expand" link. Fieldsets with the ``wide`` style will be given
extra horizontal space.
For example (taken from the ``core.flatfiles`` model)::
results in an admin that looks like: fields = (
(None, {
.. image:: images/flatfiles_admin.png 'fields': ('url', 'title', 'content', 'sites')
}),
('Advanced options', {
'classes': 'collapse',
'fields' : ('enable_comments', 'registration_required', 'template_name')
}),
),
results in an admin that looks like:
.. image:: http://media.djangoproject.com/img/doc/flatfiles_admin.png
``js`` ``js``
------ Extra JavaScript files to link into the admin screen. This can be used to
tweak a given type of admin page in JS or to provide "quick links" to fill
Extra JavaScript files to link into the admin screen. This can be used to in default values for certain fields.
tweak a given type of admin page in JS or to provide "quick links" to fill
in default values for certain fields.
``list_display`` ``list_display``
---------------- List of fields to display on the list page in the admin.
List of fields to display on the list page in the admin. There are a few special cases that do other things besides displaying the
contents of the given fields:
There are a few special cases that do other things besides displaying the
contents of the given fields: * If the field given has a relationship, that relationship is
followed and the ``repr()`` of the related object is displayed.
* If the field given has a relationship, that relationship is
followed and the ``repr()`` of the related object is displayed. * If the field is a ``BooleanField``, a "on" or "off" icon will
be displayed instead of ``True`` or ``False``.
* If the field is a ``BooleanField``, a "on" or "off" icon will
be displayed instead of ``True`` or ``False``. * If the field name given does not exist, a function of the model
will be searched for and called if present. This function
* If the field name given does not exist, a function of the model should have a ``short_description`` attribute that will be
will be searched for and called if present. This function used as the header for the field.
should have a ``short_description`` attribute that will be
used as the header for the field. See the exmaple below.
See the exmaple below.
``list_filter`` ``list_filter``
--------------- List of fields to filter by. Each field should either be a ``BooleanField``
or else a field with a ``ManyToOne`` relation.
List of fields to filter by. Each field should either be a ``BooleanField``
or else a field with a ``ManyToOne`` relation.
An example of how ``list_display`` and ``list_filter`` work (taken from
the ``auth.user`` model)::
list_display = ('username', 'email', 'first_name', 'last_name', 'is_staff'),
list_filter = ('is_staff', 'is_superuser'),
results in a admin that looks like: An example of how ``list_display`` and ``list_filter`` work (taken from
the ``auth.user`` model)::
.. image:: images/users_changelist.png
list_display = ('username', 'email', 'first_name', 'last_name', 'is_staff'),
list_filter = ('is_staff', 'is_superuser'),
results in a admin that looks like:
.. image:: http://media.djangoproject.com/img/doc/users_changelist.png
(This example also has ``search_fields`` defined; see below).
(This example also has ``search_fields`` defined; see below).
``ordering`` ``ordering``
------------ An ordering tuple (see the `Options for models`_, above) that gives a
different ordering for the admin change list. If not given, the
An ordering tuple (see the `Options for models`_, above) that gives a model's default ordering will be used.
different ordering for the admin change list. If not given, the
model's default ordering will be used.
``save_as`` ``save_as``
----------- Enables a "save as" feature on object pages. Normally, objects have
three save options: "Save", "Save and continue editing", and "Save
Enables a "save as" feature on object pages. Normally, objects have and add another". If ``save_as`` is ``True``, "Save and add another"
three save options: "Save", "Save and continue editing", and "Save will be replaced by a "Save as" button.
and add another". If ``save_as`` is ``True``, "Save and add another"
will be replaced by a "Save as" button.
``save_on_top`` ``save_on_top``
--------------- If this option is ``True``, object pages will have the save buttons
across the top as well as at the bottom of the page.
If this option is ``True``, object pages will have the save buttons
across the top as well as at the bottom of the page.
``search_fields`` ``search_fields``
----------------- A list of fields to provide a text search for. These fields should,
obviously, be some kind of text field.
A list of fields to provide a text search for. These fields should,
obviously, be some kind of text field.

996
docs/templates.txt
View File

File diff suppressed because it is too large Load Diff