collective.easyform 4.2.1

Forms for Plone

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.

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 Add-ons control panel.

Migration from PloneFormGen

With PloneFormGen installed, open the following url:

@@migrate-ploneformgen

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:

Using conditional fields

Under Advanced > field depends on, you can define conditions to hide a field and only fade it in when a condition is fulfilled. We are using pat-depends here, all options are documented in the pat-depends docs.

You can also set a CSS class string for every field under Advanced > CSS Class.

Since the form is marked with the row css class you can use the existing Bootstrap 5 CSS column classes for the fields to create simple column layouts. See the Bootstrap Grid System documentation for more information.

For more complex layouts you can also add your own CSS classes and definitions. Here is one example CSS to define a form with up to 4 columns and different col span for individual fields.

.easyformForm fieldset{
  display: grid;
  gap: 1em;
  grid-template-columns: 1fr 1fr 1fr 1fr;
}

.easyformForm .field{
  background-color: #eeeeee;
  padding: 0.5em;
  grid-column: auto / span 2;
}

.easyformForm fieldset > p:first-of-type{
  background-color: transparent;
  grid-column: auto / span 4;
}

.easyformForm .field.formCol14{
  grid-column: auto / span 1;
}

.easyformForm .field.formCol34{
  grid-column: auto / span 3;
}

.easyformForm .field.formCol44{
  grid-column: auto / span 4;
}

ReCaptcha support

Install collective.easyform with the recaptcha extra:

[buildout]

...

eggs =
    collective.easyform [recaptcha]

Run buildout. In the Add-ons control panel, activate both EasyForm and the ReCaptcha widget.

In the ReCaptcha control panel, set the public key and private key values you obtained from https://developers.google.com/recaptcha/ (you can use reCAPTCHA V2).

In the EasyFrom control panel (/@@easyform-controlpanel), 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>

Add the ReCaptcha field to the forms where you want to use it. Use the field type ReCaptcha and leave require unchecked.

As a last step you might want to avoid including the recaptcha field in the thank you page and in the 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 mailer: open the form actions via the Actions toolbar menu and edit the mailer settings accordingly.

collective.z3cform.norobots support

Install collective.easyform with the norobots extra:

[buildout]

...

eggs =
    collective.easyform [norobots]

Run buildout. In the Add-ons control panel, install EasyForm.

In the EasyFrom control panel (/@@easyform-controlpanel), add the “NorobotCaptcha” 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.NorobotCaptcha</element>
  </value>
</record>

Add the NorobotCaptcha field to the forms where you want to use it. Use the field type NorobotCaptcha and leave require unchecked.

As a last step you might want to avoid including the norobotcaptcha field in the thanks page and the 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 mailer: open the form actions via the Actions toolbar menu and edit the mailer settings accordingly.

Download XLSX from savedata adapter support

Install collective.easyform with the downloadxlsx extra:

[buildout]

...

eggs =
    collective.easyform [downloadxlsx]

This gives you the option to download the saved data as XLSX using openpyxl to generate the XLSX file.

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.

Translations

This add-on has been translated into

• Basque

• Brazilian Portuguese

• Deutsch

• Dutch

• English

• French

• Italian

• Japanese

• Spanish

• Ukrainian

Related Addons

Note: This Plone package is similar to Archetypes based Products.PloneFormGen for Plone versions 1 to 4. Now, Dexterity is the default framework for building content types in Plone 5. collective.easyform is based on Dexterity.

Source Code and Contributions

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

• Source code at Github

• Issue tracker at Github

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.

Contribute

• Issue Tracker: https://github.com/collective/collective.easyform/issues

• Source Code: https://github.com/collective/collective.easyform

License

The project is licensed under the GPLv2.

Compatibility

• 1.x targets Plone 4.x

• 2.x targets Plone 5.x onwards

• 3.x targets Plone 5.2

• 4.x targets Plone 6, on Python 3

Changelog

4.2.1 (2024-10-08)

• Fix Plone 5 related upgrade steps in Plone 6. [thet]

• Add plone.shortname behaviour to EasyForm type. [ThibautBorn]

• Include the Products.validation ZCML to load the proper translation catalog. Refs. issue 434. [ale-rt]

4.2.0 (2024-03-15)

• Set fieldset description as attribute, not node, when migrating from PFG. [thomasmassmann]

• Add filesize upload limit for file and image uploads. [ThibautBorn]

• Update Dutch translations. [ThibautBorn]

4.1.6 (2024-03-08)

• Fix unused, incorrect and undeclared imports in serializer. [thet]

4.1.5 (2023-11-03)

• check for “collective.easyform.DownloadSavedInput” permission, before including the saved data in serializer. [MrTango]

4.1.4 (2023-07-27)

• fix folder_contents accessibility from @@saveddata. [ThibautBorn]

• make ReCaptcha fields not required during PloneFormGen migration [ThibautBorn]

4.1.3 (2023-05-16)

Bug fixes:

• Add upgrade step and profile to update contenttype icon in registry. [maurits]

• Add icon expressions for actions. [maurits]

• Update Spanish translations. [macagua]

