[pLog-svn] r4059 - plugins/branches/lifetype-1.1/nestedcomments

[oscar at devel.lifetype.net]

Author: oscar
Date: 2006-09-28 06:05:45 +0000 (Thu, 28 Sep 2006)
New Revision: 4059

Modified:
   plugins/branches/lifetype-1.1/nestedcomments/pluginnestedcomments.class.php
Log:
changes in the plugin documentation


Modified: plugins/branches/lifetype-1.1/nestedcomments/pluginnestedcomments.class.php
===================================================================
--- plugins/branches/lifetype-1.1/nestedcomments/pluginnestedcomments.class.php	2006-09-27 19:33:01 UTC (rev 4058)
+++ plugins/branches/lifetype-1.1/nestedcomments/pluginnestedcomments.class.php	2006-09-28 06:05:45 UTC (rev 4059)
@@ -20,18 +20,16 @@
 			// description
 			$this->desc = <<<EOD
 This plugin will generate a nested list of comments. In order to use it, edit your postandcomments.template file
-and where it says:
+and add the following line:
 <pre>
-   {foreach from=\$comments item=comment}   
+   {assign var=comments value=\$nestedcomments->getNestedComments(\$post)}
 </pre>
-with:
+just above this line:
 <pre>
-   {assign var=comments value=\$nestedcomments->getNestedComments(\$post)}
    {foreach from=\$comments item=comment}
 </pre>
-In order to nest the comments, you can check the value of the "depth" field in order to know how
-deeply a certain comment should be nested but keeping in mind that the array of comments is already
-sorted correctly:
+Nesting is applied by using CSS classes to increase the left margin of the div block of the comment. The recommended
+implenentation looks like this:
 <pre>
    {assign var=comments value=\$nestedcomments->getNestedComments(\$post)}
    {foreach from=\$comments item=comment}
@@ -41,9 +39,11 @@
      &lt;/div&gt;
    {/foreach}
 </pre>
+Please notice that we are defining several different "comment_X" CSS classes that should be defined in our
+CSS file:
 In order to apply different graphical styles for different levels of nesting, define up to 6
 "comment_X" CSS classes (as in "comment_1", "comment_2", "comment_3", etc) in the CSS file used
-by your template set.
+by your template set:
 <pre>
     .comment_1 {
      margin-left: 10px;