hCalendar

Share this article

Description

The hCalendar Microformat is closest in terms of usage and, arguably, usefulness to hCard. Just as you may like to keep your contacts’ details up to date and synchronized between your various devices (phone, PDA, and your desktop or laptop computer) and online services (web-based email, contact and calendar services, and so on), you probably feel the same way about calendar events. As with hCard, there’s an existing standard for calendar events, namely the IETF iCalendar standard. This standard underpins calendar applications such as Google Calendar, Lotus Notes, and Apple’s iCal, to name but a few. If you were to save one of these events from your calendar application and view it in a text editor, you’d see the data marked up quite clearly. Let’s see this in action. I have a tentative date to go and see some camel racing, which appears in Apple’s iCal as shown in the image below.
camel-racing
I can drag that calendar entry to my desktop (in your application, it may be a case of right-clicking and selecting Save As), which creates a file with an extension of .ics. Opening that file in a text editor reveals the following, somewhat verbose, underlying data:

BEGIN:VCALENDAR
VERSION:2.0
X-WR-CALNAME:Camel racing?
PRODID:-//Apple Computer\, Inc//iCal 2.0//EN
X-WR-RELCALID:046F4A00-D853-4F02-BE7B-7DF6B3CD49A7
X-WR-TIMEZONE:Asia/Dubai
CALSCALE:GREGORIAN
METHOD:PUBLISH
BEGIN:VTIMEZONE
TZID:Asia/Dubai
LAST-MODIFIED:20080120T212715Z
BEGIN:STANDARD
DTSTART:19321213T204552
TZOFFSETTO:+0400
TZOFFSETFROM:+0000
TZNAME:GST
END:STANDARD
END:VTIMEZONE
BEGIN:VEVENT
DTSTART;TZID=Asia/Dubai:20080124T070000
DTEND;TZID=Asia/Dubai:20080124T090000
SUMMARY:Camel racing?
UID:64923D95-98E9-47D7-8AD7-94D62F26B499
SEQUENCE:7
DTSTAMP:20080119T171029Z
BEGIN:VALARM
ACTION:AUDIO
TRIGGER:-PT1H30M
X-WR-ALARMUID:2C3DEF4A-4E7E-4FE5-95CF-E86321C9C5AF
ATTACH;VALUE=URI:Basso
END:VALARM
END:VEVENT
END:VCALENDAR

Quite a lot of the information there has been generated automatically by iCal, but you can create a valid hCalendar entry using a handful of data items gleaned from the above, namely:

  • summary, for the title of the event
  • dtstart, for the start date and time
  • dtend, for the end date and time
  • location, for the physical location at
    which the event will take place

You may also want to add a description, which allows you to expand on the simple summary, although this may not always be necessary or desirable. To mark the camel racing event up using hCalender, you need to wrap it in a container of some kind (most likely a div, but you could use any HTML element) with the class of “vcalendar”. If that seems confusing, remember that Microformats reuse existing naming conventions, but apply them to HTML, so while we refer to hCalendar, it’s marked up using the name defined in iCal:

<div class="vcalendar">
 ⋮
</div>

Once the outer container is marked up in this way, Microformat parsers (for example, the Tails or Operator extension) will expect Microformat content relating to hCard to appear inside. The next thing to do is to identify a specific event using the “vevent” class name:

<div class="vcalendar">
 <p class="vevent">
 ⋮
 </p>
</div>

At this point, there are numerous pieces of data that you could include beyond those mentioned above, but for the sake of this example, we want to know what the event is, when it’s happening, and where:

<div class="vcalendar">
 <p class="vevent">
 Tentative event:
 <span class="summary">Camel Racing</span>
 (<span class="location">Dubai</span>),
 Thursday 24th Jan,
 <abbr class="dtstart" title="20080124T0700">7</abbr> -
 <abbr class="dtend" title="20080124T0900">9am</abbr>
 </p>
</div>

Note the format of the time stamp—it uses the abbr element, indicating that the content inside the opening <abbr> and closing </abbr> tags is an abbreviation of some kind. So, for humans, the easy-to-read time of 9am is displayed, but the Microformats parsers (also known as the machines) need a specific date/time stamp, which is provided in the title attribute of the abbr element, in the format YYYY-MM-DDTHH:MM, where the T is a separator between the data and time sections.