4.1.2 (2023-01-02)

• Define ‘Edit’ and ‘View’ icons for the form. (#390) [frapell]

• Require at least Python 3.8. Test with 3.8-3.11. [maurits]

4.1.1 (2022-10-28)

• Fix display of stored values in Likert field. [gotcha]

• Add icon for the control panel tool [frapell]

• Prevent RichLabel fields from breaking the form [MrTango]

• Schemaeditor UI: close modals and reload fields(sets) when saving. [petschki]

• Fix bug which did not render correctly GroupForm widgets (see #370) [petschki]

4.1.0 (2022-08-10)

New features:

• Add support for field level CSS classes. [mrtango]

• Add support for conditional fields. [mrtango]

• Add Likert scale field. [gotcha]

• Add French translations [mpeeters, laulaz]

• Use collective.easyform.DownloadSavedInput permission for displaying/downloading saved data (#357) [laulaz]

• restapi (de)serializer that includes saved data [ThibautBorn, gotcha, Mychae1]

• Use “|” as delimiter of list types in exports. [mathias.leimgruber]

Bug fixes:

• Fix persistence issue with SaveData storage. [mathias.leimgruber] (#259)

• Add missing translations strings [laulaz]

• Remove unused migrate_all_forms setting and record (#206) [laulaz]

• Modify the “Form Fields” to work with latest schemaeditor (#345) [frapell]

Enhancements:

• Standarize how the “Form Fields” and “Form Actions” behave. Have a single “Save” button that will redirect back to the form once changes are applied [frapell]

4.0.0 (2022-04-07)

Breaking change:

• This is for Plone 6 only. At least this is the only version that is tested. (Changelog edited later to avoid misunderstandings, use 3.x for Plone 5.2) [maurits]

New features:

• Add support for Plone 6 [pbauer, frappell]

• Update Field/Actions listing to work with Plone 6 [petschki] (#260)

• Added Japanese translation, supported by Ochanomizu University. [terapyon] (#263)

• User-friendly delimiter setup for csv download [ThibautBorn, gotcha] (#267)

• Add support for plone.formwidget.hcaptcha [fredvd] (#292)

• Update the css registration and use the schemaeditor pattern [frapell] (#319)

• Add name attribute field to form, default empty doesn’t include it. Useful for form analytics like matomo that can check for this attribute. [fredvd] (#328)

• Download XLSX version of saved data. [mathias.leimgruber] (#285)

• Add option to append formdata as xlsx as well. [mathias.leimgruber] (#287)

Bug fixes:

• Add upgrade step for the csv_delimiter field. [fredvd] (267b)

• Always display fieldsets legends : in tabbed mode, they are hidden by autotoc pattern [laulaz] (#173)

• Show the pro- and epilogue texts also on embedded forms. [fredvd] (#274)

• Fix field order in Mailer attachments [MrTango]

• Optinally add CSV/XLSX headers to attachments [MrTango] (#323)

• Fix table of saved data: do not show labels in table; colored buttons, slight cleanup. [jensens]

• Fixes in German translation. [jensens]

• Fix recaptcha support: include it’s zcml when installed. [jensens]

• Fix translations of validation errors. [mathias.leimgruber] (#284)

• Fix download bug for RichTextFields [szakitibi] (#288)

3.0.5 (2020-11-17)

Bug fixes:

• Fix validators in field sets with zope.interface 5.1+. This fixes issue 252. [maurits] (#252)

• For increased security, in the modeleditor do not resolve entities, and remove processing instructions. [maurits] (#3209)

3.0.4 (2020-09-26)

Bug fixes:

• Fix ModuleNotFoundError: No module named ‘App.class_init’ on Zope 5. [agitator] (#251)

3.0.3 (2020-09-09)

Bug fixes:

• Make sure the catalog is updated after setting fields or actions. Fixes issue 8. [maurits] (#8)

• Make sure action urls are always relative to the easyform object. And redirect folder/easyform/folder_contents to folder/folder_contents. And show a View link in the toolbar when you are in a sub item of a form. See issue 219 and PR 239. [maurits] (#219)

3.0.2 (2020-08-17)

Bug fixes:

• Better saved data handling (ux forms, redirect to only adapter). [jensens (#1)

• More German translations [jensens] (#2)

• Fixes #217: Stop loosing action errors in form update. [wobsta] (#238)

• Fixes #182: actions urls when on action or field traverser. [jensens] (#239)

3.0.1 (2020-07-29)

Bug fixes:

• Fixes #235: Module collective.easyform.fields, line 63, in superAdapter IndexError: tuple index out of range. [jensens] (#235)

3.0.0 (2020-07-28)

Breaking changes:

• Hide the “description” field from form actions, as it is not used anywhere. Customizations which try to omit or use the description field might need adaptions. (#226)

• Change semantics for the “advanced” permission and introduce new “technical” permission. To better support use cases for “power users” while not overloading them with complex fields where a technical understanding is necessary the permissions are changed as follows:

  “Edit Advanced Fields”: - IEasyForm.form_tabbing - IEasyForm.default_fieldset_label - IFieldExtender.field_widget - IFieldExtender.validators

  “Edit Technical Fields”: - IEasyForm.method - IEasyForm.unload_protection - IEasyForm.CSRFProtection - IEasyForm.forceSSL - IMailer.replyto_field - IMailer.xinfo_headers - IMailer.additional_headers (#229)

New features:

• Use profile to configure roles instead of ZCML for easier customization. (#224)

• Simplify the editing UI: Introduce a new “Advanced” tab when creating a form for not so frequent used settings. Change permissions to allow editors to define the recipient from form field values in addition to a fixed recipient. (#227)

• Make the fields editor look nicer. (#228)

Bug fixes:

• Fix deprecated fieldset import in interfaces. (#222)

• Rewrite upgrades bobtemplates.plone style to get a better overview. (#223)

• Make Actions better compatible with plone.supermodel/autoform directives. (#225)

• Fix translation of default values for the easyform content type fields in the current active language. (#231)

2.2.0 (2020-06-04)

• Implement PloneFormGen migration. [buchi, laulaz]

• Fixed errors with header_injection implementation. [maurits, thet]

• Format code according to Plone standards: black, isort, zpretty. [thet]

• Fix Validators for value None: return valid and let required handle it [Nimo-19]

2.1.5 (2020-02-09)

• Remove hardcoded download button label check (#175) [davide-targa]

2.1.4 (2020-02-06)

• Add ‘easyform-thankspage’ css class to the content-core div if the thankspage is displayed. Combined with the header_injection field you can style elements only for the thankspage, for example as a workaround to remove empty fieldsets (#154). [fredvd]

• do not append the re-rendered download form when generating the data download file (#175) [mamico, tkimnguyen]

• fix Travis install of google-chrome-stable [tkimnguyen]

• PEP8 fixes [mamico]

2.1.3 (2019-12-11)

• Brazilian Portuguese translation #200 [ericof]

2.1.2 (2019-11-18)

• Fix broken image in README (partly addresses #197) [tkimguyen]

• Mention reCAPTCHA V2 when obtaining public/private key pair [tkimnguyen]

2.1.1 (2019-11-18)

NOTE: if you deploy 2.1.1+, the easyform extended validations start working again on fields in extra field sets (they only worked on the main/default fields). This could cause some issues if those validators, or default values, were misconfigured in the first place.

• Let filter_fields return fields in the correct order. This fixes the order on the default mailer template. Part of issue #163. [maurits]

• Fixed validation, inline validation, and defaults for fields in fieldsets. Refs issues #172 and ` #157 <https://github.com/collective/collective.easyform/issues/157>`_. [fredvd, maurits]

• Moved from dotted to named behaviors. [iham]

• Avoid potential CannotGetPortalError on startup #164 [laulaz]

• Add collective.z3cform.norobots integration #145 [1letter/gomez]

• For CSV and XML attachments send an empty string if the value is None instead of the string “None” [nngu6036]

• Put in tests to show recaptcha validation prevents submissions [djay]

• Fix UnicodeDecodeError while attaching an image to a mail #187 [krissik]

• update instructions for recaptcha functionality [tkimnguyen]

2.1.0 (2019-04-25)

New features:

• Code style black & isort. [jensens]

• Add “CheckBoxFieldWidget” for Multi-Choice-Field and “RadioFieldWidget” for Single-Choice-Field [petschki]

• add plone.formwidget.recaptcha to test dependencies [petschki]

• Added style bundle with content type icon for toolbar and folder_contents [agitator]

• nicer representation of complex field types such as bools and dates when serialized to XML or CSV attachments [nngu6036]

Bug fixes:

• fix bug where lines longer than 998 in XML or CSV attachmentments can get wrapped [nngu6036]

• add missing header_injection implementation [krissik]

2.1.0rc1 (2019-03-19)

New features:

• Add Support for Python 3. [pbauer]

• a11y: Added role attribute for portalMessage [nzambello]

Bug fixes:

• fixed startup ResourceWarning on open files [ajung]

2.0.1 (2018-12-04)

• Spanish translation. [erral]

2.0.0 (2018-10-03)

New features:

• New method in api: filter_widgets. If a isn’t selected, mailer action don’t try to render its widget. This is useful when we want to avoid to show some widgets like recaptcha, that could breaks if it’s in the wrong context. [cekk]

Bug fixes:

• changed the permission of saveddata action from “Manage portal” to “Modify portal content” so “action” and “view” have the same permission [eikichi18]

• Fix to thanks page regression introduced in 2.0.0b4 [instification]

• Fix e-mail attachments with non ASCII chars [tomgross]

2.0.0b7 (2018-09-01)

• Add option to attach form data in XML format to email [nngu6036]

• add some mailer adapter documentation, add required package version pins [tkimnguyen]

2.0.0b6 (2018-08-20)

• Bug fixes:

• update some old documentation, add documentation for @@get_save_data_adapters view [tkimnguyen]

New features:

• add @@get_save_data_adapters view [tkimnguyen]

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 <<[e-mail]>> and having instead name <[e-mail]>. [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