setting max quantity for number of tickets based on "spaces allowed" field value...
[project/registration.git] / README.txt
1 Entity based registration system for Drupal.
2
3 # Configuration
4 1. Download and enable the module.
5 2. Create at least one registration bundle (or type) at
6 /admin/structure/admin/structure/registration/registration_types, much like you would a content type.
7 3. Add a registration field to any entity you want to enable registrations
8 for. Note the display options: default, link to the registration form,
9 and embedding the actual form.
10 4. When you add or edit an entity, select the registration bundle you want to
11  use for.
12 5. Registrations are now enabled for the entity and you can configure the
13 registration settings via a local task.
14
15 # Settings
16 1. Enable: Turn registrations on / off for a given node.
17 2. Capacity: The maximum number of registrants for a given node. Leave at 0 for
18 no limit.
19 3. Allow Multiple: If selected, users can register for more than one slot for
20 this event.
21 4. Send a reminder. Checking this exposes reminder date and message template
22 fields.
23
24 # Usage / Features
25 1. Manage registrations for any enabled entity.
26 2. Per entity registration settings.
27 3. Broadcast emails to all event registrants.
28 4. Associate any field types to a registration to collect the information needed
29 for your event.
30 5. Send reminders on a given date.
31
32 # Integrations for more functionality
33 ## [Fields](http://api.drupal.org/api/drupal/modules--field--field.module/group/field/7)
34 This is where things get interesting. You can add any Drupal field to customize
35 your registrations. The fields widgets will automatically appear on the register
36 form and will be available from a registration detail page.
37
38 ## [Views](http://drupal.org/project/views)
39 Not happy with the default tabular list of registrations? No problem,
40 registrations and their fields are all Views friendly. You can override the
41 default event registrations list, create additional ones, etc.
42
43 ## [Rules](http://drupal.org/project/rules)
44 Rules is a great companion for Registration to send confirmation emails, event
45 notifications, etc.
46
47 ## Registrants via [Field Collection](http://drupal.org/project/field_collection)
48 Attaching a field collection field to a registration allows you to collect
49 granular information for multiple registrants for a single registration. Here's
50 how it works.
51
52 1. Download and enable Field Collection.
53 2. Add a field collection field to your registration entity.
54 3. Add any fields that you want to collect to the field collection entity and
55 configure widget and display settings. You might also want to consider field
56 collection table to create tabular lists of registrants.
57
58 That's it. Now, when a registration is added, users can complete one or more
59 field collections for each registrant.
60
61 # Roadmap
62 1. Tighter integration with Field Collection for a more robust registration ->
63 registrant system. Namely, mapping the registration capacity to the number of
64 field collections per registration.
65 3. Registration Feature that bundles everything you need in a tidy package to
66 start using registrations out of the box.