hAudio 0.9.1

(Difference between revisions)

Jump to: navigation, search
m (XMDP Profile)
Current revision (00:46, 21 June 2018) (view source)
m (fix deadname)
 
(131 intermediate revisions not shown.)
Line 1: Line 1:
-
<h1>hAudio 0.7</h1>
+
<entry-title>hAudio 0.9.1</entry-title>
-
 
+
{{Template:DraftSpecification}}
 +
{{TOC-right}}
http://farm2.static.flickr.com/1216/604867362_da0921136a_o.png
http://farm2.static.flickr.com/1216/604867362_da0921136a_o.png
-
[[haudio|hAudio]] is a simple, open, distributed format, suitable for embedding information about audio recordings in (X)HTML, Atom, RSS, and arbitrary XML. hAudio is one of several [[microformats]] open standards.
+
[[haudio|hAudio]] is a simple, open, distributed format, suitable for embedding information about audio recordings in (X)HTML, Atom, RSS, and arbitrary XML. hAudio is one of several [[microformats]] open standards. This page and Microformat is in the public domain.
== hAudio Microformat Draft Specification ==
== hAudio Microformat Draft Specification ==
-
; Editor: [[User:ManuSporny | Manu Sporny]], [http://www.bitmunk.com/ Bitmunk] - [http://blog.digitalbazaar.com Digital Bazaar], Inc.
+
=== Editors ===
-
; Contributors: [[User:ManuSporny | Manu Sporny]], [http://www.bitmunk.com/ Bitmunk] - [http://blog.digitalbazaar.com Digital Bazaar], Inc.
+
* [[User:ManuSporny | Manu Sporny]] ([http://www.bitmunk.com/ Bitmunk] - [http://blog.digitalbazaar.com Digital Bazaar], Inc.)
-
: [[ user:WebOrganics | Martin McEvoy ]]
+
* [[ user:WebOrganics | Martin McEvoy ]]
-
: [[  User:AlexandreVandeSande | Alexandre Van De Sande ]] Releases all his contribution as public domain(see user page)
+
=== Authors ===
-
: Michael Johnson
+
* [[User:ManuSporny | Manu Sporny]]  
-
: Dave Longley
+
* [[ user:WebOrganics | Martin McEvoy ]]
-
: Brian Suda
+
 
-
: Ben Wiley Sittler
+
=== Contributors===
-
: Scott Reynen
+
[[User:ManuSporny | Manu Sporny]], [[ user:WebOrganics | Martin McEvoy ]], [[  User:AlexandreVandeSande | Alexandre Van De Sande ]], Michael Johnson, Dave Longley, Brian Suda, Ben Wiley Sittler, Scott Reynen, Frances Berriman, James Craig, David Janes, [[User:AndyMabbett|Andy Mabbett]], Danny Ayers, Rudy Desjardins, Theresa O'Connor, Ryan King, Chris Griego, Brad Hafichuk, Tantek Çelik, Colin Barrett, Joe Andrieu, Michael Smethurst, [[User:ChrisNewell | Chris Newell]], Julian Stahnke, Justin Maxwell, Paul Wilkins and David I. Lehn.
-
: Frances Berriman
+
-
: James Craig
+
-
: David Janes
+
-
: Andy Mabbett
+
-
: Danny Ayers
+
-
: Rudy Desjardins
+
-
: Edward O'Connor
+
-
: Ryan King
+
-
: Chris Griego
+
-
: Brad Hafichuk
+
-
: Tantek Çelik
+
-
: Colin Barrett
+
-
: Joe Andrieu
+
-
: Michael Smethurst
+
-
: [[User:ChrisNewell | Chris Newell]]
+
-
: Julian Stahnke
+
-
: Justin Maxwell
+
-
: Paul Wilkins
+
Microformats [[#Copyright]] and [[#Patents]] statements apply.
Microformats [[#Copyright]] and [[#Patents]] statements apply.
-
 
-
__TOC__
 
== Introduction ==
== Introduction ==
Line 49: Line 30:
=== Inspiration and Acknowledgments ===
=== Inspiration and Acknowledgments ===
-
Many thanks to the various individuals that did research and proposed ideas and discussion related to media info and audio info in general. Among the many participants are [[RodBegbie]], Dean Hudson, [http://tantek.com/log/ Tantek Çelik], [http://napsterization.org/stories/ Mary Hodder], [http://joshkinberg.com/blog/ Joshua Kinberg], ChrisMessina, and [http://onlisareinsradar.com/ Lisa Rein].
+
Many thanks to the various individuals that did research and proposed ideas and discussion related to media info and audio info in general. Among the many participants are [[RodBegbie]], Dean Hudson, [http://tantek.com/log/ Tantek Çelik], [http://napsterization.org/stories/ Mary Hodder], [http://joshkinberg.com/blog/ Joshua Kinberg], ChrisMessina, and [http://onlisareinsradar.com/ Lisa Rein][http://www.irstaxreliefsettlement.com .]
=== Scope ===
=== Scope ===
Line 55: Line 36:
Audio content consistently share several common fields.  Where possible hAudio has been based on this minimal common subset.
Audio content consistently share several common fields.  Where possible hAudio has been based on this minimal common subset.
-
==== Out of scope ====
+
=== Out of scope ===
Fields that are type-specific have been omitted from hAudio.  It is important that hAudio be kept simple and minimal from the start.  Additional features can be added as deemed necessary by practical implementation experience.
Fields that are type-specific have been omitted from hAudio.  It is important that hAudio be kept simple and minimal from the start.  Additional features can be added as deemed necessary by practical implementation experience.
Line 61: Line 42:
The concept of a universal audio identifier, that is, how to identify the same audio album, song, speech, or podcast across different music and audio sites, though something very useful to have, is outside the scope of this format.
The concept of a universal audio identifier, that is, how to identify the same audio album, song, speech, or podcast across different music and audio sites, though something very useful to have, is outside the scope of this format.
-
== Semantic XHTML Design Principles ==
+
== Format ==
-
{{semantic-xhtml-design-principles}}
+
{{rfc-2119-intro}}
-
 
+
-
== Format ==
+
=== In General ===
=== In General ===
Line 75: Line 54:
* hAudio ('''<code>haudio</code>''')
* hAudio ('''<code>haudio</code>''')
-
** '''fn''' and/or '''album''' required. text.
+
** '''fn''' or/and '''album''' required. text.
** '''contributor'''. optional. using text or [[hCard]].
** '''contributor'''. optional. using text or [[hCard]].
-
** '''duration'''. optional. ISO-8601 time duration using [[abbr-design-pattern]] (re-used from [[hcalendar]]).
+
** '''duration'''. optional. ISO-8601 time duration. (re-used from [[hcalendar]]).
** '''item''' optional. using text or multiple properties from [[hAudio]].
** '''item''' optional. using text or multiple properties from [[hAudio]].
** '''position''' optional. text.
** '''position''' optional. text.
** '''category'''. optional. text.
** '''category'''. optional. text.
-
** '''published'''. optional. using [[datetime-design-pattern]].
+
** '''published'''. optional.
-
** '''photo'''. optional. using HTML and XHTML tag <code>img</code>.
+
** '''photo'''. optional. using any element containing a URL, such as IMG.
** '''description''' optional. text.
** '''description''' optional. text.
** '''sample''' (rel). optional. sample file/stream using [[rel-design-pattern]] with <code>sample</code> as the <code>mf-rel-value</code>.
** '''sample''' (rel). optional. sample file/stream using [[rel-design-pattern]] with <code>sample</code> as the <code>mf-rel-value</code>.
** '''enclosure''' (rel). optional. full download of file using [[rel-enclosure]].
** '''enclosure''' (rel). optional. full download of file using [[rel-enclosure]].
** '''payment''' (rel). optional. link to purchase process using [[rel-payment]].
** '''payment''' (rel). optional. link to purchase process using [[rel-payment]].
-
** '''price'''. optional. using [[currency-proposal]].
+
** '''price''' optional. Using the sub properties '''currency''' and '''amount'''.
=== Field details ===
=== Field details ===
Line 99: Line 78:
* an hAudio element is identified by class name <code>haudio</code>
* an hAudio element is identified by class name <code>haudio</code>
-
==== Formatted Name ====
+
==== fn ====
-
The title of a single audio recording is a short textual description used to identify the work among interested parties. This can be the title of a speech, song title, or short description regarding a sound effect.
+
The name of a single audio recording is a short textual description used to identify the work among interested parties. This can be the name of a speech, song name, or short description regarding a sound effect.
* The element is identified by the class name <code>fn</code>.
* The element is identified by the class name <code>fn</code>.
-
* hAudio {{must}} have either <code>fn</code> or <code>album</code>.
+
* hAudio {{must}} have <code>fn</code> or/and  <code>album</code>.
==== Album ====
==== Album ====
-
The title of a collection of audio recordings that are represented as a CD, album or LP. The text should be a short textual description used to identify the work among interested parties. This can be the title of a CD, album title, or the name of a collection of audio recordings.
+
The title of a collection of audio recordings, such as those that are represented as a CD, album or LP. The text should be a short textual description used to identify the work among interested parties.
* The element is identified by the class name <code>album</code>.
* The element is identified by the class name <code>album</code>.
-
* hAudio {{must}} have either <code>album</code> or <code>fn</code>.
+
* hAudio {{must}} have either <code>album</code> or <code>fn</code> or both.
==== Item ====
==== Item ====
Line 129: Line 108:
* hAudio {{may}} include one <code>position</code> element.
* hAudio {{may}} include one <code>position</code> element.
* The contents of the element {{must}} be a number or other sequential identifier.
* The contents of the element {{must}} be a number or other sequential identifier.
 +
* The sequential identifier {{may}} be specified out-of-sequence.
==== Contributor ====
==== Contributor ====
-
A Contributor is any entity that takes part in the creation and distribution of an audio recording. Examples include: artist, publisher, guitarist, vocalist, violinist, lead singer, backup singer, bassist, drummer, manager, and roadie.
+
A Contributor is any entity that takes part in the creation and distribution of an audio recording. Examples include: artist, composer, publisher, guitarist, vocalist, violinist, lead singer, backup singer, bassist, drummer, manager, and roadie.
* The element is identified by the class name <code>contributor</code>.
* The element is identified by the class name <code>contributor</code>.
* hAudio {{may}} include one or more contributors.
* hAudio {{may}} include one or more contributors.
-
* The contents of the element {{may}} be plain-text or {{may}} include a valid [[hCard]] Microformat.
+
* The contributor's name SHOULD also be marked up as a valid hCard Microformat. [[hcard]]
-
* The <code>role</code> field should be used to specify the Contributor's responsibility related to the audio recording if the [[hCard]] Microformat is utilized for mark-up.
+
*# The <code>role</code> attribute {{should}} be used to specify the contributor's responsibility related to the audio recording if hCard is utilized.
-
* If multiple Contributors are specified without <code>role</code> specifications, it may be assumed that the first role mentioned is the primary artist or creator. This applies to plain-text contributor markup as well.
+
* The contributor's name {{may}} be specified in plain-text without being enclosed in a hCard Microformat.
==== Published ====
==== Published ====
Line 146: Line 126:
* The element is identified by the class name <code>published</code>.
* The element is identified by the class name <code>published</code>.
* hAudio {{may}} include one or more <code>published</code> elements.
* hAudio {{may}} include one or more <code>published</code> elements.
-
* The contents of the element must include a date format compliant with the [[datetime-design-pattern]].
+
* The contents of the element {{may}} include a date format compliant with the [[datetime-design-pattern]].
==== Sample ====
==== Sample ====
-
A Sample URL specifies from where an excerpt of the audio recording may be retrieved.
+
A Sample URI specifies from where an excerpt of the audio recording may be retrieved.
-
* The element is identified by a URL fitting the [[rel-design-pattern]], the rel content being <code>sample</code>.
+
* The element is identified by a URI fitting the [[rel-design-pattern]], the rel content being <code>sample</code>.
-
* hAudio {{may}} include one or more URL <code>sample</code>s.
+
* hAudio {{may}} include one or more URI <code>sample</code>s.
-
* The URL {{should}} point to a directly accessible stream or file.
+
* The URI {{should}} point to a directly accessible stream or file.
-
* The type of the sample {{may}} be specified by using the <code>type</code> specifier for a URL.
+
* The type of the sample {{may}} be specified by using the <code>type</code> specifier for a URI.
==== Full Download (Enclosure) ====
==== Full Download (Enclosure) ====
-
An Full Download URL specifies from where the full version of an audio recording may be retrieved. The URL {{must}} point to a direct link to a file.
+
A Full Download URI specifies from where the full version of an audio recording may be retrieved. The URI {{must}} point to a direct link to a file retrieval process (FTP, HTTP, BitTorrent URI, etc).
-
* The element is identified by a URL fitting the [[rel-design-pattern]], the rel content being <code>enclosure</code>.
+
* The element is identified by a URI fitting the [[rel-design-pattern]], the rel content being <code>enclosure</code>.
-
* hAudio {{may}} include one or more <code>enclosure</code> URLs.
+
* hAudio {{may}} include one or more <code>enclosure</code> URIs.
-
* The type of the file {{may}} be specified by using the <code>type</code> specifier for a URL.
+
* The type of the file {{should}} be specified by using the <code>type</code> specifier for a URI.
==== Purchase (Payment) ====
==== Purchase (Payment) ====
-
An Purchase URL specifies from where the full version of an audio recording may be purchased. The URL {{must}} point to a page that contains a purchase process.
+
A Purchase URI specifies from where the full version of an audio recording may be purchased. The URI {{must}} point to the beginning of a purchase process for the hAudio.
-
* The element is identified by a URL fitting the [[rel-design-pattern]], the rel content being <code>payment</code>.
+
* The element is identified by a URI fitting the [[rel-design-pattern]], the rel content being <code>payment</code>.
-
* hAudio {{may}} include one or more <code>payment</code> URLs.
+
* hAudio {{may}} include one or more <code>payment</code> URIs.
-
* The type of the file {{may}} be specified by using the <code>type</code> specifier for a URL.
+
* The type of the file {{may}} be specified by using the <code>type</code> specifier for a URI.
==== Photo ====
==== Photo ====
Line 179: Line 159:
* The element is identified by the class name <code>photo</code>.
* The element is identified by the class name <code>photo</code>.
* hAudio {{may}} include one or more <code>photo</code> elements.
* hAudio {{may}} include one or more <code>photo</code> elements.
-
* The element must be an &lt;img&gt; element.
+
* The element {{should}} use an &lt;img&gt; element.
 +
* The element {{may}} use any other element that contains a URL, such as &lt;a&gt; or &lt;object&gt;, but it is not recommended.
==== Category ====
==== Category ====
Line 187: Line 168:
* The element is identified by the class name <code>category</code>.
* The element is identified by the class name <code>category</code>.
* hAudio {{may}} include one or more <code>category</code> elements.
* hAudio {{may}} include one or more <code>category</code> elements.
 +
* This element {{may}} be expressed using the [[rel-tag]] elemental microformat. When a category is expressed using rel-tag, the content of the element is used as the text for the category. For example: <code><a class="category" rel="tag" href="/tags/symphony">Symphonic</a></code> would have "Symphonic" as the text for the category.
==== Duration ====
==== Duration ====
Line 194: Line 176:
* The element is identified by the class name <code>duration</code>.
* The element is identified by the class name <code>duration</code>.
* hAudio {{may}} include one <code>duration</code> element.
* hAudio {{may}} include one <code>duration</code> element.
-
* The contents of the element {{should}} use the [[abbr-design-pattern]] whose title attribute contains an ISO-8601 formatted duration. An example of 3:23 would be "PT3M23S" in ISO 8601 format.
+
* The contents of the element {{may}} use the [[abbr-design-pattern]] whose title attribute contains an ISO-8601 formatted duration. An example of 3:23 (i.e 3 minutes 23 seconds) would be "PT3M23S" in ISO 8601 format.
 +
* The element {{may}} contain the following sub properties:
 +
** '''h''' Hour.
 +
** '''min''' Minute.
 +
** '''s''' Second.
 +
Example:
 +
<pre><span class="duration">
 +
<span class="h">1</span>:
 +
<span class="min">3</span>:
 +
<span class="s">23</span>
 +
</span></pre>
==== Price ====
==== Price ====
-
The Price specifies the amount of currency that must be exchanged for acquisition of a full specimen of the audio recording. Examples include: One Dollar, $2, and £4.
+
The Price specifies the amount of currency that must be exchanged for acquisition of a full specimen of the audio recording.  
* The element is identified by the class name <code>price</code>.
* The element is identified by the class name <code>price</code>.
* hAudio {{may}} include one or more <code>price</code> elements.
* hAudio {{may}} include one or more <code>price</code> elements.
-
* The contents of the element {{should}} use the [[currency-proposal]].
+
* The contents of the element {{may}} also use plain text with a currency symbol.
 +
* The contents {{may}} contain the following sub properties:
 +
** '''currency''' an [http://en.wikipedia.org/wiki/ISO_4217#Active_codes ISO 4217] currency name.
 +
** '''amount''' a numerical value.
 +
Example:
 +
<pre><span class="price">
 +
<abbr class="currency" title="GBP">&pound;</abbr>
 +
<span class="amount">4.99</span>
 +
</span></pre>
==== Description ====
==== Description ====
Line 211: Line 211:
* hAudio {{may}} include one or more <code>description</code> elements. If more than one description element is defined, the full description for the hAudio is the concatenation, in order, of all <code>description</code> elements.
* hAudio {{may}} include one or more <code>description</code> elements. If more than one description element is defined, the full description for the hAudio is the concatenation, in order, of all <code>description</code> elements.
 +
=== Parser Processing Notes ===
 +
* It is important to understand that ITEM is an opaque element. When processing the ITEM element, none of the properties of the child hAudio should be pulled into the parent hAudio. However, it is recommended that child hAudio {{should}} inherit the following parent hAudio properties, if they are not specified on the child:
 +
** album
 +
** contributor
 +
** category
 +
** published
 +
** photo
-
=== More Semantic Equivalents ===
+
=== Semantic XHTML Design Principles ===
 +
 
 +
{{semantic-xhtml-design-principles}}
 +
 
 +
==== More Semantic Equivalents ====
For some properties there is a more semantic equivalent, and therefore they get special treatment, e.g.:  
For some properties there is a more semantic equivalent, and therefore they get special treatment, e.g.:  
Line 220: Line 231:
* If only 'album' is specified, then the hAudio is an album.
* If only 'album' is specified, then the hAudio is an album.
* If only 'fn' is specified, then the hAudio is a song, audio track, sound effect, speech, or other atomic/singular work.
* If only 'fn' is specified, then the hAudio is a song, audio track, sound effect, speech, or other atomic/singular work.
-
* If both 'album' and 'fn' is specified, then the hAudio is a atomic/singular work that is part of an album.
+
* If both 'album' and 'fn' are specified, then the hAudio is a atomic/singular work that is part of an album.
 +
** Example: <code><nowiki><span class="haudio">Side two of <span class="album">Meddle</span> opens with <span class="fn">One of These Days</span></span></nowiki></code>
* If 'fn' and one or more 'items's are specified, the hAudio is an audio recording containing multiple sections. Each item is assumed to be an hAudio that is part of the parent hAudio.  None of the 'item' properties should implicitly be added to the containing hAudio. In other words, the parser shouldn't parse the contents of the 'item' into the higher-level hAudio object.
* If 'fn' and one or more 'items's are specified, the hAudio is an audio recording containing multiple sections. Each item is assumed to be an hAudio that is part of the parent hAudio.  None of the 'item' properties should implicitly be added to the containing hAudio. In other words, the parser shouldn't parse the contents of the 'item' into the higher-level hAudio object.
==== Language ====
==== Language ====
-
* To explicitly convey the natural language that an hAudio is written in, use the standard (X)HTML 'lang' attribute on the element with class="haudio", e.g. <code>&lt;div class="haudio" lang="en"&gt; ... &lt;/div&gt;</code> If portions of an hAudio (e.g. the item name) are in a different language, use the 'lang' attribute on those portions.
+
* To explicitly convey the natural language that an hAudio is written in, use the standard (X)HTML 'lang' or 'xml:lang' attribute on the element with class="haudio"
-
* hAudio processors which need to handle the language of reviews {{must}} process the standard (X)HTML 'lang' attribute as specified.
+
**e.g. <code><nowiki><p>I like <span class="haudio" lang="de"><span class="fn">Das Lied von der Erde</span></span> best.</p></nowiki></code>
 +
*If portions of an hAudio (e.g. the item name) are in a different language to the rest of the hAudio, use the 'lang' or 'xml:lang' attribute on those portions.
 +
* hAudio parsers which need to handle the native language of hAudio {{must}} process the standard (X)HTML 'lang' or 'xml:lang' attribute as specified.
 +
* hAudio parsers which need to handle native language {{may}} traverse up the DOM to discover the native language of the page and apply that to the hAudio if no other language is specified on the hAudio.
 +
 
 +
==== Human vs. Machine Readable ====
-
=== Human vs. Machine Readable ===
 
If an <code>&lt;abbr></code> element is used for a property, then its '<code>title</code>' attribute is used for the value of the property, instead of the contents of the element, which can then be used to provide a user-friendly alternate presentation of the value.  
If an <code>&lt;abbr></code> element is used for a property, then its '<code>title</code>' attribute is used for the value of the property, instead of the contents of the element, which can then be used to provide a user-friendly alternate presentation of the value.  
-
Similarly, if an <code><img /></code> element is used for one or more properties, it {{must}} be treated as follows:  
+
If an <code>&lt;a&gt;</code> element is used for one or more properties, it {{must}} be treated as follows:
 +
# For the 'photo' property and any other property that takes a URL as its value, the <code>href="..."</code> attribute provides the property value.
 +
# For other properties, the element's content is the value of the property.
-
# For the "photo" property and any other property that takes a URL as its value, the <code>src="..."</code> attribute provides the property value.  
+
If an <code>&lt;img&gt;</code> element is used for one or more properties, it {{must}} be treated as follows:
-
# For other properties, the <code><img /></code> element's '<code>alt</code>' attribute is the value of the property.
+
# For the 'photo' property and any other property that takes a URL as its value, the <code>src="..."</code> attribute provides the property value.
 +
# For other properties, the <code>&lt;img></code> element's '<code>alt</code>' attribute is the value of the property.
 +
 
 +
If an <code>&lt;object&gt;</code> element is used for one or more properties, it {{must}} be treated as follows:
 +
# For the 'photo' property and any other property that takes a URL as its value, the <code>data="..."</code> attribute provides the property value.
 +
# For other properties, the element's content is the value of the property.
=== Notes ===
=== Notes ===
Line 240: Line 263:
This section is informative.
This section is informative.
-
* By marking up audio content with the hAudio microformat, the expectation is communicated that information about the content {{may}} be indexed.  This has no impact on the copyright of the content itself which the publisher may explicitly specify using [[rel-license]] as specified above.
+
* By marking up audio content with the hAudio microformat, the expectation is communicated that information about the content {{may}} be indexed.  This has no impact on the copyright of the content itself which the publisher may explicitly specify using the [[rel-license]] microformat.
-
* The enumerated list of item types is under development and may be extended.
+
-
* Each type may have custom hAudio fields that follow the common set.
+
-
* Additional details about a particular item should be specified with the rest of the item's info at the URL provided for the item.
+
== XMDP Profile ==
== XMDP Profile ==
-
 
+
See: [[haudio-profile]].
-
<pre>
+
-
<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>.
+
-
  <dl>
+
-
  <dt>haudio</dt>
+
-
  <dd>
+
-
    Used to identify and describe metadata associated with an individual audio recording.
+
-
  </dd>
+
-
  <dt>fn</dt>
+
-
  <dd>
+
-
    A short textual description used to identify an audio recording among interested parties.
+
-
  </dd>
+
-
  <dt>album</dt>
+
-
  <dd>
+
-
    A short textual description used to identify an audio recording that is an album among
+
-
    interested parties.
+
-
  </dd>
+
-
  <dt>collaborator</dt>
+
-
  <dd>
+
-
    An entity that takes part in the creation and distribution of an audio recording.
+
-
  </dd>
+
-
  <dt>published</dt>
+
-
  <dd>
+
-
    The date that the audio recording was made available to the public.
+
-
  </dd>
+
-
  <dt>description</dt>
+
-
  <dd>
+
-
    A verbose description of the audio recording.
+
-
  </dd>
+
-
  <dt>photo</dt>
+
-
  <dd>
+
-
    An image that should be used to summarize the audio recording.
+
-
  </dd>
+
-
  <dt>category</dt>
+
-
  <dd>
+
-
    The genre or style used to classify the audio recording.
+
-
  </dd>
+
-
  <dt>duration</dt>
+
-
  <dd>
+
-
    The length of the audio recording.
+
-
  </dd>
+
-
  <dt>price</dt>
+
-
  <dd>
+
-
    The amount of currency that must be exchanged for acquisition of a full specimen of the audio recording.
+
-
  </dd>
+
-
</dd>
+
-
</dl>
+
-
</pre>
+
== Examples ==
== Examples ==
-
Here are a few examples of audio content from current web sites, and how they could be easily enhanced to support the hAudio audio metadata microformat. 
 
-
Want to write valid [[haudio|hAudio]]?  Use the [http://microformats.org/code/haudio/creator hAudio creator] (not implemented yet) to write about audio content and publish it on your blog.
+
This section is informative.
 +
 
 +
Here are a few examples of text about, and links to, audio content, from real web sites, showing how they could be easily enhanced to use hAudio.
 +
 
 +
<!-- Want to write valid [[haudio|hAudio]]?  Use the [http://microformats.org/code/haudio/creator hAudio creator] (not implemented yet) to write about audio content and publish it on your blog. -->
=== Simple Song Example ===
=== Simple Song Example ===
Line 312: Line 280:
Display:
Display:
-
Start Wearing Purple by Gogol Bordello
+
(This is a live example, detectable in parsers)
 +
 
 +
<div class="haudio">
 +
<span class="fn">Start Wearing Purple</span> by <span class="contributor">Gogol Bordello</span>
 +
</div>
Microformatted XHTML:
Microformatted XHTML:
Line 318: Line 290:
<pre>
<pre>
<div class="haudio">
<div class="haudio">
-
   <span class="audio-title">Start Wearing Purple</span> by  
+
   <span class="fn">Start Wearing Purple</span> by  
   <span class="contributor">Gogol Bordello</span>
   <span class="contributor">Gogol Bordello</span>
</div>
</div>
Line 324: Line 296:
=== Speech Example ===
=== Speech Example ===
 +
 +
(This is a live example, detectable in parsers)
Display:  
Display:  
-
I Have a Dream, a speech by Martin Luther King Jr.  
+
<div class="haudio">
 +
<span class="fn">I Have a Dream</span>, a <span class="category">speech</span> by <span class="contributor"><span class="vcard"><span class="fn n"><span class="given-name">Martin</span> <span class="additional-name">Luther</span> <span class="family-name">King</span>, <span class="honorific-suffix">Jr.</span></span></span></span>
 +
</div>  
Microformatted XHTML:
Microformatted XHTML:
<pre>  
<pre>  
<div class="haudio">  
<div class="haudio">  
-
   <span class="recording">I Have a Dream</span>, a  
+
   <span class="fn">I Have a Dream</span>, a  
   <span class="category">speech</span> by  
   <span class="category">speech</span> by  
-
   <div class="contributor">
+
   <span class="contributor">
-
       <div class="vcard">
+
       <span class="vcard">
-
         <span class="fn">Martin Luther King, Jr.</span>
+
         <span class="fn n">
-
       </div>
+
            <span class="given-name">Martin</span>
-
   </div>
+
            <span class="additional-name">Luther</span>
 +
            <span class="family-name">King</span>,
 +
            <span class="honorific-suffix">Jr.</span>
 +
        </span>
 +
       </span>
 +
   </span>
</div>  
</div>  
</pre>
</pre>
 +
 +
Note the use of [[hcard|hCard]].
=== Song and Album Example ===
=== Song and Album Example ===
 +
 +
(This is a live example, detectable in parsers)
Display:
Display:
-
Start Wearing Purple by Gogol Bordello found on Underdog World Strike
+
<div class="haudio">
 +
<span class="fn">Start Wearing Purple</span> by <span class="contributor"><span class="vcard"><span class="fn org">Gogol Bordello</span></span></span> found on <span class="album">Underdog World Strike</span>
 +
</div>
Microformatted XHTML:
Microformatted XHTML:
Line 352: Line 339:
<pre>
<pre>
<div class="haudio">
<div class="haudio">
-
   <span class="audio-title">Start Wearing Purple</span> by  
+
   <span class="fn">Start Wearing Purple</span> by  
-
   <div class="contributor">
+
   <span class="contributor">
-
      <div class="vcard">
+
        <span class="vcard">
-
        <span class="org fn">Gogol Bordello</span>
+
            <span class="fn org">Gogol Bordello</span>
-
      </div>
+
        </span>
-
  </div>
+
    </span>
   found on
   found on
-
   <span class="album-title">Underdog World Strike</span>
+
   <span class="album">Underdog World Strike</span>
</div>
</div>
</pre>
</pre>
 +
 +
Note that for bands, hCard's ''[[hcard#Implied_.22organization-name.22_Optimization|Implied "organization-name" Optimization]]'' is used.
=== Complete Album Example ===
=== Complete Album Example ===
Line 370: Line 359:
Released: October 31, 2002<br/>
Released: October 31, 2002<br/>
Acquire: Sample, Live Recording, Buy High Quality Track<br/>
Acquire: Sample, Live Recording, Buy High Quality Track<br/>
-
Category: Live<br/>
+
Category: [http://www.example.org/tags/live live]<br/>
Duration: 145 minutes, 27 seconds<br/>
Duration: 145 minutes, 27 seconds<br/>
Price: $14.99<br/>
Price: $14.99<br/>
Line 382: Line 371:
<pre>
<pre>
<div class="haudio">
<div class="haudio">
-
   <img class="photo" src="images/live_phish_vol_15.jpg"/>
+
   <img class="photo" src="images/live_phish_vol_15.jpg" alt="" />
-
   <span class="album-title">Live Phish, Volume 15</span>
+
   <span class="album">Live Phish, Volume 15</span>
   <span class="contributor">
   <span class="contributor">
       <span class="vcard">
       <span class="vcard">
Line 391: Line 380:
   <br/>
   <br/>
   Released on:
   Released on:
-
   <abbr class="published" title="20023110">October 31, 2002<abbr>
+
   <abbr class="published" title="2002-10-31">October 31, 2002</abbr>
   <br/>
   <br/>
   Acquire:  
   Acquire:  
Line 397: Line 386:
   <a rel="enclosure" href="/live/phish_live_phish_vol_15.mp3">Live Recording</a>,
   <a rel="enclosure" href="/live/phish_live_phish_vol_15.mp3">Live Recording</a>,
   <a rel="payment" href="/buy/phish_live_phish_vol_15">Buy High Quality Track</a>
   <a rel="payment" href="/buy/phish_live_phish_vol_15">Buy High Quality Track</a>
-
   Category: <span class="category">live</span>
+
   Category: <a class="category" rel="tag" href="http://www.example.org/tags/live">live</a>
-
   Duration: <abbr class="duration" title="PT8727S">145 minutes, 27 seconds</abbr>
+
   Duration: <abbr class="duration" title="PT145M27S">145 minutes, 27 seconds</abbr>
-
   Price: <span class="money">
+
   Price: <div class="price"><abbr class="currency" title="USD">$</abbr><span class="amount">14.99</span></div>
-
            <abbr class="currency" title="USD">$</abbr>
+
-
            <span class="amount">14.99</span>
+
-
          </span>
+
   Tracks:
   Tracks:
-
   <span class="track">
+
   <div class="item">
-
    <span class="haudio>
+
      <span class="position">1</span>.
-
    <span class="position">1</span>.
+
      <span class="fn">Sanity</span>
-
    <span class="audio-title">Sanity</span>  
+
      (<abbr class="duration" title="PT5M48S">5:48</abbr>)
-
    (<abbr class="duration" title="PT348S">5:48</abbr>)
+
     </div>
-
    </span>
+
     <div class="item">
-
     </span>
+
-
  </span>
+
-
     <span class="haudio>
+
     <span class="position">2</span>.
     <span class="position">2</span>.
-
     <span class="audio-title">Highway To Hell</span>  
+
     <span class="fn">Highway To Hell</span>  
-
     (<abbr class="duration" title="PT219S">3:39</abbr>)
+
     (<abbr class="duration" title="PT3M39S">3:39</abbr>)
-
    </span>
+
  </div>
-
    </span>
+
</div>
 +
</pre>
 +
 
 +
=== Multi-part Podcast Example ===
 +
 
 +
DigitalPlanet Podcast: 29 Oct 07
 +
 
 +
Forensic computing: is it really possible to delete data from your machine? Grand plans for getting broadband into Africa, checking out the sky at night via the internet and answering your emails to the programme.
 +
 
 +
Download MP3
 +
 
 +
<pre>
 +
<div class="haudio">
 +
<p>
 +
  <span class="fn">DigitalPlanet Podcast</span>
 +
  :
 +
  <abbr class="published" title="20071029">29 Oct 07</abbr>
 +
</p>
 +
<p>
 +
  <div class="item">
 +
      <span class="fn">Forensic computing: is it really possible to delete data from your machine?</span>
 +
  </div>
 +
  <div class="item">
 +
      <span class="fn">Grand plans for getting broadband into Africa</span>
 +
  </div>
 +
  ,
 +
  <div class="item">
 +
      <span class="fn">checking out the sky at night via the internet</span>
 +
  </div>
 +
  and
 +
  <div class="item">
 +
      <span class="fn">answering your emails</span>
 +
  </div>
 +
  to the programme.
 +
</p>
 +
<p>
 +
  <a rel="enclosure" href="/download/episode/DigitalPlanet-2007-10-29">Download MP3</a>
 +
</p>
 +
</div>
 +
</pre>
 +
 
 +
=== Opera Example ===
 +
 
 +
(This is a live example, detectable in parsers)
 +
 
 +
<div class="haudio" lang="en">
 +
<span class="fn" lang="fr">La Bohème</span> is an <span class="category">opera</span> in four acts by <span class="contributor" lang="it">Giacomo Puccini</span> to an <span class="category">Italian liberetto</span> by <span class="contributor" lang="it">Luigi Illica</span> and <span class="contributor" lang="it">Giuseppe Giacosais</span>. I saw it performed last week and found <span class="item"> <span class="fn">Act III</span> to be pretty interesting, especially the <span class="item"> "<span class="fn" lang="it">Sa dirmi, scusi</span>"</span> and <span class="item">"<span class="fn" lang="it">O buon Marcello, aiuto!</span>"</span> arias.</span>
 +
</div>
 +
 
 +
 
 +
<pre>
 +
<div class="haudio" lang="en">
 +
  <span class="fn" lang="fr">La Bohème</span>
 +
  is an
 +
  <span class="category">opera</span>
 +
  in four acts by
 +
  <span class="contributor" lang="it">Giacomo Puccini</span>
 +
  to an
 +
  <span class="category">Italian liberetto</span>
 +
  by
 +
  <span class="contributor" lang="it">Luigi Illica</span>
 +
  and
 +
  <span class="contributor" lang="it">Giuseppe Giacosais</span>.
 +
  I saw it performed last week and found
 +
  <span class="item">
 +
      <span class="fn">Act III</span>
 +
      to be pretty interesting, especially the
 +
      <span class="item">
 +
        "<span class="fn" lang="it">Sa dirmi, scusi</span>"
 +
      </span>
 +
      and
 +
      <span class="item">
 +
        "<span class="fn" lang="it">O buon Marcello, aiuto!</span>"
 +
      </span>
 +
      arias.
   </span>
   </span>
</div>
</div>
Line 425: Line 482:
This section is '''informative'''.
This section is '''informative'''.
 +
 +
* [http://en.wikipedia.org/wiki/Category:Articles_with_hAudio_microformats Wikipedia] has 119,555 songs and albums marked up in hAudio format.
 +
* [http://weborganics.co.uk/haudio-rss/ hAudio-RSS] uses hAudio 0.9.1 and XSLT to generate an RSS2 Playlist.
 +
* Tara Hunt of [http://openmediaweb.org/index.php/2008/01/13/publishing-my-workout-music-in-haudio/ Open Media Web] Published her workout Music in hAudio
 +
* Grabb.it The web music player now uses hAudio 0.9 in its [http://grabb.it/users/greg user pages]
 +
* [http://soundcloud.com/ SoundCloud] has hAudio in its pages.
 +
* [http://populizer.com/ Populizer] also has hAudio in its pages.
 +
* The [http://www.numblog.de/ New Urban Music Blog] has hAudio marked up in its pages.
 +
* [http://alpha.libre.fm/ Libre.fm] has marked up on all its user pages in hAudio see : [http://alpha.libre.fm/user/weborganics example]
== Implementations ==
== Implementations ==
 +
This section is '''informative'''.  
This section is '''informative'''.  
-
See [[haudio-implementations|hAudio Implementations]].
+
*[http://weborganics.co.uk/files/js/haudio.js hAudio 0.9 script] for [[operator|Operator]], updated version of the original hAudio script by David Lehn.
 +
* Matthias Pfefferle has made some [http://notizblog.org/projects/haudio-icons/ hAudio Icons]
 +
* [http://microform.at/ Microformat TransFormr] extracts hAudio 0.9.1 as a RSS2 Podcast.
 +
* [http://buzzword.org.uk/cognition/ Cognition] 0.1-&alpha;11 and above will parse hAudio 0.9 and export as RDF/XML or RDF/JSON. As of 0.1-&alpha;12, it will also export in M3U playlist format and Turtle.
 +
* [http://weborganics.co.uk/mo-haudio/ hAudio Microformat to RDF Music Ontology], a [http://www.w3.org/TR/grddl/ GRDDL] profile for hAudio 0.9.1, producing [http://musicontology.com/ Music Ontology] RDF.
 +
* The [http://singpolyma.net/plugins/actionstream/ wp-diso-actionstream] plugin produces hAudio for last.fm scrobbles
 +
*...
 +
<!--
 +
See [[haudio-implementations|hAudio Implementations]].  
 +
link not needed until section has become too large for this page (per previous specs)
 +
-->
== References ==
== References ==
Line 436: Line 513:
* [http://gmpg.org/xmdp/ XMDP]
* [http://gmpg.org/xmdp/ XMDP]
* [[hcard|hCard]]
* [[hcard|hCard]]
 +
* [[abbr-design-pattern]]
 +
* [[currency-proposal]]
 +
* [[datetime-design-pattern]]
 +
* [[rel-design-pattern]]
 +
* [[ISO-31-1|ISO-31-1/ISQ]]
=== Informative References ===
=== Informative References ===
Line 446: Line 528:
==== Similar Work ====
==== Similar Work ====
-
* [[media-info-examples]]
+
* [[media-info]]
-
* [[media-info-formats]]
+
* [[grouping-examples]]
* [[grouping-examples]]
* [[grouping-brainstorming]]
* [[grouping-brainstorming]]
Line 454: Line 535:
=== Copyright ===
=== Copyright ===
-
This document and specification was placed into the public domain on July 25th, 2007 by the authors. There are no usage, distribution, re-printing, or any other restrictions of any kind with regards to the text or content of this specification.
+
This document and <span class="vevent"><span class="summary">hAudio specification was placed into the public domain</span> on <span class="dtstart">2008-11-14</span></span> by the authors. There are no usage, distribution, re-printing, or any other restrictions of any kind with regards to the text or content of this specification.
=== Patents ===
=== Patents ===
-
The authors of this Microformat have not and will not apply for patents covering any invention covering this Microformat in part or as a whole. There are no claims to any patent in this document. Each author is required to report any known patent issues immediately under this section.
+
{{MicroFormatPatentStatement}}
-
 
+
-
This document and specification is distributed under a royalty free patent policy, e.g. per the W3C Patent Policy (http://www.w3.org/Consortium/Patent-Policy-20040205/), and IETF RFC3667 (http://www.ietf.org/rfc/rfc3667.txt) & RFC3668 (http://www.ietf.org/rfc/rfc3668.txt).
+
=== Public Domain Release ===
=== Public Domain Release ===
Line 474: Line 553:
== Work in progress ==
== Work in progress ==
This specification is a work in progress. As additional aspects are discussed, understood, and written, they will be added.  
This specification is a work in progress. As additional aspects are discussed, understood, and written, they will be added.  
-
 
-
== Further Reading ==
 
-
 
-
=== Mailing List Discussion ===
 
-
 
-
* Renewed interest in audio-info Microformat
 
-
** http://microformats.org/discuss/mail/microformats-new/2007-March/000028.html
 
-
** http://microformats.org/discuss/mail/microformats-new/2007-April/000096.html
 
-
* Proposed solution to split media-info into audio, video and images
 
-
** http://microformats.org/discuss/mail/microformats-new/2007-April/000143.html
 
-
* Failed proposal to re-use hReview/hAtom
 
-
** http://microformats.org/discuss/mail/microformats-new/2007-April/000138.html
 
-
* Requirement to define collections for audio-info
 
-
** http://microformats.org/discuss/mail/microformats-new/2007-April/000183.html
 
-
* First attempt at hAudio proposal
 
-
** http://microformats.org/discuss/mail/microformats-new/2007-May/000252.html
 
-
* First attempt at hAudio proposal (continued)
 
-
** http://microformats.org/discuss/mail/microformats-new/2007-May/000305.html
 
-
* hAtom is not a silver bullet
 
-
** http://microformats.org/discuss/mail/microformats-new/2007-May/000316.html
 
-
* Second attempt at hAudio
 
-
** http://microformats.org/discuss/mail/microformats-new/2007-May/000329.html
 
-
* hAudio 'acquire' re-naming
 
-
** http://microformats.org/discuss/mail/microformats-new/2007-May/000338.html
 
-
* An argument against 'fn' in hAudio
 
-
** http://microformats.org/discuss/mail/microformats-new/2007-May/000342.html
 
-
* hAudio Test
 
-
** http://microformats.org/discuss/mail/microformats-new/2007-May/000377.html
 
-
* hAudio - audio-album and audio-podcast
 
-
** http://microformats.org/discuss/mail/microformats-new/2007-May/000442.html
 
-
* hAudio: relevant UIDs
 
-
** http://microformats.org/discuss/mail/microformats-new/2007-June/000491.html
 
-
* Sound optimization for hAudio
 
-
** http://microformats.org/discuss/mail/microformats-new/2007-June/000450.html
 
-
* XOXO + Playlist problem
 
-
** http://microformats.org/discuss/mail/microformats-new/2007-June/000482.html
 
-
* Reusing class names in multiple formats
 
-
** http://microformats.org/discuss/mail/microformats-new/2007-June/000525.html
 
-
* audio-title proposal for hAudio
 
-
** http://microformats.org/discuss/mail/microformats-new/2007-June/000549.html
 
-
 
-
=== Specification Development Statistics ===
 
-
 
-
* Number of examples reviewed: 185
 
-
* Total examples analyzed: 105
 
-
* Days of development from concept to first draft: 129
 
-
* Estimated hours of work by primary investigator on hAudio: 320
 
-
* Estimated combined work hours by mailing list: 170
 
-
* Total estimated hours of work to produce hAudio draft: 490
 
-
* Estimated cost to develop based on $65,000/year salary: $16,600
 
== Related Pages ==
== Related Pages ==
{{haudio-related-pages}}
{{haudio-related-pages}}
 +
* [[audio]] (other pages about Audio on this wiki)
 +
 +
[[Category:Draft Specifications]]

Current revision

This document represents a draft microformat specification. Although drafts are somewhat mature in the development process, the stability of this document cannot be guaranteed, and implementers should be prepared to keep abreast of future developments and changes. Watch this wiki page, or follow discussions on the #microformats Freenode IRC channel to stay up-to-date.

Contents

604867362_da0921136a_o.png

hAudio is a simple, open, distributed format, suitable for embedding information about audio recordings in (X)HTML, Atom, RSS, and arbitrary XML. hAudio is one of several microformats open standards. This page and Microformat is in the public domain.

hAudio Microformat Draft Specification

Editors

Authors

Contributors

Manu Sporny, Martin McEvoy , Alexandre Van De Sande , Michael Johnson, Dave Longley, Brian Suda, Ben Wiley Sittler, Scott Reynen, Frances Berriman, James Craig, David Janes, Andy Mabbett, Danny Ayers, Rudy Desjardins, Theresa O'Connor, Ryan King, Chris Griego, Brad Hafichuk, Tantek Çelik, Colin Barrett, Joe Andrieu, Michael Smethurst, Chris Newell, Julian Stahnke, Justin Maxwell, Paul Wilkins and David I. Lehn.

Microformats #Copyright and #Patents statements apply.

Introduction

It is difficult for a browser to extract semantic information about an audio recording described on a web page. Metadata such as speaker, musician, publisher, label, title of the work, release date, acquisition link, related image artwork and tags provide relevant context for the audio recording.

Having such information marked up can provide a number of benefits to the viewer. If a web browser understands that a particular web page contains a song performed by an artist, it can produce richer interactions. For example, specific searches may be performed for artists and songs via general search services such as Google and Wikipedia. Specific search services may also be queried such as MusicBrainz, The Internet Archive, FreeDB, or Bitmunk. Additionally, classification by crawlers can become more accurate. If there are 20 tracks found on a page done by the same artist, and that content consumes a significant portion of the page, it can be assumed that the page is not only about music, but also about a particular artist.

In order to enable and encourage the sharing, distribution, syndication, and aggregation of audio content, the authors propose the hAudio microformat, an open standard for distributed audio metadata. The authors have researched both numerous audio-info-examples in the wild and earlier attempts at audio-info-formats, and have designed hAudio around a simple minimal schema for audio content. Feedback is encouraged on the hAudio feedback page.

Inspiration and Acknowledgments

Many thanks to the various individuals that did research and proposed ideas and discussion related to media info and audio info in general. Among the many participants are RodBegbie, Dean Hudson, Tantek Çelik, Mary Hodder, Joshua Kinberg, ChrisMessina, and Lisa Rein.

Scope

Audio content consistently share several common fields. Where possible hAudio has been based on this minimal common subset.

Out of scope

Fields that are type-specific have been omitted from hAudio. It is important that hAudio be kept simple and minimal from the start. Additional features can be added as deemed necessary by practical implementation experience.

The concept of a universal audio identifier, that is, how to identify the same audio album, song, speech, or podcast across different music and audio sites, though something very useful to have, is outside the scope of this format.

Format

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.

In General

The hAudio format is based on a set of fields common to numerous audio content sites and formats in use today on the web. Where possible field names have been chosen based on those defined by the related hCard standards.

Schema

The hAudio schema consists of the following:

Field details

The fields of the hAudio schema represent the following:

hAudio

An hAudio is used to identify and describe metadata associated with an audio recording.

fn

The name of a single audio recording is a short textual description used to identify the work among interested parties. This can be the name of a speech, song name, or short description regarding a sound effect.

Album

The title of a collection of audio recordings, such as those that are represented as a CD, album or LP. The text should be a short textual description used to identify the work among interested parties.

Item

A container for another hAudio item, which MUST be considered a part of the parent audio recording. An example of an item that is part of an hAudio would be a track in an audio album, a aria in an Opera, or a section of a podcast.

Position

The position is used to describe the position of the hAudio item in a list. Examples of hAudio lists can include album track listings, music top 10 lists, playlists, and podcast chapters.

Contributor

A Contributor is any entity that takes part in the creation and distribution of an audio recording. Examples include: artist, composer, publisher, guitarist, vocalist, violinist, lead singer, backup singer, bassist, drummer, manager, and roadie.

Published

The published date specifies the date that the audio recording was made available to the public. Examples include: The airing date of a radio broadcast, the day a speech was given, or the day a music album was made available for sale.

Sample

A Sample URI specifies from where an excerpt of the audio recording may be retrieved.

Full Download (Enclosure)

A Full Download URI specifies from where the full version of an audio recording may be retrieved. The URI MUST point to a direct link to a file retrieval process (FTP, HTTP, BitTorrent URI, etc).

Purchase (Payment)

A Purchase URI specifies from where the full version of an audio recording may be purchased. The URI MUST point to the beginning of a purchase process for the hAudio.

Photo

A photo specifies an image that should be used to summarize the audio recording. Examples include: the image of a speaker, an audio album cover image, or a picture from a concert.

Category

The Category specifies the genre or style used to classify the audio recording. Examples include: blues, rock, motivational, spoken word, or sound effect.

Duration

The Duration specifies the length in time of the audio recording. Examples include: 104 seconds, 3:23, and 4 minutes.

Example:

<span class="duration">
<span class="h">1</span>:
 <span class="min">3</span>:
 <span class="s">23</span>
</span>

Price

The Price specifies the amount of currency that must be exchanged for acquisition of a full specimen of the audio recording.

Example:

<span class="price">
	<abbr class="currency" title="GBP">£</abbr> 
	<span class="amount">4.99</span>
</span>

Description

An explanation of the contents of the hAudio item. This could explain the significance of a speech, the full-text description of a sound effect, or the meaning of a song or album.

Parser Processing Notes

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

More Semantic Equivalents

For some properties there is a more semantic equivalent, and therefore they get special treatment, e.g.:

Language

Human vs. Machine Readable

If an <abbr> element is used for a property, then its 'title' attribute is used for the value of the property, instead of the contents of the element, which can then be used to provide a user-friendly alternate presentation of the value.

If an <a> element is used for one or more properties, it MUST be treated as follows:

  1. For the 'photo' property and any other property that takes a URL as its value, the href="..." attribute provides the property value.
  2. For other properties, the element's content is the value of the property.

If an <img> element is used for one or more properties, it MUST be treated as follows:

  1. For the 'photo' property and any other property that takes a URL as its value, the src="..." attribute provides the property value.
  2. For other properties, the <img> element's 'alt' attribute is the value of the property.

If an <object> element is used for one or more properties, it MUST be treated as follows:

  1. For the 'photo' property and any other property that takes a URL as its value, the data="..." attribute provides the property value.
  2. For other properties, the element's content is the value of the property.

Notes

This section is informative.

XMDP Profile

See: haudio-profile.

Examples

This section is informative.

Here are a few examples of text about, and links to, audio content, from real web sites, showing how they could be easily enhanced to use hAudio.


Simple Song Example

Display:

(This is a live example, detectable in parsers)

Start Wearing Purple by Gogol Bordello

Microformatted XHTML:

<div class="haudio">
   <span class="fn">Start Wearing Purple</span> by 
   <span class="contributor">Gogol Bordello</span>
</div>

Speech Example

(This is a live example, detectable in parsers)

Display:

I Have a Dream, a speech by Martin Luther King, Jr.

Microformatted XHTML:

	 
<div class="haudio">	 
   <span class="fn">I Have a Dream</span>, a 	 
   <span class="category">speech</span> by 	 
   <span class="contributor">
      <span class="vcard">
         <span class="fn n">
            <span class="given-name">Martin</span>
            <span class="additional-name">Luther</span>
            <span class="family-name">King</span>,
            <span class="honorific-suffix">Jr.</span>
         </span>
      </span>
   </span>
</div>	 

Note the use of hCard.

Song and Album Example

(This is a live example, detectable in parsers)

Display:

Start Wearing Purple by Gogol Bordello found on Underdog World Strike

Microformatted XHTML:

<div class="haudio">
   <span class="fn">Start Wearing Purple</span> by 
   <span class="contributor">
        <span class="vcard">
            <span class="fn org">Gogol Bordello</span>
        </span>
    </span>
   found on
   <span class="album">Underdog World Strike</span>
</div>

Note that for bands, hCard's Implied "organization-name" Optimization is used.

Complete Album Example

An example that uses every element of hAudio:

[Image] Live Phish, Volume 15 by Phish
Released: October 31, 2002
Acquire: Sample, Live Recording, Buy High Quality Track
Category: live
Duration: 145 minutes, 27 seconds
Price: $14.99

Tracks:
1. Sanity (5:48)
2. Highway To Hell (3:39)

Here is the hAudio Microformat markup:

<div class="haudio">
   <img class="photo" src="images/live_phish_vol_15.jpg" alt="" />
   <span class="album">Live Phish, Volume 15</span>
   <span class="contributor">
      <span class="vcard">
         <span class="fn org">Phish</span>
      </span>
   </span>
   <br/>
   Released on:
   <abbr class="published" title="2002-10-31">October 31, 2002</abbr>
   <br/>
   Acquire: 
   <a rel="sample" href="/samples/live_phish_vol_15_sample.mp3">Sample</a>, 
   <a rel="enclosure" href="/live/phish_live_phish_vol_15.mp3">Live Recording</a>,
   <a rel="payment" href="/buy/phish_live_phish_vol_15">Buy High Quality Track</a>
   Category: <a class="category" rel="tag" href="http://www.example.org/tags/live">live</a>
   Duration: <abbr class="duration" title="PT145M27S">145 minutes, 27 seconds</abbr>
   Price: <div class="price"><abbr class="currency" title="USD">$</abbr><span class="amount">14.99</span></div>
   Tracks:
   <div class="item">
      <span class="position">1</span>.
      <span class="fn">Sanity</span>
      (<abbr class="duration" title="PT5M48S">5:48</abbr>)
    </div>
    <div class="item">
     <span class="position">2</span>.
     <span class="fn">Highway To Hell</span> 
     (<abbr class="duration" title="PT3M39S">3:39</abbr>)
  </div>
</div>

Multi-part Podcast Example

DigitalPlanet Podcast: 29 Oct 07

Forensic computing: is it really possible to delete data from your machine? Grand plans for getting broadband into Africa, checking out the sky at night via the internet and answering your emails to the programme.

Download MP3

<div class="haudio">
<p>
   <span class="fn">DigitalPlanet Podcast</span>
   :
   <abbr class="published" title="20071029">29 Oct 07</abbr>
</p>
<p>
   <div class="item">
      <span class="fn">Forensic computing: is it really possible to delete data from your machine?</span>
   </div>
   <div class="item">
      <span class="fn">Grand plans for getting broadband into Africa</span>
   </div>
   , 
   <div class="item">
      <span class="fn">checking out the sky at night via the internet</span>
   </div> 
   and 
   <div class="item">
      <span class="fn">answering your emails</span>
   </div>
   to the programme.
</p>
<p>
   <a rel="enclosure" href="/download/episode/DigitalPlanet-2007-10-29">Download MP3</a>
</p>
</div>

Opera Example

(This is a live example, detectable in parsers)

La Bohème is an opera in four acts by Giacomo Puccini to an Italian liberetto by Luigi Illica and Giuseppe Giacosais. I saw it performed last week and found Act III to be pretty interesting, especially the "Sa dirmi, scusi" and "O buon Marcello, aiuto!" arias.


<div class="haudio" lang="en">
   <span class="fn" lang="fr">La Bohème</span> 
   is an 
   <span class="category">opera</span> 
   in four acts by 
   <span class="contributor" lang="it">Giacomo Puccini</span>
   to an 
   <span class="category">Italian liberetto</span>
   by
   <span class="contributor" lang="it">Luigi Illica</span>
   and
   <span class="contributor" lang="it">Giuseppe Giacosais</span>.
   I saw it performed last week and found
   <span class="item">
      <span class="fn">Act III</span>
       to be pretty interesting, especially the
      <span class="item">
         "<span class="fn" lang="it">Sa dirmi, scusi</span>"
      </span>
      and
      <span class="item">
         "<span class="fn" lang="it">O buon Marcello, aiuto!</span>"
      </span>
      arias.
   </span>
</div>

Examples in the wild

This section is informative.

Implementations

This section is informative.

References

Normative References

Informative References

Similar Work

Copyright

This document and hAudio specification was placed into the public domain on 2008-11-14 by the authors. There are no usage, distribution, re-printing, or any other restrictions of any kind with regards to the text or content of this specification.

Patents

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

Public Domain Release

The authors and editors of this page due hereby relinquish their copyright on the document and release the text of this page into the public domain.

Work in progress

This specification is a work in progress. As additional aspects are discussed, understood, and written, they will be added.

Related Pages

Categories

hAudio 0.9.1 was last modified: Thursday, June 21st, 2018

Views