Download the Event source into the directory on the webserver where it will be stored. This directory will need to be writable by your user, but will not need to be writable by the web server itself. Event is designed for PHP and Apache httpd. It makes use of local .htaccess and mod_rewrite rules.
Event is designed to be self contained, although it may require some initial tweaking to get it to work depending upon how you have PHP configured. Take a look at
php/config.inc in your event directory if you have problems. Event may need to have "." in the PHP include_path variable, set in php.ini (this should be set by default).
For each event you want to inclue in your Event instance, you will create a file in
events/ under your Event directory. The name of this file will be used as part of the URL that will point to the Event page.
It is the author's hope that the Event file format is generaly intuitive. It contains sections which are strings contained by a '[' ']' bracket pair—for instance every event file should have the
[event] section which describes basic event information. Within each section is a seriries of key, value pairs. These are separated by a colon (':'), and have the format
[event] name:A Sample Event hosts:Jake time:1316284200 location:Wrigley Field address:1060 West Addison Street, Chicago, Illinois 60613 greeting:We're getting the band back together. after:after_party
Most key value pairs in an Event file are straight forward, such as here, the value associated key name in the event section is taken to be the name of the event described by this file. Information such as the location, hosts, and address are similarly taken as flat string values and inserted into various locations in Event. The time value is the time of the event according to the Unix-epoch (seconds since midnight 1970-01-01 UTC).
One special entry in this example is that of the key after. Its value, after_party is not used on its own inside of Event. Instead, it is used as a reference by Event, telling Event to use the section after_party to when information about after is requested.
References help keep the Event file manageable but powerfully descriptive. It keeps information logically organized, such that all key-value pairs logicaly describe the section containing them. Only certain key-value pairs function as references, these are (in the form section.key):
These sections are always treated as references. If they exist in your file, they should have a matching section named after their value. To ensure that you're not going to collide with an existing or future standard Event section, you can use the underscore character ('_') which will not be used in standard Event section names.
For more information about non-standard sections, see the section "Non-standard Sections" below.
event. There can be multiple
page:displayed name, where page is one of the defined pages, and "displayed name" is the name to display in the navigation links. If no
displayed nameis given, the page name is used as
blurb. Zero or more.
leaving. Added in v0.3
textual description. Zero or more.
textual description. Zero or more.
Homeis designed to provide a quick overview of an event, including Who is hosting it, What it is, When it will take place, and where it will be. Optionally, a free-form
greetingcan explain how and why.
Locationprovides maps and information to the event.
lodgingentries listed under the
restaurantsentries listed under the
thingentries listed under the
Display Namefor this page, in which case it will use a section of the format
display_name(all lowercase, with spaces converted to underscores) for its information. The format for this section is each line of the page prefixed with