Difference between revisions of "hcalendar-ja"

From Microformats Wiki
Jump to navigation Jump to search
(sync: english: 11:29, 25 Jul 2006)
Line 28: Line 28:
  
 
== Introduction ==
 
== Introduction ==
The iCalendar standard ([http://www.ietf.org/rfc/rfc2445.txt RFC2445]), has been broadly interoperably implemented (e.g. Apple's "iCal" application built into MacOSX).
+
iCalendarは、(例えばMac OS Xに同梱されているアップル・コンピュータ社のアプリケーション「iCal」のように)広く相互運用性を持った実装がある標準([http://www.ietf.org/rfc/rfc2445.txt RFC2445])です。
  
 
In addition, bloggers often discuss events on their blogs -- upcoming events, writeups of past events, etc.  With just a tad bit of structure, bloggers can discuss events in their blog(s) in such a way that spiders and other aggregators can retrieve such events, automatically convert them to iCalendar, and use them in any iCalendar application or service.
 
In addition, bloggers often discuss events on their blogs -- upcoming events, writeups of past events, etc.  With just a tad bit of structure, bloggers can discuss events in their blog(s) in such a way that spiders and other aggregators can retrieve such events, automatically convert them to iCalendar, and use them in any iCalendar application or service.

Revision as of 10:03, 28 July 2006


hCalendar

hCalendarは、iCalendar(RFC2445)を基とした簡単でオープンな日程表とイベント情報を配信するフォーマットです。(X)HTMLやAtom、RSS、任意のXMLに埋め込めます。hCalendarは、microformatオープンスタンダードのうちの一つです。

hCalendarを使ってイベント情報を書いてみたいならば、はじめはhCalendar creatorを使って作成し、公開してみてください。

仕様

Editor 
Tantek Çelik (Technorati, Inc)
Authors 
Tantek Çelik, Technorati, Inc
Brian Suda

著作権

This specification is (C) 2004-2020 by the authors. However, the authors intend to submit (or already have submitted, see details in the spec) this specification to a standards body with a liberal copyright/licensing policy such as the GMPG, IETF, and/or W3C. Anyone wishing to contribute should read their copyright principles, policies and licenses (e.g. the GMPG Principles) and agree to them, including licensing of all contributions under all required licenses (e.g. CC-by 1.0 and later), before contributing.

特許

この仕様はロイヤリティーフリーの特許方針に帰属するものです。特許方針に関してはW3C Patent PolicyRFC3667RFC3668をご覧下さい。

謝辞

Thanks to:


Introduction

iCalendarは、(例えばMac OS Xに同梱されているアップル・コンピュータ社のアプリケーション「iCal」のように)広く相互運用性を持った実装がある標準(RFC2445)です。

In addition, bloggers often discuss events on their blogs -- upcoming events, writeups of past events, etc. With just a tad bit of structure, bloggers can discuss events in their blog(s) in such a way that spiders and other aggregators can retrieve such events, automatically convert them to iCalendar, and use them in any iCalendar application or service.

This specification introduces the hCalendar format, which is a 1:1 representation of the aforementioned iCalendar standard, in semantic XHTML. Bloggers can both embed hCalendar events directly in their web pages, and style them with CSS to make them appear as desired. In addition, hCalendar enables applications to retrieve information about such events directly from web pages without having to reference a separate file.

Semantic XHTML Design Principles

Note: the Semantic XHTML Design Principles were written primarily within the context of developing hCard and hCalendar, thus it may be easier to understand these principles in the context of the hCard design methodology (i.e. read that first). Tantek

XHTML is built on XML, and thus XHTML based formats can be used not only for convenient display presentation, but also for general purpose data exchange. In many ways, XHTML based formats exemplify the best of both HTML and XML worlds. However, when building XHTML based formats, it helps to have a guiding set of principles.

  1. Reuse the schema (names, objects, properties, values, types, hierarchies, constraints) as much as possible from pre-existing, established, well-supported standards by reference. Avoid restating constraints expressed in the source standard. Informative mentions are ok.
    1. For types with multiple components, use nested elements with class names equivalent to the names of the components.
    2. Plural components are made singular, and thus multiple nested elements are used to represent multiple text values that are comma-delimited.
  2. Use the most accurately precise semantic XHTML building block for each object etc.
  3. Otherwise use a generic structural element (e.g. <span> or <div>), or the appropriate contextual element (e.g. an <li> inside a <ul> or <ol>).
  4. Use class names based on names from the original schema, unless the semantic XHTML building block precisely represents that part of the original schema. If names in the source schema are case-insensitive, then use an all lowercase equivalent. Components names implicit in prose (rather than explicit in the defined schema) should also use lowercase equivalents for ease of use. Spaces in component names become dash '-' characters.
  5. Finally, if the format of the data according to the original schema is too long and/or not human-friendly, use <abbr> instead of a generic structural element, and place the literal data into the 'title' attribute (where abbr expansions go), and the more brief and human readable equivalent into the element itself. Further informative explanation of this use of <abbr>: Human vs. ISO8601 dates problem solved

Format

In General

The iCalendar standard (RFC2445) forms the basis of hCalendar.

Note: the editor and authors of this specification are tracking the "iCal-Basic" effort and intend to base the core hCalendar profile on iCal-Basic. See references for a link to the current draft.

The basic format of hCalendar is to use iCalendar object/property names in lower-case for class names, and to map the nesting of iCalendar objects directly into nested XHTML.

More Semantic Equivalents

However, for some properties there is a more semantic equivalent, and therefore they get special treatment, e.g.:

  • URL in iCalendar becomes <a class="url" href="...">...</a> inside the element with class="vevent" in hCalendar.
  • ATTENDEE, CONTACT, and ORGANIZER in iCalendar may be represented by an hCard in hCalendar .
  • A named LOCATION (potentially with an address and/or geo) in iCalendar may be represented by a nested hCard in hCalendar. Similarly, an address LOCATION may be represented by an adr, and a geo (latitude and longitude) LOCATION may be represented by a Geo.
  • UID in iCalendar simply becomes another semantic applied to a specific URL for an hCalendar event.

Singular vs. Plural Properties

For properties which are singular (e.g. "N" and "FN" from vCard), the first descendant element with that class should take effect, any others being ignored.

For properties which can be plural (e.g. "TEL" from vCard), each class instance should create a instance of that property. Plural properties with subtypes (e.g. TEL with WORK, HOME, CELL from vCard) can be optimized to share a common element for the property itself, with each instance of subtype being an appropriately classed descendant of the property element.

Plural Properties Singularized

Since plural property names become their singular equivalents, even if the original plural property permitted only a single value with multiple components, those multiple components are represented each with their own singularly named property and the the property is effectively multivalued and subject to the above treatment of multivalued properties.

Human vs. Machine readable

If an <abbr> element is used for a property, then the 'title' attribute of the <abbr> element is the value of the property, instead of the contents of the element, which instead provide a human presentable version of the value. This specification recommends that such <abbr> elements be used for the following iCalendar properties:

  • DTSTART, DTEND, DURATION, RDATE, RRULE

Example

Here is a sample event in an iCalendar:

BEGIN:VCALENDAR
PRODID:-//XYZproduct//EN
VERSION:2.0
BEGIN:VEVENT
URL:http://www.web2con.com/
DTSTART:20051005
DTEND:20051008
SUMMARY:Web 2.0 Conference
LOCATION:Argent Hotel\, San Francisco\, CA
END:VEVENT
END:VCALENDAR

and an equivalent event in hCalendar format with various elements optimized appropriately. See hCalendar Example 1 Steps for the derivation.

<span class="vevent">
 <a class="url" href="http://www.web2con.com/">
  <span class="summary">Web 2.0 Conference</span>: 
  <abbr class="dtstart" title="2005-10-05">October 5</abbr>-
  <abbr class="dtend" title="2005-10-08">7</abbr>,
 at the <span class="location">Argent Hotel, San Francisco, CA</span>
 </a>
</span>

which could be displayed as:

Web 2.0 Conference: October 5-7, at the Argent Hotel, San Francisco, CA

Note 1: The product information is not necessary since hCalendar is an interchange format. When transforming hCalendar back into iCalendar, the transforming engine should add its own product ID.

Note 2: A surrounding <span class="vcalendar"> element is optional, and is left out as such. It is optional since the context of a vcalendar is implied when a vevent is encountered. The implied context/scope is that of the document. Authors may explicitly use elements with class="vcalendar" to wrap sets of vevents that all belong to the same calendar, e.g. when publishing multiple calendars on the same page.

Note 3: The version information is unnecessary in hCalendar markup directly since the version will be defined by the profile of hCalendar that is used/referred to in the 'profile' attribute of the <head> element.

Note 4: ISO8601 dates (required by iCalendar) are not very human friendly. In addition, the year is often understood implicitly by humans from the context. Thus <abbr> elements are used to simultaneously provide a human friendly date and/or time in the visible contents of the element, while placing the respective machine parsable comprehensive ISO8601 datetime in the 'title' attribute. The notation YYYY-MM-DD should be used for better readability.

Note 5: The difference between the DTEND ISO8601 date (2005-10-08) and the human readable date (7) is NOT a mistake. DTEND is exclusive, meaning, that the event ends just before the DTEND. Thus for events which start on one day and end on another day, the DTEND date must be specified as the day after the day that a human would say is the last day of the event.

Note 6: The location in this example contains implicit structure (venue name, city, state) which could be marked up explicitly as an hCard. See hCalendar brainstorming: hCard locations for a informative explanation of how to do this.

See hCalendar examples for more hCalendar examples

Examples in the wild

This section is informative.

The following sites have implemented hCalendar, and thus are a great place to start for anyone looking for examples "in the wild" to try parsing, indexing, organizing etc. If events on your pages are marked up with hCalendar, feel free to add it to the top of this list. Once the list grows too big, we'll make a separate wiki page.

New Examples

Please add new examples to this section.

  • Geek in the Park uses hCalendar for the event information. -- by trovster
  • official site of Besançon (France) for its events
  • Conference schedule for d.Construct 2006 is published using hCalendar.
  • Yahoo Local now supports hCalendar
  • We used hcalendar for the F’parade flyer 2006, a counter demonstration to the Love Parade in Berlin, alas two issues arose: the Firefox tails extension doesn't get a summary when it's an alt-text in an image. Also the default charset when creating an iCal file through the Technorati feed is UTF-8, but our website is ISO-8859-15. Is there a way to define a different charset, or why doesn’t the API respect the charset given by the website in the first place (in our case it’s in the HTPP header, in the XML declaration, and the meta tag)?
  • Harper Adams University College uses hCalendar to mark up all University events on the Homepage and Events Calendar page.
  • Capital University uses hCalendar on multiple pages to provide feeds of events, relevant to page content
  • The Session events uses hCalendar to mark up concerts, festivals and workshops related to Irish traditional music.
  • ncl.rb uses hCalendar to mark up new meetings.
  • World Cup KickOff where you can download and keep all the fixtures you are interested in so you will never miss a single game of the 2006 football World Cup!

Mon May 22, 4:00 PM ET The World Cup, one of the world's most watched sporting events, is almost upon us. If you've ever tried to follow your favorite team through the Cup you know that it can sometimes be difficult to know when they're on. World Cup Kickoff can help.

World Cup KickOff is all you will ever need for knowing all the match details for the upcoming World Cup 2006. Whether you use your mobile phone, MS Outlook, Apple iCal or Mozilla Calendar, you can download and keep all the fixtures you are interested in so you will never miss a single game! ADVERTISEMENT

Next tip? We'll show you how to get up at 2 AM to watch your matches. ;0) Thanks to Tom for the tip!

Examples with some problems

  • s'Bokle is a German music pub. Their events calendar has been marked up with hCalendar.
    • improper use of rrule --RyanKing 16:04, 6 Jan 2006 (PST)
  • Plan9 - Uses hCalendar to mark up events !
    • dtstart/dtend are implemented on span element Tom Armitage June 23, 2006
  • socalTECH is a news and information site. Their front page event listing is marked up with hCalendar.
    • dtstart/dtend implemented on span element Tom Armitage June 23, 2006
  • The Multipack features a vevent for the next meeting information.
    • dtstart/dtend are implemented on em element Tom Armitage June 23, 2006
  • Paul Schreiber's unofficial schedule site publishes hCalendar information for upcoming hockey games at Ice Oasis
    • dtstart/dtend are implemented on td element Tom Armitage June 23, 2006

- whilst Tails parses dtstart/dtend on any element, technically it really needs to be on abbr. Technorati Microformats Search only looks for the title element on <abbr> tags, for instance.

Implementations

This section is informative.

The following implementations have been developed which either generate or parse hCalendars. If you have an hCalendar implementation, feel free to add it to the top of this list. Once the list grows too big, we'll make a separate wiki page.

Authoring

Implementations you can use to author, create, and publish hCalendar events.

Blogging and CMS tools

Midgard CMS 
Midgard CMS - net.nemein.calendar - as blogged by Henri Bergius
Drupal module 
Drupal Upcoming.org syndication module emits hCalendar
MovableType and WordPress plug-ins 
StructuredBlogging is a set of plugins for WordPress and for MovableType that supports embedding hCalendar and other microformats in templates and blog posts.
Textpattern plug-in 
pnh_mf is a plugin for Textpattern that supports embedding hCalendar and other microformats in templates and blog posts. Written by Chris Casciano.

Browser scripts and plug-ins

Browser plugins that work with existing authoring tools:

Any browser with javascript and a little bit of CSS 
microformats.org hCalendar creator (see also original: Ryan King has an hCalendar creator).
Firefox Greasemonkey user script hCalendar creator 
magic_hcalendar Greasemonkey user script by Les Orchard - allows easy form entry of an event into any textarea, e.g. into a blog post text area.
Firefox Greasemonkey user script hCalendar to Google Calendar
Elias Torres has created a simple script that will parse hCalendar entries and create a link to add event to Google Calendar's service. Based on George's and Arve's work.

Desktop Authoring Tools

Dreamweaver Extension 
Extension suite for Dreamweaver 8 from the Web Standards Project.
xfy 

In xfy Community, there are some hCalendar implementations.

  • hCalendar via RSS parses an RSS feed, retrieves XHTML documents linked from that feed, and syndicates hCalendars into a calendar view.
  • hCalendar Marker XVCD helps to mark up an event information in XHTML document with hCalendar.
  • Simple RDF Calendar XVCD is a schedule tool which uses RDF Calendar format. It also converts RDF Calendar format to iCalendar and hCalendar format.

Search and Discovery

Conversion and Import

Implementations you can use to importing into a Calendar Application, typically by converting hCalendar to iCalendar/vCalendar.

Web Services

These return iCalendar (.ics) and other calendar formats for easy importing into typical calendar programs or other processing.

  • Technorati Events Feed service uses X2V library to parse hCalendar and return iCalendar (.ics). Note friendly URL, e.g. http://feeds.technorati.com/events/http%3A//microformats.org
  • X2V parses hCalendar and produces a .ics (iCalendar) stream. Note: needs to be updated to track changes in the specification as they occur.
  • Life Lint Parser parses hCalendar and produces .ics, .rdf and debugging information and attempts to be more fully compliant to the iCal standard than previous implementations. It can be used in the same manner as X2V. Can output iCal (w optional Outlook 2002 compat), and RDF.
  • Spanning Salesforce produces hCalendar-enabled RSS feeds and .ics calendars from Salesforce.com.

Firefox Greasemonkey Plugins

Aggregators

  • Extract Microformats is a script for NetNewsWire that supports extracting hCard and hCalendar data in blog posts (via technorati service). Written by Chris Casciano
  • Endo, an OS X aggregator, supports discovering hCal and adding those events to iCal. Look at the last screenshot at the bottom of the page.

Browsing

Implementations that detect, display and otherwise highlight hCalendar events in pages.

  • In xfy Community, there are some hCalendar implementations. "hCalendar via RSS" parses an RSS feed, retrieves XHTML documents linked from that feed, and syndicates hCalendars into a calendar view.
  • JSCalendar parses hCalendar and produces a displayable HTML table/CSS-based calendar.

Firefox extension

Tails is a Firefox Extension that will display the presence of microformats (hCard, hCalendar, hReview, xFolk) on a webpage.

Flock extension

Flocktails - port of Tails extension for Flock 0.5.12 that looks for hCards, hCalendar, xFolk and hReview and tosses them into a handy topbar

Libraries

Open source libraries of hCalendar parsers and other related code for building hCalendar implementations.

Javascript 
simple hCalendar parser by Arve Bersvendsen
PHP 
Microformat Base is an open-source PHP microformat aggregation crawler, currently recognizing hreview, hcalendar, and hcard.
Ruby 
uformats is a ruby library that can parse hCalendar 1.0, hCard 1.0, hReview 0.4 (in progress) and rel="tag"
XSLT 
  • X2V is available as an XSLT library
  • palmagent by User:DanC includes toICal.xsl and test materials; it works much like xhtml2vcal.xsl in X2V. See also: RDF Calendar workspace with icalendar test materials.

Potential implementations

These are open source projects that could be potentially enhanced to support hCalendar.

References

Normative References

Informative References

Specifications That Use hCalendar

Similar Work

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.


Further Reading

"Right now people can do that by publishing .ics files, but it's not trivial to do so, and it's work on the part of other people to look at them. If it's not HTML hanging off our friend's home page that can be viewed in any browser on a public terminal in a library, the bar to entry is too high and it's useless."