signup/INSTALL.txt

   1 $Id: INSTALL.txt,v 1.13.2.1 2008/12/20 00:53:06 dww Exp $
   2
   3 It is assumed that you have Drupal up and running.  Be sure to check
   4 the http://drupal.org web site if you need assistance.  If you run
   5 into problems, you should always read the INSTALL.txt that comes with
   6 the Drupal package and read the online documentation.
   7
   8
   9 0. Always backup your database before you enable a new contributed module!
  10
  11
  12 1. Place the signup package into your Drupal modules/ directory.
  13
  14
  15 2. (Optional) Customize the form presented to users when signing up
  16    for content on your site.  Unfortuantely, there is not yet a way to
  17    do this from within your site, you must modify a theme function to
  18    change this form.  See the comment above "theme_signup_user_form()"
  19    in the theme/signup_form.inc file.  If you want to change the form,
  20    you should define your own version of theme_signup_user_form() in
  21    your site's theme (e.g. as phptemplate_signup_user_form()).
  22
  23
  24 3. Enable the signup module by navigating to:
  25    Administer > Site building > Modules
  26
  27    Note: if you want support for automatic closing of events and
  28    reminder emails you must also install and enable either the Event
  29    module (http://drupal.org/project/event) or use the Date module
  30    (http://drupal.org/project/date) and add at least one date field.
  31
  32    Click the 'Save configuration' button at the bottom to commit your
  33    changes.
  34
  35
  36 4. For the final configuration of the module, navigate to:
  37    Administer > Site configuration > Signup
  38
  39    Here you can configure the options for the module.
  40
  41
  42 5. Enable the node types that you wish to allow signups for under:
  43    Administer > Content management > Content types
  44
  45    You may wish to create a new content type specifically for event
  46    signups (which you can customize via the Content Construction Kit
  47    from http://drupal.org/project/cck), or install the Event module
  48    (http://drupal.org/project/event).
  49
  50
  51 6. Grant the proper access to user accounts under:
  52    Administer > User management > Access control
  53
  54    'sign up for content':
  55      Allows users to sign up for any content types that are signup-enabled.
  56      NOTE: Enabling 'sign up for content' for the anonymous user will
  57      allow anonymous users to sign up by entering an email address.
  58
  59    'cancel own signups':
  60      Allows users to cancel their own signups. Without this permission,
  61      only users with 'administer all signups' or 'administer signups for
  62      own content' permission are allowed to cancel signups.
  63      NOTE: Anonymous users aren't allowed cancel their signups even if
  64      this permission is granted to the role 'anonymous user'.
  65
  66    'view all signups':
  67      Allows users to view all of the users who have signed up for any
  68      signup-enabled content on the site.
  69
  70    'email all signed up users':
  71      Allows users to send an email to everyone who has signed up for
  72      any signup-enabled content on the site.
  73
  74    'email users signed up for own content':
  75      Allows a user to send an email to everyone who has signed up for
  76      content owned by the user.
  77
  78    'admininister all signups':
  79      Implies 'view all signups' and 'cancel own signups' permissions.
  80      Allows users to view who has signed up for nodes, to cancel
  81      signups of other users, to close signups for specific nodes, and
  82      to configure system-wide settings related to this module.
  83
  84    'administer signups for own content':
  85      Allows users to view who has signed up, to cancel signups of
  86      other users, and to close signups for any nodes that the user owns.
  87
  88    'cancel signups':
  89      Allows users that can administer signups for a given node to
  90      cancel the signups of other users from the node/N/signups page.
  91
  92    Viewing the signup report (Administer > Content management > Signup),
  93    and configuring the module (Administer > Site configuration > Signup)
  94    are restricted to users who have the 'access administration pages'
  95    privilege.
  96
  97
  98 7. (Optional) If you have enabled the Views module on your site
  99    (http://drupal.org/project/views), be sure you are running Views
 100    version 5.x-1.6 or later.  Once you have everything installed and
 101    working, you should consider customizing any of the signup-related
 102    views to better suit the needs of your site.  For example, if you
 103    are using the event module, you might want to add a filter to the
 104    'current signups' view to restrict it to events that have not
 105    started yet.
 106
 107 8. (Optional) Configure if and how you want a list of users signed up
 108    for each node to appear.  Under the 'Advanced settings' at
 109    admin/settings/signup, if the signup form and related information
 110    is being displayed on the node itself or on a separate tab, you
 111    will find a setting to control how you want the list of signed up
 112    users to appear.  You can either use the built-in listing, no
 113    listing at all, or if you have enabled the Views module on your
 114    site (see step #7 above), you can also embed a view for this.
 115
 116    There is a default view included called 'signup_user_list' which is
 117    disabled by default.  If you enable this view to customize it at
 118    all, you should be careful about two things:
 119
 120    A) Be sure to restrict access to this view to roles that have the
 121       'view all signups' permission to avoid information disclosure.
 122
 123    B) If you continue to embed the view on the signup nodes, be sure
 124       to disable the menu items for the view, so that you don't get a
 125       duplicate tab with the same information.
 126
 127    Note that if you just use it in its default (disabled) form, it
 128    will still work as an embedded view under the signup form, and you
 129    do not need to worry about these two things.
 130
 131    Of course, instead of embedding the view under the signup form, you
 132    can also disable the setting entirely, then enable the default
 133    'signup_user_list' view to provide the information on a separate
 134    tab or in a block.
 135
 136
 137 9. Start signing up!