h-event

(Difference between revisions)

Jump to: navigation, search
(time element allows space instead of T separator between date and time. Undo revision 56856 by GlennJones (Talk))
Current revision (11:48, 9 May 2019) (view source)
(Examples in the wild: + 68middle.st/events)
 
(31 intermediate revisions not shown.)
Line 1: Line 1:
<entry-title>h-event</entry-title>
<entry-title>h-event</entry-title>
-
<span class="h-event vcard"><span class="p-name fn">[[User:Tantek|Tantek Çelik]]</span> (<span class="p-role role">Editor</span>)</span>
+
<dfn style="font-style:normal;font-weight:bold">h-event</dfn> is a simple, open format for events on the web. h-event is often used with both event listings and individual event pages. h-event is one of several open [[microformats|microformat]] draft standards suitable for embedding data in HTML.
-
----
+
-
<dfn style="font-style:normal;font-weight:bold">h-event</dfn> is a simple, open format for publishing events on the web. h-event is one of several open [[microformats|microformat]] draft standards suitable for embedding data in HTML/HTML5.
+
h-event is the [[microformats2]] update to [[hCalendar]].
h-event is the [[microformats2]] update to [[hCalendar]].
 +
 +
;<span id="Status">Status</span>
 +
:This is a '''Living Specification''' yet mature enough to encourage additional implementations and [[h-event-issues|feedback]].
 +
;Participate
 +
