==================================================================
Snippet-title:		comments_by v2.1
Creator:		Graham Keellings
E-mail:			pivot@keellings.com
Website:		http://www.keellings.com/software/pivot.php
Creation date:		18 Sept 2006, Singapore
==================================================================

Content of zipped file:
-----------------------
snippet_comments_by.php
readme_comments_by.txt (this file)


Usage:
------
1) unpack this package in your extensions/snippets/ folder.
2) place a [[comments_by]] tag, with the appropriate parameters, in any of your template    files, wherever you want the output to appear (side bar, page top or bottom, etc)
3) rebuild the FrontPage(s).
   
Description:
------------
* A snippet to show all comments by a given author, optionally restricted to 
* a particlar weblog or category. 
* 
* When first run, the snippet generates a drop-down list with the names of
* everyone who has commented, plus a button. When the user clicks the button, 
* the snippet shows a URL to each entry where the user has commented. 
*
* Visit http://www.keellings.com/blog/_demos/comments_by.php to see it
* in action



Important:
-----------
You can make a click on a link jump directly to a comment, or just to the top
of the entry page. This is governed by the comment format for your blog.
Go to Adminsitration/weblogs then to your blog and go to the third page.
Look for "Format of Comments:". If you start if with %anchor% then Pivot will
generate HTML anchors for each individual comment and the snippet can jump
straight to each comment; otherwise, it just jumps to the start of the entry page.



Parameters:
-----------
* @param  string  author     - pass an author's name to restrict 
*                              selection, or '*' for all authors (default),
*                              or '.' for 'author of current entry' (for
*                              use in your entrypage_template.html
* @param  string  weblog     - pass '.'for the current blog, '*' for
*                              all blogs, or a blog title like my_blog
* @param  string  category   - consider only entries of the given category, or
*                              all categories if omitted or set to *.
* @param  string  dateFormat - each 'quicklink' will be preceded by the 
*                              comment date formatted by this string (passed to
*                              the PHPdate() function. e.g. "d M, Y - G:ia"
*                              Leave blank for none.
* @param  string  introText  - if specified, this text will be output before
*                              the list box.efault = no text
* @param  string  buttonText - this text will be written on the submit button.
*                              Default = 'Show comments'
* @param  int     sort       - detrines how the entries of the drop down list 
*                              are sorted:
*                                0 (default) number of comments, descending
*                                1 alphabetically
*                                2 most recent commenters first
* @param  string  exclude    - a list of commenters names, sperated by | whco 
*                               should not be included.E.g   graham|admin



/*
* History:
*
* v 2.1 2006/11/27  Singapore
*  - unread_entry() in loop, to free up memory and avoid 
*    allocation problems.
*
* v 2.0 2006/10/17  Singapore
*   Major version number jump because fo parameetr change:
*   - combined 'introText' and 'buttonText' into 'text' as we already had eight
*      partameters and wanted to add maxlength

* v 1.1 v 1.0 2006/10/15  Singapore
*   - I had stupidly left some debug code in. Any entries before #850 were ignored.
*
* v 1.0 2006/09/18  Singapore
*   - initial version
*
*/