db.models.Field.help_text

Field.help_text

Extra “help” text to be displayed with the form widget. It’s useful for documentation even if your field isn’t used on a form.

Note that this value is not HTML-escaped in automatically-generated forms. This lets you include HTML in help_text if you so desire. For example:

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. Ensure that you escape any help text that may come from untrusted users to avoid a cross-site scripting attack.

Links:

https://docs.djangoproject.com/en/1.10/ref/models/fields/#django.db.models.Field.help_text

doc_Django

2016-10-09 18:35:26

Comments

Popular Articles

forms.Field.help_text Field.help_text The help_text argument lets you specify descriptive text for this Field. If you provide help_text, it will be displayed next to th

db.models.Field class Field [source] Field is an abstract class that represents a database table column. Django uses fields to create the database table (db_type(

db.models.Field.model Field.model Returns the model on which the field is defined. If a field is defined on a superclass of a model, model will refer to the superclass,

db.models.Field.default Field.default The default value for the field. This can be a value or a callable object. If callable it will be called every time a new object is

db.models.Field.hidden Field.hidden Boolean flag that indicates if a field is used to back another non-hidden field’s functionality (e.g. the content_type and object_id