# Blosxom Plugin: readme
# Author(s): Rael Dornfest <rael@oreilly.com> 
# Version: 2003-11-12
# Documentation: See the bottom of this file or type: perldoc readme

package readme;

# --- Configurable variables -----

my $before_readme = qq{<span class="readme">};
my $after_readme = qq{</span>};

# --------------------------------

$readme; # use as $readme::readme in flavour templates

use FileHandle;

my $fh = new FileHandle;

sub start {
  1;
}

sub head {
  my($pkg, $path, $head_ref) = @_;

  LOOK: {
    do {
      $fh->open("< $blosxom::datadir/$path/readme") || $fh->open("< $blosxom::datadir/$path/readme.$blosxom::flavour") and $readme = join('', $before_readme, <$fh>, $after_readme), $fh->close, last LOOK;
    } while ($path =~ s/(\/*[^\/]*)$// and $1);
  }
  
  return 1;
}

1;

__END__

=head1 NAME

Blosxom Plug-in: readme

=head1 SYNOPSIS

Purpose: Populates $readme::readme with the contents of any readme.flavour
(specific to a particular flavour) or readme (general, regardless of flavour)
file found along a particular category path/directory, preferring those found 
closest to the point of the path at hand.

=head1 VERSION

2003-11-12

Version number coincides with the version of Blosxom with which the 
current version was first bundled.

=head1 AUTHOR

Rael Dornfest  <rael@oreilly.com>, http://www.raelity.org/

=head1 SEE ALSO

Blosxom Home/Docs/Licensing: http://www.raelity.org/apps/blosxom/

Blosxom Plugin Docs: http://www.raelity.org/apps/blosxom/plugin.shtml

=head1 BUGS

Address bug reports and comments to the Blosxom mailing list 
[http://www.yahoogroups.com/group/blosxom].

=head1 LICENSE

Blosxom and this Blosxom Plug-in
Copyright 2003, Rael Dornfest 

Permission is hereby granted, free of charge, to any person obtaining a
copy of this software and associated documentation files (the "Software"),
to deal in the Software without restriction, including without limitation
the rights to use, copy, modify, merge, publish, distribute, sublicense,
and/or sell copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included
in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.