root/afridex/plugins/get-recent-comments 2/readme.txt @ 23

Revision 21, 11.5 kB (checked in by admin, 18 years ago)
Line 
1=== Get Recent Comments ===
2Tags: comments, widget
3Requires at least: 1.5
4Tested up to: 2.3
5Stable tag: trunk
6
7Display the most recent comments or trackbacks with your own formatting in the sidebar.
8
9== Description ==
10
11This plugin shows excerpts of the latest comments and/or trackbacks in your
12sidebar. You have comprehensive control about their appearance. This ranges
13from the number of comments, the length of the excerpts up to the html layout.
14You can let the plugin order the comments by the corresponding post, or simply
15order them by date. The plugin can (optionally) separate the
16trackbacks/pingbacks from the comments. It can ignore comments to certain
17categories, and it offers support for gravatars. It only gives extra work to
18the database, when actually a new comment arrived. You can filter out
19unwanted pingbacks, which originate from your own blog. And it is a widget.
20
21You might want to have a look in the [changelog](http://blog.jodies.de/archiv/2004/11/13/recent-comments/2/#changelog).
22
23*Feature List*
24
25* Highly configurable via WordPress admin interface.
26* Support for WordPress 1.5, 2.0, 2.1, 2.2 and 2.3
27* Adjustable layout by macros.
28* Handles trackbacks and comments in separate lists, or in one combined list.
29* Widget support
30* Caches the output
31* Order comments by date, or by posting
32* Support for [gravatars](http://www.gravatar.com/).
33* Option to exclude comments to posts in certain categorys
34* Doesn’t show pingbacks originating from own blog
35* There is a special version for lyceum multiblog installations: http://blog.jodies.de/blog/get-recent-comments/lyceum/
36* Supports [Hannah Gray’s](http://geekgrl.net/) [Profile Pics Plugin](http://geekgrl.net/2007/01/02/profile-pics-plugin-release/)
37
38== Installation ==
391. Upload `get-recent-comments.php` to the `/wp-content/plugins/` directory.
402. Activate `Get Recent Comments` through the 'Plugins' menu in WordPress.
413. What to do now depends on how up to date your theme is:
42
43    **Modern theme with widget support**
44
45    The plugin is a [widget](http://automattic.com/code/widgets/). If your
46theme supports widgets, and you have installed the [widget
47plugin](http://wordpress.org/extend/plugins/widgets/), adding the plugin to the
48sidebar is easy: Go to the presentation menu and drag and drop the widget into
49the sidebar ([Screenshot](http://wordpress.org/extend/plugins/get-recent-comments/screenshots/)). Don't forget the Get Recent Trackbacks box. And you might want to
50change the title. All done.
51
52    **Old school theme without widget support**
53
54    You need to insert the following code snippet into the sidebar template.   
55*wp-content/themes/<name of theme>/sidebar.php*
56
57        <?php if (function_exists('get_recent_comments')) { ?>
58        <li><h2><?php _e('Recent Comments:'); ?></h2>
59              <ul>
60              <?php get_recent_comments(); ?>
61              </ul>
62        </li>
63        <?php } ?>   
64         
65        <?php if (function_exists('get_recent_trackbacks')) { ?>
66        <li><h2><?php _e('Recent Trackbacks:'); ?></h2>
67              <ul>
68              <?php get_recent_trackbacks(); ?>
69              </ul>
70        </li>
71        <?php } ?>
72
73== Contributors/Changelog ==
74
75Many users of the plugin gave feedback and contributed their ideas. They are
76referenced in the [changelog](http://blog.jodies.de/archiv/2004/11/13/recent-comments/2/#changelog):
77
78
79    Version Date       Changes
80    2.0.2   2007/09/25 Fix: Plugin was not compatible to WordPress
81                       2.0.11 any more. Thank you to Stephan for
82                       reporting the bug.
83
84    2.0.1   2007/09/24 Added switch on the categories page, which
85                       reverses the selection. It is now possible to
86                       include or exclude categories.
87
88    2.0     2007/09/24 New code for fetching the data: 1. Instead of
89                       one expensive database query we now use two
90                       or more cheap queries. Thanks to mirra, who
91                       reported the problem. And again thank you to
92                       the people mentioned in changlog 1.4, where
93                       the cache was introduced for the same
94                       (performance-) problems on big blogs. 2. This
95                       also fixed a bug, which lead to too less than
96                       requested comments in lists, ordered by post.
97                       Thanks to Johanna and Frédéric for reporting
98                       and documenting this. Changed the css in the
99                       admin gui, to work around a display issue
100                       with Tiger Admin. Thank you, Andi, for
101                       finding this. Added %time_since macro, which
102                       displays the time since the comment was
103                       posted. Thanks to Imran and Keith for
104                       sugesting (something like) this (very long
105                       ago). Admin interface: Added switch fpr
106                       turning on and off smileys. Thank you, panos,
107                       for requesting this feature. Support for
108                       Custom Smileys Plugin. Thanks to Henry for
109                       suggesting this. Fix: Username was not
110                       displayed as "Anonymous", if commentor left
111                       no name. Thanks to Pixelation for reporting
112                       this. Added support for WordPress 2.3. It
113                       will drop the post2cat table. Changed plugin
114                       to new taxonomy scheme. A *great* thank you
115                       goes to Lakatos Zsolt, who provided a
116                       complete patch for get-recent-comments-1.5.6,
117                       which made it very easy for me to understand
118                       how 2.0-beta10 had to be changed. Thank you
119                       also to xelios, Ville and Kretzschmar who
120                       warned me, that WordPress 2.3 will break the
121                       old plugin code.
122
123    1.5.5   2007/03/26 Added support for malyfred's Polyglot Plugin.
124                       Requested by Torben.
125    1.5.4   2007/02/01 Use full pingback_author as %comment_author
126                       (instead of 'Unknown', if the pingback parser
127                       fails to recognize the pingback_author.
128                       Thanks again to Gant who found this in his
129                       blog. Added %author_url_href macros, which
130                       allows to generate inactive links, if the
131                       commentator did not leave an url. This was
132                       wished (in part long ago) by beej, carl,
133                       FilSchiesty and SwB.
134                       Added %profile_picture macro, which supports
135                       Hannah Gray's Profile Pics Plugin. Thank you
136                       for the idea and your help, Markus
137    1.5.3   2007/01/15 Refresh cache, when a comment is approved by
138                       moderator. Problem found by Gant. Thank you!
139    1.5.2   2007/01/05 Added option for excluding comments from blog
140                       authors. Suggested by This is Zimbabwe, Slim,
141                       marilyn's shampoo and Igor M.
142    1.5.1   2006/12/29 Store the cache base64 encoded. There seems
143                       to be a problem with the unserialization of
144                       multibyte characters. Thanks to priv, who
145                       reported the problem and suggested the
146                       encoding.
147                       After upgrading to this version you should
148                       trigger a regeneration of the cache by adding
149                       a comment somewhere.
150    1.5     2006/12/27 New pingback parser
151                       Stop losing html entities and tags in the
152                       post titles and comments by using
153                       wptexturize. Thanks to ejm (again!) and
154                       mobius for reporting the problem and making
155                       suggestions.
156                       Bugfix in widget code: Error, when trackbacks
157                       came before comments
158    1.4     2006/12/24 The plugin is a widget now. Thanks to
159                       herrmueller and Thomas de Klein for
160                       suggesting this feature.
161                       Cache the output in order to reduce the
162                       database impact of the plugin. Thanks to the
163                       following people for reporting the poor
164                       performance and making suggestions to solve
165                       the problem: Brandon Stone, King of Fools,
166                       Robert Basic and especially CountZero.
167                       Option to combine comments and trackbacks in
168                       one list (requested by Maniac and die
169                       produzentin)
170                       Allow to Group comments by their posting
171                       (requested by eyolf)
172                       Allow limit of comments per post (suggested
173                       by Thomas)
174                       Use Wordpress 2.1 compatible database
175                       variables. Thanks to spencerp, for reporting
176                       and fixing.
177                       Bugfix: Wrong key used in gravatar hash
178                       (Thank you, Hamzeh N., for finding and fixing
179                       this).
180                       Updated the stylesheets to the look of
181                       wordpress 2.x.
182                       Added two macros: %comment_type and
183                       %post_counter.
184                       Use less option variables in db.
185                       Updated instructions page.
186                       Dropped support for Wordpress 1.2
187    1.3.1   2006/12/11 Fixes for problems with wordpress running
188                       under windows.
189    1.3     2006/11/26 Fixes for problems with php5.
190    1.2     2005/09/15 Prevent pingbacks from own blog. Thanks to
191                       Matt for the idea and support!
192                       To use the feature, go to the trackbacks
193                       configuration and enter the address of your
194                       webserver.
195    1.0     2005/03/21 Also show comments to static pages. (They are
196                       new in WP 1.5). Thanks to maza for the hint.
197    0.9     2005/03/20 Introduced admin gui. Handle trackbacks
198                       different than comments. Replaced most
199                       regular expressions with basic string
200                       operations. Dedicated macro for posting time.
201                       Requested by Zonekiller
202    0.8     2005/02/04 Readjusted sequence of arguments to the one
203                       described in the documentation. Thanks to
204                       Thomas
205    0.7     2005/02/03 Renamed plugin to get-recent-comments, to
206                       make it possible to use the subversion system
207                       at www.wp-plugins.org
208                       Allow to specify your own formatting in the
209                       function call
210    0.5     2005/01/02 Removed superfluous </p>
211    0.4     2004/12/19 Use function arguments for displaying HTML
212                       before and after the comment
213                       Make number of comments and number of
214                       characters also function arguments
215    0.3     2004/12/08 Link to permalink of comment
216                       Wrap very long strings
217    0.2                Don’t show comments that are not approved
218    0.1     2004/11/03 Initial release
219
220Thanks to all who sent bug reports and ideas for improvements.
221Please send me a mail if I forgot you to mention here.
222
223
224== Screenshots ==
2251. Activation of widget
2262. Administration Interface
227
Note: See TracBrowser for help on using the browser.