diff --git a/en_US/freeform/assets/forms-ajax.png b/en_US/freeform/assets/forms-ajax.png new file mode 100644 index 0000000..cbfd899 Binary files /dev/null and b/en_US/freeform/assets/forms-ajax.png differ diff --git a/en_US/freeform/assets/forms-block.png b/en_US/freeform/assets/forms-block.png new file mode 100644 index 0000000..a1f6db1 Binary files /dev/null and b/en_US/freeform/assets/forms-block.png differ diff --git a/en_US/freeform/assets/forms-composer.png b/en_US/freeform/assets/forms-composer.png new file mode 100644 index 0000000..a312c87 Binary files /dev/null and b/en_US/freeform/assets/forms-composer.png differ diff --git a/en_US/freeform/assets/forms-fields.png b/en_US/freeform/assets/forms-fields.png new file mode 100644 index 0000000..fbd09f9 Binary files /dev/null and b/en_US/freeform/assets/forms-fields.png differ diff --git a/en_US/freeform/assets/forms-notifications.png b/en_US/freeform/assets/forms-notifications.png new file mode 100644 index 0000000..0778595 Binary files /dev/null and b/en_US/freeform/assets/forms-notifications.png differ diff --git a/en_US/freeform/assets/forms-return.png b/en_US/freeform/assets/forms-return.png new file mode 100644 index 0000000..0f9559a Binary files /dev/null and b/en_US/freeform/assets/forms-return.png differ diff --git a/en_US/freeform/info.json b/en_US/freeform/info.json new file mode 100644 index 0000000..bfeab5b --- /dev/null +++ b/en_US/freeform/info.json @@ -0,0 +1,17 @@ +{ + "title": "Freeform (Twig)", + "description": "This is a guide for basic Freeform use where editors are allowed to create and edit their own forms.", + "assetsPath": "en_US/freeform/assets", + "templatesPath": "en_US/freeform/templates", + "guides": [ + { + "format": "twig", + "slug": "freeform", + "template": "freeform.twig", + "title": "Freeform" + }, + ], + "contributors": [ + "@darylknight" + ] +} \ No newline at end of file diff --git a/en_US/freeform/templates/freeform.twig b/en_US/freeform/templates/freeform.twig new file mode 100644 index 0000000..8502cd5 --- /dev/null +++ b/en_US/freeform/templates/freeform.twig @@ -0,0 +1,37 @@ +

You can create and edit forms from within the control panel under Freeform in the sidebar.

+ +

Dashboard

+

The dashboard displays an overview of all your form data; how many submissions there are, how many forms you have, errors etc.

+ +

Creating Forms

+

To create a form, go to Forms and click + New Form

+ +

Editing Forms

+

To edit an existing form, go to Forms and click on the title of the form you want to edit. This will take you to the form composer, and has an inbuilt click-through guide on how to build forms. You can open the walkthrough by clicking on this flashing icon:

+ + +

Adding Forms to Pages

+

When editing another entry on the site, you can add any forms you've previously created by adding a Form block to the page. This will ask you which form to include. If AJAX is enabled on the form itself, you'll be able to customise the success and error messages for that form here.

+ + +

Submission Methods

+

Forms have two methods of submission; AJAX or no-AJAX: +

+

You can enable or disable AJAX per-form using the checkbox on the form editor:

+ +

If AJAX is disabled, you should add a Return URL. This defines where the form will redirect the user to after they click submit. It should be a page on your website.

+ + +

Notifications

+

Admin Notifications

+

You can send form submissions by email to as many people as you like by clicking on the envelope tab in the form builder, selecting a notification template, and adding email addresses.

+ +

Auto Responses

+

You can choose to send an automatic reply to a user when they submit a form by adding a notification to the email field they fill in. Click on the email field you added to your form, then in the sidebar on the right, select the notification template to use.

+ +

Adding fields

+

You can add fields to use in all of your forms either from the Fields section of Freeform, or by adding them while building a new form from the sidebar on the left.

+ diff --git a/guides.json b/guides.json index 45f7ced..7c405ea 100644 --- a/guides.json +++ b/guides.json @@ -5,6 +5,9 @@ }, { "path": "en_US/general_twig" + }, + { + "path": "en_US/freeform" } ] } \ No newline at end of file