Note that there are some concerns that the fact that hCalendar uses the abbr and title in this way actually makes it harder for people using assistive devices such as screen readers, as they may prefer to announce the content of the title attribute over the human-friendly contents inside the abbr element. At the time of writing, the debate about whether a solution is required for this—and what form it may take—is ongoing (for a good overview of the problem, read the posting on Webstandards.org at http://snipurl.com/hcal-access), and be aware that there’s a possibility that the format for this may change in a future iteration of the hCalendar standard.

Example

Here’s a very basic event marked up
in hCalendar format:

<div class="vcalendar">
 <p class="vevent">
 Tentative event:
 <span class="summary">Camel Racing</span>
 (<span class="location">Dubai</span>),
 Thursday 24th Jan,
 <abbr class="dtstart" title="2008-01-24T07:00">7</abbr> -
 <abbr class="dtend" title="2008-01-24T09:00">9am</abbr>
 </p>
</div>

What’s the Benefit of Using hCalendar?

With the way that the Web’s going, and with the increasing use of online calendar services and social software that requires (or would greatly benefit from) data sharing, it’s desirable to have a standard for marking up event details that can be read easily by humans, but which allows that data to be shared and ported from web application to web application, to desktop applications, and to hand-held devices. If you’re in the business of publishing any event details within your web site, you’d do well to consider marking them up using hCalendar formatting.

Adam RobertsAdam Roberts
View Author

Adam is SitePoint's head of newsletters, who mainly writes Versioning, a daily newsletter covering everything new and interesting in the world of web development. He has a beard and will talk to you about beer and Star Wars, if you let him.

Share this article
Read Next
Quick Tip: Creating a Date Picker in React
Quick Tip: Creating a Date Picker in React
Dianne Pena
How to Create Interactive Animations Using React Spring
How to Create Interactive Animations Using React Spring
Yemi Ojedapo
10 Reasons to Love Google Docs
10 Reasons to Love Google Docs
Joshua KrausZain Zaidi
How to Use Magento 2 for International Ecommerce Success
How to Use Magento 2 for International Ecommerce Success
Mitul Patel
5 Exciting New JavaScript Features in 2024
5 Exciting New JavaScript Features in 2024
Olivia GibsonDarren Jones
Tools and Strategies for Efficient Web Project Management
Tools and Strategies for Efficient Web Project Management
Juliet Ofoegbu
Choosing the Best WordPress CRM Plugin for Your Business
Choosing the Best WordPress CRM Plugin for Your Business
Neve Wilkinson
ChatGPT Plugins for Marketing Success
ChatGPT Plugins for Marketing Success
Neil Jordan
Managing Static Files in Django: A Comprehensive Guide
Managing Static Files in Django: A Comprehensive Guide
Kabaki Antony
The Ultimate Guide to Choosing the Best React Website Builder
The Ultimate Guide to Choosing the Best React Website Builder
Dianne Pena
Exploring the Creative Power of CSS Filters and Blending
Exploring the Creative Power of CSS Filters and Blending
Joan Ayebola
How to Use WebSockets in Node.js to Create Real-time Apps
How to Use WebSockets in Node.js to Create Real-time Apps
Craig Buckler
Best Node.js Framework Choices for Modern App Development
Best Node.js Framework Choices for Modern App Development
Dianne Pena
SaaS Boilerplates: What They Are, And 10 of the Best
SaaS Boilerplates: What They Are, And 10 of the Best
Zain Zaidi
Understanding Cookies and Sessions in React
Understanding Cookies and Sessions in React
Blessing Ene Anyebe
Enhanced Internationalization (i18n) in Next.js 14
Enhanced Internationalization (i18n) in Next.js 14
Emmanuel Onyeyaforo
Essential React Native Performance Tips and Tricks
Essential React Native Performance Tips and Tricks
Shaik Mukthahar
How to Use Server-sent Events in Node.js
How to Use Server-sent Events in Node.js
Craig Buckler
Five Simple Ways to Boost a WooCommerce Site’s Performance
Five Simple Ways to Boost a WooCommerce Site’s Performance
Palash Ghosh
Elevate Your Online Store with Top WooCommerce Plugins
Elevate Your Online Store with Top WooCommerce Plugins
Dianne Pena
Unleash Your Website’s Potential: Top 5 SEO Tools of 2024
Unleash Your Website’s Potential: Top 5 SEO Tools of 2024
Dianne Pena
How to Build a Chat Interface using Gradio & Vultr Cloud GPU
How to Build a Chat Interface using Gradio & Vultr Cloud GPU
Vultr
Enhance Your React Apps with ShadCn Utilities and Components
Enhance Your React Apps with ShadCn Utilities and Components
David Jaja
10 Best Create React App Alternatives for Different Use Cases
10 Best Create React App Alternatives for Different Use Cases
Zain Zaidi
Control Lazy Load, Infinite Scroll and Animations in React
Control Lazy Load, Infinite Scroll and Animations in React
Blessing Ene Anyebe
Building a Research Assistant Tool with AI and JavaScript
Building a Research Assistant Tool with AI and JavaScript
Mahmud Adeleye
Understanding React useEffect
Understanding React useEffect
Dianne Pena
Web Design Trends to Watch in 2024
Web Design Trends to Watch in 2024
Juliet Ofoegbu
Building a 3D Card Flip Animation with CSS Houdini
Building a 3D Card Flip Animation with CSS Houdini
Fred Zugs
How to Use ChatGPT in an Unavailable Country
How to Use ChatGPT in an Unavailable Country
Dianne Pena
An Introduction to Node.js Multithreading
An Introduction to Node.js Multithreading
Craig Buckler
How to Boost WordPress Security and Protect Your SEO Ranking
How to Boost WordPress Security and Protect Your SEO Ranking
Jaya Iyer
Understanding How ChatGPT Maintains Context
Understanding How ChatGPT Maintains Context
Dianne Pena
Building Interactive Data Visualizations with D3.js and React
Building Interactive Data Visualizations with D3.js and React
Oluwabusayo Jacobs
JavaScript vs Python: Which One Should You Learn First?
JavaScript vs Python: Which One Should You Learn First?
Olivia GibsonDarren Jones
13 Best Books, Courses and Communities for Learning React
13 Best Books, Courses and Communities for Learning React
Zain Zaidi
5 jQuery.each() Function Examples
5 jQuery.each() Function Examples
Florian RapplJames Hibbard
Implementing User Authentication in React Apps with Appwrite
Implementing User Authentication in React Apps with Appwrite
Yemi Ojedapo
AI-Powered Search Engine With Milvus Vector Database on Vultr
AI-Powered Search Engine With Milvus Vector Database on Vultr
Vultr
Understanding Signals in Django
Understanding Signals in Django
Kabaki Antony
Why React Icons May Be the Only Icon Library You Need
Why React Icons May Be the Only Icon Library You Need
Zain Zaidi
View Transitions in Astro
View Transitions in Astro
Tamas Piros
Getting Started with Content Collections in Astro
Getting Started with Content Collections in Astro
Tamas Piros
What Does the Java Virtual Machine Do All Day?
What Does the Java Virtual Machine Do All Day?
Peter Kessler
Become a Freelance Web Developer on Fiverr: Ultimate Guide
Become a Freelance Web Developer on Fiverr: Ultimate Guide
Mayank Singh
Layouts in Astro
Layouts in Astro
Tamas Piros
.NET 8: Blazor Render Modes Explained
.NET 8: Blazor Render Modes Explained
Peter De Tender
Mastering Node CSV
Mastering Node CSV
Dianne Pena
A Beginner’s Guide to SvelteKit
A Beginner’s Guide to SvelteKit
Erik KückelheimSimon Holthausen
Brighten Up Your Astro Site with KwesForms and Rive
Brighten Up Your Astro Site with KwesForms and Rive
Paul Scanlon
Which Programming Language Should I Learn First in 2024?
Which Programming Language Should I Learn First in 2024?
Joel Falconer
Managing PHP Versions with Laravel Herd
Managing PHP Versions with Laravel Herd
Dianne Pena
Accelerating the Cloud: The Final Steps
Accelerating the Cloud: The Final Steps
Dave Neary
An Alphebetized List of MIME Types
An Alphebetized List of MIME Types
Dianne Pena
The Best PHP Frameworks for 2024
The Best PHP Frameworks for 2024
Claudio Ribeiro
11 Best WordPress Themes for Developers & Designers in 2024
11 Best WordPress Themes for Developers & Designers in 2024
SitePoint Sponsors
Top 9 Best WordPress AI Plugins of 2024
Top 9 Best WordPress AI Plugins of 2024
Dianne Pena
20+ Tools for Node.js Development in 2024
20+ Tools for Node.js Development in 2024
Dianne Pena
The Best Figma Plugins to Enhance Your Design Workflow in 2024
The Best Figma Plugins to Enhance Your Design Workflow in 2024
Dianne Pena
Harnessing the Power of Zenserp for Advanced Search Engine Parsing
Harnessing the Power of Zenserp for Advanced Search Engine Parsing
Christopher Collins
Build Your Own AI Tools in Python Using the OpenAI API
Build Your Own AI Tools in Python Using the OpenAI API
Zain Zaidi
The Best React Chart Libraries for Data Visualization in 2024
The Best React Chart Libraries for Data Visualization in 2024
Dianne Pena
7 Free AI Logo Generators to Get Started
7 Free AI Logo Generators to Get Started
Zain Zaidi
Turn Your Vue App into an Offline-ready Progressive Web App
Turn Your Vue App into an Offline-ready Progressive Web App
Imran Alam
Clean Architecture: Theming with Tailwind and CSS Variables
Clean Architecture: Theming with Tailwind and CSS Variables
Emmanuel Onyeyaforo
How to Analyze Large Text Datasets with LangChain and Python
How to Analyze Large Text Datasets with LangChain and Python
Matt Nikonorov
6 Techniques for Conditional Rendering in React, with Examples
6 Techniques for Conditional Rendering in React, with Examples
Yemi Ojedapo
Introducing STRICH: Barcode Scanning for Web Apps
Introducing STRICH: Barcode Scanning for Web Apps
Alex Suzuki
Using Nodemon and Watch in Node.js for Live Restarts
Using Nodemon and Watch in Node.js for Live Restarts
Craig Buckler
Task Automation and Debugging with AI-Powered Tools
Task Automation and Debugging with AI-Powered Tools
Timi Omoyeni
Quick Tip: Understanding React Tooltip
Quick Tip: Understanding React Tooltip
Dianne Pena
12 Outstanding AI Tools that Enhance Efficiency & Productivity
12 Outstanding AI Tools that Enhance Efficiency & Productivity
Ilija Sekulov
React Performance Optimization
React Performance Optimization
Blessing Ene Anyebe
Introducing Chatbots and Large Language Models (LLMs)
Introducing Chatbots and Large Language Models (LLMs)
Timi Omoyeni
Migrate to Ampere on OCI with Heterogeneous Kubernetes Clusters
Migrate to Ampere on OCI with Heterogeneous Kubernetes Clusters
Ampere Computing
Scale Your React App with Storybook and Chromatic
Scale Your React App with Storybook and Chromatic
Daine Mawer
10 Tips for Implementing Webflow On-page SEO
10 Tips for Implementing Webflow On-page SEO
Milan Vracar
Create Dynamic Web Experiences with Interactive SVG Animations
Create Dynamic Web Experiences with Interactive SVG Animations
Patricia Egyed
5 React Architecture Best Practices for 2024
5 React Architecture Best Practices for 2024
Sebastian Deutsch
How to Create Animated GIFs from GSAP Animations
How to Create Animated GIFs from GSAP Animations
Paul Scanlon
Aligning Teams for Effective User Onboarding Success
Aligning Teams for Effective User Onboarding Success
Himanshu Sharma
How to use the File System in Node.js
How to use the File System in Node.js
Craig Buckler
Laravel vs CodeIgniter: A Comprehensive Comparison
Laravel vs CodeIgniter: A Comprehensive Comparison
Dianne Pena
Essential Tips and Tricks for Coding HTML Emails
Essential Tips and Tricks for Coding HTML Emails
Rémi Parmentier
How to Create a Sortable and Filterable Table in React
How to Create a Sortable and Filterable Table in React
Ferenc Almasi
WooCommerce vs Wix: Which Is Best for Your Next Online Store
WooCommerce vs Wix: Which Is Best for Your Next Online Store
Priyanka Prajapati
GCC Guide for Ampere Processors
GCC Guide for Ampere Processors
John O’Neill
Navigating Data Management: Warehouses, Lakes and Lakehouses
Navigating Data Management: Warehouses, Lakes and Lakehouses
Leonid Chashnikov
Integrating MongoDB with Node.js
Integrating MongoDB with Node.js
Dianne Pena
How to Use Node.js with Docker
How to Use Node.js with Docker
Craig Buckler
4 Reasons Why You Should Join A Freelancing Community
4 Reasons Why You Should Join A Freelancing Community
Kyle Prinsloo
ChatGPT vs AutoGPT: Comparing Top Language Models
ChatGPT vs AutoGPT: Comparing Top Language Models
Dianne Pena
How to Perform User Authentication with Flask-Login
How to Perform User Authentication with Flask-Login
Yemi Ojedapo
BERT vs LLM: A Comparison
BERT vs LLM: A Comparison
Dianne Pena
Monitoring Your Python App with AppSignal
Monitoring Your Python App with AppSignal
Connor James
BabyAGI vs AutoGPT: A Comprehensive Comparison
BabyAGI vs AutoGPT: A Comprehensive Comparison
Dianne Pena
Top Redux Alternatives: Exploring State Management Solutions
Top Redux Alternatives: Exploring State Management Solutions
Dianne Pena
Code Migration: Ampere Porting Advisor for x86 to AAarch64
Code Migration: Ampere Porting Advisor for x86 to AAarch64
Pete Baker
React Router v6: A Beginner’s Guide
React Router v6: A Beginner’s Guide
James Hibbard
Understanding React Error Boundary
Understanding React Error Boundary
Dianne Pena
Get the freshest news and resources for developers, designers and digital creators in your inbox each week