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 excludez 0.5.

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

excludez 0.5

The excludez plugin lets you keep individual entries or entire directories from being displayed, on a per-flavour, per-category basis. Exclude-ing can be suspended for the find or wikieditish plugins. Migration from the orignal exclude and hide plugins is seamless; new features include standard path notation, more options for where exclude info is stored, and the ability to "comment out" path info in exclude files.

excludez is a re-work of the venerable exclude and hide plugins, with a couple more features.


Configuring & Installing excludez

Enter configuration values for the options described below; drop this file into your blosxom plugins folder; blog on.

Exclude Files' name : to keep whole categories and/or specific files from displaying, you'll list them in "exclude files" at one or more spots in your directories; enter the name these files will use between the single quote marks. If you leave the name blank, the default exclude will be used.

Allow Finding : if you may want items that are excluded from display to still be searchable or editable, set $allow_find to 1; if not, set $allow_find to 0.


Info Formats

There are two formats available for specifying the directories and/or files to exclude from display in your blog:

  1. Original --
    The original "exclude" plugins (exclude, hide) required directory and file specifications like this:
     dir1/dir2/
     entry_file.txt
     dir1/entry_file.txt

    And that method works here, so if you're migrating, you can
    still use your existing exclude files.

  2. Standard --
    New users may prefer a more-standard notation, like this:
     /dir1/dir2
     /entry_file.txt
     /dir1/entry_file.txt

    And that works, too.


Info Locations

There are three ways to save exclude info:

  1. Situate exclude files on a per-flavour, per-directory basis, as in the original "exclude" plugins (exclude, hide). So again, if you're migrating, all your old files will still work.

    Given this directory structure:

    /blosxom
       /sekrit_stuff
       /dir1
       /dir2
           /sub2
               /sub_sub2
                   /sekrit_entry.txt
       /dir3

    we would use these exclude files to hide our sekrit stuff:

    /blosxom
       /exclude_file containing: /sekrit_stuff
                              /dir2/sub2/sub_sub2/sekrit_entry.txt
       /sekrit_stuff
       /dir1
       /dir2
           /exclude_file containing: /sub2/sub_sub2/sekrit_entry.txt
           /sub2
               /exclude_file containing: /sub_sub2/sekrit_entry.txt
               /sub_sub2
                   /exclude_file containing: /sekrit_entry.txt
                   /sekrit_entry.txt
       /dir3

    Very efficient for the plugin, but potentially many exclude files to keep track of.

  2. Situate one per-flavour exclude file in your plugins "state" directory (blosxom's $plugins_state_dir configuration variable).

    Given the above directory structure, an exclude file in the plugins state directory would look like this:

    /sekrit_stuff
    /dir2/sub2/sub_sub2/sekrit_entry.txt
    /sub2/sub_sub2/sekrit_entry.txt
    /sub_sub2/sekrit_entry.txt
    /sekrit_entry.txt

    More work for the plugin, but only one file for us to deal with.

  3. Store exclude info in the __DATA__ section of the plugin (generic only; applies to all flavours). Just paste lines of exclude info between __DATA__ and __END__; reading stops at a blank line.

    For an example, see Method 2 above.


Using excludez

It makes no difference which info format you use (/dir vs. dir/), so don't worry about it. It does make a difference where your exclude files are located: the plugin follows a sequence as it looks for info, and stops looking as soon as it finds a file. The precedence of exclude file locations is:

  1. current directory, flavour-specific file ("exclude.flavour")
  2. current directory, generic file ("exclude")
  3. plugins state directory, flavour-specific file
  4. plugins state directory, generic file
  5. DATA section, generic info (applies to all flavours)

So, if you absoposilutely have to keep a file or directory from being displayed, record it in the DATA section of the plugin as a safety net against lost exclude files. (But see the next note about exceptions for Find.)


Special Case for Find, Wikieditish

When $allow_find is set to 1, and the Find or Wikieditish plugins are active (finding or editing), things are a little different. In this case, all your exclude files are ignored, allowing the plugins to access any entry file.

However, you may still have items you don't want exposed to finding or editing. Exclude info entered into the DATA section of the plugin is not ignored during finding or editing.

So, in terms of finding --

  1. if you never want your excluded items to be "find-able", (or "wikieditish-able") set $allow_find to 0 (zero)
  2. to allow all your excluded items to be "find-able", set $allow_find to 1 and use only exclude files to store exclude info
  3. to allow find-ing in some excluded items, but not all, use exclude files to hold exclude info about find-able items, and use the DATA section of the plugin to hold info about "non-find-able" items.


Credits

excludez is based on exclude v0+3i by Breyten Ernsting and hide v0.1 by Fletcher T Penney; just my hack on two fine plugins.

 

DOWNLOAD excludez 0.5