==================================================================
Snippet-title:		cat v1.0
Creator:		Graham Keellings
E-mail:			pivot@keellings.com
Website:		http://www.keellings.com/software/pivot.php
Creation date:		22 May 2006, Singapore
==================================================================

Content of zipped file:
-----------------------
snippet_cat.php
readme_cat.txt (this file)


Usage:
------
1) unpack this package in your extensions/snippets/ folder.
2) place a [[cat]] tag, with the appropriate parameters, in an entry, 
whereever you want the link to appear

   
Description:
------------
* A snippet intended to be used in your entries, to provide a link to all
* entries of a given category.
*
* For instance, you might write this in an entry:
*  Last night I drank some [[cat:beer]], as is my wont of a Friday.
*
* and the snippet will be replaced by a link to all entries in the 
* category "beer".



Parameters:
-----------
* @param  string  category   - the category to which to link.
* @param  string  weblog     - pass '.'for the current blog (default), 
*                              or a blog title like "my_blog"
* @param  int     format     - if 0 (default), then a link will be generated
*                              to the standard Pivot archive page to view all
*                              entries for the category.
*                              If 1, then the link will be used to reload your
*                              fronpage with a parameter which will cause 
*                              Graham's category_list_entries, the operation
*                              of which can be seen by visiting Graham's blog
*                              and clicking a category title in the left column.
*                              IMPORTANT!! you will *not* be able to do this
*                              without some undocumented changes to your 
*                              frontpage template and some unreleased snippets, 
*                              so you must contact Graham if you want to use 
*                              this.
*                              Don't try this at home, children :-)
* @return The requested HTML, as specified by the parameters.