audio-album-proposal - Revision history

ManuSporny: /* Complete Example */

2007-09-09T14:11:27Z

Complete Example

← Older revision		Revision as of 14:11, 9 September 2007
Line 331:		Line 331:
	<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: <span class="category">live</span>
	Duration: <abbr class="duration" title="~~8727~~">145 minutes, 27 seconds</abbr>		Duration: <abbr class="duration" title="P8727S">145 minutes, 27 seconds</abbr>
	Price: <span class="money">		Price: <span class="money">
	<abbr class="currency" title="USD">$</abbr>		<abbr class="currency" title="USD">$</abbr>
Line 340:		Line 340:
	<span class="haudio>		<span class="haudio>
	<span class="audio-title">Sanity</span>		<span class="audio-title">Sanity</span>
	(<abbr class="duration" title="~~348~~">5:48</abbr>)		(<abbr class="duration" title="P348S">5:48</abbr>)
	</span>		</span>
	</span>		</span>
Line 347:		Line 347:
	<span class="haudio>		<span class="haudio>
	<span class="audio-title">Highway To Hell</span>		<span class="audio-title">Highway To Hell</span>
	(<abbr class="duration" title="~~219~~">3:39</abbr>)		(<abbr class="duration" title="P219S">3:39</abbr>)
	</span>		</span>
	</span>		</span>

SenorPantalones: Added myself to contributors list

2007-08-30T17:07:10Z

Added myself to contributors list

