Skip to content

Commit

Permalink
Merge branch 'v1.1.0-documentation' into v1.1.0
Browse files Browse the repository at this point in the history
  • Loading branch information
hjelmevold committed Dec 10, 2018
2 parents db12dc4 + 47e54d1 commit 27ea874
Show file tree
Hide file tree
Showing 4 changed files with 23 additions and 12 deletions.
18 changes: 14 additions & 4 deletions README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@ The app was originally a fork of https://github.com/it-vegard/xp-form-builder[XP

== Installation

There are three options:
There are three ways to install this app:

* First option is to open the Enonic XP Applications admin tool. In here select "Install" and find this app in the Market list of available apps.
* First alternative is to open the Enonic XP Applications admin tool. In here select "Install" and find this app in the Market list of available apps.
* Second alternative is to simply download the app http://repo.enonic.com/public/com/enonic/app/formbuilder/1.0.0/app-formbuilder-1.0.0.jar[JAR file] and move it to the XP installation's `$XP_HOME/deploy` folder.
* Or you can build this app with gradle. First, download the zip file of this repo. Unpack it locally. In the terminal, from the root of the project, type `./gradlew build`. On Windows, just type `gradlew build`. Next, move the JAR file from `build/libs` to your `$XP_HOME/deploy` directory. The Form Buider app will now be available to add to your websites through the Content Studio admin tool in Enonic XP.

Expand Down Expand Up @@ -42,9 +42,9 @@ Are you a robot? To enable reCAPTCHA, both the Site Key and and Secret Key field

== Creating your first form

From the Content Studio: Create a new content of type "Form" somewhere on a site where you added the application. If you made a page template that supports the Form content type, otherwise you must add it to a page using the "Form view" part.
From the Content Studio: Create a new content of type "Form" somewhere on a site where you added the application. If you made a page template that supports the Form content type, you will get a preview as you edit your form content. Otherwise you must add the form to a page using the "Form view" part before the form can be shown on a page.

You have many options on how to configure your form, but in many cases you can just leave the default settings in place. The only part you need to do, is add one or more input fields. **NB:** If you've configured the app to use the "Minimal" data storage policy, you also _must_ add one or more "Send to" e-mail addresses in the corresponding field further down.
You have many options on how to configure your form, but in many cases you can just leave the default settings in place. The only part you need to do, is add one or more input fields. **NB:** If you've configured the app to use the "Minimal" data storage policy, you also _must_ add one or more e-mail addresses in the corresponding field "Send data by e-mail => To" further down in your configuration.

== Form Report widget

Expand Down Expand Up @@ -79,12 +79,22 @@ If you need access to form response data at a more individual level without runn

|1.0.0
|6.13.0

|1.1.0
|6.13.0
|===

*Important!* This App is not backwards compatible with any XP version before 6.13.

== Changelog

=== Version 1.1.0

* Send e-mail receipt back to the user
* Allow periods in input names
* Support HTML editor macros in thank you message
* Show thank you message also when storage location is set to none

=== Version 1.0.0

* First release
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@ The app was originally a fork of [XP Form Builder by Vegard Haugstvedt](https://

## Installation

There are three options:
There are three ways to install this app:

* First option is to open the Enonic XP Applications admin tool. In here select "Install" and find this app in the Market list of available apps.
* First alternative is to open the Enonic XP Applications admin tool. In here select "Install" and find this app in the Market list of available apps.
* Second alternative is to simply download the app [JAR file](http://repo.enonic.com/public/com/enonic/app/formbuilder/1.0.0/app-formbuilder-1.0.0.jar) and move it to the XP installation's `$XP_HOME/deploy` folder.
* Or you can build this app with gradle. First, download the zip file of this repo. Unpack it locally. In the terminal, from the root of the project, type `./gradlew build`. On Windows, just type `gradlew build`. Next, move the JAR file from `build/libs` to your `$XP_HOME/deploy` directory. The Form Buider app will now be available to add to your websites through the Content Studio admin tool in Enonic XP.

Expand Down Expand Up @@ -42,9 +42,9 @@ Are you a robot? To enable reCAPTCHA, both the Site Key and and Secret Key field

## Creating your first form

From the Content Studio: Create a new content of type "Form" somewhere on a site where you added the application. If you made a page template that supports the Form content type, otherwise you must add it to a page using the "Form view" part.
From the Content Studio: Create a new content of type "Form" somewhere on a site where you added the application. If you made a page template that supports the Form content type, you will get a preview as you edit your form content. Otherwise you must add the form to a page using the "Form view" part before the form can be shown on a page.

You have many options on how to configure your form, but in many cases you can just leave the default settings in place. The only part you need to do, is add one or more input fields. **NB:** If you've configured the app to use the "Minimal" data storage policy, you also *must* add one or more "Send to" e-mail addresses in the corresponding field further down.
You have many options on how to configure your form, but in many cases you can just leave the default settings in place. The only part you need to do, is add one or more input fields. **NB:** If you've configured the app to use the "Minimal" data storage policy, you also _must_ add one or more e-mail addresses in the corresponding field "Send data by e-mail => To" further down in your configuration.

## Form Report widget

Expand Down Expand Up @@ -74,6 +74,7 @@ If you need access to form response data at a more individual level without runn

| Version | XP version |
| ------------- | ------------- |
| 1.1.0 | 6.13.0 |
| 1.0.0 | 6.13.0 |

**Important!** This App is not backwards compatible with any XP version before 6.13.
Expand Down
4 changes: 2 additions & 2 deletions src/main/resources/site/views/error/form-missing-inputs.html
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<div class="info missing-inputs">
<h2>You are almost finished...</h2>
<p>Now you need to add some input elements. If you have already created one you can add it right now. Otherwise you have to go create one and come back to the form once you are done.</p>
<p>For documentation on how to use the form, <a href="https://github.com/it-vegard/xp-form-builder/blob/master/README.md">visit the project home page</a></p>
<p>For documentation on how to use the form, <a href="https://github.com/enonic/app-formbuilder/blob/master/README.md">visit the project home page</a></p>
<p>Good luck!</p>
</div>
</div>
4 changes: 2 additions & 2 deletions src/main/resources/site/views/error/form-not-found.html
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<div class="info not-configured">
<h2>Great, you have added a form part to the page template!</h2>
<p>But we can not find any form. Have you created one and added it to the part?</p>
<p>For documentation on how to use the form, <a href="https://github.com/it-vegard/xp-form-builder/blob/master/README.md">visit the project home page</a></p>
<p>For documentation on how to use the form, <a href="https://github.com/enonic/app-formbuilder/blob/master/README.md">visit the project home page</a></p>
<p>Good luck!</p>
</div>
</div>

0 comments on commit 27ea874

Please sign in to comment.