Skip to main content

Forms for Plone

Project description

latest release version badge by Badge Fury Travis CI status Coveralls status

The add on collective.easyform adds Plone content types for form creation.

EasyForm provides a Plone form builder through-the-web using fields, widgets, actions and validators (based on Dexterity).

Form input can be saved or emailed. A simple and user-friendly interface allows non-programmers to create custom forms.

Note: This Plone package is similar to Archetypes based Products.PloneFormGen for Plone versions 1 to 4.

Dexterity is the default framework for building content types in Plone 5.

Installation

Install collective.easyform by adding it to your buildout:

[buildout]

...

eggs =
    collective.easyform

Run buildout:

bin/buildout

The last step is to activate EasyForm in the Control Panel.

Usage

  • Choose EasyForm from the toolbars ‘Add new’ menu. Insert form title, description and other settings.
  • Add fields or fieldsets to create a unique form that will meet your particular requirements. There are enough basic field types to satisfy any demands:
    • File Upload,
    • Text line (String),
    • Integer,
    • Yes/No,
    • Date, Date/Time,
    • Floating-point number,
    • Choice,
    • Rich Text,
    • Image,
    • Multiple Choice,
    • Text,
    • Password,
    • ReСaptcha.
  • Continue to customize form by setting the order of fields, defining required and hidden ones, choosing validator, if necessary, and other field type specific settings.

Click on the picture below for a short introduction video:

EasyForm instructional video

ReCaptcha support

Install collective.easyform with the recaptcha extra:

[buildout]

...

eggs =
    collective.easyform [recaptcha]

And run buildout and install EasyForm as described above.

Then go to the EasyFrom controlpanel (/@@easyform-controlpanel) and add the “ReCaptcha” field to “Allowed Fields”. Alternatively, activate it by adding it as an registry.xml entry for Generic Setup:

<record name="easyform.allowedFields">
  <value purge="False">
    <element>collective.easyform.fields.ReCaptcha</element>
  </value>
</record>

Then add the ReCaptcha field to the forms where you want to use it. As field type use ReCaptcha and set require to false.

As last step you might want to not include the recaptcha field in the thanks page and mailer action. To do that, edit the form, go to the “Thanks page” settings, disable “Show all fields” and then include only those you want. Likewise for the mailing: Open the form actions via the actions toolbar menu and edit the mailer settings accordingly.

Actions

You can choose between the following actions after form submission:

  • Mailer
  • DataStorage
  • CustomScript

The mailer stores a HTML template for sending the results of the form. You can override it with a file named easyform_mail_body_default.pt in your site. If it is not found the default from the default_schemata directory of this package is taken. If you plan to override start with the the mail_body_default.pt file and make sure it is a valid pagetemplate.

Source Code and Contributions

If you want to help with the development (improvement, update, bug-fixing, …) of collective.easyform this is a great idea!

You can clone it or get access to the github-collective and work directly on the project.

Please do larger changes on a branch and submit a Pull Request.

Maintainer of collective.easyform is the Plone Collective community.

We appreciate any contribution !

For new release, please contact one of the owners or maintainers mentioned at the Python Package Index page.

License

The project is licensed under the GPLv2.

Compatibility

  • 1.x targets Plone 4.x
  • 2.x targets Plone 5.x onwards

Changelog

2.0.0b5 (2018-06-22)

Bug fixes:

  • Fix display of items in fieldset on thanks page [tomgross]

2.0.0b4 (2018-05-17)

New features:

  • Add support for hidden fields [tomgross]

Bug fixes:

  • Fix filtering regression introduced with 2.0.0b3 [tomgross]

2.0.0b3 (2018-05-08)

New features:

  • Add browserlayer. [jensens]
  • Enhance file validation view with type check [tomgross]
  • Basque translation [erral]
  • Update italian translations. [arsenico13]
  • Allow default fields, actions & mailtemplate in DB [tomgross]
  • New mailer adapter checkbox to send CSV data attachment [tkimnguyen]

