Difference between revisions of "faq"
(→Microformats and Spam: rewrite to tak account of mailing list comment byPatrick H. Lauke (Jul 2 15:20:06 PDT 2007))
(→Microformats and Spam: sp.)
|Line 231:||Line 231:|
===''Q. Given that Google now looks at hidden content as potential spam, will invisible microformats be considered spam?''===
===''Q. Given that Google now looks at hidden content as potential spam, will invisible microformats be considered spam?''===
A. No. Although it is advisable not to hide information in your site, regardless of whether it is
A. No. Although it is advisable not to hide information in your site, regardless of whether it is or not, Google do not attempt to parse the complex interplay of CSS and (X)HTML for each page to determine if content is somehow hidden. If somebody reports a page to Google, their team investigates it (as in the case of BMW in Germany, for example). There's human judgement involved, and not an automated "hidden = spam" algorithm. That said, microformats provide a mechanism for marking up ''visible'' content. Avoid invisible (meta)data. Publish visible data.
== Design Patterns with Abbr & Title ==
== Design Patterns with Abbr & Title ==
Revision as of 18:26, 3 July 2007
If you're looking for a microformat for marking up FAQs, see question-answer-brainstorming.
- 1 Microformats FAQ
- 1.1 Wiki specific questions
- 1.2 Email list
- 1.3 Basic Microformat Questions
- 1.3.1 Q: What does xxx mean?"
- 1.3.2 Q: When should I use a microformat? What are they for?"
- 1.3.3 Q: Are microformats dependent upon (X)HTML?
- 1.3.4 Q: Microformats sound great. How can I help?
- 1.3.5 Q: I'd like to make a donation to the microformat cause. How can I do this?
- 1.3.6 Q: Which microformats have been implemented?
- 1.3.7 Q: Which microformats should I implement?
- 1.3.8 Q: Do you have any link badges I can add to my website/blog?
- 1.3.9 Q. Are there any tools that support microformats?
- 1.3.10 Q. Is there a way to indicate that a given web page contains markup that conforms to one or more microformats?
- 1.3.11 Q. What about using new URI schemes instead of class names, e.g. for geo information?
- 1.3.12 Q: Who controls microformats?
- 1.3.13 Q: Who is the registrar for microformats?
- 1.3.14 Q: So multiple microformats with the same name can be valid?
- 1.3.15 Q: How do I validate my microformated content?
- 1.3.16 Q: How do microformats breach language barriers?
- 1.3.17 Q: How come microformats sometimes to linger as Drafts even though they seem usable?
- 1.4 Creating and Suggesting New Microformats
- 1.5 Specific Microformat Questions
- 1.6 Class interactions
- 1.7 <div> and <span> semantics
- 1.8 Class semantics
- 1.9 Microformats and Spam
- 1.10 Design Patterns with Abbr & Title
- 1.11 Nesting of elements
Wiki specific questions
Q: How do I create a username? Why won't it let me use my preferred username?
A: First, read this: http://en.wikipedia.org/wiki/Wikipedia:Username . Second, real names are preferred to pseudonyms/handles etc. Real names encourage better transparency and accountability. Third, the most common problem creating a user name is forgetting to capitalize the first letter of the user name. Try using a WikiCase version of your full name as username, e.g. RyanKing.
Q: I've joined the discussion mailing list but am not seeing my replies anywhere. Why?
A: There is no moderation on microformats-discuss, but it only accepts posts from subscribers. You MUST post to microformats-discuss using the email address you used to subscribe.
Q: What does "The message's content type was not explicitly allowed" mean?
A: Please go read mailinglists-policies. In particular note:
No HTML or RTF e-mail period, end of story, full stop. Your mail client should let you configure it so you can send plain text messages. Make use of this ability or else there are no guarantees that anyone will be able to read your email.
The mailing lists are set up to automatically reject email that is sent as text/html. Thus please configure your email client to send plain text (text/plain) email.
Basic Microformat Questions
Q: What does xxx mean?"
A: See our glossary.
Q: When should I use a microformat? What are they for?"
A: You are writing some HTML that contains useful human-readable information (such as a piece of contact information). You say to yourself: I would like to mark this up with some classes now for styling. You look up the relevant microformat, and you pull in the standard names. You don't have to make your own up, and now your page is machine-readable too. Bonus!
Microformats are designed to make the data you already publish for humans available to machines. It allows applications as simple as cut-and-paste or as complex as a seach engine to use your data effectively.
Q: Are microformats dependent upon (X)HTML?
A: Microformats are made to be embeddable. They can be embedded in (X)HTML, RSS, Atom or anywhere (X)HTML is allowed.
Q: Microformats sound great. How can I help?
Q: I'd like to make a donation to the microformat cause. How can I do this?
A: Thank you for your willingness to support microformats. We've only recently started this site and have decided that while we are figuring out exactly how to accept donations, we will be passing along donations to other good causes. Please consider donating to another cause like Red Cross, perhaps directed to help victims of recent natural disasters.
Q: Which microformats have been implemented?
A: See the Microformats Implementations page.
Q: Which microformats should I implement?
A: Chances are you that your website already has data very similar to several microformats. For example, you probably have people and/or their contact information somewhere. That information could be marked up with hCard, see the hCard authoring page for step by step instructions. If you are publishing press releases, try using hAtom.
A: There are some Microformats Buttons but we can certainly use more! Please contribute what you come up with!
Q. Are there any tools that support microformats?
A. Yes...tons... Microformats Implementations.
Q. Is there a way to indicate that a given web page contains markup that conforms to one or more microformats?
A. The HTML HEAD element's '
profile' attribute alerts applications to the potential presence of microformats. The W3C HTML Specification describes more about the profile attribute, and the XMDP description documents how it is used.
Q. What about using new URI schemes instead of class names, e.g. for geo information?
A. In general, it is more work, and less content-publisher friendly, to ask publishers to use URI schemes instead of class names.
Authors aren't publishing links to geo information.
They're publishing *visible text* of Geo information.
So the easiest thing to do, for the author, is to leave it as visible text.
Thus, it makes the most sense to do the simple thing of just wrapping that visible text with a little bit of markup, rather than asking the author to move (or copy) it into an attribute, which may or may not require a reformatting of the data as well.
It would make sense from a usability persepective to hyperlink geo information to a maps page or something, so that clicking it actually does something. If you forced them to use a hypothetical "geo:" protocol instead, then that would interfere, since you can only hyperlink something to one destination.
Q: Who controls microformats?
A: An open community. Microformats are open standards licensed under Creative Commons Attribution. Much of the work here was begun on Technorati's Developer Wiki, but Technorati has since divested control of these microformat standards to the open community here. The microformats.org domain is registered to Rohit Khare (see Whois microformats.org), CommerceNet is graciously hosting the servers, but claims no control over microformat standards. Anyone may follow the established The microformats process and contribute towards the development of microformat standards.
Any required governance of the microformats IRC channel, wiki, and mailing lists (and very little has been required) is discussed by a group of volunteer administrators, who are listed on that page.
Q: Who is the registrar for microformats?
A: There is no central registry. Microformats are registered in a distributed manner using profiles. For more information on profiles see http://microformats.org/wiki/profile-uris and http://gmpg.org/xmdp/
Conflicts and interoperability are managed through social processes rather than a formal registry. Current microformat profiles can be found at http://gmpg.org, http://w3.org, and http://microformats.org.
Q: So multiple microformats with the same name can be valid?
A: Yes. The community at microformats.org can hopefully play a role in determining which is preferred by bringing interested folks together in one place and helping them resolve that question. As long as each microformat maintains a valid profile, each can be used effectively.
Q: How do I validate my microformated content?
A: Currently there is no automatic general-purpose validator for microformats (See To Do - for all microformats). There are however some microformat-specific tools listed on the Microformats Implementations page which can help with validation. Operator does a good job of compliant parsing for microformats in general. For hCard, try the Technorati Contacts Feed service. For hCalendar, try the Technorati Events Feed service. Also, posting your examples to the microformats-discuss mailing list, and adding them to the respective examples/implementations sections/pages will very often get folks from the community to review and validate them for you.
Q: How do microformats breach language barriers?
Would we have to "force" non-English speaking web page developers to use something like class="name" (as opposed to "namen" or "nom") for their productions to be properly indexed by agents?
A: Yes, but that's no different to using English words like "class", "span" or "head". This was briefly discussed on the microformats-discuss list most recently as "Language Maps" but has been raised before that. Some folks have raised the issue that microformats use English names for properties, and they would like alternate (non-English) names in other (natural) languages, and perhaps try to establish a mapping between them. As microformats property names are based on existing standards (see The microformats process, and Naming Principles), this is another problem that is far outside the scope of microformats. As Ryan King put it, this is a pre-existing (unsolved) "problem" with English-based HTML, the English-based CSS, the English-based HTTP and so on. Note that this is NOT about the internationalization of the content and data itself - which is of course an excellent goal, advocated and promoted by microformats and the standards they are based on (e.g. W3C, IETF). This is purely about the names of the properties (and enumerated values) in the formats. See also Internationalization.
Q: How come microformats sometimes to linger as Drafts even though they seem usable?
A: Tantek went over this at the recent The Growth and Evolution of Microformats panel at SXSW. He conveyed that it was important to have a basic software implementation -- even an experimental one -- before moving a format from Draft to Specification. It can sometimes be hard to recognize subtle inconsistencies within a format by eye; however, in the process of implementing a format-reader in code, inconsistencies (if any) can become much more noticeable (due to DRY / Don't Repeat Yourself, among other programming best practices). Then, once such a tool has been created (in effect, confirming the programmability of the format), it can be transitioned to a Specification (so as to encourage other machine-based implementations).
Creating and Suggesting New Microformats
A. The first thing to do before attempting a new microformat open standard is to make as much use of existing microformats open standards as possible in whatever site you are looking to mark up with your new microformat, as a way of learning what is left to be done. That is, at a minimum first:
- Mark up all people and organizations as hCards.
- Mark up all events and time based things as hCalendar events.
- Mark up all reviews as hReviews.
Then join the microformats discuss list, and ask folks what they think of your use of the microformats and if it can be improved.
From that experience you will then be able to figure out what is left to be specified. Otherwise it is too hard to approach the "whole problem".
Once you have completed that, take a look at the microformats The microformats process for how to walk through the steps of creating a new microformat, and note the specific problem you are trying to solve to the microformats-discuss list. This will help you find more people to help you solve the problems you are trying to solve.
Q How do I know if an idea for a Microformat has already been suggested in the past?
A. Check the list of proposed and rejected microformats.
Q. What if I can't find real-world examples of a standard I'd like to propose?
A. If we can't find real-world examples of the types of data a proposal would address, it's probably not suitable for a microformat. If we only can't find real-world examples of the specific markup a proposal would use for that data, however, that's not really a problem. It's actually the lack of such standard markup in real-world publishing around a specific problem that suggests the need for increased consensus.
Specific Microformat Questions
If you have a question regarding a specific microformat, you may want to check the FAQ specific to that microformat.
- hAtom FAQ
- hCard FAQ
Q. Are there issues with page styling when specific class values are used?
A. There might be. However, any such issues can be easily (trivially) worked around by using contextual selectors.
Q. How does the use of class values for semantics interact with the use of class values for attaching CSS styles?
A. The class attribute takes a space separated set of class names HTML4 reference. Thus both author and microformat defined class names may be used in the same class attribute. In addition, microformat class names provide the author with a consistent set of class names to use for styling. If the author is already using using specific class names, they can continue to do so, and include microformat class names. If the author is already using a class name that happens to also be a microformat class name, then the author may want to consider using contextual CSS class selectors to make sure that avoid any unintentional styling effects.
- A Touch Of Class
- Class For Meaning Not For Show
- Competant Classing, by Eric Meyer for discussion of choosing class names in (X)HTML
- Class attributes are about more than styling - Ryan King dispells common misconceptions about the HTML class attribute.
Q. Is it semantically meaningless to use divs?
A. Yes, both
<span> have nearly no semantics.
<div> can be used to represent a "division" of the page content. Similarly
<span> can be used to reperesent that that "span" of text has some meaning, but the specifics of what that meaning is undefined by the
Q. Does the use of
<span> elements add any semantics to web pages?
A. According to the HTML 4 spec,
<span> "offer a generic mechanism for adding structure to documents." Their only meaning is in dividing documents into sections, and as such, their presence implies that the content within has a specific, but undefined by the element markup, semantic. Thus they are nearly semantic-free.
Q. Why do the examples on the wiki use
<div> for nearly everything?
<div> are generic elements in HTML. When you use microformats, you should pick the most specific semantic element available for the semantics you are trying to express. You might, for example, apply
class="vevent" to a
class="vcard" to a
Q. How will microformat class names impact page size?
A. You probably won't notice any impact on page size when authoring with microformats. Our experience is that people use comparably sized class names, and semantic class names are now considered an industry best practice. Some sites are successfully publishing millions of microformats, and we haven't heard any complaints yet. You are more likely to gain space savings by more fully adopting the principles of microformats, and eliminating tables for layout. TODO: Consider creating a new section for web authoring tips? Or at least linking to another site that advocates good authorship.
Q. Can an element have more than one class
A. Yes, the class attribute can contain a space delimited list of classes. For example:
<p class="todo idea">Write high quality and simple mark-up.</p>
See W3C HTML 4.01 Specification: 7.5.2 Element identifiers: the id and class attributes
Q. Do (X)HTML class names have semantics?
A. The HTML4 specification does not define any particular class values REF, nor does it define any particular semantic for class values REF, except that they "may be used for general user agent processing" REF. However, the " draft of "Hypertext Links in HTML", allows for a "profile" to define meanings for those classes. XMDP is a format for defining meta data profiles for (X)HTML, and thus an XMDP profile can be used to define the meanings of class names.
Q. I thought one of the main goals of CSS was to separate data from presentation. Isn’t this sneaking presentation back into data?
A. This is a quite commonly expressed objection to the way microformats uses class, but it's based on a misunderstanding of the way the class attribute in HTML was designed. Yes, class is very commonly,and appropriately used by web designers in conjunction with CSS to style pages, and in truth, it is often overused for that, but despite this, class, according to the HTML specification "has several roles in HTML", including "for general purpose processing by user agents".
Microformats utilize this second aspect of the class (and id) attribute, and do so legitimately. It is not an abuse of the class or id attribute to use it to add semantic context to a document. Nor is the use of class in and of itself presentational - in fact, it is an important mechanism for separating presentation from structured content.
For some more on using class semantically, here are some articles
- Competent Classing by Eric Meyer
- Use class with semantics in mind, W3C
- More about the class attribute, Tantek Çelik
Microformats and Spam
A. No. Although it is advisable not to hide information in your site, regardless of whether it is microformatted or not, Google do not attempt to parse the complex interplay of CSS and (X)HTML for each page to determine if content is somehow hidden. If somebody reports a page to Google, their team investigates it (as in the case of BMW in Germany, for example). There's human judgement involved, and not an automated "hidden = spam" algorithm. That said, microformats provide a mechanism for marking up visible content. Avoid invisible (meta)data. Publish visible data.
Design Patterns with Abbr & Title
Q. Why is ABBR being used when the title attribute is available on all HTML elements?
In the datetime design pattern the title attribute is used for the value of the property and the node value is used as the display value. <abbr title="value-here">Display-Here</abbr>.
A. The short answer is that <abbr> has the correct semantics.
The longer answer is that the value is often an abbreviated version of the formal value. Of course, if you don't want to use an <abbr>, you can use another element like this:
<abbr title="2006-12-31T12:59:59Z" class="dtstamp">New Year</abbr>
In addition, microformats encourage the content to be visible and thus prefer the text of an element rather than using the 'title' attribute or any other less visible alternative. The exception is made for datetimes and abbr due to the fact that microformats are for humans first, machines second. Thus the content of the abbr element is used to provide human visible content and the machine equivalent is placed in the less visible (but still easily verifiable) 'title' attribute.
Nesting of elements
Q. It seems that
<span class="vcard fn org" id="club">...</span> should work. Is this correct?
A. No. See