Microformats

The OpenCalais response format supports three Microformats: rel-tag, hCard and hCalendar. The Microformats output is returned as one stream of text and enables insertion directly into HTML pages without affecting the page layout; that is, adding the Microformats for each entity so that entities/events can be visually highlighted by Microformats-aware browsers. (This is done by using the <span> tag in the Microformats output.)

The returned Microformats are based on the most relevant metadata elements (Entities, Events and Facts) from the Calais Semantic Metadata. The Entities, Events and Facts used for each Microformat type are summarized below.

Please remember to modify the outputFormat and reltagBaseURL input parameters as described here to get proper Microformats output. The reltagBaseURL needs to be a valid URL, to which rel-tag values will be appended.

rel-tag

The rel-tag format serves as the tags/keywords/categories for an article they refer to. We selected a subset of the Calais Semantic Metadata that is most suitable for assignment as tags/keywords/categories for a given article. The subset includes Entities, in which case the rel-tag value will be the attribute values for these entities, and Events and Facts, in which case the rel-tag values will be human-readable keywords/categories that indicate the Event type.

The following table summarizes the metadata elements included in the rel-tag Microformats (Entities are shown before Events and Facts):

Metadata Element - Entities rel-tag Value
Anniversary attribute value Anniversary
Company attribute value Company
EntertainmentAwardEvent attribute value EntertainmentAwardEvent
Facility attribute value Facility
Holiday attribute value Holiday
IndustryTerm attribute value IndustryTerm
MedicalCondition attribute value MedicalCondition
MedicalTreatment attribute value MedicalTreatment
Movie attribute value Movie
MusicAlbum attribute value MusicAlbum
MusicGroup attribute value MusicGroup
OperatingSystem attribute value OperatingSystem
Organization attribute value Organization
Person attribute value Person
PoliticalEvent attribute value PoliticalEvent
Product attribute value Product
ProgrammingLanguage attribute value ProgrammingLanguage
RadioProgram attribute value RadioProgram
SportsEvent attribute value SportsEvent
SportsLeague attribute value SportsLeague
Technology attribute value Technology
TVShow attribute value TVShow
Metadata Element - Events/Facts rel-tag Value
Acquisition "M&A"
Alliance "Business Partnership"
AnalystEarningsEstimate "Earnings Estimate"
AnalystRecommendation "Analyst Recommendation"
Arrest "Judicial Event"
Bankruptcy "Bankruptcy"
BonusSharesIssuance "Bonus Shares Issuance"
BusinessRelation "Business Partnership"
Buybacks "Security Buyback"
CompanyAccountingChange "Accounting Change"
CompanyEarningsAnnouncement "Earnings Announcement"
CompanyEarningsGuidance "Earnings Guidance"
CompanyExpansion "Company Expansion"
CompanyForceMajeure "Force Majeure"
CompanyInvestment "Funding"
CompanyLaborIssues "Labor Issues"
CompanyLayoffs "Layoffs"
CompanyLegalIssues "Legal Issues"
CompanyListingChange "Company Listing Change"
CompanyMeeting "General or Shareholder Meeting"
CompanyNameChange "Name Change"
CompanyReorganization "Reorganization"
CompanyRestatement "Restatement"
ConferenceCall "Conference Call"
Conviction "Judicial Event"
CreditRating "Credit Rating"
DebtFinancing "Debt Financing"
DelayedFiling "Delayed Filing"
DiplomaticRelations "Dipolomatic Relations"
Dividend "Dividend Issuance"
EmploymentChange "Employment Change"
EnvironmentalIssue "Environmental Issues"
Extinction "Extinction"
FDAPhase "FDA Phase"
Indictment "Judicial Event"
IPO "IPO"
JointVenture "Business Partnership"
ManMadeDisaster "Man-Made Disaster"
Merger "M&A"
MovieRelease "Movie Release"
MusicAlbumRelease "Music Album Release"
NaturalDisaster "Natural Disaster"
PatentFiling "Patent Filing"
PatentIssuance "Patent Issuance"
PersonCommunication "Person Communication and Meetings"
PersonTravel "Person Travel"
PoliticalEndorsement "Political Endorsement"
PollsResult "Polls Result"
ProductRecall "Product Recall"
ProductRelease "Product Release"
SecondaryIssuance "Second Stock Issuance"
SocialTags Value of each identified Social Tag
StockSplit "Company Stock Split"
Trial "Judicial Event"
VotingResult "Voting Result"

