haudio-issues

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.

issues

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.

• You can subscribe to all haudio issues on webcal://feeds.technorati.com/events/http://microformats.org/wiki/haudio-issues

2008

D1: 2008-01-10 Contributor

• resolved issue D1: 2008-01-10 raised by Andy Mabbett in microformats-discuss/2008-January/011340.html

• 1. the wording about contributor could be improved to facilitate more streamlined mark-up (see above e-mail for details).
     • A resolution to this issue is outlined in this email http://microformats.org/discuss/mail/microformats-new/2008-August/001725.html
     • RESOLVED ISSUE The hAudio Contributor Specification is to be changed to:
       • The element is identified by the class name |contributor|.
       • hAudio /MAY/ include one or more contributors.
       • The contributor's name SHOULD also be marked up as a valid hCard Microformat. <http://microformats.org/wiki/hcard>
         1. The |role| attribute /SHOULD/ be used to specify the contributor's responsibility related to the audio recording if hCard is utilized.
       • The contributor's name MAY be specified in plain-text without being enclosed in a hCard Microformat.
     • REMOVED:
       • If multiple contributors are specified, without |role| specifications, it /MAY/ be assumed that the first role mentioned is the primary artist or creator.
         1. As proposed By Manu Sporny in http://microformats.org/discuss/mail/microformats-new/2008-August/001725.html

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

• open issue! D2: 2008-01-10 raised by Andy Mabbett in [1]

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
   • +1 Martin McEvoy
   • +1 Manu Sporny
4. Resoulution 3: Use "audio-title" As tentatively proposed by Manu Sporny see:microformats-new/2008-August/001692.html
5. Don't really care — just pick one. ;-)
   • +1 TobyInk

D3: 2008-01-10 Position.

• resolved issue D3: 2008-01-10 raised by Andy Mabbett in microformats-discuss/2008-January/011343.html

• 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 [2] 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)
     • RESOLVED 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:
       • The sequential identifier /MAY/ be specified out-of-sequence.
         1. As proposed By Manu Sporny in http://microformats.org/discuss/mail/microformats-new/2008-August/001708.html
     • 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 importance 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

• resolved issue D4: 2008-01-10 raised by Andy Mabbett in microformats-discuss/2008-January/011344.html

• 1. The required use of rel-enclosure does not allow for links to streaming files, which are not cacheable, and are thus outside the scope of rel-enclosure. An example on the BBC website has the relevant link is below the heading "LISTEN AGAIN". (see discussion at microformats-new/2008-January/001339.html et seq).
     • A proposal for this issue was first made in this email http://microformats.org/discuss/mail/microformats-new/2008-August/001715.html
     • A second proposal for this issue has been made in this email http://microformats.org/discuss/mail/microformats-new/2008-August/001727.html
     • This can potentially be solved by recognition of downloadable/streamable MIME types. For performance reasons it is undesirable for parsers to be required to make HTTP requests for each file to determine its MIME type, so authors should be encouraged to include the MIME type in the type attribute. See the related section on "brainstorming". TobyInk 14:41, 20 Aug 2008 (PDT)
     • RESOLVED ISSUE The hAudio Enclosure Specification is to be changed to:
       • The element is identified by a URI fitting the rel-design-pattern, the rel content being enclosure.
       • hAudio MAY include one or more enclosure URIs.
       • The type of the file SHOULD be specified by using the type specifier for a URI.
     • CHANGED:
       • The type of the file MAY be specified by using the type specifier for a URI.
         • As suggested by Tantek Çelik in this email http://microformats.org/discuss/mail/microformats-new/2008-August/001731.html
         • As Proposed by Toby Inkster on 14:41, 20 Aug 2008 (PDT)
     • A tutorial on the importance of Type Specifiers and hAudio Enclosures is to be added to the hAudio Authoring Page

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

• open issue! D5: 2008-01-10 raised by Andy Mabbett in microformats-discuss/2008-January/011344.html

• 1. 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 [3].

D6: 2008-01-10 hAudio notes inconsistency

• resolved issue D6: 2008-01-10 raised by Andy Mabbett in microformats-discuss/2008-January/011345.html

• 1. The "Notes" section of the hAudio spec says "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.". However, that is the first and only reference to rel-license on the page.
     • Typing error changed to "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". [4]
     • hAudio Specification SHOULD include the rel-license microformat Martin McEvoy 11:57, 18 Aug 2008 (GMT)
     • A proposed resolution to this issue has been made in this email http://microformats.org/discuss/mail/microformats-new/2008-August/001720.html
  2. RESOLVED rel="licence" is not part of this version of hAudio (0.9) see:http://microformats.org/discuss/mail/microformats-new/2008-August/001747.html

template

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">
{{OpenIssue}} 
<span class="entry-summary author vcard">
 <span class="published">2011-MM-DD</span> 
 raised by <span class="fn">~~~</span>
</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
</div>
</div>

see also

• audio-info-issues

related pages

• hAudio
• hAudio cheatsheet - hAudio properties.
• hAudio authoring - learn how to add hAudio markup to your existing web pages.
• hAudio issues - issues with the specification.
  • Audio info issues - issues with the preparatory work.
• hAudio brainstorming - ideas for the specification.
• hAudio-history - the history of the research and development of hAudio.