From Microformats Wiki
Jump to navigation Jump to search

hAudio issues

These are externally raised issues about hAudio with broadly varying degrees of merit. Thus some issues are rejected for a number of obvious reasons (but still documented here in case they are re-raised), and others contain longer discussions. Some issues may be accepted and perhaps cause changes or improved explanations in the spec.

Submitted issues may (and probably will) be edited and rewritten for better terseness, clarity, calmness, rationality, and as neutral a point of view as possible.


Please add new issues to the bottom of the list by copy and pasting the Template. Please follow-up to resolved/rejected issues with new information rather than resubmitting such issues. Duplicate issue additions will be reverted.


D1: 2008-01-10 Contributor

    1. the wording about contributor could be improved to facilitate more streamlined mark-up (see above e-mail for details).

D2: 2008-01-10 hAudio Title was Overloading "fn".

The "overloading" of fn for both the tile of a work and the name of a contributor causes problems (see above e-mail for examples). Another example of this problem is a table, where the "artist" column comes before the "title" column. For discussion, see also microformats-new/2008-January/001375.html.

  1. Existing Resolution Manu Sporny has propsosed that "fn" should be replaced with "title" see: microformats-new/2008-February/001468.html
  2. Resolution 1: Martin McEvoy proposed change "title" to "name" see: microformats-new/2008-March/001555.html
  3. Resolution 2: Martin McEvoy later propsosed that "title" should be replaced with "htitle" see: microformats-new/2008-August/001692.html
  4. Resolution 3: Use "audio-title" As tentatively proposed by Manu Sporny see:microformats-new/2008-August/001692.html
  5. Resolution 4: Change "title" back to "fn" see: [2]
  6. Don't really care — just pick one. ;-)

D3: 2008-01-10 Position.

    1. The recommended use of "position" in hAudio is contrary to the good practice, semantic use of ordered lists (see example and suggested solution in the above e-mail; also [3] et seq)
      • For Cognition I'm considering an extension: if no position has been explicitly marked up, and the item is <li class="item"> within an ordered list, then the position is taken to be the numerical value of the list marker. (To calculate the numerical value for the list marker, find the most recent sibling <li> element which has a value attribute. The numerical value is the number in that value attribute added to the count of <li> elements after that value attribute up to the current one. If there are no such <li> elements with value attributes, then you should assume that the value attribute of the first list item is equal to the start attribute of the ordered list itself, or "1" if there is no such start attribute. TobyInk 04:24, 29 Jul 2008 (PDT)
      • A Proposed Resolution was made in this email: ( http://microformats.org/discuss/mail/microformats-new/2008-August/001751.html)
      • ACCEPTED ISSUE The hAudio Position Specification is to be changed to:
        • The element is identified by the class name |position|.
        • hAudio /MAY/ include one |position| element.
        • The contents of the element /MUST/ be a number or other sequential identifier.
        • The sequential identifier /MAY/ be specified out-of-sequence.
      • ADDED:
      • Andy Mabbett also Expressed concerns that the Complete Album Example should be marked up as an ordered list this is unnecessary as "position" is not related to the order of a track item in a list.
      • A tutorial on the correct use of semantic ordered lists and hAudio is to be added to the hAudio Authoring Page

D4: 2008-01-10 rel-enclosure does not allow for links to streaming files

D5: 2008-01-10 there is no way of linking to an interim page

There appears to be no mechanism to mark up an hAudio, expressed in plain text on page A, which links to an interim page, B, which in turn links to a file download. For example, the radio shows listed on [4].

  1. Resolution 1: re use "url" from hCard.
  2. Resolution 2: use the rel "bookmark" HTML Link Type.

D6: 2008-01-10 hAudio notes inconsistency


D7: 2009-01-11 Endorsement of optimization patterns in schema listing too strong

  • resolved issue D7: 2009-01-11 raised by Ben Ward.

The hAudio spec schema makes references to multiple optimization patterns (datetime pattern for published, abbr-pattern for duration). It is currently worded as to imply that those patterns must be used. Given past disagreement over ABBR in particular, I think the spec should avoid specific endorsement of any pattern, at the very least reducing references to patterns to clear ‘You may use the abbr-pattern with this field' sort of phrasing.

  1. Resolution 1: Reword schema listing to use may language clearly.
    • RESOLUTION: The schema now uses may language more clearly

D8: 2009-01-11 Don't link to currency proposal

  • resolved issue D8: 2009-01-11 raised by Ben Ward.

The hAudio spec schema makes reference to the currency proposal. Since that is still a proposal, the spec should not endorse it or encourage too-early adoption of it, especially since it's not even a draft at this stage. Should the currency work be completed, hAudio should be updated later, rather than linking it in pre-emptively.

  1. Resolution 1: Remove reference to currency proposal from hAudio schema.
    • RESOLUTION: The hAudio no longer references the currency proposal, only cites it as an Informative reference at the bottom of the page.


D9: 2010-06-11 hAudio duration and published should adopt the value-title pattern

hAudio Duration and Published should adopt the value-title pattern like hRecipe Duration and hAtom, to prevent the user from getting machine data in a tooltip.


<span class="duration">
  3 minutes 33 seconds
  <span class="value-title" title="PT3M33S">.</span>


<span class="published">
  February 06, 2007
  <span class="value-title" title="2007-02-06">.</span>
  1. Resolution 1: Adopt the value-title pattern for both hAudio Duration and Published.


D10: 2012-02-13 hAudio sample and enclosure should support HTML5 audio

hAudio Sample and hAudio Enclosure currently only support links to the audio files. Using the HTML5 audio tag it would be possible to embed the audio file directly in the page. The "sample" and "enclosure" markup would then be used as classes of the audio element.


<audio class="sample" src="sample.mp3" controls/>

Or when specifying a fallback list of audio files:

<audio class="enclosure" controls>
  <source type="audio/ogg" src="song.ogg"/>
  <source type="audio/mp4" src="song.m4a"/>
  <source type="audio/mpeg" src="song.mp3"/>
  1. Resolution 1: Support "sample" and "enclosure" as classes of HTML5 audio elements.

D11: 2012-04-30 Add start time field

In our application we are using hAudio to represent tracks within an hour-long radio show. Although the duration field is useful, we'd also like a start-time field. This would handle situations where there is speech between tracks, so the actual duration of the track does not correspond to the time when the next track begins.


Consider using this format (copy and paste this to the end of the list to add your issues; replace ~~~ with an external link if preferred) to report issues or feedback, so that issues can show up in hAtom subscriptions of this issues page. If open issues lack this markup, please add it.

Please post one issue per entry, to make them easier to manage. Avoid combining multiple issues into single reports, as this can confuse or muddle feedback, and puts a burden of separating the discrete issues onto someone else who 1. may not have the time, and 2. may not understand the issue in the same way as the original reporter.

<div class="hentry">
<span class="entry-summary author vcard">
 <span class="published">2011-MM-DD</span> 
 raised by <span class="fn">~~~</span>
<div class="entry-content discussion issues">
* <strong class="entry-title">«Short title of issue»</strong>. «Description of Issue»
** Follow-up comment #1
** Follow-up comment #2

see also

related pages