hmedia

(Difference between revisions)

Jump to: navigation, search
m (Scope: spelling mistake :()
(removing elements that can be marked up using other microformats ( Modularity ))
Line 5: Line 5:
{{TOC-right}}
{{TOC-right}}
-
== Proposal 2008-11-10 ==
+
== Proposal 2008-11-11 ==
=== Editor/Author ===
=== Editor/Author ===
Line 39: Line 39:
== Scope ==
== Scope ==
-
Images, Video and Audio regularly share several common fields. hMedia has been based on a minimal common subset based on the analysis of 225 media related web pages. All fields discovered during analysis occur more than 70% of the time or more across each of the target domains listed on the [[media-info-examples|Media Info Examples]] page. hMedia was developed using the [[process|Microformats Process]] and [[principles|Design Principles]].
+
Images, Video and Audio regularly share several common fields. hMedia has been based on a minimal common subset based on the analysis of 225 media related web pages. All fields discovered during analysis occur more than 80% of the time or more across each of the target domains listed on the [[media-info-examples|Media Info Examples]] page. hMedia was developed using the [[process|Microformats Process]] and [[principles|Design Principles]].
== Introduction ==
== Introduction ==
Line 59: Line 59:
** '''fn''' {{required}}. Text.
** '''fn''' {{required}}. Text.
** '''contributor'''. {{optional}}. using text or [[hcard]].
** '''contributor'''. {{optional}}. using text or [[hcard]].
-
** '''description'''. {{optional}}. text.
 
** '''photo[1]'''.  Using the HTML IMG element.
** '''photo[1]'''.  Using the HTML IMG element.
** '''video[1]'''.  Using the HTML elemens DIV, SPAN or OBJECT.
** '''video[1]'''.  Using the HTML elemens DIV, SPAN or OBJECT.
** '''enclosure[1]'''.  A <abbr title="Uniform Resource Identifier">URI</abbr> using the [[rel-design-pattern]].
** '''enclosure[1]'''.  A <abbr title="Uniform Resource Identifier">URI</abbr> using the [[rel-design-pattern]].
-
** '''published'''. {{optional}}. using [[datetime-design-pattern]].
 
-
** '''comment'''. {{optional}}. using [[hcard]]
 
-
** '''alternate'''. {{optional}}. A <abbr title="Uniform Resource Identifier">URI</abbr> using the [[rel-design-pattern]].
 
-
** '''category'''. {{optional}}. Text and/or [[rel-tag]]
 
** '''item''' {{optional}}. Using multiple properties from [[hmedia]].
** '''item''' {{optional}}. Using multiple properties from [[hmedia]].
Line 91: Line 86:
* hMedia {{may}} include one or more contributors.
* hMedia {{may}} include one or more contributors.
* The contents of the element {{should}} include a valid [[hcard|hCard]].
* The contents of the element {{should}} include a valid [[hcard|hCard]].
-
 
-
==== description ====
 
-
 
-
A full-text description of the Media. Reused from [[hreview]]
 
-
 
-
* The element is identified by the class name <code>description</code>.
 
-
* Multiple elements of class <code>description</code> {{should}} be ordered by default document order.
 
==== photo ====
==== photo ====
Line 123: Line 111:
* hMedia {{may}} include one or more <code>enclosure</code>'s.
* hMedia {{may}} include one or more <code>enclosure</code>'s.
* The type of the file {{should}} be specified by using the <code>type</code> specifier for a <abbr title="Uniform Resource Identifier">URI</abbr>.
* The type of the file {{should}} be specified by using the <code>type</code> specifier for a <abbr title="Uniform Resource Identifier">URI</abbr>.
-
 
-
==== published ====
 
-
 
-
Represents the date that the Media was made available to the public. Reused from [[hatom]]
 
-
 
-
* The element is identified by the class name <code>published</code>.
 
-
* hMedia {{may}} include one or more <code>published</code> elements.
 
-
* The contents of the element {{should}} use the [[datetime-design-pattern]].
 
-
 
-
==== comment ====
 
-
 
-
A user or visitor submitted comment on the media, contents {{must}} contain a valid [[hcard]]
 
-
 
-
* The element is identified by the class name <code>comment</code>.
 
-
* hMedia {{may}} have one or more <code>comment</code> elements.
 
-
* The contents of a <code>comment</code> {{must}} contain a valid [[hcard]]
 
-
** hCard properties
 
-
*** '''fn''' The name of the person who authored a comment
 
-
*** '''url''' A <abbr title="Uniform Resource Identifier">URI</abbr> of the person who authored a comment.
 
-
*** '''note''' To specify a comment that is associated with the person who authored a comment. Contents can be text or Valid html mark up
 
-
*** '''rev''' Datetime of the revision of the entire coment. This element {{should}} use the [[datetime-design-pattern]].
 
-
*** '''uid''' A unique <abbr title="Uniform Resource Identifier">URI</abbr> identifier of a comment, typically a &quot;permalink&quot; to a comment
 
-
 
-
See also [[media-info-brainstorming#Media_Comments|Media Comments]]
 
-
 
-
==== alternate ====
 
-
 
-
Designates an alternate version for the document or Media typically an RSS, Atom or XML feed.
 
-
 
-
* The element is identified by a <abbr title="Uniform Resource Identifier">URI</abbr> using the [[rel-design-pattern]], the rel attribute {{should}} contain the value of <code>alternate</code>.
 
-
* hMedia {{may}} include one or more <code>alternate</code> <abbr title="Uniform Resource Identifier">URI</abbr>s.
 
-
* The type of the document {{should}} be specified by using the <code>type</code> specifier for a <abbr title="Uniform Resource Identifier">URI</abbr>.
 
-
 
-
==== category ====
 
-
 
-
An author-designated "category" or a keyword/subject of the Media. Reused from [[hcalendar]].
 
-
 
-
* The element is identified by the class name <code>category</code>.
 
-
* hMedia {{may}} include one or more <code>category</code> elements.
 
-
* <code>category</code> keywords {{may}} also be defined using [[rel-tag]]
 
==== item ====
==== item ====
Line 197: Line 145:
   <dd>
   <dd>
     A Contributor is any person or organization that takes part in the creation or distribution of the Media
     A Contributor is any person or organization that takes part in the creation or distribution of the Media
-
  </dd>
 
-
  <dt>description</dt>
 
-
  <dd>
 
-
    A full-text description of the Media.
 
   </dd>
   </dd>
   <dt>photo</dt>
   <dt>photo</dt>
Line 213: Line 157:
   <dd>
   <dd>
     Indicates that the referred url is a download of the Media.
     Indicates that the referred url is a download of the Media.
-
  </dd>
 
-
  <dt>published</dt>
 
-
  <dd>
 
-
    Represents the date that the Media was made available to the public.
 
-
  </dd>
 
-
  <dt>comment</dt>
 
-
  <dd>
 
-
    A user or visitor submitted comment on the media.
 
-
  </dd>
 
-
  <dt>alternate</dt>
 
-
  <dd>
 
-
    Designates an alternate version for the document or Media typically an RSS, Atom or XML feed.
 
-
  </dd>
 
-
  <dt>category</dt>
 
-
  <dd>
 
-
    An author-designated "category" or a keyword or subject of the Media.
 
-
  </dd>
 
-
  <dt>category</dt>
 
-
  <dd>
 
-
    The genre or style used to classify the audio recording.
 
   </dd>
   </dd>
   <dt>item</dt>
   <dt>item</dt>
Line 242: Line 166:
</dl>
</dl>
</pre>
</pre>
 +
 +
== Modularity ==
 +
 +
Although media items are sometimes presented on their own they are often found in data structures that are supported by existing microformats. It should therefore be possible to use the media microformat as a child (or in some cases a parent) of these microformats.
 +
 +
=== Distribution and Syndication ===
 +
 +
* [http://microformats.org/wiki/hatom hAtom]
 +
 +
Podcast feeds reference a sequence of media items. A media microformat could therefore be used as a child element of hAtom.
 +
 +
=== Media Events ===
 +
 +
* [http://microformats.org/wiki/hcalendar hCalendar]
 +
 +
hMedia may used to describe a continuous media stream e.g. a TV channel. An event or a schedule of events on the channel can be signaled using hEvents as child elements. This combination would provide what is necessary to capture a specific event; the media stream information and the timing information.
 +
 +
=== Media Comments ===
 +
 +
* [http://microformats.org/wiki/comment Comment]
 +
 +
Comments and Feedback on media items often come up in popular publishing practice, a comment microformat should be used when marking up Media Comments
== Examples ==
== Examples ==

Revision as of 13:23, 11 November 2008

hMedia

hMedia ("Hypertext Media") is a simple and open format for publishing Images Video and Audio. hMedia may be embedded in HTML or XHTML, Atom, RSS, and arbitrary XML. hMedia is one of several open microformat standards.

Contents


Proposal 2008-11-11

Editor/Author

Contributors

In historical order of contribution

Inspiration and Acknowledgments

Many thanks to Tantek Çelik, Mary Hodder, and Manu Sporny for their continual contributions to Media and Audio Microformats in general.

Patents

This specification is subject to a royalty free patent policy, e.g. per the W3C Patent Policy, and IETF RFC3667 & RFC3668.

Semantic XHTML Design Principles

Note: the Semantic XHTML Design Principles were written primarily within the context of developing hCard and hCalendar, thus it may be easier to understand these principles in the context of the hCard design methodology (i.e. read that first). Tantek

XHTML is built on XML, and thus XHTML based formats can be used not only for convenient display presentation, but also for general purpose data exchange. In many ways, XHTML based formats exemplify the best of both HTML and XML worlds. However, when building XHTML based formats, it helps to have a guiding set of principles.

  1. Reuse the schema (names, objects, properties, values, types, hierarchies, constraints) as much as possible from pre-existing, established, well-supported standards by reference. Avoid restating constraints expressed in the source standard. Informative mentions are ok.
    1. For types with multiple components, use nested elements with class names equivalent to the names of the components.
    2. Plural components are made singular, and thus multiple nested elements are used to represent multiple text values that are comma-delimited.
  2. Use the most accurately precise semantic XHTML building block for each object etc.
  3. Otherwise use a generic structural element (e.g. <span> or <div>), or the appropriate contextual element (e.g. an <li> inside a <ul> or <ol>).
  4. Use class names based on names from the original schema, unless the semantic XHTML building block precisely represents that part of the original schema. If names in the source schema are case-insensitive, then use an all lowercase equivalent. Components names implicit in prose (rather than explicit in the defined schema) should also use lowercase equivalents for ease of use. Spaces in component names become dash '-' characters.
  5. Finally, if the format of the data according to the original schema is too long and/or not human-friendly, use <abbr> instead of a generic structural element, and place the literal data into the 'title' attribute (where abbr expansions go), and the more brief and human readable equivalent into the element itself. Further informative explanation of this use of <abbr>: Human vs. ISO8601 dates problem solved

Scope

Images, Video and Audio regularly share several common fields. hMedia has been based on a minimal common subset based on the analysis of 225 media related web pages. All fields discovered during analysis occur more than 80% of the time or more across each of the target domains listed on the Media Info Examples page. hMedia was developed using the Microformats Process and Design Principles.

Introduction

Mary Hodder - 22 Jan 2006

There are many ways to publish media by users, but as people try to access those remixing and aggregation become more and more prevalent, having consistent records becomes important. Audio, photos and video show up in each other's publishing spaces, even though they are unique media objects. A photo might be next to the link for an audio piece, as it's visual artwork. A video can be comprised of quotes of other videos, photos and audio. Still photos can be made from videos. All three types of objects can contain subsets of media that is tagged and described.

The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in RFC 2119.

Format

Abstract

hMedia is a single media publishing format that relates to Images, Video and Audio in a meaningful, organized and structured way. Wherever possible field names have been chosen from those defined by the hCard standard.

Schema

[1] hMedia MUST contain at least one.

Schema Definition

hmedia

hMedia is used to describe semantic information associated with Images, Videos and Audio.

fn

The name of a media. Reused from hcard

contributor

A Contributor is any person or organization that takes part in the creation or distribution of the Media. Reused from haudio

photo

An embedded Image or Photograph of the Media. Reused from hcard

video

The contents are an embedded video or movie of the Media such as a Flash Movie.

enclosure

Indicates that the referred url is a download of the Media. Using rel-enclosure.

item

A container element for another Media item. Reused from haudio

XMDP Profile

<dl class="profile">
 <dt>class</dt>
 <dd><p>
  <a rel="help" 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>.</p>
  <dl>
   <dt>hmedia</dt>
   <dd>
    Used to describe semantic information associated with Images, Videos and Audio.
   </dd>
   <dt>fn</dt>
   <dd>
    The name of a media
   </dd>
   <dt>contributor</dt>
   <dd>
    A Contributor is any person or organization that takes part in the creation or distribution of the Media
   </dd>
   <dt>photo</dt>
   <dd>
    An embedded Image or Photograph of the Media.
   </dd>
   <dt>video</dt>
   <dd>
    An embedded video or movie of the Media.
   </dd>
   <dt>enclosure</dt>
   <dd>
     Indicates that the referred url is a download of the Media.
   </dd>
   <dt>item</dt>
   <dd>
    A container element for another Media item.
   </dd>
  </dl>
 </dd>
</dl>

Modularity

Although media items are sometimes presented on their own they are often found in data structures that are supported by existing microformats. It should therefore be possible to use the media microformat as a child (or in some cases a parent) of these microformats.

Distribution and Syndication

Podcast feeds reference a sequence of media items. A media microformat could therefore be used as a child element of hAtom.

Media Events

hMedia may used to describe a continuous media stream e.g. a TV channel. An event or a schedule of events on the channel can be signaled using hEvents as child elements. This combination would provide what is necessary to capture a specific event; the media stream information and the timing information.

Media Comments

Comments and Feedback on media items often come up in popular publishing practice, a comment microformat should be used when marking up Media Comments

Examples

Images

Video

Audio

Combined

History

References

Normative References

Informative References

Similar Work

Work in progress

Brainstorming

See: media-info-brainstorming

Discussions

Issues

See: media-info-issues

Related pages

hmedia was last modified: Wednesday, December 31st, 1969

Views