hatom-profile: Difference between revisions
Jump to navigation
Jump to search
m (Replace <entry-title> with {{DISPLAYTITLE:}}) |
|||
| (One intermediate revision by one other user not shown) | |||
| Line 1: | Line 1: | ||
{{DISPLAYTITLE:hAtom Profile}} | |||
The following is an [http://gmpg.org/xmdp/ XMDP] profile for the [[hatom|hAtom]] specification. | The following is an [http://gmpg.org/xmdp/ XMDP] profile for the [[hatom|hAtom]] specification. | ||
| Line 62: | Line 62: | ||
</dd> | </dd> | ||
<dt id="entry-title"> | <dt id="entry-title">entry-title</dt> | ||
<dd>This optional property provides the title or name of an entry, based on the definition of atom:feed (section 4.2.14 of RFC 4287), | <dd>This optional property provides the title or name of an entry, based on the definition of atom:feed (section 4.2.14 of RFC 4287), | ||
constrained and modified as per the <a href="http://microformats.org/wiki/hatom">hAtom microformat spec</a>.</dd> | constrained and modified as per the <a href="http://microformats.org/wiki/hatom">hAtom microformat spec</a>.</dd> | ||
| Line 76: | Line 76: | ||
<dt id="author">author</dt> | <dt id="author">author</dt> | ||
<dd>This optional property provides information about the person who wrote a feed or entry. If the value is provided then the same element that | <dd>This optional property provides information about the person who wrote a feed or entry. If the value is provided then the same element that | ||
has the class name of "author" should use the class name of "vcard" and thus represent an embedded <a href="http://microformats.org/wiki/hcard"> | has the class name of "author" should use the class name of "vcard" and thus represent an embedded <a href="http://microformats.org/wiki/hcard">hCard</a>. This property is based loosely on the definition of atom:author (section 4.2.1 of RFC 4287), | ||
constrained and modified as per the <a href="http://microformats.org/wiki/hatom">hAtom microformat spec</a>.</dd> | constrained and modified as per the <a href="http://microformats.org/wiki/hatom">hAtom microformat spec</a>.</dd> | ||
| Line 84: | Line 84: | ||
constrained and modified as per the <a href="http://microformats.org/wiki/hatom">hAtom microformat spec</a>.</dd> | constrained and modified as per the <a href="http://microformats.org/wiki/hatom">hAtom microformat spec</a>.</dd> | ||
<dt id="updated"> | <dt id="updated">updated</dt> | ||
<dd>This optional property specifies the date and time (in ISO8601 date or date-time) that an entry was most recently updated. | <dd>This optional property specifies the date and time (in ISO8601 date or date-time) that an entry was most recently updated. | ||
This property is based loosely on the definition of atom:updated (section 4.2.15 of RFC 4287), | This property is based loosely on the definition of atom:updated (section 4.2.15 of RFC 4287), | ||
Latest revision as of 16:23, 18 July 2020
The following is an XMDP profile for the hAtom 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/hatom'>
In HTML5, head[profile] has been deprecated:
<head>
…
<link rel='profile' href='http://microformats.org/profile/hatom'>
</head>
Profile
<dl class="profile">
<dt id="rel">rel</dt>
<dd><p>
<a rel="help" href="http://www.w3.org/TR/html401/struct/links.html#adef-rel">
HTML4 definition of the 'rel' attribute.</a>
Here is an additional value as defined in the
<a rel="help start" href="http://microformats.org/wiki/rel-tag">
rel-tag</a>
specification.</p>
<dl>
<dt id="tag">tag</dt>
<dd>Indicates that the referred resource serves as a "tag",
or keyword/subject, for the referring page, or some portion of the referring page (such as an hAtom).</dd>
</dl>
</dd>
<dt>class</dt>
<dd><p>
<a 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 rel="help start" href="http://microformats.org/wiki/hatom">
hAtom specification</a>.
</p>
<dl>
<dt id="hfeed">hfeed</dt>
<dd>The root class name and container for a feed, based on the definition of atom:feed (section 4.1.1 of RFC 4287),
constrained and modified as per the <a href="http://microformats.org/wiki/hatom">hAtom microformat spec</a>.
</dd>
<dt id="hentry">hentry</dt>
<dd>The root class name and container for an entry, based on the definition of atom:feed (section 4.1.2 of RFC 4287),
constrained and modified as per the <a href="http://microformats.org/wiki/hatom">hAtom microformat spec</a>.
</dd>
<dt id="entry-title">entry-title</dt>
<dd>This optional property provides the title or name of an entry, based on the definition of atom:feed (section 4.2.14 of RFC 4287),
constrained and modified as per the <a href="http://microformats.org/wiki/hatom">hAtom microformat spec</a>.</dd>
<dt id="entry-summary">entry-summary</dt>
<dd>This optional property provides the summary of an entry, based on the definition of atom:summary (section 4.2.13 of RFC 4287),
constrained and modified as per the <a href="http://microformats.org/wiki/hatom">hAtom microformat spec</a>.</dd>
<dt id="entry-content">entry-content</dt>
<dd>This optional property provides the contents of an entry, based on the definition of atom:content (section 4.1.3 of RFC 4287),
constrained and modified as per the <a href="http://microformats.org/wiki/hatom">hAtom microformat spec</a>.</dd>
<dt id="author">author</dt>
<dd>This optional property provides information about the person who wrote a feed or entry. If the value is provided then the same element that
has the class name of "author" should use the class name of "vcard" and thus represent an embedded <a href="http://microformats.org/wiki/hcard">hCard</a>. This property is based loosely on the definition of atom:author (section 4.2.1 of RFC 4287),
constrained and modified as per the <a href="http://microformats.org/wiki/hatom">hAtom microformat spec</a>.</dd>
<dt id="published">published</dt>
<dd>This optional property specifies the date and time (in ISO8601 date or date-time) that an entry was originally published.
This property is based loosely on the definition of atom:published (section 4.2.9 of RFC 4287),
constrained and modified as per the <a href="http://microformats.org/wiki/hatom">hAtom microformat spec</a>.</dd>
<dt id="updated">updated</dt>
<dd>This optional property specifies the date and time (in ISO8601 date or date-time) that an entry was most recently updated.
This property is based loosely on the definition of atom:updated (section 4.2.15 of RFC 4287),
constrained and modified as per the <a href="http://microformats.org/wiki/hatom">hAtom microformat spec</a>.</dd>
<dt id="category">category</dt>
<dd>A category of the feed or entry. Publishers should also use rel-tag to indicate the precise meaning of a category with a URL.
Note: this property may be repeated (a feed or entry may belong in several categories). Re-used from hCalendar which re-uses it from iCalendar (section 4.8.1.2 of RFC 2445).
This property is also based loosely on the definition of atom:category (section 4.2.2 of RFC 4287),
constrained and modified as per the <a href="http://microformats.org/wiki/hatom">hAtom microformat spec</a>.</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
- h-entry - latest markup spec for Atom entries in HTML
- h-feed - brainstorm/experiment for feeds in HTML
- hAtom - the draft proposal.
- hAtom Cheatsheet - hAtom properties.
- hAtom Examples, in the Wild
- hAtom Hints - help for implementors.
- hAtom Issues - problems? complaints? ideas? Put them here.
- hatom-brainstorming - active work on iterations toward the next version of hAtom
- hAtom FAQ - knowledge base.
- hAtom advocacy - encourage others to use hAtom.