Difference between revisions of "comment-brainstorming"

From Microformats Wiki
comment-brainstorming
Jump to navigation Jump to search
Line 57: Line 57:
 
**# http://microformats.org/wiki/hatom#Entry_Updated
 
**# http://microformats.org/wiki/hatom#Entry_Updated
  
* '''contact''' (comment-link) 40%
+
* '''reply''' (comment-link) 40%
** Someone you know how to get in touch with, [[rel-contact]] is a two way link type ([http://en.wikipedia.org/wiki/Symmetry symmetric]), comments on a web page are generally a way of contact between the author of a page and the publisher of a comment.  
+
**   The "reply" element is used to indicate that an entry is a response to another resource.  
**# http://gmpg.org/xfn/11#contact
+
**# http://tools.ietf.org/html/rfc4685#section-3
**# <code>contact</code> could be parsed as the [[comment-brainstorming#hAtom_and_in-reply-to|in-reply-to]] [http://tools.ietf.org/html/rfc4685 Atom Threading Extension].
+
**# <code>reply</code> {{should}} be parsed as the [[comment-brainstorming#hAtom_and_in-reply-to|in-reply-to]] [http://tools.ietf.org/html/rfc4685 Atom Threading Extension].
**# The <code>contact</code> link type is used to determine the difference between a comment and an article or blog post
 
  
 
Example:
 
Example:
Line 74: Line 73:
 
       <p>Hey Great Post</p>
 
       <p>Hey Great Post</p>
 
     </div>
 
     </div>
   <a rel="contact bookmark" href="#comment-001">link to this</a>
+
   <a rel="reply bookmark" href="#comment-001">link to this</a>
 
</div>
 
</div>
 
</pre>
 
</pre>
Line 82: Line 81:
 
* If the <code>entry-title</code> element is not used, the atom:title element {{should}} use the <code>author</code> value of the <code>hentry</code> presented in a contextual way, for example by prefixing the <code>author</code> value with "by" or appending it with "said" or "says".
 
* If the <code>entry-title</code> element is not used, the atom:title element {{should}} use the <code>author</code> value of the <code>hentry</code> presented in a contextual way, for example by prefixing the <code>author</code> value with "by" or appending it with "said" or "says".
 
* The <code>entry-title</code> element {{should}} provide [http://www.atomenabled.org/developers/syndication/atom-format-spec.php#rfc.section.4.1.1.1 textual content] and not be an empty string.
 
* The <code>entry-title</code> element {{should}} provide [http://www.atomenabled.org/developers/syndication/atom-format-spec.php#rfc.section.4.1.1.1 textual content] and not be an empty string.
 +
* To be defined further..
  
 
===Summary===
 
===Summary===
  
This proposal means that on the whole nothing new is needed for a [[comment]] microformat, just use [[hatom|hAtom]], but instead of using just [[rel-bookmark]] use [http://gmpg.org/xfn/11 XFN] [[rel-contact]] as well.
+
This proposal means that on the whole nothing much is needed for a [[comment]] microformat we can re-use terms outlined in the [[hatom|hAtom Microformat]], but instead of using just [[rel-bookmark]] use [[rel-reply]] as well to indicate that the [[hatom#Entry| hEntry]] is also a reply.
  
 
== Schema II ==
 
== Schema II ==

Revision as of 12:23, 15 November 2008

Brainstorming for a Comment Microformat

This is a brainstorm for comment microformat. Examples of a comment can be found here comment-examples

Problem

Shortform: How do you track blog comments you've made?

Longform: How do track the comments you have made on blogs, comments made on blogs your interested in and comments other people have made on your own blog?

How can you do this in a pragmatic way, ingested into some kind of data store, searched or aggregated?

Contributors

Discovered Elements

Based on the analysis of 25 real world examples of a comment, the results can be found at the Comment Analysis section

The following properties occur most regularly across all examples (92% or more)

  • author (name)100%
  • comment (text) 100%
  • published (date) 100%
  • author-url (href) 92%

Other achievable elements

  • comment-link (a permalink) 40%

Schema I

Proposal

  • url (author-url) 92%

Example:

<div class="hentry" id="comment-001">
   <span class="author vcard">
       <span class="entry-title"><a class="url fn" href="http://contributor.com/blog/">Author</a> said</span>
   </span>
   about <span class="updated" title="2008-09-01T14:40:45+01:00">72 days ago</span>, 
   <div class="entry-content">
      <p>Hey Great Post</p>
    </div>
   <a rel="reply bookmark" href="#comment-001">link to this</a>
</div>

Parser Notes

  • If the entry-title element is not used, the atom:title element SHOULD use the author value of the hentry presented in a contextual way, for example by prefixing the author value with "by" or appending it with "said" or "says".
  • The entry-title element SHOULD provide textual content and not be an empty string.
  • To be defined further..

Summary

This proposal means that on the whole nothing much is needed for a comment microformat we can re-use terms outlined in the hAtom Microformat, but instead of using just rel-design-pattern use rel-reply as well to indicate that the hEntry is also a reply.

Schema II

Proposal

  • reuse hAtom 0.1
  • comments are Entrys
  • comments are nested in a Feed "hfeed comments" block
  • the "hfeed comments" block is nested within the hentry of what the comment is on
<div class="hentry">
   <h3 class="entry-title">The blog post title</h3>
   <div class="entry-content">The blog post text</div>
   (etc)
   <div class="hfeed comments">
       <div class="hentry" id="p0001">
          <div class="entry-content">Comment #1</div>
          (etc)
       </div>
       <div class="hentry" id="p0002">
          <div class="entry-content">Comment #2</div>
          (etc)
       </div>
   </div>
</div>

Details

Feedback

If we can indicate that the hAtom entries are also comments, we could add an indicator beside hAtom.

<div class="hfeed hcomment">

hAtom pattern goes here.

</div>

Alternatively, we could add hcomment with hentry to indicate that the following hentry can be treated also as a comment.

<div class="hentry hcomment">

hEntry pattern goes here.

</div>

--Sarven Capadisli 11:59, 25 Sep 2008 (PDT)


  • If an hfeed is embedded in an hEntry, that could be enough context to show "these items are replies to the one they're embedded in" singpolyma 12:20, 25 Sep 2008 (PDT)


hAtom and in-reply-to

A user comment (e.g., in blogs, wikis, forms) can be marked as an hAtom since it has a similar content pattern. A way to differentiate an hEntry (e.g., a blog post) from another hEntry (e.g., a user comment) can be done reusing in-reply-to from Atom Threading Extensions. It provides a mechanism to indicate that an entry is a response to another resource. rel="in-reply-to" can indicate that the current hEntry is a reply to another hEntry and has a reference point @href:

<a rel="in-reply-to" href="#comment_20080902144745">Parent</a>

hEntries that use rel="in-reply-to" can be considered as a comment entry in response to a parent entry in the threaded conversation (e.g., in blogs, wikis, forms).

hEntries that are chronologically listed can all use rel="in-reply-to" and refer to the root hEntry (e.g., blog post, form post)

By reusing in-reply-to, we can solve the microformats representation for user comments [1], [2], [3].

Example comment using in-reply-to: http://www.csarven.ca/my-responses-are-in-white

--Sarven Capadisli 21:25, 3 Oct 2008 (PDT)

See Also

Related: