git-svn-id: http://svn.viney.net.nz/things/rails/plugins/acts_as_tagg…

…able_on_steroids@338 20afb1e0-9c0e-0410-9884-91ed27886737

CHANGELOG

@@ -1,3 +1,9 @@
+[3 October 2007]
+
+# Improve documentation.
+
+* Fix TagsHelper and test.
+
 [2 October 2007]
 
 * Remove TagList.parse, use TagList.from instead.

README

@@ -11,10 +11,9 @@ If you find this plugin useful, please consider a donation to show your support!
 This plugin is based on acts_as_taggable by DHH but includes extras
 such as tests, smarter tag assignment, and tag cloud calculations.
 
-== Resources
+== Installation
 
-Install
-  * script/plugin install http://svn.viney.net.nz/things/rails/plugins/acts_as_taggable_on_steroids
+  ruby script/plugin install http://svn.viney.net.nz/things/rails/plugins/acts_as_taggable_on_steroids
 
 == Usage
 
@@ -27,7 +26,7 @@ Generate and apply the migration:
 
 === Basic tagging
 
-Let's suppose we have users that have many posts and we want those posts to be able to be tagged by the user.
+Let's suppose users have many posts and we want those posts to have tags.
 The first step is to add +acts_as_taggable+ to the Post class:
 
   class Post < ActiveRecord::Base
@@ -60,6 +59,8 @@ By default, find_tagged_with will find objects that have any of the given tags.
 find only objects that are tagged with all the given tags, use match_all.
 
   Post.find_tagged_with('Funny, Silly', :match_all => true)
+
+See <tt>ActiveRecord::Acts::Taggable::InstanceMethods</tt> for more methods and options.
 
 === Tag cloud calculations
 

lib/acts_as_taggable.rb

@@ -1,12 +1,12 @@
-module ActiveRecord
+module ActiveRecord #:nodoc:
   module Acts #:nodoc:
     module Taggable #:nodoc:
       def self.included(base)
         base.extend(ClassMethods)
       end
 
       module ClassMethods
-        def acts_as_taggable(options = {})
+        def acts_as_taggable
           has_many :taggings, :as => :taggable, :dependent => :destroy, :include => :tag
           has_many :tags, :through => :taggings
 
@@ -172,7 +172,7 @@ def tag_counts(options = {})
           self.class.tag_counts({ :conditions => ["#{Tag.table_name}.name IN (?)", tag_list] }.reverse_merge!(options))
         end
 
-        def reload_with_tag_list(*args)
+        def reload_with_tag_list(*args) #:nodoc:
           @tag_list = nil
           reload_without_tag_list(*args)
         end

lib/tag_counts_extension.rb

@@ -1,2 +1,3 @@
-module TagCountsExtension
+# Deprecated
+module TagCountsExtension #:nodoc:
 end

lib/tagging.rb

@@ -1,4 +1,4 @@
-class Tagging < ActiveRecord::Base
+class Tagging < ActiveRecord::Base #:nodoc:
   belongs_to :tag
   belongs_to :taggable, :polymorphic => true
 end

lib/tags_helper.rb

@@ -1,4 +1,5 @@
 module TagsHelper
+  # See the README for an example using tag_cloud.
   def tag_cloud(tags, classes)
     max_count = tags.sort_by(&:count).last.count.to_f