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 the Field when the Field is rendered by one of the convenience Form methods (e.g., as_ul()).
Like the model field’s help_text, this value isn’t HTML-escaped in automatically-generated forms.
Here’s a full example Form that implements help_text for two of its fields. We’ve specified auto_id=False to simplify the output:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 | >>> from django import forms>>> class HelpTextContactForm(forms.Form):... subject = forms.CharField(max_length=100, help_text='100 characters max.')... message = forms.CharField()... sender = forms.EmailField(help_text='A valid email address, please.')... cc_myself = forms.BooleanField(required=False)>>> f = HelpTextContactForm(auto_id=False)>>> print(f.as_table())<tr><th>Subject:</th><td><input type="text" name="subject" maxlength="100" required /><br /><span class="helptext">100 characters max.</span></td></tr><tr><th>Message:</th><td><input type="text" name="message" required /></td></tr><tr><th>Sender:</th><td><input type="email" name="sender" required /><br />A valid email address, please.</td></tr><tr><th>Cc myself:</th><td><input type="checkbox" name="cc_myself" /></td></tr>>>> print(f.as_ul()))<li>Subject: <input type="text" name="subject" maxlength="100" required /> <span class="helptext">100 characters max.</span></li><li>Message: <input type="text" name="message" required /></li><li>Sender: <input type="email" name="sender" required /> A valid email address, please.</li><li>Cc myself: <input type="checkbox" name="cc_myself" /></li>>>> print(f.as_p())<p>Subject: <input type="text" name="subject" maxlength="100" required /> <span class="helptext">100 characters max.</span></p><p>Message: <input type="text" name="message" required /></p><p>Sender: <input type="email" name="sender" required /> A valid email address, please.</p><p>Cc myself: <input type="checkbox" name="cc_myself" /></p> |
Please login to continue.