h-entry

(Difference between revisions)

Jump to: navigation, search
m (Properties: signed personal note)
(dump of FAQ, experimental link preview properties from mf2 page)
Line 52: Line 52:
** Potentially optionally a nested h-entry (for reply contexts) but I’m the only one doing that right now so not considered a recommendation --[[User:Barnabywalters|bw]] 16:44, 13 June 2013 (UTC)
** Potentially optionally a nested h-entry (for reply contexts) but I’m the only one doing that right now so not considered a recommendation --[[User:Barnabywalters|bw]] 16:44, 13 June 2013 (UTC)
* '''<code>p-comment</code>''' - optionally nested h-entry(ies), each of which is a comment on/reply to the parent h-entry. See [[comment-brainstorming]].
* '''<code>p-comment</code>''' - optionally nested h-entry(ies), each of which is a comment on/reply to the parent h-entry. See [[comment-brainstorming]].
 +
 +
The following properties are proposed additions based on various existing link preview markup conventions which are ''not'' yet used in the wild:
 +
* '''<code>u-photo</code>'''
 +
* '''<code>u-audio</code>''' - consider special u- parsing rules for <code>&lt;audio></code>
 +
* '''<code>u-video</code>''' - consider special u- parsing rules for <code>&lt;video></code>
 +
* '''<code>u-in-reply-to</code>''' - for links to other posts that this post is a reply to (comment regarding, etc.)
 +
 +
See also [[link-preview-brainstorming]].
== Status ==
== Status ==
Line 60: Line 68:
== Property Details ==
== Property Details ==
(stub, to be expanded)
(stub, to be expanded)
 +
 +
== FAQ ==
 +
 +
<div class="discussion">
 +
* '''What is the <code>p-name</code> of a [http://indiewebcamp.com/note note]?'''
 +
** A few options, from simplest to most detailed.
 +
*** '''same as the p-content/e-content''' property.
 +
*** '''same as the <code>title</code> 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 [http://indiewebcamp.com/syndication syndication] and [[link-preview]] purposes to provide just the first sentence of the note as the <code>p-name</code>. Similarly if only a portion of the content is syndicated to other sites, that portion can be marked up as the <code>p-summary</code>.
 +
* ...
 +
</div>
== Examples in the wild ==
== Examples in the wild ==

Revision as of 16:54, 13 June 2013

Tantek Çelik (Editor)


h-entry is a simple, open format for content on the web which can be syndicated, primarily but not limited to blog posts. h-entry is one of several open microformat draft standards suitable for embedding data in HTML/HTML5.

h-entry is the microformats-2 replacement for hAtom.

Contents

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">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>

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 microformats-2-parsing to learn more about property classnames.

Properties

h-entry properties (inside class h-entry):

The following experimental properties are in use in the wild but are not yet part of the spec:

The following properties are proposed additions based on various existing link preview markup conventions which are not yet used in the wild:

See also link-preview-brainstorming.

Status

h-entry is a microformats.org draft specification. Public discussion on h-entry takes place on h-entry-feedback, the #microformats irc channel on irc.freenode.net, and microformats-new mailing list.

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 entries.

Property Details

(stub, to be expanded)

FAQ

  • 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.
  • ...

Examples in the wild

Real world in the wild examples:

Background

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

Design Principles

(stub, expand)

See Also

Categories

h-entry was last modified: Wednesday, December 31st, 1969

Views