Back to Top

hCard

The hCard format is used to represent people, companies/organizations and places. We selected a subset of the Calais Semantic Metadata that is most suitable to represent the relationships between people and companies/organizations and between companies/organizations and places; the output does not include hCard results for each and every Person, Company or Organization identified.

The following table shows the mapping between Calais metadata elements and their attributes to hCard attributes.

Metadata Element hCard Attribute Attribute of Metadata Element
PersonProfessional fn value of attribute Person
  n value of attribute Person
  title value of attribute Position
  org value of attribute Company or Organization
CompanyLocation fn value of attribute Company
  n value of attribute Company
  adr locality value of attribute City
  adr region value of attribute ProvinceOrState
  adr country-name value of attribute Country
  adr type "Work"

Back to Top

hCalendar

The hCalendar format is used to represent calendar events. We selected the two relevant Event types from the Calais Semantic Metadata to output calendar events in the hCalendar format.

The following table shows the mapping between Calais metadata elements and their attributes to hCalendar attributes.

Metadata Element hCalendar Attribute Attribute of Metadata Element
ConferenceCall dtstart value of attribute Date
  summary values of attributes Company + Quarter+CCallType (appended)
CompanyMeeting dtstart value of attribute Date
  summary values of attributes Company + CompanyMeetingType (appended)
  location MeetingSite, City, ProvinceOrState, Country (taking only the non-empty values)

Examples:

Microformats Input:

2007 Monday August 20, 9:00 am ET 
Tensleep Corporation (Other OTC:TENS.PK - News) (""Tensleep"") announced that with the acquisition of XSTV Media, Inc. (""XSTV""),
it will become an online independent sports company. The transaction is
to close on or before September 15, 2007. Tensleep will, by the end of
this week or early next week, call a special meeting of shareholders to
approve the change name to ""XSTV Corporation.""

David Bailey, an analyst at Gerard Klauer Mattison, said such cuts ""could include head count reductions.""

Layoffs
to some degree are inevitable, said IDC analyst Roger Kay. For years,
the company enjoyed a lower cost structure than other PC makers because
it sold computers directly.

International
Star Inc. (OTC BB: ILST) announced that the annual meeting of
shareholders of International Star Inc. will be held on May 19, 2008,
at 3:00 p.m. (local time) at The Hilton Hotel, 104 Market Street,
Shreveport, La., 71101.

Microformats Output:

 <!--Use of the Calais Web Service is governed by the Terms of Service located at http://www.opencalais.com. By using this service or the results of the service you agree to these terms of service.--> <!-- hCards: Roger Kay,David Bailey,
