djangocms-form-builder documentation

djangocms-form-builder adds a form editor to the structure board of django CMS. Editors build forms from plugins - one plugin per form field - and decide per form what happens to a submission: store it, mail it, show a message, redirect, or run an action your project provides.

Forms are submitted by fetch() to a JSON endpoint the app installs itself, so a page may carry as many forms as you like without a page reload.

The documentation is organised along the four kinds of documentation described by the Diátaxis framework:

Tutorial

A guided first form: install the app, build a contact form in the structure board and read the submission in the admin.

How-to guides

Recipes for a concrete goal - registering an existing Django form, writing an action, protecting a public form with a captcha, accepting uploads.

Reference

The settings, plugins, models, template tags, management commands and Python APIs, described as they are implemented.

Explanation

Background on how the pieces fit together and why forms open to the public are treated the way they are.

• Tutorial: build your first form
  • Install the app
  • Add a form to a page
  • Add the fields
  • Submit the form
  • Read the submission
  • Where to go next
• How-to guides
  • Protect a form with a captcha
  • Accept file uploads
  • Delete old submissions
  • Send a confirmation mail to the submitter
  • Rate limit form actions
  • Write your own form action
  • Use a Django form you already have
  • Change how forms are rendered
• Reference
  • Settings
  • Plugins
  • Form actions
  • File upload validation
  • Models and stored data
  • Template tags
  • Management commands
  • The submission endpoint
• Explanation
  • How a plugin tree becomes a form
  • Forms open to the public

Indices and tables

• Index

• Search Page