comment-brainstorming

(Difference between revisions)

Jump to: navigation, search
(add hAtom Entry Feed around all comments: -1)
(Schema I: removing rel-reply)
Line 58: Line 58:
**# http://microformats.org/wiki/hatom#Entry_Updated
**# http://microformats.org/wiki/hatom#Entry_Updated
-
* '''reply''' (comment-link) 60%  
+
* '''bookmark''' (comment-link) 60%  
-
**  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 "bookmark" the author is indicating that the page <nowiki>http://someblog/post#comment-001</nowiki> is a link to a key entry point within an extended document.
-
**# <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 {{may}} use the referring page <nowiki>http://someblog/post</nowiki> as the value of in-reply-to (see transformation)
+
==== Example ====
==== Example ====
Line 74: Line 72:
       <p>Hey Great Post</p>
       <p>Hey Great Post</p>
     </div>
     </div>
-
   <a rel="reply bookmark" href="http://someblog/post#comment-001">link to this</a>
+
   <a rel="bookmark" href="http://someblog/post#comment-001">link to this</a>
</div>
</div>
</pre>
</pre>
Line 90: Line 88:
       </author>
       </author>
     <link rel="alternate" href="http://someblog/post#comment-001" type="text/html"/>
     <link rel="alternate" href="http://someblog/post#comment-001" type="text/html"/>
-
    <thr:in-reply-to
 
-
      ref="http://someblog/post"
 
-
      type="text/html"
 
-
      href="http://someblog/post"/>
 
     <content>Hey Great Post</content>
     <content>Hey Great Post</content>
</entry>
</entry>
Line 105: Line 99:
===Summary===
===Summary===
-
* This proposal means that on the whole nothing much is needed for a [[comment]] microformat, a comment 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.
+
* This proposal means that on the whole nothing much is needed for a [[comment]] microformat, a comment can re-use terms outlined in the [[hatom|hAtom Microformat]]
===References===
===References===
Line 111: Line 105:
* [[comment-formats#Atom_Threading_Extension|Comment Formats]]
* [[comment-formats#Atom_Threading_Extension|Comment Formats]]
* [[hatom|hAtom Microformat]]
* [[hatom|hAtom Microformat]]
-
* Atom Threading Extensions [http://tools.ietf.org/html/rfc4685 rfc4685]
 
===Design Notes===
===Design Notes===

Revision as of 15:26, 24 November 2008

Brainstorming for a Comment Microformat

Contents


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 (84% or more)


Other achievable elements

Schema I

Proposal

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

Transformation

<entry>
     <id>http://someblog/post#comment-001</id>
     <title>Author said</title>
     <updated>2008-09-01T14:40:45+01:00</updated>
      <author>
          <name>Author</name>
          <uri>http://contributor.com/blog/</uri>
      </author>
     <link rel="alternate" href="http://someblog/post#comment-001" type="text/html"/>
     <content>Hey Great Post</content>
</entry>

Parser Notes

Summary

References

Design Notes

Schema II

Proposal

<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

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)

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)



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)

Idea Consolidation

This is a list of all the various "micro-ideas" that have been discussed on the mailing list in the Wiki, to capture everyone's thoughts and preferences.

use hAtom Entry for a comment

mark the comment permalink with rel="reply"

mark the comment permalink with rel="in-reply-to"

add an independent rel="in-reply-to" link

add class="comment" to the comment Entry

add hAtom Entry Feed around all comments

add class="comments" (or similar) to a element around all comments

use XOXO to mark up comments

Twitter is a comments system

A comment microformat should deal with hierarchically nested comments

if hAtom Entry is used, the Entry Title if not present should be X

suggested usage template for above

See Also

Related:

comment-brainstorming was last modified: Wednesday, December 31st, 1969

Views