hcalendars: International Star Inc. (International Star, Inc.) Shareholders' Meeting,
rel-tags: sports,Tensleep Corporation,XSTV Corporation,International Star Inc.,Gerard Klauer Mattison,XSTV Media Inc.,David Bailey,Roger Kay,The Hilton Hotel,IDC,M&A,General or Shareholder Meeting,
-->
<OpenCalaisMicroformats>
  <Description>
    <allowDistribution>true</allowDistribution>
    <allowSearch>true</allowSearch>
    <calaisRequestID>39da8eff-afdb-fff2-121a-ab23ef516c8a</calaisRequestID>
    <externalID>QA</externalID>
    <id>http://id.opencalais.com/dHge0IWfL02eA2zlheqdVQ</id>
    <about>http://d.opencalais.com/dochash-1/d84e833b-aa2e-38a7-bc3d-77e6eb133f28</about>
    <docTitle/>
    <docDate>2007-08-20</docDate>
  </Description>
  <Microformats>
    <cards>
      <hcard>
        <span class="vcard">
          <abbr class="fn" title="Roger Kay">Roger Kay</abbr>
          <abbr class="org" title="I.D.C. Holding a.s."/>
          <abbr class="title" title="analyst"/>
        </span>
      </hcard>
      <hcard>
        <span class="vcard">
          <abbr class="fn" title="David Bailey">David Bailey</abbr>
          <abbr class="org" title="Harris Nesbitt Gerard, Inc"/>
          <abbr class="title" title="analyst"/>
        </span>
      </hcard>
    </cards>
    <calendars>
      <hcalendar>
        <span id="hcalendar-International-Star-Inc.-(International-Star,-Inc.)-Shareholders'-Meeting" class="vevent">
          <abbr title="20080519" class="dtstart">May 19, 2008</abbr>
          <span class="summary">International Star Inc. (International Star, Inc.) Shareholders' Meeting</span>
          <span class="location">The Hilton Hotel, Shreveport,Louisiana,United States</span>
          <span class="geo">
            <abbr class="latitude" title="32.4680555556"/>
            <abbr class="longitude" title="-93.7711111111"/>
          </span>
        </span>
      </hcalendar>
    </calendars>
    <rel-tags>
      <rel-tag>
        <a href="/sports" rel="tag">sports</a>
      </rel-tag>
      <rel-tag>
        <a href="/Tensleep%20Corporation" rel="tag">Tensleep Corporation</a>
      </rel-tag>
      <rel-tag>
        <a href="/XSTV%20Corporation" rel="tag">XSTV Corporation</a>
      </rel-tag>
      <rel-tag>
        <a href="/International%20Star%20Inc." rel="tag">International Star Inc.</a>
      </rel-tag>
      <rel-tag>
        <a href="/Gerard%20Klauer%20Mattison" rel="tag">Gerard Klauer Mattison</a>
      </rel-tag>
      <rel-tag>
        <a href="/XSTV%20Media%20Inc." rel="tag">XSTV Media Inc.</a>
      </rel-tag>
      <rel-tag>
        <a href="/David%20Bailey" rel="tag">David Bailey</a>
      </rel-tag>
      <rel-tag>
        <a href="/Roger%20Kay" rel="tag">Roger Kay</a>
      </rel-tag>
      <rel-tag>
        <a href="/The%20Hilton%20Hotel" rel="tag">The Hilton Hotel</a>
      </rel-tag>
      <rel-tag>
        <a href="/IDC" rel="tag">IDC</a>
      </rel-tag>
      <rel-tag>
        <a href="/M&amp;A" rel="tag">M&amp;A</a>
      </rel-tag>
      <rel-tag>
        <a href="/General%20or%20Shareholder%20Meeting" rel="tag">General or Shareholder Meeting</a>
      </rel-tag>
    </rel-tags>
  </Microformats>
</OpenCalaisMicroformats>

Microformats Schema:

<!-- Comment -->
<OpenCalaisMicroformats>

    <Description>
    <id></id>
    <about></about>
    ..................
    </Description>
<Microformats>
    <cards>
        <hcard>
  <span class="vcard">
  <span class="fn"></span>
  <span class="org"></span>
  <span class="title"> </span>
  </span>
        </hcard>
     <hcard>
     ...
  </hcard>
 
    </cards>
 
     <calendars>
     <hcalendar>
      <span id=" " class=" ">
      <abbr title="" class="dtstart"> </abbr>
      <span class="summary"> </span>       
      <span class="location"> </span>
      <span class="geo">
        <abbr class="latitude" title=" " />
        <abbr class="longitude" title=" " />
        </span>
      </span>   
     </hcalendar>  
   
     <hcalendar>
     ...   
     </hcalendar>
   
 </calendars>
  <rel-tags>
      <rel-tag> 
       <a href="" rel="tag"</a>
      </rel-tag>
      
      <rel-tag> 
  ...
      </rel-tag>
   
  </rel-tags>
</Microformats>
</OpenCalaisMicroformats>