root/form/README.txt

Revision 290, 3.1 kB (checked in by kevin, 8 months ago)

Added clarification on removing vs. deleting fields.

Line 
1 Elgg Form Builder Plugin
2 Version 0.2
3 20 April 2008
4 For Elgg 0.8 and higher
5
6 Kevin Jardine
7 Radagast Solutions
8 http://radagast.biz
9 kevin@radagast.biz
10
11 Warning: this is an alpha plugin and is currently provided for testing
12 purposes only. You might lose profile data in a production system if you
13 use this plugin. So be careful!
14
15 The form module allows you to create full-blown Elgg surveys and to export
16 the results in a CSV (comma-separated value) file.
17
18 You can also use the form module to import your profile.config.php file
19 and to manage all of these fields through the web, both for community
20 and personal profile forms (as well as your registration form if you have
21 the regext plugin installed).
22
23 The form module also requires the prfext module. Both the form and prfext
24 modules should work just fine with Elgg 0.8 and higher.
25 You should make sure that you have the latest version of the prfext module
26 (either from SVN or the plugin download area).
27
28 After you install the form plugin, it creates a number of tables and adds a
29 "Manage forms" option to your admin menu. Currently only site admins can
30 create forms.
31
32 You can create any of the standard Elgg or new prfext field types (including
33 the new profile_radio_group 2D radio button grid) except for the rather
34 complicated group select ( profile_selectg).
35
36 You create a new field by adding it to an existing form. However, field
37 definitions are independent from forms. The same field definition can be
38 used on multiple forms and continues to exist even if the forms that they
39 are associated with are deleted. Removing a field from a form is not
40 the same as deleting the field definition. There is a separate page to
41 list / edit / delete field definitions. There is also a page to manage "orphan"
42 fields that are not currently on any form.
43
44 Both forms and fields must have unique names.
45
46 You can also import your profile fields. Simply import the profile fields
47 (there is a one click option to do this), and then comment them out in
48 profile.config.php and replace them with the single line:
49
50 form_handle_profile();
51
52 After that you can maintain your person and community profile forms through
53 the web. The form plugin does not handle foaf or vcard fields, so if you do
54 use that stuff, you will need to leave those field definitions uncommented
55 in profile.config.php.
56
57 If you have regext installed, you can also manage your registration form
58 through the web as well. You can even use it to manage the title, blurb
59 and response text for the registration form (and the title and blurb for
60 the join form that collects the email address). More details are in the latest
61 version of the regext plugin.
62
63 If you use the form builder plugin to create your own surveys, you can preview
64 the survey, get a public link to it that you can promote to your site members,
65 and export the data collected as a comma separated file. You can also specify
66 for each form whether you want to be notified each time someone submits the form.
67
68 Comments, bug reports and suggestions for improvements are always welcome.
69 Please send them to kevin@radagast.biz
Note: See TracBrowser for help on using the browser.