Documentation

Thank you for buying Extended Form!

Setting up your form

Where do you need help with?
- Formfields, Content items and/or Recipient selector
- Preview
- Required form elements (captcha, required fields, submitbutton)
- Other form options
- After submitted
- Editing
- CSS
- FAQ


Here some explanation about the formfields and there options

Formfields

Textfield
Required: title
Options: tooltip, required
Validation (when required is checked): may not be empty, accepts every character
Description: Adds a single textfield in the form
Extra: none

E-mailaddress Field
Required: title
Options: send copy and reply-to, validation, tooltip, required
Validation (when required is checked): may not be empty, accepts only e-mailaddresses
Description: Adds a single textfield in the form that only accepts e-mailaddress
Extra: When added to the form you can check the "send copy and reply-to"-checkbox. When this is checked the submitter of the form will receive a notification e-mail and the admin will receive an e-mail with this e-mailaddress as sender. Use this if you want to reply to received e-mails. When validation is checked another formfield is added to the form. The e-mailaddress entered in the first formfield and the second are being confirmed. They should match, if not the addon gets back to the form.

Textarea
Required: title
Options: content option, settings (width & height), tooltip, required
Validation (when required is checked): may not be empty, accepts every character
Description: Adds a textarea in the form
Extra: The content option is a default value of the textarea. The width and height settings allows you to manipulate the size of the textarea. Note that the settings will be overwritten by the stylesheet.

TinyMCE Textarea
Required: title
Options: tooltip, required
Validation (when required is checked): may not be empty, accepts every character
Description: Adds a TinyMCE editor in the form
Extra: The editor will be a simple version, so no advanced stuff

Integer
Required: title
Options: length, tooltip, required
Validation (when required is checked): may not be empty, accepts only numeric characters
Description: Adds a single textfield in the form that only accepts numeric characters
Extra: Length will allow you to add the number of characters the submitter must enter. So if length is 4 the entered value must be something between 0000 and 9999. When length is 99 all numeric values will be accepted.

Radiobuttons
Required: title
Options: content options, other option, tooltip, required
Validation (when required is checked): may not be empty, selection is required
Description: Adds a single or group of radiobuttons.
Extra: Content options allows you to create the different options to select. Every new line is a new radiobutton. Other option creates an extra option where the user can manually fill in his/her own. Something like none of the above...

Selectbox
Required: title
Options: content options, other option, tooltip, required
Validation (when required is checked): may not be empty, selection is required
Description: Adds a single selectionbox.
Extra: Content options allows you to create the different options to select. Every new line is a new option in the selectionbox. Other option creates an extra option where the user can manually fill in his/her own. Something like none of the above...

Checkboxes
Required: title
Options: content options, other option, tooltip, required
Validation (when required is checked): may not be empty, single or multiple selection is required
Description: Adds a single or group of checkboxes.
Extra: Content options allows you to create the different options to select. Every new line is a new checkbox. Other option creates an extra option where the user can manually fill in his/her own. Something like none of the above...

Date/time
Required: title
Options: date/time options, tooltip, required
Validation (when required is checked): may not be empty, date/time is required
Description: Adds a textfield with datepicker/timeselector
Extra: Date/time options has 3 options. Date/time creates a datepicker and timeselector, date only adds a datepicker and time only addes a timeselector. Default format is "YY/mm/dd H:i:s"

Hiddenfield
Required: title
Options: value, tooltip
Validation (when required is checked): none
Description: Adds a hiddenfield with or without a default value
Extra: Allows you to pass hidden information into the form

Fileupload
Required: title
Options: tooltip, required
Validation (when required is checked): may not be empty, a file must be uploaded
Description: Adds a file upload field
Extra: Uploaded files are uploaded in the dashboard an are also visable in the reports. The download link will be published in the e-mail that is send to the admin (and submitter if "send copy and reply to"-checkbox is checked, see e-mailaddress field for more info)

Rating
Required: title
Options: stars, tooltip, required
Validation (when required is checked): may not be empty, a rating must be given
Description: Adds a star-rating field to the form
Extra: The stars options allows change the number of stars that can be selected. 5 will show 5 stars, 10 will show 10 stars and so on...


Content items

Title (h4)
Required: title
Options: none
Description: Adds a heading 4 to the form
Extra: The title will be shown with <h4>-tags

Text (p)
Required: title
Options: text
Description: Adds a paragraph to the form
Extra: The text inserted will be shown with <p>-tags

Horizontal rule
Required: title
Options: none
Description: Adds a horizontal rule to the form
Extra: This will add a single line (<hr />-tag)

Empty line
Required: title
Options: none
Description: Adds a spacer to the form
Extra: This will add a empty line (spacer) to the form. Note that it isn't a break (<br />)..

Field set (start)
Required: title
Options: legend
Description: Adds the start of a fieldset with or without a legend
Extra: This is only the start of the fieldset, so you should also add the field set (end) after this field. With the legend-option you can add a legend to the fieldset.

