Skip to content
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).
Ruby
Pull request Compare This branch is 22 commits behind shadowmaru:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.
lib
rdoc
test
.gitignore
Gemfile
Gemfile.lock
LICENSE
README
README.rdoc
Rakefile
init.rb

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

  • org - Organization name

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 a hash with the phone types and numbers

  • 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=“blog.shadowmaru.org” class=“fn n url”> <span class=“given-name”>Ricardo</span> <span class=“family-name”>Yasuda</span> </a> <span class=“adr”> <span class=“country-name”>Brazil</span> </span>

</span>

An example with telephone numbers:

<%= hcard(:fn => "John Doe", :tel => { "fax" => "544-5544", "home" => "555-5555" }) %>

The output is:

<span class="vcard">
  <span class="fn n">John Doe</span>
  <span class="tel">
    <span class="tel-label-fax type">Fax: </span><span class="value">544-5544</span>
    <span class="tel-label-home type">Home: </span><span class="value">555-5555</span>
  </span> 
</span>
Something went wrong with that request. Please try again.