View source for Activity Streams/Microformats Mapping

Mapping microformats [[http://microformats.org/wiki/h-entry h-entry]] -> Activity Streams 2.0.

== Property Mapping Table ==
Activity Streams consumers can consume HTML+microformats and interpret <code>h-entry</code> as the following Activity Streams objects and properties:

{| class="wikitable"
|-
! h-entry !! AS 2.0 !! Notes
|-
| p-name || as:name ||
|-
| p-summary || as:summary ||
|-
| e-content || as:content ||
|-
| dt-published || as:published ||
|-
| dt-updated || as:updated ||
|-
| p-author || as:author || 
|- 
| p-category || as:tag ||
|-
| u-url || as:url ||
|- 
| u-uid || as:id ||
|- 
| p-location || as:location ||
|- 
| u-in-reply-to || as:inReplyTo ||
|-
| p-comment || as:replies || Note, In AS2, the value of as:replies is an as:Collection
|-	
| u-photo || as:image ||
|}

Informative <code>h-entry</code> property descriptions:
* <code>p-name</code> - entry name/title
* <code>p-summary</code> - short entry summary
* <code>e-content</code> - full content of the entry
* <code>dt-published</code> - when the entry was published
* <code>dt-updated</code> - when the entry was updated
* <code>p-author</code> - who wrote the entry, optionally embedded h-card(s)
* <code>p-category</code> - entry categories/tags
* <code>u-url</code> - entry permalink URL
* <code>u-uid</code> - unique entry ID
* <code>p-location</code> - location the entry was posted from, optionally embed <code>h-card</code>, <code>h-adr</code>, or <code>h-geo</code>
* <code>u-in-reply-to</code> - a URL the entry is posted as a response to.
** <code>p-in-reply-to</code> with embedded <code>h-cite</code> - the in-reply-to property may also be published with an embedded full <code>h-cite</code> object which itself may contain a <code>p-name</code> (title) of the citation, <code>dt-published</code> datetime it was published, and <code>u-url</code> URL of the citation.

These descriptions are informative. For normative definitions of <code>h-entry</code> properties, see the [http://microformats.org/wiki/h-entry h-entry specification].

== Parsing HTML and microformats ==
Activity Streams consumers that consume HTML+microformats SHOULD do so by implementing these specifications:
* HTML5 Parsing
* [http://microformats.org/wiki/microformats2-parsing microformats2 Parsing]

There are several open source libraries implementations may use to parse HTML+microformats into JSON:
* See: [http://microformats.org/wiki/microformats2#Implementations HTML+microformats2 parsers] available for Javascript, node.js, PHP, Ruby and Python. 

== h-card to AS Actor properties ==
In an <code>h-entry</code>, typical use of the <code>p-author</code> property includes an embedded <code>h-card</code> with author details such as <code>p-name</code>, <code>u-url</code>, <code>u-photo</code>.

<code>as:author</code> can specify author details such as name, URL, photo.

E.g. in AS2 JSON-LD, an author URL:

<pre>{
  "@context": "...",
  "actor": "http://example.org/profiles/sally"
}</pre>

... which is equivalent to

<pre>{
  "@context": "...",
  "actor": {
    "id": "http://example.org/profiles/sally"
  }
}</pre>

You can add additional properties from from there. In fact, the AS @context definition defines the [http://www.w3.org/TR/vcard-rdf/ VCARD] mapping already, so you can use VCARD properties directly. Thus:

<pre><nowiki>
<a class="p-author h-card" href="http://sally.example.org/">
  <img src="http://sally.example.org/photo.jpg" alt=""/>
  Sally Jones
</a>
</nowiki></pre>

... which is equivalent to

<pre><nowiki>
<span class="p-author h-card">
  <a class="u-url" href="http://sally.example.org/">
    <img class="u-photo" src="http://sally.example.org/photo.jpg" alt=""/>
    <span class="p-name">Sally Jones</a>
  </a>
</span>
</nowiki></pre>

... and can be interpreted as the AS2 JSON:

<pre>{
  "@context": "...",
  "author": {
    "id": "http://sally.example.org/",
    "type": "vcard:Individual",
    "vcard:fn": "Sally Jones",
    "vcard:photo": "http://sally.example.org/photo.jpg",
  }
}</pre>

== References ==
* [http://microformats.org/wiki/h-adr h-adr specification] (microformats.org)
* [http://microformats.org/wiki/h-card h-card specification] (microformats.org)
* [http://microformats.org/wiki/h-cite h-cite specification] (microformats.org)
* [http://microformats.org/wiki/h-entry h-entry specification] (microformats.org)
* [http://microformats.org/wiki/h-geo h-geo specification] (microformats.org)
* [http://microformats.org/wiki/microformats2-parsing microformats2 parsing specification] (microformats.org)
* [https://github.com/snarfed/activitystreams-unofficial/blob/master/microformats2.py#L97 activitystreams-unofficial.py]