hcalendar-profile: Difference between revisions
Jump to navigation
Jump to search
m (Replace <entry-title> with {{DISPLAYTITLE:}}) |
|||
Line 1: | Line 1: | ||
{{DISPLAYTITLE:hCalendar Profile}} | |||
The following is an [http://gmpg.org/xmdp/ XMDP] profile for the [[hcalendar|hCalendar]] specification. | The following is an [http://gmpg.org/xmdp/ XMDP] profile for the [[hcalendar|hCalendar]] specification. |
Latest revision as of 16:24, 18 July 2020
The following is an XMDP profile for the hCalendar specification.
URLs
This profile is hosted as a separate XMDP file on microformats.org:
Usage
Profiles are referenced in (X)HTML files in the <head>
tag, e.g.:
<head profile='http://microformats.org/profile/hcalendar'>
Profile
<dl class="profile">
<dt>class</dt>
<dd><p>
<a rel="help" href="http://www.w3.org/TR/html401/struct/global.html#adef-class">
HTML4 definition of the 'class' attribute.</a>
This meta data profile defines some 'class' attribute values (class names)
and their meanings as suggested by a
<a href="http://www.w3.org/TR/WD-htmllink-970328#profile">
draft of "Hypertext Links in HTML"</a>.
All values are defined according to the semantics defined in the
<a href="http://microformats.org/wiki/hcalendar">
hCalendar specification</a>
and thus in
<a href="http://www.ietf.org/rfc/rfc2445.txt">RFC 2445</a>.
</p>
<dl>
<dt id="vcalendar">vcalendar</dt>
<dd>A container for one or more events (vevent).
This property is optional; if there is only one event then omit it.
See section 1. of RFC 2445.
</dd>
<dt id="vevent">vevent</dt>
<dd>A container for one event.
See section 4.6.1 of RFC 2445.
</dd>
<dt id="dtstart">dtstart</dt>
<dd>Date/time of the start of the event.
See section 4.8.2.4 of RFC 2445.
</dd>
<dt id="dtend">dtend</dt>
<dd>Date/time of the end of the event.
See section 4.8.2.2 of RFC 2445.
</dd>
<dt id="duration">duration</dt>
<dd>Length of the event.
See section 4.8.2.5 of RFC 2445.
</dd>
<dt id="summary">summary</dt>
<dd>Short synopsis, title, or name of the event.
See section 4.8.1.12 of RFC 2445.
</dd>
<dt id="uid">uid</dt>
<dd>A globally unique identifier for the event; typically a URL is used.
See section 4.8.4.7 of RFC 2445.
</dd>
<dt id="dtstamp">dtstamp</dt>
<dd>Date/time of when the document containing information about the event
was created.
See section 4.8.7.2 of RFC 2445.
</dd>
<dt id="method">method</dt>
<dd>Function of the event object.
Values for this property are: PUBLISH, REQUEST, REPLY, ADD, CANCEL, REFRESH,
COUNTER, or DECLINECOUNTER. For example, a value of REQUEST indicates that a
request is being made for the event to occur.
See section 4.7.2 of RFC 2445.
</dd>
<dt id="category">category</dt>
<dd>Category of the event object.
Note: this property may be repeated (an event may belong in several categories).
Common values are: MEETING, APPOINTMENT, CONFERENCE, EXPO.
See section 4.8.1.2 of RFC 2445.
</dd>
<dt id="location">location</dt>
<dd>Tells where the event is to be held. May be represented by nested
<a href="http://microformats.org/wiki/hcard">hCard record</a>,
<a href="http://microformats.org/wiki/adr">adr record</a>,
<a href="http://microformats.org/wiki/geo">geo record</a>, or combination thereof.
See sections 4.8.1.7 and 4.8.1.6 of RFC 2445.
</dd>
<dt id="url">url</dt>
<dd>A URL to a page that contains the definitive/preferred information about an event;
UID and URL are typically the same.
See section 4.8.4.6 of RFC 2445, except "url" may occur more than once in an hCalendar event.
</dd>
<dt id="description">description</dt>
<dd>A more detailed synopsis of the event than that provided by summary.
See section 4.8.1.5 of RFC 2445.
</dd>
<dt id="last-modified">last-modified</dt>
<dd>Date/time the information about the event was updated.
See section 4.8.7.3 of RFC 2445.
</dd>
<dt id="status">status</dt>
<dd>Status of the calendar event. Values are: TENTATIVE, CONFIRMED, CANCELLED.
See section 4.8.1.11 of RFC 2445.
</dd>
<dt id="class">class</dt>
<dd>Access classification of the event information;
Values are: PUBLIC, PRIVATE, CONFIDENTIAL.
See section 4.8.1.3 of RFC 2445.
</dd>
<dt id="attendee">attendee</dt>
<dd>An individual invited to attend the event;
An event container may contain more than one attendee record;
May be represented by nested <a href="http://microformats.org/wiki/hcard">hCard record</a>.
See section 4.8.4.1 of RFC 2445.
</dd>
<dt id="partstat">partstat</dt>
<dd>The participation-status of an individual invited to attend the event;
Subproperty of "attendee";
See section 4.2.12 of RFC 2445.
</dd>
<dt id="role">role</dt>
<dd>The role of an individual invited to attend the event;
Subproperty of "attendee";
See section 4.2.16 of RFC 2445.
</dd>
<dt id="contact">contact</dt>
<dd>Contact information associated with the event;
May be represented by nested <a href="http://microformats.org/wiki/hcard">hCard record</a>.
See section 4.8.4.2 of RFC 2445.
</dd>
<dt id="organizer">organizer</dt>
<dd>The organizer associated with the event.
May be represented by nested <a href="http://microformats.org/wiki/hcard">hCard record</a>.
See section 4.8.4.3 of RFC 2445.
</dd>
<dt id="attach">attach</dt>
<dd>A attached resource associated with the event, such as a photo.
See section 4.8.1.1 of RFC 2445.
</dd>
<dt id="value">value</dt>
<dd>This class name is used to distinguish the <em>actual</em> value
of a property from any other cruft that may be in
the containing element representing the property.
See the
<a href="http://microformats.org/wiki/value-class-pattern">
value-class-pattern</a> for details.</dd>
<dt id="value-title">value-title</dt>
<dd>This class name is used to distinguish the <em>actual</em> value
of a property, specifically in the 'title' attribute of the element,
from the element contents and the element representing
the containing property.
See the
<a href="http://microformats.org/wiki/value-class-pattern#Parsing_value_from_a_title_attribute">
value-class-pattern value-title description</a> for details.</dd>
</dl>
</dd>
</dl>
Related Pages
- hCalendar - specification
- hCalendar intro - plain English introduction
- hCalendar authoring - learn how to add hCalendar markup to your existing events.
- hCalendar creator (hCalendar creator feedback) - create your own hCalendar events.
- hCalendar cheatsheet - hCalendar properties
- hCalendar examples in the wild - an on-going list of websites which use hCalendars.
- hCalendar implementations - websites or tools which either generate or parse hCalendars
- hCalendar FAQ - If you have any questions about hCalendar, check here.
- hCalendar parsing - normative details of how to parse hCalendar.
- hCalendar profile - the XMDP profile for hCalendar
- hCalendar singular properties - an explanation of the list of singular properties in hCalendar.
- hCalendar tests - a wiki page with actual embedded hCalendar events to try parsing.
- hCalendar "to do" - jobs to do
- hCalendar advocacy - encourage others to use hCalendar.
- iCalendar implementations
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.
- hCalendar Brainstorming - brainstorms and other explorations relating to hCalendar
- hCalendar issues - issues with the specification