Difference between revisions of "h-entry"

From Microformats Wiki
Jump to navigation Jump to search
(→‎Draft Properties: p-rsvp Case-insensitive values, normalized to lowercase)
(→‎Properties: bumping p-rsvp from draft to core as there are now 10+ publishers (2016.indieweb.org) and ~5+ consumers/receivers that support it, so the market has made it stable)
Line 91: Line 91:
  
 
=== Core Properties ===
 
=== Core Properties ===
The following ''core'' h-entry properties have broad consensus:
+
The following ''core'' h-entry properties have broad consensus and are broadly interoperably published and consumed:
 
* '''<code>p-name</code>''' - entry name/title
 
* '''<code>p-name</code>''' - entry name/title
 
* '''<code>p-summary</code>''' - short entry summary
 
* '''<code>p-summary</code>''' - short entry summary
Line 104: Line 104:
 
* '''<code>u-syndication</code>''' - URL(s) of syndicated copies of this post. The property equivalent of [[rel-syndication]] ([http://erinjo.is/2014/checked-into-rockit-colabs-23 example])
 
* '''<code>u-syndication</code>''' - URL(s) of syndicated copies of this post. The property equivalent of [[rel-syndication]] ([http://erinjo.is/2014/checked-into-rockit-colabs-23 example])
 
* '''<code>u-in-reply-to</code>''' - the URL which the h-entry is considered reply to (i.e. doesn’t make sense without context, could show up in comment thread), optionally an embedded [[h-cite]] ([http://indiewebcamp.com/reply-context reply-context]) ([http://waterpigs.co.uk/notes/4V2DjG/ example])
 
* '''<code>u-in-reply-to</code>''' - the URL which the h-entry is considered reply to (i.e. doesn’t make sense without context, could show up in comment thread), optionally an embedded [[h-cite]] ([http://indiewebcamp.com/reply-context reply-context]) ([http://waterpigs.co.uk/notes/4V2DjG/ example])
 +
* '''<code id="p-rsvp">p-rsvp</code>''' (enum, use &lt;data> element or [[value-class-pattern]])
 +
** "invited", "yes", "no", "maybe", "interested". Case-insensitive values, normalized to lowercase. Examples:
 +
** <code><nowiki>... <data class="p-rsvp" value="yes">is going</data> to ...</nowiki></code>, or
 +
** <code><nowiki>... <data class="p-rsvp" value="maybe">might go</data> to ...</nowiki></code>
 +
** <code><nowiki>... <data class="p-rsvp" value="no">unable to go</data> to ...</nowiki></code>
 +
** <code><nowiki>... <data class="p-rsvp" value="interested">am interested/tracking/watching</data>  ...</nowiki></code>
  
 
=== Draft Properties ===
 
=== Draft Properties ===
Line 113: Line 119:
 
* '''<code id="u-photo">u-photo</code>''' - one or more photos that is/are considered the primary content of the entry, unless there is a <code>p-location h-card</code>, which is still considered a "checkin" (i.e. with a photo). Otherwise the presence of a u-photo means the name of the entry should be interpreted as a caption on the photo, and the summary/content should be interpreted as a description of the photo.
 
* '''<code id="u-photo">u-photo</code>''' - one or more photos that is/are considered the primary content of the entry, unless there is a <code>p-location h-card</code>, which is still considered a "checkin" (i.e. with a photo). Otherwise the presence of a u-photo means the name of the entry should be interpreted as a caption on the photo, and the summary/content should be interpreted as a description of the photo.
 
* '''<code>u-video</code>''' - special u- parsing rules for <code>&lt;video src> & &lt;source src></code>
 
* '''<code>u-video</code>''' - special u- parsing rules for <code>&lt;video src> & &lt;source src></code>
* '''<code id="p-rsvp">p-rsvp</code>''' (enum, use &lt;data> element or [[value-class-pattern]])
+
 
** "invited", "yes", "no", "maybe", "interested". Case-insensitive values, normalized to lowercase. Examples:
 
** <code><nowiki>... <data class="p-rsvp" value="yes">is going</data> to ...</nowiki></code>, or
 
** <code><nowiki>... <data class="p-rsvp" value="maybe">might go</data> to ...</nowiki></code>
 
** <code><nowiki>... <data class="p-rsvp" value="no">unable to go</data> to ...</nowiki></code>
 
** <code><nowiki>... <data class="p-rsvp" value="interested">am interested/tracking/watching</data>  ...</nowiki></code>
 
  
 
=== Proposed Additions ===
 
=== Proposed Additions ===

Revision as of 19:04, 27 May 2016

<entry-title>h-entry</entry-title> h-entry is a simple, open format for episodic or datestamped content on the web. h-entry is often used with content intended to be syndicated, e.g. blog posts. h-entry is one of several open microformat draft standards suitable for embedding data in HTML/HTML5.

h-entry is the microformats2 update to hAtom 0.1's "hentry". For an update to "hfeed" see h-feed.

Status
This is a Living Specification yet mature enough to encourage additional implementations and feedback.
Participate
Wiki (Open issues)
#microformats on freenode: #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 2020-09-24, the editors have made this specification available under the Open Web Foundation Agreement Version 1.0.

Example

Here is a simple blog post example:

<article class="h-entry">
  <h1 class="p-name">Microformats are amazing</h1>
  <p>Published by <a class="p-author h-card" href="http://example.com">W. Developer</a>
     on <time class="dt-published" datetime="2013-06-13 12:00:00">13<sup>th</sup> June 2013</time>
  
  <p class="p-summary">In which I extoll the virtues of using microformats.</p>
  
  <div class="e-content">
    <p>Blah blah blah</p>
  </div>
</article>

Parsed JSON:

{
  "items": [
    {
      "type": [
        "h-entry"
      ],
      "properties": {
        "name": [
          "Microformats are amazing"
        ],
        "author": [
          {
            "value": "W. Developer",
            "type": [
              "h-card"
            ],
            "properties": {
              "name": [
                "W. Developer"
              ],
              "url": [
                "http://example.com"
              ]
            }
          }
        ],
        "published": [
          "2013-06-13 12:00:00"
        ],
        "summary": [
          "In which I extoll the virtues of using microformats."
        ],
        "content": [
          {
            "value": "Blah blah blah",
            "html": "<p>Blah blah blah</p>"
          }
        ]
      }
    }
  ]
}

Get started

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

p-name, p-author, dt-published and the other h-entry property classnames listed below define properties of the h-entry.

See microformats2 parsing specification to learn more about property classnames.

Properties

h-entry properties, inside an element with class h-entry. All properties are optional.

Core Properties

The following core h-entry properties have broad consensus and are broadly interoperably published and consumed:

  • p-name - entry name/title
  • p-summary - short entry summary
  • e-content - full content of the entry
  • dt-published - when the entry was published
  • dt-updated - when the entry was updated
  • p-author - who wrote the entry, optionally embedded h-card(s)
  • p-category - entry categories/tags
  • u-url - entry permalink URL
  • u-uid - universally unique identifier, typically canonical entry URL
  • p-location - location the entry was posted from, optionally embed h-card, h-adr, or h-geo
  • u-syndication - URL(s) of syndicated copies of this post. The property equivalent of rel-syndication (example)
  • u-in-reply-to - the URL which the h-entry is considered reply to (i.e. doesn’t make sense without context, could show up in comment thread), optionally an embedded h-cite (reply-context) (example)
  • p-rsvp (enum, use <data> element or Value Class Pattern)
    • "invited", "yes", "no", "maybe", "interested". Case-insensitive values, normalized to lowercase. Examples:
    • ... <data class="p-rsvp" value="yes">is going</data> to ..., or
    • ... <data class="p-rsvp" value="maybe">might go</data> to ...
    • ... <data class="p-rsvp" value="no">unable to go</data> to ...
    • ... <data class="p-rsvp" value="interested">am interested/tracking/watching</data> ...

Draft Properties

The following draft properties are in use in the wild (published and consumed), and are under strong consideration, but are not yet part of the core:

  • p-comment - optionally embedded (or nested?) h-cite(s), each of which is a comment on/reply to the parent h-entry. See Brainstorming for a Comment Microformat (example)
  • u-like-of - the URL which the h-entry is considered a “like” (favorite, star) of. Optionally an embedded h-cite (example)
  • u-repost-of - the URL which the h-entry is considered a “repost” of. Optionally an embedded h-cite.
  • u-photo - one or more photos that is/are considered the primary content of the entry, unless there is a p-location h-card, which is still considered a "checkin" (i.e. with a photo). Otherwise the presence of a u-photo means the name of the entry should be interpreted as a caption on the photo, and the summary/content should be interpreted as a description of the photo.
  • u-video - special u- parsing rules for <video src> & <source src>


Proposed Additions

The following properties are proposed additions based on various use-cases, such as existing link preview markup conventions, but are awaiting citations of use across multiple sites in the wild, and at least one reader / real world consuming code example:

  • u-audio - special u- parsing rules for <audio src> & <source src>
  • u-like - similar to p-comment, URL to a like post of the current post, e.g. in a responses list or facepile.
  • u-repost - similar to u-like, URL to a repost of the current post, e.g. in a responses list or facepile.
  • u-featured - a representative photo or image for the entry, e.g. primary photo for an article or subject-cropped photo, suitable for use in a link-preview.

The following interpretation is also proposed addition:

  • if the p-location is also an embedded h-card, the entry is treated as a "checkin".

Status

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

h-entry is ready to use and implemented in the wild, but for backwards compatibility you should also mark h-entries up as classic hAtom 0.1 entries.

Property Details

This section is a stub.

p-location

p-location has been re-used from h-event.

FAQ

p-name of a note

  • What is the p-name of a note?
    • A few options, from simplest to most detailed.
      • same as the p-content/e-content property.
      • same as the title element on the note permalink post page. When publishing a note on its own permalink post page, the contents of the note are likely abbreviated for the title of the page. The same abbreviation can be used for the p-name.
      • first sentence of the p-content/e-content property. It may be better for syndication and link-preview purposes to provide just the first sentence of the note as the p-name. Similarly if only a portion of the content is syndicated to other sites, that portion can be marked up as the p-summary.

venue an entry was posted from

  • How do you indicate a named venue where an entry was posted from? Like a restaurant or park.
    • Use an embedded h-card microformat on a p-location property value.

address an entry was posted from

  • How do you indicate the address where an entry was posted from? Like a restaurant or park.
    • If the address is just part of a named venue, see above, use an h-card
    • Otherwise use an embedded h-adr microformat on a p-location property value.

lat long an entry was posted from

  • How do you indicate the latitude and longitude of where an entry was posted from?
    • If the location has a name in addition to latitude and longitude, see above, use an h-card
    • Otherwise if there is an address in addition to latitude and longitude, see above, use an h-adr
    • Otherwise use an embedded h-geo microformat on a p-location property value.

dt-published property and HTML5 time element

  • Does the dt-published property need to be a time element?
    • The dt-published property should be a <time> element so that you can take advantage of HTML5's "datetime" property.
    • This lets you specify a human-readable date in the value of the attribute, and the ISO8601 machine-readable date in the "datetime" property.

what is the bare minimum list of required properties on an h-entry

  • What is the bare minimum list of required properties on an h-entry?
    • No properties are explicitly required, but in practice a h-entry should have the following properties at a minimum for consumers:
  • name (can be implied)
  • url (can be implied)
  • published
  • What properties should an h-entry have in addition to the bare minimum?
    • Beyond the bare minimum, a typical h-entry should have the following as well:
  • content (or summary at least) - especially for structured content. For a plain text note, the content/summary (whichever is used) should be the same as the name, otherwise it will be implied from the text content of the root element.
  • name - for explicitly named/titled entries. Otherwise the entry is assumed to be a "title-less" note (like a tweet).
  • author - including a nested h-card

Examples in the wild

Real world in the wild examples:

  • ... add uses of h-entry you see in the wild here.
  • ind.ie mark up their blog listing and permalink pages with h-entry
  • David John Mead marks up his profile, blog posts and comments with h-card, h-entry and h-cite on davidjohnmead.com
  • Brian Suda marks up his blog posts up with h-entry and h-card on optional.is
  • Ashton McAllen marks up his blog posts, reposts, comments and likes with h-entry, h-card and h-cite on acegiak.net
  • Emma Kuo marks up her blog posts and notes with h-entry and h-card on notenoughneon.com
  • Scott Jenson marks up his blog posts with h-entry and h-card on jenson.org
  • Emily McAllen marks up her blog posts with h-entry and h-card on blackwoolholiday.com
  • Ryan Barrett marks up his blog posts, notes, replies and likes with h-entry and h-card on snarfed.org
  • Barry Frost marks up his notes with h-entry, h-card and h-cite on barryfrost.com
  • Amber Case marks up her profile, blog posts, replies and notes with h-entry and h-card on caseorganic.com
  • Johannes Ernst marks up his blog posts with h-entry on upon2020.com
  • Michiel de Jong marks up his profile and notes with h-entry and h-card on michielbdejong.com
  • Mike Taylor marks up his profile and blog posts with h-card and h-entry on bear.im
  • Erin Jo Ritchey marks up her profile, posts and comments using h-card, h-entry and h-cite with idno on erinjo.is
  • Jeena Paradies marks up his profile, blog posts, notes and comments using h-card, h-entry and h-cite on jeena.net
  • Andy Sylvester marks up his profile, blog posts and comments using h-card and h-entry on andysylvester.com (note: as of 2014-03-13 using h-entry for comments instead of correct h-cite --bw 14:44, 13 March 2014 (UTC))
  • Chloe Weil marks up her blog posts with h-entry on chloeweil.com
  • Christophe Ducamp marks up his blog posts and profile with h-entry and h-card on christopheducamp.com
  • Glenn Jones marks up his blog posts, notes, replies, profile and comments with h-entry, h-card and h-cite on glennjones.net
  • Marcus Povey marks up his blog posts and profile with h-entry and h-card on marcus-povey.co.uk
  • Matthias Pfefferle marks up his blog posts, comments and profile with h-card, h-cite and h-entry on notizblog.org
  • Kyle Mahan marks up his profile and notes with h-card and h-entry on kylewm.com
  • Okinawan-lyrics marks up his posts with h-entry and h-card (example)
  • App.net marks up profile pages and permalink pages with h-entry as of 2013-08-06 (example)
  • The Twitter archive browser UI uses h-entry and h-card internally, unfortunately it’s not exposed as HTML in static files anywhere
  • Brett Comnes marks up his posts with h-entry and h-card (example)
  • Ben Werdmuller marks up his posts with h-card and h-entry, u-in-reply-to and u-like (example)
  • Sandeep Shetty marks his posts up with h-card and h-entry, as well as draft u-in-reply-to and experimental u-like properties (example)
  • Laurent Eschenauer marks up his posts with h-entry (example)
  • Tom Morris marks up his posts using h-entry (example)
  • Numerous newer W3C specs, e.g.
  • SemPress is a WordPress theme that supports h-card, h-feed/h-entry.
  • The Pastry Box Project use h-card and h-entry markup on their homepage and individual thoughts pages
  • Aaron Parecki uses h-entry to mark up notes, e.g. 2012/230/reply/1.
  • Tantek Çelik uses h-entry on his home page, as well as h-entry on all post permalinks, e.g. 2012-243 post, with rel-prev/rel-next (if applicable) to indicate prev/next posts
  • Barnaby Walters uses h-entry on all notes and articles, as well as nested within notes as reply contexts example and comments example.

offline

  • spreadly marks up share permalink pages with h-entry, as well as minimal h-cards and experimental p-like properties (example)

Validating

Main article: microformats validators

Test and validate microformats2 markup in general with:

Backward Compatibility

Publisher Compatibility

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

<div class="h-entry hentry">
  <h1 class="p-name entry-title">My great blog post</h1>
</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-entry" is found, don't look for an "hentry" on the same element.

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

  • entry-title - parse as p-name
  • entry-summary - parse as p-summary
  • entry-content - parse as e-content
  • published - parse as dt-
  • updated - parse as dt-
  • author - including compat root vcard in the absence of h-card
  • category
  • rel=bookmark - parse as u-url. While not a class name nor typical microformats property, rel=bookmark was the only way to indicate an hentry permalink. Thus parsers should look for rel=bookmark hyperlinks inside an hentry, and take their "href" value as a value for a u-url property, including handling any relative URL resolution.
  • rel=tag - parse as p-category. While not a class name nor typical microformats property, rel=tag was the typical way to tag an hentry. Thus parsers should look for rel=tag hyperlinks inside an hentry, and take the last path segment of their "href" value as a value for a p-category property.

Proposed:

  • time.entry-date[datetime] - in the absence of published, parse as dt-published. parse for the first <time> element with class name of entry-date and non-empty datetime attribute inside an hentry, if there is no published property, use that time element's datetime attribute value for the dt-published property. Evidence: default WordPress themes 2011-2014([1][2][3][4]).
  • rel=author - in the absence of author, parse as u-author. While not a class name nor typical microformats property, rel=author was commonly used to link to an author's URL. Thus parsers should look for rel=author hyperlinks inside an hentry (or even on the same page, preceding the hentry), use the absolute version of it as a value for the u-author property if there is no "author" property. (citations to "hentry" examples in the wild that depend on rel=author needed to accepted this proposal. Note: default WordPress themes twentyeleven, twentytwelve, twentythirteen, twentyfourteen all use rel=author but only inside class="author vcard", and thus rel=author can be ignored since authorship is already picked up by existing author backcompat parsing.)

Compat FAQ

What about rel bookmark

Also asked as: Why use an h-entry u-url u-uid for permalinks when I have rel=bookmark?

A: tl;dr: use class="u-url u-uid" instead of rel=bookmark for post permalinks because it's simpler (fewer attributes), and works better across contexts (permalink page, recent posts on home page, collection of posts on archive pages).

rel=bookmark was the old hAtom 0.1 way of marking up permalinks. Since then two factors have contributed to reducing use of rel inside microformats:

  • rel by typically* document scoped in Microformats in HTML5 - thus making it inappropriate for use in microformats that are aggregated, e.g. a collection of posts on a home page or in monthly archives.
  • it is easier to always use class names for properties. When formats use two (or more!) attributes in HTML to specify properties, confusion results in lower data quality (of the markup and thus the stuff that is marked up). Thus per the microformats principles of start as simple as possible, in microformats2 we only use class names for properties.

* even though rel=bookmark in particular is article-element / sectioning scoped in HTML5[5], it's a detail that typical authors are not going to remember, and thus it's not good to depend on it for any kind of format.

Why rename entry-title entry-summary entry-content

The entry-* classnames in classic hAtom 0.1 were prefixed as such due to concerns about vocabulary overlap with the title (as in job title, completely separate semantic) property in hCard 1.0 and the summary property in hCalendar 1.0 (see: hAtom FAQ).

Following the start as simple as possible principle, in microformats2, the aforementioned vagueness of title is dealt with by removing it. As name is now used consistently across all vocabularies as the property which “names” the microformat, it makes sense to use it to mark up the name of a post.

Likewise, adding entry- to summary doesn’t add any useful information, and in practice there have been no problems with blog post summaries overlapping with entry summaries, so it makes sense to simplify to summary. The same applies to entry-content simplified to content.

See also: 2012-08-30 IRC conversation.

Related Work

Work that re-uses or builds upon h-entry:

Background

This work is based on the existing hAtom 0.1 microformat, and extensive selfdogfooding in the indie web camp community.

See Also