hcalendar-authoring

From Microformats Wiki
Revision as of 19:04, 17 February 2011 by Tantek (talk | contribs) (→‎Location Location Location: mention venue and dtend fix)
Jump to navigation Jump to search

<entry-title>hCalendar authoring</entry-title>

This page contains useful tips and guidelines for how to author hCalendar events, either from scratch, or by adding markup to existing content.

Goal: The goal of this document is to provide some good intuitive guidelines that should make it as easy and as quick as possible for any web author to create hCalendar events or add hCalendar markup to existing content.

Audience: Web authors and designers. This document is written for easy consumption and understanding by any web designer who knows at least enough (X)HTML and CSS to use HTML class names on elements and write CSS selectors that apply styles to those class names. Please help with clarifying/simplifying this document accordingly.

Author(s): Tantek Çelik

Creating new hCalendar events

Start with the hCalendar creator, and for additional fields and properties (e.g. contact, attendees, etc.), see the hCalendar examples page as well as the rest of this page.

Adding hCalendar markup to existing content

Minimal Markup Changes

The important thing to keep in mind when adding microformats to existing content, is the fact that microformats are designed so that they can be added with minimal (almost always no) changes to the existing presentation of the page. Thus keep this in mind: change as little markup as possible. If you want to fix various pages to be valid XHTML as well, that's a fine goal and highly encouraged.

Find Events

Start with looking for all mentions of events on a page, such as an "Upcoming Events" or "Recent Events" listing. Those are all potential hCalendar events - even more so if they are linked to their respective URLs (e.g. to single event pages with more details).

If an event is mentioned several times on a page, consider marking up an hCalendar event the mention which is the most persistent, detailed, definitive, or otherwise thorough. Ideally you might want to mark up all instances of a events with hCalendar, but for now, just keep it simple and mark up the most representative instance. (Perhaps the most "definitive" instance, which could also then be marked up with a <dfn> element around the summary/title of the event for additional semantic XHTML goodness.)

Determine The Surrounding Element for Each

For each event that you want to add hCalendar, find the smallest element that contains all the info about that event, without overlapping with any other event on the page.

Add the class name "vevent" to that element.

If there is no such element (perhaps the nearest enclosing element contains more than one event), then add a <span class="vevent">...</span> or <div class="vevent">...</div> that wraps the info about about that event and just that event.

The rest of the markup for this hCalendar event MUST go inside that element with the class name "vevent".

In all cases, where it says to add an element with class name of "xyz", if you can find an existing element that precisely surrounds the necessary content, then re-use that element and simply add the class name "xyz" to it (by adding it to the class attribute on the existing element, or by adding a new class attribute class="xyz" to elements without a class attribute).

For instance, assuming you have the following markup: 

    <div class="someFoo">
       <p> This is my wonderful markup, it contains some event information inside of it</p>
       <h6>Some Wonderful Event</h6>
       <p> From the people who brought you Great Times and Fun Lovin, 
           comes the Some Wonderful Event at the Local Sports Stadium.  
           Come at <b>A Specified Time</b>, and enjoy yourself! </p>
    </div>

If you need to add an element with the class of "vevent" around your event content, you could re-use the existing div element, and add the class "vevent" to it like so: 

    <div class="someFoo vevent">

Similarly, if you decide not to re-purpose an existing container, you can just wrap the content around a new block: 

    <div class="someFoo">
      <div class="vevent">
         <p> This is my wond...
         ...
         ... and enjoy yourself! </p>
      </div>
    </div>

The Importance of Time and Topic

Several properties are required in hCalendar. At a minimum, an event needs a "summary" (AKA title) and "dtstart" (starting date time), as well as either a "dtend" (ending date time) or "duration". Thus be sure to mark up the name/summary/title of the event with the class name "summary". E.g. 

<div class="vevent">
 <span class="summary">An Event Apart, New York City, NY</span>,
 <abbr class="dtstart" title="2006-07-10">July 10</abbr>-<abbr class="dtend" title="2006-07-12">11th, 2006</abbr>
</div>

This event might be presented like:

An Event Apart, New York City, NY, July 10-11th, 2006

Note: the use of the abbr element's title attribute to mark up a machine readable absolute datetime in addition to the human readable text. Note also that the machine readable ending date is the day after the date specified in the human readable content. The reason for this is that hCalendar (due to iCalendar RFC2445) interprets an ending date without a time as an instant in time, that is midnight, the absolute beginning of that day, thus ending the event the day before. See hCalendar and hcalendar-example1-steps for more details on the use of the abbr element in this fashion.

Separate dates and times

