GitHub Sale: sign up for any paid plan this week and pay nothing until January 1, 2009!  [ hide ]

public
Description: Radiant Comments
Clone URL: git://github.com/artofmission/radiant-comments.git
jomz (author)
Mon Sep 01 16:32:56 -0700 2008
commit  c4f78d17993f57d9f246189a9379d0930a5bd98a
tree    973fca5bcb41bd7a8b751f7195275d1e8ec4eac1
parent  a793697f8673ea3d4beb403e8ca53c1d84f95af0
name age message
file CHANGELOG Wed Jun 11 08:45:24 -0700 2008 Did a bit of cleanup. [ntalbott]
file MIT-LICENSE Mon May 05 12:13:47 -0700 2008 Importing comments extension to Git [artofmission]
file README.rdoc Mon Sep 01 16:32:56 -0700 2008 Showing config keys in README [jomz]
file Rakefile Mon May 05 12:13:47 -0700 2008 Importing comments extension to Git [artofmission]
file TODO Wed Jun 11 08:45:24 -0700 2008 Did a bit of cleanup. [ntalbott]
directory app/ Mon Jul 28 16:41:41 -0700 2008 Merge branch 'master' of git://github.com/mikeh... [artofmission]
directory autotest/ Wed Jul 23 12:43:27 -0700 2008 add autotest support [mikehale]
file comments_extension.rb Mon Jul 28 16:28:50 -0700 2008 fix restrict route so that remove/update still ... [mikehale]
directory db/ Mon Jun 16 09:11:33 -0700 2008 Notify the user about whether their comment has... [jonleighton]
directory lib/ Tue Jun 24 12:40:29 -0700 2008 Selected comment should show even if it is the ... [ntalbott]
directory test/ Thu Jul 24 10:41:04 -0700 2008 nicer urls for csv downloads [mikehale]
README.rdoc
= Radiant Comments Extension

Adds blog-like comment functionality to Radiant. 

== Patches

This software "works for me", but it may not work for you, depending on your particular environment or setup. Feel free 
to modify it in any way. If you do make changes that would be useful to others, please send a patch to ryan at 
artofmission (dot you-know-what), and I will see that it gets applied. 

== Dependencies

* Requires Radiant 0.6.7 or greater.
* Requires will_paginate Rails plugin (http://github.com/mislav/will_paginate/tree/master)
* Requires fastercsv 1.2.3 or greater.

== Usage

Remember to run the migration. This _WILL_ delete any snippets named 'comment', 'comments' and 'comment_form' if these 
exist.

  rake radiant:extensions:comments:migrate

To enable spam protection, you will need to set your Akismet key and url in the Radiant config.
For example:

script/console production
Radiant::Config['comments.akismet_key'] = "6a009ca6ab4e"
Radiant::Config['comments.akismet_url'] = "yoursite.com"
exit


To customize the CSV fields you can add an initializer like this:

  Comment.class_eval do
    def export_columns(format = nil)
      %w[approved? author author_email content referrer]
    end
  end

=== In your layout: 

  <r:snippet name="comments" />

=== Snippets

The snippets "comments", "comment" and "comment_form" are created by the migration. These can be found under snippets, 
and can be customised after your needs. Check out the 002 migration to see what they default to.

== Caveats

* Relative urls will *not* work on comment pages if they fail validation, since the page gets re-rendered
  at a (probably) different level of the hierarchy. Always use absolute urls and you won't have any issues.

== Contributors

* Michael Hale of http://halethegeek.com/, sponsored by http://ignitesocialmedia.com/.
* Nathaniel Talbott of http://terralien.com/, sponsored by http://ignitesocialmedia.com/.
* John Croisant
* Jon Leighton
* Witter Cheng
* Keith Bingman
* Sean Cribbs
* Ryan Heneise

If you contribute, go ahead and add your name to the list!