issues

<entry-title> Microformat Issues </entry-title>

These are externally raised issues about microformats in general.

Some issues may be ACCEPTED and perhaps cause changes or improved explanations in one or more specifications or microformats in general. Some issues may be REJECTED for a variety of brief reasons, and others contain longer discussions.

As this is a general microformats issues page, please only note concrete real world issues. Theoretical issues may be deleted, as will any issues raised that do not contain documentation of specific real-world examples that use real-world microformats (not just brainstorms).

Please be sure that an issue applies to more than one microformat or pattern, otherwise the issue should be raised on the format/pattern specific issues page. Please check issues-resolved and issues-closed to first see if your issue has a resolution.

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. Write your issues well. — Tantek

Closed Issues

Resolved issues that have no further actions to take.

• See issues-closed

Resolved Issues

Resolved issues that have outstanding to-do items.

• See issues-resolved

Issues

opened 2006

open issue! 2006-05-11 FAQ by Brian Suda, expanded/reraised by Tantek

• why does hCard use "vcard" as the root class or hCalendar use "vevent"?
  • Originally partly an FAQ written by Brian Suda, this slight inconsistency between the name of the format and the name of the root class name consistently causes confusion in a large percentage of newcomers to microformats. - Tantek
    • Looks like a typo (just one letter difference)
    • Cognitive dissonance: saying "use hCard" but implying use "vcard" class name, or the implication causing one to just say "use vcard", e.g. Kyle Weems:

      I always end up saying "vcard" instead of "hcard" because I never write "hcard" in the code. It's weird having "two" formats that are 1:1.

    • Ambiguity in discussions, e.g. put "vcard" in your HTML - meaning, class name, or a link to a .vcf file?
    • Cognitive load: extra bit of information to remember when marking up a microformat
    • in contrast to hReview, hListing, hRecipe, etc. which all have root class name same as name of microformat (albeit lowercased, however some publishers have used the 2nd-letter-uppercase version as the root class name, e.g. class="hReview", enough for Google's rich snippet parsers to liberally accept it, so those could be improved as well.).
  • Though in microformats we believe very strongly in the principle of reuse, we have to admit that in this case experience/evidence has shown that this may be a case where we re-used something too far beyond it's original meaning. Or perhaps we errantly called two slightly different things by the same name.
    • ACCEPTED PROPOSED RESOLUTION. In microformats-2, all vocabularies are named the same as their root class names, e.g. "h-card", "h-event", "h-entry" etc. - Tantek

opened 2010

Issues opened/raised in 2010.

open issue! 2010-08-24 raised by Wim, expanded by Tantek

• microformats classes like 'url' or 'region' already in use. "Using class for the microformat markup is clearly a problem, in part because it’s so easy to overlap with other markup. Authors use classes like “url” or “region” all the time, and might not be aware of the hCard format. All sorts of markup might look like a microformat."
  • There has also been an anecdotal report of a design firm who was not (yet) familiar with microformats seeing the "extra" classes that "that don't seem to be used" (without corresponding CSS rules) and asking if they "can remove them". By making microformats class names different from generic words, authors unfamiliar with microformats may at least notice such distinction and infer special functionality accordingly. - Tantek
  • ACCEPTED. Pretty sure this was raised before, in IRC/lists elsewhere, but this URL was the earliest one I could find to capture it. - Tantek
  • 2011-10-26 confirmed by Richard Vaughan:
    • "... Microformats can screw with existing CSS rules. ..."
  • and follow-up same day also:
    • "microformats are the easiest as it's just CSS classes, but may be a pain to implement if those class names are already used."
  • See also Beware of microformats/CSS naming collisions section in http://knol.google.com/k/google-rich-snippets-tips-and-tricks (no edit history, date unknown, found 2011-350)
  • ACCEPTED. PROPOSED RESOLUTION. We are fixing this with microformats-2, all property names have prefixes to avoid such collisions. E.g. 'url' becomes 'u-url' and 'region' becomes 'p-region'. See microformats 2: h-card properties for more. - Tantek

opened 2011

Issues opened/raised in 2011.

• ...

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>

Format Specific Issues

Please raise format specific issues on their respective page(s):

• hatom-issues
• hcard-issues
  • representative-hcard-issues
• hcalendar-issues
• hlisting-issues
• hresume-issues
• hreview-issues
• rel-issues
  • rel-home-issues
  • rel-license-issues
• vote-links-issues
• xfn-issues
• xfolk-issues
• xmdp-issues
• xoxo-issues
  • xoxo-opml-issues

Issues regarding microformats in progress (brainstorms etc.) are documented on their respective pages.

Pattern Specific Issues

Please raise pattern specific issues on the respective page:

• abbr-design-pattern-issues
  • accessibility-issues#abbr-design-pattern.
• include-pattern-issues
• etc.

Domain Specific Issues

• accessibility-issues
• code-issues
• external-issues
• tests-issues

See also

• accessibility
• criticism
• wiki-feedback
• The microformats FAQ, which answers many general criticisms/ issues that have been raised with microformats.