Bug fixes:

  • Do not override configured widgets with default widgets in thank-you-page. This fixes #111. Includes code cleanup. [jensens]
  • Hide profiles not used for regular install. [jensens]
  • Remove ProtectedEmail and ProtectedTextLine as addable fields https://github.com/collective/collective.easyform/issues/94 [fgrcon]
  • Support showAll and includeEmpties also for the thanks page. [thet]
  • Register the recaptcha validator more specifically, so that it overrides the default easyform validator. Fixes an issue where plone.formwidget.recaptcha had no effect when used. [thet]
  • Fix broken access to saved data due to acquisition problems if action is called ‘data’. Fixes: #87. [sverbois]
  • Fix action URLs to savedata, export, import [tomgross]
  • Fix display of values in mailer template #76 [tomgross]

2.0.0b2 (2017-08-31)

Bug fixes:

  • Update italian translations. [arsenico13]
  • Added Products.validation dependency to make it work for archetypes-free sites. [agitator]
  • In the schema editor for fields, Fix the URL to ACE library according to the modeleditor in plone.app.dexterity. [thet]
  • Fix saver action with non ASCII filename uploads #77 [tomgross]
  • In the schema editor for fields, Fix the URL to ACE library according to the modeleditor in plone.app.dexterity. [thet]

2.0.0b1 (2017-06-14)

New features:

  • Add filesize upload validator [tomgross]

Bug fixes:

  • Take over signature linebreaks to HTML email [tomgross]
  • Allow multi-select fields as subject field https://github.com/collective/collective.easyform/issues/71 [tomgross]
  • Update german translations. [tomgross, jensens]
  • Keep line breaks for body_pre, body_post and body_footer field. Changed field type to RichText with TextAreaWidget and default_mime_type=’text/x-web-intelligent’. Updated default mailer template. [agitator]
  • Use site email address as default recipient address also for Plone 5. [tmassman]
  • Update README [svx]
  • Allow emails (CC, BCC) separated by ‘;’ and newlines https://github.com/collective/collective.easyform/issues/49 [tomgross]
  • Allow managment of fields enabled for c.easyform in controlpanel [karalics]

2.0.0a2 (2016-10-14)

New:

  • Rename api.get_fields to api.get_schema [jensens, agitator]

Fixes:

  • Fix field order [jensens, agitator]

2.0.0a1 (2016-10-13)

New:

  • Update for Plone 5, no longer support Plone 4.x [agitator]

Fixes:

  • Fix: Overhaul TravisCI setup to really use caches. Use bobtemplates.plone travis setup as best practice. [jensens]
  • Don’t show the reset button after form submission at the summary page. [thet]
  • Housekeeping: isort, zca decorators, autopep8 and major manual cleanup. Includes structural cleanup and [jensens, agitator]

1.0a4 (unreleased)

New:

  • Change recipient address field to Email type so it gets properly validated [davilima6]
  • Make the default buildout use Plone 5. Update travis setup to the point where tests actually run, though many still fail. [smcmahon]
  • look up email_from_address in registry [kcleong]
  • Move the default xml configuration out into xml files. These can be picked up by i18ndude or other po file generators for translations strings. Also translate the FIELDS_DEFAULT fields. [thet]
  • Add German translations. [thet]
  • Allow the definition of some EasyForm default values via the i18n translation mechanism. [thet]
  • Reworked mail address formating, avoiding recipient address in the form of name <<account@domain.com>> and having instead name <account@domain.com>. [thet]
  • Depend on plone.schemaeditor > 2.0 for JS compatibility. [thet]
  • fix plone.schemaeditor i18n factory import. This fixes 5.0.1 support. [vangheem]
  • Fix modeleditor.pt markup so it works with barceloneta. [ebrehault]

Fixes:

  • fix plone.schemaeditor i18n factory import. This fixes 5.0.1 support

1.0a3 (2015-06-02)

  • Fixed templates [kroman0]
  • Fixed field order #17 [kroman0]
  • Fixed Plone 5 support [kroman0]
  • Fixed dependencies [kroman0]
  • Set script type correctly [fredvd]

1.0a2 (2014-06-13)

  • Fixed conflict with plone.app.multilingual[dexterity] [kroman0]
  • Fixed rendering saved data form [kroman0]
  • Fixed and updated tests [kroman0]
  • Fix unicode encoding in download csv [gborelli]
  • Added Italian translation [gborelli]
  • Added fields parameter in Mailer override expressions [gborelli]

1.0a1 (2014-03-18)

  • Initial release

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
collective.easyform-2.0.0b5.tar.gz (756.2 kB) Copy SHA256 hash SHA256 Source None Jun 22, 2018

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page