| 1 |
/*
|
| 2 |
* Installation Instructions
|
| 3 |
* Author: Michael Haggerty, mhaggerty@trellon.com
|
| 4 |
*
|
| 5 |
* TABLE OF CONTENTS
|
| 6 |
* -----------------
|
| 7 |
* I. Overview
|
| 8 |
* II. Installation
|
| 9 |
* III. Permissions
|
| 10 |
* IV. Settings
|
| 11 |
* 1) Search Settings
|
| 12 |
* 2) Display Settings
|
| 13 |
* 3) Registration Settings
|
| 14 |
* 4) Mailer Options
|
| 15 |
* 5) Saved Search Options
|
| 16 |
* V. EventFinder Controls
|
| 17 |
* VI. Configuration Issues
|
| 18 |
*
|
| 19 |
*/
|
| 20 |
|
| 21 |
I. Overview
|
| 22 |
--------------------------------------------------
|
| 23 |
EventFinder has the same basic technical requirements as drupal and
|
| 24 |
requires a number of additional modules in order to operate. At a
|
| 25 |
minimum, eventfinder requires event.module and location.module
|
| 26 |
for drupal 4.6. These modules should be installed prior to installing
|
| 27 |
eventfinder. Additionally, several optional features depend upon the
|
| 28 |
contact_manager module, built by CivicSpace Labs. At the time of this
|
| 29 |
writing, contact_manager can be downloaded from the following address:
|
| 30 |
|
| 31 |
http://drumm.drupaldevs.org/contact_manager.tgz
|
| 32 |
|
| 33 |
EventFinder also has a number of settings which must be configured
|
| 34 |
prior to use on a drupal site. These will be covered in detail below.
|
| 35 |
|
| 36 |
This document assumes a basic familiarity with the event module and the
|
| 37 |
location module.
|
| 38 |
|
| 39 |
Installation issues should be sent to mhaggerty@trellon.com.
|
| 40 |
|
| 41 |
II. Installation
|
| 42 |
---------------------------------------------------
|
| 43 |
1) Install event.module and location.module on your drupal site.
|
| 44 |
OPTIONAL: Install contact_manager module.
|
| 45 |
|
| 46 |
2) Download the EventFinder module and copy the files
|
| 47 |
under your drupal modules/ directory.
|
| 48 |
|
| 49 |
3) Navigate to the EventFinder installation directory and
|
| 50 |
install the database defintions for EventFinder. The syntax
|
| 51 |
for the mysql command is as follows:
|
| 52 |
|
| 53 |
mysql -u [username] -p [drupal db name] < eventfinder.mysql
|
| 54 |
|
| 55 |
Where 'username' is the name of a user on your installation of
|
| 56 |
mysql who has CREATE access on your drupal database, and 'drupal
|
| 57 |
db name] is the name of your drupal database.
|
| 58 |
|
| 59 |
4) Login to your drupal site using an administrative account. Navigate
|
| 60 |
to admin/modules and enable EventFinder.
|
| 61 |
|
| 62 |
5) Navigate to admin/settings/eventfinder and enable / disable options
|
| 63 |
to your liking. EventFinder settings are covered in detail below.
|
| 64 |
OPTIONAL: Within contact_manager, define a source for contacts
|
| 65 |
generated as a result of EventFinder registrations.
|
| 66 |
|
| 67 |
6) Navigate to admin/access control and enable / disable EventFinder
|
| 68 |
permissions to your liking. Permissions are covered in detail below.
|
| 69 |
|
| 70 |
7) OPTIONAL: Enable cron on your drupal site to support sending saved
|
| 71 |
searches via email.
|
| 72 |
|
| 73 |
III. Permissions
|
| 74 |
-----------------------------------------------------
|
| 75 |
There are 4 permissions in EventFinder
|
| 76 |
|
| 77 |
1) Search Events - User has the ability to search for events within eventfinder.
|
| 78 |
Without this permission, EventFinder is effectively useless to a given
|
| 79 |
user group.
|
| 80 |
|
| 81 |
2) Saved Searches - User has the ability to create saved searches and
|
| 82 |
receive saved search emails.
|
| 83 |
|
| 84 |
3) Host Event - User has the ability to view the bost event page. Permissions
|
| 85 |
at this point are a little complicated - essentially, the host event page
|
| 86 |
will display all node types which the user has permission to create. User
|
| 87 |
groups without permission to create event-enabled node types will find this
|
| 88 |
permission to be useless.
|
| 89 |
|
| 90 |
EventFinder has no native node type, nor does it grant users permissions to
|
| 91 |
other node types.
|
| 92 |
|
| 93 |
4) admin eventfinder - User has the ability to administer EventFinder. This
|
| 94 |
permission currently does nothing but will be useful when other modules
|
| 95 |
are integrated into EventFinder.
|
| 96 |
|
| 97 |
IV. Settings
|
| 98 |
-----------------------------------------------------
|
| 99 |
EventFinder has a number of settings which must be enabled in order
|
| 100 |
for the module to work. Additonally, these settings affect the functionality
|
| 101 |
of the module itself. Administrators are urged to take care to understand
|
| 102 |
these settings prior to implementing the module.
|
| 103 |
|
| 104 |
1) Search Settings
|
| 105 |
------------------
|
| 106 |
There are 5 basic types of searches that EventFinder supports. Each seach type
|
| 107 |
can be turned on and off using these features. Checking off the checkbox next to
|
| 108 |
a search type will remove that search criteria from both the main search form and
|
| 109 |
the saved search form.
|
| 110 |
|
| 111 |
a) Enable Event Taxonomy Searches - Displays event taxonomy search controls on the
|
| 112 |
search interface.
|
| 113 |
|
| 114 |
b) Enable Event Type Searches - Displays event type search controls on the search
|
| 115 |
screen.
|
| 116 |
|
| 117 |
c) Enable Location Proximity Searches - Displays search controls for searching by
|
| 118 |
zip code radius.
|
| 119 |
|
| 120 |
d) Enable State Searches - Displays search controls for searching by state.
|
| 121 |
|
| 122 |
e) Enable Major Metropolitan Area Searches - Displays search controls for searching
|
| 123 |
by Major Metropolitan Area.
|
| 124 |
|
| 125 |
2) Display Settings
|
| 126 |
-------------------
|
| 127 |
These settings control several elements of the search interface including placement
|
| 128 |
of controls and instructions to users.
|
| 129 |
|
| 130 |
a) Display EventFinder Options: Controls whether the event subscription controls
|
| 131 |
appear above or beneath the main body of event-enabled nodes within the system.
|
| 132 |
|
| 133 |
b) Search Description: Descriptive text to display to users doing a search. Leaving
|
| 134 |
this field blank supresses the description.
|
| 135 |
|
| 136 |
c) MyEvents Description: Descriptive text to display to users visiting their MyEvents
|
| 137 |
page. Leaving this field blank supresses the description.
|
| 138 |
|
| 139 |
d) Host an Event Description: Descriptive text to display to users on the Host an Event
|
| 140 |
page. Leaving this field blank supresses the description.
|
| 141 |
|
| 142 |
e) Send Message to Registered Users Description: Descriptive text to display to users
|
| 143 |
on the Send Message to Registered Users page.
|
| 144 |
|
| 145 |
3) Registration Settings
|
| 146 |
------------------------
|
| 147 |
These settings control how and when users can register for events in the system.
|
| 148 |
|
| 149 |
a) Registration List Description: A description to appear at the top of the event
|
| 150 |
registration screen.
|
| 151 |
|
| 152 |
b) Registration Workflow: Controls how users are able to register for events. Changing
|
| 153 |
this setting once EventFinder is installed and users have begun registering for
|
| 154 |
events is NOT suggested.
|
| 155 |
|
| 156 |
One Click: Users with an account on your drupal site can register for an event
|
| 157 |
simply by clicking on a link. Users must have an account on your site in order
|
| 158 |
to register for an event.
|
| 159 |
|
| 160 |
Registration Page: Users are taken to a registration page in order to register
|
| 161 |
for an event. In this way, anonymous users can register for an event.
|
| 162 |
|
| 163 |
c) Storage Options: Controls where user contact information is kept under 'Registration
|
| 164 |
Page' style registration. Currently, the only repository supported is the
|
| 165 |
contact_manager module.
|
| 166 |
|
| 167 |
d) Contact Source Group: The source group within the contact_manager module to use
|
| 168 |
for EventFinder registrations.
|
| 169 |
|
| 170 |
4) Mailer Options
|
| 171 |
-----------------
|
| 172 |
These settings control the behavior of the EventFinder mailer sub-system.
|
| 173 |
|
| 174 |
a) Enable EventFinder to send a confirmation mail to people who enter events - Basically,
|
| 175 |
since EventFinder works on top of the event system, it may or may not be a good idea to
|
| 176 |
have emails going out every time someone enters an event-enabled node type within the
|
| 177 |
system. Unchecking this box turns entry emails off.
|
| 178 |
|
| 179 |
b) Enable registration confirmation email - Similar to the previous item, EventFinder sends
|
| 180 |
an email when someone registers to attend an event. Unchecking this box stops this behavior.
|
| 181 |
|
| 182 |
c) Email Name: The name you want to appear in email clients for emails from EventFinder. Applies
|
| 183 |
to all emails sent from the system.
|
| 184 |
|
| 185 |
d) Email Address: The email address you want to appear in email clients for emails from
|
| 186 |
EventFinder. This setting applies to all emails generated by the system.
|
| 187 |
|
| 188 |
e) Host Email Subject Line - The subject line for the host email. When a user enters an
|
| 189 |
event-enabled node type into the system, EventFinder checks to see whether host emails are
|
| 190 |
enabled and sends out a thank you message. Wildcards can be included here corresponding to
|
| 191 |
the event type in the system.
|
| 192 |
|
| 193 |
f) Host Email Body - The body of the email to be sent to users once they have entered an
|
| 194 |
event-enabled node type. Wildcards here include any field that is part of the event-enabled
|
| 195 |
node type, prefixed by a percentage (%) sign. For example, %title. While it would be nice to
|
| 196 |
offer a standard set of fields that covers all node types, this is not possible given the
|
| 197 |
fact there can be any number of fields associated with a node.
|
| 198 |
|
| 199 |
g) Register Email Subject Line - The subject line for the register email. When a user registers
|
| 200 |
for an event through EventFinder, the system checks to see whether register emails are enabled
|
| 201 |
then sends out a thank you message. Wildcards can be included here corresponding to the
|
| 202 |
event type in the system.
|
| 203 |
|
| 204 |
h) Register Email Body - The body of the email to be sent to users once they have registered for
|
| 205 |
an event through EventFinder. Wildcards here include any field that is part of the event-enabled
|
| 206 |
node type, prefixed by a percentage (%) sign. For example, %title. While it would be nice to
|
| 207 |
offer a standard set of fields that covers all node types, this is not possible given the fact
|
| 208 |
there can be any number of fields associated with a node.
|
| 209 |
|
| 210 |
5) Saved Search Options
|
| 211 |
-----------------------
|
| 212 |
These settings affect saved searches throughout the system. Saved searches are a way of 'pushing'
|
| 213 |
events into people's mailboxes using an opt-in subscription system. While they are cool, there could
|
| 214 |
be a performance hit on a high-volume site. Controls are presented for turning saved searches on and
|
| 215 |
off in the system.
|
| 216 |
|
| 217 |
a) Enable Saved Searches - Enable / disable saved searches. Overrides all other options.
|
| 218 |
|
| 219 |
b) Maximum Saved Searches per User - The maximum number of saved searches a single user can create.
|
| 220 |
Not implmemented at the time of this writing.
|
| 221 |
|
| 222 |
c) Saved Search Description - Descriptive text to present to users at the main saved search page.
|
| 223 |
|
| 224 |
d) Create Saved Search Instructions - Descriptive text presented to users at the create saved search
|
| 225 |
page.
|
| 226 |
|
| 227 |
e) Saved Search Email Subject Line - The subject line of messages to be sent through the saved search.
|
| 228 |
|
| 229 |
f) Saved Search Email Body - The body of the messages to be sent through the saved search system.
|
| 230 |
Because the number of search results will vary for each user, this is really just a container for
|
| 231 |
descriptions of specific nodes in the email.
|
| 232 |
|
| 233 |
g) Saved Search Event Description - This field controls how a saved search result is presented within
|
| 234 |
the email.
|
| 235 |
|
| 236 |
V. EventFinder Controls
|
| 237 |
------------------------------------------------------
|
| 238 |
When creating a node that is event-enabled (users familiar with the event module understand
|
| 239 |
this concept), a form group will appear labelled 'EventFinder Options'. There are 2 fields
|
| 240 |
here: 'Enable Online Registration for this Event' and 'Maximum Number of Online Registrants'.
|
| 241 |
|
| 242 |
Clicking the 'Online Registration' checkbox will allow users to register for an event.
|
| 243 |
|
| 244 |
Setting the 'Maximum Number of Online Registrants' will limit the number of people who can
|
| 245 |
register for an event.
|
| 246 |
|
| 247 |
VI. Configuration Issues
|
| 248 |
------------------------------------------------------
|
| 249 |
Out of the box, EventFinder is not extremely pretty. Part of this is a result of how the module
|
| 250 |
was developed, relying on information from other modules (i.e. the date and time of an event
|
| 251 |
is separated on the node description from the placement of location information). The authors
|
| 252 |
of these modules have been contacted and are working on a solution at the time of this writing.
|
| 253 |
|
| 254 |
Part of the issue of appearance is a result just of how EventFinder is, and steps have been
|
| 255 |
taken in development to ensure easy configuration of the module for production environments.
|
| 256 |
All of the themes within EventFinder are kept within the eventfinder_themes.inc file, which can
|
| 257 |
(should) be edited. Also, the css controlling EventFinder themes is located in the file
|
| 258 |
eventfinder.css. Each of these files can be located under the eventfinder installation directory.
|
| 259 |
|
| 260 |
|
| 261 |
|
| 262 |
|
Parent Directory
| 
Revision Log
| 
Revision Graph