Field set (end)
Required: title
Options: none
Description: Adds the end of a fieldset
Extra: This is only the end of the fieldset, so you should also add the field set (start) before this field.


Others

Recipient selector
Required: title, recipients
Options: required
Description: Adds a selectbox with recipients
Extra: Recipients-option allows you to add different recipients. Every new line is a new recipient in the selectionbox. Put each recipient (e-mailaddress;name) on a new line. Example: [email protected];Firstname Lastname. The name (if added) will be shown in the selectionbox. The e-mailaddress is automatically encrypted, so no e-mailaddress is shown. When a recipient selector is in the form, the selected recipient will receive an e-mail. The admin will also receive an e-mail.


Required form elements

Somethings need to be done...

Formname
The formname is required. Should be something like "Contactform" or "Inquiry"...

Use Captcha
Captcha is used to determine if a human is filling out the form. If you like spam, don't use it... ;-)
If you use it you can use the default captcha of Concrete5 or you can use Google's reCaptcha.
Fill out the necessary fields and you are good....

Required fields
If you have required fields in your form you can notify the submitter at the bottom of the form.
Every required fields gets an astrix (*) besides its title.


Other options

The addon has some more features you might want to use...

Custom sender
Normally the recipient of the e-mails towards the submitter are from the user who added the form (most of the time this will be the admin). Use this option if you want to determine which recipient should be used for the e-mails. You can add a name and e-mailaddress.

Notify someone
When the form is submitted you can notify someone with the form results, Put in a e-mailaddress and the form will be send to this e-mailaddress. The form will still be saved in the Reports of the dashboard.

Capture User
Loggedin users can aslo be captured. This way you know who submitted the form.

Capture IP
Captures the users IP-address.

Capture PageID
Useful when you use the form within your scrapbook. Now you know which page the form was on!a


After submitted

After submitting the form you have a few options.

Subject of e-mails
Change the subject of the e-mail, if you want to use the formname just enter %s.

Adding a default attachment to the e-mail
You can select a file/or image to be automatically send with the e-mail. You can use this to send a singup form or a guaranteeform or something like that...

Message after submitting / Redirect after submitting
Here there are 2 options. You can either add a message after submitting or redirect to another page. The message doens't allow you to use HTML or something fancy, just a simple "thank you" is no problem. If you want more I suggest to use the redirect option.


Editing

You can change certain things about this script.

/blocks/controller.php - language and form functions.

/js/jquery.form.js - edit the behavior of the form

/js/jquery.tooltip.js - edit the behavior of the tooltip

/js/jquery.rating.js - edit the behavior of the rating stars

/mail/submission_admin.php - outgoing mail to the admin / webmaster
/mail/submission_recepient.php - outgoing mail to the recipient

Keep in mind that the files in /mail/ are overwritten when updating this addon!

You can work with templates, example template is available in this addon.
Check the files /blocks/extended_form/templates/custom


CSS

Here some explanation about using the custom classes for each field / item.
The custom class is alwasy assigned to the input.
When the input has more "children" like label or other (when checked), you can use this
also with your custom class...

Example:

.mycustomclassname { // This is the inputfield
}

.mycustomclassname_label { // This is the label for the inputfield (available for radio, checkbox, select)
}

.mycustomclassname_other { // This is the label for the "other" inputfield, when check (available for radio, checkbox, select)
}

.mycustomclassname_tooltip { // This is the tooltip for the inputfield
}

Some predefined class in the form...

.formBlockSurveyTable - Represents the complete form
.formBlockSurveyRow - Each row within the form.
.formBlockSurveyCell - Each cell within the form. Title and inputfield are each in different cells but have the same class.

.question - Assigned to the cell that holds the question or name of the input field
.answer - Assigned to the cell that holds the inputfield

.checkboxList - A div around the checkboxes
.checkboxPair - A div around the checkbox and its label

.radiobuttonsList - A div around the radios
.radiobuttonsPair - A div around the radios and its label

.otherDiv - A div around the "other" inputfield (available for radio, checkbox, select)
.tooltip_holder - This holds the text in the tooltip.

.space - Assigned to the cell that holds the space item
.text - Assigned to the cell that holds the text item
.hr - Assigned to the cell that holds the hr item
.line - Assigned to the cell that holds the line item
.fieldset - Assigned to the cell that holds the fieldset item
.legend - Assigned to the cell that holds the legend item
.required - Astrix and "required"-text in the form


FAQ

1. The admin can't reply!
You need an e-mailaddress field in the form and the checkbox "Send copy and Reply to" must be checked. In the options tab you need to check "Notify someone" and insert a valid e-mailadres. The form will be submitted to this address and the submitter will be the sender.

2. Can this addon be used as a registration page of profile page?
No! There is no connection between the users of your C5 installation and this addon.

3. The e-mails I receive are in plain text
Yes, this is correct. This addon can't use HTML e-mails (yet). So all fields (including TinyMCE) will be converted to plain text.

4. How do I change the e-mail to my admin and/or submitter?
Change the files in the "mail" folder of this addon. See also Editing.