Often pages show the date of an event and its times separately, perhaps for stylistic or layout reasons, e.g. the SPHCM Events Calendar puts the date in a stylistic heading (should probably be an h3), and the times following it: 

<div class='eventdate'>October 2</div>
<div class='eventtime'>3:30 pm - 4:50 pm</div>

In such cases, rather than having to redo the markup (which may be serving other purposes) to combine the start date and time into a single element, just mark up the times by themselves as the dtstart and dtend, e.g.: (whitespace added for readability) 

<div class='eventdate'>October 2</div>
<div class='eventtime'>
 <abbr class='dtstart' title='2007-10-02T15:30-0700'>3:30 pm</abbr> - 
 <abbr class='dtend' title='2007-10-02T16:50-0700'>4:50 pm</abbr>
</div>

Eliminating Default Dotted Underline

Some browsers (Camino, Firefox, Mozilla) put a dotted underline or border on each abbr. You can use the following rule in your style sheet to eliminate this default presentation. 

.vevent abbr{border:0}

In the above An Event Apart example, this would have the following effect (which may not look any different for some readers):

An Event Apart, New York City, NY, July 10-11th, 2006

Representative URLs

One of the most common patterns for events in web content is to link them to their definitive/preferred web site.

"Event Rolls" are a good example of this (see also XOXO for proper semantic list and outline markup).

Since the class attribute takes a space separated set of class names, one can often mark up the URL on the same element as the name, e.g. by replacing the first <span> in the above example with an <a href> hyperlink: 

<div class="vevent">
 <a href="http://aneventapart.com/events/2006/nyc/" class="summary url">An Event Apart, New York City, NY</a>,
 <abbr class="dtstart" title="2006-07-10">July 10</abbr>-<abbr class="dtend" title="2006-07-12">11th, 2006</abbr>
</div>

This event might be presented like:

An Event Apart, New York City, NY, July 10-11th, 2006

Location Location Location

As with real estate, the location of an event is quite relevant, and important to mark up properly. At a minimum, identify the location related information in the event and mark it up with the class name of "location", e.g. continuing with the above example: 

<div class="vevent">
 <a href="http://aneventapart.com/events/2006/nyc/" class="summary url">An Event Apart, 
  <span class="location">New York City, NY</span></a>, 
 <abbr class="dtstart" title="2006-07-10">July 10</abbr>-<abbr class="dtend" title="2006-07-11">11th, 2006</abbr>
</div>

This is good, but can be made even better with the addition of the adr microformat to explicitly identify the city and state: 

<div class="vevent">
 <a href="http://aneventapart.com/events/2006/nyc/" class="summary url">An Event Apart, 
  <span class="location adr"><span class="locality">New York City</span>, <span class="region">NY</span></span></a>, 
 <abbr class="dtstart" title="2006-07-10">July 10</abbr>-<abbr class="dtend" title="2006-07-11">11th, 2006</abbr>
</div>

Even better, if the location is a specific venue with a name, such as a business or organization, make the location into a complete hCard rather than just an adr: 

<div class="vevent">
 <a href="http://aneventapart.com/events/2006/nyc/" class="summary url">An Event Apart, 
  <span class="location vcard">
   <span class="fn org">Scandinavia House</span>,
   <span class="adr"><span class="locality">New York City</span>, <span class="region">NY</span></span>
  </span></a>,
 <abbr class="dtstart" title="2006-07-10">July 10</abbr>-<abbr class="dtend" title="2006-07-11">11th, 2006</abbr>
</div>

More tips and guidelines

Feel free to add more tips that experience has taught you while marking up events with hCalendar, even if all you add is a brief catch phrase that reminds you.

  • How to mark up the contact and organizer
  • How to mark up attendees (including speakers)
  • ...

Add subscribe to events link

When you update your events to include hCalendar markup, you can also include "Add Events to Calendar" and/or "Subscribe to Events" links for the convenience of your users.

Here are examples of such links: 

<a href="http://feeds.technorati.com/events/http://tantek.com/">
Add Events to Calendar
</a>

<a href="webcal://feeds.technorati.com/events/http://tantek.com/">
Subscribe to Events
</a>

Simply substitute the link to your hCalendar events for the http://tantek.com/ URL above.

If you want, you can also use Brian Suda's hosted X2V service, or even download and install the X2V XSLT yourself and run it on your own server instead of using an online hCalendar to iCalendar (.ics) converter service.

Related Pages

This specification is a work in progress. As additional aspects are discussed, understood, and written, they will be added. These thoughts, issues, and questions are kept in separate pages.

Retrieved from "http://microformats.org/wiki/index.php?title=hcalendar-authoring&oldid=43603"