|
| 1 | +.. _forms: |
| 2 | + |
| 3 | +Forms Module |
| 4 | +============ |
| 5 | + |
| 6 | +This small module enables a user to create and manage forms like questionnaires among users and contacts. It is meant as |
| 7 | +a more privacy-friendly alternative to Google Forms. |
| 8 | + |
| 9 | +Prerequisites |
| 10 | +------------- |
| 11 | + |
| 12 | +Participants for the forms are either core users or contacts. Therefore, the addressbook module needs to be available. |
| 13 | +You need a professional license to use the Forms module. |
| 14 | + |
| 15 | +Creating and Managing Books |
| 16 | +--------------------------- |
| 17 | + |
| 18 | +Forms are kept in books, not unlike note books or address books. :ref:`Sharing books <sharing>` work the same: if a user has access to a book, |
| 19 | +they have access to all forms in that book. |
| 20 | + |
| 21 | +Creating and Managing Forms |
| 22 | +--------------------------- |
| 23 | + |
| 24 | +Form creation is done through the following steps: |
| 25 | + |
| 26 | +1. Create an empty form |
| 27 | +```````````````````````` |
| 28 | + |
| 29 | +.. figure:: /_static/using/forms/forms-1.jpg |
| 30 | + :alt: Editing a sample form |
| 31 | + :width: 50% |
| 32 | + |
| 33 | + Editing a sample form |
| 34 | + |
| 35 | +Add at least a title. You can optionally set a description, a period and even a reminder mail. |
| 36 | + |
| 37 | + |
| 38 | +2. Add the fields of the form |
| 39 | +`````````````````````````````` |
| 40 | + |
| 41 | +A large number of field types is available. The system is not unlike adding custom fields. You can order the individual fields |
| 42 | +through drag and drop. There's also options to conditionally hide fields or to conditionally require them. |
| 43 | + |
| 44 | +.. figure:: /_static/using/forms/forms-add-field.jpg |
| 45 | + :alt: Add a field |
| 46 | + :width: 50% |
| 47 | + |
| 48 | + Add a field |
| 49 | + |
| 50 | + |
| 51 | +3. Add participants |
| 52 | +```````````````````` |
| 53 | + |
| 54 | +In order to identify your target audience, you have to add them to the 'Participants' list. This can be done with a |
| 55 | +simple search field. |
| 56 | + |
| 57 | +.. note:: In order for a participant to be available, they have to exist in the addressbook module. |
| 58 | + |
| 59 | +4. Send out the invitations |
| 60 | +```````````````````````````` |
| 61 | +.. figure:: /_static/using/forms/forms-send-invitation.jpg |
| 62 | + :alt: Invite participants |
| 63 | + :width: 50% |
| 64 | + |
| 65 | + Invite participants |
| 66 | + |
| 67 | +When you're satisfied with the form, you need to invite your participants. Simply click the 'Send' button and amend your |
| 68 | +subject and body to your taste. |
| 69 | + |
| 70 | +The invitees will receive an email with the link to the form, which will look somewhat like this: |
| 71 | + |
| 72 | +.. figure:: /_static/using/forms/forms-sample.jpg |
| 73 | + :alt: A sample form for the participant |
| 74 | + :width: 50% |
| 75 | + |
| 76 | + A sample form for the participant |
| 77 | + |
| 78 | +After filling in the form and submitting, an optional 'Thank you' text is shown. |
| 79 | + |
| 80 | +When a participant has filled in the form, it will be shown in the participants list. |
| 81 | + |
| 82 | +Tips |
| 83 | +---- |
| 84 | + |
| 85 | +- You can :ref:`link <links>` forms to other objects like projects or tasks. |
| 86 | +- Forms can be cloned by clicking the button labeled 'Duplicate'. |
| 87 | +- View the results in a spreadsheet format by clicking the 'Download report' button. |
| 88 | +- Expired forms can be hidden by clicking the 'Archive' button. You can view archived forms by using the filter in the left panel. |
0 commit comments