:[https://github.com/microformats/h-event/issues Open Issues]
 +
:[[IRC]]: [irc://irc.freenode.net/microformats #microformats on Freenode]
 +
<div class="p-author h-card vcard">
 +
;<span class="p-role role">Editor</span>
 +
:<span class="p-name fn">[[User:Tantek|Tantek Çelik]]</span>
 +
</div>
 +
;License
 +
: {{cc0-owfa-license}}
 +
__TOC__
== Example ==
== Example ==
Line 18: Line 29:
   <p class="p-summary">Get together and discuss all things microformats-related.</p>
   <p class="p-summary">Get together and discuss all things microformats-related.</p>
</div>
</div>
 +
</source>
 +
 +
Parsed JSON:
 +
<source lang=javascript>
 +
{
 +
  "items": [
 +
    {
 +
      "type": [
 +
        "h-event"
 +
      ],
 +
      "properties": {
 +
        "name": [
 +
          "Microformats Meetup"
 +
        ],
 +
        "start": [
 +
          "2013-06-30 12:00:00"
 +
        ],
 +
        "end": [
 +
          "2013-06-30 18:00:00"
 +
        ],
 +
        "location": [
 +
          "Some bar in SF"
 +
        ],
 +
        "summary": [
 +
          "Get together and discuss all things microformats-related."
 +
        ]
 +
      }
 +
    }
 +
  ]
 +
}
</source>
</source>
Line 35: Line 76:
* '''<code>dt-duration</code>''' - duration of the event
* '''<code>dt-duration</code>''' - duration of the event
* '''<code>p-description</code>''' - more detailed description of the event
* '''<code>p-description</code>''' - more detailed description of the event
 +
** '''WARNING:''' Proposed to be replaced by '''<code>e-content</code>''' (re-used from [[h-entry]])
 +
** See and follow-up: https://github.com/microformats/h-event/issues/3
* '''<code>u-url</code>''' - permalink for the event
* '''<code>u-url</code>''' - permalink for the event
* '''<code>p-category</code>''' - event category(ies)/tag(s)
* '''<code>p-category</code>''' - event category(ies)/tag(s)
-
* '''<code>p-location</code>''' - where the event takes place, optionally embedded [[h-adr]] or [[h-card]] {{main|h-adr}} {{main|h-card}}
+
* '''<code>p-location</code>''' - where the event takes place, optionally embedded [[h-card]], [[h-adr]], or [[h-geo]]
-
* '''<code>p-geo</code>''' - geophysical coordinates of the event, optionally embedded [[h-geo]] {{main|h-geo}}
+
-
* '''<code>p-latitude</code>''' - decimal latitude
+
-
* '''<code>p-longitude</code>''' - decimal longitude
+
-
Experimental properties currently in use in the wild but not (yet) part of the official h-entry spec:
+
Experimental properties currently in use in the wild but not (yet) part of the official h-event spec:
-
* '''<code>p-attendee</code>''' - a person attending the event, optionally embed [[h-card]] {{main|h-card}}
+
* '''<code>p-attendee</code>''' - a person attending the event, optionally embed [[h-card]]
 +
<div class="discussion">
 +
* This draft has not been updated in almost 2 years. During this period, <code>h-entry</code> <code>p-rsvp</code> has been standardised, thus making it robust and mature enough for the addition. I guess it's about time to unlabel <code>p-attendee</code> as experimental.
 +
** I've filed https://github.com/microformats/h-event/issues/2 to track advancing this draft as a whole. Let's do that with the existing draft before discussing p-attendee in particular. And rather than guessing, take a look at the vocabulary maturity levels in h-entry and perhaps help evaluate (in another issue) p-attendee according to those criteria. [[User:Tantek|Tantek]] 01:10, 28 February 2017 (UTC)
 +
* I would also suggest to extend expected value to [[h-entry]], so that, while the personal info can be preserved, the attendee can also support p-rsvp property of h-entry.
 +
** I don't understand this. p-attendee is supposed to represent a person, e.g. an [[h-card]]. How would it having that be an [[h-entry]] make sense and work (from a publishing and consuming code perspective)? This proposed extension to p-attendee may be worth its own issue as well. [[User:Tantek|Tantek]] 01:10, 28 February 2017 (UTC)
 +
</div>
All properties are optional.
All properties are optional.
== Status ==
== Status ==
-
'''h-event''' is a microformats.org draft specification. Public discussion on h-event takes place on [[h-event-feedback]], the #microformats [[irc]] channel on irc.freenode.net, and [http://microformats.org/discuss/mail/microformats-new/ microformats-new mailing list].
+
'''h-event''' is a microformats.org draft specification. Public discussion on h-event takes place on [[h-event-feedback]] and the #microformats [[irc]] channel on irc.freenode.net.
h-event is ready to use and implemented in the wild, but for backwards compatibility you should also mark h-events up as classic [[hCalendar]] events.
h-event is ready to use and implemented in the wild, but for backwards compatibility you should also mark h-events up as classic [[hCalendar]] events.
Line 55: Line 101:
(stub, to be expanded)
(stub, to be expanded)
 +
=== p-location ===
<code>p-location</code> is typically a physical address, optionally marked up with [[h-adr]], for example:
<code>p-location</code> is typically a physical address, optionally marked up with [[h-adr]], for example:
<source lang=html4strict>
<source lang=html4strict>
-
<p class="p-adr h-adr">
+
<p class="p-location h-adr">
   <span class="p-street-address">17 Austerstræti</span>
   <span class="p-street-address">17 Austerstræti</span>
   <span class="p-locality">Reykjavík</span>
   <span class="p-locality">Reykjavík</span>
Line 65: Line 112:
</source>
</source>
-
hCalendar-specific implementations that perform custom display or translation (e.g. to iCalendar .ics) {{should}} prefer <code>p-name</code> over <code>p-summary</code>, and use <code>p-summary</code> value(s) as a fallback if there is no <code>p-name</code>.
+
=== Reserved Properties ===
-
 
+
Reserved properties:
Reserved properties:
* '''<code>p-organizer</code>''' - a person (co-)organizing the event, optionally embed [[h-card]] {{main|h-card}}
* '''<code>p-organizer</code>''' - a person (co-)organizing the event, optionally embed [[h-card]] {{main|h-card}}
 +
** proposed as way to [https://github.com/snarfed/bridgy/issues/275 implement copying an event organizer to Eventbrite]
== Examples in the wild ==
== Examples in the wild ==
Line 81: Line 128:
* [http://indiewebcamp.com IndieWebCamp] has [[microformats2]] h-event markup with embedded h-cards for the organizers and the location.
* [http://indiewebcamp.com IndieWebCamp] has [[microformats2]] h-event markup with embedded h-cards for the organizers and the location.
* [https://wiki.mozilla.org/Events Mozilla Events] page has [[microformats2]] h-event markup with attendees marked up with h-card.
* [https://wiki.mozilla.org/Events Mozilla Events] page has [[microformats2]] h-event markup with attendees marked up with h-card.
 +
* https://gregorlove.com/events has h-event markup, for example: https://gregorlove.com/2017/06/homebrew-website-club/
 +
** has additional property from [[h-entry]]: <code>dt-published</code>
 +
* https://oauth.net/events/ has a list of h-event marked up events relating to OAuth, both future and past
 +
* http://68middle.st/events has events marked up in h-event
See [[microformats2#Examples_in_the_wild|microformats2 examples in the wild]] for more
See [[microformats2#Examples_in_the_wild|microformats2 examples in the wild]] for more
-
 
+
== Validating ==
{{h-spec-section-validating}}
{{h-spec-section-validating}}
 +
== Implementations ==
 +
Software implementations that publish or consume h-event, including themes, plugins, or extensions:
 +
 +
When adding an implementation, please provide and link to its home page and open source repo if any.
 +
 +
* [https://github.com/gRegorLove/mf2-to-iCalendar mf2 to iCalendar]: Convert microformats h-event to iCalendar. Example: https://gregorlove.com/calendar/
== Backward Compatibility ==
== Backward Compatibility ==
Line 100: Line 157:
=== Parser Compatibility ===
=== Parser Compatibility ===
-
Microformats parsers {{should}} detect the following root class name and property names. A microformats2 parser may use existing microformats [[parsers]] to extract these properties. If an "h-event" is found, don't look for a "vevent" on the same element.
+
Microformats parsers {{should}} detect classic properties only if a classic root class name is found and parse them as microformats2 properties.  
 +
 
 +
If an "h-event" is found, don't look for a "vevent" on the same element.
Compat root class name: <code id="vevent">vevent</code><br/>
Compat root class name: <code id="vevent">vevent</code><br/>
Line 112: Line 171:
* <code>category</code>
* <code>category</code>
* <code>location</code> - including compat root <code>vcard</code> in the absence of <code>h-card</code>, and compat root <code>adr</code> in the absence of <code>h-adr</code>
* <code>location</code> - including compat root <code>vcard</code> in the absence of <code>h-card</code>, and compat root <code>adr</code> in the absence of <code>h-adr</code>
-
* <code>geo</code> - parse as '''<code>p-geo h-geo</code>''' including compat root <code>geo</code>
+
* <code>geo</code> - parse as '''<code>p-location h-geo</code>''' including compat root <code>geo</code>
-
* <code>latitude</code>
+
 
-
* <code>longitude</code>
+
=== iCalendar Compatibility ===
 +
hCalendar-specific implementations that perform custom display or translation to iCalendar .ics {{should}} prefer <code>p-name</code> over <code>p-summary</code>, and use <code>p-summary</code> value(s) as a fallback if there is no <code>p-name</code>.
== Background ==
== Background ==
Line 123: Line 183:
== See Also ==
== See Also ==
 +
* [[h-calendar-to-do]]
 +
* [[h-event-brainstorming]]
* [[microformats2]]
* [[microformats2]]
* [[microformats2-parsing]]
* [[microformats2-parsing]]
Line 129: Line 191:
* [[h-card]]
* [[h-card]]
* [[hCalendar]]
* [[hCalendar]]
 +
* [[h-entry]]s can be RSVPs to events, using the p-rsvp property
[[Category:Draft Specifications]]
[[Category:Draft Specifications]]

Current revision

h-event is a simple, open format for events on the web. h-event is often used with both event listings and individual event pages. h-event is one of several open microformat draft standards suitable for embedding data in HTML.

h-event is the microformats2 update to hCalendar.

Status
This is a Living Specification yet mature enough to encourage additional implementations and feedback.
Participate
Open Issues
IRC: #microformats on Freenode
Editor
Tantek Çelik
License
Per CC0, to the extent possible under law, the editors have waived all copyright and related or neighboring rights to this work. In addition, as of 2019-07-18, the editors have made this specification available under the Open Web Foundation Agreement Version 1.0.

Contents


Example

Here is a simple event example:

<div class="h-event">
  <h1 class="p-name">Microformats Meetup</h1>
  <p>From 
    <time class="dt-start" datetime="2013-06-30 12:00">30<sup>th</sup> June 2013, 12:00</time>
    to <time class="dt-end" datetime="2013-06-30 18:00">18:00</time>
    at <span class="p-location">Some bar in SF</span></p>
  <p class="p-summary">Get together and discuss all things microformats-related.</p>
</div>

Parsed JSON:

{
  "items": [
    {
      "type": [
        "h-event"
      ],
      "properties": {
        "name": [
          "Microformats Meetup"
        ],
        "start": [
          "2013-06-30 12:00:00"
        ],
        "end": [
          "2013-06-30 18:00:00"
        ],
        "location": [
          "Some bar in SF"
        ],
        "summary": [
          "Get together and discuss all things microformats-related."
        ]
      }
    }
  ]
}

Get started

The class h-event is a root class name that indicates the presence of an h-event.

p-name, dt-start, dt-end, p-location, p-summary, and the other h-event property class names listed below define properties of the h-event.

See microformats2-parsing to learn more about property class names.

Properties

h-event properties, inside an element with class h-event:

Experimental properties currently in use in the wild but not (yet) part of the official h-event spec:

  • This draft has not been updated in almost 2 years. During this period, h-entry p-rsvp has been standardised, thus making it robust and mature enough for the addition. I guess it's about time to unlabel p-attendee as experimental.
    • I've filed https://github.com/microformats/h-event/issues/2 to track advancing this draft as a whole. Let's do that with the existing draft before discussing p-attendee in particular. And rather than guessing, take a look at the vocabulary maturity levels in h-entry and perhaps help evaluate (in another issue) p-attendee according to those criteria. Tantek 01:10, 28 February 2017 (UTC)
  • I would also suggest to extend expected value to h-entry, so that, while the personal info can be preserved, the attendee can also support p-rsvp property of h-entry.
    • I don't understand this. p-attendee is supposed to represent a person, e.g. an h-card. How would it having that be an h-entry make sense and work (from a publishing and consuming code perspective)? This proposed extension to p-attendee may be worth its own issue as well. Tantek 01:10, 28 February 2017 (UTC)

All properties are optional.

Status

h-event is a microformats.org draft specification. Public discussion on h-event takes place on h-event-feedback and the #microformats irc channel on irc.freenode.net.

h-event is ready to use and implemented in the wild, but for backwards compatibility you should also mark h-events up as classic hCalendar events.

Property Details

(stub, to be expanded)

p-location

p-location is typically a physical address, optionally marked up with h-adr, for example:

<p class="p-location h-adr">
  <span class="p-street-address">17 Austerstræti</span>
  <span class="p-locality">Reykjavík</span>
  <span class="p-country-name">Iceland</span>
</p>

Reserved Properties

Reserved properties:

Examples in the wild

Real world in the wild examples:

See microformats2 examples in the wild for more

Validating

Main article: validators

Test and validate microformats2 markup in general with:

Implementations

Software implementations that publish or consume h-event, including themes, plugins, or extensions:

When adding an implementation, please provide and link to its home page and open source repo if any.

Backward Compatibility

Publisher Compatibility

For backward compatibility, you may wish to use classic hCalendar classnames in addition to the more future-proof h-event properties, for example:

<div class="h-event vevent">
  <h1 class="p-name summary">Some great event</h1>
</div>
</div>

Parser Compatibility

Microformats parsers SHOULD detect classic properties only if a classic root class name is found and parse them as microformats2 properties.

If an "h-event" is found, don't look for a "vevent" on the same element.

Compat root class name: vevent
Properties: (parsed as p- plain text unless otherwise specified)

iCalendar Compatibility

hCalendar-specific implementations that perform custom display or translation to iCalendar .ics SHOULD prefer p-name over p-summary, and use p-summary value(s) as a fallback if there is no p-name.

Background

This work is based on the existing hCalendar and iCalendar specifications.

Design Principles

(stub, expand)

See Also

Categories

h-event was last modified: Thursday, May 9th, 2019

Views