Difference between revisions of "comments-formats"

From Microformats Wiki
Jump to navigation Jump to search
 
(24 intermediate revisions by 16 users not shown)
Line 1: Line 1:
 +
__NOTOC__
 +
== Discussion Participants ==
 +
 +
=== Authors ===
 +
* [http://blog.factoryjoe.com/ Chris Messina], [http://roundtwo.com Round Two, Inc.]
 +
* [http://climbtothestars.org Stephanie Booth], [http://cocomment.com coComment] (hope I'm not messing things up by putting them here, please let me know if they should go elsewhere)
 +
 
= Current Comments Formats =
 
= Current Comments Formats =
 
There have been several efforts to define data formats for posting "comments" on the Web.
 
There have been several efforts to define data formats for posting "comments" on the Web.
Line 4: Line 11:
 
This page serves to document the current list of comment schemas, formats, and efforts as background for the design of a simple comments MicroFormat.
 
This page serves to document the current list of comment schemas, formats, and efforts as background for the design of a simple comments MicroFormat.
  
== Tools ==
 
 
=== WordPress ===
 
* http://wordpress.org
 
 
** comment_ID
 
** comment_author
 
** comment_author_IP
 
** comment_author_email
 
** comment_author_link
 
** comment_type
 
** comment_text
 
** comment_excerpt
 
** comment_date
 
** comment_time
 
 
=== pMachine ===
 
* http://pmachine.com
 
 
** body
 
** date
 
** name
 
** location
 
** url
 
** email
 
** profile_link
 
** member_total_comments
 
 
=== Expression Engine ===
 
* http://pmachine.com
 
 
** {author_id}
 
** {comment}
 
** {comment_id}
 
** {ip_address}
 
** {name}
 
** {permalink}
 
** {url}
 
** {url_or_email}
 
 
Expression Engine includes many additional comments templates tags. This list excludes the following tags: tags used to display user data (instant message handles, location, occupation, etc.), tags which are used for navigation within EE-based blogs or websites, tags which deal with comment presentation (alternating background colors between comments), and custom member tags (which are defined by individual sites.)
 
 
=== Drupal ===
 
* http://drupal.org
 
  
** $comment->new
 
** $comment->subject
 
** $comment->cid
 
** $comment->nid
 
** $comment->timestamp
 
** $submitted
 
** $comment
 
** $picture
 
** $content
 
** $links
 
  
 
== Examples from the wild ==
 
== Examples from the wild ==
  
 
* brianstorms (movable type) (from http://www.brianstorms.com/archives/000580.html)
 
* brianstorms (movable type) (from http://www.brianstorms.com/archives/000580.html)
<pre><code><nowiki>
+
<pre><nowiki>
 
<div class="comments-body">
 
<div class="comments-body">
 
<p>Congratulations!  Any list that includes Molly Holzschlag and Wil Wheaton is certainly something...  
 
<p>Congratulations!  Any list that includes Molly Holzschlag and Wil Wheaton is certainly something...  
Line 73: Line 26:
 
at June 21, 2005 08:53 PM</span>
 
at June 21, 2005 08:53 PM</span>
 
</div>
 
</div>
</nowiki></code></pre>
+
</nowiki></pre>
  
 
* mfComment "small" example:
 
* mfComment "small" example:
Line 87: Line 40:
 
  &lt;/div&gt;
 
  &lt;/div&gt;
 
</nowiki></pre>
 
</nowiki></pre>
 +
 +
* CommentAPI
 +
http://wellformedweb.org/story/9 Granted, this is not XHTML, but still should be useful as an example of expressing comments structurally.
 +
 +
* [http://blogxoxo.blogspot.com/2006/01/xoxo-blog-format.html XOXO Blog Format] (comment subset and suggested extension to [[hatom]])
 +
<pre><nowiki>
 +
&lt;ul class="xoxo comments"&gt;
 +
    &lt;li id="c836428"&gt;
 +
      Posted on &lt;a href="COMMENT PERMALINK" title="COMMENT TIMESTAMP (unix timestamp in seconds or nanoseconds)"&gt;COMMENT DATE POSTED&lt;/a&gt;
 +
  by &lt;a href="AUTHOR URL"&gt;AUTHOR NAME&lt;/a&gt;
 +
      &lt;dl&gt;
 +
        &lt;dt&gt;body&lt;/dt&gt;
 +
            &lt;dd&gt;COMMENT BODY&lt;/dd&gt;
 +
      &lt;/dl&gt;
 +
  &lt;/li&gt;
 +
&lt;/ul&gt;
 +
</nowiki></pre>
 +
 +
* Wordpress.com
 +
from [http://steph.wordpress.com/2006/06/04/before-and-after/]
 +
<pre><nowiki>
 +
<ol id="commentlist">
 +
<li class="alt" id="comment-1143">
 +
<h3 class="commenttitle"><a href='http://www.derriere-le-hublot.com' rel='external nofollow'>virginie</a> said,</h3>
 +
<p class="commentmeta">June 6, 2006 @ <a href="#comment-1143" title="Permanent link to this comment">9:02 pm</a></p>
 +
<p>Nice hairdo! I really think it suits you! And the color is different from the last times, isn&#8217;t it?</p>
 +
</li>
 +
</ol>
 +
</nowiki></pre>
 +
 +
 +
* blogger.com
 +
from [http://jamesfostofapfz.blogspot.com/2008/09/if-your-goal-is-customer-loyalty-then.html]
 +
<pre><nowiki>
 +
&lt;dl id=&#x27;comments-block&#x27;&gt;
 +
  &lt;dt class=&#x27;comment-author openid-comment-icon&#x27; id=&#x27;c5069974981380830367&#x27;&gt;
 +
      &lt;a name=&#x27;c5069974981380830367&#x27;&gt;&lt;/a&gt;
 +
      &lt;a href=&#x27;http://meme-rocket.com/&#x27; rel=&#x27;nofollow&#x27;&gt;Bill&lt;/a&gt;
 +
      said...
 +
  &lt;/dt&gt;
 +
 +
  &lt;dd class=&#x27;comment-body&#x27;&gt;
 +
      &lt;p&gt;testing an OpenID comment&lt;/p&gt;
 +
  &lt;/dd&gt;
 +
  &lt;dd class=&#x27;comment-footer&#x27;&gt;
 +
      &lt;span class=&#x27;comment-timestamp&#x27;&gt;
 +
        &lt;a href=&#x27;http://jamesfostofapfz.blogspot.com/2008/09/if-your-goal-is-customer-loyalty-then.html?showComment=1222259520000#c5069974981380830367&#x27; title=&#x27;comment permalink&#x27;&gt;
 +
            September 24, 2008 5:32 AM
 +
        &lt;/a&gt;
 +
        &lt;span class=&#x27;item-control blog-admin pid-216793578&#x27;&gt;
 +
            &lt;a href=&#x27;http://www.blogger.com/delete-comment.g?blogID=6882271259081968971&amp;postID=5069974981380830367&#x27; title=&#x27;Delete Comment&#x27;&gt;
 +
              &lt;img src=&#x27;http://www.blogger.com/img/icon_delete13.gif&#x27;/&gt;
 +
            &lt;/a&gt;
 +
        &lt;/span&gt;
 +
      &lt;/span&gt;
 +
  &lt;/dd&gt;
 +
&lt;/dl&gt;
 +
</nowiki></pre>
 +
 +
Guy Fraser: Are comments not just another form of atom? Could we use something like hEntry ?
 +
 +
Matt MacDougall: Comments should be separate from hEntry to give systems the capability to weight a comment differently than its parent entry.  Modifying hEntry to include parent child relationships would become borderline human unfriendly.
 +
 +
Phil Peace: It seems to me that a comments microformat would be a specialization/subset of hreview. This would chime with the recent Google RDFa push.

Latest revision as of 10:28, 27 August 2009

Discussion Participants

Authors

Current Comments Formats

There have been several efforts to define data formats for posting "comments" on the Web.

This page serves to document the current list of comment schemas, formats, and efforts as background for the design of a simple comments MicroFormat.


Examples from the wild

<div class="comments-body">
<p>Congratulations!  Any list that includes Molly Holzschlag and Wil Wheaton is certainly something... 
and that's just the Honorable Mentions.</p>

<p>Now to scrape the links of all the rest of those "people you may not know but probably should"...</p>
<span class="comments-post">Posted by: 
<a href="http://www.brianstorms.com/mt/mt-comments.cgi?__mode=red&id=3826">Chris</a> 
at June 21, 2005 08:53 PM</span>
</div>
  • mfComment "small" example:
 <div class="mfcomment">
    <a class="url" rel="target" href="http://an9.org/devdev/shdh2/>
    <span class="commenter">anonymous</span>
    <abbr class="dtcommented" title="20050612T21:30-0700">June 12th, 2005</abbr>
    <div class="description">
        <p>Gosh, this is neat.</p>
    </div>
    <a class="url" rel="self bookmark" href="http://sxore.com/comment/view/14">link to this comment</a>
 </div>
  • CommentAPI

http://wellformedweb.org/story/9 Granted, this is not XHTML, but still should be useful as an example of expressing comments structurally.

 <ul class="xoxo comments">
    <li id="c836428">
       Posted on <a href="COMMENT PERMALINK" title="COMMENT TIMESTAMP (unix timestamp in seconds or nanoseconds)">COMMENT DATE POSTED</a>
   by <a href="AUTHOR URL">AUTHOR NAME</a>
      <dl>
         <dt>body</dt>
            <dd>COMMENT BODY</dd>
      </dl>
   </li>
 </ul>
  • Wordpress.com

from [1]

	<ol id="commentlist">
		<li class="alt" id="comment-1143">
		<h3 class="commenttitle"><a href='http://www.derriere-le-hublot.com' rel='external nofollow'>virginie</a> said,</h3>
		<p class="commentmeta">June 6, 2006 @ <a href="#comment-1143" title="Permanent link to this comment">9:02 pm</a></p>
		<p>Nice hairdo! I really think it suits you! And the color is different from the last times, isn’t it?</p>
		</li>
	</ol>


  • blogger.com

from [2]

<dl id='comments-block'>
   <dt class='comment-author openid-comment-icon' id='c5069974981380830367'>
      <a name='c5069974981380830367'></a>
      <a href='http://meme-rocket.com/' rel='nofollow'>Bill</a>
      said...
   </dt>

   <dd class='comment-body'>
      <p>testing an OpenID comment</p>
   </dd>
   <dd class='comment-footer'>
      <span class='comment-timestamp'>
         <a href='http://jamesfostofapfz.blogspot.com/2008/09/if-your-goal-is-customer-loyalty-then.html?showComment=1222259520000#c5069974981380830367' title='comment permalink'>
            September 24, 2008 5:32 AM
         </a>
         <span class='item-control blog-admin pid-216793578'>
            <a href='http://www.blogger.com/delete-comment.g?blogID=6882271259081968971&postID=5069974981380830367' title='Delete Comment'>
               <img src='http://www.blogger.com/img/icon_delete13.gif'/>
            </a>
         </span>
      </span>
   </dd>
</dl>

Guy Fraser: Are comments not just another form of atom? Could we use something like hEntry ?

Matt MacDougall: Comments should be separate from hEntry to give systems the capability to weight a comment differently than its parent entry. Modifying hEntry to include parent child relationships would become borderline human unfriendly.

Phil Peace: It seems to me that a comments microformat would be a specialization/subset of hreview. This would chime with the recent Google RDFa push.