h-entry: Difference between revisions
m (r) |
(Initial stub dump with examples and experimental properties noted) |
||
Line 1: | Line 1: | ||
# | <entry-title>h-entry</entry-title> | ||
<span class="h-card 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-entry</dfn> 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 [[microformats|microformat]] draft standards suitable for embedding data in HTML/HTML5. | |||
h-entry is the [[microformats-2]] replacement for [[hAtom]]. | |||
== Example == | |||
Here is a simple blog post example: | |||
<source lang=html4strict> | |||
<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> | |||
</source> | |||
=== Get started === | |||
The class '''<code>h-entry</code>''' 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 <code>'''h-entry'''</code>): | |||
* '''<code>p-name</code>''' - entry name/title | |||
* '''<code>p-summary</code>''' - short entry summary | |||
* '''<code>e-content</code>''' - full content of the entry | |||
* '''<code>dt-published</code>''' - when the entry was published | |||
* '''<code>dt-updated</code>''' - when the entry was updated | |||
* '''<code>p-author</code>''' - who wrote the entry, optionally nested [[h-card]](s) | |||
* '''<code>p-category</code>''' - entry categories/tags | |||
* '''<code>u-url</code>''' - entry permalink URL | |||
* '''<code>u-uid</code>''' - unique entry ID | |||
* '''<code>p-geo</code>''' - geophysical location the entry was posted from, optionally a nested [[h-geo]] | |||
* '''<code>p-latitude</code>''' - decimal latitude | |||
* '''<code>p-longitude</code>''' - decimal longitude | |||
* '''<code>p-altitude</code>''' - decimal altitude | |||
The following experimental properties are in use in the wild but are not yet part of the spec: | |||
* '''<code>u-in-reply-to</code>''' - the URL which the h-entry is considered a reply to or comment on. | |||
** Potentially optionally a nested h-entry (for reply contexts) but I’m the only one doing that right now so not considered a recommendation | |||
* '''<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]]. | |||
== 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 [http://microformats.org/discuss/mail/microformats-new/ 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) | |||
== Examples in the wild == | |||
Real world in the wild examples: | |||
* ... add uses of h-entry you see in the wild here. | |||
== Background == | |||
This work is based on the existing [[hAtom]] microformat, and extensive selfdogfooding in the [http://indiewebcamp.com indie web camp] community. | |||
== Design Principles == | |||
(stub, expand) | |||
== See Also == | |||
* [[microformats-2]] | |||
* [[microformats-2-parsing]] | |||
* [[h-geo]] | |||
* [[hCard]] | |||
[[Category:Draft Specifications]] |
Revision as of 16:43, 13 June 2013
<entry-title>h-entry</entry-title> 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.
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
):
p-name
- entry name/titlep-summary
- short entry summarye-content
- full content of the entrydt-published
- when the entry was publisheddt-updated
- when the entry was updatedp-author
- who wrote the entry, optionally nested h-card(s)p-category
- entry categories/tagsu-url
- entry permalink URLu-uid
- unique entry IDp-geo
- geophysical location the entry was posted from, optionally a nested h-geop-latitude
- decimal latitudep-longitude
- decimal longitudep-altitude
- decimal altitude
The following experimental properties are in use in the wild but are not yet part of the spec:
u-in-reply-to
- the URL which the h-entry is considered a reply to or comment on.- Potentially optionally a nested h-entry (for reply contexts) but I’m the only one doing that right now so not considered a recommendation
p-comment
- optionally nested h-entry(ies), each of which is a comment on/reply to the parent h-entry. See comment-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)
Examples in the wild
Real world in the wild examples:
- ... add uses of h-entry you see in the wild here.
Background
This work is based on the existing hAtom microformat, and extensive selfdogfooding in the indie web camp community.
Design Principles
(stub, expand)