About Event | Configuration Information | Live Demo

Event Configuration

Installing Event

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.

PHP Configuration

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/ 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).

One File Per Event

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.

Event file overview

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 key:value.

Sample event section
name:A Sample Event
location:Wrigley Field
address:1060 West Addison Street, Chicago, Illinois 60613
greeting:We're getting the band back together.

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.

Standard Sections
name: The name of the event, used in headings.
hosts: The name of the host(s), which will be used on various pages.
time: The time of the event according to the Unix Epoch.
location: Human-readable location, e.g. My House.
address: Street address, preferably something a generic geocoding navigation system would understand.
greeting: Free-form text to show on the event's homepage.
after: (reference) A section that describes an event to follow, but is associated with, this event. Its sections are the same as event. There can be multiple after entries.
image: (reference) A reference to an image-section whose thumb will be used on the event listing page.
email: The eMail address to which event will send messages (e.g. from the contact form or RSVP form). This is not publicly viewable.
This section contains a list of the pages that you want to show for a given event. The format is 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 name is given, the page name is used as displayed name.
blurb: Free-form text to show above the RSVP form.
text: The value of this is used as a label for a text input box. Zero or more.
boolean: The value of this is used as a label for a yes/no radio input. Zero or more.
lodging: (reference) A section describing loding nearby.
food: (reference) A section describing nearby restaurants.
thing: (reference) A section describing activities nearby.
blurb: Free-form text.
section: (reference) A section containing more detailed transportation information than does blurb. Zero or more.
airport: IATA airport code to use as a nearby-destination for the air-flight search form on the Transportation page. Requires incoming and leaving. Added in v0.3
incoming: Arrival date to use for flight search. Required iff airport is provided.
leaving: Departure date to use for flight search. Required iff airport is provided.
image: (reference) A reference to information regarding images to show on the photos page. Zero or more.
registry: A link to a gift registry. The format is URL{space}textual description. Zero or more.
more: An arbitrary link . The format is URL{space}textual description. Zero or more.
Home is 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 greeting can explain how and why.
Provides a simple form for guests to respond to predefined questions from the host(s) via eMail.
Provides a simple form for guests to make inquiries to the host(s) via eMail.
A page to display various photos or images. See the images section.
Location provides maps and information to the event.
Lodging shows all lodging entries listed under the nearby section.
Restaurants shows all restaurants entries listed under the nearby section.
Nearby shows all thing entries listed under the nearby section.
A reasonable page to display transportation options, and provides a form to search for airfare. See the transportation section.
A general purpose page. It is expected that you will provide a Display Name for 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 t:. e.g. t:<p>Hello World!</p>
See the links section above.
Non-standard Sections
nearby.lodging,, nearby.thing
name: Location name.
blurb: Free-form description.
address: Address of the location, which should be understandable by simple geocoding online map systems.
url: A URL for more information about this location.
name: Heading text.
text: Free-form text for this section.
title: A caption for the image.
description: Longer description displayed with the image.
thumb: URL for a thumbnail version of the image.
full: Full-size version of the image.
url: URL to see the image in another context off site.
These are the same as for event

About Event | Configuration Information | Live Demo