
=== CLEAN ARCHIVES RELOADED v1.0.0 ===

http://www.viper007bond.com/wordpress-plugins/clean-archives-reloaded/


== CREDITS ==

* Sebastian Schmieg -- created original code for his "Blix" theme: http://www.kingcosmonaut.de/portfolio.php?project=blix
* Shawn Grimes -- turned the code into a plugin: http://www.sporadicnonsense.com/2005/04/28/clean-archives-plug-in/
* Valerio Proietti -- for writing the "moo.fx" Javascript package: http://moofx.mad4milk.net
* Chris O'Rourke -- gave me the idea to enhance the plugin using moo.fx to expand/collapse the months


== DESCRIPTION ==

This plugin generates and outputs a pretty list of all of your posts, organized by month.

Unlike the original version which used 2 queries per post + 1 for each month which most often resulted in hundreds of queries per page load, this one caches the output which means only 1 or 2 queries is needed each time the page is viewed.

This version of the plugin is also moo.fx enhanced which means that for people who post a lot won't have an archive page that's 3 miles long.

A demo of this plugin can be found here: http://www.viper007bond.com/archives/


== INSTALLATION ==

Upload the contents of the downloaded ZIP file to your plugins folder located at "/wp-content/plugins/" while making sure to keep this plugin's file structure intact.

You should end up with a folder called "clean_archives_reloaded" in your plugins folder and some files and a folder called "moo.fx" inside of that.

Go to your admin area and active the plugin from the plugins page. See this for more details: http://codex.wordpress.org/Managing_Plugins#Installing_Plugins


== INITIAL SETUP ==

You have two choices here.


* The first and easier method (but somewhat less preferred) is to install a plugin that will allow you to use PHP in your posts and Pages. You can find some listed here:

  http://codex.wordpress.org/Plugins/Posts_Formatting

  Just search for "PHP" on that page and you'll find them. And no, sorry, I don't have a clue which is the best to use. I don't use any of them.


* The other method requires a bit more work, but is much more secure and such. This method involves creating a custom Page template. For details on how to do that, see this link:

  http://codex.wordpress.org/Pages#Page_Templates

  It's much easier than it may sound. You basically just make a copy of your page.php file and modify it a bit.


== PLUGIN USAGE ==

Now, once you've chosen a method, now to actually use the plugin. This plugin creates two functions.


* The main function of this plugin is the one that outputs your archives. To use it, simply drop this PHP code where you want it to show up:

	<?php if (function_exists('clean_archives_reloaded')) { clean_archives_reloaded(); } ?>


* The other function that this plugin creates will return the total number of posts. It's used for generating the output, but you can also use it like I have to show your total post count. Here's some example code:

	<?php if (function_exists('car_total_posts')) { echo "Here's a list of all " . car_total_posts() . " posts that I've made to my blog."; } ?>

  It is important to note that this function doesn't actually output the count, it only returns it. You much use an "echo" or whatever to output the count.


== OPTIONAL CONFIGURATION ==

If you open up the plugin file (clean_archives_reloaded.php), there's some optional configuration listed at the top. Read the comments for details about the options.


== SUPPORT ==

If you've read over this readme carefully and are still having issues, if you've discovered a bug, or have a feature request, please visit this URL:

http://www.viper007bond.com/wordpress-plugins/forums/viewforum.php?id=22