← Older revision		Revision as of 17:07, 30 August 2007
Line 16:		Line 16:
	: Rudy Desjardins		: Rudy Desjardins
	: Joe Andrieu		: Joe Andrieu
			: [[ user:SenorPantalones \| Justin Maxwell ]]

	Microformats [[#Copyright]] and [[#Patents]] statements apply.		Microformats [[#Copyright]] and [[#Patents]] statements apply.

ManuSporny: Added Various Artists Album Example

2007-08-08T15:41:50Z

Added Various Artists Album Example

@@ Line 347: / Line 347: @@
       <span class="audio-title">Highway To Hell</span>
       (<abbr class="duration" title="219">3:39</abbr>)
       </span>
      </span>

ManuSporny: Adding track to complete example

2007-08-06T03:52:28Z

Adding track to complete example

@@ Line 305: / Line 305: @@
 Duration: 145 minutes, 27 seconds<br/>
 Price: $14.99<br/>
 Here is the hAlbum Microformat markup:
@@ Line 331: / Line 335: @@
               <span class="amount">14.99</span>
            </span>
 </div>
 </pre>

ManuSporny: Adding moderately complicated album example to examples section

2007-08-06T03:46:44Z

Adding moderately complicated album example to examples section

@@ Line 261: / Line 261: @@
 <pre>
 <div class="halbum">
     <span class="album-title">Underdog World Strike</span> by
     <div class="collaborator">

ManuSporny: Adding Track specification

2007-08-06T03:44:19Z

Adding Track specification

← Older revision		Revision as of 03:44, 6 August 2007
Line 159:		Line 159:
	* hAlbum MAY include one or more <code>price</code> elements.		* hAlbum MAY include one or more <code>price</code> elements.
	* The contents of the element SHOULD use the [[currency-proposal]].		* The contents of the element SHOULD use the [[currency-proposal]].

			==== Track ====

			The Track specifies details for a specific track that can be found on the album. hAudio should be used to describe the track.

			* The element is identified by the class name <code>track</code>.
			* hAlbum MAY include one or more <code>track</code> elements.
			* The contents of the element SHOULD use the [[hAudio]] Microformat.

	=== More Semantic Equivalents ===		=== More Semantic Equivalents ===

ManuSporny: /* Schema */ - changed hAlbum to hAudio

2007-08-06T03:42:32Z

Schema: - changed hAlbum to hAudio

← Older revision		Revision as of 03:42, 6 August 2007
Line 58:		Line 58:
	* hAlbum ('''<code>halbum</code>''')		* hAlbum ('''<code>halbum</code>''')
	** '''album-title''' required. text.		** '''album-title''' required. text.
	** '''contributor'''. optional. using [[hCard]]. Re-used from [[~~hAlbum~~]].		** '''contributor'''. optional. using [[hCard]]. Re-used from [[hAudio]].
	** '''published'''. optional. using [[datetime-design-pattern]]. Re-used from [[hAtom]]		** '''published'''. optional. using [[datetime-design-pattern]]. Re-used from [[hAtom]]
	** '''rel-sample'''. optional. sample file/stream using [[rel-design-pattern]] with <code>sample</code> as the <code>mf-rel-value</code>. Re-used from [[~~hAlbum~~]].		** '''rel-sample'''. optional. sample file/stream using [[rel-design-pattern]] with <code>sample</code> as the <code>mf-rel-value</code>. Re-used from [[hAudio]].
	** '''rel-enclosure'''. optional. full download of file using [[rel-enclosure]]. Re-used from [[~~hAlbum~~]].		** '''rel-enclosure'''. optional. full download of file using [[rel-enclosure]]. Re-used from [[hAudio]].
	** '''rel-payment'''. optional. link to purchase process using [[rel-payment]]. Re-used from [[~~hAlbum~~]].		** '''rel-payment'''. optional. link to purchase process using [[rel-payment]]. Re-used from [[hAudio]].
	** '''photo'''. optional. using HTML and XHTML tag <code>img</code>. Re-used from [[hReview]].		** '''photo'''. optional. using HTML and XHTML tag <code>img</code>. Re-used from [[hReview]].
	** '''category'''. optional. text.		** '''category'''. optional. text.
	** '''duration'''. optional. ISO-8601 time duration using [[abbr-design-pattern]] (re-used from [[hcalendar]]).		** '''duration'''. optional. ISO-8601 time duration using [[abbr-design-pattern]] (re-used from [[hcalendar]]).
	** '''price'''. optional. using [[currency-proposal]]. Re-used from [[~~hAlbum~~]].		** '''price'''. optional. using [[currency-proposal]]. Re-used from [[hAudio]].
	** '''track'''. optional. using [[hAudio]].		** '''track'''. optional. using [[hAudio]].

ManuSporny: Schema - adding 'track' property

2007-08-06T03:41:47Z

Schema - adding 'track' property

← Older revision		Revision as of 03:41, 6 August 2007
Line 67:		Line 67:
	** '''duration'''. optional. ISO-8601 time duration using [[abbr-design-pattern]] (re-used from [[hcalendar]]).		** '''duration'''. optional. ISO-8601 time duration using [[abbr-design-pattern]] (re-used from [[hcalendar]]).
	** '''price'''. optional. using [[currency-proposal]]. Re-used from [[hAlbum]].		** '''price'''. optional. using [[currency-proposal]]. Re-used from [[hAlbum]].
			** '''track'''. optional. using [[hAudio]].

	=== Field details ===		=== Field details ===

ManuSporny: Creating audio-album-proposal page

2007-08-06T03:39:49Z

Creating audio-album-proposal page

New page

<h1>hAlbum 0.1</h1>

[[halbum|hAlbum]] is a simple, open, distributed format, suitable for embedding information about audio albums in (X)HTML, Atom, RSS, and arbitrary XML. hAlbum is one of several [[microformats]] open standards.

== hAlbum Microformat Draft Specification ==

; Editor: [[User:ManuSporny | Manu Sporny]], [http://www.bitmunk.com/ Bitmunk] - [http://blog.digitalbazaar.com Digital Bazaar], Inc.
; Contributors: [[User:ManuSporny | Manu Sporny]], [http://www.bitmunk.com/ Bitmunk] - [http://blog.digitalbazaar.com Digital Bazaar], Inc.
: [[ user:WebOrganics | Martin McEvoy ]]
: [[ User:AlexandreVandeSande | Alexandre Van De Sande ]] Releases all his contribution as public domain(see user page)
: Michael Johnson
: Dave Longley
: Brian Suda
: Scott Reynen
: Andy Mabbett
: Rudy Desjardins
: Joe Andrieu

Microformats [[#Copyright]] and [[#Patents]] statements apply.

__TOC__

== Introduction ==

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

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 an album 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 4 albums 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 albums, the authors propose the hAlbum microformat, an open standard for distributed audio album metadata. The authors have researched both numerous [[audio-info-examples]] in the wild and earlier attempts at [[audio-info-formats]], and have designed hAlbum around a simple minimal schema for audio content. Feedback is encouraged on the [[audio-album-feedback|hAlbum 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, [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].

=== Scope ===

Audio content consistently share several common fields. Where possible hAlbum has been based on this minimal common subset, heavily re-using properties discovered in the [[audio-info-proposal|hAlbum Microformat]].

==== Out of scope ====

Fields that are type-specific have been omitted from hAlbum. It is important that hAlbum 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 across different music and audio sites, though something very useful to have, is outside the scope of this format.

== Semantic XHTML Design Principles ==

{{semantic-xhtml-design-principles}}

== Format ==

=== In General ===
The hAlbum 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 re-used from hCard, hReview, hAtom, and hAlbum.

=== Schema ===

The hAlbum schema consists of the following:

* hAlbum ('''<code>halbum</code>''')
** '''album-title''' required. text.
** '''contributor'''. optional. using [[hCard]]. Re-used from [[hAlbum]].
** '''published'''. optional. using [[datetime-design-pattern]]. Re-used from [[hAtom]]
** '''rel-sample'''. optional. sample file/stream using [[rel-design-pattern]] with <code>sample</code> as the <code>mf-rel-value</code>. Re-used from [[hAlbum]].
** '''rel-enclosure'''. optional. full download of file using [[rel-enclosure]]. Re-used from [[hAlbum]].
** '''rel-payment'''. optional. link to purchase process using [[rel-payment]]. Re-used from [[hAlbum]].
** '''photo'''. optional. using HTML and XHTML tag <code>img</code>. Re-used from [[hReview]].
** '''category'''. optional. text.
** '''duration'''. optional. ISO-8601 time duration using [[abbr-design-pattern]] (re-used from [[hcalendar]]).
** '''price'''. optional. using [[currency-proposal]]. Re-used from [[hAlbum]].

=== Field details ===

The fields of the hAlbum schema represent the following:

==== hAlbum ====

An hAlbum is used to identify and describe metadata associated with a collection of audio albums.

* an hAlbum element is identified by class name <code>halbum</code>

==== Album Title ====

The album title of an audio album is a short textual description used to identify the work among interested parties. This is usually the title of the album.

* The element is identified by the class name <code>album-title</code>.
* hAlbum MUST have an album title.

==== Contributor ====

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

* The element is identified by the class name <code>contributor</code>.
* hAlbum MAY include one or more contributors.
* The contents of the element must include a valid [[hCard]] Microformat.
* The <code>role</code> field should be used to specify the Contributor's responsibility related to the audio album.
* If multiple Contributors are specified without <code>role</code> specifications, it may be assumed that the first role mentioned is the artist.

==== Published Date ====

The Published Date specifies the date that the audio album 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.

* The element is identified by the class name <code>published-date</code>.
* hAlbum MAY include one or more <code>published-date</code>s.
* The contents of the element must include a date format compliant with the [[datetime-design-pattern]].

==== Sample ====

A Sample URL specifies from where an excerpt of the audio album may be retrieved.

* The element is identified by a URL fitting the [[rel-design-pattern]], the rel content being <code>sample</code>.
* hAlbum MAY include one or more URL <code>sample</code>s.
* The URL 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.

==== Full Download (Enclosure) ====

An Full Download URL specifies from where the full version of an audio album may be retrieved. The URL MUST point to a direct link to a file.

* The element is identified by a URL fitting the [[rel-design-pattern]], the rel content being <code>enclosure</code>.
* hAlbum MAY include one or more <code>enclosure</code> URLs.
* The type of the file MAY be specified by using the <code>type</code> specifier for a URL.

==== Purchase (Payment) ====

An Purchase URL specifies from where the full version of an audio album may be purchased. The URL MUST point to a page that contains a purchase process.

* The element is identified by a URL fitting the [[rel-design-pattern]], the rel content being <code>payment</code>.
* hAlbum MAY include one or more <code>payment</code> URLs.
* The type of the file MAY be specified by using the <code>type</code> specifier for a URL.

==== Photo ====

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

* The element is identified by the class name <code>photo</code>.
* hAlbum MAY include one or more <code>photo</code> images.
* The element must be an <img> element.

==== Category ====

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

* The element is identified by the class name <code>category</code>.
* hAlbum MAY include one or more <code>category</code> elements.

==== Duration ====

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

* The element is identified by the class name <code>duration</code>.
* hAlbum 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, specifically in seconds. This allows us to expand into specifying time slices and other time markup in the future, but keep parsing simple for now. An example of 3:23 (203 seconds) would be "P203S" in ISO 8601 format. Currently, all abbr attributes specifying duration SHOULD be in seconds.

==== Price ====

The Price specifies the amount of currency that must be exchanged for acquisition of a full specimen of the audio album. Examples include: One Dollar, $2, and £4.

* The element is identified by the class name <code>price</code>.
* hAlbum MAY include one or more <code>price</code> elements.
* The contents of the element SHOULD use the [[currency-proposal]].

=== More Semantic Equivalents ===

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

* For any "url", use <code><a class="url" href="...">...</a></code> inside the element with the class name 'halbum' in hAlbum.
* And for "image-summary", use <code><img class="image-summary" src="..." alt="Photo of ..." /></code>

==== Language ====

* To explicitly convey the natural language that an hAlbum is written in, use the standard (X)HTML 'lang' attribute on the element with class="halbum", e.g. <code><div class="halbum" lang="en"> ... </div></code> If portions of an hAlbum (e.g. the item name) are in a different language, use the 'lang' attribute on those portions.
* hAlbum processors which need to handle the language of reviews MUST process the standard (X)HTML 'lang' attribute as specified.

=== Human vs. Machine Readable ===
If an <code><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:

# For the "image-summary" 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><img /></code> element's '<code>alt</code>' attribute is the value of the property.

=== Notes ===

This section is informative.

* By marking up audio content with the hAlbum 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.
* The enumerated list of item types is under development and may be extended.
* Each type may have custom hAlbum 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 ==

<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>halbum</dt>
<dd>
Used to identify and describe metadata associated with an individual audio album.
</dd>
<dt>album-title</dt>
<dd>
A short textual description used to identify an audio album among interested parties.
</dd>
<dt>collaborator</dt>
<dd>
An entity that takes part in the creation and distribution of an audio album.
</dd>
<dt>published</dt>
<dd>
The date that the audio album was made available to the public.
</dd>
<dt>photo</dt>
<dd>
An image that should be used to summarize the audio album.
</dd>
<dt>category</dt>
<dd>
The genre or style used to classify the audio album.
</dd>
<dt>duration</dt>
<dd>
The length of the audio album.
</dd>
<dt>price</dt>
<dd>
The amount of currency that must be exchanged for acquisition of a full specimen of the audio album.
</dd>
</dd>
</dl>
</pre>

== Examples ==
Here are a few examples of audio content from current web sites, and how they could be easily enhanced to support the hAlbum metadata microformat.

Want to write valid [[halbum|hAlbum]]? Use the [http://microformats.org/code/halbum/creator hAlbum creator] (not implemented yet) to write about audio content and publish it on your blog.

=== Simple Album Example ===

Display:

Underdog World Strike by Gogol Bordello

Microformatted XHTML:

<pre>
<div class="halbum">
<span class="album-title">Underdog World Strike</span> by
<div class="collaborator">
<div class="vcard">
<span class="org fn">Gogol Bordello</span>
</div>
</div>
</div>
</pre>

=== Complete Example ===

An example that uses every element of halbum:

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

Here is the hAlbum Microformat markup:

<pre>
<div class="halbum">
<img class="photo" src="images/live_phish_vol_15.jpg"/>
<span class="album-title">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="20023110">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: <span class="category">live</span>
Duration: <abbr class="duration" title="8727">145 minutes, 27 seconds</abbr>
Price: <span class="money">
<abbr class="currency" title="USD">$</abbr>
<span class="amount">14.99</span>
</span>
</div>
</pre>

== Examples in the wild ==

This section is '''informative'''.

== Implementations ==
This section is '''informative'''.

See [[halbum-implementations|hAlbum Implementations]].

== References ==
=== Normative References ===
* [http://www.w3.org/TR/2002/REC-xhtml1-20020801/ XHTML 1.0 SE]
* [http://gmpg.org/xmdp/ XMDP]
* [[hcard|hCard]]

=== Informative References ===
* [http://www.w3.org/TR/REC-CSS1 CSS1]
* ISO.8601.1988
** International Organization for Standardization, "Data elements and interchange formats - Information interchange - Representation of dates and times", ISO Standard 8601, June 1988.
* [http://www.w3.org/TR/1998/NOTE-datetime-19980827 W3C NOTE-datetime-19980827]
* [http://www.w3.org/Consortium/Patent-Policy-20040205/ W3C Patent Policy]
* Other audio metadata efforts. See [[audio-info-formats]].

==== Similar Work ====
* [[media-info-examples]]
* [[media-info-formats]]
* [[grouping-examples]]
* [[grouping-brainstorming]]

=== Copyright ===

This document and specification was placed into the public domain on August 5th, 2007.

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

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

== Work in progress ==
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 hAlbum: 420
* Estimated combined work hours by mailing list: 270
* Total estimated hours of work to produce halbum draft: 690
* Estimated cost to develop based on $65,000/year salary: $25,600

== Related Pages ==
{{halbum-related-pages}}