Author: lukeplant
Date: 2008-07-25 09:47:35 -0500 (Fri, 25 Jul 2008)
New Revision: 8074
Modified:
django/trunk/docs/admin.txt
django/trunk/docs/model-api.txt
Log:
Standardised documentation of the Field help_text option and ModelAdmin.fields
'description' option.
Modified: django/trunk/docs/admin.txt
===================================================================
--- django/trunk/docs/admin.txt 2008-07-25 14:44:56 UTC (rev 8073)
+++ django/trunk/docs/admin.txt 2008-07-25 14:47:35 UTC (rev 8074)
@@ -139,9 +139,14 @@
``description``
A string of optional extra text to be displayed at the top of each
fieldset,
- under the heading of the fieldset. It's used verbatim, so you can use any
HTML
- and you must escape any special HTML characters (such as ampersands)
yourself.
+ under the heading of the fieldset.
+ Note that this value is *not* HTML-escaped when it's displayed in
+ the admin interface. This lets you include HTML if you so desire.
+ Alternatively you can use plain text and
+ ``django.utils.html.escape()`` to escape any HTML special
+ characters.
+
``filter_horizontal``
~~~~~~~~~~~~~~~~~~~~~
Modified: django/trunk/docs/model-api.txt
===================================================================
--- django/trunk/docs/model-api.txt 2008-07-25 14:44:56 UTC (rev 8073)
+++ django/trunk/docs/model-api.txt 2008-07-25 14:47:35 UTC (rev 8074)
@@ -658,6 +658,9 @@
help_text="Please use the following format: <em>YYYY-MM-DD</em>."
+Alternatively you can use plain text and
+``django.utils.html.escape()`` to escape any HTML special characters.
+
``primary_key``
~~~~~~~~~~~~~~~
--~--~---------~--~----~------------~-------~--~----~
You received this message because you are subscribed to the Google Groups
"Django updates" group.
To post to this group, send email to [email protected]
To unsubscribe from this group, send email to [EMAIL PROTECTED]
For more options, visit this group at
http://groups.google.com/group/django-updates?hl=en
-~----------~----~----~----~------~----~------~--~---
