Here's the complete text for the download you were just reading about. For those that hate to read documentation, here's a link to DOWNLOAD categoryz 0.62.

To return to the Downloads page, click the Downloads button at left.

categoryz 0.62

The categoryz plugin generates a hierarchical "tree" of all the categories (directories) in your datadir. The tree is composed of nested unordered lists; each list item links to its category's view.

Optionally, each directory item can display the number of entries it contains. Users can specify style info for lists and list items. Category links can be set to specify a flavour, or just let blosxom use its preferred flavour.

Here's an example:

These directories... ...produce this "tree":

/docs
/docs/books
/docs/books/bios
/docs/books/scifi
/docs/movies
/docs/movies/noire
/docs/movies/scifi
/docs/toonz
/docs/toonz/rock
/docs/toonz/soul
/docs/toonz/space



Configuring & Installing categoryz

categoryz comes preconfigured for most blosxom installs; just add a call to $categoryz::display in your head or foot template, drop the plugin file into your plugins folder and blog on. The following values can be changed to alter categoryz's behavior:

Style bits : as shipped, categoryz assigns its lists and list items to the categoryz and categoryz_item CSS classes, respectively. These assignments can be changed to whatever you wish, including empty.

Entries counts : as shipped, the plugin shows the number of entries (the count) for each category list item; each count is surrounded by parentheses. To suppress the count, set $show_counts to 0 (zero). To change the characters that surround the count, enter values into the $pre_count_bits and $post_count_bits variables.

Category view flavour : as shipped, the category URLs composed by the plugin contain no flavour information; whatever flavour is specified in blosxom's configuration section or by the config plugin will be used when a category view is opened. To specify a flavour of your choice for category views, enter it into the $cat_flavour variable. $cat_flavour is available to the config plugin.

(Category view flavour is set in URLs by adding the flav parameter, as in /category?flav=flavour. If you dig around in the code, you'll find a spot to use /index.flavour instead.)

Skip leading directories : The $skip_top_dirs variable specifies the number of "top" directories to exclude from the category list. For example, your datadir might have one or more top-level directories that hold files for blosxom, but not necessarily for your blog. Set $skip_top_dirs to 1 the number of "top" directories


Using categoryz

Add $categoryz::display to a head or foot flavour to display the list generated by the plugin. To take advantage of the CSS class identifiers categoryz and categoryz_item you will, of course, have to add definitions to your style sheet or head flavour.

If you use the exclude plugin (or similar), rest easy — categoryz doesn't start its work until all filtering is done; no secrets will be revealed ;-)

Here's the example from the top of this page, this time including a tree made with $skip_top_dirs set to 1:

These directories... ...produce this "tree": or, with $skip_top_dirs set to 1:

/docs
/docs/books
/docs/books/bios
/docs/books/scifi
/docs/movies
/docs/movies/noire
/docs/movies/scifi
/docs/toonz
/docs/toonz/rock
/docs/toonz/soul
/docs/toonz/space


Credits

categoryz was inspired by a post to the blosxom list from Steph Smith; adapted from the
categorytree plugin v1.7 by Eric Davis.

 

DOWNLOAD categoryz 0.62