Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

readonly_fields documentation amended ticket #19120 #459

Closed
wants to merge 2 commits into from
Closed

readonly_fields documentation amended ticket #19120 #459

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fb75de8
readonly_fields docs amended ticket 19120
evildmp Oct 22, 2012
b2d46ab
readonly_fields docs typo fixed
evildmp Oct 22, 2012
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
31 changes: 25 additions & 6 deletions docs/ref/contrib/admin/index.txt
View file
Open in desktop
Expand Up @@ -179,8 +179,6 @@ subclass::
values defined in :attr:`ModelAdmin.readonly_fields` to be displayed as
read-only.

.. versionadded:: 1.4

To display multiple fields on the same line, wrap those fields in their own
tuple. In this example, the ``url`` and ``title`` fields will display on the
same line and the ``content`` field will be displayed below them in its
Expand Down Expand Up @@ -807,14 +805,35 @@ subclass::

By default the admin shows all fields as editable. Any fields in this
option (which should be a ``list`` or ``tuple``) will display its data
as-is and non-editable. This option behaves nearly identical to
:attr:`ModelAdmin.list_display`. Usage is the same, however, when you
specify :attr:`ModelAdmin.fields` or :attr:`ModelAdmin.fieldsets` the
read-only fields must be present to be shown (they are ignored otherwise).
as-is and non-editable. Note that when specifying
:attr:`ModelAdmin.fields` or :attr:`ModelAdmin.fieldsets` the read-only
fields must be present to be shown (they are ignored otherwise).

If ``readonly_fields`` is used without defining explicit ordering through
:attr:`ModelAdmin.fields` or :attr:`ModelAdmin.fieldsets` they will be
added last after all editable fields.

A read-only field can not only display data from a model's field, it can
also display the output of a function, or a model's method, or a method of
the ``ModelAdmin`` class itself, if these are declared in
``readonly_fields``. This is very similar to the way
:attr:`ModelAdmin.list_display` behaves.

This provides an effective and easy way to use the admin interface to
provide feedback on the status of the objects being edited, for example::

class PersonAdmin(ModelAdmin):
readonly_fields = ('address_report',)

# instance is the instance of the model we are editing
def address_report(self, instance):
return "%s" % (", ".join(instance.get_full_address)) or "<span class='errors'>Warning: I can't determine this person's address.</span>"

# the short_description functions like a model field's verbose_name
address_report.short_description = "Address"
# in this example, we have used HTML tags in the output
address_report.allow_tags = True


.. attribute:: ModelAdmin.save_as

Expand Down