public
Description: Microformats Helper is a plugin for generating content-rich tags in HTML files, following Microformats standards. For more information about Microformats, check its website (http://microformats.org).
Homepage:
Clone URL: git://github.com/shadow11/microformats_helper.git
name age message
file LICENSE Thu Jun 12 14:46:17 -0700 2008 Documentation [shadow11]
file README Loading commit data...
file README.rdoc
file Rakefile Thu Jun 12 13:15:55 -0700 2008 Added some working tests [shadow11]
file init.rb Thu Jun 12 12:11:28 -0700 2008 Initial commit [shadow11]
directory lib/
directory rdoc/
directory test/
README.rdoc

Microformats Helper

Microformats Helper is a plugin for generating content-rich tags in HTML files, following Microformats standards. For more information about Microformats, check its website (microformats.org).

Currently only the hCard microformat is available.

Options

All fields are optional but the name, you are required to provide at least one of the names below.

Name

  • fn - Formal Name: should be used when no other name is provided
  • given - Given Name
  • family - Family Name
  • additional - Additional Name: goes between given and family names
  • prefix - Honorific Prefix: for titles like Dr. or Sir
  • suffix - Honorific Suffix: for titles like M.D. or Jr

Address

  • street - Street Address
  • locality - The city or similar
  • region - The state, county or similar
  • +postal-code+ - ZIP number
  • country - The country

Contact

  • tel - Provide the phone number
  • url - Add a link to a site in the name
  • email - Add a link to a mailto: address

Usage

In your views:

  <%= hcard :fn => "Ricardo Yasuda" %>

The output is:

  <span class="vcard">
        <span class="fn n">Ricardo Yasuda</span>
  </span>

A more complicated example:

  <%= hcard :given => "Ricardo", :family => "Yasuda", :url => "http://blog.shadowmaru.org", :country => "Brazil" %>

The output is:

  <span class="vcard">
        <a href="http:blog.shadowmaru.org" class="fn n url">
                <span class="given-name">Ricardo</span> <span class="family-name">Yasuda</span>
        </a>
        <div class="adr">
                <span class="country-name">Brazil</span>
        </div>
  </span>