Difference between revisions of "comment-brainstorming"

From Microformats Wiki
Jump to navigation Jump to search
(→‎Proposal: oops typo)
(→‎Proposal: simplifying)
Line 61: Line 61:
**  By adding "rel-reply" the author is indicating that the page <nowiki>http://someblog/post#comment-001</nowiki> is a reply for the referring page (see example).   
**  By adding "rel-reply" the author is indicating that the page <nowiki>http://someblog/post#comment-001</nowiki> is a reply for the referring page (see example).   
**# <code>reply</code> {{may}} be defined as rfc4685 section 3 ([http://tools.ietf.org/html/rfc4685#section-3 1]) in-reply-to [http://tools.ietf.org/html/rfc4685 atom threading extension]. A parser {{should}} use the referring page <nowiki>http://someblog/post</nowiki> as the value of in-reply-to
**# <code>reply</code> {{may}} be defined as rfc4685 section 3 ([http://tools.ietf.org/html/rfc4685#section-3 1]) in-reply-to [http://tools.ietf.org/html/rfc4685 atom threading extension]. A parser {{should}} use the referring page <nowiki>http://someblog/post</nowiki> as the value of in-reply-to
**# <code>reply</code> is a bi-directional link type.
==== Example ====
==== Example ====

Revision as of 10:20, 17 November 2008

Brainstorming for a Comment Microformat

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


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?


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)

  • comment 100%
  • author 96%
  • published 96%
  • author-url 84%

Other achievable elements

  • comment-link (permalink) 60%

Schema I


  • url (author-url) 84%
  • reply (comment-link) 60%
    • By adding "rel-reply" the author is indicating that the page http://someblog/post#comment-001 is a reply for the referring page (see example).
      1. reply MAY be defined as rfc4685 section 3 (1) in-reply-to atom threading extension. A parser SHOULD use the referring page http://someblog/post as the value of in-reply-to


<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>
   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>
   <a rel="reply bookmark" href="http://someblog/post#comment-001">link to this</a>


     <title>Author said</title>
     <link rel="alternate" href="http://someblog/post#comment-001" type="text/html"/>
     <content>Hey Great Post</content>

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.



Design Notes

Schema II


  • reuse hAtom 0.1
  • if Entry "B" is in an Entry Comments element of Entry "A", then Entry "B" is a comment on Entry "A"
  • an Entry Comments element is identified by using both class names "hfeed comments"
<div class="hentry">
   <h3 class="entry-title">The blog post title</h3>
   <div class="entry-content">The blog post text</div>
   <div class="hfeed comments">
       <div class="hentry" id="p0001">
          <div class="entry-content">Comment #1</div>
       <div class="hentry" id="p0002">
          <div class="entry-content">Comment #2</div>


Specific Example from the Wild

hAtom Comments changes are marked IN UPPER CASE LETTERS FOR VISIBILITY. Assume them to be the normal case in otherwise

(section to be completed)


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.


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.


--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