public
Description: Radiant Comments
Clone URL: git://github.com/artofmission/radiant-comments.git
Search Repo:
radiant-comments / README.rdoc
100644 68 lines (43 sloc) 2.201 kb

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.

Installation

To copy the supporting files to your public directory, run:

  rake radiant:extensions:comments:update

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!