==================================================================
Snippet-title:		word_cloud v1.0
Creator:		Graham Keellings
E-mail:			pivot@keellings.com
Website:		http://www.keellings.com/software/pivot.php
Creation date:		9 Aug 2006, Singapore (National Day)
==================================================================

Content of zipped file:
-----------------------
snippet_word_cloud.php
ignore_words.php
readme_word_cloud.txt (this file)


Usage:
------
1) unpack this package in your extensions/snippets/ folder.
2) if you want to use an 'ignore words' file, to indicate words
   which you do not want to be included the cloud, you can use
   the included "ignore_words.php" as a base, after first copying
   it to your templates directory.
3) place a [[word_cloud]] tag, with the appropriate parameters, 
   wherever you want the output to appear.
4) rebuild the FrontPage(s).
 
   

Description:
------------
Shows the 'word cloud' for your blog. The X (user defined) most commonly used words are shown with the font size indicating how often they are used'. Highly customisable (output sort order, list of words to ignore, etc), see parameter for details.

Visit http://www.keellings.com/blog/_demos/word_cloud.php to see it in action




Parameters:
-----------
* @param  string  author               - pass an author's name to restrict 
*                                        selection, or '*' for all authors (default)
* @param  string  weblog               - pass '.'for the current blog, '*' for
*                                        all blogs (default), or a blog title 
*                                        like 'my_blog'
* @param  string  category             - consider only entries of the given 
*                                        category, or all categories set to * (default).
* @param  string  ignoreWordsFileName  - this, optional, file contains a list
*                                        of words whcih you want the snippet to
*                                        ignore (e.g, "the", "and", etc
*                                        (default name = 'ignore_words.php')
*                                        It must exist in your templates directory.
* @param  int     minWordLength        - A string must be this many characters
*                                        long to be considered a word
*                                           (daefult = 3)
*                                        If you don't like this idea, set the 
*                                        value to 99 or so ;-)
* @param  int     numCloudWords        - You may have several thousand unique
*                                        words in your blog. Thsi parameter
*                                        limits home many will be output by the
*                                        snippet. Default = 100 most used words.
* @param  string  fontRange            - Minimum and maximum font size for the 
*                                        cloud, spearated by the |haracter. 
*                                        Words will be spaced evenly along this
*                                        range. Default is 10|48
* @param  int     sort                 - specifies the sort order of the 
*                                        genrated word cloud. 
*                                          0 (default) - Ascending alphabetical, a->z
*                                          1 - Descending alphabetical z->a
*                                          2 - Ascending numerically 
*                                          3 - Descending numerically
* @return The requested HTML, as specified by the parameters.